2.4 (Current)
Search
K
Links
📦

Installation for Unity

This page shows you how to install Yarn Spinner for Unity, the Unity integration for running Yarn and Yarn Spinner scripts in your Unity-based games.
You can download and install Yarn Spinner for Unity in four different ways:
Yarn Spinner is an open source project. You can directly support the Yarn Spinner Team by purchasing Yarn Spinner from Itch or the Unity Asset Store, but it will always also be available for free. To support the continued development of Yarn Spinner, purchasing Yarn Spinner for Unity from one of the storefronts. This is the best way to directly support the Yarn Spinner team.

Install from Itch.io

First, visit the Yarn Spinner Itch.io Store, and click the Buy Now button, and complete the checkout process.
Once you've purchased Yarn Spinner, you'll find a Download button at the top of the page:
The download button will take you the following page, where you can download the Yarn Spinner for Unity .unitypackage:
Once you've downloaded the .unitypackage, with the Unity project you want to use it in open and ready to go, double click it. Unity will then allow you to import the package into your project:

Install from the Unity Asset Store

First, visit the Unity Asset Store page for Yarn Spinner for Unity, and add it to your cart, and complete your purchase while logged into the same Unity account you use to activate Unity.
Once you've purchased Yarn Spinner for Unity, you'll find the Add to Cart button replaced by an Open in Unity button. Click this button to launch Unity, and the Package Manager will locate your purchased package:
Once the Package Manager has located the package, you can use the Download button to fetch it:
Once Yarn Spinner for Unity has downloaded, you can use the Import button to start the process of adding it to your project:
This will trigger the Import Unity Package workflow, where you can use the Import button to add the Yarn Spinner for Unity package to your project:
And with that, you're ready to use Yarn Spinner! You might also want to download and import the Yarn Spinner for Unity Samples as a .unitypackage, from here.
You can review Unity's documentation for using the Asset Store for further guidance on working with purchased packages.

Installing from other sources

If you would prefer to download and install Yarn Spinner for Unity outside of Itch or the Unity Asset Store, we provide the following methods:
Install via the Unity Package Manager

Install via the Unity Package Manager

You can also install the Yarn Spinner package into your project using the Package Manager window in Unity. Specifically, Yarn Spinner is available via the OpenUPM registry.
In order to follow the instructions in this section, your project needs to be using Unity 2020.1 or higher. If your project is using an earlier version of Unity, we recommend installing Yarn Spinner from Git.

Setting Up the OpenUPM Registry in Your Project

Before you can install Yarn Spinner from OpenUPM, you first need to configure your project so that it knows where to get the package from.
  1. 1.
    In Unity, open the Edit menu, and choose Project Settings.
  2. 2.
    In the list of sections at the left hand side of the window, select Package Manager.
This window is where you tell Unity about where to find packages that come from registries besides Unity's built-in one.
  1. 1.
    In the Name field, type OpenUPM.
  2. 2.
    In the URL field, type https://package.openupm.com.
  3. 3.
    In the Scopes field, type dev.yarnspinner.
  4. 4.
    Click Save.
When you're done, the settings window should look like this:
You can now install Yarn Spinner itself.

Installing the Yarn Spinner package

  1. 1.
    Open the Window menu, and choose Package Manager.
  2. 2.
    In the toolbar, click Packages: In Project, and choose My Registries.
  1. 1.
    Yarn Spinner will appear in the list. Select it, and click Install.
Yarn Spinner will download and install into your project.
You can verify that everything is imported succesfully by looking for Yarn Spinner under Packages, in the Project pane.
Verify that Unity has the package by checking the Packages folder of the Project pane.
Install from GitHub

Install from GitHub

As an alternative to downloading Yarn Spinner from OpenUPM, you can install Yarn Spinner by downloading the package directly from GitHub, where the project's source code is stored.
Where possible, we recommend installing Yarn Spinner via a purchased .unitypackage, or from OpenUPM rather than GitHub, because it's easier to update to new versions.
To install Yarn Spinner from GitHub, follow these instructions.
  1. 2.
    In Unity, open the Window menu, and choose Package Manager.
  2. 3.
    Click the + button, and choose "Add package from git URL".
  3. 4.
    In the text field that appears, enter the following URL: https://github.com/YarnSpinnerTool/YarnSpinner-Unity.git#current Be sure to type the URL exactly as it appears in this document.
  4. 5.
    The project will download and install. This might take a moment.

Next Steps

Once you've installed Yarn Spinner, you're ready to start using it!