forked from Minecraft/Hush
Joey Hines
784ebed9b0
+ cancel_msg allows a category to cancel the offending message, blocking it from going to chat + Updated docs to be a bit more clear + Switched to woodpecker + Fixes #1 and #2 Reviewed-on: Minecraft/Hush#3 Co-authored-by: Joey Hines <joey@ahines.net> Co-committed-by: Joey Hines <joey@ahines.net> |
||
|---|---|---|
| gradle/wrapper | ||
| src/main | ||
| .gitignore | ||
| .woodpecker.yml | ||
| LICENSE | ||
| README.md | ||
| build.gradle | ||
| gradle.properties | ||
| settings.gradle | ||
README.md
Hush 
A plugin to monitor chat for forbidden phrases.
Watch Lists
Watchlist are groups of categories Hush monitors for. To enable a watchlist for a player,
they should be given the hush.<watchlist_name> permission.
Categories
A category is a group of regex filters, and the actions to run when a player matches one of those filters. An example of a category is shown below:
# "ban" category
ban:
# Filters to search for in chat
filters:
- "heck"
- "fricks"
# Optional, commands to run when a filter matches. {player} is replaced with the player's name.
commands:
- "ban {player}"
# Optional, should the message that matched the filter be cancelled? Default is "false".
cancel_msg: true
Permissions
hush.admin- allows access to thehushcommandhush.<watchlist_name>- used to determine if a player's messages should be checked by a watchlist
Commands
hush reload- reloads the plugin config