Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

Exporting for Android

See also

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

Exporting for Android has fewer requirements than compiling Godot for Android. The following steps detail what is needed to set up the Android SDK and the engine.

Attention

Projects written in C# using Godot 4 currently cannot be exported to Android. To use C# on Android, use Godot 3 instead.

Install OpenJDK 11

Download and install OpenJDK 11.

Download the Android SDK

Download and install the Android SDK.

  • You can install the Android SDK using Android Studio version 4.1 or later.

    • Run it once to complete the SDK setup using these instructions.

    • Ensure that the required packages are installed as well.

      • Android SDK Platform-Tools version 30.0.5 or later

      • Android SDK Build-Tools version 33.0.2

      • Android SDK Platform 33

      • Android SDK Command-line Tools (latest)

      • CMake version 3.10.2.4988404

      • NDK version r23c (23.2.8568313)

  • Alternatively, you can install the Android SDK using the command line tools.

    • Once the command line tools are installed, run the sdkmanager command to complete the setup process:

sdkmanager --sdk_root=<android_sdk_path> "platform-tools" "build-tools;33.0.2" "platforms;android-33" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;23.2.8568313"

Note

If you are using Linux, do not use an Android SDK provided by your distribution's repositories as it will often be outdated.

Create a debug.keystore

Android needs a debug keystore file to install to devices and distribute non-release APKs. If you have used the SDK before and have built projects, ant or eclipse probably generated one for you (in the ~/.android directory on Linux and macOS, in the C:\Users\<user>\.android\ directory on Windows).

If you can't find it or need to generate one, the keytool command from the JDK can be used for this purpose:

keytool -keyalg RSA -genkeypair -alias androiddebugkey -keypass android -keystore debug.keystore -storepass android -dname "CN=Android Debug,O=Android,C=US" -validity 9999 -deststoretype pkcs12

This will create a debug.keystore file in your current directory. You should move it to a memorable location such as %USERPROFILE%\.android\, because you will need its location in a later step. For more information on keytool usage, see this Q&A article.

Note

It is important that the password is the same for the keystore and the key. This is a known Android studio issue that also affects Godot projects.