AutoMod/README.md

34 lines
10 KiB
Markdown
Raw Normal View History

2022-03-23 20:31:57 +01:00
# AutoMod
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&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAwAAAAOCAYAAAAbvf3sAAAHFHpUWHRSYXcgcHJvZmlsZSB0eXBlIGV4aWYAAHja7Vhbdtw4Dv3nKmYJAkAQxHL4PGd20MufC0rltt1OnEz/puQSWRQFArh4Oq2//rvTf/DhwiVltVq8lAuf7Nm5YVKv+9POna587vdnPCN9XE/Xeh4wlgSj3D9refa/1umNwD00zPQdofqcQP3jA88P/fqJ0HOQBEeMyXwI+UNI+H5AD4F2i3UVr/ZehP5I8Lx/q6GGaLjJpvYQu4l++p0N2puKc4R5CcmFu8jDgMSXkzRMBHcWvIdN9azEneTFSdD9Qk9vHwdHO1jNX276gMrsX6P1mqXPaGV+tsgnJZe38cv1RPo1Kkf1707O9Znxx/Wdb6tL1yftx3fvWfeRGVK0XKDq8gj1EuXMsA8C5zi6JrBWLsNXQcLO5bgqrHrAFCYsueMa5MSAa1OmSY02rTMOGmAx80psmDAPlrNYxdh5SOCX46LNJi4TOLKMA3sWfuOFzrF+jXROqzh5ErYygRiFXfzulX73hb3DFYiuR/ngDHwxh7LBRiAXd2wDIrQfpepR8Ov6/AlcBQhqaDlcxKHYfpPoSn9HAjlACzYqxtsHyeZDACrC0QpmSIAAUCNRKnQZsxFBkRUANbDOkrkDAVLlCSY5ixRgUzmOxitGZysrApslrCOYAQmVIgZsXBrAyllhP5YrbKipaFbVoqZVXVuRkouWUqxEUGwmlpOpFTOr5taq1Fy1lmq1Vq/N2QVBU724eXX31nBmA+WGtxs2tNa5S89dUy/deu3e24D5jDx0lGGjDh9t8pSJ+DHLtFmnz7ZowZRWXrrKslWXr7ZhalvSzlt32bbr9t3eUKPHbT9fv4EaPajxQSo22htqWDV7kaAIJxqYATBOmYC4BQQwaA7Mrko5cyAXmF2OiCfKYFIDs0mBGBDMi1g3vbBLfCMayP0r3JLlD7jx/4tcCuh+E7l/4vYVarOdbCoHofDCUCryCsKY71Ub1xbJ7h5xBste2m2ncdlus/iEwA6nxa7ZER1lz9Lz6q34RphahiFTVvypX/fkejemzwtfj6oz42gZJe8hG7ob0uZ4t5heq4MbjiyQtFzBN3c47T2rF8DcXda0Dc4s3rU9St1r7K4hha+Ese4jErUOjE03D4MFzYFdrvYzCr4OmSCQ9v0+jU4LQTteRiwpEeR7H01n7x2w5Jl7iDm5I8Dcus7vFZB+RUOvEVZYJ2sdTfAF7tx6cFRsthSTsSMUWz1sToXJuWRfS/Jss2Lz9F3OKzIw0AoVZ9tB4PV++kigLq270BZZS/W9Mt/r8ivNpzbBtoV+L4vXbzEEOe+T8X0zpus3X/hD6A+hP4R+PiJkhcPuVugOanHfmlq919HGxJMTCeKrrSPttlV2cV4L6Y9zXrVMrMi61K2sOaejOvW1ldNEXJd9QrggpGxkwI4lpGIk2UFv4SCKs5hdPxjT9c2Gd2NBk9QaYhB33AW5EtkCOXpvsJ9y6b66h1DNEQs3+FpdkKqR05HXr9qsu/UT4RaaNzB/xJ8lAtwJe7Gczjp+YH2MSEK3TooPpzsboeZBOsr7yRdHi7RXKYiJt15AStJH1RjtioyChD/rLdLwV3L7+Zi+2+B18FfCN2rL8AeJVit7Q9k2Tn5oo/QykG6QPrIeqNDvjFcqKpD26AY5hEIfY0S6WAYMPFDjNtpqqNmukVGXzVYsMuhkw9lAokAPrEXY8uxmAk7uOtY5u4w51xqzIouI0YhypKL4gO2oCao37HxQH/kXs2f66oFaByi5i5MrajKqK9MwI60ToB4Rl/WMiaFpqw5NJLIiMGFG7VVfJhUw/63XunseB3yZLcfYV53RV6ImvQWE0aXOPlDZoPKihQ7leOYY/TOEsKN8LMjLxAB1d22oTAkVobG2ldZENQyFwdavdrjpwGEDORjXk6JnQzuJehSm0NCgodgMSDXD/mFyOVpSTXUjMFyEqhGYwmcUZoCStdO1eJZfz+Dp3UIzu/nc8K2LHUFiwPt3xhPYRT/OYKg+x1N2wAZaXlAEmgiEkdFngy+iKhm+MRGAAzNbZWZWXwzL8CiOVkWgQtGSo0yMfzVNyDQgNOiEixyv/M6fGLX4g2YNS6U3L+FoPsak1ME+WCCpcGYES60IDs62ULCG0zRERvQIMHBCQZh5KylwACJXIOLbwSfKx1TrYhR0qPUNdTqRgx5MA1bvDQ0Bze8DJHyozJQZLY0ePSACQQ/oAabIpyPDCHyhtkN0hB1QOSVf1L+o7XWjREXf31DW6YQHKPqLcQ1BjyG92uSGfoDELELlRqitd4yKrvsffKXvArWhVp5RgHYw1qFAlN6CHgeGGUij1gff4D2pRgM03REfK44OmFCr/9AAB999w253M3E1KLWYprANBHW0P3tl1M2KwrTDeAzYlCeGhFP/gC6ceXr6H/KFIUX4ZU+oAAABhGlDQ1BJQ0MgcHJvZmlsZQAAeJx9kT1Iw0AcxV9bS0UqIhYUUchQnSyIijhqFYpQIdQKrTqYXPoFTRqSFBdHwbXg4Mdi1cHFWVcHV0EQ/ABxdHJSdJES/5cUWsR4cNyPd/ced+8Af73MVLNjHFA1y0gl4kImuyqEXhFAP3oRxLDETH1OFJPwHF/38PH1LsazvM/9ObqVnMkAn0A8y3TDIt4gnt60dM77xBFWlBTic+Ixgy5I/Mh12eU3zgWH/TwzYqRT88QRYqHQxnIbs6KhEk8RRxVVo3x/xmWF8xZntVxlzXvyF4Zz2soy12kOIYFFLEGEABlVlFCGhRitGikmUrQf9/APOn6RXDK5SmDkWEAFKiTHD/4Hv7s185MTblI4DgRfbPtjBAjtAo2abX8f23bjBAg8A1day1+pAzOfpNdaWvQI6NkGLq5bmrwHXO4AA0+6ZEiOFKDpz+eB9zP6pizQdwt0rbm9Nfdx+gCkqavkDXBwCIwWKHvd492d7b39e6bZ3w8vtnKMQBwKtgAADRppVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+Cjx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDQuNC4wLUV4aXYyIj4KIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIgogICAgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIKICAgIHhtbG5zOkdJTVA9Imh0dHA6Ly93d3cuZ2ltcC5vcmcveG1wLyIKICAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIKICAgIHhtbG5zOnRpZmY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIgogICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICB4bXBNTTpEb2N1bWVudElEPSJnaW1wOmRvY2lkOmdpbXA6NzJhYmE4ZjEtNzk3Mi00NzIyLThjM2UtMWI4NTU1YTE5MGMxIgogICB4bXBNTTp
[<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%2Fautomod-api.janderedev.xyz%2Fstats&style=for-the-badge&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" height=500 />
<br />
## Features
- Basic moderation features: Kick/Ban/Tempban/Warn
- Infraction system which logs all moderation events
- 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!