This repository contains the code for all Java-based Metrics classes.
The recommended way to include the Metrics classes is to use a build management tool like Gradle or Maven and shade + relocate the required classes.
However, to make bStats more accessible for beginners, a single file Metrics class is automatically generated on every
release and pushed to the single-file branch. This file can simply be copy-and-pasted.
To generate a Metrics class locally, you can run the gradlew generateMetrics command.
It will write the generated files into the <platform>/build/generated/ directory.
Snapshots are automatically published on every push.
To publish a new release, one can simply remove the -SNAPSHOT suffix from the version in the gradle.properties file
and in the MetricsBase class.
This will automatically trigger a GitHub Action that
- Publishes a GitHub Release
- Pushes the new version to Maven Central
- Creates and pushes a new commit that updates the version by one patch level and append a
-SNAPSHOTsuffix (e.g.,2.3.4->2.3.5-SNAPSHOT).
For the GitHub Actions to properly work, one must configure the following encrypted secrets:
OSSRH_USERNAME: The username used to publish the Maven CentralOSSRH_TOKEN: The password used to publish to Maven CentralSIGNING_KEY: The PGP private key used to sign the built artifacts (can be obtained by runninggpg --export-secret-keys -a <key-id> > key.txt)SIGNING_PASSWORD: The passphrase that protects the private key