You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorials/xr/deploying_to_android.rst
+19-43Lines changed: 19 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,10 @@ Before following the OpenXR-specific instructions here, you'll need to first set
16
16
17
17
See :ref:`doc_exporting_for_android` for the full details, and return here when you've finished these steps.
18
18
19
+
.. warning::
20
+
While the Mobile Vulkan renderer has many optimizations targeted at mobile devices, we're still working out the kinks.
21
+
It is highly advisable to use the compatibility renderer (OpenGL) for the time being when targeting Android based XR devices.
22
+
19
23
Gradle Android build
20
24
--------------------
21
25
@@ -36,38 +40,18 @@ You can read more about gradle builds here: :ref:`doc_android_gradle_build`.
36
40
Installing the vendors plugin
37
41
-----------------------------
38
42
39
-
.. warning::
40
-
The Android plugin structure has been restructured in Godot 4.2, and the loader plugin was renamed to vendors plugin as it now includes more than just loaders.
41
-
If you've previously installed the loader plugin you need to delete it from the `android/plugins` folder.
42
-
43
-
The vendors plugin can be downloaded from the asset library, search for "OpenXR vendors" and install the plugin:
43
+
The vendors plugin can be downloaded from the asset library, search for "OpenXR
44
+
vendors" and install the one named "Godot OpenXR Vendors plugin for Godot 4.3".
44
45
45
46
.. image:: img/openxr_loader_asset_lib.webp
46
47
47
-
You will find the installed files inside the **addons** folder.
48
-
49
-
Alternatively you can manually install the vendors plugin by downloading the v2.x version of the plugin `from the release page here <https://github.com/GodotVR/godot_openxr_vendors/releases>`__.
50
-
51
-
You will need to copy the `assets/addons/godotopenxrvendors` folder from the zip file into your projects `addons` folder.
48
+
You will find the installed files inside the **addons** folder. Alternatively you
49
+
can manually install the vendors plugin by downloading it `from the release page here <https://github.com/GodotVR/godot_openxr_vendors/releases>`__.
50
+
you will need to copy the `assets/addons/godotopenxrvendors` folder from the zip
51
+
file into your projects `addons` folder.
52
52
53
53
You can find the main repository of the vendors plugin `here <https://github.com/GodotVR/godot_openxr_vendors>`__.
54
54
55
-
Enabling the vendors plugin
56
-
---------------------------
57
-
58
-
The vendors plugin needs to be enabled before the export settings become accessible.
59
-
Open **Project** and select **Project Settings...**.
60
-
Go to the **Plugins** tab.
61
-
Enable the **GodotOpenXRVendors** plugin.
62
-
63
-
.. image:: img/xr_enable_vendors_plugin.webp
64
-
65
-
.. note::
66
-
This is no longer required from vendors plugin 2.0.3 onwards as it now uses GDExtension.
67
-
The plugin will not be shown in this list.
68
-
You can verify it is installed correctly by checking if the export presets contain
69
-
the entries described below.
70
-
71
55
Creating the export presets
72
56
---------------------------
73
57
You will need to setup a separate export preset for each device, as each device will need its own loader included.
@@ -78,28 +62,20 @@ Next change the name of the export preset for the device you're setting this up
78
62
And enable **Use Gradle Build**.
79
63
If you want to use one-click deploy (described below), ensure that **Runnable** is enabled.
80
64
81
-
If the vendors plugins were installed correctly you should find entries for the different headsets, select the entry for meta:
65
+
If the vendors plugins were installed correctly you should find entries for the
66
+
different headsets under **XR Features**. Change the **XR Mode** to **OpenXR**, then
67
+
select the entry for your headset if you see one. If you don't see one enable the
68
+
Khronos plugin. It's the official Khronos loader, in due time all headsets should
69
+
work with this loader. At the moment this loader has been tested with the Magic Leap
70
+
2 and standalone HTC headsets.
82
71
83
72
.. image:: img/android_meta_quest.webp
84
73
85
-
Also change the **XR Mode** to **OpenXR**.
86
74
87
-
Scroll to the bottom of the list and you'll find additional XR feature sections, currently only **Meta XR Features** is available.
88
-
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.
89
75
90
-
.. image:: img/xr_export_features.webp
91
-
92
-
Now you can repeat the same process for the other devices.
93
-
94
-
.. note::
95
-
There are separate loaders for the Meta Quest, Pico and Lynx R1 headsets.
96
-
97
-
The fourth option is the official Khronos loader, in due time all headsets should work with this loader.
98
-
At the moment this loader has been tested with the Magic Leap 2 and standalone HTC headsets.
99
-
100
-
.. warning::
101
-
While the Mobile Vulkan renderer has many optimizations targeted at mobile devices, we're still working out the kinks.
102
-
It is highly advisable to use the compatibility renderer (OpenGL) for the time being when targeting Android based XR devices.
76
+
Scroll to the bottom of the list and you'll find additional XR feature sections,
77
+
currently only **Meta XR Features** and **Pico XR Features** are available.
78
+
You will need to select the appropriate settings if you wish to use these features.
0 commit comments