Backwards/protector
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Expanded Readme

Browse Source
This commit is contained in:
Alexander Harding
2026-07-16 09:45:54 -04:00
parent 175bb5169c
commit 7686e44a51
1 changed files with 33 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+31 -2
View File
@@ -3,6 +3,8 @@ A Custom Moderation bot I am writing for my servers and servers I am administrat
Will become more advanced as I need more custom moderation tools. Will become more advanced as I need more custom moderation tools.
This tool will likely not be of value to most people, I'm mostly just building it for something to do, besides it providing a few valuable tools that other moderation tools don't provide, but they're very unnecessary for most server admins/moderators/owners.
## Why ## Why
I'm creating this because a server I am an admin of recently got targeted by a spam-scam campign spamming a crypto scam image. I'm creating this because a server I am an admin of recently got targeted by a spam-scam campign spamming a crypto scam image.
At the time, the owner wasn't available to grant permission for tools like Wick, so I had to come up with something on the spot; thus I created this tool. At the time, the owner wasn't available to grant permission for tools like Wick, so I had to come up with something on the spot; thus I created this tool.
@@ -12,8 +14,11 @@ I can now swap to another tool like Wick, but I became interested in expanding t
## What ## What
As of now, this bot will only timeout individuals caught spamming, right now everything is super hard-coded; I needed it done quickly, so a lot of things were rushed. As of now, this bot will only timeout individuals caught spamming, right now everything is super hard-coded; I needed it done quickly, so a lot of things were rushed.
Once a member spams, it will run through a customizable filter, if it's deemed to be "infringing" it will mute the member and return the content to, as of currently, my user ID (this is customizable). Specific users can be added to a list that will allow them to bypass the moderation functions of this bot (for owners, admins, etc. who may be posting warnings, may be spamming advertising for the server itself, or may just be doing something in admin-only channels for some reason.)
From there it is up to the dedicated admin/moderator to ban the user if they deem it necessary.
Once a member spams, it will run through a filter, if it's deemed to be "infringing" it will mute the member and send the content to DMs - That being said, I was in kind of a hurry to get this up and running, so there are no "easy" configuration options, files, etc.
"send the content to DMs": This is currently set to 1 specific user, a "volunteer user".
The filter, spam amount, mute length, spam cooldown, moderation whitelist, and the "volunteer user" are saved to variables througout the code, configuring this isn't super simple, but this is something I aim to fix for a more "public release".
In the future banning will be automated (see #Todo) In the future banning will be automated (see #Todo)
@@ -33,3 +38,27 @@ If you don't want to start from 0, you can set a boolean in the code to `true` w
`public_db_connection_string.txt` will be updated if ever the database connection string needs to be updated, the bot will check this every 12am EST, and will be automatically swapped if it's different. `public_db_connection_string.txt` will be updated if ever the database connection string needs to be updated, the bot will check this every 12am EST, and will be automatically swapped if it's different.
Noting that this check will not happen if the readonly db boolean is `false` Noting that this check will not happen if the readonly db boolean is `false`
### Simple Configuration
I hope to setup a configuration system that will allow moderators/admins to configure things that I currently have hardcoded, things like:
* Whitelisted user(s)
* Global Infringement
* Punishment Durations (separate mute and ban durations)
* Who gets the review messages (when a message is flagged, but isn't considered infringing, it will still be sent to DMs, this will be used to determine who gets it | Everyone in several roles? Everyone in one role? A list of users, A specific-desginated user? etc.)
* What constitutes a "flagged" content (i.e. "it contains mentions" or "it contains an image" noting that all images will be checked regardless of whether it's flagged, this is more an Anti-Spam feature.)
## Suggestions
I am open to suggestions, but note that I would like to get through the above TODO list before working on any new challenge, therein if you provide a suggestion, it will likely be added to the bottom of the TODO list, alternatively if you would like it added to this bot you're welcome to:
## Contribute
I'm open to any sort of contribution. (real contributions, not just minute readme changes are not real contributions.)
Feel free to open a Pull Request with any functional changes you may have changed/added.
(This is hosted on my personal Gitea server, so I am unsure how this will work...)
## License
This project is published under the MIT License.
This is hosted on my personal gitea server ... is anyone even really reading this readme?