Development and addons

The source repository contains the current module map, API, and contributor guidance. Read its architecture guide, feature guide, and contributing guide before changing code.

The project uses Kotlin, JDK 25, and Gradle 9.7.x. Open the repository root as one Gradle build. A wrapper is not committed; use an installed Gradle or the IDE’s Gradle. Useful build-only tasks:

gradle build-26.1.2-legit
gradle build-26.1.2-cheat
gradle build-26.2-legit
gradle build-26.2-cheat
gradle build-all

build-all includes both versions, both editions, and Extras. Built main jars are under mod/platform/<minecraft-version>/build/libs/; Extras jars are under addons/extras/<minecraft-version>/build/libs/.

Third-party addons are Fabric mods with a blackaddons:addon entrypoint. They register features through the BlackAddons API and events. The Cheat edition uses this addon mechanism internally. The feature guide explains discovery, categories, settings, HUD elements, and localization. The architecture guide includes instructions for an addon in its own repository using the published blackaddons-api contract.

Source use is governed by the PolyForm Noncommercial License. Contributions are subject to the Contributor License Agreement.