Project: android-port (GitHub Link)

android-port-master
- gradle.properties
- gradle
  - wrapper
    - gradle-wrapper.properties
- gradlew.bat
- buildscripts
  - include
    - asan-wrapper.sh
    - command_wrapper_tail.sh.in
    - version.sh
    - download-ndk.sh
    - command_wrapper_head.sh.in
    - gdb-add-index
    - setup-ndk.sh
  - tool
    - asan_symbolize.py
  - clean.sh
  - ssh-build.sh
  - package-symbols.sh
  - full-build.sh
  - CMakeLists.txt
  - checksum.py
  - patches
    - openal-unset-compiler.patch
    - sdl2-android-gamepad.patch
    - gas-preprocessor.pl
    - openmw
      - 0009-windowmanagerimp-always-show-mouse-when-possible-pat.patch
      - 0002-scenemanager-disable-state-share-inc-compile.patch
      - 0004-getUVBuffer-pre-set-array-binding-to-avoid-thread-ra.patch
      - 0003-globalmap-fix-race-vs-savegame-load.patch
      - 0001-loadingscreen-disable-for-now.patch
      - 0006-Add-an-option-to-enable-simple-bounding-box.patch
      - 2344.patch
      - 0005-android-Revert-UI-dimensions.patch
      - 0007-android-Fix-red-sky-after-shadows-merge.patch
      - 0008-Revert-Merge-pull-request-2238-from-Capostrophic-fre.patch
    - clang-ccache.sh
    - clang++-ccache.sh
    - gl4es-build-shared.patch
    - osg
      - 0005-CullSettings-make-inheritanceMask-atomic-to-silence-.patch
      - 0001-Replace-Atomic-impl-with-std-atomic.patch
      - 0004-IncrementalCompileOperation-wrap-some-stuff-in-atomi.patch
      - 0002-BufferObject-make-numClients-atomic.patch
      - 0003-Array-make-possible-to-use-thread-safely-with-setTex.patch
    - sdl2-SDL_gamecontrollerdb.h
    - bullet-fix-cmake.patch
  - .gitignore
  - build.sh
- LICENSE
- gradlew
- build.gradle
- CI
  - travis.sh
- .travis.yml
- README.md
- app
  - src
    - main
      - res
        xml
        settings.xml
        shortcuts.xml
        layout
        settings.xml
        toolbar.xml
        file_view.xml
        configure_controls.xml
        main.xml
        activity_filechoser.xml
        rowlistview.xml
        screencontrols.xml
        listview.xml
        layout-large
        rowlistview.xml
        values-v21
        styles.xml
        menu
        menu_settings.xml
        values-v14
        styles.xml
        layout-xlarge
        rowlistview.xml
        values
        styles.xml
        attrs.xml
        themes.xml
        strings.xml
        drawable
        divider.xml
        card_backround.xml
        toolbar_dropshadow.xml
      - AndroidManifest.xml
      - gdb.sh
      - java
        utils
        Utils.java
        ui
        controls
        Osc.kt
        GamepadEmulator.java
        JoystickRight.java
        Joystick.java
        JoystickLeft.java
        Osk.kt
        ButtonTouchListener.java
        activity
        ConfigureControls.kt
        MainActivity.java
        GameActivity.java
        fragments
        FragmentSettings.java
        file
        utils
        CopyFilesFromAssets.java
        Writer.java
        ConfigsFileStorageHelper.java
        constants
        Constants.java
        permission
        PermissionHelper.java
        org
        libsdl
        app
        SDLControllerManager.java
        SDL.java
        SDLActivity.java
        SDLAudioManager.java
        cursor
        MouseCursor.java
        parser
        CommandlineParser.java
      - .gitignore
  - openmw-base.cfg
  - lint.xml
  - settings-base.cfg
  - build.gradle
- settings.gradle
- .gitignore

OpenMW for Android

Building

There are two steps for building OpenMW for Android. The first step is building C/C++ libraries. The second step is building the Java launcher.

Prerequisites

You will need some standard tools installed that you probably already have (bash, gcc, g++, sha256sum, unzip).

CMake 3.6.0 or newer is required, you can download the latest version here (and place in your PATH) if your distro ships with an outdated version.

Additionally, to build the launcher you will need Android SDK installed, it is suggested that you use Android Studio which can set it up for you (see step 2).

Step 1: Build the libraries

Go into the buildscripts directory and run ./build.sh. The script will automatically download the Android native toolchain and all dependencies, and will compile and install them.

Step 2: Build the Java launcher

To get an APK file you can install, open the android-port directory in Android Studio and run the project.

Alternatively, if you do not have Android Studio installed or would rather not use it, run ./gradlew assembleDebug from the root directory of this repository. The resulting APK, located at ./app/build/outputs/apk/debug/app-debug.apk, can be transferred to the device and installed.

Notes for developers

Debugging native code

You can debug native code with ndk-gdb. To use it, once you've built both libraries and the apk and installed the apk, run the application and let it stay on the main menu. Then cd to app/src/main and run ./gdb.sh [arch]. The arch variable has to match the library your device will be using (one of arm, arm64, x86_64, x86; arm is the default).

This also automatically enables gdb to use unstripped libraries, so you get proper symbols, source code references, etc.

Running Address Sanitizer

To compile everything with ASAN:

# Clean previous build
./clean.sh
# Build with ASAN enabled & debug symbols
./build.sh --ccache --asan --debug
# Or: ./build.sh --ccache --asan --debug --arch arm64

Then open Android Studio and compile and install the project.

To get symbolized output:

adb logcat | ./tool/asan_symbolize.py --demangle -s ./build/arm/symbols/
# Or: adb logcat | ./tool/asan_symbolize.py --demangle -s ./build/arm64/symbols/

Credits

Original Java code written by sandstranger. Build scripts originally written by sandstranger and bwhaines.