godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4522 from m4gr3d/update_android_build_instructions_3_2

Browse Source 
[3.3] Update instructions for compiling for Android
This commit is contained in:
Rémi Verschelde
2021-03-31 10:23:46 +02:00
committed by GitHub
parent 0c9360a234 4c781b9849
commit 0b715e3321
1 changed files with 23 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
development/compiling/compiling_for_android.rst
View File

@@ -26,11 +26,10 @@ For compiling under Windows, Linux or macOS, the following is required:
- `Android SDK <https://developer.android.com/studio/#command-tools>`_
(command-line tools are sufficient).
- Required SDK components will be automatically installed by Gradle (except the NDK).
- Required SDK components will be automatically installed.
- On Linux,
**do not use an Android SDK provided by your distribution's repositories as it will often be outdated**.
- `Android NDK <https://developer.android.com/ndk/downloads/>`_ r17 or later.
- Gradle (will be downloaded and installed automatically if missing).
- JDK 8 (either OpenJDK or Oracle JDK).
@@ -45,36 +44,32 @@ For compiling under Windows, Linux or macOS, the following is required:
Setting up the buildsystem
--------------------------
Set the environment variable ``ANDROID_HOME`` to point to the Android
SDK. If you downloaded the Android command-line tools, this would be
the folder where you extracted the contents of the ZIP archive.
Later on, ``gradlew`` will install necessary SDK components in this folder.
However, you need to accept the SDK component licenses before they can be
downloaded by Gradle. This can be done by running the following command
from the root of the SDK directory, then answering all the prompts
with ``y``:
- Set the environment variable ``ANDROID_SDK_ROOT`` to point to the Android
SDK. If you downloaded the Android command-line tools, this would be
the folder where you extracted the contents of the ZIP archive.
::
- Install the necessary SDK components in this folder:
tools/bin/sdkmanager --licenses
- Accept the SDK component licenses by running the following command
where ``android_sdk_path`` is the path to the Android SDK, then answering all the prompts with ``y``:
::
Set the environment variable ``ANDROID_NDK_ROOT`` to point to the
Android NDK. You also might need to set the variable ``ANDROID_NDK_HOME``
to the same path, especially if you are using custom Android modules,
since some Gradle plugins rely on the NDK and use this variable to
determine its location.
tools/bin/sdkmanager --sdk_root=<android_sdk_path> --licenses
To set those environment variables on Windows, press :kbd:`Windows + R`, type
"control system", then click on **Advanced system settings** in the left
pane, then click on **Environment variables** on the window that
appears.
- Complete setup by running the following command where ``android_sdk_path`` is the path to the Android SDK.
To set those environment variables on Linux or macOS, use
``export ANDROID_HOME=/path/to/android-sdk`` and
``export ANDROID_NDK_ROOT=/path/to/android-ndk``
where ``/path/to/android-sdk`` and ``/path/to/android-ndk`` point to
the root of the SDK and NDK directories.
::
tools/bin/sdkmanager --sdk_root=<android_sdk_path> "platform-tools" "build-tools;30.0.1" "platforms;android-29" "cmdline-tools;latest" "cmake;3.10.2.4988404"
.. seealso:: To set the environment variable on Windows, press :kbd:`Windows + R`, type
"control system", then click on **Advanced system settings** in the left
pane, then click on **Environment variables** on the window that appears.
.. seealso:: To set the environment variable on Linux or macOS, use
``export ANDROID_SDK_ROOT=/path/to/android-sdk`` where ``/path/to/android-sdk`` points to
the root of the SDK directories.
Building the export templates
-----------------------------
@@ -204,8 +199,8 @@ Troubleshooting
Platform doesn't appear in SCons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Double-check that you've set both the ``ANDROID_HOME`` and ``ANDROID_NDK_ROOT``
environment variables. This is required for the platform to appear in SCons'
Double-check that you've set the ``ANDROID_SDK_ROOT``
environment variable. This is required for the platform to appear in SCons'
list of detected platforms.
See :ref:`Setting up the buildsystem <doc_android_setting_up_the_buildsystem>`
for more information.