BuildStendhalForAndroid: Difference between revisions

=== Gradle ===

The [https://gradle.org/ Gradle Build Tool] is used for building. The necessary tools are already included with the source code. Two scripts are provided for executing the build: <span style="color:green;">android/gradlew</span> for Unix/Linux systems, & <span style="color:green;">android/gradlew.bat</span> for Windows.

In order for the build to complete, the scripts must know where the SDK libraries are located. The script will check the '''<span style="color:green;">ANDROID_SDK_ROOT</span>''' environment variable, or it will parse the value of '''<span style="color:green;">sdk.dir</span>''' in the <span style="color:green;">android/local.properties</span> file ''('''NOTE:''' Windows users must use double backslashes for directories (\\))''.

Example <span style="color:green;">local.properties</span> for Unix/Linux:

<pre>

sdk.dir=/path/to/sdk/root

</pre>

Example <span style="color:green;">local.properties</span> for Windows:

<pre>

sdk.dir=C:\\path\\to\\sdk\\root

</pre>

'''''NOTE:''' On Windows, if you used Android Studio to download the SDK, it will be located in <span style="color:green;">C:\\Users\\<username>\\AppData\\Local\\Android\\Sdk</span>.''

There are three build types available: <span style="color:darkgreen;">assembleRelease</span>, <span style="color:darkgreen;">assemblePrerelease</span>, & <span style="color:darkgreen;">assembleDebug</span>. From a command line or terminal, move into the <span style="color:green;">android</span> sub-directory & execute the following.

$ ./gradlew assembleRelease

$ ANDROID_SDK_ROOT="/path/to/sdk/root" ./gradlew assembleRelease

Windows '''cmd''' example (note that you do not need to include the ".bat" filename extension):

> gradlew assembleRelease

> gradlew assembleRelease

If <span style="color:darkgreen;">build</span> is used as the argument (<code>gradlew build</code>), it will execute all build types.

After build completes, the resulting .apk packages will be located in <span style="color:green;"><source root>/build/build_android_client/outputs/apk</span>.

==== Signing Packages ====

On most Android systems packages will [https://developer.android.com/studio/publish/app-signing need to be signed] in order to work. By default Gradle will sign packages using a debugging keystore which must by installed in your home directory. You can specify a different keystore by creating a file <span style="color:darkblue;">android/keystore.properties</span> with contents as follows:

storeFile=<path-to-keystore-file>

storePassword=<store-password>

keyPassword=<key-password>

keyAlias=<key-alias>

=== Ant ===

As with other instructions on building from the command line, the Android client can also be built with an [https://ant.apache.org/ Apache Ant target]. The same conditions related to invoking the Gradle scripts directly apply to using ant.

From the Stendhal source root directory, execute the following.

$ ant dist_client_android

$ ANDROID_SDK_ROOT="/path/to/sdk/root" ant dist_client_android

Windows '''cmd''' example:

> ant dist_client_android

> ant dist_client_android

The resulting .apk packages will be located in the <span style="color:green;"><source root>/build</span> directory.

The build type can be set manually using the <span style="color:green;">android.build</span> property. The default is <span style="color:green;">assembleDebug</span>.

<pre>

$ ant dist_client_android -Dandroid.build=assembleDebug

</pre>

=== Setting Revision Suffix ===

The compiled .apk packages will be versioned with the date of build. A custom revision suffix can be added by setting the <span style="color:darkgreen;">android.rev</span> property. If invoking gradle script directly, use the '''''-P''''' switch. If calling ant, use the '''''-D''''' switch.

Example usage:

# calling gradle script directly

$ ./gradlew assembleDebug -Pandroid.rev=1

# calling ant target

$ ant dist_client_android -Dandroid.rev=1

Example output: ''stendhal-webview-{{#time:Ymd}}-1-debug.apk''