About PurgeFX
This plugin automates purge scheduling for Rust servers based on a configurable schedule. It determines purge start times using the specified weeks and days in the config and automatically unloads selected plugins during the purge, with built-in checks to ensure persistence after server restarts. Notifications can be sent via chat or the Notify plugin, with customizable colors and formatting. If wiping isn't required, the plugin reloads specified plugins when the purge ends.
It supports time zone customization or defaults to the server time zone, automates wipe commands using Oxidation Wiper, and integrates with SimpleStatus to display an active purge indicator above players' health bars. It also supports the Sound Library API for playing sounds on purge start and allows manual control with customizable chat and console commands.
Some features this offers:
Automated Purge Scheduling
- Set purges to run automatically on specific days and weeks of the month.
- Customize start and end times to match your server’s schedule.
- Force start or end purges anytime using /purge and /endpurge commands.
Player Notifications & Messaging
- Display upcoming purge start, end, and server wipe times, all calculated automatically.
- Fully customizable message colors and notification formatting.
- Send Discord alerts when purges start and end.
Plugin & Server Management
- Choose which plugins to disable during purges and reload afterward.
- Supports Oxidation Wiper for fully automated server wipes.
- Set a custom time zone or default to the server’s time zone.
Enhanced Player Experience
- Works with SimpleStatus to display an active purge indicator above health bars.
- Supports Sound Library API to play audio alerts when a purge starts.
Permissions System
- Permissions apply only to the /purge and /endpurge commands.
- Uses Oxide's permission system for managing access.
- Grant permissions with: `oxide.grant <user or group> <name or steam ID> purgefx.purge`.
- Remove permissions with: `oxide.revoke <user or group> <name or steam ID> purgefx.purge`.
Attached is an example config.
*AFTER THE FIRST LOAD UP YOU HAVE TO CHANGE THE DATES AND TIMES IN THE DATA FILE TO MATCH WHAT YOU HAVE IN THE CONFIG AFTER THAT IT WILL RECALCULATE AND UPDATE THEM FOR YOU.
{ "Discord Webhook Purge Start Message": " **Purge is now active! Prepare for chaos!** ", "Discord Webhook Purge End Message": " **Purge has ended! The world is safe again... for now.**", "Use @everyone in Discord Webhook": true, "Discord Webhook URL": "", "Custom Time Zone (Use abbreviation or full name leave it blank for default server time zone Ex:CST or Central Standard Time)": "", "Console command for Purge": "purge", "Chat command for Purge": "purge", "Console command for force wipe, will enter this command for you on server force wipe day and time": "wipe forced", "Console command for other wipes, will enter this command for you on mid month or weekly wipe day and time": "wipe weekly", "List of plugins that will be unloaded on purge start": [ "SmoothRestarter", "PreventLooting", "TruePVE" ], "Prefab name to play on purge start": "assets/bundled/prefabs/fx/invite_notice.prefab", "Weeks of the month, when the purge will run": [ 1, 3 ], "Days of the week, when the purge will run": [ "Thursday" ], "Days of the week for purge to end": [ "Thursday" ], "Weeks of the month for purge to end": [ 1, 3 ], "Days of the week for server wipe": [ "Thursday" ], "Weeks of the month for server wipe": [ 1, 3 ], "Purge Start Hour, must be 24-Hour Time": 1, "Purge Start Minute": 25, "Purge End Hour, must be 24-Hour Time": 1, "Purge End Minute": 28, "Server Wipe Hour, must be 24-Hour Time": 2, "Server Wipe Minute": 17, "Use 24-Hour Time Format For Chat": false, "Date Format for Chat": "MM/dd/yyyy", "Sound Library API support. To play original Sound prefab, leave it empty. Example command: audio.message sendall fileName ": "", "Auto Display Interval (minutes)": 60, "Display Purge Start Date in Chat": true, "Display Purge End Date in Chat": true, "Display Server Wipe Date in Chat": true, "Hex Color for Purge Start Message": "#FFA500", "Hex Color for Purge End Message": "#FF4500", "Hex Color for Server Wipe Message": "#008000", "Chat Prefix for Purge Messages": "[PurgeFX]", "Hex Color for Chat Prefix": "#FFA500", "Use SimpleStatus Plugin": true, "SimpleStatus Color": "0.77255 0.23922 0.15686 1", "SimpleStatus Title": "Purge Is Currently Active!", "SimpleStatus Title Color": "1 1 1 1", "SimpleStatus Icon": "assets/icons/warning.png", "SimpleStatus Icon Color": "1 1 1 1", "Use Notify Plugin for Messages": false, "Notification Type for Notify Plugin": 0, "Custom Command for Purge Time Reminder": "purgetime", "Chat command for End Purge": "endpurge", "Console command for End Purge": "endpurge" }
