Raid Alarm

01Premium

02What it does

Every player who signs up gets their own 4 digit code. They put an RF Broadcaster in their base on that frequency and wire it so it goes off when they're hit. Within a few seconds of that code starting to broadcast, Surge posts your raid message in your Discord and pings the player.

The message is sent 5 times, 3 seconds apart, so it's hard to miss. After that, the bot waits 10 minutes before alerting on that code again, so a long raid doesn't spam your channel.

03Setting it up

1. 1Link this server's Discord from Management > Discord Integration > Overview. You get a code to use with the /install command in Discord. Do this on each Rust server, even if they share one Discord.
2. 2Add the Surge bot to your Discord if it isn't there yet. The panel shows an Add Bot button when it's missing.
3. 3Open Features > Raid Alarm and pick an announcement channel. The bot needs to be able to see the channel, send messages and post embeds there. Channels it can't post in are greyed out.
4. 4Save. The bot posts "Raid Alarms are Linked to the discord Successfully" in the channel so you know it worked.
5. 5Flip the Raid Alarm switch on.

04How players use it

1. 1Join your Discord.
2. 2Open Raid Alarm on their player dashboard, give the alarm a name (up to 32 characters) and get their code.
3. 3Place an RF Broadcaster at their base, set it to that code, and wire it to go off when they get raided.

• Each player gets one alarm per server.
• No two players on the same server ever share a code.
• A code lasts 15 days. After that it expires and the player needs to grab a new one and update their broadcaster.
• Refresh gives a new code. The old one is held back for 24 hours so nobody else gets it straight away.
• Players can refresh or remove their alarm up to 5 times a day.

Codes run from 1000 to 9999. Oil rig frequencies and a few other reserved ones are never handed out and never set off an alarm.

05The announcement message

Pick Embed (the default) or Normal text. The live preview on the right shows exactly what Discord will show.

• {discordname}: the player. Required. It pings them in the text message, and in the embed description and field values.
• {servername}: your server name. Required.
• {alarmname}: the name the player gave their alarm. Optional.

In Normal text mode you get one message up to 2000 characters, and Discord formatting like bold and *italic* works.

In Embed mode you can set the colour, title, title link, description, author (name, icon and link), a thumbnail and a large image, a footer with an icon, a timestamp, and up to 10 fields. The default is a red embed titled "You Are Getting Raided" with the player and server in the description.

Short server name is what {servername} turns into. Up to 40 characters. Leave it empty and Surge picks a short version of your server's name for you.

06Status and troubleshooting

The Status box shows whether the bot is watching, when it last checked, how many codes are active, and the last raid alert. If posting an alarm failed, the reason is shown there.

• Paused means your Discord isn't linked any more, the bot was removed from it, or the linked Discord changed.
• Server offline means the bot lost its connection to your game server. It starts watching again by itself when it reconnects.
• If your linked Discord server changes, you have to pick the announcement channel again.
• Saving with no channel selected turns Raid Alarm off.

07Good to know

• The alarm only fires if the broadcaster actually transmits, so it's on the player to wire it up properly. Tell them to test it.
• Remind players to refresh their code before the 15 days are up, or the alarm goes quiet.
• The bot checks that a player is in your Discord before it hands out a code, so the invite link really matters.