Welcome to Red-DiscordBot’s documentation!¶
Red’s commands¶
Red is now modular and uses commands + subcommands~
If you are confused, type in [p]help [command] and if help command
lists subcommands do [p]help [command] [subcommand]
[p] being short for your prefix, such as !, ., ^
NOTE: Do not write your commands in [] or [].
Wrong Example: [p]play [http://youtube.com.....]
Right Example: [p]play http://youtube.com.....
Danger
This list is not up to date with the current version and it’s only meant to be a general reference for the features that Red offers. Always rely on the internal help command.
Alias¶
| Command | Description |
|---|---|
| alias | Manage per-server aliases for commands |
Audio¶
| Command | Description |
|---|---|
| cache | Cache management tools. |
| skip | Skips a song, using the set threshold if the requester isn’t |
| queue | Queues a song to play next. Extended functionality in [p]help |
| shuffle | Shuffles the current queue |
| local | Local playlists commands |
| prev | Goes back to the last song. |
| stop | Stops a currently playing song or playlist. CLEARS QUEUE. |
| playlist | Playlist management/control. |
| yt | Searches and plays a video from YouTube |
| sing | Makes Red sing one of her songs |
| pause | Pauses the current song, [p]resume to continue. |
| play | Plays a link / searches and play |
| skip | Skips a song, using the set threshold if the requester isn’t |
| song | Info about the current song. |
| audiostat | General stats on audio stuff. |
| repeat | Toggles REPEAT |
| audioset | Audio settings. |
| resume | Resumes a paused song or playlist |
CustomCommands¶
| Command | Description |
|---|---|
| cc edit | Edits a custom command |
| cc list | Shows custom commands list |
| cc delete | Deletes a custom command |
| cc add | Adds a custom command |
Downloader¶
| Command | Description |
|---|---|
| cog | Additional cogs management |
Economy¶
| Command | Description |
|---|---|
| payday | Get some free credits |
| economyset | Changes economy module settings |
| slot | Play the slot machine |
| leaderboard | Server / global leaderboard |
| bank | Bank operations |
| payouts | Shows slot machine payouts |
General¶
| Command | Description |
|---|---|
| flip | Flips a coin... or a user. |
| roll | Rolls random number (between 1 and user choice) |
| stopwatch | Starts/stops stopwatch |
| 8 | Ask 8 ball a question |
| lmgtfy | Creates a lmgtfy link |
| hug | Because everyone likes hugs |
| userinfo | Shows users’s informations |
| poll | Starts/stops a poll |
| rps | Play rock paper scissors |
| stopwatch | Starts/stops stopwatch |
| choose | Chooses between multiple choices. |
| 8 | Ask 8 ball a question |
| urban | Urban Dictionary search |
| serverinfo | Shows server’s informations |
| ping | Pong. |
Image¶
| Command | Description |
|---|---|
| gif | Retrieves first search result from giphy |
| gifr | Retrieves a random gif from a giphy search |
| imgur | Retrieves a picture from imgur |
Mod¶
| Command | Description |
|---|---|
| reason | Lets you specify a reason for mod-log’s cases |
| names | Show previous names/nicknames of a user |
| ignore | Adds servers/channels to ignorelist |
| mute | Mutes user in the channel/server |
| whitelist | Users who will be able to use the bot |
| editrole | Edits roles settings |
| ban | Bans user and deletes last X days worth of messages. |
| modset | Manages server administration settings. |
| blacklist | Bans user from using the bot |
| unmute | Unmutes user in the channel/server |
| cleanup | Deletes messages. |
| rename | Changes user’s nickname |
| kick | Kicks user. |
| unignore | Removes servers/channels from ignorelist |
| filter | Adds/removes words from filter |
| softban | Kicks the user, deleting 1 day worth of messages. |
Owner¶
| Command | Description |
|---|---|
| unload | Unloads a module |
| load | Loads a module |
| command | Disables/enables commands |
| leave | Leaves server |
| reload | Reloads a module |
| version | Shows Red’s current version |
| shutdown | Shuts down Red |
| contact | Sends message to the owner |
| cogs | Shows loaded/unloaded cogs |
| servers | Lists and allows to leave servers |
| set | Changes Red’s global settings. |
| uptime | Shows Red’s uptime |
| info | Shows info about Red |
| join | Joins new server |
| debug | Evaluates code |
Streams¶
| Command | Description |
|---|---|
| streamset | Stream settings |
| streamalert | Adds/removes stream alerts from the current channel |
| twitch | Checks if twitch stream is online |
| hitbox | Checks if hitbox stream is online |
| beam | Checks if beam stream is online |
Trivia¶
| Command | Description |
|---|---|
| trivia | Start a trivia session with the specified list |
| triviaset | Change trivia settings |
None¶
| Command | Description |
|---|---|
| help | Shows this message. |
Installing on Windows¶
Software¶
Install Python. Red needs the latest 3.5.x. Avoid 3.6 for the time being as there are known installation issues with it.
Install Git. Git is necessary for downloading cogs and keeping Red up to date with the latest changes.
Important
Failure to add the above software to PATH like shown will result in failure of the following steps.
Installation¶
- Go to the folder you want to install Red in. Don’t create a separate folder for it, the installer will do it by itself.Right click. This is what you should see.
Open git bash and you should see a console similar to Windows’ command prompt.
Git bash
Copy/paste this:
git clone -b develop --single-branch https://github.com/Twentysix26/Red-DiscordBot.git Red-DiscordBot
Click on start_launcher.bat. Red’s launcher will open up: it’s an applications made to facilitate many common operations. Navigating the menus is simple: pick a number and press enter.
- First things first: let’s install Red’s requirements. Pick the appropriate option from the main menu.If you’re interested in audio you’ll need to pick ffmpeg as well: make sure to install the 64 bit version (assuming you’re on a 64bit system), as the installation is entirely automated.
updatescreen
Running Red¶
Having completed the previous steps, Red should be good to go. Go back to the main menu and pick the Run Red option.
You will be prompted for a token. Make a new bot user by following the “Creating a new bot account” section.
Complete the configuration process. You’ll be able to invite your bot to your server by using the invite link that’s provided at boot.
Consult the Getting started page for a practical guide on familiarizing yourself with Red.
Tip
The launcher will create 2 batch files: start_red.bat and start_red_autostart.bat. You can use those to start Red directly without passing through the launcher.
Updates¶
Keep Red and its requirements up to date by occasionally running the update option from the launcher.