Home

Welcome to the Godot OpenXR wiki!

Introduction

This repository holds the source code and latest releases for the Godot OpenXR plugin.

This plugin currently targets Godot 3.4.0 and up but does not currently work with the Godot 4 which is currently in development.

Note that this plugin is under constant development and often relies on improvements in the current 3.x branch for some of its latest features. We are taking care however that all the base functionality will work with the current stable Godot 3 release.

Please follow the instructions in the readme of this repo for building the plugin from source. If you just want to download the latest release check here.

Getting started

To start a new project that supports OpenXR start by opening up the Godot editor and creating a new project.

Copy the plugin into this new project in the subfolder addons/godot_openxr using your favorite file browser. It is very important that it is placed in this exact location in your project folder.

Back in Godot create a new 3D scene and press to select the addons/godot_openxr/scenes/first_person_controller_vr.tscn subscene and add it into your scene. Right click on the added node and select editable children to gain access to some of the components in this subscene:

Note in 1.1.0 and earlier it is important to add a script on the root node and call $FPSController.initialise(), this is no longer required in v1.1.1 and later.

This is the bare minimum you need however for good measure we suggest adding a directional light and maybe a few mesh instance nodes so you have something to see. If you add those to the hand nodes you can visualise where your controllers are tracking.

Your scene should now look something like this:

Now you can press to start your project and you should be able to look around.

Next steps

To turn this simple scene into a proper game the sky is the limit. Below there are a few more topics specific to this plugin however the following resources are a good place to continue:

• VR starter tutorial in the official documentation may focus on OpenVR but almost everything there applies to OpenXR as well.
• Godot XR tools is a plugin that contains a set of handy sub scene to quickly implement locomotion, object interaction and UI elements into your XR experience.

Please check the Godot Engine community page to find help from other Godot developers. The #XR channel on the Godot Discord has become a vibrant Godot XR community.

Plugin features

• Enabling plugin features
• Runtime selection
• Passthrough
• Deploying on Android

more coming soon we'll be discussing further features implemented in this plugin such as configuration, finger tracking and more.