Skip to content

README.md

Latest commit

 

History

History
193 lines (182 loc) · 10.8 KB

README.md

File metadata and controls

193 lines (182 loc) · 10.8 KB

Requirements for building for Android on Linux

  • At least 10-15 GiB of free disk space.
  • First follow the general instructions for setting up https://github.com/ddnet/ddnet for building on Linux.
  • Install the Android NDK, Android SDK build tools and the Android command-line tools in the same location where Android Studio would unpack them. You can run the following script to automatically download the correct versions: 
    scripts/android/download_android_sdk.sh
    This will download the relevant components of the Android SDK to ~/Android/Sdk. This will also accept the Android SDK licenses using the SDK manager, otherwise the Gradle build will fail. Note: If you have previously downloaded different versions of the Android SDK components, delete them before downloading the new versions to ensure that the correct versions are used.
  • Use a stable version of Rust. Using the nightly version results in linking errors. For reproducible builds, use exactly the same version of Rust that is used in the CI: 
    rustup default 1.92.0
  • Install cargo-ndk and add the Android targets to rustup to build Rust with the Android NDK after setting the Rust version: 
    cargo install cargo-ndk
rustup target add armv7-linux-androideabi
rustup target add i686-linux-android
rustup target add aarch64-linux-android
rustup target add x86_64-linux-android
  • Install OpenJDK 21: 
    sudo apt install openjdk-21-jdk
  • Install ninja: 
    sudo apt install ninja-build
  • (macOS only) Install coreutils so nproc is available: 
    brew install coreutils
  • Build the ddnet-libs for Android. See below for instructions on how to compile them locally. Alternatively, use the precompiled libraries from https://github.com/ddnet/ddnet-libs/. The libraries can also be built by manually running the GitHub workflow build-libraries-android.
  • Important note for reproducible builds: To make the build reproducible, you must use exactly the same versions of the Android SDK components and Rust. Furthermore, exactly CMake version 3.22.1 must be used for configuring.

Requirements for building for Android on Windows using MSYS2

  • At least 50 GiB of free disk space if you start from scratch.
  • First install MSYS2 (https://www.msys2.org/wiki/MSYS2-installation/) as well as all required packages for building DDNet using MSYS2 on Windows. (There is currently no more detailed guide for this.)
  • Note: All commands in this README must be executed in a bash terminal (e.g., from MSYS2) and not in cmd.exe or PowerShell.
  • Install cargo-ndk and add Android targets to rustup to build Rust with the Android NDK: 
    cargo install cargo-ndk
rustup target add armv7-linux-androideabi
rustup target add i686-linux-android
rustup target add aarch64-linux-android
rustup target add x86_64-linux-android
  • Install JDK 21, e.g. from https://adoptium.net/temurin/releases/?package=jdk&os=windows&version=21
  • Install ninja: 
    pacman -S mingw-w64-x86_64-ninja
  • Install coreutils so nproc is available: 
    pacman -S coreutils
  • Build the ddnet-libs for Android. See below for instructions on how to compile them locally. Alternatively, use the precompiled libraries from https://github.com/ddnet/ddnet-libs/. The libraries can also be build by manually running the GitHub workflow build-libraries-android.
  • Set the ANDROID_HOME environment variable to override the location where the Android SDK will be installed, e.g. C:/Android/SDK. Make sure to only use forward slashes and no spaces in the path.
  • Install either Android Studio (which includes an SDK manager GUI) from https://developer.android.com/studio or the standalone command-line tools (which include the sdkmanager tool) from https://developer.android.com/studio/#command-line-tools-only.
  • When using the command-line tools: Ensure the command-line tools are installed at the expected location, so %ANDROID_HOME%/cmdline-tools/latest/bin should contain sdkmanager.bat. Accept the licenses using the SDK manager, otherwise the Gradle build will fail: 
    yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager.bat --licenses
  • Install the following using the SDK Manager in Android Studio (Tools menu) or the sdkmanager command-line tool:
    • SDK Platform for API Level 36
    • NDK (Side by side) version 29
    • Android SDK Build-Tools (latest version)
  • Alternatively, you can use the provided script to download the relevant tools automatically: 
    scripts/android/download_android_sdk.sh "<path to android home>"

How to locally build the ddnet-libs for Android

  • Note for building on Windows: All commands in this README must be executed in a bash terminal (e.g., from MSYS2) and not in cmd.exe or PowerShell.
  • On Linux, install the following dependencies: 
    sudo apt install autoconf automake libtool m4
  • On Windows using MSYS2, install the following dependencies: 
    pacman -S autoconf-wrapper automake-wrapper libtool unzip
  • There is a script to automatically download and build all libraries. This requires an active internet connection and can take around 10-20 minutes: 
    scripts/compile_libs/gen_libs.sh build-android-libs android
    Warning: Do not choose a directory inside the src folder!
  • If you see error messages in the first few minutes, examine the output and ensure that you installed the NDK and other prerequisites correctly.
  • After the script finished executing, it should have created a ddnet-libs directory in your selected output folder, which contains all libraries in the correct directory format and can be merged with the ddnet-libs folder in the source directory: 
    find ddnet-libs -type d -name android -exec rm -r {} + -prune
rm -rf ddnet-libs/sdl/java
cp -r build-android-libs/ddnet-libs/. ddnet-libs/
  • To force the libraries to be rebuild, delete the individual build folders inside the library folders: 
    rm -rf build-android-libs/compile_libs/*/build_android_*
  • To force the libraries to be downloaded again when changing the library versions, delete the entire library build folder: 
    rm -rf build-android-libs

How to build the DDNet client for Android

  • Open a terminal inside the ddnet project root directory and run the following: 
    scripts/android/cmake_android.sh <x86/x86_64/arm/arm64/all> <Game name> <Package name> <Debug/Release> <Build folder>
    • The first parameter denotes the architecture. Use all to compile for all architectures.
    • The second parameter denotes the APK name, which must be equal to the library name. If you want to rename the APK, do it after the build.
    • The third parameter denotes the package name of the APK.
    • The fourth parameter denotes the build type.
    • The fifth parameter denotes the build folder.
  • Example to build only for x86_64 architecture in debug mode: 
    scripts/android/cmake_android.sh x86_64 DDNet org.ddnet.client Debug build-android-debug
  • To build a signed APK, generate a signing key and export environment variables before running the build script: 
    keytool -genkey -v -keystore my-release-key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias my-alias
export TW_KEY_NAME=<key name>
export TW_KEY_PW=<key password>
export TW_KEY_ALIAS=<key alias>
  • By default, the version code and name of the APK will be determined automatically based on the definitions in src/game/version.h. You can also specify the build version code and name manually before running the build script, e.g.: 
    export TW_VERSION_CODE=20210819
export TW_VERSION_NAME="1.0"
    The version code must increase for newer version in order for users to automatically update to them. The version name is the string that will be displayed to the user, e.g. 1.2.3-snapshot4.
  • Example to build a signed APK in release mode for all architectures: 
    keytool -genkey -v -keystore Teeworlds.jks -keyalg RSA -keysize 2048 -validity 10000 -alias Teeworlds-Key
# It will prompt for the password, input for example "mypassword"
export TW_KEY_NAME=Teeworlds.jks
export TW_KEY_PW=mypassword
export TW_KEY_ALIAS=Teeworlds-Key
# Version code and name will be determined automatically
scripts/android/cmake_android.sh all DDNet org.ddnet.client Release build-android-release
  • Note that you should only generate a signing key once (and make backups). Users can only update apps automatically if the same package name and signing key have been used, else they must manually uninstall the old app.

Common problems and solutions

  • If the Gradle build fails with errors messages indicating bugs relating to files in the Gradle cache, try to clear the Gradle cache by deleting the contents of the folder ~/.gradle/caches (%USERPROFILE%/.gradle/caches on Windows). If that did not fix it, also delete the .gradle folder in the build folder and reboot your system to restart the Gradle daemon.
  • The Gradle build may show a message that the JDK version could not be determined but this can safely be ignored.
  • The Gradle build will fail with errors messages indicating an unsupported class file version if a different version of the JDK is used than specified in build.gradle. When incrementing the supported JDK version, the Gradle version also has to be incremented according to https://docs.gradle.org/current/userguide/compatibility.html. If you have multiple JDKs installed, you can set the JDK version for Gradle using the property org.gradle.java.home in the gradle.properties file in your Gradle home directory.

Maintainers' notes

  • To update the download links for the Android SDK, refer to https://dl.google.com/android/repository/repository2-3.xml which lists all available files.
  • To update Gradle and the Android Gradle Plugin refer to https://developer.android.com/build/releases/gradle-plugin#updating-gradle which list the compatible versions. To update the Gradle Wrapper, a working build folder is required, so first build the Android client normally. Update the Gradle version and SHA256 in the file gradle/wrapper/gradle-wrapper.properties in the build folder. Next run ./gradlew wrapper twice in the build folder. Lastly, copy the files gradlew, gradlew.bat and the folder gradle from the build folder to the folder scripts/android/files in the project root and override the existing files. Commit changed files to version control. Running the wrapper directly in the scripts/android/files folder does not work.