twinproduction/skraid repository overview

⁠skraid

Docker Repository⁠

To invite the bot in the server: https://discord.com/oauth2/authorize?client_id=<YOUR_BOT_CLIENT_ID>&scope=bot&permissions=11332

Skraid - a word play on scram, scam and raid - is an attempt to harness the power of large communities in order to put an end, or at least to reduce the blast radius of raids and common scams by ensuring that scammers and users known to take part in raids are banned before they can cause any harm.

This is, however, easier said than done.

This bot is built with several fail-safe mechanisms to prevent abuse.

One of these fail-safe mechanisms is the fact that inviting the bot to a guild does not allow you to modify the global ban list. The staff members of each guild (i.e. users with BAN_MEMBERS permissions) may suggest the addition of users to the global ban list by using s!suggest_blocklist USER_ID, but the decision is ultimately up to several factors which will not be disclosed to prevent malicious actors from attempting to circumvent the system. Do not be too worried, though, as one of the measures put in place requires manual action from the maintainer of the bot.

⁠Usage

⁠Getting started

Upon inviting Skraid in your server, you must create an alert channel where Skraid will send its messages to.

Once you've created the alert channel, make sure that Skraid has access to the channel and type the following:

s!SetAlertChannel <ALERT_CHANNEL_ID>

Where <ALERT_CHANNEL_ID> is the channel ID of your alert channel (e.g. 860216911907298444)

If you wish Skraid to not automatically take actions, you may enable alert-only mode by using the following command:

s!SetAlertOnly true

⁠Features

• Detect when a user is spamming (and deletes the messages marked as spam if Skraid is not in alert-only mode).
• Send an alert if a user in the global blocklist has joined the server (or ban said user, if configured to do so). Does not affect users that were already in the server.
• Supports per-server list of "exceptions" (allowlist), in case a guild wishes to let a user in the global ban list (blocklist) join their server anyways. This only applies if the bot is configured to ban instead of alert.
• Detect messages containing known phishing/scam links and send an alert, or delete said messages if configured to do so.
• Configuration for setting up a channel for alerts, including replacing all actions by alerts sent to said channel.
• Has some utility functions to manage raids

⁠Commands

All commands must be prefixed by the COMMAND_PREFIX, or s! by default.

⁠Configuration

⁠User Allowlist

Each guild has their own separate allowlist which, in the case that they chose to enable Skraid's automatic banning capabilities, can allow a user they believe was wrongly blocklisted to join the server.

If alert_only is set to true, there's no need to use the allowlist as the only thing you'd be preventing is the creation of an alert.

⁠Suggestion

Suggestions are the mean by which guild staff members may communicate with the maintainer.

⁠Utilities

⁠Maintainer

⁠Glossary

• user blocklist: A global list maintained by the bot's maintainer.
• user allowlist: A per-guild list of user ids. Used only in case Skraid has flagged or banned a user whom you believe is a legitimate user.
• word blocklist: A list of words that, if detected, will send an alert to the configured alert channel and, optionally, delete the message. These are mostly links of known scam websites.