Skip to content

Commit 7cf7f13

Browse files
authored
Merge pull request #7439 from m4gr3d/update_android_section
2 parents 3b6184e + 031cfc2 commit 7cf7f13

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

tutorials/editor/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ in other sections where appropriate. For example, the :ref:`animation editor
2424
default_key_mapping
2525
customizing_editor
2626

27+
Android editor
28+
--------------
29+
30+
Godot offers a native port of the editor running entirely on Android devices.
31+
The Android port can be downloaded from the `Android Downloads page <https://godotengine.org/download/android/>`__.
32+
While we strive for feature parity with the Desktop version of the editor,
33+
the Android port has a certain amount of caveats you should be aware of.
34+
35+
.. toctree::
36+
:maxdepth: 1
37+
:name: toc-android-editor
38+
39+
using_the_android_editor
40+
2741
Web editor
2842
----------
2943

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _doc_using_the_android_editor:
2+
3+
Using the Android editor
4+
========================
5+
6+
In 2023, `we added <https://godotengine.org/article/android_godot_editor_play_store_beta_release/>`__
7+
a `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.
9+
10+
.. note::
11+
12+
The Android editor is in beta testing stage, 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+
15+
Android devices support
16+
-----------------------
17+
18+
The Android editor requires devices running Android 5 Lollipop or higher, with at least OpenGL 3 support. This includes (not exhaustive):
19+
20+
- Android tablets, foldables and large phones
21+
- Android-powered netbooks
22+
- Chromebooks supporting Android apps
23+
24+
.. _doc_using_the_android_editor_limitations:
25+
26+
Required Permissions
27+
--------------------
28+
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.
32+
33+
Limitations & known issues
34+
--------------------------
35+
36+
Here are the known limitations and issues of the Android editor:
37+
38+
- No C#/Mono support
39+
- No GDExtension support
40+
- No support for external script editors
41+
- While available, the *Vulkan Forward+* renderer is not recommended due to severe performance issues
42+
- No support for building and exporting an Android APK binary.
43+
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>`__
44+
- No support for building and exporting binaries for other platforms
45+
- Performance and stability issues when using the *Vulkan Mobile* renderer for a project
46+
- UX not optimized for Android phones form-factor
47+
- `Android Go devices <https://developer.android.com/guide/topics/androidgo>`__ lacks
48+
the *All files access* permission required for device read/write access.
49+
As a workaround, when using a Android Go device, it's recommended to create new projects only in the Android *Documents* or *Downloads* directories.
50+
- The editor doesn't properly resume when *Don't keep activities* is enabled in the *Developer Options*
51+
52+
.. seealso::
53+
54+
See the
55+
`list of open issues on GitHub related to the Android editor <https://github.com/godotengine/godot/issues?q=is%3Aopen+is%3Aissue+label%3Aplatform%3Aandroid+label%3Atopic%3Aeditor>`__ for a list of known bugs.

0 commit comments

Comments
 (0)