Module Development setup

**This page represents an abridged description of how to install and use the necessary tools to enable working with the VASL code. It is also somewhat dated in terms of version references. A more complete set of instructions is available via the GettingStartedWithVASLDevelopment.docx in the vasl/dev documentation directory on GitHub. **

Required software

Install Java SDK 11 or higher. The JRE that comes with VASSAL is not sufficient for compiling the code. Make sure that the JAVA_HOME variable is set in your system environment and is pointing to the correct directory.

Install Maven 3.3.0 from http://maven.apache.org/. Add the path to the mvn command to your PATH environment variable.

Configuring Maven

You need a special settings.xml in order to be able to build VASL. This file goes into your home directory in the .m2 subdirectory (the ~/.m2 folder). Use these contents but do replace the path to your JDK (if you have a path with spaces, you DON'T need to quote it):

	<settings>
		<profiles>
			<profile>
				<id>vasl</id>
				<activation>
					<activeByDefault>true</activeByDefault>
				</activation>
				<properties>
					<jdk>C:\your\path\to\jdk</jdk>
				</properties>
				<repositories>
					<repository>
						<name>Google Code</name>
						<id>googelcode</id>
						<releases>
							<enabled>true</enabled>
							<updatePolicy>always</updatePolicy>
							<checksumPolicy>warn</checksumPolicy>
						</releases>
						<snapshots>
							<enabled>true</enabled>
							<updatePolicy>never</updatePolicy>
							<checksumPolicy>fail</checksumPolicy>
						</snapshots>
						<url>https://oss.sonatype.org/content/groups/googlecode/</url>
						<layout>default</layout>
					</repository>
				</repositories>
			</profile>
		</profiles>
	</settings>

For an x64 program files location of the jdk, this worked (but use your correct jdk version name):

<jdk>C:\Program Files\Java\jdk1.7.0_67</jdk>

Building VASL

In order to build VASL, checkout the code from GithUb on the command line or from within your favorite IDE. Then switch to the directory that contains the Maven pom.xml and call it:

mvnw clean package

Coding

Within your IDE, clone the VASL source code from the GitHub vasl-developers/vasl repository. Configure project settings within the IDE.

Running VASL

Run a built VASL module with VASSAL from the VASSAL window just as you would with a VASL mod downloaded from VASL.info.