Rules
Rules are the #1 way to filter anything in your chat.
Rules are used to match advertisements in messages, swear words and other prohibited stuff, but so much more. You can send custom messages based on player chat or command output and replace 10s of other plugins with our unique rules system.
If you use ViaVersion, ProtocolSupport or any weird Spigot fork, packet rules may not function and there's unfortunately nothing we can do about it.
How they work is that they are simple regular expressions that we test against every message. When matched, they can execute numerous operators you define. The rules/ folder contains files for all aspects of the game:
- anvil.rs: Rules applied to items when renamed on anvil.
- book.rs: Rules applied to books when edited or signed.
- chat.rs: Rules applied to chat messages.
- command.rs: Rules applied to commands.
- global.rs: Rules applied to everything, if you import this file, see below.
- groups.rs: Groups of rule operators, so you can catch 50 curse words all of which will alert your staff members the same way but don't have to copy paste the alert message 50 times. You simple create a group and reference to it later. See below.
- packet.rs: (Requires ProtocolLib) Rules applied to ANY messages from any plugin or even server itself.
- sign.rs: Rules applied to signs when placed.
- tag.rs: Rules applied to /tag command when players set their own nick, prefix or suffix.
To open RS files, you need to pay $49 to download our premium RulesOpener. Just kidding guys, simply open it with any supported text editor, see Use Right Encoding.
You can remove/edit everything in rules/ as you wish. We apply rules from top to bottom order.
You can bulk the operators above together in groups.rs file.
In this file, simply create rules using the same operators as above but instead of "match" use "group " to create a rule. Then return back to your rules files and reference to this group using "group ".
That way, you can deal with of 100s swear words easily without having to copy-paste operators under every rule.
Every rule .rs file can import rules from other rs files (except from groups.rs) by using the follow operator below. You can add multiple operators if you wish, but you cannot create your own files.
@import <rule type>
Please see Variables page for a list of placeholders you can use. Please know that not all placeholders are available on all places within the rules files.
Rules should work fine for your non-English language and we even make it easier to catch swears by replacing accents so that á ä ô and others get replaced into regular a and o. If you want to disable this feature set Rules.Strip_Accents to false in settings.yml.
Below is an example of a filter which blocks the word "fuck", and is also immune to some bypasses like f.u.c.k and even fuuu-ck. It is simple to configure it to match other words, too.
Here is an example of a rule that catches 'jerk', even in forms like jeeerrk and so on.
match \b(j+(\W|\d|_)*e+(\W|\d|_)*r+(\W|\d|_)*k+(\W|\d|_)*)
group swear
The 'match' operator has a regular expression that is evaluated against players' messages. If it matches, the rule applies. The latter operator, 'group', tells the program to do all the instructions stated in the 'swear' group in groups.rs file. You can write all the operators manually to the rule itself, if you want, but in case you wish to handle multiple swear words the same way, it becomes more convenient to store the instructions in one place.
You can use the "before replace" operator to remove anything matching the given regex BEFORE the message is matched, thus making it harder for players to bypass the filter by inserting special characters or anything else into it.
# Matches "hajzl" but removes any unicode such as ® or ™ before matching and replacing it
match (h+(\W|\d|_)*a+(\W|\d|_)*j+(\W|\d|_)*z+(\W|\d|_)*l+(\W|\d|_)*)
group swear
before replace [^\u0000-\u007F]+
then replace záchod
To allow your server's website, open rules/global.rs, find the following line:
ignore string minecraft:|youtube.com|imgur.com
And add the desired domain name to it at the end separated with |, such as "|myserver.com". You can add multiple websites separated by |.
To whitelist your server's IP, see the rule above, named "ip" (it says "# IP filter." in comments). We don't have the ignore operator there so you have to write it:
ignore string 12.123.12.123
By prefixing it with \ you make the filter ignore this specific IP address and nothing else. You can put the content after "ignore string " to https://regex101.com/ to see what it matches or not.
To whitelist more IP addresses, place them after the first one separated by | as you could see above when whitelisting domains.
Some rules such as "tits" may catch messages such as "but its" or similar. You can fix this in two ways:
a) Add the \b characters in the match rule. This makes the rule only match if the message does not have a whitespace either in front (if you put \b in front) or at the end (if you put \b as the last thing in the match):
match \btits
This will match "tits" but not "but its". Similarly, you can add also add \b at the end to make it only match when it ends with a whitespace. Be aware that such rules are easier to bypass.
b) Use "ignore string" operator. This is the best solution to allow certain words and won't make the rule easier to bypass:
match anal
ignore string analog|an all
This will prevent the two phrases 'analog' and 'an all' being blocked. To ignore multiple words, use the | letter as a separator (shown above, in that case we will ignore both "analog" and "an all").
If you wish to block a message containing spaces inside ("f u c k", or "come to m y s e r v e r . c o m"), use the 'before replace' operator. Insert it under each rule you want to affect and all whitespaces will be removed:
match <your rule>
before replace \s*
[...]
Below you will find a rule that denies all special, unicode characters. Those are misused to bypass filters. Please keep in mind that non-english languages might use them as well. You can past it directly to rules/rules.txt.
match [^\u0000-\u007F]+
then warn Unicode is prohibited
then deny
The plugin supports regex capturing groups and it is possible to refer to them in other operators with $<number>. TIP: If the $1 is not displaying relevant information, use $0 instead.
Don't forget to define groups by () brackets in your matching expressions!
Example:
match (You are being teleported to) (.*)
then rewrite You have been moved to . Do /spawn to get back.
Colorizing parts of message using our hidden feature
If you add this to your chat.rs file:
match !(.+)!
then replace [#flpc-i]&e[#flpc-1]
Then if someone were to say this in chat This part is normal !this part is highlighted! but this part is normal again it will make the message look like this:
Meaning any part of a users text which is surrounded by ! as shown here !this part is highlighted! will have the color changed. Thanks to @TheIntolerant for the tip!
Each rule consists of different things, we call them operators. We invented a custom language to write these because there simply was no other way and yaml was ineffective.
Below, the <> parameters are must-have whereas the [] ones are optional.
This is the core fundamental of every rule. A player’s message will be tested against the given regular expression and, when matched, the rule’s operators will be executed.
You can put plain-English words into it or regular expressions. Use regex101.com to test them first.
Example:
match bitch
match b(i|!)tch
Give a rule a name that you can later use in alert messages or in groups with the {rule_name} variable.
Example:
name ip
Assign a group to the rule. Multiple rules can have the same group to share operators into, so can easily block e.g. 100s of swear words and execute the same actions for all of them using a single group. Configure groups in rules/groups.rs file.
Example:
group advertisement
A regular expression used to match the message, similar to "match". However, this is applied before the match and the message that will be evaluated is edited for the match. You can specify the "with" parameter that will edit the message before it will be evaluated against the match with the given replacement. If you do not specify this, we will simply strip out the matched part of the message before matching it with the main "match" operator. This is used to "prepare" messages for advertisement filters, where we remove some letters from players’ messages they typically use to bypass the filter before matching it.
Example:
before replace dot|\[|\]|\{|\}|\(|\) with .
before replace [\(\[\]\)]|\s*
Overrides Rules.Strip_Colors option from settings.yml for an individual rule.
Example:
strip colors
strip colors true
strip colors false
Overrides Rules.Strip_Accents option from settings.yml for an individual rule.
Example:
strip accents
strip accents true
strip accents false
A date after which we stop executing this rule.
expires 30 Dec 2021, 15:00
How much time to wait before running this rule again?
This delay is applied globally to all users.
delay 6 seconds
How much time to wait before running this rule again for this player?
Works similar to the above operator, however, the "player delay" operator only affects a single user.
player delay 6 seconds
An optional permission that, if set, will make the rule only execute if the sender has it. You can also specify what message will be sent to the player if he lacks the permission.
Example:
require perm chatcontrol.rule.special
require perm chatcontrol.rule.special {error_prefix} You lack the ‘{permission}’ for this action.
An optional JavaScript that must return true/false. The rule will only be executed if it returns a value of true. You can use "player" or "sender" variable to get the sender’s instance. You can also use Variables there and they will be translated in the script directly, so a variable returning "true" will be treated as a boolean, such as "{player_vanished}".
Warning: JavaScript knowledge is required to program the script. We currently don’t have the capacity to do so we don’t offer help with creating your own scripts.
Example:
require script {sender_is_player}
require script player.getHandle().ping > 10
Only apply rule if sender has the given gamemode. You can use | to specify multiple gamemodes to require.
Example:
require gamemode creative
require gamemode adventure|spectate
If sender is not within any of the given world(s), ignore the rule. Use | to separate multiple worlds to ignore.
Example:
require world flat
require world flat|flat_nether
If sender is not within any of the given region(s), ignore the rule. Use | to separate multiple regions to ignore.
Example:
require region warzone
require region warzone|peacezone
If sender is not within any of the given channel(s), ignore the rule. Use | to separate multiple channels to ignore. You can also specify the mode the sender must be in to require.
Exception: If the channel mode is set to "read" we will make rule not run even when player is writing from another channel, because logically he cannot be writing from this other channel that is is only reading.
Example:
require channel standard
require channel admin|global
Require the custom data key to be set using the "save key" operator elsewhere to execute this rule.
Example:
require key player-name
Ignore the custom data key if set using the "save key" operator elsewhere from executing this rule.
Example:
ignore key player-name
Save a custom key to player's data. This is permanent and will remain even after reload.
WARNING: The key, before saved, is treated as JavaScript. That means, if you simply want to save a string such as "tree", you must put it into brackets: "save key 'tree'". In your save code, you can use "player" variable to get Bukkit Player class, see image below for example usage.
Example:
save key player-name <key>
For example, here's a complete sequence of rules used to create simple chat bot. Player then type @bot and then can save their own name.
A permission the sender will have to bypass the rule.
Optional regular expression that, if matched against the part of the whole message being matched, it will be ignored.
Useful when matching "ass" but you want to ignore "grass" from being matched. You can use the | letter from regular expressions to ignore multiple words.
Example:
ignore string grass|glass
If your rule is in global.rs file, you can specify what kinds of places you want this rule to ignore. Use | to separate multiple values.
Example:
ignore type chat
ignore type sign|book|anvil
See "require script", except that, if this script here returns true, the rule will not be applied.
Ignore the given command labels. Use | to separate multiple labels to ignore. Example:
ignore command /register|/reg|/r
If sender has the given gamemode, the rule will not apply for him. You can use | to specify multiple gamemodes to ignore.
Example:
ignore gamemode creative
ignore gamemode adventure|spectate
If sender is in the given world, bypass the rule. Use | to separate multiple worlds to ignore.
Example:
ignore world anarchy
ignore world anarchy|anarchy _nether|anarchy _the_end
If sender is the given region(s), bypass the rule. Use | to separate multiple regions to ignore.
Example:
ignore region warzone
ignore region warzone|peacezone
Only applied from chatting – when sender sent the message from a certain chat channel, ignore the rule. Use | to separate multiple channels. You can also specify the mode the sender must be in to ignore.
Exception: If the channel mode is set to "read" we will make rule not run even when player is writing from another channel, because logically he cannot be writing from this other channel that is is only reading.
Example:
ignore channel admin
ignore channel admin|anarchy
Do not apply the rule if the sender of the message is coming from Discord.
Example:
ignore discord
Only apply the rule if the sender of the message is coming from Discord.
Example:
require discord
Optional message to send to the player. Use | to define multiple messages, one of which will be selected randomly. Use the {player} variable to get the player and other variables normally.
To send multiline warn messages, you can use multiple "then warn" operators multiple times on new lines.
If specified, player will be kicked with the given message. Use the {player} variable to get the player and other variables normally.
Sends a toast notification to the player.
Styles available are CHALLENGE, GOAL and TASK
then toast Hello world!
then toast WITCH_SPAWN_EGG Hello world!
then toast WITCH_SPAWN_EGG CHALLENGE Hello world!
Requires DiscordSRV. Send a message to the given Discord channel. Use the {player} variable to get the player and other variables normally.
Send a title with subtitle to the player, if possible. Use the {player} variable to get the player and other variables normally. Split the message with | to send the other part as subtitle.
The fadein, stay and fadeout values are in ticks (20 = 1s), and they are not necessary.
Example:
then title &6Hi {player}|&cThis is a subtitle
then title &6Hi {player}|&cThis is a subtitle|10|60|10
Send action bar message to the player, if possible. Use the {player} variable to get the player and other variables normally.
Send boss bar to the player, if possible. For message, use the {player} variable to get the player and other variables normally.
Use this link to select a color:
Use this link to select a style:
Plays a sound to the player.
Select the sound names from the following link:
Example:
then sound ENTITY_ARROW_HIT_PLAYER 1.0 0.1
Opens a book. The name of the book is the file name of book from books/ folder. You can create these books using "/chc book" command.
Example:
then book test-book
Send the given message to every other player on your network/server that has the given permission. Used for staff notifications.
You can also specify a format name there to be used.
Example:
then notify chatcontrol.rules.swear &8[&4{rule_name} violation&8] &c{player} wrote: {original_message}
then notify chatcontrol.rules.ad Ad_Info
If specified, and you have Vault plugin installed, we will take the given amount of your currency from the player's bank account. Do not specify the currency symbol.
Example:
then fine 100
If you have warning points enabled, we will give the amount of warning points to the given warning set of the player.
Example:
then points ads 50
Replace the matched part in the message with the given replacement. Use | to separate multiple replacements. Once will be randomly chosen from those.
Example:
then replace I am a fool!
then replace I am a fool!|I am an idiot!
See "then replace" above, except that we will replace the entire message with the replacement(s), not just the matched part of it. You can still use the | separator to specify multiple messages, one of which will randomly be selected.
Same as "then rewrite" except that the message will only be rewritten in the specified world. You can still use the | separator to specify multiple messages, one of which will randomly be selected.
You can add multiple operators in the same rule for multiple worlds.
Example:
then rewritein hardcore This action is prohibited on the hardcore world.
Commands that will be executed in the given order as the sender, with his permissions. Use | to define multiple commands, and use the {player} variable to get the player.
Commands that will be executed in the given order from the console, with server privileges. Use | to define multiple commands, and use the {player} variable to get the player.
Commands that will be sent to BungeeCord to be executed. Use | to define multiple commands, and use the {player} variable to get the player.
The server variable can either be "bungee" (so we run the command on BungeeCord), or a name of another server where the command should be forwarded.
Log a message to the console.
Example:
then log {player} at {world} {x} {y} {z} has triggered this rule!
Write a message to the file.
Example:
then write logs/swear.log {player} at {world} {x} {y} {z} has triggered this rule with: {original_message}
Stop processing rules that follow after this one. We process rules from top to bottom of your files.
Example:
then abort
Prevent the message from appearing in the chat by canceling it. If this is for books, signs, items etc. we will prevent their creation.
Example:
then deny
Prevent the message from appearing for others but send it to sender, making him believe it was really sent out. Useful for blocking ads so that the player will not continue to spam them but will believe his advertisement has been seen (where in reality only admins have seen it and can take proper massive action).
Example:
then deny silently
This will simulate player typing the command in the chat and performs spy and log features. Useful if you are creating custom command through command.rs rules file.
Example:
spy command
Prevent the rule from being logged into "/chc log".
Example:
dont log
Prevent the message that the rule catches from being spied using "/spy" feature.
Example use case: In CraftBook plugin people can use the pipe system which requires people to place signs where line 2 is "[Pipe]" and it gets quite spammy, so you can filter signs containing a [Pipe] from being spied on.
dont spy
Prevent the rule from printing "MATCHED **" and similar messages to console.
Example:
dont verbose
Makes this rule load to memory but be disabled. Used in "/chc rule" commands to toggle rules.
Example:
disabled