Skip to content

Commit e269ed9

Browse files
authored
Merge pull request godotengine#7884 from m4gr3d/update_android_plugin_tutorial
Update the Android documentation for Godot 4.2
2 parents 2c102ff + 66ee5cb commit e269ed9

20 files changed

+601
-188
lines changed

_tools/redirects/redirects.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ source,destination
130130
/getting_started/workflow/best_practices/scene_organization.html,/tutorials/best_practices/scene_organization.html
131131
/getting_started/workflow/best_practices/scenes_versus_scripts.html,/tutorials/best_practices/scenes_versus_scripts.html
132132
/getting_started/workflow/best_practices/what_are_godot_classes.html,/tutorials/best_practices/what_are_godot_classes.html
133-
/getting_started/workflow/export/android_custom_build.html,/tutorials/export/android_custom_build.html
133+
/getting_started/workflow/export/android_custom_build.html,/tutorials/export/android_gradle_build.html
134134
/getting_started/workflow/export/changing_application_icon_for_windows.html,/tutorials/export/changing_application_icon_for_windows.html
135135
/getting_started/workflow/export/exporting_for_android.html,/tutorials/export/exporting_for_android.html
136136
/getting_started/workflow/export/exporting_for_dedicated_servers.html,/tutorials/export/exporting_for_dedicated_servers.html

about/docs_changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ New pages since version 3.1
235235
Project workflow
236236
^^^^^^^^^^^^^^^^
237237

238-
- :ref:`doc_android_custom_build`
238+
- :ref:`doc_android_gradle_build`
239239

240240
2D
241241
^^

classes/class_editorexportplatformandroid.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Tutorials
2121

2222
- :doc:`Exporting for Android <../tutorials/export/exporting_for_android>`
2323

24-
- :doc:`Custom builds for Android <../tutorials/export/android_custom_build>`
24+
- :doc:`Gradle builds for Android <../tutorials/export/android_gradle_build>`
2525

2626
- :doc:`Android plugins documentation index <../tutorials/platform/index>`
2727

contributing/development/compiling/compiling_for_android.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ root directory with the following arguments:
9494

9595
::
9696

97-
scons platform=android target=template_release arch=armv7
98-
scons platform=android target=template_release arch=arm64v8
97+
scons platform=android target=template_release arch=arm32
98+
scons platform=android target=template_release arch=arm64
9999
cd platform/android/java
100100
# On Windows
101101
.\gradlew generateGodotTemplates
@@ -109,8 +109,8 @@ The resulting APK will be located at ``bin/android_release.apk``.
109109

110110
::
111111

112-
scons platform=android target=template_debug arch=armv7
113-
scons platform=android target=template_debug arch=arm64v8
112+
scons platform=android target=template_debug arch=arm32
113+
scons platform=android target=template_debug arch=arm64
114114
cd platform/android/java
115115
# On Windows
116116
.\gradlew generateGodotTemplates
@@ -135,9 +135,9 @@ example, for the release template:
135135

136136
::
137137

138-
scons platform=android target=template_release arch=armv7
139-
scons platform=android target=template_release arch=arm64v8
140-
scons platform=android target=template_release arch=x86
138+
scons platform=android target=template_release arch=arm32
139+
scons platform=android target=template_release arch=arm64
140+
scons platform=android target=template_release arch=x86_32
141141
scons platform=android target=template_release arch=x86_64
142142
cd platform/android/java
143143
# On Windows
@@ -160,9 +160,9 @@ You can use the following commands to remove the generated export templates:
160160

161161
cd platform/android/java
162162
# On Windows
163-
.\gradlew cleanGodotTemplates
163+
.\gradlew clean
164164
# On Linux and macOS
165-
./gradlew cleanGodotTemplates
165+
./gradlew clean
166166

167167

168168
Using the export templates
@@ -213,9 +213,9 @@ root directory with the following arguments:
213213

214214
::
215215

216-
scons platform=android arch=armv7 production=yes target=editor
217-
scons platform=android arch=arm64v8 production=yes target=editor
218-
scons platform=android arch=x86 production=yes target=editor
216+
scons platform=android arch=arm32 production=yes target=editor
217+
scons platform=android arch=arm64 production=yes target=editor
218+
scons platform=android arch=x86_32 production=yes target=editor
219219
scons platform=android arch=x86_64 production=yes target=editor
220220
cd platform/android/java
221221
# On Windows
@@ -224,7 +224,7 @@ root directory with the following arguments:
224224
./gradlew generateGodotEditor
225225

226226

227-
The resulting APK will be located at ``bin/android_editor.apk``.
227+
The resulting APK will be located at ``bin/android_editor_builds/android_editor-release.apk``.
228228

229229
Removing the Editor templates
230230
-----------------------------
@@ -235,9 +235,9 @@ You can use the following commands to remove the generated editor templates:
235235

236236
cd platform/android/java
237237
# On Windows
238-
.\gradlew cleanGodotEditor
238+
.\gradlew clean
239239
# On Linux and macOS
240-
./gradlew cleanGodotEditor
240+
./gradlew clean
241241

242242
Installing the Godot editor
243243
---------------------------
@@ -247,7 +247,7 @@ Open up a Terminal/Command Prompt and run the following commands from the root d
247247

248248
::
249249

250-
adb install ./bin/android_editor.apk
250+
adb install ./bin/android_editor_builds/android_editor-release.apk
251251

252252
Troubleshooting
253253
---------------

tutorials/export/android_custom_build.rst renamed to tutorials/export/android_gradle_build.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _doc_android_custom_build:
1+
.. _doc_android_gradle_build:
22

3-
Custom builds for Android
3+
Gradle builds for Android
44
=========================
55

6-
Godot provides the option to use custom build Android templates. Instead of
7-
using the already pre-built template that ships with Godot, an actual Android
6+
Godot provides the option to build using the gradle buildsystem. Instead of
7+
using the already pre-built template that ships with Godot, an Android
88
Java project gets installed into your project folder. Godot will then build it
99
and use it as an export template every time you export the project.
1010

@@ -13,45 +13,44 @@ There are some reasons why you may want to do this:
1313
* Modify the project before it's built.
1414
* Add external SDKs that build with your project.
1515

16-
Configuring the custom build is a fairly straightforward process. But first
16+
Configuring the gradle build is a fairly straightforward process. But first
1717
you need to follow the steps in :ref:`exporting for android<doc_exporting_for_android>`
1818
up to **Setting it up in Godot**. After doing that, follow the steps below.
1919

20-
Set up the custom build environment
20+
Set up the gradle build environment
2121
-----------------------------------
2222

23-
Go to the Project menu, and install the *Custom Build* template:
23+
Go to the Project menu, and install the *Gradle Build* template:
2424

25-
.. image:: img/custom_build_install_template.png
25+
.. image:: img/gradle_build_install_template.webp
2626

2727
Make sure export templates are downloaded. If not, this menu will help you
2828
download them.
2929

3030
A Gradle-based Android project will be created under ``res://android/build``.
31-
Editing these files is not needed unless you want to :ref:`create
32-
your own add-ons<doc_android_plugin>`, or you really need to modify the project.
31+
Editing these files is not needed unless you really need to modify the project.
3332

3433

35-
Enabling the custom build and exporting
34+
Enabling the gradle build and exporting
3635
---------------------------------------
3736

3837
When setting up the Android project in the **Project > Export** dialog,
39-
**Custom Build** needs to be enabled:
38+
**Gradle Build** needs to be enabled:
4039

41-
.. image:: img/custom_build_enable.png
40+
.. image:: img/gradle_build_enable.webp
4241

4342
From now on, attempting to export the project or one-click deploy will call the
4443
`Gradle <https://gradle.org/>`__ build system to generate fresh templates (this
4544
window will appear every time):
4645

47-
.. image:: img/custom_build_gradle.png
46+
.. image:: img/gradle_build_gradle.webp
4847

4948
The templates built will be used automatically afterwards, so no further
5049
configuration is needed.
5150

5251
.. note::
5352

54-
When using the custom Android build system, assets that are placed within a
53+
When using the gradle Android build system, assets that are placed within a
5554
folder whose name begins with an underscore will not be included in the
5655
generated APK. This does not apply to assets whose *file* name begins with
5756
an underscore.
-32.7 KB
Binary file not shown.
-46.2 KB
Binary file not shown.
-6.14 KB
Binary file not shown.
19.6 KB
Loading
9.34 KB
Loading

0 commit comments

Comments
 (0)