手册概述
插件版本 1.2.3 | 文档版本 1.2.3 | UE 5.3-5.7 本篇是文档集总入口:说明这套手册怎么读、每篇写给谁、遇到问题去哪找。
这套手册是什么
YomovUESDKCore 是游幕 LBEVR 分发平台面向 Unreal Engine 的接入插件,覆盖:播控系统通信、桥接数据同步(多应用混播)、大空间路径(动态 / 固定)、多人同步与远程 Avatar、虚空边界、引导与报幕。
本手册面向内容方(接入开发、技术美术、多人联调与部署同学),讲清"装什么、配什么、怎么验证、出错怎么查"。
运营系统侧接入(后台启播、内容管理、场次编排)不在本手册范围,见 YOMOV 分发 & 运营系统接入说明。
怎么读这套手册
路径 A:首次接入(推荐顺序)
00 开发者手册(本篇)→ 01 产品简介 → 02 快速入门 → 03 接入流程 → 04 测试打包
前四篇是一条线性主干:看懂产品 → 装上跑通 → 完整接入 → 测试打包。纵深参考(05–09)按需查,不必通读。
路径 B:从 Unity 版迁移过来
先看 01 §核心概念(两平台的"模式名"不同,见下方对照表),再从 03 接入流程 开始——接入步骤的形状与 Unity 版一致(流程 A / 流程 B 二分),只是编辑器操作不同。
路径 C:遇到问题
08 FAQ(先查)→ 03 §DS 部署排障(多人/DS 相关)→ 06 核心组件 / 07 接口与事件(确认机制与签名)
排障时优先看日志,日志字典见 08 §验收日志字典。
全部篇目
篇 | 标题 | 写什么 | 主要读者 |
|---|---|---|---|
00 | 开发者手册 | 本篇。总入口与阅读路径 | 全体 |
01 | 产品简介 | 产品定位、架构、核心概念(奇境/游戏、动态/固定路径)、核心组件速览、术语表 | 全体(先读这篇) |
02 | 快速入门 | 插件下载安装、两个 DataAsset 配置、最小连通验证 | 首次接入开发 |
03 | 接入流程 | 自包含完整接入:流程 A(接入 SDK 多人同步)/ 流程 B(不接入多人);DS 部署排障附录 | 接入开发、多人联调 |
04 | 测试打包 | 三阶段测试模型、版本号规则、包体格式、DS 打包 | 接入开发、发版同学 |
05 | 大空间最佳实践 | Act/Plot 尺寸与衔接、三区参数、转场、玩家指引、评审清单 | 内容设计、制作人 |
06 | 核心组件 | 按域讲组件:核心运行逻辑 / 空间与安全边界 / 多人同步 / 叙事与 Sequencer | 开发者(纵深参考) |
07 | 接口与事件 | 蓝图与 C++ API 速查、事件委托清单、接口约定 | 开发者(按需查) |
08 | FAQ | 常见问题、验收日志字典、多人发版检查清单、联调工具 | 全体 |
09 | 编辑器工具 | InspectorPanel 配置自检 / SettingPanel / BestPath 路径编辑器 / ActBuilder / EdMode / 内容制作工作流 | 内容制作、关卡设计 |
10 | 多队伍道具与交互同步 | 一个 DS 承载多队伍时,同队道具/交互同步、异队互不干扰的蓝图配置、验证与排查 | 多人接入开发 |
Unity 版 ↔ UE 版 对照
游幕分发平台同时提供 Unity 版与 UE 版 SDK,核心业务概念一致,但术语与实现不同。从 Unity 版迁移过来时先看这张表:
业务概念 | Unity 版叫法 | UE 版叫法 |
|---|---|---|
大空间奇境类内容(行走观看、剧情体验) | 动态路径 | Sequence 模式( |
小空间游戏类内容(高频交互、玩法对抗) | 固定路径 | Single 模式( |
路径单元 | Act | Act(同名) |
内容单元 | Plot | Plot(同名) |
路径配置工具 | Best Path Designer(场景内组件) | BestPath 路径编辑器(独立窗口,见 09) |
叙事推进 |
| FlowController + LevelSequence Event key / 蓝图轨(见 06) |
事件总线 |
| 播控事件在 |
多人同步 |
|
|
播控通知 |
|
|
⚠️ 能力范围差异:Unity 版 SDK Creator 的部分增值能力(玩家角色 IK 动作、游后分享、LBE 先导片、载具类 Plot、多语言自动适配)UE 版暂未提供或覆盖范围不同。接入前请与游幕对接人确认 UE 侧支持范围。
版本与支持
项 | 值 |
|---|---|
插件版本 | 1.2.3 |
支持引擎 | UE 5.3 / 5.4 / 5.5 / 5.6 / 5.7(全版本验证通过) |
支持平台 | Win64 编辑器(内容制作)· Android / PICO(VR 客户端)· Windows Dedicated Server(多人服务器) |
分发形式 | 预编译插件包(binary)· 源码包( |
发布记录(含破坏性变更升级指引)见 01 §发布记录。
遇到问题时的排查顺序
-
先看日志:
Saved/Logs/YOMOVSDK.log(DS 端在<DS>/YOMOVSDK/Saved/Logs/)。不要只看 stdout——DS 作为管道子进程时 stdout 会假死。日志关键字字典见 08 §验收日志字典。 -
核对配置:先开菜单 YOMOV SDK → InspectorPanel 自检——三项配置资产(
DA_CommandLineArgs/DA_DataAsset/TestNarrative)缺失或类不对会红显,可一键 Autofix(见 09 §2)。再按 02 §2 核对字段,多人下确认各端用同一份 DA。 -
回查章节:08 FAQ 按现象分类;DS / NetDriver / 端口类问题见 03 附录。