Unity 概览
IGP Unity SDK 用于将 Unity 游戏接入 IGP 平台的正版校验、联机房间、实时通信、成就、实名认证与防沉迷能力。接入方只需配置 appId,SDK 会处理与 IGP 桌面客户端和后台服务之间的通信。
本页仅说明 Unity 引擎相关细节。具体功能接入方式,请优先查看“按功能使用”中的对应页面。
- 正版校验:在游戏启动时确认当前玩家是否在 IGP 平台上合法持有这款游戏,支持
authorized_online/authorized_offline两种结果(协议层对应RequestGameAuthorization)。 - 桌面客户端连接:连接本机 IGP 桌面客户端,支持重试、按需启动和能力查询。
- 联机房间:创建 / 加入 / 离开房间,ready、start、finish 生命周期事件,host / guest 对称。
- 实时通信:房间内可靠消息、KCP 数据通道、大消息自动分片。
- 状态与 RPC:跨端同步玩家状态,点对点调用房间内其他玩家的逻辑。
- 成就:解锁与进度上报。
- 实名认证与防沉迷模块:可选接入实名认证与防沉迷状态事件、年龄段读取、剩余可玩时长读取。
- Mirror 传输层:为已经使用 Mirror 的 Unity 项目提供可选传输层包。
- Unity
2022.3 LTS或更高 - Windows 10 及以上
- 本机安装 IGP 桌面客户端
- IGP 运营分配的
appId
通过 Unity 标准导入包安装,三个包按需组合:
| 包名 | 用途 | 适用项目 |
|---|---|---|
cn.indiegp.sdk.unity | 主包,包含 runtime 与 Editor 工具 | 所有接入项目都必装 |
cn.indiegp.sdk.unity.mirror-transport | Mirror 传输层适配 | 仅已经在用 Mirror 的项目 |
cn.indiegp.sdk.unity.compliance | 实名认证与防沉迷辅助入口 | 需要读取实名认证与防沉迷状态和事件的项目 |
主包附带以下示例,导入后可在 Assets/IGP.UnitySDK/Samples 下查看:
StarterDemo—— 最小接入样例RoomLifecycle—— 房间生命周期演示RealtimeMessaging—— 实时 / state / RPCAchievements—— 成就解锁与进度上报HostedPlayground—— 综合手动联调台
- 装包:Unity 安装
- 按接入目标完成最小验证流程:Unity Quick Start
- 确认基础启动流程:启动与连接
- 按目标功能继续看:
- 做对应能力的完整检查:联调与测试
- 如需在 Editor 中调试 desktop 能力或完整房间流程:Unity 调试
- 查看最新版本号与下载链接:Release Notes
- Preview 阶段:接口仍可能有不兼容改动,请锁定具体版本号使用。
- 仅支持 Windows 10 及以上。其他操作系统不在支持范围内。
- 联机房间需要通过本机 IGP 桌面客户端启动;纯无头环境(例如 CI / 云构建)目前不属于房间链路支持场景。
商标与版权声明
Section titled “商标与版权声明”本页面和 IGP Unity SDK 未由 Unity Technologies 或其关联公司赞助,也不代表与 Unity Technologies 或其关联公司存在官方关联或背书。
Unity、Unity 标志及其他 Unity 商标是 Unity Technologies 或其关联公司在美国及其他地区的商标或注册商标。Unity 相关商标、标志和素材的使用应遵循 Unity 官方商标指南。