-
Notifications
You must be signed in to change notification settings - Fork 5
Home
This documentation is incomplete!
To learn how to set up the bot, please view README.md.
If you wish to use a feature, make sure it is turned on in settings.js. Most are turned off by default
Can now be found and understood simply by interacting with the new slash commands. A text-based explanation may come later.
{settings.status} : The string value will be shown as the bot's Discord status while online.
{settings.logMessages} : If set to true, this will enable message logging. Logged messages will be logged to #logs. If the text-channel does not exist, it will be created. When a message is deleted, information on the deleted message will be logged(Who deleted it, who made the message, and the text content). When a message is edited, information on the edited message will be logged(Who made the message, the old text content, the new text content, and a link to the message).
{settings.antispam} : If set to true, this will enable the spam filter. This anti-spam is far from bulletproof, but something is better than nothing. Repeat messages sent in bulk will be deleted. Messages sent too fast by the same user will be deleted.
{settings.antiinvite} : If set to true, messages containing a Discord guild invite link will be deleted. Note that this was more done to stop honest users. This can still be bypassed by masking a link with a redirect service, but at least that means the embed is gone.
{settings.antiIPLog} : If set to true, messages containing a known IP logger link will be deleted. This can still be bypassed by masking a link with a redirect service, but at least it adds some sort of wall.
{settings.antiMuteBypass} : If set to true, this will cache users who are muted into the database. When a guild member leaves, their roles are removed by Discord. This feature will make the bot re-add the mute role.
{settings.autoResponder} : If enabled, this will enable the bot to respond using the pattern and instructions as found in {settings.autoResponders}
{settings.autoResponders} : The pattern and instructions to be used with {settings.autoResponder}. Please view the default {settings.autoResponders} options to figure out how to define your instructions and patterns.
{settings.autoResponders.ignoreRoles} : If a member has one of the roles in this array, the autoresponders feature will ignore them.
{settings.welcomeMessage} : If a string is defined with a length greater than 0, the bot will send this string to members who join the guild.
{settings.bannedNameContainment} : An array of strings. Each element in the array is expected to be a string. If a member joins the guild and their username contains anything in the array, they will be banned.
{settings.throttleMessages} : If set to true, this will enable the bot's message handling throttle based on {settings.throttleMessagesOptions}. Useful to set a more specific or lenient rate-limit compared to Discord's built-in "SLOWMODE" feature.
{settings.trackInvites} : If set to true, this will log new member join information to #logs. If the text-channel does not exist, it will be created. The logged information will include the member who joined, what invite they used, who made the invite, and how many uses the invite has.
{settings.moderator.rateLimitKicks} : If set to true, this will limit the number of kicks and bans to 25 per 24 hours. This will help prevent server nuking.
{settings.moderator.maxSlowMode} : The max rate limit time to be used with the !slowmode
command.