Core¶
This is the cog guide for the core cog. You will find detailed docs about usage and commands.
[p]
is considered as your prefix.
Usage¶
The Core cog has many commands related to core functions.
These commands come loaded with every Red bot, and cover some of the most basic usage of the bot.
Commands¶
allowlist¶
Note
This command is locked to the bot owner.
Syntax
[p]allowlist
Tip
Alias: whitelist
Description
Commands to manage the allowlist.
Warning
When the allowlist is in use, the bot will ignore commands from everyone not on the list.
Use [p]allowlist clear
to disable the allowlist
allowlist add¶
Syntax
[p]allowlist add <users...>
Description
Adds users to the allowlist.
- Examples:
[p]allowlist add @26 @Will
- Adds two users to the allowlist.[p]allowlist add 262626262626262626
- Adds a user by ID.
- Arguments:
<users...>
- The user or users to add to the allowlist.
allowlist clear¶
Syntax
[p]allowlist clear
Description
Clears the allowlist.
This disables the allowlist.
- Example:
[p]allowlist clear
allowlist list¶
Syntax
[p]allowlist list
Description
Lists users on the allowlist.
- Example:
[p]allowlist list
allowlist remove¶
Syntax
[p]allowlist remove <users...>
Description
Removes users from the allowlist.
The allowlist will be disabled if all users are removed.
- Examples:
[p]allowlist remove @26 @Will
- Removes two users from the allowlist.[p]allowlist remove 262626262626262626
- Removes a user by ID.
- Arguments:
<users...>
- The user or users to remove from the allowlist.
autoimmune¶
Note
This command is locked to the server owner.
Syntax
[p]autoimmune
Description
Commands to manage server settings for immunity from automated actions.
This includes duplicate message deletion and mention spam from the Mod cog, and filters from the Filter cog.
autoimmune add¶
Syntax
[p]autoimmune add <user_or_role>
Description
Makes a user or role immune from automated moderation actions.
- Examples:
[p]autoimmune add @TwentySix
- Adds a user.[p]autoimmune add @Mods
- Adds a role.
- Arguments:
<user_or_role>
- The user or role to add immunity to.
autoimmune isimmune¶
Syntax
[p]autoimmune isimmune <user_or_role>
Description
Checks if a user or role would be considered immune from automated actions.
- Examples:
[p]autoimmune isimmune @TwentySix
[p]autoimmune isimmune @Mods
- Arguments:
<user_or_role>
- The user or role to check the immunity of.
autoimmune list¶
Syntax
[p]autoimmune list
Description
Gets the current members and roles configured for automatic moderation action immunity.
- Example:
[p]autoimmune list
autoimmune remove¶
Syntax
[p]autoimmune remove <user_or_role>
Description
Remove a user or role from being immune to automated moderation actions.
- Examples:
[p]autoimmune remove @TwentySix
- Removes a user.[p]autoimmune remove @Mods
- Removes a role.
- Arguments:
<user_or_role>
- The user or role to remove immunity from.
blocklist¶
Note
This command is locked to the bot owner.
Syntax
[p]blocklist
Tip
Aliases: blacklist
, denylist
Description
Commands to manage the blocklist.
Use [p]blocklist clear
to disable the blocklist
blocklist add¶
Syntax
[p]blocklist add <users...>
Description
Adds users to the blocklist.
- Examples:
[p]blocklist add @26 @Will
- Adds two users to the blocklist.[p]blocklist add 262626262626262626
- Blocks a user by ID.
- Arguments:
<users...>
- The user or users to add to the blocklist.
blocklist clear¶
Syntax
[p]blocklist clear
Description
Clears the blocklist.
- Example:
[p]blocklist clear
blocklist list¶
Syntax
[p]blocklist list
Description
Lists users on the blocklist.
- Example:
[p]blocklist list
blocklist remove¶
Syntax
[p]blocklist remove <users...>
Description
Removes users from the blocklist.
- Examples:
[p]blocklist remove @26 @Will
- Removes two users from the blocklist.[p]blocklist remove 262626262626262626
- Removes a user by ID.
- Arguments:
<users...>
- The user or users to remove from the blocklist.
command¶
Note
This command is locked to the server owner.
Syntax
[p]command
Description
Commands to enable and disable commands and cogs.
command defaultdisablecog¶
Note
This command is locked to the bot owner.
Syntax
[p]command defaultdisablecog <cog>
Description
Set the default state for a cog as disabled.
This will disable the cog for all servers by default.
To override it, use [p]command enablecog
on the servers you want to allow usage.
Note
This will only work on loaded cogs, and must reference the title-case cog name.
- Examples:
[p]command defaultdisablecog Economy
[p]command defaultdisablecog ModLog
- Arguments:
<cog>
- The name of the cog to make disabled by default. Must be title-case.
command defaultenablecog¶
Note
This command is locked to the bot owner.
Syntax
[p]command defaultenablecog <cog>
Description
Set the default state for a cog as enabled.
This will re-enable the cog for all servers by default.
To override it, use [p]command disablecog
on the servers you want to disallow usage.
Note
This will only work on loaded cogs, and must reference the title-case cog name.
- Examples:
[p]command defaultenablecog Economy
[p]command defaultenablecog ModLog
- Arguments:
<cog>
- The name of the cog to make enabled by default. Must be title-case.
command disable¶
Syntax
[p]command disable <command>
Description
Disable a command.
If you’re the bot owner, this will disable commands globally by default. Otherwise, this will disable commands on the current server.
- Examples:
[p]command disable userinfo
- Disables theuserinfo
command in the Mod cog.[p]command disable urban
- Disables theurban
command in the General cog.
- Arguments:
<command>
- The command to disable.
command disable global¶
Note
This command is locked to the bot owner.
Syntax
[p]command disable global <command>
Description
Disable a command globally.
- Examples:
[p]command disable global userinfo
- Disables theuserinfo
command in the Mod cog.[p]command disable global urban
- Disables theurban
command in the General cog.
- Arguments:
<command>
- The command to disable globally.
command disable server¶
Syntax
[p]command disable server <command>
Tip
Alias: command disable guild
Description
Disable a command in this server only.
- Examples:
[p]command disable server userinfo
- Disables theuserinfo
command in the Mod cog.
[p]command disable server urban
- Disables theurban
command in the General cog.- Arguments:
<command>
- The command to disable for the current server.
command disablecog¶
Syntax
[p]command disablecog <cog>
Description
Disable a cog in this server.
Note
This will only work on loaded cogs, and must reference the title-case cog name.
- Examples:
[p]command disablecog Economy
[p]command disablecog ModLog
- Arguments:
<cog>
- The name of the cog to disable on this server. Must be title-case.
command disabledmsg¶
Note
This command is locked to the bot owner.
Syntax
[p]command disabledmsg [message]
Description
Set the bot’s response to disabled commands.
Leave blank to send nothing.
To include the command name in the message, include the {command}
placeholder.
- Examples:
[p]command disabledmsg This command is disabled
[p]command disabledmsg {command} is disabled
[p]command disabledmsg
- Sends nothing when a disabled command is attempted.
- Arguments:
[message]
- The message to send when a disabled command is attempted.
command enable¶
Syntax
[p]command enable <command>
Description
Enable a command.
If you’re the bot owner, this will try to enable a globally disabled command by default. Otherwise, this will try to enable a command disabled on the current server.
- Examples:
[p]command enable userinfo
- Enables theuserinfo
command in the Mod cog.[p]command enable urban
- Enables theurban
command in the General cog.
- Arguments:
<command>
- The command to enable.
command enable global¶
Note
This command is locked to the bot owner.
Syntax
[p]command enable global <command>
Description
Enable a command globally.
- Examples:
[p]command enable global userinfo
- Enables theuserinfo
command in the Mod cog.[p]command enable global urban
- Enables theurban
command in the General cog.
- Arguments:
<command>
- The command to enable globally.
command enable server¶
Syntax
[p]command enable server <command>
Tip
Alias: command enable guild
Description
Enable a command in this server.
- Examples:
[p]command enable server userinfo
- Enables theuserinfo
command in the Mod cog.[p]command enable server urban
- Enables theurban
command in the General cog.
- Arguments:
<command>
- The command to enable for the current server.
command enablecog¶
Syntax
[p]command enablecog <cog>
Description
Enable a cog in this server.
Note
This will only work on loaded cogs, and must reference the title-case cog name.
- Examples:
[p]command enablecog Economy
[p]command enablecog ModLog
- Arguments:
<cog>
- The name of the cog to enable on this server. Must be title-case.
command listdisabled¶
Syntax
[p]command listdisabled
Description
List disabled commands.
If you’re the bot owner, this will show global disabled commands by default. Otherwise, this will show disabled commands on the current server.
- Example:
[p]command listdisabled
command listdisabled global¶
Syntax
[p]command listdisabled global
Description
List disabled commands globally.
- Example:
[p]command listdisabled global
command listdisabled guild¶
Syntax
[p]command listdisabled guild
Description
List disabled commands in this server.
- Example:
[p]command listdisabled guild
command listdisabledcogs¶
Syntax
[p]command listdisabledcogs
Description
List the cogs which are disabled in this server.
- Example:
[p]command listdisabledcogs
contact¶
Syntax
[p]contact <message>
Description
Sends a message to the owner.
This is limited to one message every 60 seconds per person.
- Example:
[p]contact Help! The bot has become sentient!
- Arguments:
[message]
- The message to send to the owner.
diagnoseissues¶
Syntax
[p]diagnoseissues [channel] <member> <command_name>
Description
Diagnose issues with the command checks with ease!
If you want to diagnose the command from a text channel in a different server, you can do so by using the command in DMs.
- Example:
[p]diagnoseissues #general @Slime ban
- Diagnose why @Slime can’t use[p]ban
in #general channel.
- Arguments:
[channel]
- The text channel that the command should be tested for. Defaults to the current channel.<member>
- The member that should be considered as the command caller.<command_name>
- The name of the command to test.
dm¶
Note
This command is locked to the bot owner.
Syntax
[p]dm <user_id> <message>
Description
Sends a DM to a user.
This command needs a user ID to work.
To get a user ID, go to Discord’s settings and open the ‘Appearance’ tab. Enable ‘Developer Mode’, then right click a user and click on ‘Copy ID’.
- Example:
[p]dm 262626262626262626 Do you like me? Yes / No
- Arguments:
[message]
- The message to dm to the user.
embedset¶
Syntax
[p]embedset
Description
Commands for toggling embeds on or off.
This setting determines whether or not to use embeds as a response to a command (for commands that support it). The default is to use embeds.
- The embed settings are checked until the first True/False in this order:
- In guild context:
Channel override -
[p]embedset channel
Server command override -
[p]embedset command server
Server override -
[p]embedset server
Global command override -
[p]embedset command global
Global setting -
[p]embedset global
- In DM context:
User override -
[p]embedset user
Global command override -
[p]embedset command global
Global setting -
[p]embedset global
embedset channel¶
Note
This command is locked to the server owner.
Syntax
[p]embedset channel [enabled]
Description
Set’s a channel’s embed setting.
If set, this is used instead of the guild and command defaults to determine whether or not to use embeds. This is used for all commands done in a channel.
If enabled is left blank, the setting will be unset and the guild default will be used instead.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset channel False
- Disables embeds in this channel.[p]embedset channel
- Resets value to use guild default.
- Arguments:
[enabled]
- Whether to use embeds in this channel. Leave blank to reset to default.
embedset command¶
Note
This command is locked to the server owner.
Syntax
[p]embedset command <command> [enabled]
Description
Sets a command’s embed setting.
If you’re the bot owner, this will try to change the command’s embed setting globally by default. Otherwise, this will try to change embed settings on the current server.
If enabled is left blank, the setting will be unset.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset command info
- Clears command specific embed settings for ‘info’.[p]embedset command info False
- Disables embeds for ‘info’.[p]embedset command "ignore list" True
- Quotes are needed for subcommands.
- Arguments:
[enabled]
- Whether to use embeds for this command. Leave blank to reset to default.
embedset command global¶
Note
This command is locked to the bot owner.
Syntax
[p]embedset command global <command> [enabled]
Description
Sets a command’s embed setting globally.
If set, this is used instead of the global default to determine whether or not to use embeds.
If enabled is left blank, the setting will be unset.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset command global info
- Clears command specific embed settings for ‘info’.[p]embedset command global info False
- Disables embeds for ‘info’.[p]embedset command global "ignore list" True
- Quotes are needed for subcommands.
- Arguments:
[enabled]
- Whether to use embeds for this command. Leave blank to reset to default.
embedset command server¶
Syntax
[p]embedset command server <command> [enabled]
Tip
Alias: embedset command guild
Description
Sets a commmand’s embed setting for the current server.
If set, this is used instead of the server default to determine whether or not to use embeds.
If enabled is left blank, the setting will be unset and the server default will be used instead.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset command server info
- Clears command specific embed settings for ‘info’.[p]embedset command server info False
- Disables embeds for ‘info’.[p]embedset command server "ignore list" True
- Quotes are needed for subcommands.
- Arguments:
[enabled]
- Whether to use embeds for this command. Leave blank to reset to default.
embedset global¶
Note
This command is locked to the bot owner.
Syntax
[p]embedset global
Description
Toggle the global embed setting.
This is used as a fallback if the user or guild hasn’t set a preference. The default is to use embeds.
To see full evaluation order of embed settings, run [p]help embedset
.
- Example:
[p]embedset global
embedset server¶
Note
This command is locked to the server owner.
Syntax
[p]embedset server [enabled]
Tip
Alias: embedset guild
Description
Set the server’s embed setting.
If set, this is used instead of the global default to determine whether or not to use embeds. This is used for all commands done in a server.
If enabled is left blank, the setting will be unset and the global default will be used instead.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset server False
- Disables embeds on this server.[p]embedset server
- Resets value to use global default.
- Arguments:
[enabled]
- Whether to use embeds on this server. Leave blank to reset to default.
embedset showsettings¶
Syntax
[p]embedset showsettings [command]
Description
Show the current embed settings.
Provide a command name to check for command specific embed settings.
- Examples:
[p]embedset showsettings
- Shows embed settings.[p]embedset showsettings info
- Also shows embed settings for the ‘info’ command.[p]embedset showsettings "ignore list"
- Checking subcommands requires quotes.
- Arguments:
[command]
- Checks this command for command specific embed settings.
embedset user¶
Syntax
[p]embedset user [enabled]
Description
Sets personal embed setting for DMs.
If set, this is used instead of the global default to determine whether or not to use embeds. This is used for all commands executed in a DM with the bot.
If enabled is left blank, the setting will be unset and the global default will be used instead.
To see full evaluation order of embed settings, run [p]help embedset
.
- Examples:
[p]embedset user False
- Disables embeds in your DMs.[p]embedset user
- Resets value to use global default.
- Arguments:
[enabled]
- Whether to use embeds in your DMs. Leave blank to reset to default.
helpset¶
Note
This command is locked to the bot owner.
Syntax
[p]helpset
Description
Commands to manage settings for the help command.
All help settings are applied globally.
helpset deletedelay¶
Syntax
[p]helpset deletedelay <seconds>
Description
Set the delay after which help pages will be deleted.
The setting is disabled by default, and only applies to non-menu help, sent in server text channels. Setting the delay to 0 disables this feature.
The bot has to have MANAGE_MESSAGES permission for this to work.
- Examples:
[p]helpset deletedelay 60
- Delete the help pages after a minute.[p]helpset deletedelay 1
- Delete the help pages as quickly as possible.[p]helpset deletedelay 1209600
- Max time to wait before deleting (14 days).[p]helpset deletedelay 0
- Disable deleting help pages.
- Arguments:
<seconds>
- The seconds to wait before deleting help pages.
helpset maxpages¶
Syntax
[p]helpset maxpages <pages>
Description
Set the maximum number of help pages sent in a server channel.
Note
This setting does not apply to menu help.
If a help message contains more pages than this value, the help message will be sent to the command author via DM. This is to help reduce spam in server text channels.
The default value is 2 pages.
- Examples:
[p]helpset maxpages 50
- Basically never send help to DMs.[p]helpset maxpages 0
- Always send help to DMs.
- Arguments:
<limit>
- The max pages allowed to send per help in a server.
helpset pagecharlimit¶
Syntax
[p]helpset pagecharlimit <limit>
Description
Set the character limit for each page in the help message.
Note
This setting only applies to embedded help.
The default value is 1000 characters. The minimum value is 500. The maximum is based on the lower of what you provide and what discord allows.
Please note that setting a relatively small character limit may mean some pages will exceed this limit.
- Example:
[p]helpset pagecharlimit 1500
- Arguments:
<limit>
- The max amount of characters to show per page in the help message.
helpset reacttimeout¶
Syntax
[p]helpset reacttimeout <seconds>
Description
Set the timeout for reactions, if menus are enabled.
The default is 30 seconds. The timeout has to be between 15 and 300 seconds.
- Examples:
[p]helpset reacttimeout 30
- The default timeout.[p]helpset reacttimeout 60
- Timeout of 1 minute.[p]helpset reacttimeout 15
- Minimum allowed timeout.[p]helpset reacttimeout 300
- Max allowed timeout (5 mins).
- Arguments:
<seconds>
- The timeout, in seconds, of the reactions.
helpset resetformatter¶
Syntax
[p]helpset resetformatter
Description
This resets Red’s help formatter to the default formatter.
- Example:
[p]helpset resetformatter``
helpset resetsettings¶
Syntax
[p]helpset resetsettings
Description
This resets Red’s help settings to their defaults.
This may not have an impact when using custom formatters from 3rd party cogs
- Example:
[p]helpset resetsettings``
helpset showaliases¶
Syntax
[p]helpset showaliases [show_aliases]
Description
This allows the help command to show existing commands aliases if there is any.
This defaults to True. Using this without a setting will toggle.
- Examples:
[p]helpset showaliases False
- Disables showing aliases on this server.[p]helpset showaliases
- Toggles the value.
- Arguments:
[show_aliases]
- Whether to include aliases in help. Leave blank to toggle.
helpset showsettings¶
Syntax
[p]helpset showsettings
Description
Show the current help settings.
Warning
These settings may not be accurate if the default formatter is not in use.
- Example:
[p]helpset showsettings``
helpset tagline¶
Syntax
[p]helpset tagline [tagline]
Description
Set the tagline to be used.
The maximum tagline length is 2048 characters. This setting only applies to embedded help. If no tagline is specified, the default will be used instead.
- Examples:
[p]helpset tagline Thanks for using the bot!
[p]helpset tagline
- Resets the tagline to the default.
- Arguments:
[tagline]
- The tagline to appear at the bottom of help embeds. Leave blank to reset.
helpset usetick¶
Syntax
[p]helpset usetick [use_tick]
Description
This allows the help command message to be ticked if help is sent to a DM.
Ticking is reacting to the help message with a ✅.
Defaults to False. Using this without a setting will toggle.
Note
This is only used when the bot is not using menus.
- Examples:
[p]helpset usetick False
- Disables ticking when help is sent to DMs.[p]helpset usetick
- Toggles the value.
- Arguments:
[use_tick]
- Whether to tick the help command when help is sent to DMs. Leave blank to toggle.
helpset verifychecks¶
Syntax
[p]helpset verifychecks [verify]
Description
Sets if commands which can’t be run in the current context should be filtered from help.
Defaults to True. Using this without a setting will toggle.
- Examples:
[p]helpset verifychecks False
- Enables showing unusable commands in help.[p]helpset verifychecks
- Toggles the value.
- Arguments:
[verify]
- Whether to hide unusable commands in help. Leave blank to toggle.
helpset verifyexists¶
Syntax
[p]helpset verifyexists [verify]
Description
Sets whether the bot should respond to help commands for nonexistent topics.
When enabled, this will indicate the existence of help topics, even if the user can’t use it.
Note
This setting on its own does not fully prevent command enumeration.
Defaults to False. Using this without a setting will toggle.
- Examples:
[p]helpset verifyexists True
- Enables sending help for nonexistent topics.[p]helpset verifyexists
- Toggles the value.
- Arguments:
[verify]
- Whether to respond to help for nonexistent topics. Leave blank to toggle.
ignore¶
Note
This command is locked to the admin role.
Syntax
[p]ignore
Description
Commands to add servers or channels to the ignore list.
The ignore list will prevent the bot from responding to commands in the configured locations.
Note
Owners and Admins override the ignore list.
ignore channel¶
Syntax
[p]ignore channel [channel]
Description
Ignore commands in the channel or category.
Defaults to the current channel.
Note
Owners, Admins, and those with Manage Channel permissions override ignored channels.
- Examples:
[p]ignore channel #general
- Ignores commands in the #general channel.[p]ignore channel
- Ignores commands in the current channel.[p]ignore channel "General Channels"
- Use quotes for categories with spaces.[p]ignore channel 356236713347252226
- Also accepts IDs.
- Arguments:
<channel>
- The channel to ignore. Can be a category channel.
ignore list¶
Syntax
[p]ignore list
Description
List the currently ignored servers and channels.
- Example:
[p]ignore list
ignore server¶
Note
This command is locked to the admin role.
Syntax
[p]ignore server
Tip
Alias: ignore guild
Description
Ignore commands in this server.
Note
Owners, Admins, and those with Manage Server permissions override ignored servers.
- Example:
[p]ignore server
- Ignores the current server
invite¶
Syntax
[p]invite
Description
Shows Red’s invite url.
This will always send the invite to DMs to keep it private.
This command is locked to the owner unless [p]inviteset public
is set to True.
- Example:
[p]invite
inviteset¶
Note
This command is locked to the bot owner.
Syntax
[p]inviteset
Description
Commands to setup Red’s invite settings.
inviteset perms¶
Syntax
[p]inviteset perms <level>
Description
Make the bot create its own role with permissions on join.
The bot will create its own role with the desired permissions when it joins a new server. This is a special role that can’t be deleted or removed from the bot.
For that, you need to provide a valid permissions level. You can generate one here: https://discordapi.com/permissions.html
Please note that you might need two factor authentication for some permissions.
- Example:
[p]inviteset perms 134217728
- Adds a “Manage Nicknames” permission requirement to the invite.
- Arguments:
<level>
- The permission level to require for the bot in the generated invite.
inviteset public¶
Syntax
[p]inviteset public [confirm=False]
Description
Toggles if [p]invite
should be accessible for the average user.
The bot must be made into a Public bot
in the developer dashboard for public invites to work.
- Example:
[p]inviteset public yes
- Toggles the public invite setting.
- Arguments:
[confirm]
- Required to set to public. Not required to toggle back to private.
leave¶
Note
This command is locked to the bot owner.
Syntax
[p]leave [servers...]
Description
Leaves servers.
If no server IDs are passed the local server will be left instead.
Note
This command is interactive.
- Examples:
[p]leave
- Leave the current server.[p]leave "Red - Discord Bot"
- Quotes are necessary when there are spaces in the name.[p]leave 133049272517001216 240154543684321280
- Leaves multiple servers, using IDs.
- Arguments:
[servers...]
- The servers to leave. When blank, attempts to leave the current server.
licenseinfo¶
Syntax
[p]licenseinfo
Tip
Alias: licenceinfo
Description
Get info about Red’s licenses.
load¶
Note
This command is locked to the bot owner.
Syntax
[p]load <cogs...>
Description
Loads cog packages from the local paths and installed cogs.
See packages available to load with [p]cogs
.
Additional cogs can be added using Downloader, or from local paths using [p]addpath
.
- Examples:
[p]load general
- Loads thegeneral
cog.[p]load admin mod mutes
- Loads multiple cogs.
- Arguments:
<cogs...>
- The cog packages to load.
localallowlist¶
Note
This command is locked to the admin role.
Syntax
[p]localallowlist
Tip
Alias: localwhitelist
Description
Commands to manage the server specific allowlist.
Warning
When the allowlist is in use, the bot will ignore commands from everyone not on the list in the server.
Use [p]localallowlist clear
to disable the allowlist
localallowlist add¶
Syntax
[p]localallowlist add <users_or_roles...>
Description
Adds a user or role to the server allowlist.
- Examples:
[p]localallowlist add @26 @Will
- Adds two users to the local allowlist.[p]localallowlist add 262626262626262626
- Allows a user by ID.[p]localallowlist add "Super Admins"
- Allows a role with a space in the name without mentioning.
- Arguments:
<users_or_roles...>
- The users or roles to remove from the local allowlist.
localallowlist clear¶
Syntax
[p]localallowlist clear
Description
Clears the allowlist.
This disables the local allowlist and clears all entires.
- Example:
[p]localallowlist clear
localallowlist list¶
Syntax
[p]localallowlist list
Description
Lists users and roles on the server allowlist.
- Example:
[p]localallowlist list
localallowlist remove¶
Syntax
[p]localallowlist remove <users_or_roles...>
Description
Removes user or role from the allowlist.
The local allowlist will be disabled if all users are removed.
- Examples:
[p]localallowlist remove @26 @Will
- Removes two users from the local allowlist.[p]localallowlist remove 262626262626262626
- Removes a user by ID.[p]localallowlist remove "Super Admins"
- Removes a role with a space in the name without mentioning.
- Arguments:
<users_or_roles...>
- The users or roles to remove from the local allowlist.
localblocklist¶
Note
This command is locked to the admin role.
Syntax
[p]localblocklist
Tip
Alias: localblacklist
Description
Commands to manage the server specific blocklist.
Use [p]localblocklist clear
to disable the blocklist
localblocklist add¶
Syntax
[p]localblocklist add <users_or_roles...>
Description
Adds a user or role to the local blocklist.
- Examples:
[p]localblocklist add @26 @Will
- Adds two users to the local blocklist.[p]localblocklist add 262626262626262626
- Blocks a user by ID.[p]localblocklist add "Bad Apples"
- Blocks a role with a space in the name without mentioning.
- Arguments:
<users_or_roles...>
- The users or roles to add to the local blocklist.
localblocklist clear¶
Syntax
[p]localblocklist clear
Description
Clears the server blocklist.
This disabled the server blocklist and clears all entries.
- Example:
[p]blocklist clear
localblocklist list¶
Syntax
[p]localblocklist list
Description
Lists users and roles on the server blocklist.
- Example:
[p]localblocklist list
localblocklist remove¶
Syntax
[p]localblocklist remove <users_or_roles...>
Description
Removes user or role from blocklist.
- Examples:
[p]localblocklist remove @26 @Will
- Removes two users from the local blocklist.[p]localblocklist remove 262626262626262626
- Unblocks a user by ID.[p]localblocklist remove "Bad Apples"
- Unblocks a role with a space in the name without mentioning.
- Arguments:
<users_or_roles...>
- The users or roles to remove from the local blocklist.
mydata¶
Syntax
[p]mydata
Description
Commands which interact with the data Red has about you.
More information can be found in the End User Data Documentation.
mydata 3rdparty¶
Syntax
[p]mydata 3rdparty
Description
View the End User Data statements of each 3rd-party module.
This will send an attachment with the End User Data statements of all loaded 3rd party cogs.
- Example:
[p]mydata 3rdparty
mydata forgetme¶
Syntax
[p]mydata forgetme
Description
Have Red forget what it knows about you.
This may not remove all data about you, data needed for operation, such as command cooldowns will be kept until no longer necessary.
Further interactions with Red may cause it to learn about you again.
- Example:
[p]mydata forgetme
mydata getmydata¶
Syntax
[p]mydata getmydata
Description
[Coming Soon] Get what data Red has about you.
mydata ownermanagement¶
Note
This command is locked to the bot owner.
Syntax
[p]mydata ownermanagement
Description
Commands for more complete data handling.
mydata ownermanagement allowuserdeletions¶
Syntax
[p]mydata ownermanagement allowuserdeletions
Description
Set the bot to allow users to request a data deletion.
This is on by default.
Opposite of [p]mydata ownermanagement disallowuserdeletions
- Example:
[p]mydata ownermanagement allowuserdeletions
mydata ownermanagement deleteforuser¶
Syntax
[p]mydata ownermanagement deleteforuser <user_id>
Description
Delete data Red has about a user for a user.
This will cause the bot to get rid of or disassociate a lot of non-operational data from the specified user. Users have access to a different command for this unless they can’t interact with the bot at all. This is a mostly safe operation, but you should not use it unless processing a request from this user as it may impact their usage of the bot.
- Arguments:
<user_id>
- The id of the user whose data would be deleted.
mydata ownermanagement deleteuserasowner¶
Syntax
[p]mydata ownermanagement deleteuserasowner <user_id>
Description
Delete data Red has about a user.
This will cause the bot to get rid of or disassociate a lot of data about the specified user. This may include more than just end user data, including anti abuse records.
- Arguments:
<user_id>
- The id of the user whose data would be deleted.
mydata ownermanagement disallowuserdeletions¶
Syntax
[p]mydata ownermanagement disallowuserdeletions
Description
Set the bot to not allow users to request a data deletion.
Opposite of [p]mydata ownermanagement allowuserdeletions
- Example:
[p]mydata ownermanagement disallowuserdeletions
mydata ownermanagement processdiscordrequest¶
Syntax
[p]mydata ownermanagement processdiscordrequest <user_id>
Description
Handle a deletion request from Discord.
This will cause the bot to get rid of or disassociate all data from the specified user ID.
You should not use this unless Discord has specifically requested this with regard to a deleted user.
This will remove the user from various anti-abuse measures.
If you are processing a manual request from a user, you may want [p]mydata ownermanagement deleteforuser
instead.
- Arguments:
<user_id>
- The id of the user whose data would be deleted.
mydata ownermanagement setuserdeletionlevel¶
Syntax
[p]mydata ownermanagement setuserdeletionlevel <level>
Description
Sets how user deletions are treated.
- Example:
[p]mydata ownermanagement setuserdeletionlevel 1
- Arguments:
<level>
- The strictness level for user deletion. See Level guide below.
- Level:
0
: What users can delete is left entirely up to each cog.1
: Cogs should delete anything the cog doesn’t need about the user.
mydata whatdata¶
Syntax
[p]mydata whatdata
Description
Find out what type of data Red stores and why.
- Example:
[p]mydata whatdata
reload¶
Note
This command is locked to the bot owner.
Syntax
[p]reload <cogs...>
Description
Reloads cog packages.
This will unload and then load the specified cogs.
Cogs that were not loaded will only be loaded.
- Examples:
[p]reload general
- Unloads then loads thegeneral
cog.[p]reload admin mod mutes
- Unloads then loads multiple cogs.
- Arguments:
<cogs...>
- The cog packages to reload.
restart¶
Note
This command is locked to the bot owner.
Syntax
[p]restart [silently=False]
Description
Attempts to restart Red.
Makes Red quit with exit code 26. The restart is not guaranteed: it must be dealt with by the process manager in use.
- Examples:
[p]restart
[p]restart True
- Restarts silently.
- Arguments:
[silently]
- Whether to skip sending the restart message. Defaults to False.
servers¶
Note
This command is locked to the bot owner.
Syntax
[p]servers
Description
Lists the servers Red is currently in.
Note
This command is interactive.
set¶
Syntax
[p]set
Description
Commands for changing Red’s settings.
set addadminrole¶
Note
This command is locked to the server owner.
Syntax
[p]set addadminrole <role>
Description
Adds an admin role for this guild.
- Admins have the same access as Mods, plus additional admin level commands like:
[p]set serverprefix
[p]addrole
[p]ban
[p]ignore guild
And more.
- Examples:
[p]set addadminrole @Admins
[p]set addadminrole Super Admins
- Arguments:
<role>
- The role to add as an admin.
set addmodrole¶
Note
This command is locked to the server owner.
Syntax
[p]set addmodrole <role>
Description
Adds a moderator role for this guild.
- This grants access to moderator level commands like:
[p]mute
[p]cleanup
[p]customcommand create
And more.
- Examples:
[p]set addmodrole @Mods
[p]set addmodrole Loyal Helpers
- Arguments:
<role>
- The role to add as a moderator.
set api¶
Note
This command is locked to the bot owner.
Syntax
[p]set api <service> <tokens>
Description
Commands to set, list or remove various external API tokens.
This setting will be asked for by some 3rd party cogs and some core cogs.
To add the keys provide the service name and the tokens as a comma separated list of key,values as described by the cog requesting this command.
Note
API tokens are sensitive, so this command should only be used in a private channel or in DM with the bot.
- Examples:
[p]set api spotify redirect_uri localhost
[p]set api github client_id,whoops client_secret,whoops
- Arguments:
<service>
- The service you’re adding tokens to.<tokens>
- Pairs of token keys and values. The key and value should be separated by one of ``, ``,
, or;
.
set api list¶
Syntax
[p]set api list
Description
Show all external API services along with their keys that have been set.
Secrets are not shown.
- Example:
[p]set api list``
set api remove¶
Syntax
[p]set api remove <services...>
Description
Remove the given services with all their keys and tokens.
- Examples:
[p]set api remove spotify
[p]set api remove github youtube
- Arguments:
<services...>
- The services to remove.
set avatar¶
Note
This command is locked to the bot owner.
Syntax
[p]set avatar [url]
Description
Sets Red’s avatar
Supports either an attachment or an image URL.
- Examples:
[p]set avatar
- With an image attachment, this will set the avatar.[p]set avatar
- Without an attachment, this will show the command help.[p]set avatar https://links.flaree.xyz/k95
- Sets the avatar to the provided url.
- Arguments:
[url]
- An image url to be used as an avatar. Leave blank when uploading an attachment.
set avatar remove¶
Note
This command is locked to the bot owner.
Syntax
[p]set avatar remove
Tip
Alias: set avatar clear
Description
Removes Red’s avatar.
- Example:
[p]set avatar remove
set colour¶
Note
This command is locked to the bot owner.
Syntax
[p]set colour [colour]
Tip
Alias: set color
Description
Sets a default colour to be used for the bot’s embeds.
Acceptable values for the colour parameter can be found at:
- Examples:
[p]set colour dark red
[p]set colour blurple
[p]set colour 0x5DADE2
[p]set color 0x#FDFEFE
[p]set color #7F8C8D
- Arguments:
[colour]
- The colour to use for embeds. Leave blank to set to the default value (red).
set competing¶
Note
This command is locked to the bot owner.
Syntax
[p]set competing [competing]
Description
Sets Red’s competing status.
This will appear as Competing in <competing>
.
Maximum length for a competing status is 128 characters.
- Examples:
[p]set competing
- Clears the activity status.[p]set competing London 2012 Olympic Games
- Arguments:
[competing]
- The text to followCompeting in
. Leave blank to clear the current activity status.
set custominfo¶
Note
This command is locked to the bot owner.
Syntax
[p]set custominfo [text]
Description
Customizes a section of [p]info
.
The maximum amount of allowed characters is 1024. Supports markdown, links and “mentions”.
Link example: [My link](https://example.com)
- Examples:
[p]set custominfo >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.
[p]set custominfo Join my [support server](discord.gg/discord)!
[p]set custominfo
- Removes custom info text.
- Arguments:
[text]
- The custom info text.
set deletedelay¶
Note
This command is locked to the server owner.
Syntax
[p]set deletedelay [time]
Description
Set the delay until the bot removes the command message.
Must be between -1 and 60.
Set to -1 to disable this feature.
This is only applied to the current server and not globally.
- Examples:
[p]set deletedelay
- Shows the current delete delay setting.[p]set deletedelay 60
- Sets the delete delay to the max of 60 seconds.[p]set deletedelay -1
- Disables deleting command messages.
- Arguments:
[time]
- The seconds to wait before deleting the command message. Use -1 to disable.
set description¶
Note
This command is locked to the bot owner.
Syntax
[p]set description [description]
Description
Sets the bot’s description.
Use without a description to reset. This is shown in a few locations, including the help menu.
The maximum description length is 250 characters to ensure it displays properly.
The default is “Red V3”.
- Examples:
[p]set description
- Resets the description to the default setting.[p]set description MyBot: A Red V3 Bot
- Arguments:
[description]
- The description to use for this bot. Leave blank to reset to the default.
set fuzzy¶
Note
This command is locked to the bot owner.
Syntax
[p]set fuzzy
Description
Toggle whether to enable fuzzy command search in DMs.
This allows the bot to identify potential misspelled commands and offer corrections.
Default is for fuzzy command search to be disabled.
- Example:
[p]set fuzzy
set globallocale¶
Note
This command is locked to the bot owner.
Syntax
[p]set globallocale <language_code>
Description
Changes the bot’s default locale.
This will be used when a server has not set a locale, or in DMs.
Go to Red’s Crowdin page to see locales that are available with translations.
To reset to English, use “en-US”.
- Examples:
[p]set locale en-US
[p]set locale de-DE
[p]set locale fr-FR
[p]set locale pl-PL
- Arguments:
<language_code>
- The default locale to use for the bot. This can be any language code with country code included.
set globalregionalformat¶
Note
This command is locked to the bot owner.
Syntax
[p]set globalregionalformat [language_code]
Tip
Alias: set globalregion
Description
Changes the bot’s regional format. This is used for formatting date, time and numbers.
language_code
can be any language code with country code included, e.g. en-US
, de-DE
, fr-FR
, pl-PL
, etc.
Leave language_code
empty to base regional formatting on bot’s locale.
- Examples:
[p]set globalregionalformat en-US
[p]set globalregion de-DE
[p]set globalregionalformat
- Resets to the locale.
- Arguments:
[language_code]
- The default region format to use for the bot.
set listening¶
Note
This command is locked to the bot owner.
Syntax
[p]set listening [listening]
Description
Sets Red’s listening status.
This will appear as Listening to <listening>
.
Maximum length for a listening status is 128 characters.
- Examples:
[p]set listening
- Clears the activity status.[p]set listening jams
- Arguments:
[listening]
- The text to followListening to
. Leave blank to clear the current activity status.
set locale¶
Note
This command is locked to the server owner.
Syntax
[p]set locale <language_code>
Description
Changes the bot’s locale in this server.
Go to Red’s Crowdin page to see locales that are available with translations.
Use “default” to return to the bot’s default set language. To reset to English, use “en-US”.
- Examples:
[p]set locale en-US
[p]set locale de-DE
[p]set locale fr-FR
[p]set locale pl-PL
[p]set locale default
- Resets to the global default locale.
- Arguments:
<language_code>
- The default locale to use for the bot. This can be any language code with country code included.
set nickname¶
Note
This command is locked to the admin role.
Syntax
[p]set nickname [nickname]
Description
Sets Red’s nickname for the current server.
Maximum length for a nickname is 32 characters.
- Example:
[p]set nickname 🎃 SpookyBot 🎃
- Arguments:
[nickname]
- The nickname to give the bot. Leave blank to clear the current nickname.
set ownernotifications¶
Note
This command is locked to the bot owner.
Syntax
[p]set ownernotifications
Description
Commands for configuring owner notifications.
Owner notifications include usage of [p]contact
and available Red updates.
set ownernotifications adddestination¶
Syntax
[p]set ownernotifications adddestination <channel>
Description
Adds a destination text channel to receive owner notifications.
- Examples:
[p]ownernotifications adddestination #owner-notifications
[p]ownernotifications adddestination 168091848718417920
- Accepts channel IDs.
- Arguments:
<channel>
- The channel to send owner notifications to.
set ownernotifications listdestinations¶
Syntax
[p]set ownernotifications listdestinations
Description
Lists the configured extra destinations for owner notifications.
- Example:
[p]ownernotifications listdestinations
set ownernotifications optin¶
Syntax
[p]set ownernotifications optin
Description
Opt-in on receiving owner notifications.
This is the default state.
Note
This will only resume sending owner notifications to your DMs.
Additional owners and destinations will not be affected.
- Example:
[p]ownernotifications optin
set ownernotifications optout¶
Syntax
[p]set ownernotifications optout
Description
Opt-out of receiving owner notifications.
Note
This will only stop sending owner notifications to your DMs.
Additional owners and destinations will still receive notifications.
- Example:
[p]ownernotifications optout
set ownernotifications removedestination¶
Syntax
[p]set ownernotifications removedestination <channel>
Tip
Aliases: set ownernotifications remdestination
, set ownernotifications deletedestination
, set ownernotifications deldestination
Description
Removes a destination text channel from receiving owner notifications.
- Examples:
[p]ownernotifications removedestination #owner-notifications
[p]ownernotifications deletedestination 168091848718417920
- Accepts channel IDs.
- Arguments:
<channel>
- The channel to stop sending owner notifications to.
set playing¶
Note
This command is locked to the bot owner.
Syntax
[p]set playing [game]
Tip
Alias: set game
Description
Sets Red’s playing status.
This will appear as Playing <game>
or PLAYING A GAME: <game>
depending on the context.
Maximum length for a playing status is 128 characters.
- Examples:
[p]set playing
- Clears the activity status.[p]set playing the keyboard
- Arguments:
[game]
- The text to followPlaying
. Leave blank to clear the current activity status.
set prefix¶
Note
This command is locked to the bot owner.
Syntax
[p]set prefix <prefixes...>
Tip
Alias: set prefixes
Description
Sets Red’s global prefix(es).
Warning
This is not additive. It will replace all current prefixes.
See also the --mentionable
flag to enable mentioning the bot as the prefix.
- Examples:
[p]set prefix !
[p]set prefix "! "
- Quotes are needed to use spaces in prefixes.[p]set prefix "@Red "
- This uses a mention as the prefix. See also the--mentionable
flag.[p]set prefix ! ? .
- Sets multiple prefixes.
- Arguments:
<prefixes...>
- The prefixes the bot will respond to globally.
set regionalformat¶
Note
This command is locked to the server owner.
Syntax
[p]set regionalformat [language_code]
Tip
Alias: set region
Description
Changes the bot’s regional format in this server. This is used for formatting date, time and numbers.
language_code
can be any language code with country code included, e.g. en-US
, de-DE
, fr-FR
, pl-PL
, etc.
Leave language_code
empty to base regional formatting on bot’s locale in this server.
- Examples:
[p]set regionalformat en-US
[p]set region de-DE
[p]set regionalformat
- Resets to the locale.
- Arguments:
[language_code]
- The region format to use for the bot in this server.
set removeadminrole¶
Note
This command is locked to the server owner.
Syntax
[p]set removeadminrole <role>
Tip
Aliases: set remadmindrole
, set deladminrole
, set deleteadminrole
Description
Removes an admin role for this guild.
- Examples:
[p]set removeadminrole @Admins
[p]set removeadminrole Super Admins
- Arguments:
<role>
- The role to remove from being an admin.
set removemodrole¶
Note
This command is locked to the server owner.
Syntax
[p]set removemodrole <role>
Tip
Aliases: set remmodrole
, set delmodrole
, set deletemodrole
Description
Removes a mod role for this guild.
- Examples:
[p]set removemodrole @Mods
[p]set removemodrole Loyal Helpers
- Arguments:
<role>
- The role to remove from being a moderator.
set serverfuzzy¶
Note
This command is locked to the server owner.
Syntax
[p]set serverfuzzy
Description
Toggle whether to enable fuzzy command search for the server.
This allows the bot to identify potential misspelled commands and offer corrections.
Note
This can be processor intensive and may be unsuitable for larger servers.
Default is for fuzzy command search to be disabled.
- Example:
[p]set serverfuzzy
set serverprefix¶
Note
This command is locked to the admin role.
Syntax
[p]set serverprefix [prefixes...]
Tip
Alias: set serverprefixes
Description
Sets Red’s server prefix(es).
Warning
This will override global prefixes, the bot will not respond to any global prefixes in this server.
This is not additive. It will replace all current server prefixes.
You cannot have a prefix with more than 25 characters.
- Examples:
[p]set serverprefix !
[p]set serverprefix "! "
- Quotes are needed to use spaces in prefixes.[p]set serverprefix "@Red "
- This uses a mention as the prefix.[p]set serverprefix ! ? .
- Sets multiple prefixes.
- Arguments:
[prefixes...]
- The prefixes the bot will respond to on this server. Leave blank to clear server prefixes.
set status¶
Note
This command is locked to the bot owner.
Syntax
[p]set status <status>
Description
Sets Red’s status.
- Available statuses:
online
idle
dnd
invisible
- Examples:
[p]set status online
- Clears the status.[p]set status invisible
- Arguments:
<status>
- One of the available statuses.
set streaming¶
Note
This command is locked to the bot owner.
Syntax
[p]set streaming [(<streamer> <stream_title>)]
Tip
Aliases: set stream
, set twitch
Description
Sets Red’s streaming status to a twitch stream.
This will appear as Streaming <stream_title>
or LIVE ON TWITCH
depending on the context.
It will also include a Watch
button with a twitch.tv url for the provided streamer.
Maximum length for a stream title is 128 characters.
Leaving both streamer and stream_title empty will clear it.
- Examples:
[p]set stream
- Clears the activity status.[p]set stream 26 Twentysix is streaming
- Sets the stream tohttps://www.twitch.tv/26
.[p]set stream https://twitch.tv/26 Twentysix is streaming
- Sets the URL manually.
- Arguments:
<streamer>
- The twitch streamer to provide a link to. This can be their twitch name or the entire URL.<stream_title>
- The text to followStreaming
in the status.
set usebotcolour¶
Note
This command is locked to the server owner.
Syntax
[p]set usebotcolour
Tip
Alias: set usebotcolor
Description
Toggle whether to use the bot owner-configured colour for embeds.
Default is to use the bot’s configured colour. Otherwise, the colour used will be the colour of the bot’s top role.
- Example:
[p]set usebotcolour
set username¶
Note
This command is locked to the bot owner.
Syntax
[p]set username <username>
Tip
Alias: set name
Description
Sets Red’s username.
Maximum length for a username is 32 characters.
Note
The username of a verified bot cannot be manually changed.
Please contact Discord support to change it.
- Example:
[p]set username BaguetteBot
- Arguments:
<username>
- The username to give the bot.
set watching¶
Note
This command is locked to the bot owner.
Syntax
[p]set watching [watching]
Description
Sets Red’s watching status.
This will appear as Watching <watching>
.
Maximum length for a watching status is 128 characters.
- Examples:
[p]set watching
- Clears the activity status.[p]set watching [p]help
- Arguments:
[watching]
- The text to followWatching
. Leave blank to clear the current activity status.
shutdown¶
Note
This command is locked to the bot owner.
Syntax
[p]shutdown [silently=False]
Description
Shuts down the bot.
Allows Red to shut down gracefully.
This is the recommended method for shutting down the bot.
- Examples:
[p]shutdown
[p]shutdown True
- Shutdowns silently.
- Arguments:
[silently]
- Whether to skip sending the shutdown message. Defaults to False.
traceback¶
Note
This command is locked to the bot owner.
Syntax
[p]traceback [public=False]
Description
Sends to the owner the last command exception that has occurred.
If public (yes is specified), it will be sent to the chat instead.
Warning
Sending the traceback publicly can accidentally reveal sensitive information about your computer or configuration.
- Examples:
[p]traceback
- Sends the traceback to your DMs.[p]traceback True
- Sends the last traceback in the current context.
- Arguments:
[public]
- Whether to send the traceback to the current context. Leave blank to send to your DMs.
unignore¶
Note
This command is locked to the admin role.
Syntax
[p]unignore
Description
Commands to remove servers or channels from the ignore list.
unignore channel¶
Syntax
[p]unignore channel [channel]
Description
Remove a channel or category from the ignore list.
Defaults to the current channel.
- Examples:
[p]unignore channel #general
- Unignores commands in the #general channel.[p]unignore channel
- Unignores commands in the current channel.[p]unignore channel "General Channels"
- Use quotes for categories with spaces.[p]unignore channel 356236713347252226
- Also accepts IDs. Use this method to unignore categories.
- Arguments:
<channel>
- The channel to unignore. This can be a category channel.
unignore server¶
Note
This command is locked to the admin role.
Syntax
[p]unignore server
Tip
Alias: unignore guild
Description
Remove this server from the ignore list.
- Example:
[p]unignore server
- Stops ignoring the current server
unload¶
Note
This command is locked to the bot owner.
Syntax
[p]unload <cogs...>
Description
Unloads previously loaded cog packages.
See packages available to unload with [p]cogs
.
- Examples:
[p]unload general
- Unloads thegeneral
cog.[p]unload admin mod mutes
- Unloads multiple cogs.
- Arguments:
<cogs...>
- The cog packages to unload.