Unity Overview

The IGP Unity SDK integrates game authorization, multiplayer rooms, realtime messaging, achievements, and real-name verification and anti-addiction into Unity games. Integration only needs an appId; the SDK handles communication with the IGP desktop client and backend services.

This page only covers Unity-specific details. For feature-level integration steps, start with the relevant page under “Use the SDK by feature”.

Feature list

• Game authorization: verify at launch that the current player legitimately owns the game on IGP, with authorized_online and authorized_offline results (protocol side: RequestGameAuthorization).
• Desktop client connection: connect to the local IGP desktop client, retry when needed, start it on demand, and check available capabilities.
• Rooms: create, join, and leave rooms with ready, start, and finish lifecycle events, with symmetric host and guest flows.
• Realtime messaging: reliable room messaging, KCP data-plane messaging, and automatic fragmentation for large payloads.
• State and RPC: synchronize player state across endpoints and invoke logic on other players in the room.
• Achievements: unlock achievements and report progress.
• Real-name verification and anti-addiction module: optional status events, age range reads, and remaining play-time reads.
• Mirror transport: optional transport package for Unity projects that already use Mirror.

Prerequisites

• Unity 2022.3 LTS or newer
• Windows 10 or newer
• IGP desktop client installed locally
• An appId assigned by IGP operations

Package layout

Install with Unity import packages. Three packages are available depending on project needs:

Package	Purpose	Applicable projects
cn.indiegp.sdk.unity	Main package with runtime and Editor tooling	Required for every integration
cn.indiegp.sdk.unity.mirror-transport	Mirror transport adapter	Only projects that already use Mirror
cn.indiegp.sdk.unity.compliance	Real-name verification and anti-addiction helpers	Projects that need state and event reads

The main package also ships with these samples under Assets/IGP.UnitySDK/Samples after import:

• StarterDemo - minimum integration example
• RoomLifecycle - room lifecycle walkthrough
• RealtimeMessaging - realtime / state / RPC demo
• Achievements - achievement unlock and progress demo
• HostedPlayground - combined manual integration playground

Start integrating

1. Install the package: Unity Installation
2. Complete the minimal validation flow for your target capability: Unity Quick Start
3. Confirm the base flow: Startup and connection
4. Continue with the target feature:
   • Game authorization
   • Real-name verification and anti-addiction
   • Achievements
   • Multiplayer lobby
5. Complete the relevant checks: Testing
6. For Editor debugging of desktop capabilities or the complete room flow: Unity Debugging
7. For the latest version and download links: Release Notes

Current limitations

• Preview phase: APIs may still contain incompatible changes, so pin an exact version.
• Windows 10 and later only. Other operating systems are out of scope.
• Multiplayer room flows depend on the local IGP desktop client launching the game. Pure headless environments such as CI or cloud builds are not the target use case for the room path right now.

Trademark and copyright notice

This page and the IGP Unity SDK are not sponsored by or affiliated with Unity Technologies or its affiliates, and do not imply endorsement by Unity Technologies or its affiliates.

Unity, Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere. Use of Unity trademarks, logos, and brand assets should follow the Unity trademark guidelines.