Censors

Understand the basic censors of SajuukBot and the individual configuration settings available.

SajuukBot will be ceasing operations on March 31st 2024, due to a variety of factors. For more information, please refer to the announcement provided on the SajuukBot discord server and your options for migrating to a new bot.

The censors module within SajuukBot provides you with some basic types of automoderation for the kinds of behaviour that are not overtly malicious but may simply be annoying. Perhaps you don't want your members to shout in ALL CAPS, or you have rules in place about specific language not being allowed.

With this module, you are able to manage those individual basic censors. Censors is compatible with the levels system, allowing you to set a base minimum level at the global level for all censors within the module for which a user is excluded, as well as a minimum level on specific censors where you might want less users excluded, eg a bad words filter.

Configuration

This section of configuration needs to be placed under the anti spam module as an indented element. Please see the full basic configuration for more details on how it should be formatted.

  censors:
    enabled: false
    shouting:
      enabled: false
      length: 10
    ascii:
      enabled: false
    zalgo:
      enabled: false
    tokens:
      enabled: false
      tokens:
    bad words:
      enabled: false
      words:
    invites:
      enabled: false
      codes:
    domains:
      enabled: false
      global opt-out: false
      blacklist:

Settings

Every section allows an optional level field to be defined. If it is included in the relevant sections, then the bot uses that level to determine if a user has been excluded.

Note that the bot always uses a more specific level definition over more general ones first, so if a level is defined under a specific censor (eg invites), that one will be used over any global setting (either within the censors block itself or within the anti spam block).

Core

Setting	Description
enabled	Globally toggles the censors system on or off. If this has been disabled, none of the censors will be available.
level	The minimum level at which a user is automatically exempted from the censors functionality. This setting is optional, but it is also "global" to all censors and will be used if no specific level has been defined in a censor.

Shouting

Setting	Description
enabled	Toggles the shouting censor. If this is disabled, messages containing ALL CAPS will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.
length	The minimum number of characters before the censors considers whether the post is in ALL CAPS.

ASCII

The ASCII filter may have a tendency to filter legitimate messages using characters that belong in this range but which are not spam. A future update will provide options to control the character ranges which are NOT included in the filter.

Setting	Description
enabled	Toggles the ASCII censor. If this is disabled, messages containing unicode characters within Box Drawing and Block Character ranges will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.

Zalgo

Zalgo text spam is an issue that rarely appears on Discord servers. It remains for those edge cases where a server runs into issues with this specific type of spam.

Setting	Description
enabled	Toggles the Zalgo censor. If this is disabled, messages containing unicode characters within the Combining Diacritical Marks range will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.

Bad Words

This censor has been deprecated and will receive no further updates, beyond those needed to make it compatible with a wider bot change. Despite the deprecation, the feature remains in the bot for those who prefer to utilise bot-based word censoring functionality.

Setting	Description
enabled	Toggles the Bad Words censor. If this is disabled, messages containing any defined "bad words" will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.
words	A list of words or phrases which should be matched in the message content. The formatting of this list can take two methods: you can either provide a value in the traditional formatting of a Python list, or you can use the YAML list syntax, in which each word or phrase is added on a separate line, with each entry starting with a hyphen/dash. If the censor is enabled, but this list is blank, the bot behaves as if the censor is disabled.

Invites

Setting	Description
enabled	Toggles the Invites censor. If this is disabled, messages containing non-whitelisted invite codes will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.
codes	A list of invite codes which are whitelisted. This list should consist of invite codes which do not point to your own server: these are automatically whitelisted without being included here. The formatting of this list can take two methods: you can either provide a value in the traditional formatting of a Python list, or you can use the YAML list syntax, in which each word or phrase is added on a separate line, with each entry starting with a hyphen/dash. If the censor is enabled, but this list is blank, the bot behaves as if the censor is disabled.

Domains

Setting	Description
enabled	Toggles the Domains censor. If this is disabled, messages containing disallowed URLs will not be removed from chat.
level	The minimum level at which a user is automatically exempted from this automoderator. This setting is optional and takes precedence over any earlier defined level value.
blacklist	A list of URLs pointing to sites that are to be considered as disallowed. Please note that you do not need to include the HTTP(S) in your entries. The formatting of this list can take two methods: you can either provide a value in the traditional formatting of a Python list, or you can use the YAML list syntax, in which each word or phrase is added on a separate line, with each entry starting with a hyphen/dash. If the censor is enabled, but this list is blank, the bot behaves as if the censor is disabled.