SyncLib - 联机同步库

为 REPO 模组开发提供开箱即用的网络同步能力。封装 Photon RPC、RaiseEvent、房间属性同步、快照补发与动态配置同步。

版本：1.1.0

⚠️ 免责声明 / Disclaimer

本库为个人项目辅助工具，按“现状 (AS IS)”提供，不提供任何形式的明示或暗示担保，包括但不限于对适销性、特定用途适用性或不侵权的担保。作者不保证代码无缺陷、无中断或无错误。因使用本库产生的任何直接、间接或附带损失，作者不承担责任。功能可能根据作者自身需求随时变更。

This library is a personal development utility provided "AS IS" without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. The author makes no guarantee that the code is defect-free, uninterrupted, or error-free. The author shall not be liable for any direct, indirect, or consequential damages arising from the use of this library. Features may change at any time based on the author's needs.

✨ 功能

安装

• 依赖 BepInExPack
• 将 SyncLib.dll 放入 BepInEx/plugins/SyncLib/
• 在你的模组项目中引用 SyncLib.dll
• 在模组的 manifest.json 中添加依赖："cn_xc-SyncLib-1.1.0"

⚙️ 快速开始

using cn_xc.SyncLib;

// 1. 初始化（自动挂载到 PunManager，跨场景不销毁）
var relay = SyncRelay.Instance;

// 2. RPC 广播
SyncRelay.RegisterRpc("OnSomethingChanged");
relay.Broadcast("OnSomethingChanged", arg1, arg2);

// 3. 房间属性
SyncRelay.SetRoomProperty("MyModSetting", 5);
int val = SyncRelay.GetRoomProperty<int>("MyModSetting", 1);

// 4. 动态配置（房主改，自动同步）
SyncRelay.RegisterSyncedConfig("TokenMultiplier", "10", (key, val) => {
    MyMod.UpdateMultiplier(int.Parse(val));
});
SyncRelay.SetSyncedConfig("TokenMultiplier", "20");

// 5. 快照补发（新玩家加入自动补状态）
SyncRelay.EnableSnapshotSync(
    snapshotProvider: () => {
        return JsonUtility.ToJson(myState);
    },
    snapshotApplier: (snapshot) => {
        myState = JsonUtility.FromJson<MyState>(snapshot);
    }
);

// 6. 新玩家加入回调
SyncRelay.RegisterOnPlayerJoinedCallback(player => {
    // 自定义补发逻辑
});

CHANGELOG.md

# 更新日志

## [1.1.0] - 2026-05-24
### 新增
- 快照补发系统：`EnableSnapshotSync` / `DisableSnapshotSync` / `RequestSnapshot`
  - 新玩家加入时自动生成状态快照并发送
  - 客机可主动请求补发
- 动态配置同步：`RegisterSyncedConfig` / `SetSyncedConfig` / `GetSyncedConfig`
  - 房主修改配置后自动通过 RaiseEvent 推送给所有客机
  - 支持配置快照序列化（`SerializeConfigSnapshot` / `ApplyConfigSnapshot`），配合快照补发使用
- API 稳定性承诺：所有 public API 自本版本起锁定，未来只增不改

### 修复
- 编译期错误：添加 `using BepInEx;`，解决 `Debug` 和 `Hashtable` 类型歧义
- `SendResponse` 参数类型修正（`int` → `Player`）

## [1.0.0] - 2026-05-24
### 新增
- 初始发布
- RPC 封装：`Broadcast` / `BroadcastBuffered` / `SendToPlayer` / `RequestHost`
- RaiseEvent 封装：`RaiseEventBroadcast` / `RegisterEventHandler`
- 请求-响应模式：`SendRequest` / `SendResponse` / `HandleResponse`
- 房间属性同步：`SetRoomProperty` / `GetRoomProperty`
- 新玩家加入回调：`RegisterOnPlayerJoinedCallback`
- 自动挂载 PunManager 并跨场景持久化