Skip to content

Getting Started

acoox edited this page Apr 23, 2021 · 23 revisions

Project Structure

  • assets: Contains supporting assets that aren't directly loaded by the game. This can include wiki images, documentation, texture files, etc.
  • source: Contains the source code of the game following the libGDX project layout.

Running the Game

The game uses the Gradle build tool. Open the source directory with IntelliJ or another IDE with Gradle support to automatically install dependencies. Alternatively, Gradle will install dependencies when you first run the game.

A pre-setup Intellij project is provided which contains tasks to run, test, and build the game. This can be selected from the drop-down in the top right of the editor.

Alternatively from a terminal inside the source directory, you can run:

  • ./gradlew run to run the game.
  • ./gradlew test to run the unit tests.
  • ./gradlew build to build a release version of the game.
  • ./gradlew clean to delete the generated output directory.

Dependending on your OS, you may need to substitute ./gradlew with gradlew.bat or gradle (if globally installed).

Code Layout

TODO

Clone this wiki locally