mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
53 lines
1.3 KiB
ReStructuredText
53 lines
1.3 KiB
ReStructuredText
--------------
|
|
Installing Red
|
|
--------------
|
|
|
|
Choose one of the following commands to install Red.
|
|
|
|
To install without additional config backend support:
|
|
|
|
.. prompt:: bash
|
|
:prompts: (redenv) $
|
|
|
|
python -m pip install -U pip wheel
|
|
python -m pip install -U Red-DiscordBot
|
|
|
|
Or, to install with PostgreSQL support:
|
|
|
|
.. prompt:: bash
|
|
:prompts: (redenv) $
|
|
|
|
python -m pip install -U pip wheel
|
|
python -m pip install -U "Red-DiscordBot[postgres]"
|
|
|
|
|
|
--------------------------
|
|
Setting Up and Running Red
|
|
--------------------------
|
|
|
|
After installation, set up your instance with the following command:
|
|
|
|
.. prompt:: bash
|
|
:prompts: (redenv) $
|
|
|
|
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:
|
|
|
|
.. prompt:: bash
|
|
:prompts: (redenv) $
|
|
|
|
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 <../bot_application_guide>`.
|
|
|
|
.. 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.
|