Context Navigation

Changes between Version 236 and Version 237 of AndroidPort

Timestamp:: 2012-04-23 16:30:53 (13 months ago)
Author:: Philip
Comment:: rough but basically-working Android build instructions

Legend:

: Unmodified
: Added
: Removed
: Modified

AndroidPort

-                      v236
+                      v237
 A window with installable packages should open. In addition to any packages checked by default, make sure 'Android SDK Platform-tools' is checked and click 'Install packages'.
+Google publishes a [http://developer.android.com/sdk/ndk/index.html Native Development Kit] (NDK), which is a set of tools for building native applications for the Android platform. Unfortunately, the official NDK does not and will not support the `std::wstring` (wide characters) datatype, which is required by the game, so we'll have to use the unofficial [http://www.crystax.net/android/ndk.php Crystax NDK]. This is merely an extension of the official NDK, adding support for wide characters and other features maligned by Google.
+Download the latest release from [http://www.crystax.net/en/android/ndk this page] to the working directory and then unpack there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf android-ndk-r7-crystax-4-linux-x86.tar.bz2
+}}}
+Now use the NDK to set up a standalone toolchain:
+{{{
+$ ~/android/android-ndk-r7-crystax-4/build/tools/make-standalone-toolchain.sh --platform=android-9 --install-dir=$HOME/android/toolchain
+}}}
+Google publishes a [http://developer.android.com/sdk/ndk/index.html Native Development Kit] (NDK), which is a set of tools for building native applications for the Android platform. Unfortunately, the official NDK does not and will not support the `std::wstring` (wide characters) datatype, which is required by the game, so we'll have to use the unofficial [http://www.crystax.net/android/ndk.php Crystax NDK]. This is merely an extension of the official NDK, adding support for wide characters and other features maligned by Google. This is installed automatically by the `setup-libs.sh` script (see next section).
 You also must install a Java Development Kit (JDK) if you haven't already, e.g. [https://apps.ubuntu.com/cat/applications/oneiric/default-jdk/ the standard JDK from Ubuntu Software Center]:
 {{{
 $ sudo apt-get install default-jdk
 }}}
 Make sure [http://ant.apache.org/ Ant], [http://subversion.tigris.org/ Subversion] and [http://www.gnu.org/software/autoconf/ autoconf] 2.13 is installed:
 {{{
 $ sudo apt-get install ant subversion autoconf2.13
 }}}
 On 64-bit Ubuntu you may need to install some 32-bit libraries:
 {{{
 $ sudo apt-get install ia32-libs
 }}}
 Finally, download the game sources from SVN to any location, e.g.:
 {{{
 $ svn co http://svn.wildfiregames.com/public/ps/trunk/ ~/android/0ad-game
 }}}
+=== Installing dependencies ===
+The game has a range of external dependencies. Each of these has to be compiled for the target device's processor architecture and installed in the compiler toolchain's sysroot, so we can link against them when building the game itself.
+First set a few shell variables to the paths of tools that were installed in the previous section, e.g.:
+{{{
+$ SDK=$HOME/android/android-sdk-linux/
+$ NDK=$HOME/android/android-ndk-r7-crystax-4
+$ TOOLCHAIN=$HOME/android/toolchain
+$ SYSROOT=$TOOLCHAIN/sysroot
+$ GAME=$HOME/android/0ad-game
+}}}
+Download the !MysticTreeGames [https://github.com/MysticTreeGames/Boost-for-Android/tarball/master port of the Boost C++ Libraries] to the working directory and unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf MysticTreeGames-Boost-for-Android-70838fc.tar.gz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd MysticTreeGames-Boost-for-Android-70838fc
+}}}
+Apply [http://www.wildfiregames.com/forum/index.php?showtopic=15436&view=findpost&p=234163 this patch] somehow.
+Then execute the following command to download the Boost C++ Libraries package and compile it for the target device:
+{{{
+$ ./build-android.sh $TOOLCHAIN
+}}}
+Copy the resulting headers and library files into the `usr` directory in the toolchain's sysroot:
+{{{
+$ cp -r build/* $SYSROOT/usr/
+}}}
+Fix some weird path issue:
+{{{
+$ mv $SYSROOT/usr/include/boost-1_45/boost $SYSROOT/usr/include
+}}}
+Spidermonkey is designed to build against an older version of the NDK than that of our main compiler toolchain. Download [http://ftp.mozilla.org/pub/mozilla.org/mobile/source/android-ndk-r4c-0moz3.tar.bz2 Mozilla's own toolchain] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf android-ndk-r4c-0moz3.tar.bz2
+}}}
+Set the `NDK_MOZ` shell variable to the path of the directory that was unpacked, e.g.:
+{{{
+$ NDK_MOZ=~/android/android-ndk-r4c
+}}}
+Copy the Spidermonkey source directory from the game sources to the working directory, e.g.:
+{{{
+$ cp -r $GAME/libraries/spidermonkey/js-1.8.5 ~/android/
+}}}
+Apply [https://gist.github.com/1754817 this patch] somehow.
+Regenerate the `configure` script in the new Spidermonkey source directory, e.g.:
+{{{
+$ cd ~/android/js-1.8.5/js/src
+$ autoconf2.13
+}}}
+Then create a temporary directory for building Spidermonkey, e.g.:
+{{{
+$ mkdir /tmp/js
+}}}
+Change directory to the temporary building directory, compile the package for the target device there and install it in the main toolchain's sysroot, e.g.:
+{{{
+$ cd /tmp/js
+$ ~/android/js-1.8.5/js/src/configure \
+  --target=arm-android-eabi \
+  --prefix=$SYSROOT/usr/local \
+  --with-android-ndk=$NDK_MOZ \
+  --with-android-sdk=$SDK \
+  --with-endian=little \
+  --with-arm-kuser \
+  --disable-shared-js \
+  --enable-static
+$ make
+$ make install
+}}}
+Finally, hand-edit the mozjs185.pc file to remove the requirement for NSPR somehow.
+Set up the environment for cross-compiling using the main standalone toolchain:
+{{{
+$ HOSTCONF=arm-eabi-linux
+$ BUILDCONF=i686-pc-linux-gnu
+$ export ARCH=armv7-a
+$ export SYSROOT=$SYSROOT
+$ export PATH=$PATH:$TOOLCHAIN/bin:$SYSROOT/usr/local/bin
+$ export CROSS_COMPILE=arm-linux-androideabi
+$ export CC=${CROSS_COMPILE}-gcc
+$ export CXX=${CROSS_COMPILE}-g++
+$ export AR=${CROSS_COMPILE}-ar
+$ export AS=${CROSS_COMPILE}-as
+$ export LD=${CROSS_COMPILE}-ld
+$ export RANLIB=${CROSS_COMPILE}-ranlib
+$ export NM=${CROSS_COMPILE}-nm
+$ export STRIP=${CROSS_COMPILE}-strip
+$ export CFLAGS="-DANDROID -mandroid -fomit-frame-pointer --sysroot=$SYSROOT -march=$ARCH -mfloat-abi=softfp -mfpu=vfp -mthumb"
+$ export CXXFLAGS=$CFLAGS
+$ export LDFLAGS="-L${NDK}/sources/crystax/libs/armeabi-v7a -lcrystax"
+}}}
+Download the development snapshot for SDL 1.3 from [http://www.libsdl.org/hg.php this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf SDL-1.3.tar.gz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/SDL-1.3.0-6235
+}}}
+Then execute the following commands to compile the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF  --with-sysroot=$SYSROOT --prefix=$SYSROOT/usr/local --disable-joystick
+$ make
+$ make install
+}}}
+Download the latest version of cURL from [http://curl.haxx.se/download.html this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf curl-7.24.0.tar.bz2
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/curl-7.24.0
+}}}
+Then execute the following commands to compile the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF  --with-sysroot=$SYSROOT --prefix=$SYSROOT/usr/local
+$ make
+$ make install
+}}}
+Download the latest version of libpng from [http://www.libpng.org/pub/png/libpng.html this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf libpng-1.5.7.tar.xz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/libpng-1.5.7
+}}}
+Then execute the following commands to compile the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF  --with-sysroot=$SYSROOT --prefix=$SYSROOT/usr
+$ make
+$ make install
+}}}
+The game depends on libjpeg. We will use libjpeg-turbo, an ABI-compatible fork of libjpeg that adds support for SIMD processing, giving us maximal performance with the target processor's ARM NEON engine.
+Download the latest version of libjpeg-turbo from [http://sourceforge.net/projects/libjpeg-turbo/files/ this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf libjpeg-turbo-1.1.1.tar.gz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/libjpeg-turbo-1.1.1
+}}}
+Then execute the following commands to compile the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF  --with-sysroot=$SYSROOT --prefix=$SYSROOT/usr
+$ make
+$ make install
+}}}
+Download the latest version of libxml2 from [http://xmlsoft.org/downloads.html this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf libxml2-2.7.8.tar.gz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/libxml2-2.7.8
+}}}
+Then execute the following command to configure the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF --prefix=$SYSROOT/usr --without-threads --without-iconv --without-python --enable-shared
+}}}
+Hand-edit the Makefile to remove `runtest$(EXEEXT)` and `testrecurse$(EXEEXT)` from the `noinst_PROGRAMS` definition, e.g.
+{{{
+noinst_PROGRAMS = testSchemas$(EXEEXT) testRelax$(EXEEXT) \
+        testSAX$(EXEEXT) testHTML$(EXEEXT) testXPath$(EXEEXT) \
+        testURI$(EXEEXT) testThreads$(EXEEXT) testC14N$(EXEEXT) \
+        testAutomata$(EXEEXT) testRegexp$(EXEEXT) testReader$(EXEEXT) \
+        testapi$(EXEEXT) testModule$(EXEEXT) \
+        runsuite$(EXEEXT) testchar$(EXEEXT) testdict$(EXEEXT) \
+        runxmlconf$(EXEEXT)
+}}}
+Finally, execute the following commands to compile the package:
+{{{
+$ make
+$ make install
+}}}
+Download the latest version of ENet 1.3 from [http://enet.bespin.org/download/ this page] to the working directory and then unpack it there, e.g.:
+{{{
+$ cd ~/android
+$ tar -xvf enet-1.3.3.tar.gz
+}}}
+Now change directory to the directory that was unpacked, e.g.:
+{{{
+$ cd ~/android/enet-1.3.3
+}}}
+Then execute the following commands to compile the package for the target device:
+{{{
+$ ./configure --host=$HOSTCONF --build=$BUILDCONF --prefix=$SYSROOT/usr
+$ make
+$ make install
+}}}
+=== Porting graphics ===
+See [wiki:GLESPort].
+=== Porting sound ===
+Audio can be disabled for now.
+=== Building the game ===
+The native library (i.e. the actual game) is built using the standard Premake build system as follows.
+''(Note: You currently need to reset your environment if it is still set up for cross-compiling from the previous section. Close any open terminal windows and open a new one.)''
+Build the game as normal, but with:
+{{{
+$ cd ~/android/0ad-game/build/workspaces
+$ ./update-workspaces.sh --gles --android --without-fam --without-audio --disable-atlas --with-system-mozjs185
+$ TOOLCHAIN=$HOME/android/toolchain
+$ export SYSROOT=$TOOLCHAIN/sysroot
+$ export PATH=$PATH:$TOOLCHAIN/bin:$SYSROOT/usr/local/bin
+$ export CXX=arm-linux-androideabi-g++
+$ export PKG_CONFIG_DIR=
+$ export PKG_CONFIG_LIBDIR=$SYSROOT/usr/lib/pkgconfig:$SYSROOT/usr/share/pkgconfig:$SYSROOT/usr/local/lib/pkgconfig:$SYSROOT/usr/local/share/pkgconfig
+$ cd gcc
+$ make config=debug -k pyrogenesis
+}}}
+See loads of build errors.
+Fix all the build errors.
+Fix the build system.
+=== Setting up an Android project ===
+All data that is to be compiled and packaged into the Android application must be assembled in an Android ''project''.
+We'll use the template provided by SDL. Move the project template to a fitting name under the working directory, e.g.:
+{{{
+$ mv SDL-1.3.0-6172/android-project/ ~/android/0ad
+}}}
+This is your ''project directory''.
+=== Compiling dependencies and game ===
+(These instructions are pretty imprecise, but in practice it's possible to get them to work with at least some versions of the game.)
+First download a recent version of SDL 2.0:
+{{{
+cd build/android/sdl-project/jni/
+hg clone http://hg.libsdl.org/SDL
+}}}
+Then build SDL and the .apk (the installable application that invokes the external game engine code):
+{{{
+cd build/android/sdl-project/
+make
+}}}
+(Dependency checking is probably broken, so run "`make clean`" if you need to rebuild after changing stuff.)
+Then install all the dependencies:
+{{{
+cd build/android/
+./setup-libs.sh
+}}}
+The script hardcodes the expected locations of NDK and SDK, so put them there or adjust the script, and it will output to `~/android/toolchain-0ad`. That should download and compile loads of stuff.
+Build the game like:
+{{{
+cd build/workspaces/
+./update-workspaces.sh --gles --android --without-fam --without-audio --disable-atlas --with-system-mozjs185 --with-system-enet --with-system-nvtt --without-nvtt
+cd gcc/
+TOOLCHAIN=${HOME}/android/toolchain-0ad PKG_CONFIG_LIBDIR=${TOOLCHAIN}/sysroot/usr/local/lib/pkgconfig LDFLAGS="-lSDL2 -L=/usr/local/lib -L../../android/sdl-project/libs/armeabi" INCLUDES="--sysroot=${TOOLCHAIN}/sysroot -I${TOOLCHAIN}/arm-linux-androideabi/include/c++/4.4.3/arm-linux-androideabi/armv7-a/ -I../../android/sdl-project/jni/SDL/include -isystem=/usr/local/include/boost-1_45" CXX=${TOOLCHAIN}/bin/arm-linux-androideabi-g++ make pyrogenesis -j3 config=debug
+}}}
+Then attach a device, and in `build/android/sdl-project/` run "`make push-apk`" and "`make push-so`". Run `/sdcard/0ad.apk` on the device to install.
+The .apk is basically just the standard SDL android-project, and it loads `/data/local/libpyrogenesis_dbg.so` which contains all the engine code. That means you can recompile and then upload the engine code (via "`make push-so`") on the host PC, and don't have to manually reinstall the app after each change. If you want a non-debug build, remove the "`config=debug`" when building the game, then copy `binaries/system/libpyrogenesis.so` to `libpyrogenesis_dbg.so` before running "`make push-so`".
+You need to use the game engine to create `public.zip` for data files, since it has to convert all the textures/models/animations/etc into a different format before zipping them up. Build a standard non-Android copy of the game, then run it like "`binaries/system/pyrogenesis -archivebuild=binaries/data/mods/public -archivebuild-output=temp/public.zip -archivebuild-compress`" and it should print lots of output and will take a while (maybe ten minutes or more). Then copy to `/sdcard/0ad/data/mods/public/public.zip` and the game should see it. (If you want to change a few data files after that, you don't need to regenerate `public.zip` - just copy the individual files straight into `mods/public/` and they'll override the zipped version.)
+Also, copy `binaries/data/config/default.cfg` into `/sdcard/0ad/appdata/config/`, and optionally set any local configuration values in `/sdcard/0ad/appdata/config/local.cfg`.
+Then try running the game, and use "`adb logcat`" to see what fails, and fix it.