mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
1a9216b522
* Set 3.6.6 as minimum python version on Windows Signed-off-by: Toby Harradine <tobyharradine@gmail.com> * Conditional python_requires in setup.py Signed-off-by: Toby Harradine <tobyharradine@gmail.com> * Should probably add the comment too Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
95 lines
2.6 KiB
ReStructuredText
95 lines
2.6 KiB
ReStructuredText
.. _windows-install-guide:
|
|
|
|
=========================
|
|
Installing Red on Windows
|
|
=========================
|
|
|
|
---------------
|
|
Needed Software
|
|
---------------
|
|
|
|
* `Python <https://www.python.org/downloads/>`_ - 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
|
|
|
|
* `Git <https://git-scm.com/download/win>`_
|
|
|
|
.. attention:: Please choose the option to "Run Git from the Windows Command Prompt" 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
|
|
--------------
|
|
|
|
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:
|
|
|
|
.. code-block:: none
|
|
|
|
python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot
|
|
|
|
* With audio:
|
|
|
|
.. code-block:: none
|
|
|
|
python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice]
|
|
|
|
* With audio and MongoDB support:
|
|
|
|
.. code-block:: none
|
|
|
|
python -m pip install -U --process-dependency-links --no-cache-dir Red-DiscordBot[voice,mongo]
|
|
|
|
.. note::
|
|
|
|
To install the development version, replace ``Red-DiscordBot`` in the above commands with the
|
|
following link:
|
|
|
|
.. 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 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:
|
|
|
|
.. code-block:: none
|
|
|
|
redbot-launcher
|