FAQ

Updated 2 weeks ago

Frequently Asked Questions about ScarletHooks.


Does ScarletHooks support receiving messages from Discord or other webhooks into the game?

No. ScarletHooks only sends messages from the server to external webhooks. It does not support receiving messages from outside sources into the in-game chat, if you need that feature, please check out ScarletRCON.


Can I use ScarletHooks with non-Discord webhooks?

Yes, but some webhook services may require you to modify the source code and recompile the mod for full compatibility. ScarletHooks is designed for Discord but can work with any service that accepts standard webhook POST requests.


How do I set up a clan webhook?

  1. Use .hooks add <clan-name> or .hooks afp <player-name> in-game to create the clan entry.
  2. Edit BepInEx/config/ScarletHooks/ClanWebHookUrls.json and add the webhook URL for the clan.
  3. Reload webhooks in-game with .hooks reload webhooks or restart your server.

See the Clan Webhooks page for details.


Why aren’t my messages appearing in Discord?

  • Double-check the webhook URL for typos.
  • Make sure the correct message types are enabled in your config.
  • Reload settings with .hooks reload settings after making changes.
  • Check for rate limits or errors in your server log.

See Troubleshooting for more help.


Can I customize the format of messages sent to webhooks?

Yes! You can fully customize message formats and prefixes in ScarletHooks.cfg using placeholders like {playerName}, {clanName}, and {targetName}.

See Placeholders & Message Formatting for examples.


Do I need to restart my server after changing the config?

Not always. Most changes can be applied by using the in-game command:

.hooks reload settings

For clan webhook changes, use:

.hooks reload webhooks

Restart the server if you encounter issues or want to ensure all changes are applied.


Where is the configuration file located?

BepInEx/config/ScarletHooks.cfg
Clan webhooks: BepInEx/config/ScarletHooks/ClanWebHookUrls.json


What permissions are required to use in-game commands?

Only server admins can use ScarletHooks chat commands.


Where can I get help or report bugs?