Config Files¶
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.
Bot Config File¶
- class BotConfig¶
-
- owners: list¶
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: bool¶
Whether or not the bot should DM the owners a traceback when it hits an unhandled error.
- user_agent: str¶
A simple constant that you can access with
voxelbotutils.Bot.user_agent
.
- default_prefix: str, list¶
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.
Changed in version 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: int¶
The ID of your support guild. Will be used in
voxelbotutils.Bot.fetch_support_guild()
.
- bot_support_role_id: int¶
The ID of your bot support role. Will be used in
voxelbotutils.checks.is_bot_support()
.
- guild_settings_prefix_column: str¶
The column of your prefix in the
guild_settings
table. You don’t need to change this fromprefix
unless you’re running multiple bots from the same directory.
- ephemeral_error_messages: bool¶
New in version 0.3.1.
Whether or not error messages triggered by slash commands should be ephemeral or not.
- owners_ignore_check_failures: bool¶
New in version 0.4.1.
Whether or not check failures are ignored for owners.
- class event_webhook¶
A simple webhook that recieves event pings.
- class intents¶
The intents that you want enabled on the bot.
- class help_command¶
Attributes for the help command.
- class bot_listing_api_keys¶
API keys that the bot uses internally to keep the bot listings up-to-date.
- topgg_token¶
- discordbotlist_token¶
- class command_data¶
Simple data for call/response commands.
- vote_command_enabled: bool¶
Whether or not the vote command is enabled - this will link to your Top.gg page where users can vote for the bot.
- class oauth¶
Oauth data used to build the bot’s invite link.
- class database¶
The configuration for your Postgres connection.
- class redis¶
The configuration for you Redis connection.
- class shard_manager¶
- class embed¶
Details for auto-embedding all bot responses.
- colour: int¶
The colour of the embed to be sent. If the value given is
0
, then the colour will be random.
A list of footer objects to be added to the bot. These should contain
text
andamount
attributes. A footer will be picked randomly from the list.
- class presence¶
The presence that the bot should use when online.
- include_shard_id: bool¶
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.
- class upgrade_chat¶
A set of information that lets you check for purchases made with Upgrade.Chat. You can get client information from here.
- class statsd¶
Your Datadog stats information.