Install the agent for your game

Which install route each game uses (plugin, mod, sidecar or basic mode) and where the step-by-step guide is.

Getting startedUpdated 2 min read

Every agent connects out over HTTPS (port 443) and opens no ports on your server. Players install nothing. Pick your game below; the latest version, supported server versions and SHA-256 checksums of every download are on Agent versions.

GameHow it is installedGuide
Minecraft Java: Paper, Purpur, Folia, VelocityOne jar in plugins/, then serverstats claimPaper and Velocity
Minecraft modded: Fabric, NeoForge, ForgeA server mod jar; each Minecraft version has its own buildModded Minecraft
Minecraft BedrockEndstone pluginBedrock
HytaleOne jar in mods/Hytale
FiveM and RedMThe serverstats resource and two server.cfg linesFiveM and RedM
RustServerStats.cs for Oxide or CarbonRust
Garry's ModA Lua addonGarry's Mod
CS2, Unturned, 7 Days to Die, Space Engineers, Vintage Story, Valheim, V RisingA server plugin or mod for that gameeach game's page under Games
RobloxA server module with an experience keyRoblox
Palworld, Satisfactory, Terraria, SCUM, Project Zomboid, Squad, TF2, CS:S, L4D2, Conan Exiles, DayZ, Path of Titans, Arma ReforgerThe sidecar: one Linux binary next to the game serverSidecar guide
ARK: Survival Ascended, BeamMP, RAGE:MP, open.mp (beta)Sidecar plus a small game-side componentSidecar guide
Any game with a public queryBasic mode: nothing to installBasic mode

Roblox, ARK: Survival Ascended, BeamMP, RAGE:MP and open.mp are in beta. The Isle: Evrima and Assetto Corsa have no ServerStats agent yet; Assetto Corsa can use basic mode.

The pattern is always the same

  1. Download the file and, if you like, check it against SHA256SUMS (how to verify).
  2. Put it where the game loads plugins or mods, and start the server once.
  3. Run the game's claim command with the code from the wizard, or paste the code into the config and reload.
  4. Run the agent's status command to confirm the link, then watch the wizard's First data checklist.

Update, move or remove

Updating is a file replace: keep the agent's data folder, because it holds the key that keeps the server enrolled. Moving to a new machine needs a new claim code. To remove a server, delete the agent and then use Remove server in the server's settings. See update an agent.

Still stuck? Email [email protected] with the server name and what you see. For a rejected claim code or no data, include the output of the agent’s status command.