Pardon our dust while we move our docs here. The Godot (GDScript) docs are on this site, and the Yarn language, Unity, Godot (C#) and Unreal docs are still at docs.yarnspinner.dev.

Setting Up Your Godot Project

How Godot imports your Yarn Project and Yarn Scripts, and the editor tools you get once they're in.

ESC
↑↓ Navigate ↵ Open esc Close

When you use Yarn Spinner, you write your dialogue in .yarn files, and a .yarnproject file says which of them belong together. When these files are in your Godot project, the plugin imports them like any other asset:

  • A Yarn Project (.yarnproject) is compiled on import. The compiled result is what a YarnDialogueRunner runs, so this is the file you point the runner at.
  • A Yarn Script (.yarn) isn’t compiled on its own. When you save one, the plugin recompiles every Yarn Project that includes it.

The plugin also adds a Yarn Spinner tab to the editor, a detailed Inspector for Yarn Projects, and a few smaller tools.

  • Yarn Projects: which scripts a project includes, how it compiles, and everything in its Inspector.
  • Importing Yarn Files: what happens when you add or change a .yarn file, including edits made outside Godot.
  • Editor Tools: the Yarn Spinner tab, the commands palette, and what the plugin adds to the Inspector.
Get started Yarn Projects