Installing Red on Windows

Needed Software

The following software dependencies can all be installed quickly and easily through PowerShell, using a trusted package manager for Windows called Chocolatey

We also provide instructions for manually installing all of the dependencies.

Installing using powershell and chocolatey

To install via PowerShell, search “powershell” in the Windows start menu, right-click on it and then click “Run as administrator”

Then run each of the following commands:

Set-ExecutionPolicy Bypass -Scope Process -Force
iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
choco install git --params "/GitOnlyOnPath /WindowsTerminal" -y
choco install jre8 python -y; exit

From here, continue onto installing Red.

Manually installing dependencies

  • Python - Red needs Python 3.7.0 or greater

Attention

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 “Git from the command line and also from 3rd-party software” in Git’s setup.

  • Java - needed for Audio

Attention

Please choose the “Windows Online” installer.

Installing Red

Attention

You may need to restart your computer after installing dependencies for the PATH changes to take effect.

  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, use py -3.7 in place of python, and include the --user flag with all pip install commands, like this:

py -3.7 -m pip install --user -U Red-DiscordBot
  • Normal installation:

    python -m pip install -U Red-DiscordBot
    
  • With MongoDB support:

    python -m pip install -U Red-DiscordBot[mongo]
    
  • With PostgreSQL support:

    python3.7 -m pip install -U Red-DiscordBot[postgres]
    

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 can find out how to obtain a token with this guide, section “Creating a Bot Account”.