Yarn Spinner for Unity

Yarn Spinner for Unity lets you write your game’s dialogue in Yarn and run it in Unity. It’s a package of components, assets and editor tools that you add to your Unity project.

You write dialogue in .yarn files, in the same Yarn language used by every version of Yarn Spinner. Unity compiles them when it imports them, as part of a Yarn Project. In your scene, a Dialogue Runner plays the dialogue, and Presenters put it on screen: lines of text, options for the player to choose from, voice-over, or anything else you build. Commands and Functions connect your Yarn Scripts to your C# code, so a line of dialogue can move a character, and your game can decide which options appear.

Click to play video By playing, you accept YouTube cookies

What you need

Requires Unity 2022.3.x or later For Yarn Spinner 3.3.x

• If you need to use an older version of Unity, use Yarn Spinner 2.x.
• The Yarn Spinner for Unity package. Installation explains how to get it and add it to your project.

Where to start

If you’re new to Yarn Spinner, start with Installation, below. Then read Understanding Yarn Spinner, Setting Up Your Unity Project and Showing Dialogue in order. Together they take you from an empty project to a conversation running in your game.

If you’ve used Yarn Spinner with another engine, you already know the basics. Showing Dialogue and Connecting to Your Game cover how they work in Unity.

The samples show most features working in real scenes.