Setting Up Your Godot (GDScript) Project for Yarn Spinner
You write your dialogue in .yarn files, and a .yarnproject file says which of them belong together. Once these files are in your Godot project, the plugin imports them like any other asset:
- A Yarn Project (
.yarnproject) is compiled on import. This is the file you point aYarnDialogueRunnerat, and the runner runs the compiled result. - A Yarn Script (
.yarn) is compiled as part of every Yarn Project that includes it, each time you save it.
The plugin also adds a Yarn Spinner tab to the editor, an 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
.yarnfile, including edits made outside Godot. - Editor Tools: the Yarn Spinner tab, the Commands and Functions palette, and what the plugin adds to the Inspector.