Yarn Spinner Example Projects

This repo contains source code for each of the Yarn Spinner 2.0 demo games that are referenced throughout documentation and official tutorials.

➡️ If you are here for the Space Journey demo project from the GDC 2021 talk Building Narrative Games with Yarn Spinner, download version 1.0.

➡️ If you are here for the Space Journey or Ghosty Lads demo projects from the Yarn Spinner starter tutorials (SJ, GL), download version 2.0.

Getting Started

To get started with this game, follow these instructions:

1. Download and install Unity 2020.3 or newer.
2. Create a new empty project, using the 3D Template.
3. Install Yarn Spinner by following these instructions:
   • Open the Window menu.
   • Choose Package Manager.
   • Click the + button at the top-left of the window.
   • Choose "Install from git URL..."
   • Copy and paste the following URL: https://github.com/YarnSpinnerTool/YarnSpinner-Unity.git#develop
   • Click Add.
4. Download the assets for the relevant project.
5. Double-click on the downloaded file, and it will open in Unity. Click Import.
6. Open the relevant scene (Scenes/Start Point in v1, Scenes/<game name> in v2).

If you are following along with the GDC talk, the code we added throughout is included in the asset package's C# script files but is commented out. Search the code for "Uncomment" to find the code we added.

Credits

• Story: Paris Buttfield-Addison
• Art: Kenney.nl, with modifications and additional art by Jon Manning
• Code: Jon Manning and Mars Buttfield-Addison