Skip to content
Yarn Spinner is a C# library for interactive dialogue in games!
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation Merge branch 'documentation-cleanup' of git://… Nov 2, 2018
Unity Update project Unity version to 2017.1f3 Jul 31, 2017
YarnSpinner Preserve C# 4 compatibility Jul 31, 2017
YarnSpinnerConsole first pass at errors in ANTLR Jul 12, 2017
.gitignore oops pt.2 May 7, 2018
.travis.yml Update links in .md files to point to new location Feb 8, 2016 fixing broken links Apr 3, 2018 add GSYMS to gitignore instead of removing it May 30, 2017 Merge branch 'documentation-cleanup' of git://… Nov 2, 2018
YarnSpinner.sln Merge the LocalisationTool into YarnSpinnerConsole Jul 23, 2016 ok working travis..? Jul 13, 2017 Make builds put build products in Untiy folder Jul 31, 2017

Yarn Spinner

Yarn Spinner logo

Yarn is a language that's designed to make it super easy to create 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. The Yarn language is used in a number of cool games, including Night In The Woods and Knights and Bikes.

New! Join our narrative game development Slack!

New! Continual integration API documentation now available.

Yarn Spinner interprets the Yarn language, and 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

(Image from "Night in the Woods" by Scott Benson, Bethany Hockenberry and Alec Holowka. Used with permission.)

Quick Start - Documentation

What To Do Next


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 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 awesome logo was made by the excellent Rex Smeal, and is under the Creative Commons Attribution-ShareAlike 4.0 International License.

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.