Unity Installation

This page covers package installation only. Continue with Unity Quick Start after the SDK is installed.

Prerequisites

• Windows 10 or newer
• Unity 2022.3 LTS
• A registered appId

Choose an installation method

The release provides two complete offline carriers with the same features:

Method	Best for	Location and upgrade behavior
Unity Package	Existing projects and established import workflows	Imports into Assets/IGP.UnitySDK*; reimporting performs file-level replacement
UPM .tgz	New projects and package-level version management	Managed by Package Manager and recorded in Packages/manifest.json and the lock file

Use only one carrier for each module. Never install the same module from both a .unitypackage and UPM.

All integrations install Core first, followed by Multiplayer, Compliance, or GameKit as needed. Core resolves the current Unity runtime platform and creates exactly one matching Desktop or Mobile Host Session runtime; users do not configure this choice. Public Multiplayer has no initialization-mode setting; it creates only the RoomNode Game data plane and can request a descriptor from Core or accept one explicitly from its caller.

Install Unity Packages

Download the required files for the current version from Release Notes:

• cn.indiegp.sdk.unity-0.3.4.unitypackage - Core (required)
• cn.indiegp.sdk.unity.multiplayer-0.3.4.unitypackage - Multiplayer (optional)
• cn.indiegp.sdk.unity.compliance-0.3.4.unitypackage - compliance (optional)
• cn.indiegp.sdk.unity.game-kit-0.3.4.unitypackage - GameKit / Leaderboard / Share (optional)

Core requires com.unity.nuget.newtonsoft-json; Multiplayer also requires com.unity.ugui. Add missing dependencies through Package Manager first:

"com.unity.nuget.newtonsoft-json": "3.2.1",
"com.unity.ugui": "1.0.0"

In Unity Editor, choose Assets > Import Package > Custom Package.... Import Core first, then each optional module the project needs, with all SDK files selected.

Install offline UPM tarballs

Download the matching .tgz files:

• core-igp-0.3.4.tgz - Core (required)
• multiplayer-igp-0.3.4.tgz - Multiplayer (optional)
• compliance-igp-0.3.4.tgz - compliance (optional)
• game-kit-igp-0.3.4.tgz - GameKit / Leaderboard / Share (optional)

For each package:

1. Open Window > Package Manager.
2. Open the + menu and select Add package from tarball....
3. Select core-igp-0.3.4.tgz first, wait for compilation, then add optional modules.

The short archive name only affects the downloaded file. Package Manager still shows the stable cn.indiegp.sdk.unity* package IDs. Do not edit Unity’s package cache.

For teams and CI, keep tarballs at a stable repository path such as LocalPackages/. Package Manager records an entry similar to:

"cn.indiegp.sdk.unity": "file:../LocalPackages/core-igp-0.3.4.tgz"

Commit Packages/manifest.json, Packages/packages-lock.json, and the referenced tarballs so every developer and clean CI agent resolves the same paths. UPM does not download a missing local tarball from this site.

Migrate from Unity Packages to UPM

Migrate without changing the SDK version first:

1. Back up or move project-owned IGPConfig assets, modified samples, and custom scripts.
2. Record the installed modules and version.
3. Delete the matching legacy directories: Assets/IGP.UnitySDK, Assets/IGP.UnitySDK.Multiplayer, Assets/IGP.UnitySDK.Compliance, and Assets/IGP.UnitySDK.GameKit.
4. Install the same-version Core tarball, followed by the optional modules previously used.
5. Restore and explicitly bind project-owned configuration, then check scenes and prefabs for missing scripts.
6. After the Console is free of duplicate type or assembly errors, upgrade tarballs if needed.

The SDK does not scan, move, or automatically repair project assets. Removing legacy directories and migrating project-owned content are explicit integration steps.

Update or remove UPM packages

To update, select the target version with Add package from tarball... and verify that the manifest and lock file point to the new tarball. Keep all installed IGP modules on the same SDK version.

To remove packages, remove optional modules in Package Manager first and remove Core last.

Verify installation

• Unity Package: the expected Assets/IGP.UnitySDK* directories exist.
• UPM: Package Manager lists the expected cn.indiegp.sdk.unity* packages and no legacy directory for the same module remains.
• The Console has no SDK compilation, duplicate assembly, or dependency resolution errors.
• Every installed public IGP module has the same version.

Continue with Unity Quick Start.

See Unity’s documentation for installing from a local tarball and package dependencies and resolution.