search

YarnSpinnerTool / YarnSpinner-Unity

The official Unity integration for Yarn Spinner, the friendly dialogue tool.
MIT License
524 stars 91 forks source link
game-development gamedev unity

readme

Yarn Spinner logo

Yarn Spinner for Unity

openupm

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 thousands of amazing games, including Night in the Woods, A Short Hike, Lost in Random, Dredge, Frog Detective, Button City, Escape Academy, Baladins, and Unbeatable.

To get Yarn Spinner, and support the team behind it, buy a copy from the Yarn Spinner Itch.io Store or from the Unity Asset Store, or check out the Yarn Spinner Documentation.

This repo contains the Unity integration; you can find the core Yarn Spinner compiler in its own repository.

Getting Started

Installation instructions, documentation, tutorials, plus 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.

This project has been assisted by the Australian Government through the Australia Council, its arts funding and advisory body. 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.