65
edits
Difference between revisions of "Compiling ScummVM/Android"
Jump to navigation
Jump to search
→Configure and build ScummVM
Praetorian (talk | contribs) |
|||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
This page describes how to build Android packages from the ScummVM source tree. | This page describes how to build Android packages from the ScummVM source tree. | ||
However, one can still attempt the manual way of setting up the Android toolchain(s), without using Docker containers, by following the logic and commands in our scripts for building the Docker images. It should be noted | While one can go through the process of manually installing and configuring the toolchains for the target Android architectures, as well as cross-compiling any third party libraries (again for each target architecture), currently ''the recommended method'' is to use a Docker container that can be built using scripts from our [https://github.com/scummvm/dockerized-bb Dockerised Buildbot repository]. This page will cover how to build ScummVM for the supported target Android architecture using the Docker container method. | ||
However, one can still attempt the manual way of setting up the Android toolchain(s), without using Docker containers, by following the logic and commands in our scripts for building the Docker images. It should be noted that the process of manually setting up the toolchains is ''considerably easy if the developer does not need any of the cross-compiled third party libraries'' that some of the game engines or functionalities of ScummVM depend on. | |||
= Preparatory work = | = Preparatory work = | ||
| Line 10: | Line 11: | ||
== On a Linux 64bit distribution == | == On a Linux 64bit distribution == | ||
This process requires running on a recent Linux 64bit distribution, eg. Ubuntu 16.04 LTS or higher (or equivalent). These instructions were tested on a host running Ubuntu x64 20.04 LTS. | |||
Install the <tt>git</tt> package in order to clone the ScummVM source code repository and keep it up-to-date, and also some additional packages to build the Docker toolchain containers: | Install the <tt>git</tt> package in order to clone the ScummVM source code repository and keep it up-to-date, and also some additional packages to build the Docker toolchain containers: | ||
| Line 36: | Line 37: | ||
<code>sudo apt-get install git m4 make</code> | <code>sudo apt-get install git m4 make</code> | ||
*Important note: The instructions below assume that you are running the commands from a Linux bash shell. If you're on Windows, please make sure you '''always have Docker Desktop up and running before launching your Linux bash shell(s)'''. | *Important note: The instructions below assume that you are running the commands from a Linux bash shell. If you're on Windows, please make sure you '''always have Docker Desktop up and running before launching your Linux bash shell(s)'''. | ||
== On macOS == | |||
# If you don't already have Xcode command line tools, Xcode from the app store, then from the Terminal run: <code>xcode-select --install</code> | |||
# If you don't have homebrew installed, install it from https://brew.sh/, then from the Terminal, install docker with <code>brew install docker</code> | |||
# Install a docker server. The easiest one is probably [https://docs.docker.com/desktop/install/mac-install/ Docker Desktop] | |||
= Setting up the environment = | = Setting up the environment = | ||
| Line 62: | Line 69: | ||
<code>cd ~/Workspace/android-scummvm-bb/dockerized-bb</code> | <code>cd ~/Workspace/android-scummvm-bb/dockerized-bb</code> | ||
<code>make toolchains/android</code> | <code>make toolchains/android/pull</code> | ||
At this point the <code>docker images</code> command should return something like the following: | At this point the <code>docker images</code> command should return something like the following; <code>toolchains/android</code> is the required image: | ||
<code>docker images</code> | <code>docker images</code> | ||
| Line 135: | Line 142: | ||
=== '''Configure and build ScummVM''' === | === '''Configure and build ScummVM''' === | ||
Supported target architectures for the configure command (values for the <code>--host</code> switch parameter): | Supported target architectures for the configure command (values for the <code>--host</code> switch parameter): | ||
* <code>android-arm64-v8a</code> - for all new Android devices | * <code>android-arm64-v8a</code> - for all new Android devices | ||
*<code>android-arm-v7a</code> - for older Android devices | |||
* <code>android-x86</code> - ideal for emulator with 32bit images | * <code>android-x86</code> - ideal for emulator with 32bit images | ||
* <code>android-x86_64</code> - ideal for emulator with 64bit images | * <code>android-x86_64</code> - ideal for emulator with 64bit images or a Chromebook device | ||
==== '''For a debug build''' ==== | ==== '''For a debug build''' ==== | ||
| Line 167: | Line 174: | ||
For instructions on how to create a debug signing certificate manually, if the developer wants to create it one their own for some reason, please refer to the [https://developer.android.com/studio/publish/app-signing#debugmode Android Developers instructions here]. | For instructions on how to create a debug signing certificate manually, if the developer wants to create it one their own for some reason, please refer to the [https://developer.android.com/studio/publish/app-signing#debugmode Android Developers instructions here]. | ||
==== '''For a release build''' ==== | ==== '''For a release build (which builds all engines)''' ==== | ||
First run a <code>make clean</code> and <code>configure</code> command from inside the local scummvm repository folder (you should be in there by default after running the <code>docker run</code> command). Choose one of the following commands based on the target android architecture: | First run a <code>make clean</code> and <code>configure</code> command from inside the local scummvm repository folder (you should be in there by default after running the <code>docker run</code> command). Choose one of the following commands based on the target android architecture: | ||
| Line 191: | Line 198: | ||
Please note that a release build must be signed with a non-debug key in order to be installed on a Android device. In order to sign a release build, assuming you have created a release keystore named <code>scummvm-release-key.keystore</code> and have put it in your <code>${ANDROID_SDK_HOME}</code> path on the host Linux (ie. here <code>~/Workspace/android-scummvm-bb/bshomes/sdk-home</code>), you will need to run a command like the following: | Please note that a release build must be signed with a non-debug key in order to be installed on a Android device. In order to sign a release build, assuming you have created a release keystore named <code>scummvm-release-key.keystore</code> and have put it in your <code>${ANDROID_SDK_HOME}</code> path on the host Linux (ie. here <code>~/Workspace/android-scummvm-bb/bshomes/sdk-home</code>), you will need to run a command like the following: | ||
<code>apksigner sign --ks ${ANDROID_SDK_HOME}/scummvm-release-key.keystore --out release/scummvm-release-signed.apk release/ScummVM-release-unsigned.apk</code> | <code>${ANDROID_SDK_BTOOLS}/apksigner sign --ks ${ANDROID_SDK_HOME}/scummvm-release-key.keystore --out release/scummvm-release-signed.apk release/ScummVM-release-unsigned.apk</code> | ||
== Installing the apk on an Android Device == | == Installing the apk on an Android Device == | ||
| Line 202: | Line 209: | ||
= Android Studio setup = | = Android Studio setup = | ||
After compiling | After the compiling process has concluded, one may find within the build directory (if used) a new directory called <tt>android-project.</tt> If following the above process, this folder will be inside the root folder of the locally cloned ScummVM source code repository. | ||
To enable debugging, after opening the <tt> | |||
This folder can be opened by Android Studio. C files are not yet available, but it is possible to edit the Java source files and debug both Java & native code (on an emulator or on a real device via an <tt>adb</tt> connection). | |||
To ''enable debugging'', after opening the <tt>android_project</tt> directory, please edit the <tt>android_project configuration</tt> (click on the dropdown arrow next to the configuration name and select <tt>Edit Configurations...</tt>), select the tab <tt>Debugger</tt>, and set field <tt>Debug type</tt> to <code>Dual</code>. | |||
= References = | = References = | ||
* [[Compiling_ScummVM/Docker#Using_the_docker_images | Using the Docker images]] | * [[Compiling_ScummVM/Docker#Using_the_docker_images | Using the Docker images]] | ||