mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
203cde9805
* create * add the code * change de logs * lets remember linux exists * fix formtting and change wording * change the wording a bit more... after running `sphinx-build` it def looks like i used bold a lot god that was a long commit mesage * review changes * draper's review (see description) i have put or worse partially to scare users and partially as there are other possible effects of a downgrade * review * clarity
126 lines
4.1 KiB
ReStructuredText
126 lines
4.1 KiB
ReStructuredText
.. _windows-install-guide:
|
|
|
|
=========================
|
|
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 <https://chocolatey.org>`_
|
|
|
|
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:
|
|
|
|
.. code-block:: none
|
|
|
|
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 <installing-red-windows>`.
|
|
|
|
********************************
|
|
Manually installing dependencies
|
|
********************************
|
|
|
|
* `Python <https://www.python.org/downloads/>`_ - 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.
|
|
|
|
* `Git <https://git-scm.com/download/win>`_
|
|
|
|
.. attention:: Please choose the option to "Git from the command line and also from 3rd-party software" in Git's setup.
|
|
|
|
* `Java <https://java.com/en/download/manual.jsp>`_ - needed for Audio
|
|
|
|
.. attention:: Please choose the "Windows Online" installer.
|
|
|
|
.. _installing-red-windows:
|
|
|
|
--------------
|
|
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:
|
|
|
|
.. code-block:: none
|
|
|
|
py -3.7 -m pip install --user -U Red-DiscordBot
|
|
|
|
* Normal installation:
|
|
|
|
.. code-block:: none
|
|
|
|
python -m pip install -U Red-DiscordBot
|
|
|
|
* With PostgreSQL support:
|
|
|
|
.. code-block:: none
|
|
|
|
python3.7 -m pip install -U Red-DiscordBot[postgres]
|
|
|
|
.. note::
|
|
|
|
To install the development version, replace ``Red-DiscordBot`` in the above commands with the
|
|
link below. **The development version of the bot contains experimental changes. It is not
|
|
intended for normal users.** We will not support anyone using the development version in any
|
|
support channels. Using the development version may break third party cogs and not all core
|
|
commands may work. Downgrading to stable after installing the development version may cause
|
|
data loss, crashes or worse.
|
|
|
|
.. code-block:: none
|
|
|
|
git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
|
|
|
|
--------------------------
|
|
Setting Up and Running Red
|
|
--------------------------
|
|
|
|
After installation, set up your instance with the following command:
|
|
|
|
.. code-block:: none
|
|
|
|
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:
|
|
|
|
.. code-block:: none
|
|
|
|
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
|
|
:dpy_docs:`this guide <discord.html#creating-a-bot-account>`,
|
|
section "Creating a Bot Account".
|
|
|
|
.. tip::
|
|
If it's the first time you're using Red, you should check our `getting-started` guide
|
|
that will walk you through all essential information on how to interact with Red.
|