Overview • Installation • Documentation • Plugins • Community • License
Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your liking, making it completely customizable. This is a self-hosted bot – meaning you will need to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot, new best friend or all of these together!
Installation is easy, and you do NOT need to know anything about coding! Aside from installing and updating, every part of the bot can be controlled from within Discord.
The default set of modules includes and is not limited to:
- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)
- Trivia (lists are included and can be easily added)
- Music features (YouTube, SoundCloud, local files, playlists, queues)
- Stream alerts (Twitch, Youtube, Picarto)
- Bank (slot machine, user credits)
- Custom commands
- Imgur/gif search
- Admin automation (self-role assignment, cross-server announcements, mod-mail reports)
- Customisable command permissions
Additionally, other plugins (cogs) can be easily found and added from our growing community of cog repositories.
The following platforms are officially supported:
Official Discord Server and ask in the #support channel for help.
This guide ensures Red-Bot and the Lavalink audio server communicate correctly within the same Docker container, resolving common port and host (localhost vs external IP) conflicts.
Navigate to the server creation section and complete the "Information" tab:
| Field | Recommended Value | Notes |
|---|---|---|
| Name | MyRedBot |
Your preferred server name. |
| Node | YourNode |
(Based on your host configuration). |
| Primary Allocation | 0.0.0.0:2333 |
Essential: Map the server to port 2333, which is the standard Lavalink port. |
Resource Recommendations:
- Basic: 150MB RAM, 1GB Disk Space. (Configure these limits within the Pelican Panel settings).
- With Audio (Lavalink): 1GB RAM, 1GB Disk Space. (Configure these limits within the Pelican Panel settings).
Navigate to the "Environment Configuration" tab. By setting these variables, you instruct Red-Bot to launch and utilize its own local Lavalink instance.
| Variable | Value | Explanation |
|---|---|---|
Bot Token (RED_TOKEN) |
YOUR_DISCORD_BOT_TOKEN |
Your Discord bot's secret token (mandatory). |
Instance Name (INSTANCE_NAME) |
red |
Internal name for the Red-Bot instance. |
Owner ID (OWNER_ID) |
YOUR_DISCORD_USER_ID |
Your Discord user ID for superuser permissions (mandatory). |
Prefix (PREFIX) |
! |
The command prefix you wish to use. |
Lavalink Host (LAVALINK_HOST) |
localhost | Key: Leaving this empty tells Red-Bot to use its own local instance (localhost), ignoring problematic external IPs. |
Lavalink Port (LAVALINK_PORT) |
2333 |
Key: Forces Red-Bot to look for the service on the correct port. |
Lavalink Password (LAVALINK_PASSWORD) |
youshallnotpass |
The standard Lavalink default password. |
After installation, check the server console. If you see repeated Failed connect attempt errors, it means Lavalink may be attempting to bind to an incorrect port.
Upon successful connection, the console should show:
Lavalink WS connecting to ws://localhost:2333...Lavalink WS connected to ws://localhost:2333
Red is fully modular, allowing you to load and unload plugins of your choice, and install 3rd party plugins directly from Discord! A few examples are:
- Cleverbot integration (talk to Red and she talks back)
- Ban sync
- Welcome messages
- Casino
- Reaction roles
- Slow Mode
- AniList
- And much, much more!
Feel free to take a peek at a list of available 3rd party cogs!
Red is in continuous development, and it’s supported by an active community which produces new content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t find the cog you’re looking for, consult our guide on building your own cogs!
Join us on our Official Discord Server!
Released under the GNU GPL v3 license.
Red is named after the main character of "Transistor", a video game by Super Giant Games.
Artwork created by Sinlaire on Deviant Art for the Red Discord Bot Project.
This project vendors discord.ext.menus package made by Danny Y. (Rapptz) which is distributed under MIT License. A copy of this license can be found in the discord-ext-menus.LICENSE file in the redbot/vendored folder of this repository.