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!
Install yarn if you haven't done so yet, npm i -g yarn or sudo npm i -g yarn if on a unix system.
Fork/Clone the repo.
Install deps with by typing yarn.
Copy .env.example to a new file .env file.
Type yarn build to build the Prisma schema.
Make a volume for the postgres database with docker volume create --name=postgres.
Start the database with docker-compose up --build postgres this will only start the postgres container.
Update the environment variable DATABASE_URL in /apps/bot with postgresql://postgres:internalpassword@localhost:5432/bot?schema=public
Before testing make sure to push the schema to the database with yarn pushdb (you will need to re-run this every time you make changes to prisma/schema.prisma)
Test with yarn dev. Every time you save a file the running instance will automatically stop, build and restart.
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:
If after reading the guide you are still experiencing issues, feel free to join the Official Discord Server and ask in the #support channel for help.
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!
bavarianVerifier
Checks any message containing a group ping and verifies whether the author is actually part of that group and gives a timeout if he isn't. Comes with an additional flair message for group members.
checkSnail
Holds a list of the unique id of the last 1000 tweets posted in channels and calls out a user for a repost.
cinephile
Uses regex to extract movie titles mentioned in the message (using the criterion collection format, i.e. <TITLE> (<year of release>) )and combines it with newspapers nlp methods to respond with a letterboxd review of said movie
scholar
Uses regex to extract authors and year of a paper mentioned in the message and then crawls google scholar to figure out the title and abstract of the paper
wikiCrawl
Uses a wikipedia-api to obtain the summary of the wikipedia article of a given term
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.