Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 2.89 KB

README.md

File metadata and controls

49 lines (26 loc) · 2.89 KB

Yarn Spinner 2.0

Yarn Spinner logo

Yarn Spinner is the friendly tool for writing dialogue in games. It's easy for writers to use, and has powerful features for programmers.

Yarn Spinner is a dialogue system that lets you write interactive conversations in a simple, screenplay-like format, which can be loaded into your game and run.

When a conversation is running, Yarn Spinner sends your game lines of dialogue to show, options to let the player choose from, and commands to make things happen in your scene.

Yarn Spinner has been used in a number of critically acclaimed games, including Night in the Woods, A Short Hike, Lost in Random, and many more.

It's free to download and use for free and commercial games, and is open source under the terms of the MIT License.

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.

Official Packages

These packages are written by the Yarn Spinner team, and are officially supported.

Learning More

Full documentation, tutorials, and additional information is available in the Yarn Spinner documentation.

Getting Help

For help, support, discussion, and chill community times, come and join the Yarn Spinner Discord!

Credits

Yarn Spinner is developed by Secret Lab, along with a huge community of contributors.

The logo was made by Cecile Richard.

Yarn Spinner's development is made possible in part by NYU Game Center. This project has been assisted by the Australian Government through the Australia Council, its arts funding and advisory body.

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!