Installing Red on Windows

Needed Software

  • Python - Red needs Python 3.6.6 or greater on Windows

Note

Please make sure that the box to add Python to PATH is CHECKED, otherwise you may run into issues when trying to run Red

Attention

Please choose the option to “Run Git from the Windows Command Prompt” in Git’s setup

  • Java - needed for Audio

Attention

Please choose the “Windows Online” installer

Installing Red

  1. Open a command prompt (open Start, search for “command prompt”, then click it)
  2. Create and activate a virtual environment (strongly recommended), see the section Using venv
  3. Run one of the following commands, depending on what extras you want installed

Note

If you’re not inside an activated virtual environment, include the --user flag with all pip commands.

  • No audio:

    python -m pip install -U Red-DiscordBot
    
  • With audio:

    python -m pip install -U Red-DiscordBot[voice]
    
  • With audio and MongoDB support:

    python -m pip install -U Red-DiscordBot[voice,mongo]
    

Note

To install the development version, replace Red-DiscordBot in the above commands with the following link:

git+https://github.com/Cog-Creators/[email protected]/develop#egg=Red-DiscordBot

Setting Up and Running Red

After installation, set up your instance with the following command:

redbot-setup

This will set the location where data will be stored, as well as your storage backend and the name of the instance (which will be used for running the bot).

Once done setting up the instance, run the following command to run Red:

redbot <your instance name>

It will walk through the initial setup, asking for your token and a prefix.

You may also run Red via the launcher, which allows you to restart the bot from discord, and enable auto-restart. You may also update the bot from the launcher menu. Use the following command to run the launcher:

redbot-launcher