diff --git a/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject-Dialog.png b/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject-Dialog.png new file mode 100644 index 00000000..ea2270b5 Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject-Dialog.png differ diff --git a/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject.png b/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject.png new file mode 100644 index 00000000..cab7f082 Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-Create-YarnProject.png differ diff --git a/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript-Dialog.png b/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript-Dialog.png new file mode 100644 index 00000000..142b66df Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript-Dialog.png differ diff --git a/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript.png b/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript.png new file mode 100644 index 00000000..3190cdab Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-Create-YarnScript.png differ diff --git a/.gitbook/assets/YarnSpinnerGodot-Csproj-File.png b/.gitbook/assets/YarnSpinnerGodot-Csproj-File.png new file mode 100644 index 00000000..2443dd96 Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-Csproj-File.png differ diff --git a/.gitbook/assets/YarnSpinnerGodot-YarnProject-Inspector.png b/.gitbook/assets/YarnSpinnerGodot-YarnProject-Inspector.png new file mode 100644 index 00000000..4895eab1 Binary files /dev/null and b/.gitbook/assets/YarnSpinnerGodot-YarnProject-Inspector.png differ diff --git a/docs/beginners-guide/using-a-game-engine/yarn-spinner-for-godot.md b/docs/beginners-guide/using-a-game-engine/yarn-spinner-for-godot.md index 7852db23..edba1734 100644 --- a/docs/beginners-guide/using-a-game-engine/yarn-spinner-for-godot.md +++ b/docs/beginners-guide/using-a-game-engine/yarn-spinner-for-godot.md @@ -23,7 +23,7 @@ Yarn Spinner for Godot is a Yarn Labs project. It is not fully, or officially su 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.1 (C# version) and create a new project. +First, launch Godot 4.2 (C# version) and create a new project. ## Installing Yarn Spinner for Godot @@ -47,7 +47,7 @@ Next, open the project folder in Visual Studio Code. In the sidebar of VS Code, Your brand new project should look something like this in VSCode: -

The .csproj for your project.

+

The .csproj for your project.

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. @@ -75,27 +75,21 @@ Your Scene dock will look like this showing a node hierarchy that's entirely bas 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 by right-clicking in the FileSystem dock, and choosing Resource...: +Next, create a new Yarn Project using the menu Tools > YarnSpinner >Create Yarn Project: -

Creating a new Resource in the FileSystem dock.

+

Opening the menu to create a new .yarnproject file.

-Then filter to the `YarnProject` resource type, and click the Create button: +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`: -

Creating a new YarnProject resource.

+

Selecting a location to save your .yarnproject file.

-Name the new Yarn Project `FirstProject.tres`. +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:: -Next, create a new Yarn script (a file with a `.yarn` extension) by right-clicking in the FileSystem dock, and choosing New TextFile: +

Opening the Create Yarn Script window

-

Creating a new TextFile, in order to add a Yarn script.

+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: -In the resulting New Text File... window, select All Files (\*) from the dropdown in the corner, set the File name to `MyStory.yarn`, and click the Save button: - -

Naming the file for a new Yarn script.

- -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.tres` 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.

+

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: @@ -129,7 +123,7 @@ Narrator: Someone read the Beginner's Guide! -Select the the `DialogueRunner` node in the Scene dock, and look to the Inspector. 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: +Select the `DialogueRunner` node in the Scene dock, and look to the Inspector. 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.