Config

version: 4.0: Easier setup and clearer errors

Documentation automatically generated from docstrings.

Commands for configuring the bot's settings in the server. This includes setting up channels, roles, custom messages, and feature toggles. Most commands require 'Manage Server' permissions.

`help`

Usage: /config help

If you're feeling stuck or need assistance with configuring the bot, this command will provide you with helpful information and guidance.

`setup`

Usage: /config setup <setup_type>

This command helps you get the bot set up on your server. You have a few options to choose from: 'dashboard' will give you a link to our web dashboard for an easy, graphical setup experience. 'manual' will guide you step-by-step through the setup process using Discord commands, starting with the verification mode (Website or Basic). 'auto' will automatically create the necessary roles and channels to get the bot running quickly, and sets the verification mode to Website.

Permissions:

You'll need the Manage Server permission to use this command.
The bot needs Send Messages, Embed Links, and View Channel permissions in the channel where you run this command.

`permissioncheck`

Usage: /config permissioncheck

This command triggers a check to ensure the bot has all the necessary permissions in the channels you've configured for it. It's a great way to diagnose problems if the bot isn't behaving as expected. Any issues found will be reported, usually in your log channel.

Permissions:

You'll need the Manage Server permission to use this command.

`messages`

Usage: /config messages <key> <action>

Lets you customize the various messages the bot sends. You can either set a new custom message or remove an existing one to revert it back to the default. When you choose to 'set' a message, a pop-up will appear for you to enter your new text.

Some of these are premium only, such as verification_button_label, which changes the text on the verification button itself.

Permissions:

You'll need the Manage Server permission to use this command.

`toggles`

Usage: /config toggles <key> <action>

This command allows you to enable or disable various features of the bot. You can turn things on or off to best suit your server's needs.

Permissions:

You'll need the Manage Server permission to use this command.

`approval_toggles`

Usage: /config approval_toggles <key> <action>

Use this command to customize the buttons that appear on the verification approval message in your log channel. This allows you to enable or disable specific actions your moderators can take, like banning or noting a user's ID.

I highly recommend using the website, as it provides a more user-friendly interface for configuring these settings. You can see the changes in real-time and understand the impact of each toggle better.

Permissions:

You'll need the Manage Server permission to use this command.

`channels`

Usage: /config channels <key> <action> <value>

This command is for assigning specific channels for the bot's functions, like a channel for logging or a lobby for new members. You can either 'set' a new channel or 'remove' an existing assignment. Threads work too.

Permissions:

You'll need the Manage Server permission to use this command.

`roles`

Usage: /config roles <key> <action> <value> <minimum_age> <maximum_age>

Use this command to manage which roles the bot interacts with. You can configure roles to be assigned upon verification, including setting minimum and maximum age requirements for specific roles.

Permissions:

You'll need the Manage Server permission to use this command.

`cooldown`

Usage: /config cooldown <cooldown>

Set a cooldown period for how often a user can attempt verification in the lobby. This can help prevent spam. The cooldown is set in minutes. You can set it to 0 to disable the cooldown entirely.

Permissions:

You'll need the Manage Server permission to use this command.

`verification_reminder`

Usage: /config verification_reminder <minutes>

💎 Premium: Sends a DM to members who opened the online verification page but did not finish it within the set number of minutes. The DM contains their verification link, so members who got distracted can pick up where they left off. Each link is only reminded once. Set it to 0 to turn the reminder off. Only applies when the verification method is Website verification.

Permissions:

You'll need the Manage Server permission to use this command.

`verification_mode`

Usage: /config verification_mode <verification_type> <mode>

Allows you to change the verification mode for the bot. Options:

Basic (dob)
ID verification
Basic + ID verification
Website verification

You can set the verification mode for the following types:

Verification
Reverification

Permissions:

You'll need the Manage Server permission to use this command.
premium required for Reverification, and for ID verification and Basic + ID verification

Reverification always happens inside Discord, so it can't be set to Website verification.

`denial_reasons`

Usage: /config denial_reasons <action> <reason>

Manage the reasons staff can pick after pressing Deny on an approval message. The member is sent the reason's message by DM, so it should explain what went wrong and what they can do next. Servers start with a few default reasons. list shows them, add and edit open a pop-up for the reason and its message, remove deletes one and reset puts the defaults back. Use {user} and {server} in a message for the member's mention and the server name. Up to 24 reasons; staff can always write a one-off custom reason as well.

Permissions:

You'll need the Manage Server permission to use this command.

`view`

Usage: /config view <guild>

This command provides a complete overview of the bot's current configuration for your server. It's a handy way to see all your settings at a glance. The configuration will be sent as a text file.

Permissions:

You'll need the Manage Server permission to use this command.
Only the bot developer can view the configuration of other guilds.