Chat filter based on keywords for Better Chat

Supported Games

Filter out unwanted keywords and replace them with a censor character (ie. '*') or simply replace the entire word with a substitute. Currently only works with Better Chat.

Also automatically mutes,kicks or ban depending on the amount of offences in a period of time. See Config for how to use.

Permissions

  • betterchatfilter.admin -- Allows player to use the filter admin commands

Commands

  • filter -- Check number of offences for self
  • filter check <player name or id> -- Check number of offences for specified player (admin only)
  • filter clear <player name or id> -- Clear offences for specified player (admin only)
  • clearfilters - Clears all players online offenses (admin only)

Configuration

{
  "Advanced - Regex to use": "", // Regex to trigger replacement
  "Advanced - Use REGEX": false,
  "Clear Offense After (0 - Disabled, 1 - Both Kick/Mute, 2 - Kick,  3 - Mute": 0,
   "Exclude Team Chat": false,     
   "Offenses - Broadcast Ban": true,        // a false will also remove its warn to player
  "Offenses - Broadcast kick": true,          // a false will also remove its warn to player
  "Offenses - Count To Ban": 20,      (0 -disabled)
  "Offenses - Count To Kick": 3,       (0 -disabled)
  "Offenses - Count To Mute": 3,     (0 -disabled)
  "Offenses - Time To Mute": 300,
  "Time to Ban in Minutes": 30,                (0 -Perma)
  "Warn Players with offense amount": false,
  "Word Filter - Custom Replacement": "Unicorn", // Word to be substituted n the place of the offending word.
  "Word Filter - Enabled": true,
  "Whole Message Filter - Enabled": false,    // Blocks entire message going out but still punish if set
  "Word Filter List": [ ],  // List of naughty words that triggers replacement (no spaces)
   "Word To White List": [ ],   // List of exact words to exculde from being filtered
  "Word Filter - Replacement": "*", // Symbol to censor offending word with.
  "Word Filter - Use Custom Replacement": false // Set to true to substitute word instead of symbol.
}

Future Plans

  1. adding exact word match

MIT License


Copyright (c) 2021 NooBlet


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.