fStats
fStats is a third-party statistical data collection library. The main goal of the project is to help developers understand the actual size of their audience through visual graphs and charts.
Usage
For Players
The mod includes a customizable configuration that allows disabling statistics collection on both the server and client sides, as well as hiding location information.
../config/fstats-api/config.json
{
"enabled": true, // Enable/disable data collection from our server
"hideLocation": false // The mod does not collect your IP address, only the country name
}For Developers
The first step is to register and create a project to obtain a unique project identifier.
After that, you can add the library to your project dependencies.
Java - build.gradle
groovy repositories { maven { url "https://api.modrinth.com/maven" } } dependencies { // Option 1: Include fStats API in the project for availability within your jar file (ONLY ~9KB!) include(modImplementation("maven.modrinth:fstats:<version>") // Option 2: Dependency on fStats API requiring manual installation by users modImplementation "maven.modrinth:fstats:<version>" }
Kotlin - build.gradle.kts
kts repositories { maven("https://api.modrinth.com/maven") } dependencies { // Option 1: Include fStats API in the project for availability within your jar file ONLY ~9KB! include(modImplementation("maven.modrinth", "fstats", "<version>")) // Option 2: Dependency on fStats API requiring manual installation by users modImplementation("maven.modrinth", "fstats", "<version>") }
fabric.mod.json
"suggests": {
"fstats-api": "*"
}Project Setup
fabric.mod.json
"custom": {
"fstats": <projectId>
}Done! Now, when any server uses your mod and does not disable fStats, you will receive usage data on the website.
It is recommended to add a badge to your project description to notify users about information collection.
You can resize the badge to your preference
Development Plans
A complete list of proposed features and known issues can be found in the open issues.
License
Distributed under the MIT license. Details can be found in the LICENSE.txt file.
