Skip to content

Commit fb83a28

Browse files
committed
Update README to include support for Fabric servers
1 parent 1561cd8 commit fb83a28

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,19 @@ ServerPulse is an **open-source**, real-time performance monitoring tool for Min
2222

2323
- **Goal:** Provide an extensible, lightweight plugin to gather server metrics and store them in InfluxDB for visualization with Grafana.
2424
- **Tech stack:**
25-
- Java (plugin) → InfluxDB
25+
- Java (plugin/mod) → InfluxDB
2626
- Grafana dashboard (preconfigured via provisioning)
2727
- Discord alerts for key server metrics
2828
- Docker Compose (for InfluxDB & Grafana setup)
2929

3030
## 🌟 Platform Support
3131

32-
ServerPulse now supports **all Minecraft server platforms** in the Bukkit/Paper ecosystem:
32+
ServerPulse now supports **all Minecraft server platforms** in the ecosystem:
3333

3434
- **Bukkit/Spigot**: Full support with custom TPS monitoring implementation
3535
- **Paper and its forks** (Purpur, Pufferfish, etc.): Enhanced support with native TPS monitoring
3636
- **Velocity**: Support for Velocity proxy servers (ofc TPS and world metrics are not available)
37+
- **Fabric**: Support for Fabric servers (latest versions of Fabric API and Minecraft)
3738

3839
The plugin automatically detects your server platform and uses the most efficient implementation available for that environment.
3940

@@ -42,7 +43,7 @@ The plugin automatically detects your server platform and uses the most efficien
4243
ServerPulse isn't just another metrics exporter - it offers several unique advantages:
4344

4445
- **Complete Monitoring Stack** - Fully integrated solution with InfluxDB (optimized for time-series data) and pre-configured Grafana dashboards
45-
- **Universal Platform Support** - Works with any Bukkit-based and Velocity server while taking advantage of Paper-specific optimizations when available
46+
- **Universal Platform Support** - Works with any Bukkit-based, Velocity and Fabric server while taking advantage of Paper-specific optimizations when available
4647
- **Per-World Analytics** - Track entity counts, chunk loading, and performance metrics separately for each world
4748
- **Flexible Tagging System** - Group and filter metrics by server, network, region, or any custom dimension through simple configuration
4849
- **Zero-Configuration Dashboards** - Auto-provisioned Grafana dashboards - no manual setup required
@@ -64,17 +65,17 @@ The wiki contains comprehensive documentation on:
6465

6566
## 📊 Comparison with Alternative Solutions
6667

67-
| Feature | ServerPulse | Generic Prometheus Exporters |
68-
|---------|------------|--------------------------|
69-
| Setup Time | ~5 minutes with Docker Compose | Manual metrics + Prometheus + Grafana setup |
70-
| Dashboard Configuration | Pre-configured, auto-provisioned | Manual dashboard creation |
68+
| Feature | ServerPulse | Generic Prometheus Exporters |
69+
|---------|--------------------------------------|--------------------------|
70+
| Setup Time | ~5 minutes with Docker Compose | Manual metrics + Prometheus + Grafana setup |
71+
| Dashboard Configuration | Pre-configured, auto-provisioned | Manual dashboard creation |
7172
| Data Storage | InfluxDB (optimized for time-series) | Prometheus (general-purpose) |
72-
| Platform Support | All Bukkit-based servers | Varies by implementation |
73-
| Per-World Metrics | Built-in | Usually not available |
74-
| Custom Tagging | Flexible tag system | Limited labeling |
75-
| Alert System | Discord and Telegram integration | Requires manual setup |
76-
| Infrastructure | Complete stack included | Manual integration required |
77-
| Health Monitoring | Automated health checks | Varies by implementation |
73+
| Platform Support | All Minecraft Servers | Varies by implementation |
74+
| Per-World Metrics | Built-in | Usually not available |
75+
| Custom Tagging | Flexible tag system | Limited labeling |
76+
| Alert System | Discord and Telegram integration | Requires manual setup |
77+
| Infrastructure | Complete stack included | Manual integration required |
78+
| Health Monitoring | Automated health checks | Varies by implementation |
7879

7980
## 🤝 Contributing
8081

0 commit comments

Comments
 (0)