Slight repo cleanup
This commit is contained in:
parent
c5547786ac
commit
8286650a31
4 changed files with 23 additions and 68 deletions
BIN
.assets/demo.gif
BIN
.assets/demo.gif
Binary file not shown.
Before Width: | Height: | Size: 1.3 MiB |
32
.vscode/launch.json
vendored
32
.vscode/launch.json
vendored
|
@ -1,32 +0,0 @@
|
||||||
{
|
|
||||||
// Use IntelliSense to learn about possible attributes.
|
|
||||||
// Hover to view descriptions of existing attributes.
|
|
||||||
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"command": "cd bot && yarn dev",
|
|
||||||
"name": "Bot",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"command": "cd api && yarn dev",
|
|
||||||
"name": "API",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"command": "cd web && yarn dev",
|
|
||||||
"name": "Web",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"command": "cd bridge && yarn dev",
|
|
||||||
"name": "Bridge",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal",
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
5
.vscode/settings.json
vendored
5
.vscode/settings.json
vendored
|
@ -1,5 +0,0 @@
|
||||||
{
|
|
||||||
"editor.formatOnSave": false,
|
|
||||||
"editor.formatOnSaveMode": "modifications",
|
|
||||||
"prettier.tabWidth": 4
|
|
||||||
}
|
|
54
README.md
54
README.md
|
@ -1,35 +1,27 @@
|
||||||
### Development is now at [DeclanChidlow/AutoMod](https://github.com/DeclanChidlow/AutoMod)!
|
<div align="center">
|
||||||
---
|
<h1>
|
||||||
|
AutoMod
|
||||||
|
|
||||||
|
[![Stars](https://img.shields.io/github/stars/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/stargazers)
|
||||||
|
[![Forks](https://img.shields.io/github/forks/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/network/members)
|
||||||
|
[![Pull Requests](https://img.shields.io/github/issues-pr/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/pulls)
|
||||||
|
[![Issues](https://img.shields.io/github/issues/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/issues)
|
||||||
|
[![Contributors](https://img.shields.io/github/contributors/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlowRepo/Template/graphs/contributors)
|
||||||
|
[![Licence](https://img.shields.io/github/license/DeclanChidlow/AutoMod?style=flat-square&logoColor=white)](https://github.com/DeclanChidlow/AutoMod/blob/main/LICENCE)
|
||||||
|
</h1>
|
||||||
|
Moderation bot for Revolt
|
||||||
|
</div>
|
||||||
|
<br/>
|
||||||
|
|
||||||
# AutoMod
|
AutoMod is a general purpose moderation bot for [Revolt](https://revolt.chat) that aims to protect your community from spam and malicious actors. It offers powerful moderation tools, an infraction system, and a web interface.
|
||||||
|
|
||||||
The best moderation bot for Revolt! \
|
|
||||||
<sub><sup>Or so they say...</sup></sub>
|
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/dynamic/json?labelColor=ff6e6d&color=15283f&label=Revolt%20Server&query=member_count&suffix=%20Members&url=https%3A%2F%2Fapi.revolt.chat%2Finvites%2Fjan&style=for-the-badge&cacheSeconds=60&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QAAAAAAAD5Q7t/AAAACXBIWXMAAABgAAAAYADwa0LPAAABCUlEQVQoz6WQzUoCYRSGn/MhI4HuHCFwKzRbN5JkRes2dQddQV1G7WrhOvdC15CRGdQuMKOtC8cBowySj8nTIgxHG5V6d+fn4T3nhRhlvHIh45ULcXOZqk3W295R1UNg97ulDVTOgqfsBdQ+I2Aut75i086BKkdAPsbkWYRTZ2DPO53mhwEYppJFVSpzIIC8KpVhKlkEMPxR/wNlRLgsMN41AGrC3tJWCbo/qQLirm35gLsA84N2fRXQ8Y+qQnWhm0oV0Eg4Vuwx4M/ButYJT2ZSfWs1+4LuA++/QAMjsvf6cP0yAwL02lc3Bi0B9xPtOyNS8h8vbyPpxpxlXG9zAxENWvUGMJpe+ALe41VhoX4U6QAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMi0wMy0yM1QxOTo0MDozOCswMDowMGtN3HYAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjItMDMtMjNUMTk6NDA6MzgrMDA6MDAaEGTKAAAAAElFTkSuQmCC" />](https://rvlt.gg/jan) <!-- @EnokiUN made this uwu -->
|
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/dynamic/json?labelColor=ff6e6d&color=15283f&label=Add%20the%20bot&query=servers&suffix=%20Servers&url=https%3A%2F%2Fapi.automod.me%2Fstats&style=for-the-badge&cacheSeconds=60&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAAXNSR0IArs4c6QAAAC9JREFUKJFjZMACRDXs/yPzX984yIiuhgmbRmLAENLIiB4QNLdxAPyITXA0AUAAAAZ+CZVOTi2mAAAAAElFTkSuQmCC" />](https://app.revolt.chat/bot/01FHGJ3NPP7XANQQH8C2BE44ZY)
|
|
||||||
|
|
||||||
AutoMod aims to protect your community from spam and malicious actors. It offers powerful moderation tools, an infraction system, a web interface and in the future will be able to automatically prevent raids and ban malicious actors.
|
|
||||||
|
|
||||||
<img src=".assets/demo.gif" />
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
* Basic moderation features, including kick, ban, warn, purge, and timeout
|
||||||
|
* Infraction system, which logs all moderation events
|
||||||
|
* Configurable antispam rules
|
||||||
|
* Web interface for easy configuration
|
||||||
|
* Fully configurable bot prefix
|
||||||
|
* Permission system for moderation commands
|
||||||
|
|
||||||
- Basic moderation features: Kick/Ban/Tempban/Warn
|
## Add the bot
|
||||||
- Infraction system which logs all moderation events
|
What are you waiting for? Simply click [this link](https://app.revolt.chat/bot/01FHGJ3NPP7XANQQH8C2BE44ZY) to add the bot to your server.
|
||||||
- Rudamentary configurable antispam rules (If user sends more than X messages per Y seconds, delete/warn/send message)
|
|
||||||
- Web interface for easy configuration
|
|
||||||
- Fully configurable bot prefix
|
|
||||||
- Permission system for moderation commands
|
|
||||||
- Votekick system to allow trusted users to remove users while no moderator is available*
|
|
||||||
- Act on messages based on regex matches (delete/warn/send message)*
|
|
||||||
- Log moderation events, message edits and deletions to a Revolt channel or Discord Webhook*
|
|
||||||
- Scan user profiles and alert moderators of suspicious users (Wordlist is private and provided by the bot admin)*
|
|
||||||
- And more is planned!
|
|
||||||
|
|
||||||
\* Technically a feature, but not yet configurable without database access. If you would like to set any of these up right now, feel free to get in contact with me.
|
|
||||||
|
|
||||||
## Donations
|
|
||||||
|
|
||||||
If you want to support this project, check out [this page](https://janderedev.xyz/donate). If you don't want to help financially, feel free to join [my server](https://rvlt.gg/jan) and provide mental support in the form of catgirls instead!
|
|
||||||
|
|
Loading…
Reference in a new issue