Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yarnspinnertool/yarnspinner-unity

The official Unity integration for Yarn Spinner, the friendly dialogue tool.
https://github.com/yarnspinnertool/yarnspinner-unity

game-development gamedev unity

Last synced: 2 days ago
JSON representation

The official Unity integration for Yarn Spinner, the friendly dialogue tool.

Awesome Lists containing this project

README 

        
Yarn Spinner logo



# Yarn Spinner for Unity



[![openupm](https://img.shields.io/npm/v/dev.yarnspinner.unity?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/dev.yarnspinner.unity/)



[Yarn Spinner](https://yarnspinner.dev) 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](http://nightinthewoods.com), [A Short Hike](https://ashorthike.com), [Lost in Random](https://www.ea.com/en-au/games/lost-in-random), [Dredge](https://www.dredge.game/), [Frog Detective](https://frogdetective.net/), [Button City](https://www.buttoncitygame.com/), [Escape Academy](https://escapeacademygame.com/en), [Baladins](https://www.baladinsgame.com/), and [Unbeatable](https://www.unbeatablegame.com/).



To get Yarn Spinner, and support the team behind it, buy a copy from [the Yarn Spinner Itch.io Store](https://yarnspinner.itch.io) or from [the Unity Asset Store](https://assetstore.unity.com/packages/tools/behavior-ai/yarn-spinner-for-unity-267061), or check out the [Yarn Spinner Documentation](https://docs.yarnspinner.dev).



This repo contains the Unity integration; you can find the core [Yarn Spinner compiler](https://github.com/YarnSpinnerTool/YarnSpinner) in its own repository.



## Getting Started



Installation instructions, documentation, tutorials, plus additional information is available in the [Yarn Spinner documentation](https://docs.yarnspinner.dev).



## Getting Help



For help, support, discussion, and chill community times, come and join the [Yarn Spinner Discord](https://discord.gg/yarnspinner)!



## Credits



Yarn Spinner is developed by [Secret Lab](https://secretlab.games/), along with a huge community of contributors.



The logo was made by [Cecile Richard](https://www.cecile-richard.com/).



This project has been assisted by the Australian Government through the [Australia Council](https://www.australiacouncil.gov.au/), its arts funding and advisory body. Yarn Spinner's development is made possible in part by [NYU Game Center](https://gamecenter.nyu.edu/). 



## 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.



* Yarn Spinner's development is powered by our wonderful Patreon supporters and Itch.io. [Become a patron](https://patreon.com/secretlab), or [buy Yarn Spinner on Itch.io](https://yarnspinner.itch.io), and help us make Yarn Spinner be amazing.

* Our [issues page](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/issues) contains a list of things we'd love your help in improving.

* Follow [Yarn Spinner on Twitter](http://twitter.com/YarnSpinnerTool).

* If you want to contribute to Yarn Spinner, [go read our contributor's guide!](CONTRIBUTING.md)