From ddbc8e827d705539e901ef19de215c86fdcd1b35 Mon Sep 17 00:00:00 2001 From: Fredia Huya-Kouadio Date: Mon, 21 Apr 2025 08:16:52 -0700 Subject: [PATCH] Update the Android build documentation - Replace `generate_apk` with `generate_android_binaries` in the Android documentation - Update the ndk version to 27.2.12479018 --- .../compiling/compiling_for_android.rst | 22 +++++++++++-------- tutorials/export/exporting_for_android.rst | 4 ++-- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/contributing/development/compiling/compiling_for_android.rst b/contributing/development/compiling/compiling_for_android.rst index f97965d5cc4..02fd81a19db 100644 --- a/contributing/development/compiling/compiling_for_android.rst +++ b/contributing/development/compiling/compiling_for_android.rst @@ -104,21 +104,21 @@ root directory with the following arguments: :: scons platform=android target=template_release arch=arm32 - scons platform=android target=template_release arch=arm64 generate_apk=yes + scons platform=android target=template_release arch=arm64 generate_android_binaries=yes - Debug template (used when exporting with **Debugging Enabled** checked) :: scons platform=android target=template_debug arch=arm32 - scons platform=android target=template_debug arch=arm64 generate_apk=yes + scons platform=android target=template_debug arch=arm64 generate_android_binaries=yes - (**Optional**) Dev template (used when troubleshooting) :: scons platform=android target=template_debug arch=arm32 dev_build=yes - scons platform=android target=template_debug arch=arm64 dev_build=yes generate_apk=yes + scons platform=android target=template_debug arch=arm64 dev_build=yes generate_android_binaries=yes The resulting templates will be located under the ``bin`` directory: @@ -129,9 +129,11 @@ The resulting templates will be located under the ``bin`` directory: .. note:: - - If you are changing the list of architectures you're building, remember to add ``generate_apk=yes`` to the *last* architecture you're building, so that the template files are generated after the build. + - If you are changing the list of architectures you're building, remember to add ``generate_android_binaries=yes`` to the *last* architecture you're building, so that the template files are generated after the build. - - To include debug symbols in the generated templates, add the ``debug_symbols=yes`` parameter to the SCons command. + - To include debug symbols in the generated templates, add the ``debug_symbols=yes`` parameters to the SCons command. + + - Note that you can include ``separate_debug_symbols=yes`` to generate the debug symbols in a separate ``*-native-debug-symbols.zip`` file. .. seealso:: @@ -151,7 +153,7 @@ example, for the release template: scons platform=android target=template_release arch=arm32 scons platform=android target=template_release arch=arm64 scons platform=android target=template_release arch=x86_32 - scons platform=android target=template_release arch=x86_64 generate_apk=yes + scons platform=android target=template_release arch=x86_64 generate_android_binaries=yes This will create template binaries that works on all platforms. The final binary size of exported projects will depend on the platforms you choose @@ -222,15 +224,17 @@ root directory with the following arguments: scons platform=android arch=arm32 production=yes target=editor scons platform=android arch=arm64 production=yes target=editor scons platform=android arch=x86_32 production=yes target=editor - scons platform=android arch=x86_64 production=yes target=editor generate_apk=yes + scons platform=android arch=x86_64 production=yes target=editor generate_android_binaries=yes - You can add the ``dev_build=yes`` parameter to generate a dev build of the Godot editor. -- You can add the ``debug_symbols=yes`` parameter to include the debug symbols in the generated build. +- You can add the ``debug_symbols=yes`` parameters to include the debug symbols in the generated build. + + - Note that you can include ``separate_debug_symbols=yes`` to generate the debug symbols in a separate ``*-native-debug-symbols.zip`` file. - You can skip certain architectures depending on your target device to speed up compilation. -Remember to add ``generate_apk=yes`` to the *last* architecture you're building, so that binaries are generated after the build. +Remember to add ``generate_android_binaries=yes`` to the *last* architecture you're building, so that binaries are generated after the build. The resulting binaries will be located under ``bin/android_editor_builds/``. diff --git a/tutorials/export/exporting_for_android.rst b/tutorials/export/exporting_for_android.rst index e3db694e99a..1ad8345ca7f 100644 --- a/tutorials/export/exporting_for_android.rst +++ b/tutorials/export/exporting_for_android.rst @@ -41,7 +41,7 @@ Download and install the Android SDK. - Ensure that the `NDK and CMake are installed and configured `__. - CMake version 3.10.2.4988404 - - NDK version r23c (23.2.8568313) + - NDK version r27c (27.2.12479018) - Alternatively, you can install the Android SDK with the `sdkmanager` command line tool. @@ -50,7 +50,7 @@ Download and install the Android SDK. :: - sdkmanager --sdk_root= "platform-tools" "build-tools;34.0.0" "platforms;android-34" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;23.2.8568313" + sdkmanager --sdk_root= "platform-tools" "build-tools;34.0.0" "platforms;android-34" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;27.2.12479018" .. note::