Open-source project
YarnSpinnerTool/YarnSpinner avatar
YarnSpinnerTool/YarnSpinner

Yarn Spinner: an engine-agnostic core with exactly one official package, and issues in another repo

The core compiler and engine-agnostic components for Yarn Spinner, the friendly dialogue tool.

2,877 stars234 forksC#MIT

At a glance

What is it?
Yarn Spinner is a dialogue system for games, and this repository holds its compiler core in C# rather than the thing you ship in a build. The core calls itself engine-agnostic, yet there is a single first-party integration and it targets Unity only, the issue tracker is a different repository, and the compiler's front end is generated from a grammar.
Who is it for?
Read this repository as the piece that turns screenplay-like dialogue files into data, not as the runtime you integrate. That matters for two decisions.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 5 days ago.
What is it written in?
Mainly C#, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • YarnSpinnerTool/YarnSpinner2,877 ★ · +24
Star history
Repository2026-10-042026-11-15
YarnSpinnerTool/YarnSpinner2.9k2.9k

24 Stars in the last 42 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

This repository compiles dialogue, it does not run it

The getting started section is one sentence long and it defines the scope. This repository contains the core source code for the compiler, and if you want to use the system in a game you should get the appropriate package for your game engine, with the documentation named as the place to learn the next steps. So what is here is a compiler, not a runtime. The system itself is described as a dialogue tool that lets writers write interactive conversations in a simple screenplay-like format which is then loaded into the game and run, and while a conversation is running it sends the game three kinds of payload. Lines are dialogue to show, options let the player choose, and commands make things happen in the scene. Those three are the contract between the compiler output and whatever engine package you install. In the tree the pieces are laid out as a Visual Studio solution with a main library, a compiler project and a diagnostics project, which is where error reporting lives.

One official package, and it requires a specific Unity version

The project describes itself as engine-agnostic, and the official packages section is where that claim meets reality. There is exactly one entry. Yarn Spinner for Unity, requiring Unity 2021.3 or later, written by the team and officially supported. No Godot package, no Unreal package, no web or console package appears under that heading, which means every engine other than Unity is served by integrations the page does not list and does not vouch for. That is not a criticism so much as a shape: a portable core plus one first-party binding is a reasonable allocation of a small team's effort, and the community packages are where the other engines get covered. It does mean the word agnostic describes the compiler rather than the product, and anyone planning around a non-Unity engine should find that package first and read its own documentation, because the compiler repository will not tell them how their engine integrates.

MIT licensed here, sold on two storefronts, installable from Git

The funding arrangement is stated in the first callout on the page and it is worth reading precisely. To get Yarn Spinner and to support the team behind it, you are asked to buy a copy for Unity from an independent storefront or from the Unity Asset Store, or alternatively to check the documentation to install from Git. So the code in this repository carries a permissive licence, while the supported route for Unity users is a purchase, and the free route is a source install whose instructions live off-repository. Later the same arrangement is repeated without the Git alternative, followed by a paragraph naming the funding sources: Patreon supporters, purchases on storefronts, and an Australian arts funding body. The same paragraph points bug reports and feature requests at a separate repository rather than this one, which is an unusual arrangement for a codebase of this size and worth knowing before you file anything.

Bugs and feature requests go to a repository with a different name

There are four places the page sends you for help, and none of them is this repository's own issue tracker. There is a chat channel for support, discussion and what it calls chill community times. There is a separate issues repository, whose name makes its purpose obvious, described as containing the problems being solved and the features being considered, with the promise that any issue filed there improves the tool for everyone. There is a page on the project's own site inviting you to tell them about a game you are making with it, which is the same request that appears twice in slightly different words. And there is an account on a decentralized social network. The practical effect is that this repository's tracker is not where the conversation happens, so a bug found while reading the compiler source has to be carried somewhere else, and the compiler's own commit history is not the place to look for the roadmap.

The front end is generated, the version is derived, and the build output is synced

Three shell scripts sit at the root of a C# repository, and their names describe the whole build. One runs the parser generator, which is how a grammar-driven language gets its lexer and parser without checked-in generated code. One derives the version, which tells you the version string is not sitting in a properties file waiting to be edited but is computed at build time. One synchronises the built assemblies somewhere else, which is how a compiler that produces data files ends up shipping those data files to the packages and to anyone consuming the output. Around them sit a Visual Studio solution, a directory of editor settings for a different editor, and a documentation folder, so the repository carries both the code and a slice of its documentation. Nothing on the page explains how a change to the grammar reaches a shipped package, which is exactly the kind of thing the contributor guide is for.

Two test locations and a CI file from a retired era

The tree has both a top-level directory named for tests and a project directory named for tests inside the library, so tests are split across two locations without the page saying which convention is current. It also carries a configuration file for a continuous integration service that predates the current default for C# projects, alongside a directory for the current one, which suggests the older file is either still running or has been left behind. Either way it is the kind of leftover that tells you something about the project's history and very little about its present. The release record is steadier. Three tags in the recent list, a minor release in December 2025, another in late March 2026 and a patch in early May, while the default branch was pushed in mid-September 2026, so there is a steady minor cadence and a branch that keeps moving between patches.

A company, a parent studio, two grants and a government arts fund

The credits section is unusually complete for a project page, and it explains the funding model better than the funding section does. Yarn Spinner is developed by a company registered in Australia, and it is a spinoff of a game development studio. The logo has its own credit. Development is made possible in part by a university game centre and by an Epic Mega Grant, and the project has also been assisted by the Australian Government through its national arts funding and advisory body, which is a grant rather than a commercial investment. Alongside that sits a contribution section that says outright that you do not have to be a coder to help, and lists three ways to do it: improving the documentation, spreading the word, and finding bugs. It then asks for money twice more, through a membership platform and through storefront purchases, and points contributors at a guide before they start.

Editorial conclusion

Read this repository as the piece that turns screenplay-like dialogue files into data, not as the runtime you integrate. That matters for two decisions. If you are not on Unity, your integration is a third-party package and your upgrade path depends on whoever maintains it, because the officially supported list has one entry. If you are on Unity, the supported route on the page is a paid copy from one of two storefronts rather than a build from here, while the licence on this code is MIT and the documentation also points at installing from Git. Before filing anything, note that the issue tracker is a separate repository, so a bug reported here lands in the wrong place. The default branch was last pushed on 2026-09-16 and the newest release is v3.2.1 from 2026-05-05.

Frequently asked questions

what is yarn spinner

A dialogue system for games. Writers write interactive conversations in a simple screenplay-like format, the file is loaded into the game and run, and while a conversation runs the system sends the game lines of dialogue to show, options for the player to choose from, and commands to make things happen in the scene. It has been used in games including Night in the Woods, A Short Hike, DREDGE, Venba and Lost in Random.

is yarnspinner free

The code in this repository is MIT licensed, and the page also points at installing from Git through the documentation. For Unity users the supported route it asks for is a purchase from an independent storefront or from the Unity Asset Store, framed as supporting the team, and the project is funded by memberships, storefront sales and grants rather than by licence fees.

how to install yarnspinner

This repository is the compiler core, not the package you integrate, so the page sends you two ways: buy a copy for Unity from one of two storefronts, or follow the documentation to install from Git. For a game you also need the package for your engine, and the only officially supported one listed is Yarn Spinner for Unity, which requires Unity 2021.3 or later.

how to use yarnspinner

The page does not document usage, because this repository is the compiler rather than the runtime. It points at the documentation site for the next steps, and at the right package for your game engine. Writing is done in a screenplay-like format, and the game receives lines, options and commands while a conversation runs.

Official sources

  1. License: MIT
  2. Project website
  3. README
  4. Releases
  5. YarnSpinnerTool/YarnSpinner on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/yarnspinnertool-yarnspinner.svg)](https://hysenlabs.com/projects/yarnspinnertool-yarnspinner)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/yarnspinnertool-yarnspinner.svg)](https://hysenlabs.com/projects/yarnspinnertool-yarnspinner)

Was this useful?