joeyahines
/
Hush
forked from Minecraft/Hush
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added README.md and LICENSE

master
Joey Hines 2020-09-20 16:45:42 -05:00
parent 108e0ecd8e
commit 0cc8568d67
2 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
LICENSE 100644
View File

@ -0,0 +1,7 @@
Copyright 2020 ZeroHighDef
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.

26
README.md 100644
View File

@ -0,0 +1,26 @@
# Hush
A plugin to monitor chat for forbidden phrases.
## Watch Lists
Watch lists specifies phrases to monitor. Each watch list has an associated permission. In the form of
`hush.<list_name>`. A user with this permission will have their chat messages checked to see if
they match the corresponding watch list.
Watch lists contain two types of phrases, Monitored and Banned.
### Monitored
Phrases that should be checked for context. If a user says one of these phrases, a Discord webhook is
sent out.
### Banned
A banned phrase results in an immediate ban. If a user says a banned phrase, they are kicked and added
to the ban list. A webhook is also sent to Discord.
## Example Config
[Config](src/main/resources/config.yml)
## Permissions
[Permissions](src/main/resources/plugin.yml)
## License
[MIT](LICENSE)