快速入门

快速入门演示视频：

SDK下载与安装

1. 环境要求

   • Unity 2022.3 LTS及以上

   • 渲染管线为 URP管线

2. 首次下载安装

   1. 在工程文件中，点击打开Package Manager，下拉选择【Add package from git URL】
   

   1. 输入链接后，点击添加按钮，开始下载SDK Package

      1. YOMOV SDK Core：https://cnb.cool/configreality/YomovSDKCore.git

      2. YOMOV SDK Creator：https://cnb.cool/configreality/YomovSDKCreator.git

      注：Core 为必装 SDK，Creator 为选装 SDK；Core 是应用分发的核心功能及底层依赖，Creator 提供增值功能，需要依赖Core来实现对应功能逻辑

   

   输入下载地址，点击添加

   

   下载安装等待过程

   

   下载安装完成

3. SDK迭代更新

   1. 后续若有SDK版本迭代，点击【Update】按钮，一键更新升级SDK
   

   SDK版本更新

开发者登录

下载安装SDK后，开发者需登录鉴权后，才能进行后续功能操作

1. SDK导入完成后，顶部菜单栏中回显 YOMOV SDK 菜单，点击弹出管理面板

2. 点击 Log In 选项，首次打开默认是未登录状态，点击【Get Token】按钮，跳转到 游幕开发者平台

   

   开发者登录入口

3. 输入账密登录后，进入开发者平台主页；点击右上角【获取SDK密钥】按钮，获取登录密钥

   1. 如果没有开发者后台账号，请跟商务经理进行联系获取

      

      开发者平台获取SDK密钥

4. 返回YOMOV SDK管理面板，点击【Paste Token】，完成开发者SDK登录，回显账号名称及账号

复制Token

登录成功

检查器与自动修复

SDK导入后，可能会出现Unity版本、依赖插件缺失&冲突、全局配置错误等问题，可通过检查器进行一键修复

1. 点击YOMOV SDK面板 -> Inspector选项，打开检查器面板

   

   Inspector面板入口

2. 基于面板中反馈信息依次点击进行解决，主要包括以下几类：

   1. Unity版本及渲染管线

      1. Unity 2022.3 LTS版本

      2. 渲染管线不支持（当前仅支持URP管线）

   2. 依赖插件缺少或版本太低

      1. 对于底层依赖插件如 XRI、XRhands、Newtonsoft 等，进行下载安装

      2. 对于应用中已经存在的插件但是版本过低，进行升级覆盖

      3. 注：对于不支持商业化使用的插件，比如 FinalIK 插件，需基于下载地址自行进行下载并安装使用

   3. OpenXR及多设备适配

      1. OpenXR SDK，以及适配多设备平台SDK（PICO、YVR、HTC等）

   4. Unity全局配置

      1. OpenXR 多平台适配、命令行传参、必要的图层及标签等创建、URP渲染设置等
   📌

   注：由于OpenXR跟Unity的兼容性问题，可能会导致内存不断溢出的情况

   可以在 Project Setting -> XR Plug-in Management 中，关闭 Initialize XR on Startup 选项，能大概率解决该问题

检查器面板，解决报错

导入Sample

Sample中包含了包含初始化场景以及核心功能的Prefab，能够快速帮助上手使用SDK

1. 在Package Manager -> YOMOV SDK Core/Creator中，点击导入Sample

2. YOMOVSDK Core：

   1. 示例场景：包含客户端初始化场景、4个大空间内容场景、

   2. BridgeClient：内容服务器与桥接服务器通信代码示例

3. YOMOVSDK Creator：

   1. 示例场景：包含多人服务端场景

   2. 通用资源：YOMOV通用人物模型

YOMOVSDK Core Sample示意

YOMOVSDK Creator Sample示意