Silence those H*ckers
Go to file
Joey Hines 784ebed9b0
Added cancel_msg config and update docs (#3)
+ 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>
2022-02-12 21:58:58 +00:00
gradle/wrapper Added cancel_msg config and update docs (#3) 2022-02-12 21:58:58 +00:00
src/main Added cancel_msg config and update docs (#3) 2022-02-12 21:58:58 +00:00
.gitignore Initial Commit 2020-09-20 16:34:23 -05:00
.woodpecker.yml Added cancel_msg config and update docs (#3) 2022-02-12 21:58:58 +00:00
LICENSE Added README.md and LICENSE 2020-09-20 16:45:42 -05:00
README.md Added cancel_msg config and update docs (#3) 2022-02-12 21:58:58 +00:00
build.gradle Added cancel_msg config and update docs (#3) 2022-02-12 21:58:58 +00:00
gradle.properties Initial Commit 2020-09-20 16:34:23 -05:00
settings.gradle Initial Commit 2020-09-20 16:34:23 -05:00

README.md

Hush Build Status

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 the hush command
  • hush.<watchlist_name> - used to determine if a player's messages should be checked by a watchlist

Commands

  • hush reload - reloads the plugin config

Example Config

Config

License

MIT