Repolode
Submit
YarnSpinnerTool

YarnSpinnerTool/YarnSpinner-Unity

Official Unity integration for Yarn Spinner, a screenplay-style dialogue system for running branching conversations in games.

View on GitHub
Stars
840
Forks
129
Open issues
5
Last commit
7 days ago

What is it?

Yarn Spinner for Unity connects the Yarn Spinner dialogue system to the Unity engine. Writers author conversations in a simple, screenplay-like format, and the integration loads those scripts into a Unity game and runs them.

While a conversation runs, the game receives lines of dialogue to display, options for the player to choose from, and commands that trigger actions in the scene. This lets narrative designers write dialogue without needing to modify game code for each line.

The project is distributed as a Unity package and can be installed through the Unity Asset Store, Itch.io, or Git. The core Yarn Spinner compiler lives in a separate repository.

Key features

  • 01Write dialogue in a simple, screenplay-like script format.
  • 02Delivers lines, player options, and commands to the game during a conversation.
  • 03Integrates with the Unity engine as a package.
  • 04Core compiler is maintained separately in the main Yarn Spinner repository.

Use cases

  • Adding branching dialogue and choices to a 2D or 3D Unity game.
  • Letting writers author conversations without editing C# code.
  • Triggering scene actions such as animations or events from dialogue commands.

Quick start

  1. 1

    Open the Yarn Spinner documentation for installation instructions

  2. 2

    Join the Discord for help if you get stuck

Things to know

  • Installation and setup are described only in the external documentation, not in this README.
  • Commercial distribution is typically purchased via the Itch.io or Unity Asset Store, though the project is MIT licensed.

Topics

#game-development#gamedev#unity#dialogue#narrative#csharp

FAQ

What is YarnSpinner-Unity?
Official Unity integration for Yarn Spinner, a screenplay-style dialogue system for running branching conversations in games. Yarn Spinner for Unity connects the Yarn Spinner dialogue system to the Unity engine. Writers author conversations in a simple, screenplay-like format, and the integration loads those scripts into a Unity game and runs them.
Is YarnSpinner-Unity free to use? What license does it have?
YarnSpinner-Unity is open source under the MIT license. Check the license terms before using it in commercial products.
Is YarnSpinner-Unity still maintained?
Actively maintained. The last commit to YarnSpinner-Unity was on Oct 13, 2026.
What can I use YarnSpinner-Unity for?
Adding branching dialogue and choices to a 2D or 3D Unity game. Letting writers author conversations without editing C# code. Triggering scene actions such as animations or events from dialogue commands.
How do I install YarnSpinner-Unity?
Open the Yarn Spinner documentation for installation instructions Join the Discord for help if you get stuck
Where can I get YarnSpinner-Unity?
The source code and installation instructions are on GitHub: https://github.com/YarnSpinnerTool/YarnSpinner-Unity

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects