# IGP Unity SDK 文档中心

建议按下面的顺序阅读。

## 1. 外部开发者先看这里

- [START HERE](START-HERE.md)
  外部 Unity 开发者的第一入口。先到 Curio desktop 的 `设置 -> 关于` 打开 `SDK 联调 Beta`，再看完整体流程，决定先用 Editor 还是打包版。

- [EDITOR DEBUG](EDITOR-DEBUG.md)
  默认主线文档。讲怎么把 desktop 生成的 Unity 启动包喂给 Inspector，并在 Editor 里完成联调。

- [TROUBLESHOOTING](TROUBLESHOOTING.md)
  第一阶段排错总表。先确认 `SDK 联调 Beta` 已打开，再看房间、启动包和日志。

## 2. 再看接入入口

- [Unity Quick Start](QUICKSTART.md)
  先用一条最短路径在干净 Unity 工程里接入 `IGP.UnitySDK`。

- [Mirror Transport Quickstart](../../IGP.UnitySDK.MirrorTransport/Documentation~/QUICKSTART.md)
  如果项目已经用了 Mirror，并且要把 Mirror 的 `Transport` 接到 IGP，直接看这份可选包说明。

- [Authorization](AUTHORIZATION.md)
  适合接授权验证主链路，确认启动路径、失败状态和游戏方自定义处理方式。

- [Compliance](../../IGP.UnitySDK.Compliance/README.md)
  适合接防沉迷事件。SDK 只通知游戏当前事件，限制进入、退出、切账号和提示由游戏自行处理。

- [Lying Bottle](../../IGP.UnitySDK.LyingBottle/README.md)
  适合接 Lying Bottle。游戏侧只描述业务请求，JWT、HMAC 和 replay headers 由 desktop 处理。

- [Cloud Archive](../../IGP.UnitySDK.CloudArchive/README.md)
  适合接云存档。游戏侧只传 slot、data 和 version，用户认证与 API 转发由 desktop 处理。

- [Unity Event Reference](EVENT-REFERENCE.md)
  适合集中查看 Unity 现在能接的事件清单，以及哪些已经接上主链路。运行中换地图时，游戏侧监听 `IGPRuntimeManager.onMapChanged` 或 `IGPEventManager.onMapChanged`。

- [START HERE](START-HERE.md)
  如果你的项目之前接的是 `Arena.UnitySDK`，或者你想直接按新的最短接入流程开始，这一页就是入口。

- [Package README](../README.md)
  先看包结构、安装方式和最小接入路径。

- [Unity Starter Demo](../Samples~/StarterDemo/README.md)
  在 `Quick Start` 跑通后，优先用这份最小代码样例看包内正式推荐的接法。

## 3. 再看专项文档

- [错误代码参考](ERROR-CODES.md)
  适合排查 hosted room、realtime、data plane 和 achievements 相关错误。

- [KCP 心跳与 RTT 监控指南](KCP-HEARTBEAT-RTT-GUIDE.md)
  适合需要观察统一可靠数据面的健康度、调优心跳和读取 RTT 的场景。

- [已知限制](KNOWN-LIMITATIONS.md)
  适合确认当前 Unity 首版交付的支持边界。

- [Third-Party Notices](THIRD-PARTY-NOTICES.md)
  适合查看包内 vendored 第三方代码、命名空间隔离说明和许可证文本。

## 4. 按接入目标选 sample

| 场景 | 建议 sample |
| --- | --- |
| 最短接入验证 | `Samples~/StarterDemo` |
| 房间生命周期 | `Samples~/RoomLifecycle` |
| realtime message / state / RPC | `Samples~/RealtimeMessaging` |
| achievements | `Samples~/Achievements` |
| UI playground | `Samples~/HostedPlayground` |

## 5. 当前模式提醒

当前文档默认前提是：

- Windows
- Curio desktop 宿主模式
- 房间由 desktop 统一创建和加入
- Unity 是 IGP SDK 的一个引擎适配层，而不是平台协议本身

如果你在做跨引擎 SDK 设计，不要把这里的 Unity 组件 API 当成平台标准协议。
优先参考仓库里的 `core/`、`bridge/` 和跨引擎路线文档。
