Omniverse

The repository is Omniverse SDK for Unity and UnrealEngine4. This document is edited by VSCode. You can open and preview this document by VSCode if there is any display error.

To make the game support Omni, you should follow these steps:

Contact Omniverse to create CP account;
Active your Omni in develop enviroment;
Request GameID and GameKey;
You should get Omniverse SDK, document, samples from github.com, get calibration app from Omniverse staff or CP backend;
Calibrate each Omni by calibration app;
Integrate Omniverse SDK to your game, steps are list below, functions not appeared in steps are optional;
Test your game, steps are list below in this document;
Commit your game to Omniverse staff;
Publish your game by Omniverse;

Currently, contact Omniverse staff to do step 1,2,3, later it can be done in CP backend.

Sample Projects

OVSDKSampleUE4

It's the sample for UE4 C++. OVSDKSampleUE4\Plugins\Omniverse folder is the Omniverse plugin for UE4, you can copy it to your own game project.

OVSDKSampleUE4BP

It's the sample for UE4 Blueprint; In git repository, we keep one copy of Omniverse plugin to avoid confict. So you can make link Ominverse under OVSDKSampleUE4BP\Plugins to OVSDKSampleUE4\Plugins\Omniverse, like these (and make sure you got administrator privilege)
mklink /D Omniverse ..\..\OVSDKSampleUE4\Plugins\Omniverse

OVSDKSampleUnity for Unity;

It's the sample for unity, you can export unity plugin package here, then import to your game project.

Integrate Steps

To integrate Ominiverse SDK, you must follow these steps. Other interface/functions not appeared here are optional, use or not is up to you.

Use Omniverse SDK by UE4 C++

Copy OVSDKSampleUE4/Plugins/Omniverse to your project's Plugins;
Add plugins config to uproject:

   "Plugins": [  
      {  
         "Name": "Omniverse",  
         "Enabled": true  
      },

Add dependency module in yourproject.build.cs:

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Omniverse"});

Call UOVInterface::Init(...) on game start.

UOVInterface::Init(1019, "01ec17dac7140c0fbe936ee128310000", "omni=1");

Config yourproject Engine.Input, add Omni X-Axis as MoveRight input, add Omni Y-Axis as MoveForward input.
Add UOmniControllerComponent to your ACharacter. Please config UOmniControllerComponent::Camera correctly. UOmniControllerComponent need HDM camera to correct Omni harness orientation, make HDM work correctly when ACharacter's yaw changed by omni-harness turing. Three ways to config UOmniControllerComponent::Camera:

a. by default, UOmniControllerComponentwill use the first UCameraComponent from owner ACharacter;
b. assign UOmniControllerComponent::Camera manually;
c. config UOmniControllerComponent::CameraTag, UOmniControllerComponent will try find UCameraComponent from owner ACharacter whose tags contain CameraTag;

    // Create OmniControllerComponent
    OmniControllerComponent = CreateDefaultSubobject<UOmniControllerComponent>(TEXT("OmniControllerComponent"));
    OmniControllerComponent->InitOmniDone.AddDynamic(this, &AOVSDKSampleUE4Character::OnInitOmniDone);
    //OmniControllerComponent->Camera = FirstPersonCameraComponent;

Add an individual USceneComponent as FirstPersonCameraComponent's parent, to compensate Omni harness turning.
Set FirstPersonCameraComponent->bUsePawnControlRotation to false in VR mode.
Bind MoveForward and MoveRight in your character::SetupPlayerInputComponent(...) and implement MoveForward and MoveRight. You may already have done these.
Done. You can study OVSDKSampleUE4 if any problems.

Use Omniverse by UE4 blueprint

Copy OVSDKSampleUE4/Plugins/Omniverse to your project's Plugins;
Add plugins config to uproject:

   "Plugins": [  
      {  
         "Name": "Omniverse",  
         "Enabled": true  
      },

Add dependency module in yourproject.build.cs:

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Omniverse"});

Call OVSDK.Init when game begin. (you can do it in GameInstance::Init)
Config yourproject Engine.Input, add Omni X-Axis as MoveRight input, add Omni Y-Axis as MoveForward input.
Modify character blueprint, add OmniControllerComponent, config OmniControllerComponent's Camera property.;
In character blueprint, add an individual USceneComponent as FirstPersonCameraComponent's parent, to compensate Omni harness turning.
In character blueprint, set FirstPersonCameraComponent->bUsePawnControlRotation to false in VR mode.
In character blueprint, implement InputAxis MoveForward/MoveRight. You may already have done these.
Done. You can study OVSDKSampleUE4BP if any problems.

Use Omniverse by Unity

Import Omniverse.unitypackage. (You can export from OVSDKSampleUnity)
Config OmniControllerViveSetup, refer to OmniSDK documents;
Call OVSDK.Init when game start.
Done. You can study OVSDKSampleUnity if any problems.

Testing

Create a text file under Plugins\Omniverse\DLL\Win64(same as Omniverse.Functions.dll path), named as devenv.cfg, then the game will run as develop mode in develop enviroment. You must remove this file when pack to publish the game.

The develop and retail enviroment are seperate. There have already many player accounts in develop env, you can use them. Omni is auto unlocked when game running in develop mode (This Omni must actived in develop env).

The text file devevn.cfg's content sample is listed below. The text file simulates the retail omniverse enviroment, you can modify user id, prepare-time (unit: seconds), game-time. After UOVInterface::HasInitialized return true, you can call UOVInterface::GetUserInfo() to get player's information.

user=33
gametime=600

Config different user in devenv.cfg to simulate different players;
Press Ctrl + Alt + Shift + O in game, you should see an Omniverse system-menu. (Make sure OVSDK.Init/UOVInterface::Init has called if system-menu not appeared)
Test moving in Omni, you can modify couple/decouple percentage in Omniverse system-menu.
Test other functions if you integrated.

baikety/Omniverse