Yarn Spinner for Godot Samples

Sample projects for Yarn Spinner for Godot, the dialogue system for writing branching conversations in Godot.

What's here

Folder	What it is
YarnSpinner-Godot-GDScript-Samples	Eighteen samples for Yarn Spinner for Godot (GDScript), as one Godot 4.6 project.

The samples are for Yarn Spinner for Godot (GDScript) only. Yarn Spinner for Godot (C#) ships with its own samples.

Getting started

1. Install Godot 4.6 or later, the standard build.
2. Get Yarn Spinner for Godot (GDScript). See Installation.
3. Copy its addons/yarn_spinner folder into YarnSpinner-Godot-GDScript-Samples/addons/.
4. Open YarnSpinner-Godot-GDScript-Samples/project.godot in Godot, and turn on the Yarn Spinner plugin in Project > Project Settings > Plugins.

The samples project's README has more detail, and list every sample.

Documentation

• The samples: a page for each sample, explaining how it works.
• Yarn Spinner for Godot (GDScript): installing the addon, showing dialogue, and connecting Yarn to your game.
• Learn the Yarn Language: writing Yarn Scripts.

For help, join the Yarn Spinner Discord, or see yarnspinner.dev/help.

Licence

These samples are released under the Yarn Spinner Public Licence (YSPL). See LICENSE.md.