For Developers

Build System

This mod uses the Gradle build system.

Prequisites

You only need Java installed. For this mod, Java 21 or newer is required.

Building

Inside IDEs, you are now able to build, run clients, run servers, etc., but it is possible to use commands. To simply build the mod, do the following:

For building:

./gradlew build

Artifacts will be in ./fabric/build/libs/ and ./neoforge/build/libs. On Fabric, only one jar is generated. On Neoforge, use the one ending in -all.jar. For further development, it is recommended to install an IDE such as IntelliJ IDEA (community edition is free). Importing the project will automatically give you other run actions, such as running the mod in a development environment.

Mappings

This mod currently uses Mojang's Official Mappings (mojmap). This is due to the stability of the mappings, and their ability to be used cross-platform. Although they are proprietary, they can be used in mod development. This mod also uses Parchment where possible (mappings only for method parameters and method javadocs), which builds on top of mojmap, which itself does not have official parameter mappings. This is useful for understanding what vanilla code does.