Skip to content

Commit e94f116

Browse files
committed
Add an about page for the Godot XR Editor
1 parent f8796c2 commit e94f116

File tree

3 files changed

+144
-19
lines changed

3 files changed

+144
-19
lines changed

tutorials/editor/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ in other sections where appropriate. For example, the :ref:`animation editor
2727
default_key_mapping
2828
customizing_editor
2929

30+
XR editor
31+
---------
32+
33+
Godot offers a port of the editor designed to run natively on Meta Quest devices.
34+
The port can be downloaded from the `Meta Horizon Store <https://www.meta.com/experiences/godot-game-engine/7713660705416473/>`__,
35+
or from the `Godot download page <https://godotengine.org/download/preview/>`__.
36+
37+
.. toctree::
38+
:maxdepth: 1
39+
:name: toc-xr-editor
40+
41+
using_the_xr_editor
42+
3043
Android editor
3144
--------------
3245

tutorials/editor/using_the_android_editor.rst

Lines changed: 47 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
Using the Android editor
44
========================
55

6-
In 2023, `we added <https://godotengine.org/article/android_godot_editor_play_store_beta_release/>`__
7-
an `Android port of the editor <https://godotengine.org/download/android/>`__
8-
that can be used to work on new or existing projects on Android devices.
6+
In 2023, we added an `Android port of the editor <https://godotengine.org/article/android_godot_editor_play_store_beta_release/>`__
7+
that can be used to create, develop, and export 2D and 3D projects on Android devices.
8+
9+
The app can be downloaded from the `Godot download page <https://godotengine.org/download/android/>`__
10+
or from the `Google Play Store <https://play.google.com/store/apps/details?id=org.godotengine.editor.v4>`__.
911

1012
.. note::
1113

12-
The Android editor is in early access, while we continue to refine the experience,
13-
and bring it up to parity with the Desktop version of the editor. See :ref:`doc_using_the_android_editor_limitations` below.
14+
The Android editor is in early access, while we continue to refine the experience. See :ref:`doc_using_the_android_editor_limitations` below.
1415

1516
Android devices support
1617
-----------------------
@@ -21,31 +22,58 @@ The Android editor requires devices running Android 5 Lollipop or higher, with a
2122
- Android-powered netbooks
2223
- Chromebooks supporting Android apps
2324

24-
.. _doc_using_the_android_editor_limitations:
25+
Runtime Permissions
26+
-------------------
27+
28+
- `All files access permission <https://developer.android.com/training/data-storage/manage-all-files#all-files-access>`__:
29+
Enables the editor to create, import, and read project files from any file locations on the device.
30+
Without this permission, the editor is still functional, but has limited access to the device's files and directories.
31+
- `REQUEST_INSTALL_PACKAGES <https://developer.android.com/reference/android/Manifest.permission#REQUEST_INSTALL_PACKAGES>`__: Enables the editor to install exported project APKs.
32+
- `RECORD_AUDIO <https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO>`__: Requested when the `audio/driver/enable_input <https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-audio-driver-enable-input>`__ project setting is enabled.
33+
34+
Tips & Tricks
35+
-------------
36+
37+
**Input**
38+
39+
- For the best experience and high level of productivity, connecting a bluetooth keyboard & mouse is recommended to interact with the Android editor.
40+
The Android editor supports all of the `usual shortcuts and key mappings <https://docs.godotengine.org/en/stable/tutorials/editor/default_key_mapping.html>`__.
41+
- When interacting with keyboard & mouse, you can decrease the size of the scrollbar using the `interface/touchscreen/increase_scrollbar_touch_area <https://docs.godotengine.org/en/stable/classes/class_editorsettings.html#class-editorsettings-property-interface-touchscreen-increase-scrollbar-touch-area>`__ editor setting.
42+
- For 2D projects, the `block coding plugin <https://godotengine.org/asset-library/asset/3095>`__ can provide a block-based visual alternative to composing scripts when lacking a connected hardware keyboard.
2543

26-
Required Permissions
27-
--------------------
44+
**Multi-tasking**
2845

29-
The Android editor requires the `All files access permission <https://developer.android.com/training/data-storage/manage-all-files#all-files-access>`__.
30-
The permission allows the editor to create / import / read project files from any file locations on the device.
31-
Without the permission, the editor is still functional, but has limited access to the device's files and directories.
46+
- On smaller devices, enabling and using picture-in-picture (PiP) mode provides the ability to easily transition between the *Editor* and the *Play window*.
47+
48+
- PiP can be enabled via the `run/window_placement/play_window_pip_mode <https://docs.godotengine.org/en/latest/classes/class_editorsettings.html#class-editorsettings-property-run-window-placement-play-window-pip-mode>`__ editor setting.
49+
- The `run/window_placement/android_window <https://docs.godotengine.org/en/latest/classes/class_editorsettings.html#class-editorsettings-property-run-window-placement-android-window>`__ editor setting can be used to specify whether the *Play* window should always launch in PiP mode.
50+
- **Note:** In PiP mode, the *Play* window does not have input access.
51+
52+
**Projects sync**
53+
54+
- Syncing projects via Git can be done by downloading an Android Git client.
55+
We recommend the `Termux terminal <https://termux.dev/en/>`__, an Android terminal emulator which provides access to common terminal utilities such Git and SSH.
56+
57+
- **Note:** To use Git with the Termux terminal, you'll need to grant *WRITE* permission to the terminal.
58+
This can be done by `running the following command <https://wiki.termux.com/wiki/Termux-setup-storage>`__ from within the terminal: ``termux-setup-storage``
59+
60+
.. _doc_using_the_android_editor_limitations:
3261

3362
Limitations & known issues
3463
--------------------------
3564

3665
Here are the known limitations and issues of the Android editor:
3766

38-
- No C#/Mono support
39-
- No support for external script editors
40-
- While available, the *Vulkan Forward+* renderer is not recommended due to severe performance issues
41-
- No support for building and exporting an Android APK binary.
42-
As a workaround, you can generate and export a `Godot PCK or ZIP file <https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html#pck-versus-zip-pack-file-formats>`__
43-
- No support for building and exporting binaries for other platforms
44-
- UX not optimized for Android phones form-factor
67+
- No C#/Mono support.
68+
- No support for external script editors.
69+
- While available, the *Vulkan Forward+* renderer is not recommended due to severe performance issues.
70+
- UX not optimized for Android phones form-factor.
4571
- `Android Go devices <https://developer.android.com/guide/topics/androidgo>`__ lacks
4672
the *All files access* permission required for device read/write access.
4773
As a workaround, when using an Android Go device, it's recommended to create new projects only in the Android *Documents* or *Downloads* directories.
48-
- The editor doesn't properly resume when *Don't keep activities* is enabled in the *Developer Options*
74+
- The editor doesn't properly resume when *Don't keep activities* is enabled in the *Developer Options*.
75+
- There is a `bug <https://github.com/godotengine/godot/issues/70751>`__ with the Samsung keyboard that causes random input to be inserted when writing scripts.
76+
It's recommended to use the `Google keyboard (Gboard) <https://play.google.com/store/apps/details?id=com.google.android.inputmethod.latin>`__ instead.
4977

5078
.. seealso::
5179

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
.. _doc_using_the_xr_editor:
2+
3+
Using the XR editor
4+
===================
5+
6+
In 2024, we introduced the `Godot XR editor <https://godotengine.org/article/godot-editor-horizon-store-early-access-release/>`__,
7+
a version of the Godot editor **designed to run natively on XR devices**, enabling the creation,
8+
development and export of 2D, 3D, and **XR** apps and games directly on device.
9+
10+
The app can be downloaded from the `Meta Horizon Store <https://www.meta.com/experiences/godot-game-engine/7713660705416473/>`__,
11+
or from the `Godot download page <https://godotengine.org/download/preview/>`__.
12+
13+
.. note::
14+
15+
The XR editor is in early access, while we continue to refine the experience. See :ref:`doc_using_the_xr_editor_limitations` below.
16+
17+
XR devices support
18+
------------------
19+
20+
For now, the Godot XR editor is only available for the following `Meta Quest <https://www.meta.com/quest/>`__
21+
devices running **Meta Horizon OS v69 or higher**:
22+
23+
- Meta Quest 3
24+
- Meta Quest 3s
25+
- Meta Quest Pro
26+
27+
.. note::
28+
29+
We are working to add support for more XR devices, including PCVR devices.
30+
31+
Runtime Permissions
32+
-------------------
33+
34+
- `All files access permission <https://developer.android.com/training/data-storage/manage-all-files#all-files-access>`__:
35+
Enables the editor to create, import, and read project files from any file locations on the device.
36+
Without this permission, the editor is still functional, but has limited access to the device's files and directories.
37+
- `REQUEST_INSTALL_PACKAGES <https://developer.android.com/reference/android/Manifest.permission#REQUEST_INSTALL_PACKAGES>`__: Enables the editor to install exported project APKs.
38+
- `RECORD_AUDIO <https://developer.android.com/reference/android/Manifest.permission#RECORD_AUDIO>`__: Requested when the `audio/driver/enable_input <https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-audio-driver-enable-input>`__ project setting is enabled.
39+
- `USE_SCENE <https://developers.meta.com/horizon/documentation/native/native-spatial-data-perm/>`__: Required to enable and access the scene APIs when running an XR project.
40+
41+
Tips & Tricks
42+
-------------
43+
44+
**Input**
45+
46+
- For the best experience and high level of productivity, connecting a bluetooth keyboard & mouse is recommended to interact with the XR editor.
47+
The XR editor supports all of the `usual shortcuts and key mappings <https://docs.godotengine.org/en/stable/tutorials/editor/default_key_mapping.html>`__.
48+
- When interacting with tracked controllers or tracked hands, you can toggle on the
49+
`interface/touchscreen/enable_long_press_as_right_click <https://docs.godotengine.org/en/stable/classes/class_editorsettings.html#class-editorsettings-property-interface-touchscreen-enable-long-press-as-right-click>`__ editor setting to enable right-click by long press.
50+
- When interacting with tracked controllers or tracked hands, you can increase the size of the scrollbar using the
51+
`interface/touchscreen/increase_scrollbar_touch_area <https://docs.godotengine.org/en/stable/classes/class_editorsettings.html#class-editorsettings-property-interface-touchscreen-increase-scrollbar-touch-area>`__ editor setting.
52+
53+
**Multi-tasking**
54+
55+
- `Theater View <https://www.meta.com/blog/quest/meta-quest-v67-update-new-window-layout-creator-content-horizon-feed/>`__ can be used to fullscreen the *Editor window*.
56+
- Enable `Seamless Multitasking <https://www.uploadvr.com/seamless-multitasking-experimental-quest/>`__, available in the Quest *Experimental Settings*,
57+
to enable the ability to quickly transition between a running XR project and the *Editor window*.
58+
- When developing a non-XR project, the Godot editor app icon will provide the ability to switch between the *Editor window* and the *Play window* when the latter is active, using Quest's *App menu* feature.
59+
- When developing and running an XR project, you can bring back the *Editor window* by:
60+
61+
- Pressing on the *Meta* button to invoke the menu bar
62+
- Clicking on the Godot editor app icon to summon the *App menu*, and select the *Editor window* tile.
63+
64+
**Projects sync**
65+
66+
- Syncing projects via Git can be done by downloading an Android Git client. We recommend the `Termux terminal <https://termux.dev/en/>`__,
67+
an Android terminal emulator which provides access to common terminal utilities such Git and SSH.
68+
69+
- **Note:** To use Git with the Termux terminal, you'll need to grant *WRITE* permission to the terminal.
70+
This can be done by `running the following command <https://wiki.termux.com/wiki/Termux-setup-storage>`__ from within the terminal: ``termux-setup-storage``
71+
72+
.. _doc_using_the_xr_editor_limitations:
73+
74+
Limitations & known issues
75+
--------------------------
76+
77+
Here are the known limitations and issues of the XR editor:
78+
79+
- No Meta Quest 2 support due to the limited amount of memory on the device.
80+
However advanced users can grab the XR editor APK from the `download page <https://godotengine.org/download/preview/>`__
81+
and sideload it onto their device if they desire to do so.
82+
- No C#/Mono support.
83+
- No support for external script editors.
84+
- While available, the *Vulkan Forward+* renderer is not recommended due to severe performance issues.

0 commit comments

Comments
 (0)