Quick Start
Quick Start Guide
After following the instructions to install the plugin, in your Godot project, click the Instantiate Child Scene button:

And navigate into the addons/YarnSpinner-Godot/Scenes
folder of your project, and choose the DefaultDialogueSystem.tscn
file as the scene to instantiate:

DefaultDialogueSystem.tscn
.Then, right click the new scene in the Scene dock, and check the "Editable Children" option. This will allow you to view all of the components that make up the default dialogue system, and set options on them in the inspector dock.
Your Scene dock will look like this showing a node hierarchy that's entirely based on the DefaultDialogueSystem.tscn
scene that you instantiated:

DefaultDialogueSystem
instantiated into your scene.Next, create a new Yarn Project using the menu Tools > YarnSpinner >Create Yarn Project:

Then choose a directory to save your new YarnProject in. For example, you can save it to the root of your project. Name the new Yarn Project FirstProject.yarnproject
:

Next, create a new Yarn script (a file with a .yarn
extension) by using the menu Tools > YarnSpinner >Create Yarn Script. In the resulting "Create a new Yarn Script" window, set the File name to MyStory.yarn
, and click the Save button::

It may take a moment, but Godot will import your new .yarn
file, and it will appear in the FileSystem dock. When it's appeared, double-click on the Yarn Project, FirstProject.yarnproject
in the FileSystem dock and look to the Inspector, making sure that res://MyStory.yarn
is in the list of Source Scripts, which are the Yarn scripts that compromise the new project:

Next, open the MyStory.yarn
file in VS Code, and add the following Yarn script to it, before saving it and returning to Godot:
Select the DialogueRunner
node in the Scene dock, and look to the Inspector. Selecting "Editable Children" earlier in the guide is what will allow you to see the DialogueRunner
node and edit its options. Assign the Yarn Project you created to the DialogueRunner
by dragging the FirstProject.tres
Yarn Project from the FileSystem dock into the Yarn Project slot of the Inspector:

DialogueRunner
.Finally, enter Start
as the Start Node, and tick the box next to Starts Automatically:

DialogueRunner
to start automatically.Save your scene as Demo.tscn
, and run the game. At this point, you can play your project, and step through the dialogue in the default Yarn Spinner for Godot Line Presenter and Options Presenter:

Next steps with Yarn Spinner for Godot
With that, we've reached the end of our beginner's guide. You're ready go forth and build games with Yarn Spinner! You're also equipped to work with the rest of the documentations here! Don't forget to join the Discord to chat with other Yarn Spinner users, the Yarn Spinner team, seek help, and share your work.
Last updated
Was this helpful?