Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.57 KB

YarnSpinner-with-Unity-QuickStart.md

File metadata and controls

31 lines (17 loc) · 1.57 KB
Raw

Quickstart to Using Yarn Spinner in your Unity game

Style Guide

Inline Code contain short snippets of code for your project

Code Blocks contain segments or chunks of code for your project

Bold indicate actions (Select menu item, copying file, etc.)

Bold italic text indicates emphasis

Blockquotes contain essential information

Tutorial

Note: This tutorial assumes that you know a little bit about Unity. In particular, it is helpful that you know how to get around the Unity editor, how to work with game objects, and how to write scripts in C#. If you don't know these things, please refer to Unity's documentation.

Yarn Spinner Quick Start

Here's how to quickly jump in to Yarn Spinner if you're already familiar with Unity.

  • Download the YarnSpinner package into your Unity project.
  • Import the package into your project.
  • Inside the YarnSpinner folder, open the Examples/Yarn Spinner Basic Example scene.
  • Start the game.
  • Play through the dialogue.

Once you've played with it, open the Example Script file in the Yarn Editor, (it's in the Examples/Demo Assets folder), and make some changes to the script. Once you've done that, take a look at how Code/DialogueRunner.cs, Examples/Demo Scripts/ExampleDialogueUI.cs and Examples/Demo Scripts/ExampleVariableStorage.cs work. You can also add your own functions to Yarn.