Deadlands

A top-down sandbox RPG game with crafting, fighting, and a little bit of magic!

Tech stack

• Java 17
• libGDX v1.13.1

Run locally

Install Java, then:

git clone https://github.com/ModMonster/Deadlands.git
cd Deadlands
chmod +x gradlew
./gradlew run

Local development with IntelliJ

1. Clone the repo with git clone https://github.com/ModMonster/Deadlands.git
2. Open the folder in IntelliJ Idea
3. After indexing is finished, navigate to Deadlands/desktop/src/ca/modmonster/deadlands/DesktopLauncher
4. Right click on DesktopLauncher.java and select Run 'DesktopLauncher.main()'
5. The game will be run, and can now be run by using the 'Run' action in IntelliJ.

Note: On macOS, the game may show an error when it is run by using the IntelliJ 'Run' action. To fit it, edit the build configuration and add -XstartOnFirstThread to the VM options.

Building

To build a .jar file, run ./gradlew desktop:jar

Java 17 is REQUIRED to package the game; the build tasks will fail otherwise.

To build a runnable app binary, run any of the following commands / Gradle tasks depending on the target operating system:

• ./gradlew desktop:packageWinX64 for Windows 64 bit
• ./gradlew desktop:packageMacX64 for macOS 64 bit
• ./gradlew desktop:packageMacM1 for macOS with Apple Silicon
• ./gradlew desktop:packageLinuxX64 for Linux 64 bit

The output will be placed in desktop/build/construo/dist.

Versioning

When releasing a new version, use the tag format: vX.X-X, where:

• The first X represents the major version. Increment when new gameplay changes are made (i.e. new features)
• The second X represents a patch of the version where minor gameplay changes may be made, without any new features or large gameplay differences (i.e. bug fixes)
• The final X should be either alpha, pre, or omitted altogether for a release version

For example: v26.3-beta

• Additionally, if a version is re-released with only runtime changes (changes which do not affect the code of the game itself in any way), it can be tagged by adding a plus and a number to the end of the tag (i.e. v2.2-pre+1 for the first re-release)

When releasing a new version, remember to change...

• VERSION in main Deadlands.java file
• allprojects/version in root-level build.gradle file

macOS versioning requirements are strict, and must stick to pure semantic versioning, so when building, we will use 1.0 for all pre-release builds (in the build.gradle), and start with the same versioning pattern upon release.