fStats

<a name="readme-top"></a> ] ] ] ] ] ] ] ] <br /> <div align="center"> <a href="https://github.com/fstats/fstats"> <img src="https://fstats.dev/icon.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">fStats</h3> <p align="center"> Fabric metric system for developers <br /> <a href="https://discord.gg/pbwnMwnUD6">Support</a> · <a href="https://github.com/fstats/fstats-api/issues">Report Bug</a> · <a href="https://github.com/fstats/fstats-api/issues">Request Feature</a> </p> </div> <details> <summary>Table of Contents</summary> <ol> <li><a href="#about-the-project">About The Project</a></li> <li> <a href="#usage">Usage</a> <ul> <li><a href="#for-users">For users</a></li> <li><a href="#for-developers">For developers</a></li> </ul> </li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ol> </details> ## About The Project !(https://cdn.modrinth.com/data/DkOr2M32/images/70d32b52147ef1d0431ffc31bb2241a743eaeb91.png) fStats is a 3rd-party metric collection library. The Main idea is help developers to recognize their actual community based on charts <p align="right">(<a href="#readme-top">back to top</a>)</p> ## 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 ```json5 { "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 (https://fstats.dev/register) and create a project to get projectId After that, you are ready to add a library as/to dependency <details> <summary>Java - build.gradle</summary> ```groovy 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>" } ``` </details> <details> <summary>Kotlin - build.gradle.kts</summary> ```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>") } ``` </details> > fabric.mod.json ```json "suggests": { "fstats-api": "*" } ``` Setup project > fabric.mod.json ```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 (https://fstats.dev) Also, recommend adding the badge to your project description to notify users that you collect information. *Resize badge to any size that you want* !(https://cdn.modrinth.com/data/DkOr2M32/images/597e8bc81f48ad606ae5624f566994dde65ac409.png) <p align="right">(<a href="#readme-top">back to top</a>)</p> ## Roadmap See the (https://github.com/fstats/fstats-api/issues) for a full list of proposed features (and known issues). <p align="right">(<a href="#readme-top">back to top</a>)</p> ## 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 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request <p align="right">(<a href="#readme-top">back to top</a>)</p> ## License Distributed under the MIT License. See `LICENSE.txt` for more information. <p align="right">(<a href="#readme-top">back to top</a>)</p> : https://img.shields.io/github/contributors/fstats/fstats-api.svg?style=for-the-ba

[!] [!] [!] [!] [!] [!] [!] [!]

fStats

Fabric metric system for developers

Support · Report Bug · Request Feature

Table of Contents

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

## About The Project

!(https://cdn.modrinth.com/data/DkOr2M32/images/70d32b52147ef1d0431ffc31bb2241a743eaeb91.png)

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)

### 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 ```json5 { "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 (https://fstats.dev/register) and create a project to get projectId

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

Java - build.gradle

```groovy 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:")

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

Kotlin - build.gradle.kts

```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", ""))

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

> fabric.mod.json

```json "suggests": { "fstats-api": "" } ```

Setup project

> fabric.mod.json

```json "custom": { "fstats": } ```

Done, now when any server uses your mod, and if they don't disable fStats, you are going to get data about that on (https://fstats.dev)

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

Resize badge to any size that you want* !(https://cdn.modrinth.com/data/DkOr2M32/images/597e8bc81f48ad606ae5624f566994dde65ac409.png)

(back to top)

## Roadmap See the (https://github.com/fstats/fstats-api/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 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request

(back to top)

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

(back to top)

: https://img.shields.io/github/contributors/fstats/fstats-api.svg?style=for-the-ba