How to read the docs
For a first integration, start with the recommended order: feature overview, startup and connection, engine integration, package guides, testing, and release notes.
How to read the docs
For a first integration, start with the recommended order: feature overview, startup and connection, engine integration, package guides, testing, and release notes.
Package-level guides
Unity optional packages document API examples, request / response fields, parameter meanings, and limitations on their own pages.
Feature overview
Review support status for each feature across Unity, GameMaker, and Godot.
Startup and connection
Confirm appId, desktop client connection, and room startup flow when needed before integrating SDK features.
Game authorization
Verify whether the player legitimately owns the game on IGP.
Real-name verification and anti-addiction
Read the current playability state, restriction reason, and state changes.
Achievements
Unlock achievements and report achievement progress.
Multiplayer lobby
Understand the integration order for rooms, realtime messaging, state and RPC, and Mirror transport.
Details overview
After confirming the target feature, open the installation, Quick Start, and debugging notes for your engine.
Unity
Primary delivery engine. It has the broadest feature coverage and is suitable for formal integration and full local testing.
Godot
The Godot adapter is still in development and can be used to evaluate startup, rooms, messaging, and achievements.
GameMaker
The first GameMaker release targets Windows 10 and later, with game authorization, real-name verification and anti-addiction, and achievements.
Testing
Check local integration results by feature and by engine.
Release Notes
Check current public downloads, versions, and checksums.
Changelog
See the concrete changes in each version.
Human readers should start with How to read the docs. llms.txt and llms-full.txt are whole-site indexes for IDEs, AI agents, and automation tools; they do not replace the human integration path.
llms.txt: compact index for helping tools understand the site structure quickly.llms-full.txt: full content for tools like Cursor, Claude, and ChatGPT.