fStats

Table of Contents

1. About The Project
2. Usage
   • For users
   • For developers
3. Roadmap
4. Contributing
5. License

About The Project

fStats is a 3rd-party metric collection library. The Main idea is help developers to recognize their actual community based on charts

(back to top)

Usage

For user

The mod has a config that allows to turn off a metric collection from the server/client and hiding location

../config/fstats-api/config.json

{
    "enabled": true,      // Enable/Disable collection from our server
    "hideLocation": false // Mod does not collect your IP, only the country name 
}

For developers

The first thing that you need to do is register and create a project to get projectId

After that, you are ready to add a library as/to dependency

Java - build.gradle

repositories {
    maven {
        url "https://api.modrinth.com/maven"
    }
}

dependencies {
    // Option 1: Include fStats API to project for it to be available within your own jar (IT'S ONLY ~9KB!)
    include(modImplementation("maven.modrinth:fstats:<version>")

    // Option 2: Depend on fStats API, but require that users install it manually
    modImplementation "maven.modrinth:fstats:<version>"
}

Kotlin - build.gradle.kts

repositories {
    maven("https://api.modrinth.com/maven")
}

dependencies {
    // Option 1: Include fStats API to project for it available within your own jar IT'S ONLY ~9KB!
    include(modImplementation("maven.modrinth", "fstats", "<version>"))

    // Option 2: Depend on fStats API, but require that users install it manually
    modImplementation("maven.modrinth", "fstats", "<version>")
}

fabric.mod.json

"suggests": {
    "fstats-api": "*"
}

Setup project

fabric.mod.json

"custom": {
    "fstats": <projectId>
}

Done, now when any server uses your mod, and if they don't disable fStats, you are going to get data about that on website

Also, recommend adding the badge to your project description to notify users that you collect information.

Resize badge to any size that you want

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known
issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any
contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also
simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
   1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
   2. Commit your Changes (git commit -m 'Add some AmazingFeature')
   3. Push to the Branch (git push origin feature/AmazingFeature)
   4. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)