The config file for the bot is one of the few required changes from default Discord.py, meaning that keeping your config file correct and up-to-date pretty important.
token
The token that the bot should run with.
owners
A list of the IDs for the owners of the bot. People in this list will bypass all command check failures, and will receive DMs from the bot when it hits an error if BotConfig.dm_uncaught_errors is enabled.
dm_uncaught_errors
Whether or not the bot should DM the owners a traceback when it hits an unhandled error.
user_agent
A simple constant that you can access with voxelbotutils.Bot.user_agent.
default_prefix
The prefix that the bot should use by default. Can be either a string or a list. The bot will always respond to its user and role mention.
0.3.1
Leaving an empty list or string will mean that the bot only responds to pings, and only from people set as owners. This is intended for slash-command only bots. If you want a prefix-run bot without specifying a prefix, using a space as a prefix will do this for you.
support_guild_id
The ID of your support guild. Will be used in voxelbotutils.Bot.fetch_support_guild.
bot_support_role_id
The ID of your bot support role. Will be used in voxelbotutils.checks.is_bot_support.
guild_settings_prefix_column
The column of your prefix in the guild_settings table. You don't need to change this from prefix unless you're running multiple bots from the same directory.
cached_messages
The number of messages to keep cached in the bot.
ephemeral_error_messages
0.3.1
Whether or not error messages triggered by slash commands should be ephemeral or not.
owners_ignore_check_failures
0.4.1
Whether or not check failures are ignored for owners.
A simple webhook that recieves event pings.
event_webhook_url
A Discord webhook URL to send event notifications to.
guild_join
guild_remove
shard_connect
shard_disconnect
shard_ready
bot_ready
unhandled_error
The intents that you want enabled on the bot.
guilds
members
bans
emojis
integrations
webhooks
invites
voice_states
presences
guild_messages
dm_messages
guild_reactions
dm_reactions
guild_typing
dm_typing
Attributes for the help command.
dm_help
Whether or not the help command should be DM'd to the user by default.
content
Additional content to be sent along with the bot's help embed.
API keys that the bot uses internally to keep the bot listings up-to-date.
topgg_token
discordbotlist_token
Simple data for call/response commands.
website_link
A link to your website.
guild_invite
A link to your guild.
github_link
A link to the bot's git page.
donate_link
A link where users can donate to you.
echo_command_enabled
Whether or not the echo command is enabled.
stats_command_enabled
Whether or not the stats command is enabled.
vote_command_enabled
Whether or not the vote command is enabled - this will link to your Top.gg page where users can vote for the bot.
updates_channel_id
The channel ID for an announcement channel where users can receive updates about your bot.
info
Simple information about your bot that gets output on using the !info command.
Oauth data used to build the bot's invite link.
enabled
Whether or not the invite command is enabled.
base
The base of your invite link. You probably don't need to change this.
response_type
The response type that the authorize page gives you. Unless you're doing things with oauth, youc an leave this alone.
redirect_uri
Where the user id redirected to when they authorize your bot.
client_id
The client ID for your application.
scope
A space-seperated list of scopes that your invite command will use.
permissions
A list of the permissions that the invite command should use.
The configuration for your Postgres connection.
enabled
Whether or not to connect to the database on startup.
user
The user that you want to connect with,
password
The password of that user.
database
The database that you want to connect to.
host
The host IP/URL that you want to connect to.
port
The port that your Postgres instance is running on.
The configuration for you Redis connection.
enabled
Whether or not to connect to reids on startup.
host
The host IP/URL that you want to connect to.
port
The port that your Redis instance is running on.
db
The database that you want to connect to.
shard_manager_enabled
Whether or not the shard manager for this instance is enabled.
Details for auto-embedding all bot responses.
enabled
Whether or not you want to automatically embed bot responses.
content
Additional content to be sent with the bot response.
colour
The colour of the embed to be sent. If the value given is 0, then the colour will be random.
footer
A list of footer objects to be added to the bot. These should contain text and amount attributes. A footer will be picked randomly from the list.
The author that will get added to the embed.
enabled
Whether or not you want to add an author to your embed.
name
The name of the author field.
url
The URL that the author field should point to.
The presence that the bot should use when online.
activity_type
The type of activity that the bot should be using.
text
The text given to the activity.
status
The status of the bot while online.
include_shard_id
Whether or not the shard ID of the bot should be included in its presence. Only applies after you identify with more than one shard.
A set of information that lets you automatically update the bot's presence when a given user starts streaming on Twitch.tv. You can get client information from here.
twitch_usernames
A list of usernames that you want to check for.
twitch_client_id
Your Twitch client ID.
twitch_client_secret
Your Twitch client secret.
A set of information that lets you check for purchases made with Upgrade.Chat. You can get client information from here.
client_id
Your Upgrade.Chat client ID.
client_secret
Your Upgrade.Chat client ID.
Your Datadog stats information.
host
The host that you want to post information to.
port
The port that you want to connect to.
The tags that you want to send with each post. Most helpful is the bot name.
service
An identifier for this set of stats - required for the information posting to be enabled.
website_base_url
The base URL for the website.
login_url
The endpoint on your website that redirects the user to a Discord login page.
routes
A list of route files to load into the bot.
oauth_scopes
A list of Oauth scopes that the Discord login should come loaded in with.
A list of key: config pairs that allow the website to interact with bot routes via request.app[key].
bot
The information that should be used to process the user's login.
client_id
The client ID for the user login.
client_secret
The client secret for the user login.
The configuration for your Postgres connection.
enabled
Whether or not to connect to the database on startup.
user
The user that you want to connect with,
password
The password of that user.
database
The database that you want to connect to.
host
The host IP/URL that you want to connect to.
port
The port that your Postgres instance is running on.
The configuration for you Redis connection.
enabled
Whether or not to connect to reids on startup.
host
The host IP/URL that you want to connect to.
port
The port that your Redis instance is running on.
db
The database that you want to connect to.