Overview

HTC Vive support is now included with CRYENGINE. This article will guide you through setting up VR and also includes important information that you should know before getting started.

Getting Started

• Runtime: In order to use the HTC Vive you need to install Steam.
• HTC Vive Documentation: Please read the documentation regarding device setup and configuration - Available from Steam.
• Video Drivers: Update your Video Card Driver(s) and ensure that you are running the most recent revision that supports the HTC Vive.
• Recommended PC Spec: Information regarding hardware requirements - Available from HTC.

Starting the Engine with the Vive Enabled (Game Mode)

To enable VR in CRYENGINE then follow the steps below:

1. Connect the device to your computer
2. Make sure the vendor runtime/application recognizes your headset as ready for use
3. Install the OpenVR plugin by adding the following line to the plugin section of your .cryproject file
   
   { "type": "EPluginType::Native", "path": "CryOpenVR" }
   
   
4. Add 'sys_vr_support=1' to your system.cfg or user.cfg file
5. Launch the Engine (as admin)

Once launched, the Engine should be rendering to your head-mounted device.

Making Changes to a Level (Edit Mode)

If you want to make changes to a level i.e. edit your game then you will need to disable VR.

1. Remove all VR plugins from your .cryproject for e.g. { "type": "EPluginType::Native", "path": "CryOpenVR" }. NOTE: This includes VR plugins related to HMD's from all other manufacturers, not just the HTC Vive
2. Remove sys_vr_support from your system.cfg or .cryproject
3. Ensure that any other VR specific features are disabled

Input Configuration

If so desired you can bind this directly to a key/gamepad button. This can be achieved via Flow Graph using the Debug:InputKey node.

Alternatively, you could modify the <game_folder>\Libs\Config\DefaultProfile.xml file and assign a button there.

See Setting up Controls & Actionmaps for more information.

Flow Graph

We have exposed some controls/functions that are related to the HMD device and the Motion Controllers. This can be accessed through Flow Graph.

• VR:TransformInfo
  
  

Allows quick access to position and rotation information related to the VR device.

• VR:Tools
  
  

Allows you to hook up an input to trigger the RecenterPose command.

• VR:ControllerTracking
  
  

Similar to the VR:TransformInfo node. This node will allow you to access position and rotation information of a controller. Additionally, you can provide a scaling value as well as a reference entity.

• VR:OpenVRController
  
  

Allows you to retrieve the button states as well as the trigger and touchpad values of the given Controller. (Index should usually be either 0 or 1).

Frames per Second

The HTC Vive will play your game at exactly 90 FPS if you can make it run at exactly 90 FPS or above.

Possible Issues You Can Encounter

The Sandbox Editor fails to run after enabling VR

Solution:

1. Remove any VR plugins from your .cryproject for e.g. { "type": "EPluginType::Native", "path": "CryOpenVR" }
2. Remove sys_vr_support from your system.cfg or .cryproject
3. Ensure that any other VR specific features are disabled

NOTE: When reverting back to game mode then all of the above steps/any changes made must be reverted

Running the Sandbox Editor with the user.cfg

This will try to enable VR in Editor Mode which it will attempt, but can't do.

Solution: Rename the user.cfg to something else such as _user.cfg

This will bypass the file being read on loading of the Sandbox Editor.

In some instances the Launcher (GameSDK.exe) boots to a black screen

The game is active in the background but nothing is visually represented on screen.

Solution: Delete the the user folder in the root of the build. Then relaunch the GameSDK.exe.