Getting started

Hammer is a BrackeysBot plugin which provides staff with the ability to warn/mute/ban members, as well as manage those infractions.

It also introduces features for members to report rule-breaking messages without pinging Staff.

Dependencies

This plugin requires BrackeysBot.Core 1.0.0.

Configuration

Below is an example config.json file:

{
  "discord": {
    "prefix": "h[]",
    "token": "TOKEN_HERE",
  },
  "guilds": {
    "243005537342586880": {
      "mute": {
        "gagDuration": 300000
      },
      "reactions": {
        "deleteMessageReaction": ":wastebasket:"
        "gagReaction": ":mute:",
        "historyReaction": ":clock4:",
        "reportReaction": ":triangular_flag_on_post:"
        "trackReaction": ":mag:"
      },
      "roles": {
        "mutedRoleId": 428285014111682561
      }
    }
  }
}

The purpose of each property along with the default values is as follows:

Property	Description	Default Value
discord.prefix	Command prefix	h[]
discord.token	Bot API token	null
guilds.GUILD_ID.mute.gagDuration	The duration, in milliseconds, to gag a member	300000 (5 minutes)
guilds.GUILD_ID.reactions.deleteMessageReaction	The emoji name for staff to delete messages	🗑️ (:wastebasket:)
guilds.GUILD_ID.reactions.gagReaction	The emoji name for staff to gag members	🔇 (:mute:)
guilds.GUILD_ID.reactions.historyReaction	The emoji name for staff to view member history	🕓 (:clock4:)
guilds.GUILD_ID.reactions.reportReaction	The emoji name for members to report messages	🚩 (:triangular_flag_on_post:)
guilds.GUILD_ID.reactions.trackReaction	The emoji name for staff to track members	🔍 (:mag:)
guilds.GUILD_ID.roles.mutedRoleId	The ID of the role to apply to muted members	0