Configuration Guide
Updated 2 months agoConfiguration Guide
This page explains how to configure ScarletHooks using the ScarletHooks.cfg file. You can find this file in your server's BepInEx/config directory. Most options can be changed without restarting the server by using the in-game reload command.
Where is the config file?
<V Rising Server Directory>/BepInEx/config/ScarletHooks.cfg
Configuration Sections
The config file is divided into several sections:
- [General]: Main settings for webhooks and message dispatch.
- [Customization]: Message formats and prefixes.
- [Admin]: Controls which messages are sent to the admin webhook.
- [Public]: Controls which messages are sent to the public webhook.
- [Clans]: Controls which messages are sent to clan webhooks.
General
| Setting | Description | Default |
|---|---|---|
| AdminWebhookURL | Webhook URL for admin messages | null |
| PublicWebhookURL | Webhook URL for public messages | null |
| LoginWebhookURL | Webhook URL for login/logout messages only | null |
| EnableBatching | Enable/disable batching to avoid rate limiting | true |
| MessageInterval | Interval (seconds) between sending messages | 0.2 |
| OnFailInterval | Interval (seconds) to wait before retrying after a failure | 2 |
Customization
Customize how messages appear by editing these settings.
You can use placeholders like {playerName}, {clanName}, and {targetName}.
| Setting | Description | Default |
|---|---|---|
| LoginMessageFormat | Format for login messages | {playerName} has joined the game. |
| LogoutMessageFormat | Format for logout messages | {playerName} has left the game. |
| GlobalPrefix | Prefix for global chat messages | [Global] {playerName}: |
| LocalPrefix | Prefix for local chat messages | [Local] {playerName}: |
| ClanPrefix | Prefix for clan chat messages | [Clan][{clanName}] {playerName}: |
| WhisperPrefix | Prefix for whisper messages | [Whisper to {targetName}] {playerName}: |
Admin
Control which message types are sent to the admin webhook.
| Setting | Description | Default |
|---|---|---|
| AdminGlobalMessages | Send global chat messages to admin webhook | true |
| AdminLocalMessages | Send local chat messages to admin webhook | true |
| AdminClanMessages | Send clan chat messages to admin webhook | true |
| AdminWhisperMessages | Send whisper messages to admin webhook | true |
| AdminLoginMessages | Send login/logout messages to admin webhook | true |
Public
Control which message types are sent to the public webhook.
| Setting | Description | Default |
|---|---|---|
| PublicGlobalMessages | Send global chat messages to public webhook | true |
| PublicLocalMessages | Send local chat messages to public webhook | false |
| PublicClanMessages | Send clan chat messages to public webhook | false |
| PublicWhisperMessages | Send whisper messages to public webhook | false |
| PublicLoginMessages | Send login/logout messages to public webhook | false |
Clans
| Setting | Description | Default |
|---|---|---|
| ClanLoginMessages | Send login/logout messages to clan webhooks | true |
Editing and Reloading
- Edit the desired settings in
ScarletHooks.cfgusing a text editor. - Save the file.
- Reload settings in-game with the command:
Or restart your server..hooks reload settings
Tips
- Only one webhook URL per type (admin, public, login) can be set in the config file.
- Clan webhooks are managed separately in
ClanWebHookUrls.json. - If you make a mistake, delete the config file and it will be regenerated with defaults on next launch.
- For more details on message formatting, see Placeholders & Message Formatting.
If you have issues or questions, check the Troubleshooting page or open an issue on GitHub.
