BuildStendhalForAndroid - Revision history

imported>AntumDeluge: /* Building from Command Line */ re-organize to make ant preferred build method

2025-12-31T00:58:16Z

Building from Command Line: re-organize to make ant preferred build method

← Older revision	Revision as of 00:58, 31 December 2025
(No difference)

imported>AntumDeluge: /* Building from Command Line */ re-organize to make ant preferred build method

2025-12-31T00:58:16Z

Building from Command Line: re-organize to make ant preferred build method

@@ Line 33: / Line 33: @@
 '''''IMPORTANT:''' Before you can build from the command line/terminal, you must have a [[VisualGuideToBuildingStendhalStep1|Java compiler]] provided by a [https://www.oracle.com/java/technologies/downloads/ Java Development Kit (JDK)] installed.''
 === Gradle ===
@@ Line 86: / Line 129: @@
 keyPassword=<key-password>
 keyAlias=<key-alias>
 </pre>

imported>AntumDeluge: Revision suffix property no longer supported

2024-02-12T07:04:20Z

Revision suffix property no longer supported

← Older revision	Revision as of 07:04, 12 February 2024
(No difference)

imported>AntumDeluge: Revision suffix property no longer supported

2024-02-12T07:04:20Z

Revision suffix property no longer supported

← Older revision		Revision as of 07:04, 12 February 2024
Line 126:		Line 126:
	$ ant android -Dgradle.params="assembleRelease assembleDebug"		$ ant android -Dgradle.params="assembleRelease assembleDebug"
	</pre>		</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:
	<pre>
	# calling gradle script directly
	$ ./gradlew assembleDebug -Pandroid.rev=1

	# calling ant target
	$ ant android -Dandroid.rev=1
	</pre>

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

imported>AntumDeluge: /* Ant */ add instructions for "gradle.params" property

2024-01-08T12:10:28Z

Ant: add instructions for "gradle.params" property

← Older revision	Revision as of 12:10, 8 January 2024
(No difference)

imported>AntumDeluge: /* Ant */ add instructions for "gradle.params" property

2024-01-08T12:10:28Z

Ant: add instructions for "gradle.params" property

← Older revision		Revision as of 12:10, 8 January 2024
Line 119:		Line 119:
	<pre>		<pre>
	$ ant android -Dandroid.build=assembleRelease		$ ant android -Dandroid.build=assembleRelease
			</pre>

			Alternatively, an argument line can be passed to Gradle using the <span style="color:green;">gradle.params</span> property:

			<pre>
			$ ant android -Dgradle.params="assembleRelease assembleDebug"
	</pre>		</pre>

imported>AntumDeluge: /* Ant */ note that Ant target is wrapper that calls Gradle script

2024-01-08T12:03:49Z

Ant: note that Ant target is wrapper that calls Gradle script

← Older revision	Revision as of 12:03, 8 January 2024
(No difference)

imported>AntumDeluge: /* Ant */ note that Ant target is wrapper that calls Gradle script

2024-01-08T12:03:49Z

Ant: note that Ant target is wrapper that calls Gradle script

← Older revision		Revision as of 12:03, 8 January 2024
Line 90:		Line 90:
	=== Ant ===		=== 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.		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 Ant target is a wrapper that calls the Gradle script and passes parameters to it. The same conditions related to invoking the Gradle scripts directly apply to using ant.

	From the Stendhal source root directory, execute the following.		From the Stendhal source root directory, execute the following.

imported>AntumDeluge: /* Gradle */ update instructions for changes to source

2024-01-08T12:01:15Z

Gradle: update instructions for changes to source

← Older revision	Revision as of 12:01, 8 January 2024
(No difference)

imported>AntumDeluge: /* Gradle */ update instructions for changes to source

2024-01-08T12:01:15Z

Gradle: update instructions for changes to source

← Older revision		Revision as of 12:01, 8 January 2024
Line 36:		Line 36:
	=== Gradle ===		=== 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.		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;">app/android/gradlew</span> for Unix/Linux systems and <span style="color:green;">app/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 (\\))''.		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;">app/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:		Example <span style="color:green;">local.properties</span> for Unix/Linux:
Line 52:		Line 52:
	'''''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>.''		'''''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.		There are two build types available: <span style="color:darkgreen;">assembleRelease</span> and <span style="color:darkgreen;">assembleDebug</span>. From a command line or terminal, move into the <span style="color:green;">app/android</span> sub-directory and execute the following.

	Unix/Linux example:		Unix/Linux example:
Line 75:		Line 75:
	If <span style="color:darkgreen;">build</span> is used as the argument (<code>gradlew build</code>), it will execute all build types.		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>.		After build completes, the resulting .apk packages will be located in the <span style="color:green;"><source root>/build</span> directory.

	==== Signing Packages ====		==== 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:		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 be installed in your home directory. You can specify a different keystore by creating a file <span style="color:darkblue;">app/android/keystore.properties</span> with contents as follows:

	<pre>		<pre>