Skip to content

Latest commit

 

History

History
132 lines (106 loc) · 5.64 KB

README.md

File metadata and controls

132 lines (106 loc) · 5.64 KB
Raw

MCSF

This repo is a plugin for Minecraft, and I'm going to keep it updated for as long as possible. Currently, this plugin has been tested with Minecraft Java edition versions 1.8.8 through 1.16.4.

Download the latest version from SpigotMC.org

MCSF is a swear filter that enables your server to let users personally toggle their filter status. That means users who feel like they don't need to have a swear filter could toggle it on/off whenever they please.

FEATURES:

  • Per player toggling:
    • Giving players the option to disable or enable the swear filter whenever they wish
  • DiscordSRV support:
    • This allows you to filter discord messages along with server chat messages.
    • Optionally you may surround blacklisted words with spoilers.
  • Punishments:
    • This allows you to punish players if they swear by executing commands.
  • Whitelists:
    • This is optional but will enable you to remove words from being filtered.
  • Custom regex support:
    • This allows you to add custom regex.
    • If you wish to use this, please read the bottom of this page!
  • UTF-8 support:
    • This allows you to use special characters in your blacklist so that the filter could also filter languages like Chinese!
  • MySQL support:
    • MySQL, if enabled, would save both the swears and whitelist values into the database of choice along with user information.
  • Customizability:
    • This is probably one of the most important, but you may modify every message seen by the player!
  • Multiple languages files:
    • MCSF supports multiple languages!
    • MCSF supports multiple languages!
    • You can find language files in MCSF/locales/; you may choose which one you'd like to use by changing settings.language to the file name of the language that you'd like to use :)
  • RGB support:
    • Any message sent by MCSF may have RGB using this format: &#RRGGBB
  • Cooldowns:
    • By default, all MCSF messages have a time delay of 5 seconds.
    • A 5 second delay would mean players can only use MCSF commands every 5 seconds
    • You can disable this with the permission MCSF.bypass or set the cooldown to 0.
  • Global blocking:
    • This allows you to block specific words for everyone even if the player's filter is disabled.

REQUIRMENTS:

(Optional: for global filtering) ProtocolLib
Java 8+

COMMANDS:

  • /MCSF toggle [player] (Permission: MCSF.use.toggle & MCSF.modify.others if toggling other users)
    • This command toggles a users's swear filter.
  • /MCSF reload (Permission: MCSF.modify.reload)
    • This command reloads the configuration files
  • /MCSF status [player] (Permission: MCSF.modify.others if viewing the status of other users)
    • This command views the status of a user's swear filter status
  • /MCSF add/remove [word] (Permission:MCSF.modify.add and MCSF.modify.remove)
    • Modifies the blacklist
  • /MCSF unset [player/uuid] (Permission:MCSF.modify.unset)
    • Removes remove specific users from the database
  • /MCSF whitelist [word] (Permission:MCSF.modify.whitelist)
    • Adds/Removes word from the whitelist (Requires settings.whitelist to be true)
  • /MCSF global [word] (Permission:MCSF.modify.global)
    • Adds/Removes word from the global list (Requires settings.global blacklist to be true)
  • /MCSF reload [confirm] (Permission:MCSF.modify.reload)
    • Reloads the configuration files, and the database (can be dangerous)

PLACEHOLDERS:

These placeholders are only valid for plugin messages if applicable

  • {prefix}:
    • Returns the current prefix
  • {player}:
    • Returns the user's name according to MCSF
  • {message}:
    • Returns the failure/success value if applicable
  • {current}:
    • Returns the current version of the plugin
  • {version}:
    • Returns the latest plugin version according to SpigotMC
  • {serverversion}:
    • Returns the current version of the server
  • {wordcount}:
    • Returns the amount of swear words in the config

PlacholderAPI placeholders:

  • %mcsf_player_name%:
    • Returns the player's username according to MCSF (Returns player's username)
  • %mcsf_player_flags%:
    • Returns the flags of the user (Returns integer as String)
  • %mcsf_player_status%:
    • Returns the flags of the user (Returns "enabled" or "disabled")
  • %mcsf_version%:
    • Returns the current version of this plugin (Returns double as String)

NOTES:

If you have this plugin on your server, please let me know so I can add it here.
This plugin is compiled with the latest Spigot API and works with versions 1.8 - latest.

Installation instructions:

Download this plugin into your server's plugin folder

(OPTIONAL): If you wish all messages to be filtered, you must install ProtocolLib as-well!

(OPTIONAL): If you plan on using DiscordSRV, you must first download the plugin and then add them to your server and then restart the server.

Example Regex Test:

https://regex101.com/r/pvMY0o/1

CUSTOM REGEX:

You can add custom regex for both global and normal filtering by adding them as normal swears. For a string to be recognised as regex, it must be valid for Java and have the prefix regex: This is a valid example:

IP Addresses:

  • (Per Player) /mcsf add regex:\b(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])(.|,|-)){3}(?:(?:2([0-4][0-9]|5[0-5]) |[0-1]?[0-9]?[0-9]))\b
  • (Globally) /mcsf global regex:\b(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])(.|,|-)){3}(?:(?:2([0-4][0-9]|5[0-5]) |[0-1]?[0-9]?[0-9]))\b
    • This will match IP Addresses.