跳转到内容
IGP Developer Docs

Changelog

本页记录各版本的实际变更。

如需查看下载包、版本号和校验值，请查看 Release Notes。

Unreleased

Section titled “Unreleased”

0.2.14 - 2026-07-22

Section titled “0.2.14 - 2026-07-22”

  • 重新构建 Unity SDK 0.2.14 主包以及 Mirror transport、Compliance、Lying Bottle、Cloud Archive 和 GameKit 可选包。

  • 恢复 hosted RPC 契约以及 Unity / Godot SDK 的 RPC 注册、注销、调用、响应事件、样例和协议测试。hosted command 编号 12 至 14、rpc_name 和 mode 重新启用；RPC realtime 消息名继续保留给 SDK 控制流量。

  • Unity Mirror Transport 诊断现在区分 Mirror logicalChannel 与每次发送实际采用的 effectiveTransport（kcp 或 raw-udp）；raw UDP unreliable 通道不可用时会明确记录回退到 KCP。

  • Unity hosted KCP 新增只读 KcpHealthState 和 KcpLastFaultReason。dead-link、致命 socket 错误和发送队列硬溢出会关闭当前 data-plane、进入 ConnectionFailed 并通过 onError 上报。

  • 内置网络浮层改名为 ShowNetworkDiagnostics / showNetworkDiagnostics，并显示健康状态、最近故障、RTT、队列和 UDP 统计。

  • Unity KCP 在 WaitSnd >= 1024 时施加发送背压，并可越过 256 datagram 软预算自适应排空 UDP burst。

  • Arena KCP 使用 MTU 1200 并补充逐远端 UDP/KCP 进展诊断；Unity Mirror Transport reliable batching 默认值调整为 1024 bytes。

  • Unity hosted KCP 和 raw UDP unreliable 诊断现在会针对高延迟、高 datagram 速率和高字节速率输出结构化、只观察的 Warning。

  • Unity Mirror Transport 会针对合法 reliable 大包和深接收队列输出只观察 Warning，逐包摘要保留在 Debug。

  • 高延迟、高流量和 Mirror payload/queue 告警仍为只观察 Warning，不改变网络行为。

  • 异常首次出现时立即记录；持续异常最多每 30 秒汇总一次；高延迟和高流量恢复并稳定 5 秒后记录一次恢复。

  • 绑定的 Mirror Transport 会在 Runtime 进入 ConnectionFailed 时立即清空待派发的入站消息，并向对应的客户端和服务端连接派发一次断开回调。

0.2.13 - 2026-07-13

Section titled “0.2.13 - 2026-07-13”
  • Published Unity SDK 0.2.13 packages for the main SDK, Mirror transport, Compliance, Lying Bottle, Cloud Archive, and GameKit modules.
  • Reorganized the main Unity package source into Core, Platform, Capabilities, Multiplayer, Diagnostics, and Internal categories. Public APIs, namespaces, assembly identity, and Unity asset GUIDs are unchanged.
  • Unity in-game ready state APIs now live on IGPRuntimeManager as SetGameReadyAsync and GetGameReadyStates. They reuse Arena player state at Player.State["gameReady"]; batch queries read the current room snapshot.
  • Removed the Mirror Transport ready APIs and the dedicated KCP 41004 ready message path. Game ready state does not control Mirror connections.
  • Runtime Manager diagnostics now use the shared IGPLog pipeline, including Info game-ready logs under scope=game-ready.
  • Unity GameKit adds IGPProfile.GetProfileAsync for fetching the signed-in user’s complete current profile through the desktop-owned user context.
  • Desktop session command GetDesktopUserProfile (22) returns profile JSON including avatar and background selections, avatar-frame render metadata, bio, name-change state, activity time, and pending nickname review state.
  • Unity keeps avatar PNG retrieval on the existing GetDesktopUserAvatarAsync path while Profile exposes the selection metadata and public media URLs returned by desktop.

0.2.12 - 2026-07-10

Section titled “0.2.12 - 2026-07-10”
  • Published Unity SDK 0.2.12 packages for the main SDK, Mirror transport, Compliance, Lying Bottle, Cloud Archive, and GameKit modules.
  • Unity hosted data-plane descriptors now carry raw UDP unreliable lane metadata (unreliableUdpHost, unreliableUdpPort, unreliableUdpToken, unreliableUdpExpiresAtUnixMs, unreliableUdpPayloadMaxBytes), while normal IGPNetwork.SendData and IGPNetwork.SendReliableData remain reliable KCP.
  • Unity SDK adds an internal raw UDP unreliable client for Mirror transport, including token hello/ack, session-targeted envelopes, negotiated payload limits, and receive dispatch.
  • Unity Mirror Transport now defaults Channels.Unreliable to raw UDP through the Use Raw UDP Unreliable Lane toggle; disabling the toggle restores the legacy all-KCP reliable path.
  • Unity Mirror Transport reports the unreliable packet max from the UDP lane (default 1200 bytes) when the raw lane is enabled.
  • Unity GameKit adds a desktop-owned Share module that submits versioned text, multi-image binary payloads, and game-defined extension data through desktop session command RequestDesktopShare.
  • Desktop session command requests now support binary contentBytes payloads, and the SDK frame limit is raised to 16 MiB so Share can send up to 10 MiB of raw image bytes.

0.2.11 - 2026-07-07

Section titled “0.2.11 - 2026-07-07”
  • Published Unity SDK 0.2.11 packages for the main SDK, Mirror transport, Compliance, Lying Bottle, Cloud Archive, and GameKit modules.
  • Unity IGPConfig.debugLogging is now an IGPLogLevel dropdown (Off, Error, Warning, Info, Debug) with minimum-level filtering, so projects can keep warnings/errors without logging every network payload.
  • Unity Mirror Transport now keeps low-frequency Info summaries for reliable payloads over 16 KiB or expected to fragment, including direction, peer, original/wire bytes, compression state, and estimated fragments.
  • Unity RTT HUD diagnostics now show UDP datagram rates, packet totals, and socket byte totals alongside App RTT, KCP srtt/rto, 1-second Queue averages, and 5-second Q peak values.
  • Rebuilt the Unity 0.2.11 packages so KCP/RTT diagnostics stay observational: heartbeat IsKcpAlive no longer gates P2P/Mirror sends, and reading KcpTransportStats no longer advances UDP rate sampling.

0.2.10 - 2026-07-06

Section titled “0.2.10 - 2026-07-06”
  • Published Unity SDK 0.2.10 packages for the main SDK, Mirror transport, Compliance, Lying Bottle, Cloud Archive, and GameKit modules.
  • Unity Mirror Transport now defaults connection retry attempts to every 60 seconds, connection timeout to 300 seconds, and peer silence timeout to 300 seconds.
  • Unity hosted KCP now supports binary envelope v2 for reliable chunk payloads, while preserving the existing JSON/base64 fallback path.
  • Unity Mirror transport now adds compression decision diagnostics and a separate reliable batch threshold for Mirror message coalescing.
  • Unity KCP send and receive windows are now configurable, with focused protocol/runtime tests covering the new binary reliable chunk behavior.

0.2.8 - 2026-07-03

Section titled “0.2.8 - 2026-07-03”
  • Published Unity SDK 0.2.8 packages for the main SDK, Mirror transport, Compliance, Lying Bottle, Cloud Archive, and GameKit modules.
  • Unity SDK logs now include a per-process runId and startup event=session-start summary with app, SDK, platform, transport, endpoint, room, and local player context.
  • Unity KCP and P2P diagnostics now use explicit localPlayerId, sourcePlayerId, and targetPlayerId fields, add heartbeat timing details, and log payload size/checksum summaries without full base64 payloads.

0.2.7 - 2026-06-30

Section titled “0.2.7 - 2026-06-30”
  • Published Unity SDK 0.2.7 packages for the main SDK, Mirror transport, Compliance, and GameKit modules.
  • Unity achievement unlock and progress calls now generate an eventId when callers omit one, so desktop-session achievement uploads have a default idempotency key.
  • Unity achievement progress reports now accept the optional progressValueMode field for SET versus INCREMENT semantics.

0.2.6 - 2026-06-25

Section titled “0.2.6 - 2026-06-25”
  • Published Unity SDK 0.2.6 packages for the main SDK, Mirror transport, and Compliance modules.
  • Unity internal hosted session, KCP, P2P, and hosted realtime logs now share the structured [IGP SDK] format with timestamp, level, scope, path, and event fields while remaining gated by IGPRuntimeManager.DebugLogging.
  • Unity KCP receive-drain diagnostics now include payload, payload byte, frame, queue, RTT, and window snapshots in the unified SDK log stream.
  • Unity Mirror Transport now compresses payloads from 2 KiB by default before SDK size classification, reducing large-message pressure earlier.

0.2.5 - 2026-06-24

Section titled “0.2.5 - 2026-06-24”
  • Published Unity SDK 0.2.5 packages for the main SDK, Mirror transport, and Compliance modules.
  • Unity hosted KCP now emits structured [IGP KCP] diagnostics for handshake, UDP/KCP receive, send failures, heartbeat RTT, and internal queue/window state.
  • Unity IGPKcpClient.DiagnosticsSummary now exposes a readable KCP network snapshot for diagnostics exports without parsing console logs.

0.2.4 - 2026-06-24

Section titled “0.2.4 - 2026-06-24”
  • Published Unity SDK 0.2.4 packages for the main SDK, Mirror transport, and Compliance modules.
  • Unity hosted KCP now emits only control and data transport channels, matching Arena’s current control/data queue split.

0.2.3 - 2026-06-24

Section titled “0.2.3 - 2026-06-24”
  • Published Unity SDK 0.2.3 packages for the main SDK, Mirror transport, and Compliance modules.
  • Unity Mirror Transport now exposes PeerSilenceTimeoutSeconds, defaults peer silence detection to 120 seconds, and keeps the value clamped to at least 1 second for long payload or reconnect-heavy sessions.
  • Unity IGPNetwork now emits peer activity when inbound payloads or reliable chunks are accepted, allowing Mirror Transport to refresh peer silence timers while large reliable messages are still being reassembled.
  • Unity Mirror Transport logs now include timestamps when debug logging is enabled, making transport events easier to correlate with game and platform logs.

0.2.2 - 2026-06-23

Section titled “0.2.2 - 2026-06-23”
  • Published Unity SDK 0.2.2 packages for the main SDK, Mirror transport, and Compliance modules.
  • Unity IGPNetwork can now disable retaining incoming packets for polling when an event-only consumer such as Mirror Transport is bound, preventing duplicate receive queues from accumulating the same realtime data.
  • Unity Mirror Transport now follows IGPRuntimeManager.DebugLogging as its only logging switch, and stays silent when no Runtime Manager is bound.

0.2.1 - 2026-06-23

Section titled “0.2.1 - 2026-06-23”
  • Unity hosted KCP now clears pending large-payload reassembly state when Arena sends reliable-message-aborted, and ignores late chunks for the same reliableMessageId until the reassembly timeout window expires.

0.2.0 - 2026-06-22

Section titled “0.2.0 - 2026-06-22”
  • Unity hosted KCP now separates control, data-small, and data-large transport channels so large reliable fragments do not share the same send queue with ordinary small payloads or control notifications.
  • Ordinary p2p small payloads keep the existing binary envelope path, while large reliable fragments continue to use JSON chunk metadata for SDK-side reassembly.
  • Arena reports data-large queue overflow with reliable-message-aborted control messages, and the Unity SDK recognizes and logs those control events.
  • Mirror Transport payload compression is now enabled by default with a 16 KiB threshold before SDK size classification.
  • Published Unity SDK 0.2.0 packages for the main SDK, Mirror transport, and Compliance modules.

0.1.11 - 2026-06-18

Section titled “0.1.11 - 2026-06-18”
  • Published Unity SDK 0.1.11 packages for the main SDK, Mirror transport, and Compliance modules.

0.1.9 - 2026-06-16

Section titled “0.1.9 - 2026-06-16”
  • Unity Mirror transport reconnect windows now use a 30-second connect timeout and 30-second peer silence timeout while keeping connect requests throttled to at most once every 5 seconds.
  • Unity Mirror transport pending connect requests are now throttled to at most once every 5 seconds without changing the existing control payload format.
  • Repeated ClientConnect() calls for the same pending host now keep the current retry window instead of resetting it and sending another connect request.
  • Unity Mirror transport connection handshakes now carry a connect attempt id, so stale or repeated ConnectAccept packets cannot fire duplicate client connected callbacks.
  • Published Unity SDK 0.1.9 packages.

0.1.8 - 2026-06-15

Section titled “0.1.8 - 2026-06-15”
  • Published Unity SDK 0.1.8 packages.

0.1.7 - 2026-06-14

Section titled “0.1.7 - 2026-06-14”
  • Rolled back Unity IGPNetwork to the direct KCP send path through IGPRuntimeManager.SendP2PMessage, removing SDK-side outgoing reliable scheduling and send-queue backpressure.
  • Removed network diagnostics summaries, KCP queue diagnostics, RTT congestion filtering, and the diagnostics overlay that no longer apply after the rollback.
  • Restored the Unity P2P receive buffer to an unbounded ConcurrentQueue, and removed IGPNetworkResult.kErrorSendQueueFull plus the matching Mirror transport disconnect handling.
  • Removed tests and documentation for the reverted bounded packet queue, outgoing scheduler, KCP diagnostics, and error code.
  • Published Unity SDK 0.1.7 packages.

0.1.6 - 2026-06-12

Section titled “0.1.6 - 2026-06-12”
  • Unity hosted data-plane attach 改为同一 roomId + playerId single-flight，避免并发重复请求 descriptor 和重复替换 KCP session。
  • Unity Direct KCP data-plane 现在只有收到 kcp_handshake_ack 后才进入 connected；重连前会先关闭旧 KCP，并按 500ms -> 1s -> 2s 退避重试，同时丢弃过期 attempt 的回调。
  • Unity runtime 将 STATE_NOT_FOUND、INVALID_STATE_SCOPE、INVALID_REQUEST、FORBIDDEN 分类为业务错误；STATE_NOT_FOUND 会为常见 global state key 写入默认值，不再触发连接服务不可用提示。
  • bridge/contracts/data-plane.md 补充 data-plane single-flight、重连关闭顺序、handshake ack 和 stale attempt 处理语义。
  • Unity / Godot / GameMaker SDK Environment 新增 PREVIEW，自动连接 IndieGamesPass Preview 桌面端与 \\.\pipe\igp-desktop-sdk-preview。
  • Unity MirrorTransportDemo 调试面板新增 Rematch 按钮；Unity / Godot hosted session 增加 rematch 发送回归测试，锁定 RematchGame command code 为 16。

0.1.5 - 2026-06-12

Section titled “0.1.5 - 2026-06-12”
  • Unity reliable data 发送改为按 KCP WaitSnd 可用容量 drain，不再受固定字节率/token bucket 限制；当 WaitSnd 不可用时保留每次 drain 的兜底上限。
  • Unity reliable 发送队列满时返回 kErrorSendQueueFull；Mirror transport 会将其视为可靠通道丢失并断开对应 peer，便于重连后重建状态。
  • Unity Mirror transport 优先发送小 reliable payload，不再静默丢弃已接收但未派发的 inbound transport 消息，并新增 10 秒入站静默断线和 shutdown disconnect best-effort flush。
  • Unity reliable reassembly 在 inflight/buffer 压力下驱逐最旧 partial 消息而不是抛异常，并在网络诊断中输出 reassemblyEvicted。
  • Unity hosted data-plane 状态在 KCP 仍 alive 时会从陈旧 error 状态恢复，避免 transient transport error 后状态误报。

0.1.3 - 2026-06-09

Section titled “0.1.3 - 2026-06-09”
  • Unity KCP RTT 统计新增稳定/原始双口径：发送心跳时若 KCP 已有排队，样本会标记为拥塞，只进入 LastRTT / RawAvgRTT 和诊断日志，不再污染常规 AvgRTT 延迟显示。
  • Unity 网络诊断补充 rttLastMs、rttAvgMs、rttRawAvgMs、rttCongested、pingQueueDepth，用于判断瞬时高延迟是业务包排队、真实网络波动还是接收侧积压。
  • Unity 网络诊断日志和屏幕 overlay 改为独立开关：EnableNetworkDiagnostics 只开启采样/日志，ShowNetworkDiagnosticsOverlay 才显示屏幕面板，避免测试或正式包开启日志时自动出现调试 UI。
  • Unity 点对点可靠消息新增出站调度器，按 token bucket、每帧 payload 上限和 WaitSnd 高低水位逐帧释放可靠分片，降低 Mirror / 大 payload 瞬时灌入 KCP 的风险；诊断补充 netOutQueue、netOutSent、netOutThrottle。
  • Unity KCP 接收侧提高 burst drain 上限，并在需要时扩容 KCP receive buffer，避免合法较大消息因固定缓冲过小卡在接收队列头；诊断补充 recvLimit、recvBufGrow、recvOversize。
  • Unity KCP 心跳 pong 不再每次输出普通 RTT 日志，避免高频日志在短时网络 burst 时放大 Unity 主线程抖动。

0.1.2 - 2026-06-09

Section titled “0.1.2 - 2026-06-09”
  • Unity SDK 新增可选网络诊断采样，输出 WaitSnd、Mirror produced、KCP out/recv、hit64、pktQueue、reassembly 等指标，并提供诊断 overlay。
  • Unity P2P 轮询兼容队列改为有界队列，避免只使用事件回调的游戏让 SDK 内部队列无限增长。
  • Unity hosted data-plane 协商会自动钳制可靠分片大小，避免 JSON/base64 包装超过 KCP frame 上限。
  • Unity 网络回调改为在 SDK 网络状态锁外触发，降低游戏回调执行重活时对 SDK 接收链路的放大影响。
  • Unity SDK 运行时上报版本改为显式包版本，避免接入侧误判 SDK 版本。

0.1.1 - 2026-06-09

Section titled “0.1.1 - 2026-06-09”
  • Unity hosted session 在同一房间 rematch 回到 waiting 时会重置 KCP data plane 和 P2P 会话状态，避免下一局复用上一局的数据面状态。

0.0.8 - 2026-06-05

Section titled “0.0.8 - 2026-06-05”
  • Unity SDK 在 desktop session 建联阶段新增 hosted bootstrap 请求，IGPRuntimeManager 可从桌面端拉取托管房间的初始化参数，简化托管模式接入。
  • IGPDesktopSessionClient / IGPDesktopSessionProtocol 同步补充 hosted bootstrap 请求、响应模型和协议常量，相关协议契约由根目录 igp-proto 统一生成。

0.0.7 - 2026-05-27

Section titled “0.0.7 - 2026-05-27”
  • Unity SDK 新增同一房间内运行中换地图事件，游戏可通过 IGPRuntimeManager.onMapChanged 或 IGPEventManager.onMapChanged 接收地图变化。
  • 新增 IGPMapChangeData，包含变更前后的 mapPublicId / mapVersionId 和已更新的房间快照。
  • Unity 快速接入、事件说明、房间生命周期示例、问题排查和官网房间文档已补充运行中换地图接入说明。

0.0.6 - 2026-05-13

Section titled “0.0.6 - 2026-05-13”
  • Unity / GameMaker / Godot 成就模块新增清除当前游戏全部成就的调用入口，并返回清除结果。
  • Unity Mirror 传输层默认兼容 Mirror v89.0.0 之后的版本，v90.0.0 以上仍作为推荐版本。

0.0.5 - 2026-05-12

Section titled “0.0.5 - 2026-05-12”
  • desktop session 连接阶段新增协议版本校验，desktop 过旧或协议不兼容时会立即给出清晰错误。
  • SDK 会根据 desktop 返回的能力清单判断功能是否可用，避免后续调用时才失败。

0.0.4 - 2026-05-12

Section titled “0.0.4 - 2026-05-12”
  • SDK 主动启动桌面端时，正式环境只允许启动官方可信的 IndieGamesPass；开发环境仍支持显式指定本机调试桌面端。
  • Unity Editor 中未配置游戏 exe 调试路径时，SDK 会自动带上 Unity Editor 当前进程路径，并通过桌面端 SDK 联调规则按 appId 联调。
  • Unity SDK 改为显式初始化，游戏需要主动调用 InitializeAsync()。
  • Unity Editor 中 IGPRuntimeManager 会自动挂载项目里的 IGPConfig，缺失时自动创建配置。
  • desktop session、host bridge 和 hosted session 的协议常量改为统一生成，减少协议结构漂移。
  • Unity SDK 文档已同步最新接入方式和 Editor 联调说明。

0.0.2 - 2026-04-29

Section titled “0.0.2 - 2026-04-29”
  • Unity SDK 新增可选合规模块 cn.indiegp.sdk.unity.compliance，用于实名认证和防沉迷功能的事件读取和状态变化通知。
  • 合规模块新增实名认证和防沉迷功能的年龄段和剩余可玩时长读取入口，游戏无需自行换算。
  • 实名认证和防沉迷功能遇到网络或服务异常时，会在合规模块内按不允许进入处理，默认提示为「网络或服务异常」。
  • Unity SDK 加强本地通信、编辑器联调和离线授权缓存的安全处理，降低本机异常输入与调试信息残留风险。
  • Unity SDK 发布包调整为 .unitypackage，便于在 Unity Editor 中通过 Import Package 直接导入。

0.0.1 - 2026-03-31

Section titled “0.0.1 - 2026-03-31”

SDK 初始化版本。

  • 提供 Unity SDK 基础能力，支持启动连接、成就、房间联机大厅、实时消息、状态与 RPC 等核心功能。
  • 提供 Unity Mirror 传输层可选包，用于接入基于 Mirror 的联机场景。
  • 提供基础发布包、示例工程和接入说明，便于开发者完成首轮集成与验证。