| Game | Status command | Config file | Usual cause when it does not connect |
|---|---|---|---|
| Minecraft: Paper, Purpur, Folia | serverstats status in the console | plugins/ServerStats/config.yml | Host blocks outbound 443; code typed in the config but the server not restarted |
| Minecraft: Velocity | serverstats status | plugins/serverstats/config.yml | The proxy needs its own claim code, separate from the backends |
| Hytale | /serverstats status | mods/ServerStats_ServerStats/config.yml | Outbound 443 blocked; plugin failed to load after a Hytale update |
| FiveM, RedM | serverstats status in the server console (not in-game chat) | server.cfg lines set serverstats_claim and ensure serverstats | Used sets or setr instead of set; resource folder not named serverstats |
| Rust: Carbon, Oxide | serverstats.status in console or RCON | carbon/configs/ServerStats.json or oxide/config/ServerStats.json | Plugin did not compile (framework out of date); status shows Paused |
| Sidecar games | serverstats-sidecar check -c /etc/serverstats/serverstats-sidecar.yml | serverstats-sidecar.yml | Game API disabled or password file unreadable by the serverstats user |
Minecraft
- Spigot and CraftBukkit are not supported; the plugin uses Paper-only APIs. BungeeCord and Waterfall are not supported either; Velocity is.
- Use a normal restart, not
/reloador a plugin manager. - On Folia there are no per-tick lag spikes; that is expected.
FiveM and RedM
- Pick the right game when creating the server; they have separate metric sets.
- Framework metrics need the standard resource names (
qbx_core,qb-core,es_extended,vorp_core,rsg-core,ox_inventory).serverstats statuslists what it detected. - A refused claim is not retried. Put a new code in
serverstats_claimand runensure serverstats, or runserverstats claimwith it.
Rust
- If the plugin does not compile, update Carbon or Oxide first, especially after a forced Rust update.
- If a wipe script deletes
carbon/dataoroxide/data, it deletes the agent's key; claim again. - If a typo breaks the JSON, the plugin runs on defaults and does not overwrite your file.
Hytale
Skipping pack at ServerStats_ServerStats: missing or invalid manifest.jsonat startup is harmless.- The plugin targets Hytale server API 0.6.8; after a Hytale update, check Agent versions for a newer build.
Sidecar games
- The sidecar runs on the same Linux machine as the game server and only reads local interfaces. A game API on a non-loopback address is refused unless
allow_remote_api: true. - Palworld: enable the REST API and set an admin password, and keep port 8212 closed in your firewall.
- A new claim code on a running sidecar is picked up within 5 seconds:
sudo -u serverstats serverstats-sidecar claim SS-XXXX-XXXX-XXXX -c /etc/serverstats/serverstats-sidecar.yml. - A panel-only host with no shell cannot run the sidecar; use basic mode.
Per-game install pages with the full steps: install by game.