README.md

FastStats Java

Documentation: https://docs.faststats.dev/java

Building

Run Gradle from the repository root. The library modules use the standard Java lifecycle.

Libraries

Use build for the reusable FastStats libraries:

./gradlew :core:build
./gradlew :config:build
./gradlew :bukkit:build
./gradlew :bungeecord:build
./gradlew :hytale:build
./gradlew :minestom:build
./gradlew :nukkit:build
./gradlew :sponge:build
./gradlew :velocity:build

Library jars are written to each module's build/libs directory. Fabric, Forge and NeoForge compatibility artifacts are published under stable Maven artifact IDs for every supported Minecraft version:

dev.faststats.metrics:fabric:<sdk-version>+mc26.3
dev.faststats.metrics:forge:<sdk-version>+mc26.3
dev.faststats.metrics:neoforge:<sdk-version>+mc26.3

Each artifact only declares the Minecraft version it was built for in its fabric.mod.json, mods.toml or neoforge.mods.toml.

The Fabric artifact also supports Quilt, which loads Fabric mods. On Quilt it reports Quilt and the Quilt Loader version instead of Fabric. It needs Quilt Loader 0.30.0 or newer and Fabric API or Quilted Fabric API.

See CONTRIBUTING.md for how the version-specific code is organized and how to add a Minecraft version.

Building everything

To compile and test all modules with the standard lifecycle, run:

./gradlew build

To build everything except the Fabric, Forge and NeoForge mod platforms, which is much faster, run:

./gradlew build -PmodPlatforms=none