yarnspinner

# Yarn Spinner Yarn Spinner is a dialogue system designed for game development, enabling writers to craft interactive conversations using a simple, screenplay-like syntax. The core compiler and engine-agnostic components reside in this repository, which can be integrated into various game engines. The official package for Unity (2021.3 or later) is available, and the tool has been used in critically acclaimed games such as *Night in the Woods*, *A Short Hike*, *DREDGE*, *Venba*, and *Lost in Random*. ## Key Features - **Screenplay-like Format**: Write dialogue in a format similar to a script, making it accessible for writers without programming expertise. - **Interactive Elements**: Supports lines of dialogue, player options, and commands to trigger in-game actions. - **Engine-Agnostic Core**: The compiler and core logic are separate from any specific engine, allowing integration with multiple platforms. - **Unity Integration**: Official support for Unity, with installation options via the Unity Asset Store, Itch.io, or Git. ## Getting Started To use Yarn Spinner in a game, obtain the appropriate package for your engine. The primary official package is **Yarn Spinner for Unity**, which requires Unity 2021.3 or later. Full documentation, tutorials, and installation guides are available at [docs.yarnspinner.dev](https://docs.yarnspinner.dev). ## Community and Support - **Discord**: Join the [Yarn Spinner Discord](https://discord.gg/yarnspinner) for help, support, and community discussions. - **Documentation**: Comprehensive guides and API references are provided in the official docs. - **Contributing**: The project welcomes contributions, including documentation improvements, bug reports, and feature suggestions. See the [contributor's guide](CONTRIBUTING.md) for details. ## Credits and Funding Yarn Spinner is developed by Yarn Spinner Pty. Ltd., a spinoff of Secret Lab Pty. Ltd., with support from the NYU Game Center, an Epic Mega Grant, and the Australian Government through the Australia Council. The logo was designed by Cecile Richard. The project is sustained by Patreon supporters and purchases from storefronts like Itch.io. ## How to Help - **Financial Support**: Become a patron on [Patreon](https://patreon.com/secretlab) or purchase Yarn Spinner on [Itch.io](https://yarnspinner.itch.io). - **Report Issues**: Submit bugs or feature requests via the [IssuesDiscussion repo](https://github.com/YarnSpinnerTool/IssuesDiscussion/issues). - **Spread the Word**: Follow Yarn Spinner on [Bluesky](https://bsky.app/profile/yarnspinner.dev) and share your projects. For more details, visit the [official website](https://yarnspinner.dev).