#summary Instructions for building Hedgewars for Android
#labels Phase-Implementation,Phase-Design,Phase-Support
= Building on Android =
== Introduction ==

This guide will take you through the steps needed to succesfully compile Hedgewars for Android.

==Download==

We need to download these packages:

 * [https://hg.hedgewars.org/hedgewars/ Hedgewars Source]<br>
 * [http://developer.android.com/sdk/index.html Android SDK] (Latest version will do)<br>
 * [http://developer.android.com/sdk/ndk/index.html Android NDK] (current version is r5b but anything up will probably work)<br>
 * ~~[http://freepascal.org/down/source/sources.var FreePascal] (Latest (stable) version will do)~~<br>
 * [http://sourceforge.net/projects/p-tools/ p-tools] (Fixed freepascal compiler, read below which to download)<br>
 * [http://ant.apache.org/ Ant] (Linux distro should just use their package manager to get it, version isn't really important)<br>
 * Java compiler, make sure you get JDK (not JRE) version 6 and up
 * [http://www.cmake.org/ Cmake]
 * You will also need qt4 although this is not strictly required for the android build it is needed for the desktop frontend

==Hedgewars Source==

Using Mercurial you can pull the `hedgeroid` branch using
{{{
hg clone https://hg.hedgewars.org/hedgewars/ hedgewars
}}}

==Android SDK==

Download the latest version using the link above. And unzip it at a place you can remember, I’ll refer to the location with `<SDK>`. Once you’ve unzipped/extracted the tar navigate to `<SDK>/tools` and execute ‘android’. This should bring up a GUI select ‘Available packages’, then ‘Android Repository’ and check atleast SDK Platform Android 1.6 / 2.2 / 4.0. I would recommend checking all of them, but it’s up to you. Next select ‘Install Selected’ press ‘Next’ a couple of times and you should have the SDK installed.

Optionally you could permanently add `<SDK>/platform-tools` to your `$PATH`, this makes it easier to use ‘adb’. Adb is the main program to communicate with Android, think logging/pushing and pulling files/shell.

If you do not have a real android device you can create an emulator if you do I’d skip this and continue at Android NDK.

You can use either the GUI, run Android and follow the signs or from command-line:

{{{
android create avd -n <name> -t 4
}}}

`<name>` is a name of your choice. The number after `-t` stands for the target ID.

See this for more information:

To run the emulator navigate to `<SDK>/tools` and run

{{{emulator -avd <name>}}}

where `<name>` is the same name as when you created it with the line above.

Note when using ant:

Ant needs a JDK, but tries to use a JRE sometimes (there is usually a separate JRE installation outside the JDK). If you get an error about missing `tools.jar`, make sure Ant is actually attempting to use the JDK. You can coax it to cooperate by setting the `JAVA_HOME` environment variable to point to the JDK directory.

==Android NDK==

Download and untar it, I'll refer to the ndk as `<NDK>`. That’s it. :)

==!FreePascal ==

We need to download the sources from the !FreePascal website and compile the crosscompiler. I have grabbed the latest stable release 2.4.4, though any version will work. Because of a bug in the latest fpc sources I recommend you download the p-tools repository/tar. Follow this link http://sourceforge.net/projects/p-tools/ and find the directory fpc4android in their source repository. Download a tarball and extract it to a new directory, which will be called `<fpc>` from now on. Once downloaded, extract the tar/zip and place the files in a known directory. I will refer to the directory with `<fpc>` from now on. Next navigate to the `<fpc>` directory and compile it, for this various tools are needed, ‘make’ for instance. But also a fpc compiler for your system. Some apt-get/aptitude magic will solve these problems, make a comment if you run in to problems. Use this to compile the crosscompiler:

{{{
make crossinstall CPU_TARGET=arm OS_TARGET=linux CROSSBINDIR=<ndk>/toolchains/arm-linux-androideabi-4.4.3/prebuilt/linux-x86/bin OPT=-dFPC_ARMEL BINUTILSPREFIX=arm-linux-androideabi- INSTALL_PREFIX=<fpc>/fpc_install
}}}

Note: The flag `CROSSBINDDIR` points to the `ndk/toolchain/../prebuilt/linux-x86/bin` dir, change `linux-x86` to your host machine, so for Windows it would be `windows` instead of `linux-x86`.

Note 2: On Windows, use forward slashes, so '/', not '\'.

==Final==

We will generate the `Makefile.android`, which is needed to compile hedgewars, download SDL and you’ll need to make sure CMake knows where all the compilers are.

1.<br>
Add `<NDK>:<SDK>/platform-tools:<FPC>/compiler` to your path, on Debian-based system I would do it as follows:

{{{
export PATH=$PATH:/home/xeli/SoftDev/android/ndk
export PATH=$PATH:/home/xeli/SoftDev/android/sdk/platform-tools
export PATH=$PATH:/home/xeli/SoftDev/android/fpc-2.4.4/compiler
}}}

(Check Google on how to do it for your specific OS if you don't know how.)

For Windows, the `PATH` var should include this, mind the order:
{{{
    - %WINDIR%\System32 (for Java)<br>
    - <CMake>\bin<br>
    - <QtSDK>\mingw\bin<br>
    - <QtSDK>\Desktop\Qt\4.8.0\mingw\bin<br>
    - <fpc-win>\bin\i386-win32<br>
    - <fpc-android>\compiler<br>
    - <ndk><br>
    - <sdk>\platform-tools<br>
    - <ant>\bin<br>
    - <mercurial> (directory containing hg.exe, TortoiseHg dir in my case)<br>
}}}


2.<br>
Now we're gonna download sdl and a couple of its libraries, if you're on GNU/Linux, there's a script you can use:

{{{
cd <hedgewars-root>/project_files/Android-build
chmod +x download_libs.sh (might not be needed)
./download_libs.sh
}}}
This will download and unzip sdl to the expected folders

On Windows, the script should work fine with Git Bash.


3.<br>
Finally you can use CMake to create the scripts:

{{{
cd <hedgewars-root>
cmake . -DANDROID=1
}}}

On Windows, you will need some extra arguments:
{{{
cmake -G "MinGW Makefiles" -DCMAKE_INCLUDE_PATH="%CD%/misc/winutils/include" -DCMAKE_LIBRARY_PATH="%CD%/misc/winutils/lib" -DANDROID=1 .
}}}

And that’s it. To compile:

{{{
cd <hedgewars-root>/project_files/Android-build/
make -f Makefile.android
}}}
and it should be installed on your emulator/device if it was connected.

On the device/emulator you can start the application up. :)


== TODO ==

 * Verify that it works on macOS, is the depencency list complete now?