GameSentry plugin

The GameSentry plugin runs on your Rust server. It sends player stats, leaderboards, server events and live map data to GameSentry, and powers in-game tools like chat commands. It installs in the HarmonyMods folder, so it works on a vanilla server and next to Oxide or Carbon.

Before you start

• The server is added and claimed by your organization in GameSentry.
• You can manage the server. Creating API keys needs the Manage API keys permission and a plan with API access.
• You can copy files to the server and restart it.

Install it

1. 1

   In GameSentry, open the server and go to Extensions, then GameSentry plugin. Select Download latest build. If there is no build yet, get the file from the GameSentry Discord.

2. 2

   Copy GameSentry.dll into the HarmonyMods folder of your Rust server.

3. 3

   On the GameSentry plugin page, select Create API key under Plugin config. It creates a key with only the GameSentry plugin permission and shows it once, with the whole config filled in. Copy the config right away, because the key is shown only once. You can also create the key under Organization, then API keys, with the GameSentry plugin permission.

4. 4

   Put the config in HarmonyMods/GameSentry/config.json on your server. Create the folder and the file if they are not there yet, or start the server once and the plugin creates them.

5. 5

   Start the server. Harmony mods only load when the server starts, so a reload or an RCON command will not pick up the plugin.

What goes in config.json

Both fields sit inside a GameSentry section, exactly as the plugin page shows them. Nothing else goes in the file: tracking, chat, leaderboards and updates are set on the plugin page, and the plugin gets its license from GameSentry every time it connects. A longer config.json from an older plugin version still works, and you can replace it with the short one.

Check that it works

The server console logs Authenticated successfully, followed by your license. On the GameSentry plugin page, select Test connection. The status changes to Connected.

If it does not connect