Description

Raid Alerts: Real-Time Base Defense Notifications for Rust

Simple Plugin Preview:

Raid Alerts is an essential plugin for Rust, providing instant notifications when your base is under attack. With in-game alerts, Discord integration, and Clan compatibility, Raid Alerts ensures you’re always informed of any threats to your base, even if you’re offline.

Key Features:

• Instant Alerts: Immediate in-game notifications keep you informed the moment a raid begins.
• Clan Compatibility: Integrates with the Clans plugin to notify all authorized clan members of any raid, enabling coordinated defenses.
• Advanced Discord Integration:
• Personal Webhooks: Each player can register a unique Discord webhook, allowing notifications to be sent to their private Discord server.
• Clan Webhooks: Clan owners can set a clan-wide Discord webhook so that all members are alerted on a shared Discord server.
• Global Notifications: Server owners can specify a global webhook for all raid alerts.
• Embed Option: Configure alerts as embedded messages for rich visuals or simple text for minimalistic notifications.
• Note: Each player and clan can save one webhook at a time, allowing personalized or clan-specific Discord notifications.

Why Use Raid Alerts?

• Knowing your base is under raid as it happens is vital in Rust. Whether you’re farming resources or raiding another base, Raid Alerts keeps you connected, helping you act quickly to defend your assets.

Use Cases:

• Resource Gathering or Raiding: Rest assured you’ll be notified if your base is compromised.
• Monument Exploration: Raid Alerts informs you of any threats, so you can stay focused on looting.
• Clan Defense Strategy: Enable seamless coordination as Raid Alerts notifies all clan members, facilitating quick defenses.

Command Overview:

Example Usage:

To register a personal or clan webhook, only part of the webhook URL is required. Simply use the ID and token (as shown below) to configure alerts. The complete link is not necessary.

All Player And Clan WebHooks Are Automatically Saved And Dynamically Stored/Removed/Loaded From The Generated Config

Command Example

/registerpersonalwebhook 1300063659304947833/KxfSH7NFWd65HGfHSv9yBoLNj6rC1ISjU0zAjh0zoCBqCQUWipCDtTGYdMB8Nf6j5EO5

Discord Webhook URLs typically look like:

https://discord.com/api/webhooks/1300063659304947833/KxfSH7NFWd65HGfHSv9yBoLNj6rC1ISjU0zAjh0zoCBqCQUWipCDtTGYdMB8Nf6j5EO5

Commands:

Personal Webhook:

• /registerpersonalwebhook <webhook_id/token>: Register a personal webhook for individual alerts.
• /removepersonalwebhook: Remove your registered personal webhook.

Clan Webhook:

• /registerclanwebhook <webhook_id/token>: Clan owners can register a webhook for shared alerts among clan members.
• /removeclanwebhook: Clan owners can remove the registered clan webhook.

Default Configuration:

• On installation, a default configuration file is created in oxide/config, where you can adjust settings for notifications, Discord integration, and more.

{
"Main plugin settings": {
"Cooldown for sending notifications in the game [Seconds]": 120,
"Time after which the UI disappears [seconds]": 15.0,
"Which ShortName image will be used for the notification": "explosive.timed",
"Discord Global RaidAlert Webhook URL": "",
"Use Discord Embed for Notifications": true,
"Enable Discord notification cooldown (true/false)": false,
"Discord notification cooldown [seconds]": 30,
"Enable global message cooldown for each grid location (true/false)": false,
"Global message cooldown for each grid location [seconds]": 180,
"Personal RaidAlert Webhook URLs": {

"Clan RaidAlert Webhooks": 
}
},
"Config version": {
"Major": 1,
"Minor": 0,
"Patch": 5
}
}

Configuration Options:

• cooldownGame: Frequency of in-game notifications to prevent spamming (in seconds).
• destroyUi: Duration of in-game notifications on-screen (in seconds).
• imageNotify: Icon for in-game notifications (e.g., “explosive.timed”).
• discordWebhookUrl: Global webhook URL for sending alerts to Discord.
• useEmbed: true for embedded alerts with rich visuals; false for plain text alerts.
• personalWebhooks: Stores individual player webhook URLs for personal base alerts.
• clanWebhooks: Stores clan webhook URLs for shared alerts.

Stay informed and ready with Raid Alerts 1.0.2! Whether playing solo or as part of a clan, this plugin provides essential notifications to help you respond to any threats, ensuring your base’s security.