RustSurvivor docs

RustSurvivor is a Rust+ companion that never logs off. It connects through the official Rust+ companion feature (the same one the Rust+ app uses) and stays connected when you are offline.

• Answers team-chat commands like !pop and !turrets on.
• Sends Smart Alarm raid alerts to the dashboard, team chat, Discord and Telegram.
• Lets you control your base, see the live map and track your team from any browser, on phone or PC.
• Answers Rust questions with its own AI, in game (!ai), in Discord (/ai) and on the website.

It never asks for your Steam password; you sign in with Steam's official login. RustSurvivor is a community project and is not affiliated with Facepunch or Valve.

1. 1Go to rustsurvivor.com/start and sign in with Steam.
2. 2Link your Discord account when asked. Every account needs Discord linked.
3. 3Install the browser extension. It connects your Rust+ companion login (needed once).
4. 4Join your Rust server, open the Escape menu → Rust+ → Pair Server. The server appears in your dashboard automatically.
5. 5Pair your devices: look at a Smart Switch, Smart Alarm or Storage Monitor, hold E and choose Pair.
6. 6Open the dashboard at rustsurvivor.com/app (Pro or trial) and you are set.

No Pro yet? Try everything free for 24 hours at /freetrial.

The first time you open the dashboard, a short tour shows where everything is: Servers, Discord bot, Telegram, Trackers, Team stats, Workflows, Settings, the tools, Ask AI and your plan. The first time you open a server panel, a second tour shows the header, Team link, Chat, Devices, Automation, Timers, the map tools, the right-hand tabs, Connect apps and Settings.

• Move with Next and Previous (or the arrow keys). Skip or Esc closes it.
• Each tour shows once, on its own, the first time. Skip, Esc or leaving the page ends it for good, on every device.
• Replay it any time with the small tour button (graduation cap) at the top right of the dashboard or the server panel. The account menu → Take the tour works too.
• The Get set up checklist on Overview tracks the first steps: pair a server, link Discord, add the bot, link Telegram (Pro or Beta), set up raid alarms, track a player, set your base zone and try a workflow (Pro). Each item ticks itself when it is done, and Show me takes you there.
• Hide or dismiss the checklist any time; account menu → Setup checklist brings it back.

The RustSurvivor extension links your Rust+ companion login so pairings from the game reach your account. You only need it during setup.

Looking for the BattleMetrics/Steam player panel? That is a separate free extension: SmartIntel.

• Server: in-game, Escape → Rust+ → Pair Server. You can pair as many servers as you like; each has its own settings.
• Devices: look at a Smart Switch, Smart Alarm or Storage Monitor, hold E → Pair. It shows up in the dashboard and in commands.
• Names matter: a switch named “turrets” can be controlled with !turrets on. Rename devices in the dashboard or the Rust+ app.
• After a wipe: devices reset. Pair the server again if it shows offline, then pair your devices again.
• Pairing the same server again (same IP and port, even after removing it) keeps everything: devices, map notes, farm routes, trackers, settings, Discord links, shared map links, team sharing, workflows, timers, base zone and wipe history move to the server, without duplicates. You get a notice like “Re-paired: kept 12 devices, 4 notes, 2 routes, 9 trackers and settings”.

Always-online bot, raid alerts to Discord and Telegram, smart switch/alarm/storage control, live map, team status, death log, raid history, player trackers, team-chat commands, workflows, Team Sharing, the Discord bot channels (live team chat included), the RustSurvivor AI and the full Player Intel in SmartIntel.

When a paired Smart Alarm triggers you get a popup on the dashboard (with an optional siren), a team-chat message, a Discord ping and a Telegram alert. Wire the alarm in-game (for example to an HBHF sensor or turret) and pair it with hold E → Pair.

Every alarm setting is in one card: Settings → 🚨 Smart Alarm (the same card is in a server's Settings). Turn each place on or off: In game (team chat), Discord (with Ping on raids: None, @here or @everyone, and Read raid alerts aloud (Discord TTS)), Telegram and This website (the raid popup, with Alarm sound). Below that is online raid mode, then Your alarms: each paired alarm with Rename (its name and the message your team sees), Sound and Test. In Discord, the 🚨 Smart Alarm group in #settings has the same switches. In game, !alarms lists your alarms and !alarm <name> shows one.

Online raid mode (Pro): alarms keep going off and nobody on the team is online? After the normal Discord alert, a loud Telegram alert that repeats and a last Discord ping (after 5 minutes by default). With 📞 Phone call on (off by default), still nobody answering gets a real phone call the same number of minutes later: a voice reads the alarm and server name twice, and pressing 1 says you're on it (like I'm on it on Telegram, it stops the escalation and tells your team). Calls go out on your own call provider account: under Set up phone pick Twilio,Telnyx or Plivo and paste its keys and the phone number you got there (the card shows the steps for each; the provider bills you per call). RustSurvivor checks them with the provider, saves them encrypted on your account only and never shows them again (only a masked ID); nobody else's calls use them. Then add your own number: international format (like +447700900123), a consent box, Send test call and type the 4-digit code it reads. Only the server owner and Team Sharing teammates who set this up on their own account are called. At most 1 call per 10 minutes per server and 6 a day per account. Phone calls are part of Pro (Beta and the trial see it locked); Remove keys and Remove number delete them at once.

Alarm sound: pick the popup sound (Siren, the default, Klaxon, Triple beep, Rising sweep, Buzzer or Chime), whether it loops until someone taps I'm on it or Dismiss (on by default, up to 60 seconds) and the volume, with a Preview button. That is your default for every alarm; Sound on one alarm in Your alarms gives it its own. When anyone taps I'm on it in the popup or on the Telegram alert, the siren stops on every teammate's open server page and the popup shows who took it. Telegram plays its own sound (/sound in the Telegram bot).

Every alert shows when the alarm really went off, for example fired 21:04:12, 2s ago (team chat and Telegram in UTC, this website in your own time, Discord in each reader's time), and delivered 40s late when the push was slow. After a reconnect or a restart an alarm that was already delivered is never sent again.

Add the bot and run /install (see Discord bot). Raids and alarms go to #alerts (raids ping @everyone by default; pick None, @here or @everyone in the 🚨 Smart Alarm settings). Turn on Read raid alerts aloud (Discord TTS) there and Discord reads each raid alert out loud, for example “Raid alarm, Main base, Rusty Moose”, at most once every 30 seconds per server (off by default; the bot needs the Send Text-to-Speech Messages permission). Team updates go to #activity, tracked players to #tracker. Every message names the server it came from. Turn Discord notifications on or off in Settings.

Write the main alerts in your own words in Settings → ⚙️ Advanced → ✏️ Alert messages (also in a server's Settings): Smart alarm, Online raid (nobody online), Teammate online, Teammate offline, Teammate died, Timer finished, Timer reminder and TC decay. Pick the alert, type your text and use placeholders such as {name}, {player}, {grid}, {server}, {time}, {count} and {message} (each alert lists the ones it fills, with buttons to insert them). A live preview shows it with sample values; Reset to default brings back the usual text.

One text per alert is used in team chat and as the Discord alert text (the Discord title stays). Set it for All servers or for one server; a server's own text wins. Up to 200 characters; @everyone, @here and role or user mentions are removed; an unknown {word} stays as it is; an empty or broken text falls back to the usual one. In game, long text is split into several team chat lines. In Discord, the ✏️ Alert messages message in #settings changes the All servers text. Telegram keeps its own alert cards.

Telegram alerts are part of Pro and the open beta (staff too). The free trial and the free plan don't include them. A chat linked before you lost Pro or Beta stays linked but paused: no alerts until you have Pro or Beta again, then it starts by itself. You can still unlink it any time.

1. 1Open rustsurvivor.com/app?tab=telegram (or the Telegram bot tab in the dashboard, or Connect apps → Telegram bot on a server page) and tap Open Telegram. On a computer, use QR for phone and scan it.
2. 2Press Start in the @RustSurvivor_bot chat. The page switches to Linked on its own.
3. 3Tap Send test alert (or send /test to the bot) to check it arrives.

Raid alarms are sent with sound and repeat every minute (up to 5 times) until someone taps I'm on it. Telegram follows your phone's silent mode; for a real phone call, turn on 📞 Phone call in Online raid mode (Pro, see Smart Alarms). Repeat triggers during one raid update the same message with a counter instead of sending a new one. Your Team Sharing teammates get the alerts too once they link their own Telegram. Use a team group sends a server's alerts to a Telegram group so the whole team wakes up, and anyone in the group can tap I'm on it or mute.

Choose what you get on the website or with /alerts in the bot (same switches): raid alarms, online raid alerts, TC decay, team deaths, tracked players, clan radar, team online/offline, AFK, workflow alerts, wipes, connection lost and the weekly digest. Urgent ones are loud and repeat; wipes, online/offline, AFK and the digest arrive silently. /mute 1h pauses everything (raid alarms included), /unmute turns it back on. During Online raid mode, I'm on it on the Telegram online raid alert also stops the escalation.

Make raid alerts sound like an alarm. Set our raid alarm tone as the bot chat's notification sound:

1. 1Send /sound to the bot (or tap Send alarm sound on rustsurvivor.com/app?tab=telegram). You can also play or download the tone there.
2. 2Long-press the audio message (Android: its ⋮ menu) → Save for notifications.
3. 3Tap the chat's name → Notifications → Sound → pick RustSurvivor Raid Alarm.
4. 4Optional: let Telegram break through Do Not Disturb. iPhone: Settings → Focus → your Focus → Apps → add Telegram. Android: Settings → Notifications → Telegram → Override Do Not Disturb (or priority).

This only changes the sound of the RustSurvivor bot chat. A team group needs the same steps inside the group.

What an alert looks like. The first line says what happened and which alarm (RAID ALARM · Main base), the second where and when (grid, server, time), so the phone notification alone tells you enough. Every alert has buttons: I'm on it (stops the repeats and tells the team, in the group and in each teammate's chat, who has it), Mute 1h, Open map (the server's live map) and Server status (a popup with players and who is online, nothing posted in the chat).

Menu. Send /menu (or /start once linked) for one message with buttons: Status, Servers, Alerts on/off, Mute, Test alarm, Alarm sound, Account and Help. Each button updates that same message instead of sending new ones. In a chat that isn't linked yet the bot answers in one line with a Link this chat button that opens the website with the code filled in.

Bot commands: /menu, /status, /alerts, /mute, /unmute, /test, /team, /servers, /sound (our raid alarm tone for the chat's notification sound), /unlink, /help. Telegram's command menu shows them in your app's language. If the card says Bot blocked, open the bot and tap Restart (or add it back to the group), then send a test.

The bot can post in team chat when alarms trigger, switches change, teammates respawn, join, leave or go AFK, tracked players come online and when Tool Cupboard upkeep runs low. Pick exactly which ones in Settings.

• Use team chat, not global chat.
• The default prefix is !. You can change it in Settings; then use your prefix instead.
• <value> means required, [value] means optional.
• Type !help in-game for the short list.

• In game: type !ai <question> in team chat, e.g. !ai how many rockets for an armored door.
• Discord: /ai question:<anything>. Add private:true to see the answer alone.
• Website: the Ask AI button on the dashboard and in each server's live panel. In the panel it knows that server's players, wipe and time.
• Team Stats: Summarize writes a short summary of your team's verified stats.

Raid costs, crafting, recycling, research, stack sizes, decay and upkeep come from real Rust data, not from the AI's memory. A question that names an explosive and a target, like !ai how many c4 for a stone wall, is answered straight from that data. Tips and general questions come from a small AI model and can be wrong, so double-check anything important.

Questions a day, shared between !ai, /ai and the website:

• Pro: 100.
• Free trial: 20.
• Teammates of a Pro player (on their server or in their Discord): 25.

The owner chooses whether teammates can use !ai in game and how many questions each teammate gets per hour (1, 3, 5, 10 or unlimited; 5 by default), under Settings, Ask AI, or in Discord #settings. The owner and staff are never limited by these.

Type !ai on its own to see what is left. It resets at 00:00 UTC.

• Speak a question: tap the mic next to Send in the Ask AI panel. What you say appears in the box and you can edit it before sending; listening stops by itself when you go quiet.
• Push-to-talk: on a computer, hold Space while the question box is empty. On a phone, press and hold the mic. Listening stops when you let go.
• Send automatically when I stop talking: a switch under the box, off by default.
• Read answers aloud: the speaker button in the panel header (off by default, remembered on that device). Every answer also has a Listen button to replay it, and Stop ends it. Reading stops when you close the panel or ask something new.
• Language: the mic listens in your saved translate language, else your browser language. Answers are read with a voice in the answer's language.
• Browsers: voice input works in Chrome, Edge and Safari (Firefox has no speech recognition; the mic is greyed out). Reading aloud works in all of them.
• Second screen: open a server's live panel on your phone while you play and tap the mic in Ask AI.
• Privacy: your browser or phone turns speech into text with its own speech service (in Chrome that can be Google's). RustSurvivor never receives or stores audio, only the text you send.
• Mic blocked? Allow the microphone for this site from the icon left of the address bar, then tap the mic again.

1. 1In the dashboard open the Discord Bot tab and click Add bot to server. On a server page the Connect apps tab → Discord bot walks you through the same steps for that server.
2. 2In your Discord server run /install (Pro). It creates a RustSurvivor category with the channels below, shared by all your servers.
3. 3Let other people see the channels with /role add (or pick a role in /install). By default only you and the bot can see them.

The Discord Bot tab shows how many Discord servers your plan allows and, for each Discord server with the bot, which game servers post there, whether /install ran, which channels exist or are missing, the access role and any bot permission or role order problem. The Connect apps tab on a server page shows the same for that one server.

Only the person who installed the bot in a Discord server can run /install, /uninstall and /clear there, and only they see the #settings channel.

One set of channels for all your servers. Every message shows which server it comes from.

• #information: bot status, your plan and a guide to the channels. Every Tuesday the Weekly report of each server lands here too: raids on your base, team deaths and active teammates of the week before (turn it off in Settings → Discord → Weekly report).
• #servers: one live message per server with players, time, wipe, the map and your team (online, AFK, dead, offline, map grid and Steam profile links).
• #team-chat: live team chat. Your team's in-game chat appears here, and anything you write is sent to the team in game. Reply to a line to send to that server only; !commands work here too.
• #clan-chat: your in-game clan with its name, MOTD, score and every member (online status, role, Steam profile), plus every clan chat message live. Write here to talk in clan chat.
• #switches: every smart device per server with on/off buttons, Rename and Pair device. New devices show up as soon as you pair them.
• #activity: teammates coming online or going offline, deaths, AFK, joins and leaves.
• #tracker: a live list of every player you track (online first, with the server they play on and when they were last seen), plus an alert each time one comes online or goes offline. Add players with /tracker add or the Trackers tab.
• #alerts: raids and Smart Alarms with @everyone and the alarm's in-game details, storage and wipes.
• #settings: every setting from the website's Settings page as buttons (on/off), menus (language, command prefix, where bot messages go…) and ✏️ editors (AFK time, message delay). A change shows up on the website and in game right away, and website changes update here. Only the person who installed the bot sees this channel and can change them.

Members can read every channel except #settings (installer only); only #team-chat and #clan-chat accept messages. Buttons work everywhere.

In the RustSurvivor Discord, roles follow your plan automatically:

• Free Trial when you start the trial, Pro when your payment goes through.
• Free Trial Expired / Pro Expired when it ends (the active role is removed).

Roles only work if your Discord is linked on rustsurvivor.com and you are in the RustSurvivor Discord.

1. 1Open the Team Sharing tab in the dashboard and pick a server. Only the server owner can share.
2. 2Add a teammate by SteamID64 (17 digits) or pick them from your in-game team.
3. 3Choose Manager or Viewer.

Teammates who are in your in-game Rust team can also get Viewer access automatically when they open the server link.

• Manager: can use live tools and control smart devices, chat and settings.
• Viewer: read-only. Can watch the map, team and devices but cannot toggle anything or create automations.

Sign in at rustsurvivor.com with the Steam account that was invited, link Discord, then open rustsurvivor.com/shared. No Pro needed.

The owner can change roles or remove people at any time. Removal is immediate and the person is not re-added automatically. Deleting a server removes everyone's access to it.

Go to Settings → ⚙️ Advanced, card 🔌 API & Home Assistant, and press Create token. The token starts with rs_ and is shown once: copy it then. After that only its last 4 characters are shown. We store only a hash of it.

• read: servers, devices and recent alarms. control (the "Can switch devices" switch): also turn smart switches on and off.
• Up to 5 tokens per account, 60 requests a minute per token (then HTTP 429 with Retry-After).
• Revoke a token any time: it stops working at once.
• Team Sharing works as on the website: a Viewer can read the server but never switch, even with a control token.

Base URL https://rustsurvivor.com/api/v1, header Authorization: Bearer rs_…, JSON in and out.

• GET /servers: your servers with id, name, online and players.
• GET /servers/{id}/devices: switches, alarms and storage monitors (entity id, name, type, state).
• GET /servers/{id}/devices/{entityId}: one device.
• POST /servers/{id}/devices/{entityId}/switch with {"state": "on"} (or off, toggle). Needs the control scope.
• GET /servers/{id}/alarms/recent: the last smart alarm triggers.

curl -X POST https://rustsurvivor.com/api/v1/servers/SERVER_ID/devices/12345678/switch \
  -H "Authorization: Bearer $RUSTSURVIVOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"state": "toggle"}'

Errors are JSON like {"error": "...", "code": "VIEWER"}. A switch goes through the same Rust+ path as the website, so the server must be connected.

Add up to 5 https URLs and pick events: smart alarm, online raid, teammate online/offline/died, switch changed, tracker online/offline, timer finished, server wiped. We POST:

{ "event": "smart_alarm", "serverId": "…", "serverName": "Rusty Moose",
  "data": { "alarmName": "Core alarm", "grid": "G7" }, "firedAt": "2026-10-26T20:15:00.000Z" }

• Each request has X-RustSurvivor-Signature: sha256=…, an HMAC-SHA256 of the body with the webhook's secret (shown once when you add it). Check it to know the request came from us.
• https only, port 443 or 8443, and a public address: home network and local IPs are refused.
• 5 second timeout, 3 retries. After 20 failed deliveries in a row the webhook is turned off; the card shows the last 20 deliveries and a Test button.
• Workflows can call a saved webhook too: action Call webhook.

1. 1Create a token with "Can switch devices" on.
2. 2In Home Assistant's secrets.yaml add rustsurvivor_token: "Bearer rs_…".
3. 3On the card pick a server and press Copy Home Assistant config: it fills in your server id and every switch. Paste it into configuration.yaml and restart.
4. 4For alarms add your Home Assistant webhook URL (for example your Nabu Casa address + /api/webhook/rustsurvivor_…) as a webhook on the card.

# RustSurvivor -> Home Assistant (Example)
# 1) secrets.yaml (keep the word Bearer and the space):
#      rustsurvivor_token: "Bearer rs_your_token_here"
# 2) Paste the blocks below into configuration.yaml and restart Home Assistant.

rest_command:
  rustsurvivor_switch:
    url: "https://rustsurvivor.com/api/v1/servers/YOUR_SERVER_ID/devices/{{ entity_id }}/switch"
    method: POST
    headers:
      Authorization: !secret rustsurvivor_token
      Content-Type: application/json
    payload: '{"state": "{{ state }}"}'
    # call it with: entity_id: 12345678, state: "on" | "off" | "toggle"

switch:
  - platform: rest
    name: "Base lights"
    unique_id: rustsurvivor_your_ser_12345678
    resource: "https://rustsurvivor.com/api/v1/servers/YOUR_SERVER_ID/devices/12345678/switch"
    state_resource: "https://rustsurvivor.com/api/v1/servers/YOUR_SERVER_ID/devices/12345678"
    method: post
    body_on: '{"state": "on"}'
    body_off: '{"state": "off"}'
    is_on_template: "{{ value_json.state == 'on' }}"
    headers:
      Authorization: !secret rustsurvivor_token
      Content-Type: application/json
    scan_interval: 60

# Alarms: add this webhook URL on rustsurvivor.com (API & Home Assistant card):
#   https://YOUR-HOME-ASSISTANT/api/webhook/rustsurvivor_your_ser
automation:
  - alias: "Rust raid alarm"
    trigger:
      - platform: webhook
        webhook_id: rustsurvivor_your_ser
        allowed_methods: [POST]
        local_only: false
    condition:
      - condition: template
        value_template: "{{ trigger.json.event in ['smart_alarm', 'online_raid'] }}"
    action:
      - service: notify.notify
        data:
          title: "Raid on {{ trigger.json.serverName }}"
          message: "{{ trigger.json.data.alarmName | default('Smart alarm') }} {{ trigger.json.data.grid | default('') }}"

Home Assistant's webhook trigger does not check our signature: keep the webhook id long and secret, as above.

• Alexa and Google: expose the RustSurvivor switches from Home Assistant to them (Nabu Casa or the manual integrations). We do not have our own Alexa or Google skill.
• IFTTT: use a Webhooks applet. As a trigger, add the IFTTT "Receive a web request with a JSON payload" URL as a webhook here. As an action, "Make a web request": POST to the switch URL with the Authorization header and {"state": "toggle"}.
• Stream Deck: the built-in "Website" action only opens a GET page, which cannot switch. Use a plugin that sends HTTP requests with headers (for example "API Ninja" or "Web Requests") and POST {"state": "toggle"} to the switch URL. Or press a Home Assistant button with the Home Assistant Stream Deck plugin.

SmartIntel is a free extension for Chrome and Firefox, no account needed. It adds a panel to BattleMetrics player pages and Steam profiles with ban flags, exact Rust hours, a 14-day activity chart, who the player plays with, and Steam ↔ BattleMetrics linking.

Free accounts see a stats summary; Pro unlocks the full Player Intel map. Notes and tags sync to your account. Data is never sold.

Get SmartIntel