You are reading the
(unstable) version of this documentation, which may document features not available
or compatible with Godot 3.x.
Checking the stable version of the documentation...
Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
Introducing XR tools¶
Out of the box Godot gives you all the basic support to setup an XR project. XR specific game mechanics however need to be implemented on top of this foundation. While Godot makes this relatively easy this can still be a daunting task.
For this reason Godot has developed a toolkit called Godot XR Tools that implements many of the basic mechanics found in XR games, from locomotion to object interaction to UI interaction.
This toolkit is designed to work with both OpenXR and WebXR runtimes. We'll be using this as a base for our documentation here. It helps developers hit the ground running but for more specific use cases building your own logic is just as valid. In that case XR tools can help in providing inspiration.
The current stable release of Godot XR Tools available on the Asset Library is the version for Godot 3. The port of Godot XR Tools for Godot 4 is available for download from the github website. We will walk through the step of downloading and installing it here. We will update the documentation once Godot XR Tools becomes available for Godot 4 through the asset library.
Installing XR Tools¶
Continuing on from our project we started in Setting up XR we want to add in the Godot XR Tools library.
This can be downloaded from the Godot XR Tools releases page.
Simply find the latest pre-release for Godot 4 and then under assets download the
Once downloaded unzip the file.
You will notice the files are held within a
Inside of this folder you will find an
It is this folder that you want to copy in its entirety to your Godot project folder, your project should now look something like this:
Now open up your project in Godot, if you haven't already, and give it a minute or so to import all the resources of the plugin.
Next open the
Project menu and select
Now go to the
Plugins tab and enable the plugin.
Just to get a feel of things we're going to add a few standard components that dress up our scene starting with hands for our player.
OpenXR supports full hand tracking however there currently are significant differences in capabilities between the different XR Runtimes.
As a reliable alternative Godot XR Tools comes with a number of rigged hand scenes that react on trigger and grip inputs of your controller. These hands come in low and high poly versions, come in a few configurations, a number of animation files to control finger positions and a number of different textures.
In your scene tree select your left hand XRController3D node.
Now click on the
instantiate Child Scene button to add a child scene.
As you can see from the path of this scene, low poly models are in the
lowpoly subfolder while high poly models are in the
You will want to use the low poly versions if you plan to release your game on mobile devices.
The default hand we chose is just a hand. The other options are:
tac_glove - the hand is wearing a glove with fingers exposed
full_glove - the hand is wearing a glove that covers the entire hand
Finally each hand comes in a
This exposes all the bones.
We'll look at how that can be used in another tutorial.
We repeat the same for the right hand.
We'll continue with adding features to our tutorial project using Godot XR tools in the next couple of pages. More detailed information about the toolkit can be found on the toolkits help pages.