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/editor/index.rst
+12Lines changed: 12 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,18 @@ in other sections where appropriate. For example, the :ref:`animation editor
27
27
default_key_mapping
28
28
customizing_editor
29
29
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/>`__, or from the `Godot download page <https://godotengine.org/download/preview/>`__.
Copy file name to clipboardExpand all lines: tutorials/editor/using_the_android_editor.rst
+35-14Lines changed: 35 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@
3
3
Using the Android editor
4
4
========================
5
5
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/>`__ or from the `Google Play Store <https://play.google.com/store/apps/details?id=org.godotengine.editor.v4>`__.
9
10
10
11
.. note::
11
12
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.
13
+
The Android editor is in early access, while we continue to refine the experience. See :ref:`doc_using_the_android_editor_limitations` below.
14
14
15
15
Android devices support
16
16
-----------------------
@@ -21,14 +21,37 @@ The Android editor requires devices running Android 5 Lollipop or higher, with a
21
21
- Android-powered netbooks
22
22
- Chromebooks supporting Android apps
23
23
24
-
.. _doc_using_the_android_editor_limitations:
25
-
26
-
Required Permissions
24
+
Runtime Permissions
27
25
--------------------
28
26
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.
27
+
- `All files access permission <https://developer.android.com/training/data-storage/manage-all-files#all-files-access>`__: Enables the editor to create / import / read project files from any file locations on the device. Without the permission, the editor is still functional, but has limited access to the device's files and directories.
28
+
- `REQUEST_INSTALL_PACKAGES <https://developer.android.com/reference/android/Manifest.permission#REQUEST_INSTALL_PACKAGES>`__: Enables the editor to install exported project APKs.
29
+
- `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.
30
+
31
+
Tips & Tricks
32
+
-------------
33
+
34
+
**Input**
35
+
36
+
- For the best experience and high level of productivity, connecting a bluetooth keyboard & mouse is recommended to interact with the Android editor. The Android editor supports all of the `usual shortcuts and key mappings <https://docs.godotengine.org/en/stable/tutorials/editor/default_key_mapping.html>`__.
37
+
- 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.
38
+
- 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.
39
+
40
+
**Multi-tasking**
41
+
42
+
- On smaller devices, enabling and using picture-in-picture (PiP) mode provides the ability to easily transition between the *Editor* and the *Play window*.
43
+
44
+
- 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.
45
+
- 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.
46
+
- **Note:** In PiP mode, the *Play* window does not have input access.
47
+
48
+
**Projects sync**
49
+
50
+
- Syncing projects via Git can be done by downloading an Android Git client. We recommend the `Termux terminal <https://termux.dev/en/>`__, an Android terminal emulator which provides access to common terminal utilities such Git and SSH.
51
+
52
+
- **Note:** To use Git with the Termux terminal, you'll need to grant *WRITE* permission to the terminal. This can be done by `running the following command <https://wiki.termux.com/wiki/Termux-setup-storage>`__ from within the terminal: ``termux-setup-storage``
53
+
54
+
.. _doc_using_the_android_editor_limitations:
32
55
33
56
Limitations & known issues
34
57
--------------------------
@@ -38,14 +61,12 @@ Here are the known limitations and issues of the Android editor:
38
61
- No C#/Mono support
39
62
- No support for external script editors
40
63
- 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
64
- UX not optimized for Android phones form-factor
45
65
- `Android Go devices <https://developer.android.com/guide/topics/androidgo>`__ lacks
46
66
the *All files access* permission required for device read/write access.
47
67
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
68
- The editor doesn't properly resume when *Don't keep activities* is enabled in the *Developer Options*
69
+
- 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. It's recommended to use the `Google keyboard (Gboard) <https://play.google.com/store/apps/details?id=com.google.android.inputmethod.latin>`__ instead.
In 2024, we introduced the `Godot XR Editor <https://godotengine.org/article/godot-editor-horizon-store-early-access-release/>`__, a version of the Godot Editor **designed to run natively on XR devices**, enabling the creation, development and export of 2D, 3D and **XR** apps and games directly on device.
7
+
8
+
The app can be downloaded from the `Meta Horizon Store <https://www.meta.com/experiences/godot-game-engine/7713660705416473/>`__, or from the `Godot download page <https://godotengine.org/download/preview/>`__.
9
+
10
+
.. note::
11
+
12
+
The XR editor is in early access, while we continue to refine the experience. See :ref:`doc_using_the_xr_editor_limitations` below.
13
+
14
+
XR devices support
15
+
------------------
16
+
17
+
For now, the Godot XR Editor is only available for the following `Meta Quest <https://www.meta.com/quest/>`__ devices running **Meta Horizon OS v69 or higher**:
18
+
19
+
- Meta Quest 3
20
+
- Meta Quest 3s
21
+
- Meta Quest Pro
22
+
23
+
.. note::
24
+
25
+
We are working to add support for more XR devices, including PCVR devices.
26
+
27
+
Runtime Permissions
28
+
--------------------
29
+
30
+
- `All files access permission <https://developer.android.com/training/data-storage/manage-all-files#all-files-access>`__: Enables the editor to create / import / read project files from any file locations on the device. Without the 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
+
- `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.
34
+
35
+
Tips & Tricks
36
+
-------------
37
+
38
+
**Input**
39
+
40
+
- For the best experience and high level of productivity, connecting a bluetooth keyboard & mouse is recommended to interact with the XR editor. The XR 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 tracked controllers or tracked hands, you can toggle on the `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.
42
+
- When interacting with tracked controllers or tracked hands, you can increase 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.
43
+
44
+
**Multi-tasking**
45
+
46
+
- `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.
47
+
- Enable `Seamless Multitasking <https://www.uploadvr.com/seamless-multitasking-experimental-quest/>`__, available in the Quest *Experimental Settings*, to enable the ability to quickly transition between a running XR project and the Editor window.
48
+
- 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.
49
+
- When developing and running an XR project, you can bring back the *Editor window* by:
50
+
51
+
- Pressing on the *Meta* button to invoke the menu bar
52
+
- Clicking on the Godot Editor app icon to summon the *App menu*, and select the *Editor window* tile.
53
+
54
+
**Projects sync**
55
+
56
+
- Syncing projects via Git can be done by downloading an Android Git client. We recommend the `Termux terminal <https://termux.dev/en/>`__, an Android terminal emulator which provides access to common terminal utilities such Git and SSH.
57
+
58
+
- **Note:** To use Git with the Termux terminal, you'll need to grant *WRITE* permission to the terminal. 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_xr_editor_limitations:
61
+
62
+
Limitations & known issues
63
+
--------------------------
64
+
65
+
Here are the known limitations and issues of the XR editor:
66
+
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
0 commit comments