Menu
Lumberyard
User Guide (Version 1.11)

Configuring your Project for Virtual Reality

Add one or more Virtual Reality Gems available in Lumberyard Editor to enable virtual reality for supported head-mounted displays (HMDs). You can add the gem(s) to new or existing projects. If you add more than one gem, the system automatically detects which HMD is connected, and uses the appropriate gem code to control the specific HMD and any associated virtual reality (VR) controllers.

Supported HMDs include:

  • Oculus – Oculus Rift HMD

  • OpenVR – HTC Vive HMD

  • OSVR – Open Source Virtual Reality (OSVR) HDK1 and HDK2

To add the Virtual Reality Gem(s)

  1. Use the Lumberyard Setup Assistant to open the Project Configurator.

  2. Select the project you want to add the Virtual Reality Gem to, or create a new project. Then click Set as Default.

  3. Click Enable Gems below the project name.

  4. Type VR into the search tool. Enable the HMD Framework Gem and one or more of the Virtual Reality Gems:

    • Oculus

    • OpenVR

    • OSVR

  5. Click Save.

    After you enable the gem(s), you must rebuild your project before the gem(s) will function in Lumberyard Editor.