https://github.com/yarnspinnertool/exampleprojects
Source code for Yarn Spinner's tutorial projects.
https://github.com/yarnspinnertool/exampleprojects
game game-development gamedev unity unity3d
Last synced: 10 months ago
JSON representation
Source code for Yarn Spinner's tutorial projects.
- Host: GitHub
- URL: https://github.com/yarnspinnertool/exampleprojects
- Owner: YarnSpinnerTool
- License: mit
- Created: 2021-06-25T14:01:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-31T00:46:13.000Z (almost 3 years ago)
- Last Synced: 2025-04-10T15:45:17.135Z (about 1 year ago)
- Topics: game, game-development, gamedev, unity, unity3d
- Language: ShaderLab
- Homepage:
- Size: 2.7 MB
- Stars: 13
- Watchers: 3
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://schedule.gdconf.com/session/game-career-seminar-building-narrative-games-with-yarn-spinner/880722), download [version 1.0](https://github.com/YarnSpinnerTool/ExampleProjects/releases/tag/v1.0).
➡️ If you are here for the Space Journey or Ghosty Lads demo projects from the Yarn Spinner starter tutorials ([SJ](https://docs.yarnspinner.dev/unity-sample-projects/example-project-2), [GL](https://docs.yarnspinner.dev/unity-sample-projects/example-project-3)), download [version 2.0](https://github.com/YarnSpinnerTool/ExampleProjects/releases/tag/v2.0).
## Getting Started
To get started with this game, follow these instructions:
1. Download and install [Unity 2020.3](https://unity.com) 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](https://github.com/thesecretlab/SpaceJourney/releases/).
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/` 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](https://twitter.com/parisba)
* Art: [Kenney.nl](https://kenney.nl), with modifications and additional art by [Jon Manning](https://twitter.com/desplesda)
* Code: [Jon Manning](https://twitter.com/desplesda) and [Mars Buttfield-Addison](https://twitter.com/themartianlife)