SDK 1.1
Ask or search…
K
Links

Installation

Requirements

Game engine support

coherence currently supports Unity. For custom engine integration, please contact our developer relations team. For updates regarding Unreal Engine support, please check the Unreal Engine support page.

Unity requirements

  • Latest Unity 2021 LTS and 2022 LTS are officially supported. Check LTS Releases.
  • The minimum supported version is now Unity 2021.3 LTS.

Supported Operating Systems

  • A Windows, Linux or macOS system.

Video Tutorial

Unity Package Manager

1. Add the Scoped Registry

First, open Unity's Project Settings.
Under Package Manager, add a new Scoped Registry with the following information:
  • Name: coherence
  • URL: https://registry.npmjs.org
  • Scope(s): io.coherence.sdk
  • Enable Preview / Pre-release Packages: yes
Package Manager Advanced Settings

2. Install coherence

Now open the Window / Package Manager.
Select My Registries in the Packages dropdown.
Under coherence, click Install.

Alternative method: edit manifest.json manually

Refer to Unity's instructions on modifying your project manifest.
Edit <project-path>/Packages/manifest.json.
Add an entry for the coherence sdk on the dependencies object, and for the scoped registry in the scopedRegistries array:
{
"dependencies": {
"com.unity.collab-proxy": "1.3.9",
"com.unity.ide.rider": "2.0.7",
"com.unity.ide.visualstudio": "2.0.7",
"com.unity.ide.vscode": "1.2.3",
"com.unity.test-framework": "1.1.24",
"com.unity.textmeshpro": "3.0.1",
"com.unity.timeline": "1.4.6",
"com.unity.ugui": "1.0.0",
/*** ADD THIS START ***/
"io.coherence.sdk": "1.0.0",
/*** ADD THIS END ***/
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
"com.unity.modules.animation": "1.0.0",
"com.unity.modules.assetbundle": "1.0.0",
"com.unity.modules.audio": "1.0.0",
"com.unity.modules.cloth": "1.0.0",
"com.unity.modules.director": "1.0.0",
"com.unity.modules.imageconversion": "1.0.0",
"com.unity.modules.imgui": "1.0.0",
"com.unity.modules.jsonserialize": "1.0.0",
"com.unity.modules.particlesystem": "1.0.0",
"com.unity.modules.physics": "1.0.0",
"com.unity.modules.physics2d": "1.0.0",
"com.unity.modules.screencapture": "1.0.0",
"com.unity.modules.terrain": "1.0.0",
"com.unity.modules.terrainphysics": "1.0.0",
"com.unity.modules.tilemap": "1.0.0",
"com.unity.modules.ui": "1.0.0",
"com.unity.modules.uielements": "1.0.0",
"com.unity.modules.umbra": "1.0.0",
"com.unity.modules.unityanalytics": "1.0.0",
"com.unity.modules.unitywebrequest": "1.0.0",
"com.unity.modules.unitywebrequestassetbundle": "1.0.0",
"com.unity.modules.unitywebrequestaudio": "1.0.0",
"com.unity.modules.unitywebrequesttexture": "1.0.0",
"com.unity.modules.unitywebrequestwww": "1.0.0",
"com.unity.modules.vehicles": "1.0.0",
"com.unity.modules.video": "1.0.0",
"com.unity.modules.vr": "1.0.0",
"com.unity.modules.wind": "1.0.0",
"com.unity.modules.xr": "1.0.0"
}, /* add this comma if not already present */
/*** ADD THIS SECTION START ***/
"scopedRegistries": [
{
"name": "coherence",
"url": "https://registry.npmjs.org",
"scopes": [
"io.coherence.sdk"
]
}
]
/*** ADD THIS SECTION END ***/
}
You will then see the package in the Package Manager under My Registries.
When you successfully install the coherence SDK the Welcome Window will show.
Make sure you allow HTTP connections in Editor to avoid InvalidOperationException: Insecure connection not allowed errors.
Find out how to enable HTTP connections in Unity's InsecureHttpOption article.