All commands are run inside the project folder.
// This command will build the project and run the unit tests
// The build and report artifacts are located inside the `target` folder
$ mvn -B package
// Run the executable file via Maven
$ mvn exec:java$ mvn test// The Javadoc folder for the tested code is located at `docs/apidocs/`
// The Javadoc folder for the test code is located at `docs/apidocs/testapidocs`
// Open the index.html file inside the output folder to see the document
$ mvn javadoc:javadoc javadoc:test-javadocThe doclint option is enabled by default via maven-javadoc-plugin. See
A log file is generated for the game, it is placed at src/main/resources/logs/log.txt.
Install EditorConfig for VS Code on your editor. You should enable the Enable On Save option. Once they are done, VSCode will read .editorconfig file and format accordingly.
.editorconfig support is already built-in for IntelliJ IDEA.
The project uses Spotless for code layout formatting.
// To check the violations on code formatting
$ mvn spotless:check
// To apply code formatting on the whole project
$ mvn spotless:apply