Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3, Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

Yarn Spinner+ and Add-Ons

There’s always a free version of Yarn Spinner for Godot (GDScript) on GitHub, under the Yarn Spinner Public License. Yarn Spinner+ for Godot (GDScript) is the paid version. It comes with add-ons, which are ready-made dialogue systems you can add to your game and restyle.

What’s included

Yarn Spinner+ for Godot (GDScript) includes two add-ons:

  • Classic RPG: a dialogue box in the style of old-school RPGs, with a typewriter you can speed up and pause, a skip button, item icons, and a choice of box styles.
  • Snaaake: a two-character radio conversation in the style of classic action games, with talking heads, voice-over and subtitles.

Each add-on is a Godot addon folder that works with the free Yarn Spinner for Godot (GDScript), and comes with a sample scene.

Getting Yarn Spinner+

Buy Yarn Spinner+ for Godot (GDScript) from yarnspinner.dev/godot. It’ll be on the Godot Asset Store too, as soon as the store allows paid assets. See Installation for how to add it to your project.

Installing an add-on

Each add-on needs Yarn Spinner for Godot (GDScript) and Godot 4.6 or later. They come in the same download as Yarn Spinner+. To install one:

  1. Copy the add-on’s folder, like yarn_spinner_classic_rpg, into your project’s addons folder, next to yarn_spinner.
  2. Check that the Yarn Spinner plugin is turned on in ProjectProject SettingsPlugins.
  3. Optionally, turn on the add-on’s own plugin there too. It doesn’t add anything you need, but it warns you if the Yarn Spinner plugin is off.
Godot's Project Settings window on the Plugins tab, with three plugins turned on: Yarn Spinner 3.2, Classic RPG for Yarn Spinner 1.0.0, and Snaaake for Yarn Spinner 1.0.0
Yarn Spinner and both Yarn Spinner+ add-ons turned on.

Using an add-on’s Commands and Functions

Each add-on comes with a .ysls.json file in its folder, named after the folder, that lists the Commands and Functions it adds. Yarn Spinner doesn’t look inside the addons folder for these, so add the file to the "definitions" list in your .yarnproject file:

"definitions": [
    "MyGame.ysls.json",
    "${workspaceRoot}/addons/yarn_spinner_classic_rpg/yarn_spinner_classic_rpg.ysls.json"
]
Telling a Yarn Project about an add-on’s Commands and Functions.

Each add-on’s sample Yarn Project already has this line, and you can copy it from there.

With the file listed, the Yarn Spinner extension for VS Code suggests the add-on’s Commands as you type. Classic RPG adds <<set_dialogue_style>> and <<hide_dialogue>>, and Snaaake adds <<set_slot>>.

If an add-on adds Functions, a version 5 Yarn Project needs the file to compile. Without it, a Yarn Script that calls one of them fails with “no declaration found”. Classic RPG and Snaaake add no Functions. See Commands and Functions in an addon.

In this section

  • Classic RPG: setting it up, the hashtags and Commands it supports, and restyling it.
  • Snaaake: setting it up, adding characters, and putting them in slots.
Get started Classic RPG A dialogue box in the style of old-school RPGs, included with Yarn Spinner+ for Godot (GDScript).