Yarn Spinner is a tool for creating interactive dialogue for games.

Write your conversations in Yarn, a simple programming language that's designed to be easy for writers to learn, while also powerful enough to handle whatever you need.

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.

This repo contains the core source code for the Yarn Spinner compiler. If you want to use it in a game, you should get the appropriate package for your game engine.

• Yarn Spinner for Unity (2018.4 LTS or later)

Once you've downloaded it, head over to the tutorial!

There are several places to get help with Yarn Spinner, and stay up to date with what's happening.

• Follow us on Twitter!
• Join our narrative game development Slack!

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.

Yarn Spinner was originally created by Secret Lab, an Australian game dev studio. Come say hi!

The logo was made by Cecile Richard.

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

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.

• Yarn Spinner's development is powered by our wonderful Patreon supporters. Become a patron, and help us make Yarn Spinner be amazing.
• Our issues page contains a list of things we'd love your help in improving.
• Join our discussion on Slack by joining our narrative game development channel.
• Follow Yarn Spinner on Twitter.

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