如何阅读 IGP Developer Docs

IGP Developer Docs 是 面向游戏开发者 的官方文档入口。本页说明本站应该按什么顺序阅读，以及不同类型页面各自解决什么问题。

当前首批公开内容主要围绕游戏接入 IGP 平台能力。文档分为三层：

• 按功能使用：说明 SDK 的能力范围、各能力支持的引擎，以及同一能力在不同引擎中的接入方式。
• 引擎接入细节：补充 Unity、GameMaker、Godot 的安装、Quick Start、调试和示例工程说明。
• 包级接入指南：说明具体 SDK 包的安装组合、接口用法、接入案例、请求 / 返回字段、参数含义、错误处理和当前限制。

如何阅读本站

如果是首次接入，建议按下面顺序阅读：

1. 先看 功能总览，确认 IGP SDK 当前支持哪些能力，以及目标能力是否支持你的引擎。
2. 再看 启动与连接，确认 appId、IGP 桌面客户端连接和初始化方式。
3. 然后进入 引擎接入细节，按项目使用的引擎阅读安装、Quick Start 和调试说明。
4. 如果使用 Unity 可选包，再阅读对应的包级接入指南。例如排行榜和分享能力从 Unity 概览、Unity 安装 或左侧侧栏的 GameKit / Leaderboard / Share 进入。
5. 接入完成后，按 联调与测试 检查本地流程。
6. 升级或下载包时，最后查看 Release Notes 和 Changelog。

包级网页由各包内的 Documentation~/DEVELOPER-GUIDE.zh-CN.md 同步生成。以后每个公开包都应有对应网页，用来查看更细的接入案例、字段含义、参数说明和接口限制。

当前收录什么内容

• 功能使用文档：将同一能力集中在一页，并按引擎提供示例代码。
• 引擎细节文档：说明各引擎当前能力范围、安装方式和最小验证流程。
• 版本与下载：集中列出当前公开包、下载链接和校验值。
• 调试与联调说明：覆盖本地验证、常见卡点和示例工程。

这些文档背后对应的 IGP 平台能力，当前主要包括：

• 正版校验：在游戏启动时校验当前玩家是否在 IGP 平台上合法持有这款游戏。
• 联机房间：创建 / 加入 / 离开房间，配套 ready、start、finish 生命周期事件。
• 实时通信：房间内玩家之间的可靠消息通道，大消息自动分片。
• 状态与 RPC：跨端同步玩家状态、点对点调用房间内其他玩家的逻辑。
• 成就：解锁与进度上报。
• 实名认证与防沉迷：读取当前是否可玩，以及状态变化原因；支持“启动拦截”和“游戏内实名”两种处理方式。

支持的引擎

引擎	能用吗	说明
Unity	✅ Preview	首选交付引擎，能力覆盖最全，当前文档最完整。
GameMaker	⚠️ Preview	覆盖正版校验、实名认证与防沉迷和成就主流程，暂不支持联机房间。
Godot	🚧 开发中	暂无对外发布包。
Unreal	⏳ 规划中	尚未开始。

开始接入

• 初次阅读文档时，建议从 按功能使用 SDK 开始，先了解当前能力范围。
• 已确定目标能力时，进入对应功能页，确认支持引擎、接入前提和自测方式。
• 需要安装、Quick Start 或调试说明时，再查看 引擎接入细节。
• 需要查看 Unity 可选包的字段、参数或完整调用案例时，再进入对应包级指南，例如 GameKit / Leaderboard / Share。
• 接入任何能力前，需先确认 启动与连接 中的初始化方式。
• 接入完成后，按 联调与测试 完成检查。
• 如需验证 Unity 最小流程，请查看 Unity Quick Start。
• 如需验证 GameMaker 最小流程，请查看 GameMaker Quick Start。
• 如需查看当前可用版本与下载包，请查看 Release Notes。