📦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:
buy Yarn Spinner for Unity from our Itch.io store, download it, and add the package to your project from the
.unitypackage
buy Yarn Spinner from the Unity Asset Store, download it, and install it via Unity
install Yarn Spinner for Unity via the Unity Package Manager
install Yarn Spinner for Unity from GitHub
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:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FRT2JVsc4nR3Y5tVUR3Py%252FPNG%2520image.jpeg%3Falt%3Dmedia%26token%3D158e2ffb-1860-454e-acb4-086963fc3eb6&width=768&dpr=4&quality=100&sign=6c2e4c78&sv=1)
The download button will take you the following page, where you can download the Yarn Spinner for Unity .unitypackage
:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FKwuv6JYb4KaecNoAAfO6%252FPNG%2520image.jpeg%3Falt%3Dmedia%26token%3D1898535d-d6b0-4dfe-9f1c-182fb727137c&width=768&dpr=4&quality=100&sign=36254273&sv=1)
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:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FV3LLhB2w5pxq7VhtTW2N%252FScreenshot%25202023-11-29%2520at%25204.03.41%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D416dfe78-0a5c-4f72-8721-47c3643bba84&width=768&dpr=4&quality=100&sign=1a897d6d&sv=1)
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.
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FjYIf061rcKbFEf1sNLk3%252FScreenshot%25202024-01-31%2520at%25203.48.43%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D274d8bd6-6fdc-4022-b0f8-77e44e3380be&width=768&dpr=4&quality=100&sign=4b32b00d&sv=1)
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:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FWxtxiIMVxvljsAZQNu0k%252FScreenshot%25202024-01-31%2520at%25203.41.36%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D02d20ee7-00e9-4eed-ad6d-0e0c1b3c7793&width=768&dpr=4&quality=100&sign=bc64d397&sv=1)
Once the Package Manager has located the package, you can use the Download button to fetch it:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FkfvGg0NfqE2DFeg3oNqX%252FScreenshot%25202024-01-31%2520at%25203.42.04%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D7218a49a-a929-4ffb-a88f-eae4219abe38&width=768&dpr=4&quality=100&sign=b3f57c64&sv=1)
Once Yarn Spinner for Unity has downloaded, you can use the Import button to start the process of adding it to your project:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FxFwLtlC0zc8papvYmIaz%252FScreenshot%25202024-01-31%2520at%25203.43.55%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D3827788f-14cb-46e2-9926-c80d387addf9&width=768&dpr=4&quality=100&sign=b3cd0ca7&sv=1)
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:
![](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252FT4vi1QCsrGmwx1zYJKtv%252FScreenshot%25202024-01-31%2520at%25203.46.55%25E2%2580%25AFpm.png%3Falt%3Dmedia%26token%3D55255f29-c91b-4d7d-966e-dbd4bdc0eef4&width=768&dpr=4&quality=100&sign=cead7a62&sv=1)
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:
Next Steps
Once you've installed Yarn Spinner, you're ready to start using it!
Last updated