CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-05 17:02:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

Red 3.5.0 - Changelog (#6106)

Browse Source 
Co-authored-by: Jakub Kuczys <me@jacken.men>
Co-authored-by: aikaterna <20862007+aikaterna@users.noreply.github.com>
This commit is contained in:
Flame442
2023-05-03 20:53:02 -04:00
committed by GitHub
parent 525c3885cd
commit b3fd90ae4c
5 changed files with 358 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/cog_guides/core.rst
View File

@@ -3676,7 +3676,7 @@ set serverprefix
.. code-block:: none
[p]set serverprefix [prefixes...]
[p]set serverprefix [server] [prefixes...]
.. tip:: Alias: ``set serverprefixes``
@@ -3697,6 +3697,7 @@ Sets Red's server prefix(es).
- ``[p]set serverprefix ! ? .`` - Sets multiple prefixes.
**Arguments:**
- ``[server]`` - The server to set the prefix for. Defaults to current server.
- ``[prefixes...]`` - The prefixes the bot will respond to on this server. Leave blank to clear server prefixes.
.. _core-command-set-showsettings:
@@ -3709,12 +3710,17 @@ set showsettings
.. code-block:: none
[p]set showsettings
[p]set showsettings [server]
**Description**
Show the current settings for Red.
Accepts optional server parameter to allow prefix recovery.
**Arguments:**
- ``[server]`` - The server to show the settings for. Defaults to current server, or no server in a DM context.
.. _core-command-set-status:
""""""""""

122
docs/update_red.rst
View File

@@ -12,7 +12,7 @@ Here are some things to consider to help make your upgrade as smooth as possible
.. note::
If you're developing for Red, you should also look for "Breaking changes" sections in release notes for each minor (X.Y.0) version that's been released since you last updated Red.
If you're developing for Red, you should also look for "Breaking changes" sections in release notes for each minor (X.Y.0) version that's been released since you last updated Red. To make the migration process easier, we also provide an extensive `incompatible_changes/index` document explaining the breaking changes we've made in more detail.
.. important::
@@ -25,45 +25,40 @@ Updating differs depending on the version you currently have. Next sections will
:depth: 1
Red 3.2.0 or newer
Red 3.5.0 or newer
******************
Windows
-------
If you have Red 3.2.0 or newer, you can upgrade by following these steps:
If you have Red 3.5.0 or newer, you can upgrade by following these steps:
1. Shut your bot down.
2. Activate your venv with the following command:
#. Shut your bot down.
#. Activate your venv with the following command:
.. prompt:: batch
"%userprofile%\redenv\Scripts\activate.bat"
3. Update Red with this command:
#. Update Red with this command:
.. prompt:: batch
:prompts: (redenv) C:\\>
python -m pip install -U Red-DiscordBot
.. attention::
.. attention::
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
4. Start your bot.
5. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
#. Start your bot.
#. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
Linux & Mac
-----------
If you have Red 3.2.0 or newer, you can upgrade by following these steps:
If you have Red 3.5.0 or newer, you can upgrade by following these steps:
1. Shut your bot down.
2. Activate your virtual environment.
#. Shut your bot down.
#. Activate your virtual environment.
If you used ``venv`` for your virtual environment, use:
@@ -76,21 +71,100 @@ If you have Red 3.2.0 or newer, you can upgrade by following these steps:
.. prompt:: bash
pyenv shell <name>
3. Update Red with this command:
#. Update Red with this command:
.. prompt:: bash
:prompts: (redenv) $
python -m pip install -U Red-DiscordBot
.. attention::
.. attention::
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
#. Start your bot.
#. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
4. Start your bot.
Red 3.2.0-3.4.19
****************
5. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
Windows
-------
If you have a Red version between 3.2.0 and 3.4.19, you can upgrade by following these steps:
#. Shut your bot down.
#. Activate your venv with the following command:
.. prompt:: batch
"%userprofile%\redenv\Scripts\activate.bat"
#. Update Red with this command:
.. prompt:: batch
:prompts: (redenv) C:\\>
python -m pip install -U Red-DiscordBot
.. attention::
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
#. If you're using **any** 3rd-party cogs:
#. Start your bot with ``--load-cogs downloader`` flag, for example:
.. prompt:: batch
:prompts: (redenv) C:\\>
redbot <your instance name> --load-cogs downloader
#. Wait for the bot to start.
#. Run the ``[p]cog update`` command on Discord and wait for it to finish.
#. Shutdown the bot with the ``[p]shutdown`` command.
#. Start your bot as you normally do.
Linux & Mac
-----------
If you have a Red version between 3.2.0 and 3.4.19, you can upgrade by following these steps:
#. Shut your bot down.
#. Activate your virtual environment.
If you used ``venv`` for your virtual environment, use:
.. prompt:: bash
source ~/redenv/bin/activate
If you used ``pyenv`` for your virtual environment, use:
.. prompt:: bash
pyenv shell <name>
#. Update Red with this command:
.. prompt:: bash
:prompts: (redenv) $
python -m pip install -U Red-DiscordBot
.. attention::
If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
#. **If you're using any 3rd-party cogs:**
#. Start your bot with ``--load-cogs downloader`` flag, for example:
.. prompt:: bash
:prompts: (redenv) $
redbot <your instance name> --load-cogs downloader
#. Wait for the bot to start.
#. Run the ``[p]cog update`` command on Discord and wait for it to finish.
#. Shutdown the bot with the ``[p]shutdown`` command.
#. Start your bot as you normally do.
Red 3.1.X
*********