Compiling for Android

See also

This page describes how to compile Android export template binaries from source. If you're looking to export your project to Android instead, read Exporting for Android.


In most cases, using the built-in deployer and export templates is good enough. Compiling the Android APK manually is mostly useful for custom builds or custom packages for the deployer.

Also, you still need to follow the steps mentioned in the Exporting for Android tutorial before attempting to build a custom export template.


For compiling under Windows, Linux or macOS, the following is required:

  • Python 3.6+.

  • SCons 3.0+ build system.

  • Android SDK (command-line tools are sufficient).

    • 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.

  • Gradle (will be downloaded and installed automatically if missing).

  • JDK 11 (either OpenJDK or Oracle JDK).

See also

To get the Godot source code for compiling, see Getting the source.

For a general overview of SCons usage for Godot, see Introduction to the buildsystem.

Setting up the buildsystem

  • 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:

    • 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:

    tools/bin/sdkmanager --sdk_root=<android_sdk_path> --licenses
    • Complete setup by running the following command where android_sdk_path is the path to the Android SDK.

    tools/bin/sdkmanager --sdk_root=<android_sdk_path> "platform-tools" "build-tools;30.0.3" "platforms;android-29" "cmdline-tools;latest" "cmake;"

See also

To set the environment variable on Windows, press 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.

See also

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

Godot needs two export templates for Android: the optimized "release" template (android_release.apk) and the debug template (android_debug.apk). As Google will require all APKs to include ARMv8 (64-bit) libraries starting from August 2019, the commands below will build an APK containing both ARMv7 and ARMv8 libraries.

Compiling the standard export templates is done by calling SCons from the Godot root directory with the following arguments:

  • Release template (used when exporting with Debugging Enabled unchecked)

scons platform=android target=template_release arch=armv7
scons platform=android target=template_release arch=arm64v8
cd platform/android/java
# On Windows
.\gradlew generateGodotTemplates
# On Linux and macOS