Return to the Roots Android

Android port of the fan-project Return to the Roots which aims to renew the original The Settlers 2.

This project is work in progress, please report bugs here.

Features:

• Touch controls (also shortcut: double tap on window to close)
• Mouse works fine like on pc
• App config menu to create/choose folder, set default username, orientation and view/delete log files
• Detect app update & update game files

Planned bugfixes:

• Working multiplayer
• Virtual keyboard

Downloads

Download from github releases or build it yourself as described below.

Screenshots

Compiling

You will need git
Clone this repository and its submodules:

git clone --recursive https://github.com/Farmer-Markus/s25rttr-android

When using android studio just open the project folder and click on build and everything should work fine.
If you want to use the commandline see steps below.

Dependencies

Linux

You need to install gradle and java(for example openjdk) Also you will need the android sdk, ndk, buildtools and android cmake. These can be installed using the sdkmanager cmdline tool.

Archlinux

To install the required packages run:

sudo pacman -S gradle jdk17-openjdk make gettext

To install the android sdkmanager you can use the AUR package or download the tools yourself on Googles website.

Debian

To install the required packages run:

sudo apt-get install gradle openjdk-17-jdk sdkmanager make gettext

Windows

coming soon...

Installing android SDK/build-tools

To show every available package run:

sdkmanager --list

You will need at least the following packages

android sdk 34
android cmake 3.22.1
Platform-Tools v.35.0.2
android build-tools 35.0.0
android ndk 27.0.12077973

You can install them via the sdkmanager --install command:

sdkmanager --install "platforms;android-34" "cmake;4.1.2" "platform-tools;36.0.2" "ndk;27.0.12077973" "build-tools;35.0.0"

This will install the SDK to a specific location. (Remember the location)
You need to accept the licenses using the sdkmanager

sdkmanager --licenses

You may want to move the SDK to another folder like ~/Android/Sdk (Default in android studio)

Now you need to give the gradle script the path to the android sdk.
You can create a local.properties file containing the following.

sdk.dir=<path to the sdk>

Or set the enviroment variable ANDROID_HOME to the sdk installation.

Building

Now you should able to run the build command.

./gradlew.sh assembleDebug	# Debug build on linux
./gradlew.bat assembleDebug	# Debug build on windows

To build the release version you need to look a bit deeper into the android apk signing system.

./gradlew.sh assembleRelease	# Release build on Linux
./gradlew.bat assembleRelease	# Release build on Windows