The compiler generates an APK file as the output when the `android`
module is imported by the compilation target. The path to the generated
file can be specified using the `-o` and `--dir` options.
Host system configuration
Some configuration is required to compile for the Android platform from a GNU/Linux host.
1 Download and install the latest Android SDK **and** NDK.
2 Update PATH so it includes the tools `android`, `ndk-build` and `ant`.
You should add something like the following snippet to your .bashrc or equivalent,
be careful to replace `ANDROID_SDK` and `ANDROID_NDK` with the full path where you installed each package.
3 Using the `android` executable, download the latest `tools, build-tools` and within the Android 4.0.3 (API 15) folder, install `SDK platform`.
You may have to install additional SDK platforms for applications with different targets.
4 Using your OS package manager, install `apt openjdk-7-jdk lib32stdc++6 lib32z1`.
On Debian and Ubuntu the command is:
sudo apt-get install apt openjdk-7-jdk lib32stdc++6 lib32z1
Configure your Android application
The *app.nit* framework and this project offers some services to
customize the generated Android application.
* All *app.nit* annotations are applied to Android projects:
`app_name`, `app_namespace` and `app_version`.
* Custom information can be added to the Android manifest file
using the annotations `android_manifest`, `android_manifest_application`
Example usage to specify an extra permission:
* The API version target can be specified with `android_api_min`,
`android_api_max` and `android_api_target`. These take a single
integer as argument. They are applied in the Android manifest as
`minSdkVesion`, `targetSdkVersion` and `maxSdkVersion`.
* The annotation `android_activity` defines a Java class used as an
entry point to your application. As of now, this annotation should
only be used by low-level implementations of Nit on Android.
Its usefulness will be extended in the future to customize user applications.
There is two core implementation for Nit apps on Android.
`android::nit_activity` is used by apps with standard windows and native UI controls.
`android::game` is used by, well, games and the game frameworks `mnit` and `gamnit`.
Clients don't have to select the core implementation, it is imported by other relevant modules.
For example, a module importing `app::ui` and `android` will trigger the importation of `android::nit_activity`.
Importing `android::landscape` or `android::portrait` locks the generated
application in the specified orientation. This can be useful for games and
other multimedia applications.
There are two compilation modes for the Android platform, debug and release.
Theses modes are also applied to the generated Android projects.
The compilation mode is specified as an argument to `nitc`, only
`--release` can be specified as debug is the default behavior.
Debug mode enables compiling to an APK file without handling signing keys
and their password. The APK file can be installed to a local device with
USB debugging enabled, but it cannot be published on the Play Store.
By default, `nitc` will compile Android applications in debug mode.
Building in release mode will use your private key to sign the
APK file, it can then be published on the Play Store.
1 Have a keystore with a valid key to sign your APK file.
To create a new keystore, avoid using the default values of `jarsigner`
as they change between versions of the Java SDK. You should instead use a
command similar to the following, replacing `KEYSTORE_PATH` and `KEY_ALIAS`
with the desired values.
keytool -genkey -keystore KEYSTORE_PATH -alias KEY_ALIAS -sigalg MD5withRSA -keyalg RSA -keysize 1024 -validity 10000
2 Set the environment variables used by `nitc`: `KEYSTORE`, `KEY_ALIAS` and
optionally `TSA_SERVER`. These settings can be set in a startup script such as
`~/.bashrc` or in a local Makefile.
You can use the following commands by replacing the right-hand values
to your own configuration.
export TSA_SERVER=timestamp_authority_server_url # Optional
3 Call `nitc` with the `--release` options. You will be prompted for the
required passwords as needed by `jarsigner`.