Use the SDK by feature
These pages answer three questions: what a feature does, what a project must prepare, and in which order to integrate it. They intentionally avoid API-level detail. After choosing a feature, use the engine-specific guides for the actual project steps.
Core capabilities
Section titled “Core capabilities”- Startup and connection: identify the app and establish a Desktop Session.
- Game authorization: confirm that the player may legitimately launch the game.
- Real-name verification and anti-addiction: handle verification requirements, play eligibility, and restrictions.
- Achievements: unlock achievements and report cumulative progress.
Unity, GameMaker, and Godot all provide Preview entry points for these capabilities. They use a Desktop Session from the local IGP desktop client, and a regular integration only needs the platform-issued appId. Unity and Godot require an additional Compliance package for real-name verification and anti-addiction.
Multiplayer lobby capabilities
Section titled “Multiplayer lobby capabilities”| Feature | Primary purpose | Unity | GameMaker | Godot | Prerequisite |
|---|---|---|---|---|---|
| Multiplayer lobby | Entry point for room-based multiplayer | Preview | Not supported | In development | Launched by the IGP desktop client |
| Rooms | Ready, start, finish, and leave | Preview | Not supported | In development | Launched by the IGP desktop client |
| Realtime messaging | Send custom messages in a room | Preview | Not supported | In development | Joined a room |
| State and RPC | Synchronize state and invoke remote logic | Preview | Not supported | In development | Joined a room |
| Mirror transport | Connect Unity Mirror projects to IGP transport | Preview, optional package | Not applicable | Not applicable | Unity, Mirror, and a joined room |
Recommended order
Section titled “Recommended order”- Complete Startup and connection and verify
appId, initialization, and the Desktop Session. - Integrate Game authorization and decide how the game handles online authorization, offline authorization, and failures.
- If required, add Real-name verification and anti-addiction and define the blocking policy.
- Create achievement definitions in the backend, then integrate Achievements.
- For multiplayer, continue from Multiplayer lobby. A ready Desktop Session is not the same as joining a room.
Status definitions
Section titled “Status definitions”- Preview: a public package and usable entry point exist, but the API may still change during preview.
- In development: an implementation exists in the repository but is not a stable entry point in the current public release.
- Not supported: the current public release has no entry point for this feature.
- Not applicable: the feature only applies to a specific engine or technology stack.