ScarletHooks provides a set of in-game chat commands for server admins to manage webhooks, settings, and the message dispatch system without needing to restart the server or manually edit files (except for webhook URLs and intervals). Only admins can use these commands.

Command List

Webhook Management

• .hooks add <clan-name>
  Add a clan to the webhook list.
  You must set the webhook URL in the config file and use the reload command after adding.

• .hooks afp <player-name>
  Add a clan to the webhook list using a player's name (the clan will be detected from the player data).
  You must set the webhook URL in the config file and use the reload command after adding.

• .hooks remove <clan-name|player-name>
  Remove a clan from the webhook list by clan name or by player name.

• .hooks reload settings
  Reload all settings from the config file.

• .hooks reload webhooks
  Reload all webhook URLs from the saved file.

• .hooks reload
  Reload both settings and webhooks.

• .hooks list
  List all configured webhooks (admin, public, and clans).

Settings

• .hooks settings <setting> <true|false>
  Change a boolean setting (except for webhook URLs and intervals, which are handled via the config file).

• .hooks settings
  Show current settings and their values.

Dispatch System Control

• .hooks start
  Start the message dispatch system if it has been manually stopped.

• .hooks stop
  Stop the message dispatch system.

• .hooks forcestop
  Stop the message dispatch system and clear all cache.

Notes

• Some settings (such as webhook URLs and message intervals) can only be changed directly in the config file due to in-game chat limitations.
• After adding or removing webhooks or changing settings in the config, use the appropriate reload command to apply changes without restarting the server.
• Use .hooks list to verify which webhooks are currently active.

For more details on configuration and troubleshooting, see the other pages in this Wiki.