User Guide (Version 1.18)

Creating Virtual Reality Games in Lumberyard

Lumberyard's virtual reality system integrates the use of the OculusRift, HTC Vive, and Open Source Virtual Reality (OSVR) head-mounted displays (HMD) on PC gaming systems. Before using these head-mounted displays, read each manufacturer's safety guide:

To activate Lumberyard's virtual reality support, add the appropriate Virtual Reality Gem(s) in the Project Configurator and then build your project. By enabling the appropriate Virtual Reality Gem(s), your project becomes capable of working with the supported virtual reality device(s), after some additional configuration. You can also add new gems for other head-mounted devices.

Use console variables (CVARs) to activate and modify configurable features of the virtual reality system, such as resolution and performance specifications.

You can use flow graph modules for the initial game setup and gameplay scripting, for example, to customize such features as the position of the camera, tracking of the attached virtual reality device, current view depending on height of the player, and more.

For information on Lua scripting functions for VR, see VR Lua Functions.