Skip to content
Yarn Spinner is a tool for building interactive dialogue in games!
C# Shell ANTLR Python
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation Add NYU Game Center acknowledgement to README.md Oct 23, 2019
Images Add repo social card (already set up in the GitHub settings, but now … Jul 29, 2019
Tests Remove original parser; make ANTLR parser the only parser in the code Jul 29, 2019
Unity Unity dialogue runner now has helper setters Aug 22, 2019
YarnSpinner fixed broken build command Aug 22, 2019
YarnSpinnerConsole removed obsolete calls from Console Aug 22, 2019
YarnSpinnerTests
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update links in .md files to point to new location Feb 8, 2016
CONTRIBUTORS.md
DeployDocumentation.sh
LICENSE.md Remove now-unnecessary note from license Jul 5, 2019
README.md Increase size of NYU Game Center logo in README.md Oct 23, 2019
ROADMAP.md Update ROADMAP.md to reflect higher priority for localisation Oct 21, 2019
YarnSpinner.sln
antlr.sh ok working travis..? Jul 13, 2017
build.sh
package.sh Remove original parser; make ANTLR parser the only parser in the code Jul 29, 2019
run-tests.sh Merge branch 'master' into development Jul 31, 2017

README.md

Yarn Spinner

Yarn Spinner logo

Yarn Spinner is a tool for creating interactive dialogue for games. Yarn's similar in style to Twine, so if you already know that, you'll be right at home! If you don't, that's cool - Yarn's syntax is extremely minimal, and there's not much there to learn.

New! Join our narrative game development Slack!

New! Continual integration API documentation now available.

Yarn Spinner is written in C#. Yarn Spinner is designed to be easy to add to Unity games, but it's also intended for use in other contexts as well.

Important: Yarn Spinner is still under development, and we haven't made our 1.0 release yet. It's probably fine to use right now, but there are a few bits and pieces that might change between now and first release.

Build Status

Quick Start - Documentation

What To Do Next

License

Yarn Spinner is available under the MIT License. This means that you can use it in any commercial or noncommercial project. The only requirement is that you need to include attribution in your game's docs. A credit would be very, very nice, too, but isn't required. If you'd like to know more about what this license lets you do tldrlegal.com have a very nice write up about the MIT license that you might find useful.

Made by Secret Lab!

Yarn Spinner was originally created by Secret Lab, an Australian game dev studio. Come say hi! You can visit the Yarn Spinner page on the Secret Lab website for a little more info, and to donate to Yarn Spinner open source development at Secret Lab.

The logo was made by Cecile Richard.

NYU Game Center logo

Yarn Spinner's development is made possible in part by NYU Game Center.

Help Us Make Yarn Spinner!

Yarn Spinner needs your help to be as awesome as it can be! You don't have to be a coder to help out - we'd love to have your help in improving our documentation, in spreading the word, and in finding bugs.

If you want to contribute to Yarn Spinner (!!), go read our contributor's guide!

You can’t perform that action at this time.