General purpose moderation bot for Stoat. automod.vale.rocks
stoat stoat-chat stoat-bot automod
README.md

AutoMod

Moderation bot for Stoat

AutoMod is Stoat's premier moderation bot, featuring logging, filtering, utilities, anti-spam, comprehensive documentation, and much more. It aims to provide an easy way to protect your communities from malicious actors.

Features #

  • Basic moderation commands, including kicking, warning, banning, and timing out users.
  • A web dashboard for easy configuration.
  • Full message filtering.
  • Customisable event logging (including logging of message edits/deletions and moderator actions).
  • Full infraction system to keep track of problematic users.
  • Configurable command prefix.
  • Intuitive command syntax.
  • Anti-spam measures.
  • Handy extra commands for changing user nicknames and avatars, getting information from a UUID, etc.

Documentation and Support #

All of AutoMod's commands and features are extensively documented. If you still have questions or need help, you can join the support server on Stoat. The Stoat server is also a good way to stay in the loop on updates, changes, and development.

Stoat Server

AutoMod is split into multiple packages for ease of deployment and development:

  • bot is the core bot itself, which handles commands and takes action in servers.
  • lib is a shared library that defines types used across the bot.
  • web houses the web dashboard.
  • api is a layer which facilitates communication between the bot, databases, and the web dashboard.

Invite to Your Server #

If you're on the official Stoat instance at stoat.chat then you can add AutoMod to your server. If you're on a third-party instance, then you'll need to host it yourself. Instructions to do so are available in the docs on the website.