About Quarry Notification
Overview
The Quarry Notification plugin for Rust is a plugin designed to enhance the gameplay experience by providing detailed notifications and map markers for specific quarry activities. This plugin is ideal for server administrators looking to keep players informed about quarry statuses and activities in real-time.
Features
Real-Time Notifications
- Activation Alerts: Receive notifications when a quarry is activated.
- Player Identification: Identify the last player who toggled the quarry.
- Grid Positioning: Get precise grid positions of activated quarries.
Customizable Markers
- Individual Quarry Settings: Configure markers for Sulfur, Stone, and High-Quality Metal quarries independently.
- Marker Attributes: Adjust alpha, radius, center color, ring color, and duration for each quarry type.
Configurable Advice Messages
- Interval Settings: Set the interval for periodic advice messages.
- Custom Message Formats: Personalize the format of notification messages.
Configurable Options
General Settings
- Permission for Chat Commands: Control access to chat commands (quarrynotification.use).
- Permission for Admin Commands: Restrict access to admin commands (quarrynotification.admin).
- SteamID Icon: Set the SteamID icon for chat messages.
- Enable Advice Messages: Toggle periodic advice messages.
- Advice Timer: Configure the interval for advice messages (in seconds).
- Notification Format: Customize the format of activation notification messages.
Quarry-Specific Marker Configurations
-
Sulfur Quarry
- Enable Markers: Toggle markers for Sulfur quarries.
- Alpha: Set marker transparency (0.0 - 1.0).
- Radius: Define marker radius.
- Center Color: Choose the center color of the marker (hex code).
- Ring Color: Set the ring color of the marker (hex code).
- Duration: Determine how long the marker stays on the map (in seconds).
-
Stone Quarry
- Enable Markers: Toggle markers for Stone quarries.
- Alpha: Set marker transparency (0.0 - 1.0).
- Radius: Define marker radius.
- Center Color: Choose the center color of the marker (hex code).
- Ring Color: Set the ring color of the marker (hex code).
- Duration: Determine how long the marker stays on the map (in seconds).
-
High-Quality Metal Quarry
- Enable Markers: Toggle markers for HQM quarries.
- Alpha: Set marker transparency (0.0 - 1.0).
- Radius: Define marker radius.
- Center Color: Choose the center color of the marker (hex code).
- Ring Color: Set the ring color of the marker (hex code).
- Duration: Determine how long the marker stays on the map (in seconds).
What's New and Improved
New Features
- Spam Prevention: Added protections to avoid chat spam, including limits on how often notifications can be sent and cooldown periods.
- Quarry Status Tracking: The plugin now tracks whether a quarry is active or inactive, with notifications for when a quarry is turned on or off. You can also check the status using commands.
- Discord Notifications: You can now send notifications to a Discord channel with detailed quarry activity updates, including visually enhanced messages with color coding.
General Enhancements
- Better Notifications: Cleaner and more informative messages for users, with improved formatting.
- Easier Configuration: Simplified settings with more options for customizing marker visuals and notification behaviors.
- Improved Performance: The plugin runs smoother and uses less memory, making it more efficient on your server.
- Enhanced Stability: Reduced errors and crashes by improving how the plugin handles unexpected situations and invalid inputs.
Quality of Life Improvements
- More Control for Admins: Improved permissions for commands and more detailed logs to help admins monitor quarry usage.
- Customizable Settings: Added new options for adjusting how notifications and markers work to better suit your needs.
- Better Cleanup: Ensures that resources like markers are removed properly when not needed, keeping the server clean.
Summary
The Quarry Notification plugin is now more reliable, user-friendly, and packed with features to help you monitor quarry activity efficiently while preventing unnecessary spam. Discord integration and better customization options make it a powerful tool for managing your server.
Sample Configuration
{
"Permission required to use chat commands": "quarrynotification.use",
"Permission required for admin commands": "quarrynotification.admin",
"SteamID icon for chat messages": 0,
"Enable advice messages": true,
"Interval for advice messages in seconds": 1800,
"Notification message format": "{0} has activated a {1} Quarry at {2}!",
"Anti-spam cooldown in seconds": 30.0,
"Maximum toggles per minute before spam protection": 3,
"Spam protection duration in minutes": 5,
"Quarry marker configurations": {
"SulfurQuarry": {
"Enabled": true,
"Alpha": 0.5,
"Radius": 0.6,
"Center Color": "#FF0000",
"Ring Color": "#FFFFFF",
"Duration": 30.0
},
"StoneQuarry": {
"Enabled": true,
"Alpha": 0.5,
"Radius": 0.6,
"Center Color": "#FFA07A",
"Ring Color": "#20B2AA",
"Duration": 30.0
},
"HQMQuarry": {
"Enabled": true,
"Alpha": 0.5,
"Radius": 0.6,
"Center Color": "#9370DB",
"Ring Color": "#FF69B4",
"Duration": 30.0
}
},
"Enable Discord notifications": false,
"Discord webhook URL": ""
}
Language Customization
Easily customize the in-game messages to suit your server's style and language preferences.
Default Messages
{ "QuarryStatusHeader": "<size=18><color=#4A90E2>Quarry Status Monitor</color></size>", "QuarryNameFormat": "<color=#F6C177>{0}</color>", "QuarryActivatedFormat": "<color=#4A90E2>│</color> Status: {0}", "QuarryLastPlayerFormat": "<color=#4A90E2>│</color> Last User: <color=#9ECBFF>{0}</color>", "QuarryGridPositionFormat": "<color=#4A90E2>│</color> Location: <color=#9ECBFF>{0}</color>", "QuarryNoActivationInfo": "<color=#4A90E2>│</color> <color=#E06C75>No activity recorded</color>", "QuarryLastActivated": "<color=#4A90E2>│</color> Last active: <color=#98C379>{0} {1}</color> ago at <color=#9ECBFF>{2}</color>", "QuarryOn": "<color=#98C379>✓</color> <color=#9ECBFF>{0}</color> activated the <color=#F6C177>{1}</color> quarry at <color=#9ECBFF>{2}</color>", "QuarryOff": "<color=#E06C75></color> <color=#9ECBFF>{0}</color> deactivated the <color=#F6C177>{1}</color> quarry at <color=#9ECBFF>{2}</color>", "PermissionError": "<color=#E06C75>Access denied: Insufficient permissions</color>", "QuarryAdded": "<color=#98C379>✓ Added {0} quarry at {1}</color>", "QuarryRemoved": "<color=#E06C75>Removed {0} quarry</color>", "NoQuarriesFound": "<color=#E06C75>No quarries found in the system</color>", "Minutes": "minutes", "Minute": "minute", "Seconds": "seconds", "Second": "second", "Hours": "hours", "Hour": "hour", "Days": "days", "Day": "day", "SulfurQuarry": "Sulfur", "StoneQuarry": "Stone", "HQMQuarry": "HQM", "QuarryNotFound": "<color=#E06C75>Quarry not found at specified location</color>", "InvalidCoordinates": "<color=#E06C75>Invalid coordinates format. Use: <x> <y> <z></color>", "InvalidType": "<color=#E06C75>Invalid quarry type. Available: SulfurQuarry, StoneQuarry, HQMQuarry</color>", "AddQuarryUsage": "<color=#4A90E2>Usage: /addquarry <type> <x> <y> <z></color>", "RemoveQuarryUsage": "<color=#4A90E2>Usage: /removequarry <type></color>", "NotificationHeader": "<size=18><color=#4A90E2>Quarry Activity Report</color></size>", "NotificationQuarryName": "<color=#F6C177>{0} Quarry</color>", "NotificationActivated": "<color=#4A90E2>│</color> Active: <color=#98C379>{0}</color> ago", "NotificationLastPlayer": "<color=#4A90E2>│</color> Operator: <color=#9ECBFF>{0}</color>", "NotificationGridPosition": "<color=#4A90E2>│</color> Grid: <color=#9ECBFF>{0}</color>", "NotificationSeparator": "<color=#4A90E2>└────────────────</color>", "InvalidPermissions": "<color=#E06C75>Access denied: Insufficient permissions</color>", "QuarryClearSuccess": "<color=#98C379>✓ All quarries cleared successfully</color>", "QuarryUpdateSuccess": "<color=#98C379>✓ Quarry information updated</color>", "SpamProtection": "<color=#E06C75>Anti-spam protection active. Please wait...</color>", "QuarryStatus": "<color=#4A90E2>│</color> Status: {0}", "StatusActive": "<color=#98C379>Active</color>", "StatusInactive": "<color=#E06C75>Inactive</color>" }
Commands
-
/quarry: Displays the current status of all quarries.
-
/addquarry <type> <x> <y> <z>: Adds a new quarry at the specified coordinates.
-
/removequarry <type>: Removes the specified type of quarry.
-
/listquarries: Lists all configured quarries.
-
/clearquarries: Clears all quarries from the configuration.
