YarnSpinnerTool/YarnSpinner-Unity v2.3.0-beta2 on GitHub

Yarn Spinner is made possible by your generous patronage. Please consider supporting Yarn Spinner's development by becoming a patron!

👩‍🚒 Getting Help

There are several places you can go to get help with Yarn Spinner.

Join the Yarn Spinner Discord.
Tweet at us, at @YarnSpinnerTool.
To report a bug, file an issue on GitHub.

📦 How To Install Yarn Spinner

To install the most recent release of Yarn Spinner for Unity, please see the Installation Instructions in the Yarn Spinner documentation.

If you want to install this particular version of Yarn Spinner for Unity, follow these steps:

Installing Yarn Spinner for Unity v2.3.0-beta2 from Git

Open the Window menu, and choose Package Manager.
If you already have any previous version of the Yarn Spinner package installed, remove it.
Click the + button, and click Add package from git URL...
Enter the following URL:
- https://github.com/YarnSpinnerTool/YarnSpinner-Unity.git#v2.3.0-beta2

Each release will have a different URL. To upgrade to future versions of Yarn Spinner, you will need to uninstall the package, and reinstall using the new URL.

📜 Changes

Added

The .yarnproject importer has been updated to use new JSON-formatted Yarn Projects.
- JSON-formatted Yarn Projects replace the previous format, which stored all import data in Unity's .meta files.
- JSON-formatted Yarn Projects allow a single Yarn script to be used in multiple Yarn Projects, and also allow the Yarn Spinner compiler to support upcoming new features.
- Yarn scripts no longer need to be manually associated with a Yarn Project. If they are in the same folder, or a subfolder, of the Yarn Project, they will be included.
- When you update to 2.3.0-beta2, all Yarn scripts and Yarn Projects will be re-imported.
  - You will receive import errors on your existing Yarn Projects, telling you that your Yarn Project needs to be upgraded. To do this, follow the message's instructions: select the project, and click Upgrade Yarn Project in the Inspector.
  - After upgrading your projects, you will need to set up your localisations again by adding them in the Yarn Project's inspector and dragging in your strings file and asset file.
  - If your project uses any Yarn files that are not in the same folder, or subfolder, of the Yarn Project, you will need to move the Yarn files to the folder.
  - Your Yarn scripts, strings files, and localised assets will not be modified, and you won't need to change any objects in your scenes or prefabs. The only thing that will be changed is the Yarn Project file.
For more information on the new Yarn Project file format, see the changelog for the Yarn Spinner compiler.
The Unity Localization integration is now available when the Localization package is installed.
- Prior to this change, the YARN_USE_EXPERIMENTAL_FEATURES scripting definition symbol needed to be added to the Player settings.
You can now add a Dialogue System prefab to your scene by opening the GameObject menu and choosing Yarn Spinner -> Dialogue Runner.
Added 'On Dialogue Start' event to Dialogue Runner. This event is called when the dialogue starts running. (@nrvllrgrs)

Changed

Dialogue Runner will now report an error and stop early if you tell it to start running a node that isn't in the provided Yarn Project.
Dialogue Runner's 'On Dialogue Complete' event will now fire when you stop it via by calling the Stop() method.