Skip to content
main
Switch branches/tags
Code

Yarn Spinner

Yarn Spinner logo

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.

Getting Started

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.

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

Getting Help

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

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!

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!