Welcome to the Godot OpenVR module documentation and wiki!

This is still a work in progress, and help/suggestions are welcome of course!

Getting the Godot OpenVR module

We recommend using the Godot OpenVR asset from Godot's asset library, found here. If you do download the repository directly, make sure to copy the demo/addons/godot-openvr folder to your game's addons folder.

Compiling the module

Pre-build binaries for this module can be found on the releases page in this repository.

For instructions on how to compile the module yourself, please check the README.md file in this repository.

Basic use of the Godot OpenVR asset

First, it is recommended to read the AR/VR Primer tutorial on the official Godot documentation website, where the basic VR concepts in Godot are explained.

Next, there is a starter tutorial there as well. If you prefer video, Bastiaan Olij has a good tutorial of the godot-openvr asset on Youtube.

Beginner topics

• Setting up a basic project - The bare minimum to get started
• OpenVR actions - Using the OpenVR actions interface (coming in 1.1)

Advanced topics

• Displaying 3D controller models - Showing the correct controller mesh
• Rendering to a separate viewport - Rendering to a separate viewport to fix the sRGB color issue
• Using OpenVR overlays - Using the OpenVR plugin to create overlay applications
• Godot VR Common - a toolkit library with lots of handy things to hit the ground running