Installation
If you are looking to update, check out the upgrade guide and the release notes.
Supported Unity versions
6.5
6000.5.0f1
6.4
6000.4.0f1
6.3 LTS
6000.3.0f1
6.0 LTS
6000.1.17f1
2022 LTS
2022.2.5f1
2021
2021.3.45f2
Legacy — works but not actively supported anymore.
We follow Unity's release cycles closely to support Recommeded versions of the Unity Editor. If you experience issues working with these versions, please reach out to us.
Additionally, we support newer versions as soon as we can. If you're on a bleeding-edge Unity version and are experiencing issues, get in touch with us.
Option 1 — Scoped Registry via Unity Editor
In your Unity project, go to Edit > Project Settings. Under Package Manager, add a new Scoped Registry with the following information:
Name:
coherenceURL:
https://registry.npmjs.orgScope(s):
io.coherence.sdk

The Scoped Registry is added. Next, let's tell Unity to install coherence from it.
Open the Package Manager Window via Window > Package Management > Package Manager or the icon in Unity's Main Toolbar.

coherence is available through the My Registries section.

Select the coherence registry in the left panel, then the coherence package in the main panel, and click Install in the right panel.
Option 2 — Scoped Registry via manifest.json
Refer to Unity's instructions on adding a Scoped Registry for more in-depth documentation.
Edit <unity-project>/Packages/manifest.json with the additions highlighted below:
{
"dependencies": {
"io.coherence.sdk": "2.2.0",
"com.unity.ugui": "1.0.0",
"com.unity.modules.imgui": "1.0.0",
/* ... */
},
"scopedRegistries": [
{
"name": "coherence",
"url": "https://registry.npmjs.org",
"scopes": [
"io.coherence.sdk"
]
}
]
}Once Unity is focused, this file is reloaded and installation begins.
Option 3 — Asset Store
When installing through Asset Store, coherence is installed via .unitypackage and installs the package in Packages/io.coherence.sdk, becoming embedded (see Unity's Documentation on Package Sources). This makes upgrading fragile, since files being renamed or moved will definitely break compilation and introduce unexpected issues. Refer to the Upgrade Guide if you decide to use the Asset Store version.
When you successfully install coherence, you should be welcomed with the coherence Hub.

Last updated
Was this helpful?


