# YarnSpinner

**Repository Path**: dang050/YarnSpinner

## Basic Information

- **Project Name**: YarnSpinner
- **Description**: Yarn Spinner is a tool for building interactive dialogue in games!
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-22
- **Last Updated**: 2021-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Yarn Spinner

<img src="https://yarnspinner.dev/img/YarnSpinnerLogo.png" alt="Yarn Spinner logo" width="100px;" align="right">



**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](http://twinery.org), 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. 

<a href="https://www.patreon.com/bePatron?u=11132340"><img src="https://yarnspinner.dev/img/patreon.png" width="150px"></a>

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

* **[Yarn Spinner for Unity](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/releases/latest)** (2018.4 LTS or later)

Once you've downloaded it, head over to the [tutorial](https://yarnspinner.dev/docs/tutorial)!

## Getting Help

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

* [Follow us on Twitter](https://twitter.com/YarnSpinnerTool)!
* Join the official [Yarn Spinner Discord](https://discord.gg/9CvsQfS)!

## License

Yarn Spinner is available under the [MIT License](LICENSE.md). 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](https://tldrlegal.com/license/mit-license) that you might find useful.

## Made by Secret Lab!

Yarn Spinner was originally created by [Secret Lab](http://secretlab.com.au), an Australian game dev studio. [Come say hi](https://twitter.com/thesecretlab)!

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

<a href="https://gamecenter.nyu.edu/"><img src="https://yarnspinner.dev/img/NYUGameCenter.png" alt="NYU Game Center logo" width="250px;" align="right"></a>

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 - we'd love to have your help in improving our [documentation](https://yarnspinner.dev/docs/tutorial), in spreading the word, and in finding bugs.

* Yarn Spinner's development is powered by our wonderful Patreon supporters. [Become a patron](https://patreon.com/secretlab), and help us make Yarn Spinner be amazing.
* Our [issues page](https://github.com/YarnSpinnerTool/YarnSpinner/issues) contains a list of things we'd love your help in improving.
* Join our discussion on Slack by joining our [narrative game development](http://lab.to/narrativegamedev) channel.
* 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)