Table of Contents
fStats is a 3rd-party metric collection library. The Main idea of is help developers to recognize their actual community based on charts
Mod have config that allows to turn off a metric collection and hiding location
../config/fstats-api/config.json
v2
{
"version": 2, // Config version
"mode": "ALL", // Data collecting mode [ ALL | WITHOUT_LOCATION | NOTHING ]
"messages": {
"infos": true,
"warnings": true,
"errors": true
}
}v1
{
"enabled": true, // Enable/Disable collection from our server
"hideLocation": false // Mod not collect your IP, only country name
}Up-to-date guide can be found here: https://fstats.dev/getting-started
Also, recommend adding the badge to your project description to notify users that you collect information.
Resize the badge to any size that you want
fStats also has Image Generator for webpages or markdown including and UI editor for it
%%{
init: {
'theme': 'dark',
'themeVariables': {
'primaryColor': '#20242d',
'primaryTextColor': '#ffffff',
'primaryBorderColor': '#58a6ff',
'lineColor': '#7d8590',
'secondaryColor': '#20242d',
'tertiaryColor': '#20242d'
}
}
}%%
graph TD
subgraph " "
direction LR
subgraph "User Related"
Frontend("Frontend")
Minecraft("Minecraft Client")
end
subgraph "Core Infrastructure"
Backend("Backend")
end
subgraph "Data & Caching"
direction TB
Kafka("Kafka")
ClickHouse("ClickHouse")
PostgreSQL("PostgreSQL")
Dragonfly("Dragonfly (Redis cache)")
ImageGenerator("Image Generator")
end
end
%% Connections
Frontend -- "REST API" <--> Backend;
Minecraft -- "Metric POST" --> Backend;
Backend -- "Metric POST" --> Kafka;
Backend -- "Primary Database" <--> PostgreSQL;
Backend -- "Metric REST" --> ClickHouse;
Kafka -- "Kafka Engine" --> ClickHouse;
Backend -- "REST" --> ImageGenerator;
ImageGenerator -- "Cache" <--> Dragonfly;
%% Styling
style Frontend fill:#161b22,stroke:#30363d,stroke-width:2px;
style Minecraft fill:#161b22,stroke:#30363d,stroke-width:2px;
style Backend fill:#161b22,stroke:#58a6ff,stroke-width:2px;
classDef data fill:#161b22,stroke:#30363d,stroke-width:2px;
class Kafka,ClickHouse,PostgreSQL,Dragonfly,ImageGenerator data;
See the open issues for a full list of proposed features (and known issues).
You can find the roadmap and related here: https://github.com/orgs/fStats/projects/1
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
fStats has many modules and all of them have different ways to localize, so check the table below to find the right guide.
| Module | Guide |
|---|---|
| Frontend | Link |
| Backend | Unsupported |
| Image Generator | Unsupported |
| Image Generator Editor | Link |
| Minecraft API | Link |
Distributed under the MIT License. See LICENSE.txt for more information.
