Configuring your Project for Virtual Reality - Lumberyard User Guide

Configuring your Project for Virtual Reality

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog, O3DE Discord, or O3DE GitHub to learn more. The Lumberyard forums have been deprecated. You may view past forum discussions in the archive.

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


Use the NullVR Gem to run your level through the HMD framework without a connected VR device. This is useful for VR graphics debugging. For more information about this Gem, see NullVR Gem.

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

    • NullVR

  5. Click Save.

  6. After you enable the gem(s), you must build your project before they are available in Lumberyard Editor.