Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Deploying to Android

Setup

Most mobile headsets run on Android and OpenXR support is making its way to these platforms. There are specific requirements for deploying XR projects to Android. For general requirements around exporting to Android, please first read Exporting for Android.

Note

Official support for the Android platform wasn't added to the OpenXR specification initially resulting in various vendors creating custom loaders to make OpenXR available on their headsets. While the long term expectation is that all vendors will adopt the official OpenXR loader, for now these loaders need to be added to your project.

Custom Android build

In order to deploy the loaders into your project you will need to setup a custom Android build.

Select Install Android Build Template... from the Project menu:

../../_images/android_custom_build.webp

This will create a folder called android inside of your project that contains all the runtime files needed on Android. You can now customize this installation. Godot won't show this in the editor but you can find it with a file browser.

You can read more about custom builds here: Custom builds for Android.

Installing the loader plugins

The loaders can be downloaded from the asset library, search for OpenXR Loaders and install the plugin:

../../_images/openxr_loader_asset_lib.webp

You will find the installed files inside the android folder. There is a subfolder called plugins containing the new files.

You can find the main repository of the loader plugin here.

Creating the export templates

You will need to setup a separate export template for each device as each device will need its own loader included.

Open Project and select Export... Click on Add.. and select Android. Next change the name of the export profile for the device you're setting this up for, say Meta Quest. And enable Use Gradle Build.

If the loader plugins were installed correctly you should find entries for the different headsets, select the entry for meta:

../../_images/android_meta_quest.webp

Scroll further down the list until you find the XR Features section. Change the XR Mode to OpenXR. The hand tracking and passthrough settings here currently only work for the Meta Quest and you will need to select the appropriate settings if you wish to use these features.

../../_images/xr_export_features.webp

Now you can repeat the same process for the other devices. Note that if you wish to test your game with Godots one-click deploy, you have to mark the export profile for your device as Runnable so Godot knows which loader to deploy.

Note

There are separate loaders for the Meta Quest, Pico and Lynx R1 headsets.

The fourth option is the official Khronos (KHR) loader, in due time all headsets should work with this loader. At the moment this loader has been tested with the Magic Leap 2 and standalone HTC headsets.

Warning

While the Mobile Vulkan renderer has many optimizations targeted at mobile devices, we're still working out the kinks. It is highly advisable to use the OpenGL renderer for the time being when targeting Android based XR devices.

Note that we are awaiting driver updates on various devices before Vulkan support will work on these.