User Guide (Version 1.14)

Virtual Reality Samples Project

The Virtual Reality Samples Project is a template that you can use to build virtual reality (VR) applications for any supported device. The sample is configured with the base set of gems (HMD Framework, Oculus, OpenVR, and OSVR) that you need for VR and demonstrates the following essential VR features:

  • Room-scale VR setup

  • Tracked controller input system

  • Spatialized audio playback

  • Stereo 360 video playback

To install the Virtual Reality Samples Project

  1. Download the package at Lumberyard Downloads and extract it in your Lumberyard directory. For example, \Lumberyard\1.x.0.0.

  2. Open Lumberyard Setup Assistant. On the Summary page, click Configure project.


    To ensure that the VR project launches, you must use Setup Assistant to open the Project Configurator. Lumberyard Setup Assistant copies required SDKs from the 3rdParty directory into the dev\VirtualRealityProject directory.

  3. In the Project Configurator, select VirtualRealityProject and then click Set as default.

  4. Close the Project Configurator.

  5. Open Lumberyard Setup Assistant.

  6. Download the required SDKs to view video playback for the Virtual Reality Samples Project.


    The video playback on the TV in the VR_TVRoom_Sample level must be enabled before you can view video playback. For instructions on setting up video playback, see Setting up Video Playback.

  7. Close the Lumberyard Setup Assistant.

  8. After completing video playback setup, you must also build the virtual reality project.

  9. Start Editor.exe from one of the following directories:

    • For Visual Studio 2017, use the lumberyard_version\dev\Bin64vc141 directory.

    • For Visual Studio 2015, use the lumberyard_version\dev\Bin64vc140 directory.