ScarletHooks provides advanced webhook integration for V Rising servers, allowing you to send chat and login/logout messages to external services like Discord or custom endpoints. Below is a summary of the main features available in the mod.

Main Features

• Advanced Webhook Integration
  Send chat messages and notifications to multiple webhooks, including admin, public, and clan-specific endpoints.

• Customizable Message Formats
  Personalize the format and prefix of login, logout, global, local, clan, and whisper messages via the config file.
  (Supports placeholders like {playerName}, {clanName}, {targetName} for whispers)

• Granular Message Routing
  Configure which types of messages (global, local, clan, whisper, login/logout) are sent to each webhook. Admin, public, and login webhooks can be toggled for each message type, while clans can have their own dedicated webhooks for clan chat and login notifications.

• Dedicated Login/Logout Webhook
  Optionally send only login and logout messages to a specific webhook, separate from admin or public chat notifications.

• Dynamic Clan Webhooks
  Add or remove clan webhooks dynamically via in-game commands. Each clan can have its own webhook URL, managed through the config file and easily updated or reloaded without restarting the server.

• In-Game Command Management
  Most webhook and settings management can be performed through chat commands by server admins (except for setting webhook URLs and intervals). Commands allow adding/removing clans, reloading settings or webhooks, listing all configured webhooks, and toggling settings.

• Batching and Rate Limiting
  Messages are queued and sent at configurable intervals to avoid rate limiting by webhook services. Batching can be enabled to combine multiple messages into a single webhook request, reducing spam and improving reliability.

• Automatic Retry and Failure Handling
  If a webhook fails, the system will automatically retry sending messages after a configurable delay. After several consecutive failures, the message queue for that webhook is cleared to prevent server overload.

• Persistent Configuration
  All webhook URLs and clan mappings are saved and loaded automatically from disk, ensuring settings persist across server restarts.

• Flexible Configuration File
  Fine-tune all aspects of the mod via the ScarletHooks.cfg file, including intervals, enabled message types, webhook URLs, and message formats.

• Status and Debug Commands
  View current settings, all configured webhooks, and the status of the message dispatch system directly from in-game chat.

• Safe Start/Stop Controls
  Admins can start or forcibly stop the message dispatch system at any time, clearing all message queues if needed.

For more details on configuring and using these features, see the other pages in this Wiki.