Regex moderation bot for Discord.
Important
Regy no longer offically hosted by me as of 1/2/24, Regy will continue to remain open source and public and is still functional currently, though no more large updates will be made to the bot.
- MSRV Policy 1.67.1 (Last checked 10/27/23)
- Built to run on Windows (Linux platforms are tested infrequently but have a known support for the bot as shown in the Features section)
| Feature | Windows | Linux |
|---|---|---|
| Message Scanning | ✅ | ✅ |
| Username Scanning | ✅ | ✅ |
| Infraction Tracking | ✅ | ✅ |
| Message logging | ✅ | ✅ |
| Server Cloning | ✅ | ✅ |
| Auto Raid Detection (IPM) | ✅ | ✅ |
| Auto-mod Integration | ✅ | ✅ |
| Regex Template Index (RTI) | ✅ | ✅ |
| Dead Zone Channels | ✅ | ✅ |
| Seamless Poll Detection | ✅ | ✅ |
| Message Nuking | ✅ | ✅ |
| Compiled Regex Cache (CRC) | ✅ | ✅ |
| Screen capture command | ✅ | |
| Self Update System | ✅ | ❌ |
- ✅ Works and functions as intended.
⚠️ Untested and may function incorrectly.- ❌ Does not work.
IPM is a system that allows the bot to detect raids and automatically ban the raiders. It works by scanning messages, whenever it moderates a user it will add a tally for the server which resets every minute. If the tally reaches a certain threshold it will sent a ping (alert) to the staff inside the logging channel notifying them of a possible raid so that they can take appropriate action based on the situation.
RTI is a index of community made regex templates that can be used to moderate your server. Server moderators can use /search_rti <phrase> to search the frequently updated list for phrases that match the tags of that search. If a template is found that matches the search it can be added to the server by reacting to it. RTI phrases have versions and can automatically update when a new version is released by the moderators running /update_rti this command will update all RTI phrases in the server to the latest version available inside the RTI index.
CRC is a cache generated during runtime that contains compiled regex phrases, this is a optimization regy uses to speed up its message scanning.
- Make sure you have the latest version of rust installed preferably if not make sure it follows the MSRV Policy
- Make sure you have git installed and added to your path
- Clone the repository and open up the main branch or develop branch, note that the develop branch may have work in progress features and is more prone to bugs or unfinished features.
- Build using cargo like so:
cargo build --release
Important
Make sure you create a bot application and have the token at hand if you are going to self host the bot
- Run the executable in
target/release/regy_bot.exe - The bot will generate a template config file in the same directory as the executable and then exit
- Configure the bot using the config file under the global options and add your bot token
- Re-run the executable and the bot should start up and be ready to use
Important
The bot has to be set up in each server before it can be used to its full potential with /config_setup <channel> the channel will be the designated channel for the bot to log messages and infractions in