Welcome to Red - Discord Bot’s documentation!

Installation Guides:

• Installing Red
• Creating a bot account
• Updating Red
• About Virtual Environments
• Setting up auto-restart using batch on Windows
• Setting up auto-restart on Mac
• Setting up auto-restart using systemd on Linux

Cog Reference:

• CustomCommands Cog Reference
  • How it works
  • Cooldowns
  • Context Parameters
  • Command Parameters
  • Example commands
• Permissions Cog Reference
  • How it works
  • Rule priority
  • Setting Rules From a File
  • Example configurations
• Trivia List Creation Guide
  • Getting Started
  • Author Field
  • Description Field
  • Questions and Answers
  • Optional: Custom Overrides

User guides:

• Getting started
  • Invite Red to your server
  • Interact with Red
  • Cogs
  • Permissions
  • Hosting
  • User documentation
• About (privileged) intents and public bots
  • Intents
  • Public bots
  • Bot verification process
  • Message intent and slash commands
• Admin
  • Usage
  • Commands
• Alias
  • Usage
  • Commands
• Audio
  • Basic Audio Use
  • Frequently Asked Questions
  • Queue Related Commands
  • Playlist Commands
  • Owner-Only Audioset Commands
  • Guild-based Audioset Commands
  • Spotify Playback and API Keys
  • Local Tracks
  • DJ Role and Voteskip
  • Sound Quality Issues
  • Lavalink - Red Community-Supported Advanced Usage
  • Setting up an unmanaged Lavalink node on a remote VPS or server
  • Commands
  • Lavalink Setup Commands
  • Managed Node Management Commands
  • Unmanaged Node Management Commands
• Cleanup
  • Usage
  • Commands
• Cog Manager UI
  • Usage
  • Commands
• Core
  • Usage
  • Commands
• CustomCommands
  • Usage
  • Commands
• Dev
  • Usage
  • Commands
• Downloader
  • Usage
  • Commands
• Economy
  • Usage
  • Commands
• Filter
  • Usage
  • Commands
• General
  • Usage
  • Commands
• Image
  • Usage
  • Commands
• Permissions
  • Usage
  • Commands
• Mod
  • Usage
  • Commands
• ModLog
  • Usage
  • Commands
• Mutes
  • Usage
  • Commands
• Reports
  • Usage
  • Commands
• Streams
  • Usage
  • Commands
• Trivia
  • Usage
  • Commands
• Warnings
  • Usage
  • Commands
• Red and End User Data
  • Notes for everyone
  • Additional Notes for Bot Owners and Hosts

Red Development Framework Reference:

• Migrating cogs from Red V2
  • Red as a package
  • Cogs as packages
  • Config
  • Bank
  • Mod Log
• Creating cogs for Red V3
  • Getting started
  • Setting up a package
  • Creating a cog
  • Testing your cog
  • Publishing your cog
  • Becoming an Approved Cog Creator
  • Additional resources
• Slash Commands and Interactions
  • Getting Started
  • Slash Commands and Arguments
  • Hybrid Commands
  • Context Menu Commands
  • Closing Words and Further Reading
• Publishing cogs for Red V3
  • Repository Template
  • Info.json format
  • Adding to the Index
• Becoming an Approved Cog Creator
  • Creating a Cog Creator Application
  • Requirements for Cog Creators
  • Recommendations for Cog Creators
  • Perks of being a Cog Creator
  • Other Details
• Shared API Keys
  • Basic Usage
  • Event Reference
  • Additional References
• Bank
  • Basic Usage
  • API Reference
• Bot
  • Red
• Command Check Decorators
  • admin()
  • admin_or_can_manage_channel()
  • admin_or_permissions()
  • bot_can_manage_channel()
  • bot_can_react()
  • bot_has_permissions()
  • bot_in_a_guild()
  • can_manage_channel()
  • guildowner()
  • guildowner_or_can_manage_channel()
  • guildowner_or_permissions()
  • has_guild_permissions()
  • has_permissions()
  • is_owner()
  • mod()
  • mod_or_can_manage_channel()
  • mod_or_permissions()
  • permissions_check()
• Commands Package
  • command()
  • hybrid_command()
  • group()
  • hybrid_group()
  • Cog
  • GroupCog
  • Command
  • HybridCommand
  • Group
  • HybridGroup
  • Context
  • GuildContext
  • DMContext
  • UserFeedbackCheckFailure
  • commands.requires
  • PermState
  • PrivilegeLevel
  • Requires
  • commands.converter
  • UserInputOptional
  • CogConverter
  • CommandConverter
  • DictConverter
  • NoParseOptional
  • RawUserIdConverter
  • RelativedeltaConverter
  • TimedeltaConverter
  • finite_float()
  • get_dict_converter()
  • get_timedelta_converter()
  • parse_relativedelta()
  • parse_timedelta()
  • positive_int
  • Help Functionality
• App Commands Package
  • UserFeedbackCheckFailure
• Config
  • Basic Usage
  • Tutorial
  • Advanced Usage
  • V2 Data Usage
  • Best practices and performance notes
  • API Reference
• Data Manager
  • bundled_data_path()
  • cog_data_path()
  • data_path()
  • instance_name()
  • metadata_file()
  • storage_details()
  • storage_type()
• Custom Events
  • RPC Server
• Internationalization Framework
  • Basic Usage
  • Tutorial
  • API Reference
• Mod log
  • Basic Usage
  • Registering Case types
  • API Reference
• RPC
  • Examples
  • Interacting with the RPC Server
  • API Reference
• Tree
  • RedTree
• Utility Functions
  • General Utility
  • Chat Formatting
  • Embed Helpers
  • Menus
  • Event Predicates
  • Mod Helpers
  • Tunnel
  • Common Filters
  • Utility UI
  • AntiSpam
• Versioning
• End-user Guarantees
• Developer Guarantees
  • Exclusions
• Breaking Change Notices

Others

• Changelog
  • Redbot 3.5.14 (2024-12-25)
  • Redbot 3.5.13 (2024-08-27)
  • Redbot 3.5.12 (2024-08-08)
  • Redbot 3.5.11 (2024-08-04)
  • Redbot 3.5.10 (2024-07-10)
  • Redbot 3.5.9 (2024-04-21)
  • Redbot 3.5.8 (2024-04-01)
  • Redbot 3.5.7 (2024-03-24)
  • Redbot 3.5.6 (2024-03-22)
  • Redbot 3.5.5 (2023-09-14)
  • Redbot 3.5.4 (2023-08-12)
  • Redbot 3.5.3 (2023-07-24)
  • Redbot 3.5.2 (2023-05-14)
  • Redbot 3.5.1 (2023-05-04)
  • Redbot 3.5.0 (2023-05-04)
  • Redbot 3.4.19 (2023-04-20)
  • Redbot 3.4.18 (2022-08-15)
  • Redbot 3.4.17 (2022-06-07)
  • Redbot 3.4.16 (2021-12-31)
  • Redbot 3.4.15 (2021-12-31)
  • Redbot 3.4.14 (2021-09-23)
  • Redbot 3.4.13 (2021-09-09)
  • Redbot 3.4.12 (2021-06-17)
  • Redbot 3.4.11 (2021-06-12)
  • Redbot 3.4.10 (2021-05-28)
  • Redbot 3.4.9 (2021-04-06)
  • Redbot 3.4.8 (2021-04-06)
  • Redbot 3.4.7 (2021-02-26)
  • Redbot 3.4.6 (2021-02-16)
  • Redbot 3.4.5 (2020-12-24)
  • Redbot 3.4.4 (2020-12-24)
  • Redbot 3.4.3 (2020-11-16)
  • Redbot 3.4.2 (2020-10-28)
  • Redbot 3.4.1 (2020-10-27)
  • Redbot 3.4.0 (2020-08-17)
  • Redbot 3.3.12 (2020-08-18)
  • Redbot 3.3.11 (2020-08-10)
  • Redbot 3.3.10 (2020-07-09)
  • Redbot 3.3.9 (2020-06-12)
  • Redbot 3.3.8 (2020-05-29)
  • Redbot 3.3.7 (2020-04-28)
  • Redbot 3.3.6 (2020-04-27)
  • Redbot 3.3.5 (2020-04-09)
  • Redbot 3.3.4 (2020-04-05)
  • Redbot 3.3.3 (2020-03-28)
  • Redbot 3.3.2 (2020-02-28)
  • Redbot 3.3.1 (2020-02-05)
  • Redbot 3.3.0 (2020-01-26)
  • Redbot 3.2.3 (2020-01-17)
  • Redbot 3.2.2 (2020-01-10)
  • Redbot 3.2.1 (2020-01-10)
  • Redbot 3.2.0 (2020-01-09)
  • Redbot 3.1.9 (2020-01-08)
  • Redbot 3.1.8 (2019-11-19)
  • Redbot 3.1.7 (2019-11-05)
  • Redbot 3.1.6 (2019-10-18)
  • Redbot 3.1.5 (2019-07-31)
  • Redbot 3.1.4 (2019-07-16)
  • Redbot 3.1.3 (2019-07-14)
  • Redbot 3.1.2 (2019-05-31)
  • Redbot 3.1.1 (2019-05-15)
  • Redbot 3.1.0 (2019-05-15)
  • Redbot 3.0.2 (2019-02-24)
  • Redbot 3.0.1 (2019-02-17)
  • Redbot 3.0.0 (2019-01-28)
• Backward incompatible changes
  • Future changes (currently deprecated functionality)
  • Backward incompatible changes in Red 3.5
• Hosting Information
  • Hosting on a VPS or Dedicated Server
  • Self Hosting
  • Choosing a Provider
  • Average Providers
  • Higher End Providers
  • Free Hosting

Indices and tables

• Index

• Module Index

• Search Page