> For the complete documentation index, see [llms.txt](https://docs.yarnspinner.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yarnspinner.dev/2.4/beginners-guide/making-a-game/yarn-spinner-for-godot.md). # Yarn Spinner for Godot {% hint style="danger" %} Yarn Spinner for Godot is a Yarn Labs project. It is not fully, or officially supported, and may break, or change at any time. {% endhint %} This step of the beginner's guide helps you move from writing Yarn scripts outside of a game engine, to initial integration steps to turn them into a game with Godot First, launch Godot 4.2 (C# version) and create a new project. ## Installing Yarn Spinner for Godot Download a[ copy of the latest version of Yarn Spinner for Godot](https://github.com/YarnSpinnerTool/YarnSpinner-Godot/archive/refs/heads/develop.zip) from the [GitHub repository](https://github.com/YarnSpinnerTool/YarnSpinner-Godot/), or clone the repository somewhere. Locate the `addons/` directory in your new local copy of Yarn Spinner for Godot:

The `addons` directory in a local copy of Yarn Spinner for Godot.

Put a copy of this directory into your new Godot project, either by dragging the folder in your file manager (e.g. Finder or Explorer) into the folder of the Godot project, or by dragging from your file manager into the FileSystem dock of your Godot project:

The FileSystem dock in Godot, after dragging the `addons` directory in.

Next, choose the Project menu -> Tools -> C# -> Create C# solution. This will create a C# project for you. We have to do this to trigger the creation of the `.csproj` file, which is necessary to let Godot know about the Yarn Spinner plugin. Next, open the project folder in Visual Studio Code. In the sidebar of VS Code, the `.csproj` file and add the following line to it, inside the `` `` tags, but not inside an `` or `:` ``` ``` Your brand new project should look something like this in VSCode:

Save the tweaked `.csproj` file and return to Godot, everything is almost ready to go. Click the Build button in the very top right-hand corner of the Godot window. This will trigger a build of the C# solution for the project, which is required to make Godot aware of Yarn Spinner for Godot. Once the build is complete, open the Project menu -> Project Settings, change to the Plugins tab, and tick the enabled box next to the Yarn Spinner for Godot plugin:

The Project Settings, showing the Plugins tab.

With that, you're ready to go! ## Using Yarn Spinner for Godot In your Godot project, click the Instantiate Child Scene button:

The chain-link button, for instantiating a child scene.

And navigate into the `addons/YarnSpinner-Godot/Scenes` folder of your project, and choose the `DefaultDialogueSystem.tscn` file as the scene to instantiate:

Choosing the provided `DefaultDialogueSystem.tscn`.

Then, right click the new scene in the Scene dock, and check the "Editable Children" option. This will allow you to view all of the components that make up the default dialogue system, and set options on them in the inspector dock. Your Scene dock will look like this showing a node hierarchy that's entirely based on the `DefaultDialogueSystem.tscn` scene that you instantiated:

The `DefaultDialogueSystem` instantiated into your scene.

{% hint style="info" %} You could also instantiate the `DefaultDialogueSystem.tscn` into your scene at a lower part of the hierarchy, instead of the root node, to display dialogue using the provided default UI, instead. {% endhint %} Next, create a new Yarn Project using the menu Tools > YarnSpinner >Create Yarn Project:

Opening the menu to create a new .yarnproject file.

Then choose a directory to save your new YarnProject in. For example, you can save it to the root of your project. Name the new Yarn Project `FirstProject.yarnproject`:

Selecting a location to save your .yarnproject file.

Next, create a new Yarn script (a file with a `.yarn` extension) by using the menu Tools > YarnSpinner >Create Yarn Script. In the resulting "Create a new Yarn Script" window, set the File name to `MyStory.yarn`, and click the Save button::

It may take a moment, but Godot will import your new `.yarn` file, and it will appear in the FileSystem dock. When it's appeared, double-click on the Yarn Project, `FirstProject.yarnproject` in the FileSystem dock and look to the Inspector, making sure that `res://MyStory.yarn` is in the list of Source Scripts, which are the Yarn scripts that compromise the new project:

The Yarn Project, with the Yarn script identified as a Source Script.

Next, open the `MyStory.yarn` file in VS Code, and add the following Yarn script to it, before saving it and returning to Godot:

MyStory.yarn

``` title: Start tags: --- Narrator: Oh, hello! -> Hi, where am I? Narrator: You're in Godot! -> Oh. <> -> How did I get here? <> === title: Oh --- Narrator: Yeah, fun, right? === title: Godot --- Narrator: Someone read the Beginner's Guide! === ```

Select the `DialogueRunner` node in the Scene dock, and look to the Inspector. Selecting "Editable Children" earlier in the guide is what will allow you to see the `DialogueRunner` node and edit its options. Assign the Yarn Project you created to the `DialogueRunner` by dragging the `FirstProject.tres` Yarn Project from the FileSystem dock into the Yarn Project slot of the Inspector:

The new Yarn Project resource assigned as the Yarn Project for the `DialogueRunner`.

Finally, enter `Start` as the Start Node, and tick the box next to Starts Automatically:

Setting the Start Node, and that we want this `DialogueRunner` to start automatically.

Save your scene as `Demo.tscn`, and run the game. At this point, you can play your project, and step through the dialogue in the default Yarn Spinner for Godot Line View and Options List View:

### Next steps with Yarn Spinner for Godot With that, we've reached the end of our beginner's guide. You're ready go forth and build games with Yarn Spinner! You're also equipped to work with the rest of the documentations here! Don't forget to [join the Discord](https://discord.com/invite/yarnspinner) to chat with other Yarn Spinner users, the Yarn Spinner team, seek help, and share your work. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.yarnspinner.dev/2.4/beginners-guide/making-a-game/yarn-spinner-for-godot.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.