Upgrade guide

Tips and best practices to upgrade the SDK while avoiding risk of data loss

If you wish to get started and install the coherence Unity SDK, please refer to the installation page.

Before upgrading, please make sure you backup your projects to avoid any data loss.

Upgrading — Asset Store installations

Within your project, delete the Packages/io.coherence.sdk directory — this is where the coherence SDK gets installed. Then, head to the Unity Package Manager, and search for coherence under My Assets. You will see a Download or an Import button. Use those buttons to download and import the latest version.

Upgrading — UPM Registry installations

Open Unity Package Manager and check the Packages - coherence section. It will state the currently installed version and if there are any recommended updates available:

Unity Package Manager showing coherence installation

Upgrade Guides

When upgrading coherence, please do it one major or minor version at a time (considering semantic versioning, so MAJOR.MINOR.PATCH).

For example, if your project is on 0.7 and would like to upgrade to 1.0, upgrade from 0.7 to 0.8, then from 0.8 to 0.9, and so on. Always back up your project before upgrading, to avoid any risk of losing your data.

Versions prior to 0.9 are considered legacy. We don't provide a detailed upgrade guide for those versions.

Refer to the specific upgrade guides provided as subsections of this article.

Refer to the troubleshooting section at any time to find solutions to issues found during or after upgrading.