david-0609
/
matrix-modbot
mirror of https://gitlab.com/david-0609/matrix-modbot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme

main
David 2023-01-08 16:47:34 +01:00
parent 425b9f81b5
commit 8bf806758f
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,7 +4,7 @@ Matrix Modbot is a bot for Matrix used to automatically moderate Matrix rooms.
## Who is this bot for?
The bot is orientated towards admins of large Matrix rooms that are public and require moderation. With this bot, simple jobs such as swear filtering and spam prevention could be accomplished without intervention of human moderators.
The bot is orientated towards admins of large Matrix rooms that are public and require constant moderation. With this bot, simple jobs such as swear filtering and spam prevention could be accomplished without intervention of human moderators.
## How to run?
@ -17,3 +17,21 @@ A minimal Docker image containing the compiled binary is published on [Docker Hu
cargo build --release
cargo run /path/to/config.ini
```
## Features
- Easy to configure
- Configurable swear detection
- Spam detection
- Anti-Caps
- Reputation system
- All members of a room have reputation points, they are deducted when spam/swear/caps are detected
- Automatically kicks a member if reputation is too low
- Members can award each other with maximum 1 reputation point every 24hr
### Commands
For awarding someone reputation:
- "!modbot award @user:matrix.org"
To get own reputation:
- "!modbot reputation"