Yarn Spinner for Godot (GDScript)

The Yarn Spinner runtime and editor tools, written in GDScript for Godot 4.6 and later.

ESC
↑↓ Navigate ↵ Open esc Close

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 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

Yarn Spinner for Godot (GDScript)

If you’re using C# in Godot, Yarn Spinner for Godot also comes in a C# version. See the Godot (C#) documentation.

Yarn Spinner for Godot (GDScript) lets you write your game’s dialogue in Yarn and run it in Godot. The addon is written in GDScript, so your game doesn’t need C#. It runs in both the standard build and the .NET build of Godot.

Getting SupportNeed help? If you’ve bought Yarn Spinner+ for Godot, email hello@yarnspinner.dev with the subject “YS+ GDScript Support”, ideally from the address you bought it with. If you’re using the free version of Yarn Spinner for Godot, please post an issue on our GitHub tracker.

You write dialogue in .yarn files, in the same Yarn language used by every version of Yarn Spinner. Godot compiles them when it imports them. In your scene, a Dialogue Runner plays the dialogue, and Presenters put it on screen: lines of text, options for the player to choose from, voice-over, or anything else you build. Commands and Functions connect your Yarn Scripts to your game code, so a line of dialogue can move a character, and your game can decide which options appear.

YouTube video thumbnail
The Godot editor with the Yarn Spinner tab open on the samples browser, and a YarnDialogueRunner selected in the Inspector
The Yarn Spinner tab showing the samples, with a Dialogue Runner selected in the Inspector.

What you need

Requires Godot 4.6 or later For Yarn Spinner 3.3.x
  • The standard build or the .NET build of Godot. If you want to write your game in C#, use Yarn Spinner for Godot (C#) instead.
  • The Yarn Spinner for Godot (GDScript) addon. Installation explains how to get it and add it to your project.

Where to start

If you’re new to Yarn Spinner, start with Installation, below. Then read Setting Up Your Godot Project and Showing Dialogue in order.

If you’ve used Yarn Spinner with another engine, you already know the basics. Showing Dialogue and Connecting to Your Game cover how they work in Godot.

The samples show most features working in real scenes.

Start here Installation Add the addon to your Godot project and turn on the plugin.

Get more with Yarn Spinner+

Yarn Spinner+ for Godot (GDScript) comes with two ready-made dialogue systems you can add to your game:

  • Classic RPG, a dialogue box in the style of old-school RPGs
  • Snaaake, a radio conversation in the style of classic action games
See what's included