ScoldBot

[BeardedTek]

ScoldBot

A maubot plugin that monitors a room to watch for bad / abusive language or behaviour and gives the room members and admins the tools to deal with it.

The first line of defense is a list of watch words that trigger notification to a separate control channel

The second line of defense is a configurable blacklist/whitelist located in base-config.yaml

How to trigger:

• If the word appears on any of the following lists it triggers a start:
  • watchword
  • scoldword
  • kickword
• It now checks the message agains the contextlist to make sure we're not taking something out of context.
• If it's on the context list, no action is taken.
• If it is not a false positive it will take an Action [See Actions]

Actions:

If watchword:

• notify admins in private admin channel

  If scoldword:

• notify admins in private admin channel
• scold the user with a random entry in 'scolds' as a reply to the message
• Subtract 1 from user's rep

  If kickword:

• notify admins in private admin channel
• scold the user with a random entry in 'scolds' as a reply to the message
• Subtract 5 from user's rep

  If autokickword:

• notify admins in private admin channel
• scold the user with a random entry in 'scolds' as a reply to the message
• Subtract 10 from user's rep
• Trigger a 'Kick Action'

  If a user's rep equals a rep-kick value:

• Trigger a 'Kick Action'

  If a user's rep goes below 1:

• Trigger a 'Ban Action'

Kick Action:

• Send User a DM explaining why they were kicked
• User can rejoin room right away
• If a private channel, user will be sent an invite after 1 minute

Ban Action:

• Send user a DM explaining wy they were kicked
• User is banned from room

Room intervention:

Should non-admin members of the room feel this should not have been a violation:

• Contact an admin to reverse it
• Send the command: !addrep
• Any room member can only addrep once per hour

  Should admin members of the room feel this should not have been a violation:

• Can use the following commands to mitigate:
• !addrep
• !unban

  Should an admin feel a violation is egregious, they can use the following commands:

• !kick : immediately kicks the user
• !ban : immediately bans the user
• !kickban : immediately kicks and bans the user
• !rep : manually adjust their 'rep' score

[BeardedTek]

🎉🎉 First Alpha Release 🎉🎉

See README