Skip to content

Install the plugin

import { Steps } from ‘@astrojs/starlight/components’;

Check Prerequisites first if you have not. Then:

  1. Download Cerebrust.cs.

    It is one C# file and it downloads already named Cerebrust.cs. Keep that name and do not edit the file — Oxide matches the filename to the plugin, so Cerebrust.cs is the name it must keep. There is nothing to unzip.

  2. <your server>/oxide/plugins/Cerebrust.cs

    Oxide watches that folder and compiles the plugin as soon as the file appears — on most servers you do not even need to restart.

    Your console will show it loading and then complaining that it has no token:

    Loaded plugin CerebRUST v0.8.73 by Ruu Mouat

    That is the expected state at this point. The plugin is loaded and idle.

  3. The first load writes a config file:

    <your server>/oxide/config/Cerebrust.json

    Open it and paste in your ingest token:

    {
    "ApiBaseUrl": "https://api.cerebrust.xyz",
    "IngestToken": "crst_your_token_here",
    "verbose_logging": false
    }

    Only three settings here are yours to edit:

    Key Default What it does
    ApiBaseUrl https://api.cerebrust.xyz The CerebRUST API. Leave it alone
    IngestToken "" Your server’s token. Required
    verbose_logging false Very chatty diagnostic logging. Only for troubleshooting
  4. o.reload Cerebrust
  5. Watch the console for:

    CerebRUST ingest initialized.

    That is success. Your token was accepted, the server is bound to your account, and telemetry is flowing.

    If you see something else, go to Verify it is working and then Troubleshooting.

Once initialised, the plugin starts working on its own:

  • Sends a heartbeat every 15 seconds (FPS, players online, sleepers)
  • Reports player positions every 2 seconds while they are awake
  • Snapshots tool cupboards every 5 minutes
  • Uploads a render of your map — but only when nobody is online, since it is a big upload
  • Posts your monument list once
  • Reconciles your team roster and ban list a few seconds after startup
  • Polls CerebRUST every 2 seconds for any commands you have issued from the dashboard

You do not need to schedule or trigger any of this.

The token is a credential. Anything holding it can post data as your server.

  • Do not commit oxide/config/Cerebrust.json to a public repository
  • Do not paste it into screenshots, Discord or a support ticket
  • If it leaks, ask for a replacement in Discord

A token binds to the first server that uses it (its IP and ports). If you move your server to a new address, see Troubleshooting.