serenity

Smart ChatFilter

Use Serenity's Smart ChatFilter to limit content in your server.

Replace [prefix] with your server's prefix.

ChatFilter Initial Setup

To enable the Chatfilter module, you must run the command [prefix]chatfilter enable (channel).

To set or change the logs channel for the Chatfilter module, run the command [prefix]chatfilter channel (channel}.

To view your configurations, use the command [prefix]chatfilter settings.

To disable the Chatfilter module, you can run the command [prefix]chatfilter disable.

List of Punishments

PunishmentsDescription
WarnWarns the user that triggered the chatfilter
DeleteDeletes the message that triggered the chatfilter
TimeoutMutes the user who sent the content
KickKicks the user who sent the content
BanBans the user who triggered the chatfilter

You can set a punishment by using the command [prefix]chatfilter punishment [action] (duration).

Threshold

Use the following command to set and configure the minimum confidence (0.0-1.0) threshold of the Chatfilter. This will determine when certain bypasses, content, and images are detected.

// Syntax
[prefix]chatfilter threshold [value]
// Example
;chatfilter threshold 0.85

Whitelisting

  1. You can whitelist users, roles, and channels from triggering the Smart Chatfilter by using [prefix]chatfilter whitelist add [target].
  2. It's possible to unwhitelist roles, users, and channels by running the command [prefix]whitelist remove [target].
  3. Finally, you can view your whitelisted targets by using the command [prefix]chatfilter whitelist list.

Be cautious about what and who you are whitelisting as they will be exempt from your enabled filters.

Adding and Removing Words

By configuring the words subcommands, the Smart Chatfilter will dectect your filtered custom words or phrases (bypasses are included depending on what the threshold is set to) and execute your set punishment.

To add a custom word or phrase to the filter, you must use the command [prefix]chatfilter words add [word].

To view your filtered words, use [prefix]chatfilter words list.

To remove a word or phrase from the filter, you can run [prefix]chatfilter words remove [word].

To clear all filtered words, use the command [prefix]chatfilter words clear.

It is recommended you enable Serenity's built-in EN/DE profanity list. This will help detect words you may have forgotten. You can toggle this on/off by running the commmand: [prefix]chatftiler bultin [toggle].

Detecting Scam and Nsfw Images

Replace [module] with either scam or nsfw depending on what module you are configuring.

  1. Enable Modules

    Start by enabling either the Scam or Nsfw filters using the command [prefix]chatfilter [module] enable (channel).

  2. Set the channel

    Set or change the logs channel by running [prefix]chatfilter [module] channel (channel).

  3. Punishment

    You can set a punishment for each module by using [prefix]chatfilter [module] punishment [action] [duration].

  4. Threshold

    Use [prefix]chatfilter [module] threshold [value] to set the minimum confidence (0.0-1.0) threshold.

  5. Disable Modules

    You can disable either module by running the command [prefix]chatfilter [module] disable.

  6. Module Settings

    Finally, you can view any of your scam or nsfw module configurations by using the command [prefix]chatfilter [module] settings.