SDK 开发文档 v1.0.1
对应 Slhx SDK v1.0.1。新功能与完整说明请切换至最新版文档。
历史文档
下列说明以 v1.0.1 能力为准。v1.0.2 起体验区结构、网络 objectId、安装(URP/XR Samples)等有增强,请用左上角切换版本。
1. 概述
UPM 双包:com.slhx.sdk(必装)+ com.slhx.samples(可选)。业务放在接入工程 Assets/Gameplay。
2. 环境要求
| 项 | 要求 |
|---|---|
| Unity | 2022.3.x LTS |
| 渲染 | 建议 URP |
| PICO SDK | 接入工程自备 |
| OpenUPM | LiteNetLib、YooAsset |
3. 安装 SDK
- 解压
slhx-upm-1.0.1-release.zip - 将
com.slhx.sdk(及可选 samples)放入工程Packages/ - 配置 OpenUPM scopedRegistry
- 导入 PICO Unity Integration SDK
"scopedRegistries": [{
"name": "package.openupm.com",
"url": "https://package.openupm.com",
"scopes": ["com.revenantx.litenetlib", "com.tuyoogame.yooasset"]
}]
依赖版本(以当时 package.json 为准):LiteNetLib 1.3.3、YooAsset 2.3.18、XRI 2.6.5、XR Hands 1.4.3。
4. 模块能力
| 模块 | 说明 |
|---|---|
| Framework | ServiceLocator、Bootstrap、事件、场景、配置、存档、输入等 |
| UI / Yoo / HandGesture | UI 栈、热更封装、手势 |
| Game / Room | LiteNet 房间、成员、位姿、物体同步、事件广播 |
| Game / Avatar / ToB | Avatar、Boot、lycj、边界/体验区基础能力 |
| Android | 固定 Java 包 com.slhx.android、广播桥 |
5. 快速接入
Framework.Core.FrameworkBootstrap.InitFramework();
// 房间
RoomNetClient.Instance.Configure("10.0.0.5", 12000);
RoomNetClient.Instance.Connect();
- 场景:
BootSystem、AndroidBridge(名建议与脚本回调一致) - Editor boot 配置(v1.0.1 时期常见):工程根
BoundaryConfig/config.json - 真机:
/sdcard/Download/lycj/boot/config.json
6. Android 与管控
| 方向 | Action / Extra |
|---|---|
| 管控 → Unity | ACTION_PC_CMD / cmd_json |
| Unity → 管控 | ACTION_UNITY_MSG / unity_json |
AndroidBridge.RegisterCommandReceiver / UnityToServiceNative.Send。
7. 配置路径
# 真机
/sdcard/Download/lycj/boot/config.json
# Editor(v1.0.1 文档记载)
{ProjectRoot}/BoundaryConfig/config.json
8. 常见问题
找不到 LiteNetLib / YooAsset? 检查 OpenUPM scopedRegistries。
换 applicationId 后广播异常? Java 桥固定 com.slhx.android;管控按应用包名投递。