diff --git a/.assets/demo.gif b/.assets/demo.gif new file mode 100644 index 0000000..1f60284 Binary files /dev/null and b/.assets/demo.gif differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..2001f4a --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# AutoMod + +The best moderation bot for Revolt! \ +Or so they say... + +[](https://rvlt.gg/jan) + +[](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. + + +
+ +## 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! diff --git a/bot/README.md b/bot/README.md deleted file mode 100644 index 0019da2..0000000 --- a/bot/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Automod - Revolt moderation bot -Revolt moderation bot. Improved readme coming soon™️. - -## License -Licensed under the AGPL 3.0 - Check [LICENSE](/license).