Quick Start

Quick Start guides developers through the first steps of using the YOMOV SDK, including installation, developer sign-in, dependency and configuration checks, and Sample import.

Full Quick Start walkthrough video:

Download and Install the SDK

1. Requirements

   • Unity 2022.3 LTS or later

   • Use the Universal Render Pipeline (URP).

2. First-Time Installation

   1. In the Unity Editor, open Package Manager and select Add package from git URL.

      

   2. Enter a Git URL, then click Add to download the SDK package. YOMOV SDK Core is required and provides the core distribution capabilities and underlying dependencies. YOMOV SDK Creator is optional, provides additional features, and depends on Core.

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

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

      

      Enter the Git URL and click Add

      

      Waiting for the package installation to complete

      

      SDK packages installed

3. Update the SDK

   1. When a new SDK version is available, click Update to update the SDK.

      

      Update the SDK package

Developer Sign-In

After installing the SDK, sign in and authenticate before using any other SDK features.

1. After the SDK is imported, the YOMOV SDK menu appears in the Unity menu bar. Select it to open the management panel.

2. Click Log In. The panel is signed out the first time you open it and displays Not Logged In. Click Get Token to open the YOMOV Developer Platform.

   

   Developer sign-in entry

3. Sign in with your credentials to open the Developer Platform home page. In the upper-right corner, click Get SDK Key to obtain your SDK sign-in token.

   1. If you do not have a Developer Platform account, contact your YOMOV business representative.

      

      Obtain an SDK key from the Developer Platform

4. Return to the YOMOV SDK management panel and click Paste Token. The panel signs in to the SDK and displays your account name and ID.

   

   Copy the token

   

   Signed in successfully

Inspector and Auto-Fix

After importing the SDK, the Inspector can automatically detect and fix issues such as an incompatible Unity version, missing or conflicting dependencies, and invalid project settings.

1. Open the YOMOV SDK management panel and select Inspector.

   

   Open the SDK Inspector

2. Resolve each issue reported in the panel by clicking the corresponding action. The Inspector checks the following categories:

   1. Unity Version and Render Pipeline

      1. Unity 2022.3 LTS

      2. Unsupported render pipeline (currently only URP is supported).

   2. Missing or Outdated Dependencies

      1. Install required dependencies such as XRI, XR Hands, and Newtonsoft Json.

      2. Upgrade any installed dependency that does not meet the minimum required version.

      3. Packages that cannot be redistributed with the SDK, such as Final IK, must be downloaded and installed separately from the provided link.

   3. OpenXR and Multi-Device Support

      1. OpenXR and the platform SDKs required for supported devices, including PICO, YVR, and HTC.

   4. Unity Project Settings

      1. OpenXR multi-platform settings, command-line arguments, required Layers and Tags, and URP rendering settings.
   📌

   Note: Compatibility issues between OpenXR and Unity may cause memory usage to grow continuously.

   In Project Settings > XR Plug-in Management, disable Initialize XR on Startup. This resolves the issue in most cases.

   

   Resolve issues in the SDK Inspector

Import Samples

The Samples include an initialization scene and Prefabs for core features, helping you get started with the SDK quickly.

1. In Package Manager, select YOMOV SDK Core or YOMOV SDK Creator, then click Import next to the required Sample.

2. YOMOV SDK Core:

   1. Sample Scenes: includes one client initialization scene and four LBE VR content scenes.

   2. BridgeClient: a code example showing communication between the content server and the bridge server.

3. YOMOV SDK Creator:

   1. Sample Scene: includes the multiplayer server scene.

   2. Shared Assets: includes the standard YOMOV player model.

YOMOV SDK Core Samples

YOMOV SDK Creator Samples