jkankiewicz / godot-xr-tools

Support scenes for AR and VR in Godot

Godot XR Tools

This repository contains a number of support files and support scenes that can be used together with the various AR and VR interfaces for the Godot game engine.

Versions

Official releases are tagged and can be found here.

The following branches are in active development:

Branch	Description	Godot version
master	Current development branch	Godot 4.0+
3.x	Godot 3.x development branch	Godot 3.5+

How to Use

Information about how to use this plugin can be found on the website.

Demo

This repository now contains a full demo for XR Tools with the XR Tools add on included in this demo.

After cloning this repository you will need to install the OpenXR plugin for it to work. The OpenXR plugin is not included within this repository. You can obtain the OpenXR plugin here or download it from the asset library within Godot.

Note that the demo in the 4.0-dev branch has been upgraded to work with the most recent 4.0-beta releases.

XR Tools library

To obtain just the XR Tools library for your own project, please check releases or download it from the asset library within Godot.

Preventing hickups

As many of the functions in this module will hide objects that are later shown as the user performs actions, the user will experience a hickup as Godot compiles the shader used to draw the object on screen.

To combat this you will find a scene in this module called misc/VR_Common_Shader_Cache.tscn. Add this scene as a child node to your ARVRCamera. This will trigger the required shaders being compiled the first time your main scene loads.

Licensing

Code in this repository is licensed under the MIT license. Images are licensed under CC0 unless otherwise specified.

See the full license inside of the addons folder.

About this repository

This repository was created by Bastiaan Olij a.k.a. Mux213

It is primarily maintained by:

• Bastiaan Olij
• Malcolm Nixon

For further contributors please see CONTRIBUTORS.md

Further resources:

• Bastiaan Olij on Twitter for regular updates
• Bastiaan Olij on Youtube for tutorials
• Malcolm Nixon on Youtube for demonstrations of Godot XR Tools.