Building from Source

Building from Source

You need a JDK to run Gradle. The repository points org.gradle.java.home in gradle.properties at a Temurin 26; change it to yours. Gradle downloads the JDKs the modules compile with (21 for the core, the Paper plugin and 1.21.1; 25 for 26.3).

./gradlew build

Jars end up in:

Jar	What it is
mc-<version>/fabric/build/libs/blockcompanion-fabric-<version>-<mod version>.jar	Fabric
mc-<version>/neoforge/build/libs/blockcompanion-neoforge-<version>-<mod version>.jar	NeoForge
paper/build/libs/blockcompanion-paper-<mod version>.jar	Paper plugin

<version> is 1.21.1, 26.2 or 26.3.

Try it in a development game with ./gradlew :mc-1.21.1:fabric:runClient (or :neoforge:, or the 26.2 / 26.3 modules). ./gradlew :paper:runServer starts a Paper 1.21.1 test server. The version is mod_version in gradle.properties.

Tests: ./gradlew :core:test.

The core module (plain Java 21) is compiled into each Minecraft version's common module. The Minecraft modules use Architectury Loom.