[3.4] Version bump to 3.4.19 (#6087)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.git-blame-ignore-revs

@@ -1,40 +0,0 @@
-# Since version 2.23 (released in August 2019), git-blame has a feature
-# to ignore or bypass certain commits.
-#
-# This file contains a list of commits that are not likely what you
-# are looking for in a blame, such as mass reformatting or renaming.
-# You can set this file as a default ignore file for blame by running
-# the following command.
-#
-# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
-
-# [V3] Update code standards (black code format pass) (#1650)
-b88b5a2601f56bda985729352d24842f087a8ade
-
-# Black tests and setup.py (#1657)
-e01cdbb0912387749d9459e1d934f9ed393a9b51
-
-# Black formatting for generate_strings.py and docs/conf.py (#1658)
-1ecaf6f8d5f2af731bec3eb6ad3a9721ab7a2812
-
-# [V3 Travis] Update travis to not skip pipfile lock... (#1678)
-# additional black formatting pass to conform to black 18.5b
-d3f406a34a5cae6ea63664e76e8e74be43f9949f
-
-# [V3] Update black version and reformat (#1745)
-14cc701b25cea385fd0d537cdb6475d341c017c5
-
-# [V3] Clean up some ugly auto-formatted strings (#1753)
-622382f42588ac1d8a52bd3e39bf171c89ff0224
-
-# [CI] Improve automated checks (#2702)
-16443c8cc0c24cbc5b3dc7de858edb71b9ca6cd3
-
-# Bump black to 20.8b1 (and reformat) (#4371)
-85afe19455f91af21a0f603705eeb5d9599b45cc
-
-# Reformat with Black 22.1.0 (#5633)
-c69e8d31fdadbe10230ec0ea2ef35402e5c4cf43
-
-# Reformat with Black 2023 formatting changes
-226d8d734de43e1d5ea96a528a8e480641604db1

.git_archive_info.txt

@@ -1,2 +0,0 @@
-$Format:%h$
-$Format:%(describe:tags=true)$

.gitattributes

@@ -2,10 +2,3 @@
 
 # binary file excludsions
 *.png binary
-
-# include commit/tag information in `.git_archive_info.txt` when packing with git-archive
-.git_archive_info.txt export-subst
-
-# hide diffs for .po files by default
-# https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github
-*.po linguist-generated

.github/CODEOWNERS

@@ -1,25 +1,18 @@
 # Cogs
 /redbot/cogs/audio/** @aikaterna @PredaaA
-/redbot/cogs/downloader/* @Jackenmen
+/redbot/cogs/downloader/* @jack1142
 /redbot/cogs/streams/* @palmtree5
 /redbot/cogs/mutes/* @TrustyJAID
 
-# Docs - Install and update guides
-/docs/install_guides/** @Jackenmen
-/docs/update_red.rst @Jackenmen
-
-# Docs - Version guarantees
-/docs/version_guarantees.rst @Jackenmen
-
 # Trivia Lists
 /redbot/cogs/trivia/data/lists/whosthatpokemon*.yaml @aikaterna
 
 # Tests
-/redbot/pytest/downloader* @Jackenmen
-/tests/cogs/downloader/* @Jackenmen
+/redbot/pytest/downloader* @jack1142
+/tests/cogs/downloader/* @jack1142
 
 # Schemas
-/schema/* @Jackenmen
+/schema/* @jack1142
 
 # CI
 /.travis.yml @Kowlin

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1 @@
 ### Description of the changes
-
-
-
-### Have the changes in this PR been tested?
-
-<!--
-Choose one (remove the line that doesn't apply):
--->
-Yes
-No
-<!--
-If the question doesn't apply (for example, it's not a code change), choose Yes.
-
-Please respond to this question truthfully. We do not delay nor reject PRs
-based on the answer to this question but it allows to better review this PR.
--->

.github/labeler.yml

@@ -1,328 +1,189 @@
-"Category: CI":
-  - .github/workflows/**/*
-
-
-"Category: Cogs - Admin":
+"Category: Admin":
   # Source
   - redbot/cogs/admin/*
   # Docs
   - docs/cog_guides/admin.rst
-  - docs/.resources/admin/**/*
-"Category: Cogs - Alias":
+"Category: Alias":
   # Source
   - redbot/cogs/alias/*
   # Docs
   - docs/cog_guides/alias.rst
-  # Tests
-  - redbot/pytest/alias.py
-  - tests/cogs/test_alias.py
-  - docs/.resources/alias/**/*
-"Category: Cogs - Audio":
-  # Source
+"Category: Audio Cog":
   - any:
       - redbot/cogs/audio/**/*
+    all:
       - "!redbot/cogs/audio/**/locales/*"
+"Category: Bank API":
+  # Source
+  - redbot/core/bank.py
   # Docs
-  - docs/cog_guides/audio.rst
-  # Tests
-  - tests/cogs/audio/**/*
-"Category: Cogs - Bank": []  # historical label for a removed cog
-"Category: Cogs - Cleanup":
+  - docs/framework_bank.rst
+"Category: Bank Cog":
+  # Source
+  - redbot/cogs/bank/*
+  # Docs
+  - docs/cog_guides/bank.rst
+"Category: Bot Core":
+  # Source
+  - redbot/*
+  - redbot/core/__init__.py
+  - redbot/core/_diagnoser.py
+  - redbot/core/_sharedlibdeprecation.py
+  - redbot/core/bot.py
+  - redbot/core/checks.py
+  - redbot/core/cli.py
+  - redbot/core/cog_manager.py
+  - redbot/core/core_commands.py
+  - redbot/core/data_manager.py
+  - redbot/core/errors.py
+  - redbot/core/events.py
+  - redbot/core/global_checks.py
+  - redbot/core/settings_caches.py
+  # Docs
+  - docs/framework_apikeys.rst
+  - docs/framework_bot.rst
+  - docs/framework_cogmanager.rst
+  - docs/framework_datamanager.rst
+  - docs/framework_events.rst
+  - docs/cog_guides/cog_manager_ui.rst
+  - docs/cog_guides/core.rst
+"Category: CI":
+  - .github/workflows/*
+"Category: Cleanup Cog":
   # Source
   - redbot/cogs/cleanup/*
   # Docs
   - docs/cog_guides/cleanup.rst
-"Category: Cogs - CustomCommands":
+"Category: Command Module":
+  # Source
+  - any:
+      # Source
+      - redbot/core/commands/*
+      # Docs
+      - docs/framework_checks.rst
+      - docs/framework_commands.rst
+    all:
+      - "!redbot/core/commands/help.py"
+"Category: Config":
+  # Source
+  - redbot/core/drivers/*
+  - redbot/core/config.py
+  # Docs
+  - docs/framework_config.rst
+"Category: CustomCom":
   # Source
   - redbot/cogs/customcom/*
   # Docs
   - docs/cog_customcom.rst
   - docs/cog_guides/customcommands.rst
-"Category: Cogs - Dev":
+"Category: Dev Cog":
   # Source
   - redbot/core/dev_commands.py
   # Docs
   - docs/cog_guides/dev.rst
-  # Tests
-  - tests/core/test_dev_commands.py
-"Category: Cogs - Downloader":
+"Category: Docs":
+  - docs/**/*
+"Category: Downloader":
   # Source
   - redbot/cogs/downloader/*
   # Docs
   - docs/cog_guides/downloader.rst
-  # Tests
-  - redbot/pytest/downloader.py
-  - redbot/pytest/downloader_testrepo.*
-  - tests/cogs/downloader/**/*
-"Category: Cogs - Economy":
+"Category: Economy Cog":
   # Source
   - redbot/cogs/economy/*
   # Docs
   - docs/cog_guides/economy.rst
-  # Tests
-  - redbot/pytest/economy.py
-  - tests/cogs/test_economy.py
-"Category: Cogs - Filter":
+"Category: Filter":
   # Source
   - redbot/cogs/filter/*
   # Docs
   - docs/cog_guides/filter.rst
-"Category: Cogs - General":
+"Category: General Cog":
   # Source
   - redbot/cogs/general/*
   # Docs
   - docs/cog_guides/general.rst
-"Category: Cogs - Image":
-  # Source
-  - redbot/cogs/image/*
-  # Docs
-  - docs/cog_guides/image.rst
-"Category: Cogs - Mod":
-  # Source
-  - redbot/cogs/mod/*
-  # Docs
-  - docs/cog_guides/mod.rst
-  # Tests
-  - redbot/pytest/mod.py
-  - tests/cogs/test_mod.py
-"Category: Cogs - Modlog":
-  # Source
-  - redbot/cogs/modlog/*
-  # Docs
-  - docs/cog_guides/modlog.rst
-"Category: Cogs - Mutes":
-  # Source
-  - redbot/cogs/mutes/*
-  # Docs
-  - docs/cog_guides/mutes.rst
-"Category: Cogs - Permissions":
-  # Source
-  - redbot/cogs/permissions/*
-  # Docs
-  - docs/cog_guides/permissions.rst
-  - docs/cog_permissions.rst
-  # Tests
-  - redbot/pytest/permissions.py
-  - tests/cogs/test_permissions.py
-"Category: Cogs - Reports":
-  # Source
-  - redbot/cogs/reports/*
-  # Docs
-  - docs/cog_guides/reports.rst
-"Category: Cogs - Streams":
-  # Source
-  - redbot/cogs/streams/*
-  # Docs
-  - docs/cog_guides/streams.rst
-"Category: Cogs - Trivia":
-  # Source
-  - redbot/cogs/trivia/*
-  # Docs
-  - docs/cog_guides/trivia.rst
-  - docs/guide_trivia_list_creation.rst
-  - docs/.resources/trivia/**/*
-  # Tests
-  - tests/cogs/test_trivia.py
-"Category: Cogs - Trivia - Lists":
-  - redbot/cogs/trivia/data/lists/*
-"Category: Cogs - Warnings":
-  # Source
-  - redbot/cogs/warnings/*
-  # Docs
-  - docs/cog_guides/warnings.rst
-
-
-"Category: Core - API - Audio": []  # potential future feature
-"Category: Core - API - Bank":
-  # Source
-  - redbot/core/bank.py
-  # Docs
-  - docs/framework_bank.rst
-"Category: Core - API - App Commands Package":
-  # Source
-  - redbot/core/app_commands/*
-  # Tests
-  - tests/core/test_app_commands.py
-"Category: Core - API - Commands Package":
-  # Source
-  - any:
-      - redbot/core/commands/*
-      - "!redbot/core/commands/help.py"
-  # this isn't in commands package but it just re-exports things from it
-  - redbot/core/checks.py
-  # Docs
-  - docs/framework_checks.rst
-  - docs/framework_commands.rst
-  # Tests
-  - tests/core/test_commands.py
-"Category: Core - API - Config":
-  # Source
-  - any:
-      - redbot/core/_drivers/**/*
-      - "!redbot/core/_drivers/**/locales/*"
-  - redbot/core/config.py
-  # Docs
-  - docs/framework_config.rst
-  # Tests
-  - tests/core/test_config.py
-"Category: Core - API - Other":
-  # Source
-  - redbot/__init__.py
-  - redbot/core/__init__.py
-  - redbot/core/data_manager.py
-  - redbot/core/errors.py
-  - redbot/core/tree.py
-  # Docs
-  - docs/framework_datamanager.rst
-  - docs/framework_tree.rst
-  # Tests
-  - redbot/pytest/data_manager.py
-  - tests/core/test_cog_manager.py
-  - tests/core/test_data_manager.py
-  - tests/core/test_version.py
-"Category: Core - API - Utils Package":
-  # Source
-  - any:
-    - redbot/core/utils/*
-    - "!redbot/core/utils/_internal_utils.py"
-  # Docs
-  - docs/framework_utils.rst
-  # Tests
-  - tests/core/test_utils.py
-"Category: Core - Bot Class":
-  # Source
-  - redbot/core/bot.py
-  # Docs
-  - docs/framework_apikeys.rst
-  - docs/framework_bot.rst
-"Category: Core - Bot Commands":
-  # Source
-  - redbot/core/core_commands.py
-  - redbot/core/_diagnoser.py
-  # Docs
-  - docs/.resources/cog_manager_ui/**/*
-  - docs/cog_guides/cog_manager_ui.rst
-  - docs/cog_guides/core.rst
-"Category: Core - Command-line Interfaces":
-  - redbot/__main__.py
-  - redbot/logging.py
-  - redbot/core/_cli.py
-  - redbot/core/_debuginfo.py
-  - redbot/setup.py
-"Category: Core - Help":
+"Category: Help":
   - redbot/core/commands/help.py
-"Category: Core - i18n":
+"Category: i18n":
   # Source
   - redbot/core/i18n.py
   # Locale files
   - redbot/**/locales/*
   # Docs
   - docs/framework_i18n.rst
-"Category: Core - Modlog":
+"Category: Image":
+  # Source
+  - redbot/cogs/image/*
+  # Docs
+  - docs/cog_guides/image.rst
+"Category: Meta":
+  - ./*
+  - .github/*
+  - .github/ISSUE_TEMPLATE/*
+  - .github/PULL_REQUEST_TEMPLATE/*
+  - schema/*
+  - tools/*
+"Category: Mod Cog":
+  # Source
+  - redbot/cogs/mod/*
+  # Docs
+  - docs/cog_guides/mod.rst
+"Category: Modlog API":
   # Source
   - redbot/core/generic_casetypes.py
   - redbot/core/modlog.py
   # Docs
   - docs/framework_modlog.rst
-"Category: Core - Other Internals":
+"Category: Modlog Cog":
   # Source
-  - redbot/core/_cog_manager.py
-  - redbot/core/_events.py
-  - redbot/core/_global_checks.py
-  - redbot/core/_settings_caches.py
-  - redbot/core/_sharedlibdeprecation.py
-  - redbot/core/utils/_internal_utils.py
-  # Tests
-  - redbot/pytest/__init__.py
-  - redbot/pytest/cog_manager.py
-  - redbot/pytest/core.py
-  - tests/core/test_installation.py
-"Category: Core - RPC/ZMQ":
+  - redbot/cogs/modlog/*
+  # Docs
+  - docs/cog_guides/modlog.rst
+"Category: Mutes Cog":
   # Source
-  - redbot/core/_rpc.py
+  - redbot/cogs/mutes/*
+  # Docs
+  - docs/cog_guides/mutes.rst
+"Category: Permissions":
+  # Source
+  - redbot/cogs/permissions/*
+  # Docs
+  - docs/cog_guides/permissions.rst
+  - docs/cog_permissions.rst
+"Category: Reports Cog":
+  # Source
+  - redbot/cogs/reports/*
+  # Docs
+  - docs/cog_guides/reports.rst
+"Category: RPC/ZMQ API":
+  # Source
+  - redbot/core/rpc.py
   # Docs
   - docs/framework_rpc.rst
-  # Tests
-  - redbot/pytest/rpc.py
-  - tests/core/test_rpc.py
-  - tests/rpc_test.html
-
-
-"Category: Docker": []  # potential future feature
-
-
-"Category: Docs - Changelogs":
-  - CHANGES.rst
-  - docs/changelog.rst
-  - docs/incompatible_changes/**/*
-"Category: Docs - For Developers":
-  - docs/framework_events.rst
-  - docs/guide_cog_creation.rst
-  - docs/guide_cog_creators.rst
-  - docs/guide_migration.rst
-  - docs/guide_publish_cogs.rst
-  - docs/guide_slash_and_interactions.rst
-"Category: Docs - Install Guides":
-  - docs/about_venv.rst
-  - docs/autostart_*.rst
-  - docs/.resources/bot-guide/**/*
-  - docs/bot_application_guide.rst
-  - docs/install_guides/**/*
-  - docs/update_red.rst
-"Category: Docs - Other":
-  - docs/host-list.rst
-  - docs/index.rst
-  - docs/version_guarantees.rst
-  - README.md
-"Category: Docs - User Guides":
-  - docs/getting_started.rst
-  - docs/intents.rst
-  - docs/red_core_data_statement.rst
-  # TODO: move these to `docs/.resources/getting_started` subfolder
-  - docs/.resources/red-console.png
-  - docs/.resources/code-grant.png
-  - docs/.resources/instances-ssh-button.png
-  - docs/.resources/ssh-output.png
-
-
-"Category: Meta":
-  # top-level files
-  - any:
-      - '*'
-      - '!README.md'
-      - '!CHANGES.rst'
-  # .gitattributes files
-  - '**/.gitattributes'
-  # GitHub configuration files, with the exception of CI configuration
-  - .github/*
-  - .github/ISSUE_TEMPLATE/*
-  - .github/PULL_REQUEST_TEMPLATE/*
-  # documentation configuration, extensions, scripts, templates, etc.
-  - docs/conf.py
-  - docs/_ext/**/*
-  - docs/_html/**/*
-  - docs/make.bat
-  - docs/Makefile
-  - docs/prolog.txt
-  - docs/_templates/**/*
-  # empty file
-  - redbot/cogs/__init__.py
-  # py.typed file
-  - redbot/py.typed
-  # requirements files
-  - requirements/*
-  # schema files
-  - schema/*
-  # tests configuration, global fixtures, etc.
-  - tests/conftest.py
-  - tests/__init__.py
-  - tests/*/__init__.py
-  # repository tools
-  - tools/*
-
-
-# "Category: RPC/ZMQ methods": []  # can't be matched by file patterns
-
-
-"Category: Vendored Packages":
-  - redbot/vendored/**/*
+"Category: Streams":
+  # Source
+  - redbot/cogs/streams/*
+  # Docs
+  - docs/cog_guides/streams.rst
+"Category: Tests":
+  - redbot/pytest/*
+  - tests/**/*
+"Category: Trivia Cog":
+  # Source
+  - redbot/cogs/trivia/*
+  # Docs
+  - docs/cog_guides/trivia.rst
+  - docs/guide_trivia_list_creation.rst
+"Category: Trivia Lists":
+  - redbot/cogs/trivia/data/lists/*
+"Category: Utility Functions":
+  # Source
+  - redbot/core/utils/*
+  # Docs
+  - docs/framework_utils.rst
+"Category: Warnings":
+  # Source
+  - redbot/cogs/warnings/*
+  # Docs
+  - docs/cog_guides/warnings.rst

.github/workflows/auto_labeler_issues.yml

@@ -7,7 +7,8 @@ permissions:
   issues: write
 
 jobs:
-  apply_triage_label_to_issues:
+  build:
+
     runs-on: ubuntu-latest
     steps:
       - name: Apply Triage Label

.github/workflows/auto_labeler_pr.yml

@@ -1,27 +0,0 @@
-name: Auto Labeler - PRs
-on:
-  pull_request_target:
-    types:
-      - opened
-      - synchronize
-      - reopened
-      - labeled
-      - unlabeled
-
-permissions:
-  pull-requests: write
-
-jobs:
-  label_pull_requests:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Apply Type Label
-        uses: actions/labeler@v4
-        with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
-          sync-labels: true
-
-      - name: Label documentation-only changes.
-        uses: Jackenmen/label-doconly-changes@v1
-        env:
-          LDC_LABELS: Docs-only

.github/workflows/check_label_pattern_exhaustiveness.yaml

@@ -1,23 +0,0 @@
-name: Check label pattern exhaustiveness
-on:
-  pull_request:
-  push:
-
-jobs:
-  check_label_pattern_exhaustiveness:
-    name: Check label pattern exhaustiveness
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.8"
-      - name: Install script's pre-requirements
-        run: |
-          python -m pip install -U pip
-          python -m pip install -U pathspec pyyaml rich
-      - name: Check label pattern exhaustiveness
-        run: |
-          python .github/workflows/scripts/check_label_pattern_exhaustiveness.py

.github/workflows/codeql-analysis.yml

@@ -26,7 +26,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install -U pip wheel
+        python -m pip install -U pip setuptools wheel
         python -m pip install -e .[all]
         # Set the `CODEQL-PYTHON` environment variable to the Python executable
         # that includes the dependencies

.github/workflows/crowdin_upload_strings.yml

@@ -20,7 +20,7 @@ jobs:
         echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
         sudo apt-get update -qq
         sudo apt-get install -y crowdin
-        pip install redgettext==3.4.2
+        pip install redgettext==3.3
     - name: Generate source files
       run: |
         make gettext

.github/workflows/prepare_release.yml

@@ -27,7 +27,7 @@ jobs:
           echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
           sudo apt-get update -qq
           sudo apt-get install -y crowdin
-          pip install redgettext==3.4.2
+          pip install redgettext==3.3
 
       - name: Generate source files
         run: |
@@ -45,11 +45,11 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: Automated Crowdin downstream
-          title: "Automated Crowdin downstream"
+          title: "[i18n] Automated Crowdin downstream"
           body: |
             This is an automated PR that is part of Prepare Release automated workflow (2 out of 2).
             Please ensure that there are no errors or invalid files are in the PR.
-          labels: "Automated PR, Changelog Entry: Skipped"
+          labels: "Automated PR, Category: i18n, Changelog Entry: Skipped"
           branch: "automated/i18n"
           author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
           milestone: ${{ needs.pr_stable_bump.outputs.milestone_number }}

.github/workflows/publish_release.yml

@@ -2,7 +2,7 @@ name: Publish Release
 on:
   push:
     tags:
-      - "3.[0-9]+.[0-9]+"
+      - "*"
 
 jobs:
   release_information:

.github/workflows/run_pip_compile.yaml

@@ -1,84 +0,0 @@
-name: Generate requirements files with pip-compile.
-
-on:
-  workflow_dispatch:
-
-jobs:
-  generate_requirements:
-    name: Generate requirements files for ${{ matrix.os }} platform.
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
-    steps:
-      - name: Checkout the repository.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.8.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.8'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install -U pip
-          python -m pip install -U pip-tools
-
-      - name: Generate requirements files.
-        id: compile_requirements
-        run: |
-          python .github/workflows/scripts/compile_requirements.py
-
-      - name: Upload requirements files.
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ steps.compile_requirements.outputs.sys_platform }}
-          path: requirements/${{ steps.compile_requirements.outputs.sys_platform }}-*.txt
-
-  merge_requirements:
-    name: Merge requirements files.
-    needs: generate_requirements
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.8.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.8'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install -U "packaging>=22.0"
-
-      - name: Download Windows requirements.
-        uses: actions/download-artifact@v3
-        with:
-          name: win32
-          path: requirements
-      - name: Download Linux requirements.
-        uses: actions/download-artifact@v3
-        with:
-          name: linux
-          path: requirements
-      - name: Download macOS requirements.
-        uses: actions/download-artifact@v3
-        with:
-          name: darwin
-          path: requirements
-
-      - name: Merge requirements files.
-        run: |
-          python .github/workflows/scripts/merge_requirements.py
-
-      - name: Upload merged requirements files.
-        uses: actions/upload-artifact@v3
-        with:
-          name: merged
-          path: |
-            requirements/base.txt
-            requirements/extra-*.txt

.github/workflows/scripts/bump_version.py

@@ -1,20 +1,13 @@
 import os
 import re
 import sys
-from typing import Any, Match
+from typing import Match
 
 import redbot
 
-GITHUB_OUTPUT = os.environ["GITHUB_OUTPUT"]
-
-
-def set_output(name: str, value: Any) -> None:
-    with open(GITHUB_OUTPUT, "a", encoding="utf-8") as fp:
-        fp.write(f"{name}={value}\n")
-
 
 if int(os.environ.get("JUST_RETURN_VERSION", 0)):
-    set_output("version", redbot._VERSION)
+    print(f"::set-output name=version::{redbot.__version__}")
     sys.exit(0)
 
 
@@ -24,7 +17,7 @@ version_info = None
 def repl(match: Match[str]) -> str:
     global version_info
 
-    set_output("old_version", match.group("version"))
+    print(f"::set-output name=old_version::{match.group('version')}")
 
     new_stable_version = os.environ.get("NEW_STABLE_VERSION", "auto")
     if new_stable_version == "auto":
@@ -37,12 +30,12 @@ def repl(match: Match[str]) -> str:
         version_info.micro += 1
         version_info.dev_release = 1
 
-    return f'_VERSION = "{version_info}"'
+    return f'__version__ = "{version_info}"'
 
 
 with open("redbot/__init__.py", encoding="utf-8") as fp:
     new_contents, found = re.subn(
-        pattern=r'^_VERSION = "(?P<version>[^"]*)"$',
+        pattern=r'^__version__ = "(?P<version>[^"]*)"$',
         repl=repl,
         string=fp.read(),
         count=1,
@@ -50,10 +43,10 @@ with open("redbot/__init__.py", encoding="utf-8") as fp:
     )
 
 if not found:
-    print("Couldn't find `_VERSION` line!")
+    print("Couldn't find `__version__` line!")
     sys.exit(1)
 
 with open("redbot/__init__.py", "w", encoding="utf-8", newline="\n") as fp:
     fp.write(new_contents)
 
-set_output("new_version", version_info)
+print(f"::set-output name=new_version::{version_info}")

.github/workflows/scripts/check_label_pattern_exhaustiveness.py

@@ -1,215 +0,0 @@
-import itertools
-import operator
-import os
-import subprocess
-from pathlib import Path
-from typing import Any, Dict, Iterable, List, Optional
-from typing_extensions import Self
-
-import rich
-import yaml
-from rich.console import Console, ConsoleOptions, RenderResult
-from rich.tree import Tree
-from pathspec import PathSpec
-from pathspec.patterns.gitwildmatch import GitWildMatchPattern
-
-
-ROOT_PATH = Path(__file__).resolve().parents[3]
-
-
-class Matcher:
-    def __init__(self, *, any: Iterable[str] = (), all: Iterable[str] = ()) -> None:
-        self.any_patterns = tuple(any)
-        self.any_specs = self._get_pathspecs(self.any_patterns)
-        self.all_patterns = tuple(all)
-        self.all_specs = self._get_pathspecs(self.all_patterns)
-
-    def __repr__(self) -> str:
-        return f"Matcher(any={self.any_patterns!r}, all={self.all_patterns!r})"
-
-    def __eq__(self, other: Any) -> bool:
-        if isinstance(other, self.__class__):
-            return (
-                self.any_patterns == other.any_patterns and self.all_patterns == other.all_patterns
-            )
-        return NotImplemented
-
-    def __hash__(self) -> int:
-        return hash((self.any_patterns, self.all_patterns))
-
-    @classmethod
-    def _get_pathspecs(cls, patterns: Iterable[str]) -> List[PathSpec]:
-        return tuple(
-            PathSpec.from_lines(GitWildMatchPattern, cls._get_pattern_lines(pattern))
-            for pattern in patterns
-        )
-
-    @staticmethod
-    def _get_pattern_lines(pattern: str) -> List[str]:
-        # an approximation of actions/labeler's minimatch globs
-        if pattern.startswith("!"):
-            pattern_lines = ["*", f"!/{pattern[1:]}"]
-        else:
-            pattern_lines = [f"/{pattern}"]
-            if pattern.endswith("*") and "**" not in pattern:
-                pattern_lines.append(f"!/{pattern}/")
-        return pattern_lines
-
-    @classmethod
-    def get_label_matchers(cls) -> Dict[str, List[Self]]:
-        with open(ROOT_PATH / ".github/labeler.yml", encoding="utf-8") as fp:
-            label_definitions = yaml.safe_load(fp)
-        label_matchers: Dict[str, List[Matcher]] = {}
-        for label_name, matcher_definitions in label_definitions.items():
-            matchers = label_matchers[label_name] = []
-            for idx, matcher_data in enumerate(matcher_definitions):
-                if isinstance(matcher_data, str):
-                    matchers.append(cls(any=[matcher_data]))
-                elif isinstance(matcher_data, dict):
-                    matchers.append(
-                        cls(any=matcher_data.pop("any", []), all=matcher_data.pop("all", []))
-                    )
-                    if matcher_data:
-                        raise RuntimeError(
-                            f"Unexpected keys at index {idx} for label {label_name!r}: "
-                            + ", ".join(map(repr, matcher_data))
-                        )
-                elif matcher_data is not None:
-                    raise RuntimeError(f"Unexpected type at index {idx} for label {label_name!r}")
-
-        return label_matchers
-
-
-class PathNode:
-    def __init__(self, parent_tree: Tree, path: Path, *, label: Optional[str] = None) -> None:
-        self.parent_tree = parent_tree
-        self.path = path
-        self.label = label
-
-    def __rich__(self) -> str:
-        if self.label is not None:
-            return self.label
-        return self.path.name
-
-
-class DirectoryTree:
-    def __init__(self, label: str) -> None:
-        self.root = Tree(PathNode(Tree(""), Path(), label=label))
-        self._previous = self.root
-
-    def __bool__(self) -> bool:
-        return bool(self.root.children)
-
-    def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
-        yield from self.root.__rich_console__(console, options)
-
-    def add(self, file: Path) -> Tree:
-        common_path = Path(os.path.commonpath([file.parent, self._previous.label.path]))
-
-        parent_tree = self._previous
-        while parent_tree != self.root and parent_tree.label.path != common_path:
-            parent_tree = parent_tree.label.parent_tree
-
-        for part in file.relative_to(common_path).parts:
-            if parent_tree.label.path.name == "locales":
-                if not parent_tree.children:
-                    parent_tree.add(PathNode(parent_tree, parent_tree.label.path / "*.po"))
-                continue
-            parent_tree = parent_tree.add(PathNode(parent_tree, parent_tree.label.path / part))
-
-        self._previous = parent_tree
-        return parent_tree
-
-
-class App:
-    def __init__(self) -> None:
-        self.exit_code = 0
-        self.label_matchers = Matcher.get_label_matchers()
-        self.tracked_files = [
-            Path(filename)
-            for filename in subprocess.check_output(
-                ("git", "ls-tree", "-r", "HEAD", "--name-only"), encoding="utf-8", cwd=ROOT_PATH
-            ).splitlines()
-        ]
-        self.matches_per_label = {label_name: set() for label_name in self.label_matchers}
-        self.matches_per_file = []
-        self.used_matchers = set()
-
-    def run(self) -> int:
-        old_cwd = os.getcwd()
-        try:
-            os.chdir(ROOT_PATH)
-            self._run()
-        finally:
-            os.chdir(old_cwd)
-        return self.exit_code
-
-    def _run(self) -> None:
-        self._collect_match_information()
-        self._show_matches_per_label()
-        self._show_files_without_labels()
-        self._show_files_with_multiple_labels()
-        self._show_unused_matchers()
-
-    def _collect_match_information(self) -> None:
-        tmp_matches_per_file = {file: [] for file in self.tracked_files}
-
-        for file in self.tracked_files:
-            for label_name, matchers in self.label_matchers.items():
-                matched = False
-                for matcher in matchers:
-                    if all(
-                        path_spec.match_file(file)
-                        for path_spec in itertools.chain(matcher.all_specs, matcher.any_specs)
-                    ):
-                        self.matches_per_label[label_name].add(file)
-                        matched = True
-                        self.used_matchers.add(matcher)
-                if matched:
-                    tmp_matches_per_file[file].append(label_name)
-
-        self.matches_per_file = sorted(tmp_matches_per_file.items(), key=operator.itemgetter(0))
-
-    def _show_matches_per_label(self) -> None:
-        for label_name, files in self.matches_per_label.items():
-            top_tree = DirectoryTree(f"{label_name}:")
-            for file in sorted(files):
-                top_tree.add(file)
-            rich.print(top_tree)
-        print()
-
-    def _show_files_without_labels(self) -> None:
-        top_tree = DirectoryTree("\n--- Not matched ---")
-        for file, labels in self.matches_per_file:
-            if not labels:
-                top_tree.add(file)
-        if top_tree:
-            self.exit_code = 1
-            rich.print(top_tree)
-        else:
-            print("--- All files match at least one label's patterns ---")
-
-    def _show_files_with_multiple_labels(self) -> None:
-        top_tree = DirectoryTree("\n--- Matched by more than one label ---")
-        for file, labels in self.matches_per_file:
-            if len(labels) > 1:
-                tree = top_tree.add(file)
-                for label_name in labels:
-                    tree.add(label_name)
-        if top_tree:
-            rich.print(top_tree)
-        else:
-            print("--- None of the files are matched by more than one label's patterns ---")
-
-    def _show_unused_matchers(self) -> None:
-        for label_name, matchers in self.label_matchers.items():
-            for idx, matcher in enumerate(matchers):
-                if matcher not in self.used_matchers:
-                    print(
-                        f"--- Matcher {idx} for label {label_name!r} does not match any files! ---"
-                    )
-                    self.exit_code = 1
-
-
-if __name__ == "__main__":
-    raise SystemExit(App().run())

.github/workflows/scripts/compile_requirements.py

@@ -1,36 +0,0 @@
-import os
-import shutil
-import subprocess
-import sys
-from pathlib import Path
-
-
-GITHUB_OUTPUT = os.environ["GITHUB_OUTPUT"]
-REQUIREMENTS_FOLDER = Path(__file__).parents[3].absolute() / "requirements"
-os.chdir(REQUIREMENTS_FOLDER)
-
-
-def pip_compile(name: str) -> None:
-    subprocess.check_call(
-        (
-            sys.executable,
-            "-m",
-            "piptools",
-            "compile",
-            "--upgrade",
-            "--resolver=backtracking",
-            "--verbose",
-            f"{name}.in",
-            "--output-file",
-            f"{sys.platform}-{name}.txt",
-        )
-    )
-
-
-pip_compile("base")
-shutil.copyfile(f"{sys.platform}-base.txt", "base.txt")
-for file in REQUIREMENTS_FOLDER.glob("extra-*.in"):
-    pip_compile(file.stem)
-
-with open(GITHUB_OUTPUT, "a", encoding="utf-8") as fp:
-    fp.write(f"sys_platform={sys.platform}\n")

.github/workflows/scripts/merge_requirements.py

@@ -1,134 +0,0 @@
-import os
-from pathlib import Path
-from typing import List, TextIO
-
-from packaging.markers import Marker
-from packaging.requirements import Requirement
-
-
-REQUIREMENTS_FOLDER = Path(__file__).parents[3].absolute() / "requirements"
-os.chdir(REQUIREMENTS_FOLDER)
-
-
-class RequirementData:
-    def __init__(self, requirement_string: str) -> None:
-        self.req = Requirement(requirement_string)
-        self.comments = set()
-
-    @property
-    def name(self) -> str:
-        return self.req.name
-
-    @property
-    def marker(self) -> Marker:
-        return self.req.marker
-
-    @marker.setter
-    def marker(self, value: Marker) -> None:
-        self.req.marker = value
-
-
-def get_requirements(fp: TextIO) -> List[RequirementData]:
-    requirements = []
-
-    current = None
-    for line in fp.read().splitlines():
-        annotation_prefix = "    # "
-        if line.startswith(annotation_prefix) and current is not None:
-            source = line[len(annotation_prefix) :].strip()
-            if source == "via":
-                continue
-            via_prefix = "via "
-            if source.startswith(via_prefix):
-                source = source[len(via_prefix) :]
-            current.comments.add(source)
-        elif line and not line.startswith(("#", " ")):
-            current = RequirementData(line)
-            requirements.append(current)
-
-    return requirements
-
-
-names = ["base"]
-names.extend(file.stem for file in REQUIREMENTS_FOLDER.glob("extra-*.in"))
-base_requirements = []
-
-for name in names:
-    # {req_name: {sys_platform: RequirementData}
-    input_data = {}
-    all_platforms = set()
-    for file in REQUIREMENTS_FOLDER.glob(f"*-{name}.txt"):
-        platform_name = file.stem.split("-", maxsplit=1)[0]
-        all_platforms.add(platform_name)
-        with file.open(encoding="utf-8") as fp:
-            requirements = get_requirements(fp)
-
-        for req in requirements:
-            platforms = input_data.setdefault(req.name, {})
-            platforms[platform_name] = req
-
-    output = base_requirements if name == "base" else []
-    for req_name, platforms in input_data.items():
-        req = next(iter(platforms.values()))
-        for other_req in platforms.values():
-            if req.req != other_req.req:
-                raise RuntimeError(f"Incompatible requirements for {req_name}.")
-
-            req.comments.update(other_req.comments)
-
-        base_req = next(
-            (base_req for base_req in base_requirements if base_req.name == req.name), None
-        )
-        if base_req is not None:
-            old_base_marker = base_req.marker
-            old_req_marker = req.marker
-            req.marker = base_req.marker = None
-            if base_req.req != req.req:
-                raise RuntimeError(f"Incompatible requirements for {req_name}.")
-
-            base_req.marker = old_base_marker
-            req.marker = old_req_marker
-            if base_req.marker is None or base_req.marker == req.marker:
-                continue
-
-        if len(platforms) == len(all_platforms):
-            output.append(req)
-            continue
-        elif len(platforms) < len(all_platforms - platforms.keys()):
-            platform_marker = " or ".join(
-                f"sys_platform == '{platform}'" for platform in platforms
-            )
-        else:
-            platform_marker = " and ".join(
-                f"sys_platform != '{platform}'" for platform in all_platforms - platforms.keys()
-            )
-
-        new_marker = (
-            f"({req.marker}) and ({platform_marker})"
-            if req.marker is not None
-            else platform_marker
-        )
-        req.marker = Marker(new_marker)
-        if base_req is not None and base_req.marker == req.marker:
-            continue
-
-        output.append(req)
-
-    output.sort(key=lambda req: (req.marker is not None, req.name))
-    with open(f"{name}.txt", "w+", encoding="utf-8") as fp:
-        for req in output:
-            fp.write(str(req.req))
-            fp.write("\n")
-            comments = sorted(req.comments)
-
-            if len(comments) == 1:
-                source = comments[0]
-                fp.write("    # via ")
-                fp.write(source)
-                fp.write("\n")
-            else:
-                fp.write("    # via\n")
-                for source in comments:
-                    fp.write("    #   ")
-                    fp.write(source)
-                    fp.write("\n")

.github/workflows/tests.yml

@@ -27,11 +27,8 @@ jobs:
               python_version: "3.9"
               friendly_name: Python 3.9 - Tests
             - tox_env: py310
-              python_version: "3.10"
-              friendly_name: Python 3.10 - Tests
-            - tox_env: py311
-              python_version: "3.11"
-              friendly_name: Python 3.11 - Tests
+              python_version: "3.10-dev"
+              friendly_name: Python 3.10-dev - Tests
             - tox_env: style
               friendly_name: Style
             - tox_env: docs
@@ -49,7 +46,7 @@ jobs:
         - name: Install tox
           run: |
             python -m pip install --upgrade pip
-            pip install tox
+            pip install "tox<4"
         - name: Tox test
           env:
             TOXENV: ${{ matrix.tox_env }}
@@ -62,8 +59,7 @@ jobs:
           python_version:
             - "3.8"
             - "3.9"
-            - "3.10"
-            - "3.11"
+            - "3.10-dev"
         fail-fast: false
       name: Tox - Postgres
       services:
@@ -86,7 +82,7 @@ jobs:
         - name: Install tox
           run: |
             python -m pip install --upgrade pip
-            pip install tox
+            pip install "tox<4"
         - name: Tox test
           env:
             TOXENV: postgres

.readthedocs.yml

@@ -1,13 +1,12 @@
 version: 2
 
 build:
-  os: "ubuntu-22.04"
-  tools:
-    python: "3.8"
+  image: latest
 
 python:
+  version: 3.8
   install:
     - method: pip
       path: .
       extra_requirements:
-        - doc
+        - docs

CHANGES.rst

@@ -1,494 +1,5 @@
 .. Red changelogs
 
-Redbot 3.5.5 (2023-09-14)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`Flame442`, :ghuser:`Jackenmen`, :ghuser:`karlsbjorn`, :ghuser:`Kreusada`, :ghuser:`ltzmax`, :ghuser:`palmtree5`
-
-End-user changelog
-------------------
-
-Changes
-*******
-
-- **Core - Dependencies** - Red's dependencies have been bumped (:issue:`6248`)
-- **Cogs - Downloader** - Cogs in the ``[p]cog list`` command are now listed alphabetically (:issue:`6214`, :issue:`6215`)
-
-Fixes
-*****
-
-- **Core - Bot Commands** - Fixed handling of an edge case in the ``[p]diagnoseissues`` command that involved commands without a cog (:issue:`6237`)
-- **Core - Bot Commands** - Fixed the formatting of nested result lists in the ``[p]diagnoseissues`` command (:issue:`6238`)
-- **Cogs - Mod** - Fixed the formatting of the help description for the ``[p]ban``, ``[p]kick``, and ``[p]tempban`` commands (:issue:`6245`)
-- |cool| **Cogs - Streams** - Updated the implementation of Twitch streams to no longer use the "Get Users Follows" endpoint that was deprecated in February 2023 (:issue:`6246`, :issue:`6247`)
-
-Documentation changes
----------------------
-
-Changes
-*******
-
-- Updated Python version in ``pyenv`` instructions (:issue:`6241`)
-
-----
-
-Redbot 3.5.4 (2023-08-12)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`aikaterna`, :ghuser:`Jackenmen`, :ghuser:`laggron42`, :ghuser:`Leo40Git`, :ghuser:`PredaaA`, :ghuser:`TrustyJAID`
-
-Read before updating
---------------------
-
-#. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
-
-    Red 3.5.4 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.7.8>`__.
-
-End-user changelog
-------------------
-
-Additions
-*********
-
-- |cool| **Core - Bot Commands** - Added ``[p]set status custom`` command allowing the bot owner to change the bot's custom status (:issue:`6226`)
-
-Changes
-*******
-
-- **Core - Dependencies** - Red's dependencies have been bumped (:issue:`6225`)
-
-Fixes
-*****
-
-- **Core** - Fixed errors showing in logs when the button menu timed out and the original message no longer existed (:issue:`6228`, :issue:`6229`)
-- |cool| **Cogs - Audio** - Fixed YT playback (:issue:`6221`)
-- **Cogs - Audio** - Fixed poor quality of ``[p]local/queue search``'s results when case sensitive matching was involved (:issue:`6129`, :issue:`6224`)
-- **Cogs - Audio** - Fixed ``[p]local search`` resorting to YT playback when file name involved certain characters such as ``-`` (:issue:`6223`)
-- **Cogs - CustomCommands** - Fixed poor quality of ``[p]customcom search``'s results when case sensitive matching was involved (:issue:`6224`)
-- **Cogs - Streams** - Fixed Picarto channels showing without the channel avatar (:issue:`6230`)
-
-----
-
-Redbot 3.5.3 (2023-07-24)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`AAA3A-AAA3A`, :ghuser:`aikaterna`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`Jackenmen`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`Om1609`, :ghuser:`PredaaA`, :ghuser:`TrustyJAID`, :ghuser:`Zephyrkul`
-
-Read before updating
---------------------
-
-#. Fedora 36, Ubuntu 18.04 LTS and versions of RHEL/Alma Linux/Oracle Linux/Rocky Linux older than 8.6 are no longer supported as they have already reached their end of life.
-
-End-user changelog
-------------------
-
-Changes
-*******
-
-- |cool| Red has been updated to support `Discord's new username system <https://discord.com/blog/usernames>`__ (:issue:`6130`)
-
-  This means that we now support passing the new usernames as arguments
-  and properly display usernames/global display names in core commands and cogs where applicable.
-
-- **Core** - All bots are are now considered to be immune to auto-moderation (:issue:`6130`)
-- **Core** - Added list of command-line arguments to ``redbot --debuginfo <instance_name>`` and ``[p]debuginfo`` (:issue:`6164`)
-- **Core - Bot Commands** - The ``[p]set api`` command will now hide the button once the time to open the modal to set API keys elapses (:issue:`6166`)
-- **Core - Command-line Interfaces** - Multiple arguments to ``--co-owner``, ``--load-cogs``, and ``--unload-cogs`` flags can now be specified both by passing multiple arguments right after the flag and by repeating the flag multiple times with different arguments (:issue:`6200`)
-- **Core - Dependencies** - Red's dependencies have been bumped (:issue:`6185`)
-- |cool| **Cogs - Audio** - The managed Lavalink server can now be run with either Java 11 or Java 17 (:issue:`6190`)
-- **Cogs - Audio** - Added an option to auto-use default HTTP/HTTPS port for unmanaged Lavalink server (:issue:`5629`)
-- **Cogs - Mod** - The cog now tracks both the usernames *and* global display names (:issue:`6130`)
-
-Removals
-********
-
-- **Core - OS Support** - Fedora 36, Ubuntu 18.04 LTS and versions of RHEL/Alma Linux/Oracle Linux/Rocky Linux older than 8.6 are no longer supported as they have already reached end of life (:issue:`6189`)
-
-Fixes
-*****
-
-- **Core** - Red's menu timeout is now consistent between reaction and button menus (:issue:`6173`)
-- **Core - Bot Commands** - Fixed message too long error in the ``[p]slash list`` command (:issue:`6167`)
-- **Core - Command-line Interfaces** - Red will now properly exit with code ``1`` (``CRITICAL``) when the bot fails after connecting to Discord but before becoming ready instead of indefinitely hanging in non-working condition (:issue:`6202`)
-- **Cogs - Audio** - Fixed playlist selection in the picker used by the playlist-related commands (:issue:`6169`, :issue:`6170`)
-- **Cogs - Cleanup** - Fixed an issue with ``[p]cleanup self`` not working in DMs (:issue:`6196`, :issue:`6197`)
-- **Cogs - Downloader** - Fixed ``CancelledError`` tracebacks showing up in logs when the bot is shut down quickly after the cog is loaded (:issue:`6203`)
-- **Cogs - Mutes** - Fixed ``CancelledError`` tracebacks showing up in logs when the bot is shut down quickly after the cog is loaded (:issue:`6203`)
-
-Developer changelog
--------------------
-
-Additions
-*********
-
-- |cool| **Core - Utils Package** - Added new view (`ConfirmView`) that can be used to ask for confirmation (:issue:`6174`, :issue:`6176`)
-- **Core - Commands Package** - Added `Command.is_enabled()` method allowing to check whether the command is disabled in a guild/globally (:issue:`4130`, :issue:`5552`, :issue:`6209`)
-
-Fixes
-*****
-
-- **Core - Commands Package** - Fixed handling of cases where the string returned by `Cog.format_help_for_context()`/`Command.format_help_for_context()` starts with ``"\n\n"`` (:issue:`5941`)
-- **Cogs - Dev** - Fixed issues with exception formatting in ``[p]eval/repl/debug`` commands not including the code for chained/grouped exceptions (:issue:`6178`)
-
-Documentation changes
----------------------
-
-Additions
-*********
-
-- Added usage example to `get_end_user_data_statement_or_raise()` (:issue:`6171`)
-
-Changes
-*******
-
-- |cool| Added install instructions for Debian 12 Bookworm (:issue:`6190`)
-- |cool| The install guides have been updated to install Java 17 when possible (:issue:`6190`)
-
-
-----
-
-Redbot 3.5.2 (2023-05-14)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`aikaterna`, :ghuser:`flaree`, :ghuser:`Flame442`, :ghuser:`Jackenmen`, :ghuser:`karlsbjorn`, :ghuser:`rramboer`, :ghuser:`synrg`, :ghuser:`TrustyJAID`, :ghuser:`Vexed01`
-
-End-user changelog
-------------------
-
-Changes
-*******
-
-- **Core** - Added list of global prefixes to ``redbot --debuginfo <instance_name>`` and ``[p]debuginfo`` (:issue:`6153`)
-- **Core - Dependencies** - Red's dependencies have been bumped (:issue:`6155`)
-- **Cogs - Downloader** - Updated the code block style in ``[p]repo list`` and ``[p]cog list`` to account for Discord client changes (:issue:`6003`, :issue:`6152`)
-- **Cogs - Trivia** - Updated the code block style in the scoreboard to account for Discord client changes (:issue:`6152`)
-
-Fixes
-*****
-
-- Fixed visual issues with numbered and unnumbered lists caused by Discord's new Markdown support (:issue:`6101`)
-- **Core** - Fixed handling of cooldown errors for application commands (:issue:`6159`)
-- **Core - Bot Commands** - Added missing backtick to the help of ``[p]set serverprefix`` (:issue:`6004`)
-- **Core - Command-line Interfaces** - Fixed ``redbot --debuginfo`` trying to start/starting the bot (:issue:`6131`)
-- **Cogs - Audio** - Fixed Audio's managed node trying to allocate 4 GB of memory on 32-bit platforms regardless of how much is actually available (:issue:`6137`, :issue:`6150`)
-- **Cogs - Audio** - Fixed song selection in ``[p]search`` always picking the first option when buttons are used (:issue:`6136`, :issue:`6143`)
-- **Cogs - CustomCommands** - Fixed parameter handling (:issue:`6138`, :issue:`6149`)
-- **Cogs - Mutes** - Fixed ``[p]channelmute`` returning "That user is already muted" error when the user is not actually muted (:issue:`6144`)
-- **Cogs - Mutes** - Fixed unexpected error in automatic channel unmuting when the relevant channel is not available (:issue:`6140`, :issue:`6144`)
-- **Cogs - Reports** - Fixed ``[p]report`` command not working in DMs (:issue:`6148`)
-- **Vendored Packages** - Fixed menus breaking in DMs (:issue:`6139`)
-
-
-Developer changelog
--------------------
-
-Additions
-*********
-
-- **Core - Data Manager** - Added a new `data_manager.instance_name()` public function (:issue:`6146`)
-
-Fixes
-*****
-
-- **Core - Utils Package** - Fixed ``menu()`` passing an instance of `discord.PartialEmoji` instead of `str` when a button with a unicode emoji is used (:issue:`6143`)
-- **Cogs - Dev** - Fixed issues with exception formatting in ``[p]eval/repl/debug`` commands failing when code from a previous invocation of any of those commands was used (:issue:`6135`)
-
-
-Documentation changes
----------------------
-
-Fixes
-*****
-
-- Fixed the search box on the documentation page returning no results (:issue:`6185`)
-- Fixed command choices example in `Slash Commands and Interactions guide <guide_slash_and_interactions>` (:issue:`6154`)
-- Updated `the 3.5.0 changelog <redbot-3-5-0-2023-05-04>`, `incompatible-changes-3.5`, and `end-user-guarantees` documents to mention the new ``x86-64-v2`` instruction set requirement (:issue:`6141`, :issue:`6147`)
-
-
-----
-
-Redbot 3.5.1 (2023-05-04)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`Flame442`, :ghuser:`Jackenmen`
-
-This is a hotfix release fixing documentation issues and a bug with the update notification logic
-that caused Red to crash.
-
-End-user changelog
-------------------
-
-Fixes
-*****
-
-- **Core** - Fixed a crash in the Red update notification logic (:issue:`6124`)
-
-
-Documentation changes
----------------------
-
-Fixes
-*****
-
-- Fix the instructions for updating Red (:issue:`6123`)
-
-----
-
-.. _redbot-3-5-0-2023-05-04:
-
-Redbot 3.5.0 (2023-05-04)
-=========================
-
-| Thanks to all these amazing people that contributed to this release:
-| :ghuser:`AAA3A-AAA3A`, :ghuser:`aikaterna`, :ghuser:`alexratman`, :ghuser:`AntonioNarra`, :ghuser:`Arman0334`, :ghuser:`Dav-Git`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`Honkertonken`, :ghuser:`i-am-zaidali`, :ghuser:`Jackenmen`, :ghuser:`japandotorg`, :ghuser:`karlsbjorn`, :ghuser:`keqking`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`Kuro-Rui`, :ghuser:`leetfin`, :ghuser:`npc203`, :ghuser:`palmtree5`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`TrustyJAID`, :ghuser:`Vexed01`, :ghuser:`yuansheng1549`
-
-Read before updating
---------------------
-
-#. ``[p]bankset`` is now a core command and as a consequence, the bank cog has been removed. This means that when you start the bot for the first time after the update, you'll see a "Failed to load package bank" message. That is perfectly normal and this message can be ignored.
-#. Red 3.5 comes with breaking changes for users. Look at `Backward incompatible changes in Red 3.5 document <incompatible-changes-3.5>` and `End-user changelog <important-350-1>` for full details.
-
-    Note that because this release also comes with breaking changes for developers,
-    the cogs you're currently using will likely not work with the new release
-    until you update (and that's *if* they have been updated).
-
-    `Our update instructions <update_red>` include instructions on how you can safely update
-    your bot and cogs from versions before 3.5. **Make sure** that you look at the instructions
-    for **the version you currently have**, not the version you're updating to.
-
-    Note that any cogs that have not yet been updated will likely not work
-    until their author releases an update.
-
-#. Red 3.5 comes with breaking changes for cog developers. Look at `Backward incompatible changes in Red 3.5 document <incompatible-changes-3.5>` and `Developer changelog <important-350-2>` for full details.
-#. Fedora 35 and Debian 10 (Buster) are no longer supported as they have already reached their end of life.
-#. On x86-64 systems, we now require that the CPU supports x86-64-v2 instruction set. This roughly translates to us dropping support for Intel CPUs that have been released before 2009 and AMD CPUs that have been released before 2012.
-
-.. _important-350-1:
-
-End-user changelog
-------------------
-
-Breaking Changes
-****************
-
-- **Core** - The bot will no longer launch without an owner set (:issue:`4926`)
-- **Core - OS support** - On x86-64 systems, we now require that the CPU supports x86-64-v2 instruction set. This roughly translates to us dropping support for Intel CPUs that have been released before 2009 and AMD CPUs that have been released before 2012 (:issue:`6100`)
-
-Additions
-*********
-
-- |cool| **Core** - Preference for button menus over reaction menus can now be set with ``[p]set usebuttons``. While this depends on the cog, this should allow users to replace most existing reaction menus with button menus (:issue:`5683`, :issue:`5885`)
-- **Core** - The error message for uncaught bot errors is now configurable. See help of ``[p]set errormsg`` for more details (:issue:`5622`, :issue:`5894`)
-- |cool| **Core - Bot Commands** - Added ``[p]slash`` command for managing application commands (:issue:`5672`, :issue:`5992`, :issue:`6015`)
-- **Core - Command-line Interfaces** - Added new launch flag ``--unload-cogs`` (:issue:`5796`, :issue:`5802`)
-- **Cogs - Streams** - Added ``[p]streamset livebutton`` to add a link button under stream alerts (:issue:`5646`, :issue:`5856`)
-
-Changes
-*******
-
-- **Core** - The home directory is now always preferred for the metadata file on Linux, even for system users (:issue:`5022`)
-- **Core** - Bot prefixes can no longer start with ``/`` (:issue:`5693`)
-- **Core** - Cooldown messages now use relative discord timestamps (:issue:`5893`)
-- |cool| **Core** - Added the option to request a ``file`` containing all content remaining in interactive prompts (:issue:`5901`, :issue:`5902`)
-- **Core** - Parsing errors for integer and number arguments are now more user-friendly (:issue:`5600`)
-- |cool| **Core** - Reaction menus now trigger both when adding and removing the reaction (:issue:`4517`)
-- **Core** - Threads will now inherit parent channel's embed settings (:issue:`5600`)
-- |cool| **Core** - Commands can now be used in threads, voice channels, and stage channels (:issue:`5600`, :issue:`5709`)
-- **Core** - Voice and stage channels can now be a destination for owner notifications (``[p]set ownernotifications adddestination``) (:issue:`5709`)
-- **Core** - Channel embed settings can now be applied to forum, voice, and stage channels (:issue:`5709`)
-- **Core** - Command invocations in specific threads can now be ignored with ``[p]ignore channel``. See `incompatible-changes-3.5` for details (:issue:`5600`)
-- **Core - Bot Commands** - ``[p]modlogset`` and ``[p]bankset`` are now core commands (:issue:`4128`, :issue:`4486`)
-- **Core - Bot Commands** - Moved ``[p]set`` subcommands: ``username``, ``nickname``, ``avatar``, ``description``, and ``custominfo`` to ``[p]set bot`` subgroup (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - Moved activity related ``[p]set`` subcommands to ``[p]set status`` (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - Moved status related ``[p]set`` subcommands to ``[p]set status`` (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - Moved ``[p]set globallocale`` to ``[p]set locale global`` (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - ``[p]set locale`` can now also be used through ``[p]set locale server`` (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - Moved ``[p]set globalregionalformat`` to ``[p]set regionalformat global`` (:issue:`4612`, :issue:`5432`)
-- **Core - Bot Commands** - ``[p]set regionalformat`` can now also be used through ``[p]set regionalformat server`` (:issue:`4612`, :issue:`5432`)
-- |cool| **Core - Bot Commands** - Help can now use buttons and/or select menus instead of reaction menus. See the help of ``[p]helpset usemenus`` command for more information (:issue:`5634`, :issue:`5886`)
-- **Core - Bot Commands** - ``[p]set api`` now sends a modal to securely set api tokens when no arguments are passed (:issue:`5637`)
-- **Core - Bot Commands** - ``[p]traceback`` now prompts to continue if the output requires multiple messages (:issue:`5621`, :issue:`5851`)
-- **Core - Bot Commands** - ``[p]removepath`` now allows passing more than one path at once (:issue:`5820`, :issue:`5859`)
-- **Core - Bot Commands** - Always available commands such as ``[p]licenseinfo`` now always accept a mention prefix (:issue:`5460`, :issue:`5865`)
-- **Core - Bot Commands** - Added an optional ``server`` parameter to ``[p]set showsettings`` and ``[p]set serverprefix`` to prevent lock outs in servers after forgetting a prefix (:issue:`5891`, :issue:`5918`)
-- **Core - Command-line Interfaces** - ``-v`` and ``--verbose`` are now aliased to ``--debug``, and the flag can be passed up to 3 times to increase the verbosity of the debugging logs (:issue:`5613`)
-- **Core - Command-line Interfaces** - Updated the output of ``--debuginfo`` to be consistent with ``[p]debuginfo`` and allow passing the instance name for additional information (:issue:`5662`)
-- **Core - Command-line Interfaces** - Added new exit codes ``2`` (invalid CLI usage) and ``78`` (configuration error) (:issue:`5069`, :issue:`5674`)
-- **Core - Command-line Interfaces** - Instance names must now start and end with a letter or number (:issue:`5680`)
-- **Core - Command-line Interfaces** - Instance names can no longer consecutive underscores (_) and periods (.) (:issue:`5680`)
-- **Core - Command-line Interfaces** - Added descriptions for the ``--overwrite-existing-instance`` and ``--debug`` flags in ``redbot-setup --help`` (:issue:`5808`, :issue:`5818`)
-- **Core - Command-line Interfaces** - Modified the console messages for shutting down the bot to be more consistent (:issue:`6095`)
-- |cool| **Core - Dependencies** - Bumped ``discord.py`` to version 2.2.3 (:issue:`5600`, :issue:`5709`, :issue:`5920`, :issue:`5998`, :issue:`6100`, :issue:`6109`)
-- **Core - Dependencies** - Added support for Python versions 3.10 and 3.11 (:issue:`5611`)
-- **Core - Dependencies** - Red's other dependencies have been bumped (:issue:`5611`, :issue:`5631`, :issue:`6100`)
-- **Core - Modlog** - Modlog channel can now be set to a voice or stage channel with the ``[p]modlogset channel`` command (:issue:`5709`)
-- **Cogs - Admin** - Announcement channel can now be set to a voice or stage channel with the ``[p]announceset channel`` command (:issue:`5709`)
-- **Cogs - Audio** - Expanded ``[p]llset`` to allow configuring the backend options of the internal/managed node (Lavalink) (:issue:`5593`)
-- **Cogs - Audio** - The cog now uses verbose and trace level logging to improve readability of the debug logs (:issue:`5618`)
-- **Cogs - Audio** - Swapped references from "internal"/"external" to "managed"/"unmanaged" (:issue:`5944`, :issue:`5952`)
-- **Cogs - Cleanup** - Cleanups now include a message in the audit log detailing who triggered the deletion (:issue:`5861`, :issue:`5863`)
-- **Cogs - CustomCommands** - ``{channel}`` substitution parameter may now be a thread, voice channel, or stage channel (:issue:`5600`)
-- **Cogs - Downloader** - Added an argument allowing to automatically reload cogs after updating with ``[p]cog update`` (:issue:`3539`, :issue:`5623`)
-- **Cogs - Economy** - Moved ``[p]economyset registeramount`` to ``[p]bankset registeramount`` (:issue:`4128`, :issue:`4486`)
-- **Cogs - Economy** - Moved ``[p]bank reset`` to ``[p]bankset reset`` (:issue:`4128`, :issue:`4486`)
-- **Cogs - Economy** - Moved ``[p]bank prune`` to ``[p]bankset prune`` (:issue:`4128`, :issue:`4486`)
-- **Cogs - Filter** - Messages in threads will now be checked for the filtered words of thread's parent channel and server (:issue:`5600`)
-- **Cogs - Filter** - Messages in voice or stage channels will now be checked for the filtered words and have their own channel word list (:issue:`5709`)
-- **Cogs - General** - Added stage channel information to the extended output of ``[p]serverinfo`` (:issue:`5785`)
-- **Cogs - Mutes** - Usage of ``[p]channelmute`` and ``[p]channelunmute`` commands in a thread will now mute the user in thread's parent channel (:issue:`5600`)
-- **Cogs - Mutes** - The cog will now deny Send Messages in Threads, Create Public Threads, Create Private Threads, and Use Application Commands permissions in the generated mute role and channel overrides (:issue:`5600`, :issue:`5709`)
-- **Cogs - Mutes** - Notification channel can now be set to a voice or stage channel with the ``[p]muteset notification`` command (:issue:`5709`)
-- **Cogs - Mutes** - Channel/voice mutes will now behave differently for voice/stage channels: voice mute will only deny the Speak permission while channel mute will deny message permissions as well (:issue:`5709`)
-- **Cogs - Permissions** - Red's command permission system will now use thread's parent channel for resolving rules (:issue:`5600`)
-- **Cogs - Reports** - Reports channel can now be set to a voice or stage channel with the ``[p]reportset output`` command (:issue:`5709`)
-- **Cogs - Streams** - ``[p]streamalert list`` now shows the platform of each channel (:issue:`3866`, :issue:`5160`)
-- **Cogs - Streams** - ``[p]streamalert`` subcommands now accept an additional argument to toggle alerts in a particular channel (:issue:`3866`, :issue:`5160`)
-- **Cogs - Streams** - Stream alerts can now be sent to a voice or stage channel (:issue:`5709`)
-- **Cogs - Warnings** - Warn channel can now be set to a voice or stage channel with the ``[p]warningset warnchannel`` command (:issue:`5709`)
-
-Removals
-********
-
-- **Core** - Removed ``redbot-launcher`` (:issue:`5999`)
-- **Core - OS Support** - Fedora 35 and Debian 10 (Buster) are no longer supported as they have already reached end of life (:issue:`5974`, :issue:`6110`)
-- **Cogs - Audio** - Removed the ``[p]llsetup`` alias of ``[p]llset`` (:issue:`5953`)
-- **Cogs - Bank** - Removed the bank cog as its only command - ``[p]bankset`` - is now a core command (:issue:`4128`, :issue:`4486`)
-
-Fixes
-*****
-
-- **Core** - Duration parsing in command arguments no longer matches on certain kinds of invalid data (:issue:`5385`, :issue:`5393`)
-- **Core** - Optimized how disabled commands are checked when cogs are loaded (:issue:`5550`)
-- **Core - Bot Commands** - The core path is now always an absolute path in ``[p]paths`` (:issue:`5142`)
-- **Core - Command-line Interfaces** - Fixed an unintended suppression of exceptions in Red's shutdown logic (:issue:`5661`, :issue:`5673`)
-- |cool| **Core - Modlog** - Fixed enormous performance issues with commands that have to gather a lot of cases such as ``[p]casesfor`` and ``[p]listcases`` (:issue:`4977`)
-- **Core - Modlog** - Case messages are no longer edited immediately after being sent (:issue:`5577`)
-- **Cogs - Audio** - Fixed a RAM allocation warning happening in unintended cases (:issue:`5643`)
-- **Cogs - Audio** - Fixed the Audio's managed node becoming unresponsive after it's been used for a while (:issue:`5903`)
-- **Cogs - Downloader** - Fixed a missing space to an output of ``[p]cog install`` (:issue:`5531`)
-- **Cogs - Trivia - Lists** - Fixed some inaccuracies in the ``worldflags`` list (:issue:`5684`)
-- **Cogs - Trivia - Lists** - Fixed some inaccuracies in the ``geography`` list (:issue:`5743`)
-- **Cogs - Trivia - Lists** - Fixed some inaccuracies in the ``clashroyale`` list (:issue:`5771`)
-
-.. _important-350-2:
-
-Developer changelog
--------------------
-
-Breaking Changes
-****************
-
-- **Core** - Fixed edge cases in the ordering logic of ``VersionInfo`` (:issue:`5932`)
-- **Core** - Removed ``is_mod_or_superior()``, ``is_admin_or_superior()``, and ``check_permissions()`` from ``redbot.core.checks`` (:issue:`6016`)
-- **Core - Bot Class** - Merged ``RedBase`` with the `Red` class (:issue:`5159`)
-- **Core - Bot Class** - Removed the ``guild_id`` parameter from `Red.allowed_by_whitelist_blacklist()`. Use the ``guild`` parameter instead (:issue:`4905`, :issue:`4914`, :issue:`5433`)
-- **Core - Bot Class** - Removed the ``user`` parameter from `Red.embed_requested()` (:issue:`5576`)
-- **Core - Bot Class** - The ``command`` parameter of `Red.embed_requested()` is now keyword-only (:issue:`5576`)
-- **Core - Bot Class** - The ``check_permissions`` parameter of `Red.embed_requested()` now defaults to ``True`` (:issue:`5576`)
-- **Core - Bot Class** - `Red.add_cog()` will now raise `discord.ClientException` rather than `RuntimeError` when a cog with the same name is already loaded (:issue:`5600`)
-- **Core - Bot Class** - Some of the method arguments in the `Red` class have been made positional-only. See `incompatible-changes-3.5` for more information (:issue:`5600`)
-- **Core - Bot Class** - `Red.add_cog()` and `Red.remove_cog()` are now asynchronous methods (:issue:`5600`)
-- **Core - Bot Class** - ``setup()`` and ``teardown()`` functions in cog packages are now required to be asynchronous (:issue:`5600`)
-- **Core - Bot Class** - The list returned by `Red.get_owner_notification_destinations()` may now contain instances of `discord.VoiceChannel` and `discord.StageChannel` (:issue:`5709`)
-- **Core - Commands Package** - `Context.maybe_send_embed()` now raises a `ValueError` if the message's length is not between 1 and 2000 characters (:issue:`4383`, :issue:`4465`)
-- **Core - Commands Package** - Removed ``GuildConverter`` from the `redbot.core.commands.converter` namespace. Use ``discord.Guild`` or ``commands.GuildConverter`` as the converter instead (:issue:`4928`, :issue:`5433`)
-- **Core - Commands Package** - :class:`~discord.ext.commands.BadArgument` is no longer wrapped with a ``ConversionFailure`` class (:issue:`5600`)
-- **Core - Commands Package** - Some of the method arguments in the `commands.Command` and ``commands.CogMixin`` class have been made positional-only. See `incompatible-changes-3.5` for more information (:issue:`5600`)
-- **Core - Commands Package** - Removed ``commands.requires.DM_PERMS`` (:issue:`5709`)
-- **Core - Commands Package** - ``ctx.channel`` can now be a `discord.PartialMessageable` if it represents a DM channel (:issue:`5995`, :issue:`6005`)
-- **Core - Config** - Unserializable values can no longer be registered as config defaults (:issue:`5557`)
-- **Core - Config** - ``_from_id`` methods now raise a `TypeError` if the provided value is not an ``int`` (:issue:`5459`, :issue:`5564`)
-- **Core - Modlog** - `Case.message` is now a `discord.PartialMessage` unless the case object is created with `modlog.create_case()` (:issue:`4977`)
-- **Core - Modlog** - `modlog.get_modlog_channel()` may now return an instance of `discord.VoiceChannel` or `discord.StageChannel` (:issue:`5709`)
-- **Core - Modlog** - `modlog.create_case()` now raises a `ValueError` when an invalid casetype is passed (:issue:`3346`, :issue:`5386`)
-- **Core - Modlog** - `modlog.create_case()` now raises a `RuntimeError` when a bot user is passed as the ``user`` argument (:issue:`5386`)
-- **Core - Utils Package** - `redbot.core.utils.menus.menu()` now listens to both reaction add and remove events (:issue:`4517`)
-- **Core - Utils Package** - Removed ``redbot.core.utils.mod.is_allowed_by_hierarchy()`` (:issue:`4435`, :issue:`5433`)
-- **Core - Utils Package** - Removed the ``caching`` and ``safety`` modules (:issue:`5653`)
-- **Core - Utils Package** - `DEFAULT_CONTROLS`, `ALPHABET_EMOJIS`, and `NUMBER_EMOJIS` are now immutable (:issue:`5586`, :issue:`5666`)
-
-Additions
-*********
-
-- **Core** - Added an ``on_cog_remove`` event which is dispatched when cogs are unloaded (:issue:`5570`)
-- **Core** - Added `RedTree` and general app command support (:issue:`5672`, :issue:`5992`, :issue:`6015`)
-- **Core** - Added ``redbot.core.app_commands`` package shadowing ``discord.app_commands``. We expect developers to use it instead of ``discord.app_commands`` when working with Red (:issue:`6006`)
-- **Core - App Commands Package** - Allowed setting ``red_force_enable`` in ``extras`` to ``True`` in an app command to bypass ``[p]slash enable`` (:issue:`6018`)
-- **Core - Bot Class** - Added `Red.send_interactive()` - a port of `Context.send_interactive()` that can be used with any `discord.abc.Messageable` (:issue:`5851`)
-- **Core - Bot Class** - Added `Red.enable_app_command()`, `Red.disable_app_command()`, and `Red.list_enabled_app_commands()` (:issue:`5992`)
-- **Core - Bank** - Added `redbot.core.bank.is_owner_if_bank_global()` (:issue:`3709`, :issue:`4486`)
-- **Core - Commands Package** - Added `RawUserIdConverter` (:issue:`4486`)
-- |cool| **Core - Commands Package** - Added support for hybrid commands (:issue:`5681`)
-- **Core - Commands Package** - Added `positive_int` and `finite_float` converters (:issue:`5939`, :issue:`5969`)
-- **Core - Commands Package** - Added new checks for proper permission resolution in both channels and threads: `bot_can_manage_channel()`, `bot_can_react()`, `can_manage_channel()`, `guildowner_or_can_manage_channel()`, `admin_or_can_manage_channel()`, `mod_or_can_manage_channel()` (:issue:`5600`)
-- **Core - Dependencies** - Added ``red_commons`` as a dependency (:issue:`5624`)
-- **Core - Modlog** - Added `Case.parent_channel` and `Case.parent_channel_id` (support for threads) (:issue:`5600`)
-- **Core - Utils Package** - Added `SimpleMenu`, a template view subclass (:issue:`5634`)
-- **Core - Utils Package** - Added `SetApiModal` and `SetApiView` (:issue:`5637`)
-- **Core - Utils Package** - Added new utilities for proper permissions resolution in both channels and threads: `can_user_send_messages_in()`, `can_user_manage_channel()`, `can_user_react_in()` (:issue:`5600`)
-
-Changes
-*******
-
-- |cool| **Core** - :func:`logging.getLogger()` now returns a custom logger subclass with support for ``verbose`` and ``trace`` level logging (:issue:`5613`)
-- **Core** - Added extra information to version info for dev versions of Red (:issue:`5664`)
-- **Core** - Modernized packaging-related things (:issue:`5924`)
-- **Core** - Modified `developer-guarantees`, privatizing many APIs that were not intended to be public. See `incompatible-changes-3.5` for more details (:issue:`6021`)
-- **Core - Bot Class** - `Red.ignored_channel_or_guild()` now accepts `discord.Interaction` objects (:issue:`6015`)
-- **Core - Bot Class** - The ``channel`` parameter of `Red.embed_requested()` now accepts any messageable guild channel (:issue:`5576`)
-- **Core - Bot Class** - The bot's color is now set earlier in the launch process (:issue:`5627`)
-- **Core - Bot Class** - `Red.remove_cog()` returns a `commands.Cog` instance now (:issue:`5600`)
-- **Core - Commands Package** - The provisional ``Literal`` converter has been replaced with discord.py's own `typing.Literal` implementation (:issue:`5600`)
-- **Core - Commands Package** - Added a ``join_character`` parameter to `Red.send_interactive()` and `Context.send_interactive()` to allow choosing the character messages are joined with (:issue:`5901`, :issue:`5902`)
-- **Core - Modlog** - `modlog.set_modlog_channel()` can now accept `discord.VoiceChannel` and `discord.StageChannel` (:issue:`5709`)
-- **Core - Utils Package** - `menu()` now defaults to `DEFAULT_CONTROLS` if the ``controls`` argument is not passed (:issue:`5678`)
-- **Core - Utils Package** - Removed ``bordered()`` (:issue:`5692`)
-- **Core - Utils Package** - Optimized the performance of `pagify()` to better handle large inputs (:issue:`5698`)
-- **Core - Utils Package** - ``channel`` parameter in `MessagePredicate`'s methods now accepts any `discord.abc.Messageable` (:issue:`5942`)
-- |cool| **Cogs - Dev** - Tracebacks for code ran with ``[p]eval``, ``[p]debug``, and ``[p]repl`` commands now include source lines (:issue:`5843`)
-
-Fixes
-*****
-
-- **Core - Commands Package** - Fixed decorator order inconsistencies in permissions checks (:issue:`5625`)
-- **Core - Modlog** - Fixed `modlog.get_case()` and `modlog.get_all_cases()` raising a runtime error when no modlog channel is configured (:issue:`5644`, :issue:`5866`)
-- **Core - Utils Package** - Fixed an unintended `IndexError` in menus when page number is below 0 or above last page number (:issue:`5430`)
-- **Cogs - Dev** - Fixed line numbers in tracebacks (:issue:`5843`)
-- **Cogs - Dev** - ``[p]mock`` only works in servers now (:issue:`5923`, :issue:`5926`)
-
-
-Documentation changes
----------------------
-
-Additions
-*********
-
-- Added `end-user-guarantees` codifying our support policy for different operating system versions (:issue:`5437`, :issue:`5677`)
-- Added a list of currently supported operating system versions and architectures (:issue:`5437`, :issue:`5677`, :issue:`5803`, :issue:`5974`, :issue:`6110`)
-- Added documentation for the `redbot.core.utils.antispam` module (:issue:`5641`)
-- |cool| Added a cog guide for the Audio cog (:issue:`5871`, :issue:`5895`)
-- Added documentation for creating app commands with Red (:issue:`6008`)
-- Added documentation listing past and future breaking changes (:issue:`5603`)
-
-Changes
-*******
-
-- Linux install guides have been updated to, if possible, use the Python versions already distributed through the official repositories (:issue:`5611`)
-
-Fixes
-*****
-
-- Removed references to the ``master`` discord.py docs (:issue:`5713`)
-- Removed some duplicated references (:issue:`5782`, :issue:`5778`)
-- Fixed an inaccurate typehint in the documentation for `Config.user()` (:issue:`5790`, :issue:`5791`)
-
-----
-
 Redbot 3.4.19 (2023-04-20)
 ==========================
 
@@ -590,9 +101,7 @@ Changes
 - Updated the screenshot showing what intents need to be selected (:issue:`5935`, :issue:`5936`)
 - Updated bot hosting list with the new location for Contabo and addition of AlphaVPS (:issue:`5928`)
 - Updated installation URLs for Homebrew and Chocolatey (:issue:`5776`)
-- Updated the auto-restart script for Linux to only restart when there's a critical error (crash) or the restart command is ran (:issue:`5069`, :issue:`5674`)
 
-----
 
 Redbot 3.4.18 (2022-08-15)
 ==========================
@@ -848,8 +357,8 @@ Developer changelog
 Additions
 *********
 
-- **Core - Bot Class** - Added optional ``check_permissions`` keyword-only argument to `Red.embed_requested()` which, if ``True``, will make the method also check whether the bot can send embeds in the given channel (:issue:`5452`)
-- |cool| **Core - Bot Class** - Added `Red.get_invite_url()` and `Red.is_invite_url_public()` that expose the functionality of ``[p]invite`` programmatically (:issue:`5152`, :issue:`5424`)
+- **Core - Bot Class** - Added optional ``check_permissions`` keyword-only argument to `Red.embed_requested() <RedBase.embed_requested()>` which, if ``True``, will make the method also check whether the bot can send embeds in the given channel (:issue:`5452`)
+- |cool| **Core - Bot Class** - Added `Red.get_invite_url() <RedBase.get_invite_url()>` and `Red.is_invite_url_public() <RedBase.is_invite_url_public()>` that expose the functionality of ``[p]invite`` programmatically (:issue:`5152`, :issue:`5424`)
 - |cool| **Core - Commands Package** - Added optional ``message`` argument to `Context.tick()` and `Context.react_quietly()` which is used if adding the reaction doesn't succeed (:issue:`3359`, :issue:`4092`)
 
 Changes
@@ -1029,14 +538,14 @@ Additions
 
     Here's the list of the methods that were added to the ``bot`` object:
 
-        - `Red.add_to_blacklist()`
-        - `Red.remove_from_blacklist()`
-        - `Red.get_blacklist()`
-        - `Red.clear_blacklist()`
-        - `Red.add_to_whitelist()`
-        - `Red.remove_from_whitelist()`
-        - `Red.get_whitelist()`
-        - `Red.clear_whitelist()`
+        - `Red.add_to_blacklist() <RedBase.add_to_blacklist()>`
+        - `Red.remove_from_blacklist() <RedBase.remove_from_blacklist()>`
+        - `Red.get_blacklist() <RedBase.get_blacklist()>`
+        - `Red.clear_blacklist() <RedBase.clear_blacklist()>`
+        - `Red.add_to_whitelist() <RedBase.add_to_whitelist()>`
+        - `Red.remove_from_whitelist() <RedBase.remove_from_whitelist()>`
+        - `Red.get_whitelist() <RedBase.get_whitelist()>`
+        - `Red.clear_whitelist() <RedBase.clear_whitelist()>`
 - |cool| **Core - Commands Package** - Added `RelativedeltaConverter` and `parse_relativedelta` to the ``redbot.core.commands`` package (:issue:`5000`)
 
     This converter and function return `dateutil.relativedelta.relativedelta` object that represents a relative delta.
@@ -1364,7 +873,7 @@ Changes
 Deprecations
 ************
 
-- **Core - Bot Class** - Added ``guild`` parameter to `bot.allowed_by_whitelist_blacklist() <Red.allowed_by_whitelist_blacklist()>` which is meant to replace the deprecated ``guild_id`` parameter (:issue:`4905`, :issue:`4914`)
+- **Core - Bot Class** - Added ``guild`` parameter to `bot.allowed_by_whitelist_blacklist() <RedBase.allowed_by_whitelist_blacklist()>` which is meant to replace the deprecated ``guild_id`` parameter (:issue:`4905`, :issue:`4914`)
 
     - Read the method's documentation for more information
 - **Core - Commands Package** - Deprecated importing ``GuildConverter`` from ``redbot.core.commands.converter`` namespace (:issue:`4928`)
@@ -1545,8 +1054,8 @@ Additions
 
     - Variables can be added and removed from the environment of Dev cog using two new methods:
 
-        - `bot.add_dev_env_value() <Red.add_dev_env_value()>`
-        - `bot.remove_dev_env_value() <Red.remove_dev_env_value()>`
+        - `bot.add_dev_env_value() <RedBase.add_dev_env_value()>`
+        - `bot.remove_dev_env_value() <RedBase.remove_dev_env_value()>`
 
 Changes
 *******
@@ -1920,9 +1429,9 @@ Developer changelog
 Additions
 *********
 
-- **Core - Bot Class** - Added `bot.get_or_fetch_user() <Red.get_or_fetch_user()>` and `bot.get_or_fetch_member() <Red.get_or_fetch_member()>` methods (:issue:`4403`, :issue:`4402`)
-- **Core - Bot Class** - Added `bot.remove_shared_api_services() <Red.remove_shared_api_services()>` to remove all keys and tokens associated with an API service (:issue:`4370`)
-- **Core - Bot Class** - Added an option to return all tokens for an API service if ``service_name`` is not specified in `bot.get_shared_api_tokens() <Red.get_shared_api_tokens()>` (:issue:`4370`)
+- **Core - Bot Class** - Added `bot.get_or_fetch_user() <RedBase.get_or_fetch_user()>` and `bot.get_or_fetch_member() <RedBase.get_or_fetch_member()>` methods (:issue:`4403`, :issue:`4402`)
+- **Core - Bot Class** - Added `bot.remove_shared_api_services() <RedBase.remove_shared_api_services()>` to remove all keys and tokens associated with an API service (:issue:`4370`)
+- **Core - Bot Class** - Added an option to return all tokens for an API service if ``service_name`` is not specified in `bot.get_shared_api_tokens() <RedBase.get_shared_api_tokens()>` (:issue:`4370`)
 - **Core - Dependencies** - Added ``[all]`` and ``[dev]`` extras to the ``Red-DiscordBot`` package (:issue:`4443`)
 - |cool| **Core - i18n** - Added API for setting contextual locales (:issue:`3896`, :issue:`1970`)
 
@@ -2073,7 +1582,7 @@ Additions
 
 - |cool| **Core** - Added cog disabling API (:issue:`4043`, :issue:`3945`)
 
-    - New methods added: `bot.cog_disabled_in_guild() <Red.cog_disabled_in_guild()>`, `bot.cog_disabled_in_guild_raw() <Red.cog_disabled_in_guild_raw()>`
+    - New methods added: `bot.cog_disabled_in_guild() <RedBase.cog_disabled_in_guild()>`, `bot.cog_disabled_in_guild_raw() <RedBase.cog_disabled_in_guild_raw()>`
     - Cog disabling is automatically applied for commands and only needs to be done manually for things like event listeners; see `recommendations-for-cog-creators` for more information
 - |cool| **Core** - Added data request API (:issue:`4045`,  :issue:`4169`)
 
@@ -2081,14 +1590,14 @@ Additions
     - New special module level variable added: ``__red_end_user_data_statement__``
     - These methods and variables should be added by all cogs according to their documentation; see `recommendations-for-cog-creators` for more information
     - New ``info.json`` key added: ``end_user_data_statement``; see `Info.json format documentation <info-json-format>` for more information
-- **Core - Bot Class** - Added `bot.message_eligible_as_command() <Red.message_eligible_as_command()>` utility method which can be used to determine if a message may be responded to as a command (:issue:`4077`)
+- **Core - Bot Class** - Added `bot.message_eligible_as_command() <RedBase.message_eligible_as_command()>` utility method which can be used to determine if a message may be responded to as a command (:issue:`4077`)
 - |cool| **Core - Commands Package** - Added a provisional API for replacing the help formatter. See `documentation <framework-commands-help>` for more details (:issue:`4011`)
 - **Core - Commands Package** - `commands.NoParseOptional <NoParseOptional>` is no longer provisional and is now fully supported part of API (:issue:`4142`)
 
 Changes
 *******
 
-- **Core - Bot Class** - `bot.ignored_channel_or_guild() <Red.ignored_channel_or_guild()>` now accepts `discord.Message` objects (:issue:`4077`)
+- **Core - Bot Class** - `bot.ignored_channel_or_guild() <RedBase.ignored_channel_or_guild()>` now accepts `discord.Message` objects (:issue:`4077`)
 - |cool| **Core - Commands Package** - Autohelp in group commands is now sent *after* invoking the group, which allows before invoke hooks to prevent autohelp from getting triggered (:issue:`4129`)
 - **Core - Utils Package** - `humanize_list()` now accepts ``locale`` and ``style`` keyword arguments. See its documentation for more information (:issue:`2982`)
 - |cool| **Core - Utils Package** - `humanize_list()` is now properly localized (:issue:`2906`, :issue:`2982`)
@@ -2341,7 +1850,7 @@ Developer changelog
 Additions
 *********
 
-- **Core - Bot Class** - Added `bot.set_prefixes() <Red.set_prefixes()>` method that allows developers to set global/server prefixes (:issue:`3890`)
+- **Core - Bot Class** - Added `bot.set_prefixes() <RedBase.set_prefixes()>` method that allows developers to set global/server prefixes (:issue:`3890`)
 
 
 Documentation changes
@@ -3304,13 +2813,13 @@ Breaking Changes
 
   New methods for this include:
 
-    - `Red.get_shared_api_tokens()`
-    - `Red.set_shared_api_tokens()`
-    - `Red.get_embed_colour()` (and its alias - ``get_embed_color()``)
-    - `Red.get_admin_roles()`
-    - `Red.get_admin_role_ids()`
-    - `Red.get_mod_roles()`
-    - `Red.get_mod_role_ids()`
+    - `RedBase.get_shared_api_tokens()`
+    - `RedBase.set_shared_api_tokens()`
+    - `RedBase.get_embed_colour()` (and its alias - ``get_embed_color()``)
+    - `RedBase.get_admin_roles()`
+    - `RedBase.get_admin_role_ids()`
+    - `RedBase.get_mod_roles()`
+    - `RedBase.get_mod_role_ids()`
 - **Core - Bot Class** - Removed ``bot._counter``, Made a few more attributes private (``cog_mgr``, ``main_dir``) (:issue:`2976`)
 - **Core - Modlog** - Modlog casetypes no longer have an attribute for auditlog action type (:issue:`2897`)
 - **Core - Modlog** - Removed ``redbot.core.modlog.get_next_case_number()`` (:issue:`2908`)
@@ -3320,11 +2829,11 @@ Additions
 
 - Added a few methods and classes replacing direct config access (which is no longer supported) (:issue:`2976`)
 
-   - `Red.allowed_by_whitelist_blacklist()`
-   - `Red.get_valid_prefixes()`
-   - `Red.remove_shared_api_tokens()`
+   - `Red.allowed_by_whitelist_blacklist() <RedBase.allowed_by_whitelist_blacklist()>`
+   - `Red.get_valid_prefixes() <RedBase.get_valid_prefixes()>`
+   - `Red.remove_shared_api_tokens() <RedBase.remove_shared_api_tokens()>`
    - `redbot.core.commands.help.HelpSettings`
-- **Core - Bot Class** - Added the method `Red.wait_until_red_ready()` that waits until Red's post connection startup is done (:issue:`3273`)
+- **Core - Bot Class** - Added the method `Red.wait_until_red_ready() <RedBase.wait_until_red_ready()>` that waits until Red's post connection startup is done (:issue:`3273`)
 - **Core - Bot Class** - New event ``on_red_api_tokens_update`` is now dispatched when shared api keys for a service are updated (:issue:`3134`)
 - **Core - Config** - Added functions to acquire locks on Config groups and values. These locks are acquired by default when calling a value as a context manager. See `Value.get_lock()` for details (:issue:`2654`)
 - **Core - Config** - Added methods to Config for accessing things by id without mocked objects (:issue:`2804`)
@@ -3353,8 +2862,8 @@ Additions
 Changes
 *******
 
-- **Core - Bot Class** - `Red.send_filtered()` now returns the message that is sent (:issue:`3052`)
-- **Core - Bot Class** - `Red.send_to_owners()` and `Red.get_owner_notification_destinations()` now log when they are not able to find the owner notification destination (:issue:`3273`)
+- **Core - Bot Class** - `Red.send_filtered() <RedBase.send_filtered()>` now returns the message that is sent (:issue:`3052`)
+- **Core - Bot Class** - `Red.send_to_owners() <RedBase.send_to_owners()>` and `Red.get_owner_notification_destinations() <RedBase.get_owner_notification_destinations()>` now log when they are not able to find the owner notification destination (:issue:`3273`)
 - **Core - Commands Package** - Allowed passing ``cls`` in the `redbot.core.commands.group()` decorator (:issue:`2881`)
 - **Core - Modlog** - Some generic modlog casetypes are now pre-registered for cog creator use (:issue:`2897`)
 
@@ -3367,10 +2876,10 @@ Fixes
 *****
 
 - **Core - Bank** - Bank functions now check the recipient balance before transferring and stop the transfer if the recipient's balance will go above the maximum allowed balance (:issue:`2923`)
-- **Core - Bot Class** - Fixed `Red.remove_command()` throwing an error when trying to remove a non-existent command (:issue:`2888`)
+- **Core - Bot Class** - Fixed `Red.remove_command() <RedBase.remove_command()>` throwing an error when trying to remove a non-existent command (:issue:`2888`)
 - **Core - Bot Class** - Fixed ``is_automod_immune``'s handling of the guild check and added support for checking webhooks (:issue:`3100`)
 - **Core - Bot Class** - ``Red.owner_id`` is now set in the post connection startup (:issue:`3273`)
-- **Core - Bot Class** - `Red.send_to_owners()` and `Red.get_owner_notification_destinations()` now wait until Red is done with post connection startup to ensure owner ID is available (:issue:`3273`)
+- **Core - Bot Class** - `Red.send_to_owners() <RedBase.send_to_owners()>` and `Red.get_owner_notification_destinations() <RedBase.get_owner_notification_destinations()>` now wait until Red is done with post connection startup to ensure owner ID is available (:issue:`3273`)
 - **Core - Commands Package** - `Command.can_see()` now works as intended for disabled commands (:issue:`2892`)
 - **Core - Commands Package** - Fixed ``Context.clean_prefix`` issues resulting from undocumented changes from discord (:issue:`3249`)
 - **Core - Utils Package** - Fixed `MessagePredicate.greater()` and `MessagePredicate.less()` allowing any valid int instead of only valid ints/floats that are greater/less than the given value (:issue:`3004`)
@@ -3635,7 +3144,7 @@ Developer changelog
 Additions
 *********
 
-- **Core - Bot Class** - Added `Red.send_to_owners()` and `Red.get_owner_notification_destinations()` (:issue:`2665`, :issue:`2738`)
+- **Core - Bot Class** - Added `Red.send_to_owners() <RedBase.send_to_owners()>` and `Red.get_owner_notification_destinations() <RedBase.get_owner_notification_destinations()>` (:issue:`2665`, :issue:`2738`)
 - **Core - Commands Package** - Added `DictConverter` (:issue:`2692`)
 - **Core - Commands Package** - Added `TimedeltaConverter` and `parse_timedelta()` (:issue:`2736`)
 - **Core - Commands Package** - Added ``assume_yes`` attribute to `redbot.core.commands.Context` (:issue:`2746`)

LICENSE

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     Red - A fully customizable Discord bot
-    Copyright (C) 2017-present  Cog Creators
+    Copyright (C) 2017-2021  Cog Creators
     Copyright (C) 2015-2017  Twentysix
 
     This program is free software: you can redistribute it and/or modify
@@ -653,7 +653,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    Red-DiscordBot  Copyright (C) 2017-present  Cog Creators
+    Red-DiscordBot  Copyright (C) 2017-2021  Cog Creators
     Red-DiscordBot  Copyright (C) 2015-2017  Twentysix
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
@@ -675,10 +675,10 @@ the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
 
-The Red-DiscordBot project contains subcomponents in the Audio module that 
-have a separate copyright notice and license terms. Your use of the source 
-code for these subcomponents is subject to the terms and conditions of the 
-following licenses.
+The Red-DiscordBot project contains subcomponents in audio.py that have a 
+separate copyright notice and license terms. Your use of the source code for 
+these subcomponents is subject to the terms and conditions of the following 
+licenses.
 
 This product bundles methods from https://github.com/Just-Some-Bots/MusicBot/
 blob/master/musicbot/spotify.py which are available under an MIT license.

MANIFEST.in

@@ -2,12 +2,6 @@
 include LICENSE
 recursive-include redbot *.LICENSE
 
-# include requirements files
-include requirements/base.in
-include requirements/base.txt
-include requirements/extra-*.in
-include requirements/extra-*.txt
-
 # include locale files
 recursive-include redbot locales/*.po
 
@@ -21,7 +15,7 @@ recursive-include redbot *.export
 recursive-include redbot py.typed
 
 # include *.sql files from postgres driver
-recursive-include redbot/core/_drivers/postgres *.sql
+recursive-include redbot/core/drivers/postgres *.sql
 
 # include tests
 graft tests

Makefile

@@ -52,7 +52,7 @@ bumpdeps:
 # Development environment
 newenv:
 	$(PYTHON) -m venv --clear .venv
-	.venv/bin/pip install -U pip wheel
+	.venv/bin/pip install -U pip setuptools wheel
 	$(MAKE) syncenv
 syncenv:
 	.venv/bin/pip install -Ur ./tools/dev-requirements.txt

README.md

@@ -27,9 +27,9 @@
 </p>
 <p align="center">
   <a href="https://github.com/Cog-Creators/Red-DiscordBot/actions">
-    <img src="https://img.shields.io/github/actions/workflow/status/Cog-Creators/Red-Discordbot/tests.yml?label=tests" alt="GitHub Actions">
+    <img src="https://img.shields.io/github/workflow/status/Cog-Creators/Red-Discordbot/Tests?label=tests" alt="GitHub Actions">
   </a>
-  <a href="http://docs.discord.red/en/stable/?badge=stable">
+  <a href="http://red-discordbot.readthedocs.io/en/stable/?badge=stable">
     <img src="https://readthedocs.org/projects/red-discordbot/badge/?version=stable" alt="Red on readthedocs.org">
   </a>
   <a href="https://github.com/psf/black">
@@ -48,7 +48,7 @@
   •
   <a href="#installation">Installation</a>
   •
-  <a href="http://docs.discord.red/en/stable/index.html">Documentation</a>
+  <a href="http://red-discordbot.readthedocs.io/en/stable/index.html">Documentation</a>
   •
   <a href="#plugins">Plugins</a>
   •
@@ -86,9 +86,9 @@ community of cog repositories.**
 
 **The following platforms are officially supported:** 
 
-- [Windows](https://docs.discord.red/en/stable/install_guides/windows.html)
-- [MacOS](https://docs.discord.red/en/stable/install_guides/mac.html)
-- [Most major linux distributions](https://docs.discord.red/en/stable/install_guides/index.html)
+- [Windows](https://red-discordbot.readthedocs.io/en/stable/install_windows.html)
+- [MacOS](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
+- [Most major linux distributions](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
 
 If after reading the guide you are still experiencing issues, feel free to join the
 [Official Discord Server](https://discord.gg/red) and ask in the **#support** channel for help.
@@ -115,7 +115,7 @@ available 3rd party cogs!
 **Red** is in continuous development, and it’s supported by an active community which produces new
 content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t
 [find](https://index.discord.red) the cog you’re looking for,
-consult our [guide](https://docs.discord.red/en/stable/guide_cog_creation.html) on
+consult our [guide](https://red-discordbot.readthedocs.io/en/stable/guide_cog_creation.html) on
 building your own cogs!
 
 Join us on our [Official Discord Server](https://discord.gg/red)!

SECURITY.md

@@ -1,38 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-The table below explains the current state of our versions. Currently, only version
-3.5 and higher are supported and receive security updates. Versions lower than 3.5
-are considered End of Life and will not receive any security updates.
-
-| Version       | Branch     | Security Updates   | End of Life        |
-|---------------|------------|--------------------|--------------------|
-| < 2.0         | master     | :x:                | :white_check_mark: |
-| >= 2.0, < 3.0 | develop    | :x:                | :white_check_mark: |
-| >= 3.0, < 3.5 | V3/develop | :x:                | :white_check_mark: |
-| >= 3.5        | V3/develop | :white_check_mark: | :x:                |
-
-
-## Reporting a Vulnerability
-
-For reporting vulnerabilities within Red-DiscordBot we make use of GitHub's
-private vulnerability reporting feature (More information can be found
-[here](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)).
-This ensures that all maintainers and key members have access to the reported
-vulnerability.
-
-### Opening a Vulnerability Report
-
-To open a vulnerability report please fill out [this form](https://github.com/Cog-Creators/Red-DiscordBot/security/advisories/new)
-
-You will be asked to provide a summary, details and proof of concept for your vulnerability report.
-We ask that you fill out this form to the best of your ability, with as many details as possible.
-Furthermore, you'll be asked to provide affected products and severity.
-These fields are optional and will be filled appropriately by the maintainers if not provided.
-
-### Timeline
-
-We will try to answer your report within 7 days. If you haven't received an answer by then, we suggest you reach
-out to us privately. This can best be done via our [Discord server](https://discord.gg/red), and contacting
-a member who has the Staff role.

docs/autostart_systemd.rst

@@ -52,10 +52,9 @@ Paste the following in the file, and replace all instances of :code:`username` w
     User=username
     Group=username
     Type=idle
-    Restart=on-abnormal
+    Restart=always
     RestartSec=15
-    RestartForceExitStatus=1
-    RestartForceExitStatus=26
+    RestartPreventExitStatus=0
     TimeoutStopSec=10
 
     [Install]

docs/autostart_windows.rst

@@ -21,13 +21,10 @@ Open that document in Notepad, and paste the following text in it:
     CALL "%userprofile%\redenv\Scripts\activate.bat"
     python -O -m redbot <your instance name>
 
-    IF %ERRORLEVEL% == 1 GOTO RESTART_RED
-    IF %ERRORLEVEL% == 26 GOTO RESTART_RED
-    EXIT /B %ERRORLEVEL%
-
-    :RESTART_RED
-    ECHO Restarting Red...
-    GOTO RED
+    IF %ERRORLEVEL% NEQ 0 (
+        ECHO Restarting Red...
+        GOTO RED
+    )
 
 Replace ``<your instance name>`` with the instance name of your bot.
 If you created your VENV at a location other than the recommended one, replace ``%userprofile%\redenv\Scripts\activate.bat`` with the path to your VENV.
@@ -48,4 +45,4 @@ Open the "Run" dialogue box using Windows Key + R.
 
 Enter ``shell:startup`` if you want the bot to launch only when the current user logs in, or ``shell:common startup`` if you want the bot to launch when any user logs in.
 
-Drag the shortcut into the folder that is opened. The bot will now launch on startup.
+Drag the shortcut into the folder that is opened. The bot will now launch on startup.

docs/cog_customcom.rst

@@ -19,7 +19,7 @@ Cooldowns
 
 You can set cooldowns for your custom commands. If a command is on cooldown, it will not be triggered.
 
-You can set cooldowns per member or per thread/channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
+You can set cooldowns per member or per channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
 
 ------------------
 Context Parameters
@@ -27,19 +27,19 @@ Context Parameters
 
 You can enhance your custom command's response by leaving spaces for the bot to substitute.
 
-+-----------+--------------------------------------------------+
-| Argument  | Substitute                                       |
-+===========+==================================================+
-| {message} | The message the bot is responding to.            |
-+-----------+--------------------------------------------------+
-| {author}  | The user who called the command.                 |
-+-----------+--------------------------------------------------+
-| {channel} | The channel or thread the command was called in. |
-+-----------+--------------------------------------------------+
-| {server}  | The server the command was called in.            |
-+-----------+--------------------------------------------------+
-| {guild}   | Same as with {server}.                           |
-+-----------+--------------------------------------------------+
++-----------+----------------------------------------+
+| Argument  | Substitute                             |
++===========+========================================+
+| {message} | The message the bot is responding to.  |
++-----------+----------------------------------------+
+| {author}  | The user who called the command.       |
++-----------+----------------------------------------+
+| {channel} | The channel the command was called in. |
++-----------+----------------------------------------+
+| {server}  | The server the command was called in.  |
++-----------+----------------------------------------+
+| {guild}   | Same as with {server}.                 |
++-----------+----------------------------------------+
 
 You can further refine the response with dot notation. For example, {author.mention} will mention the user who called the command.
 
@@ -81,7 +81,7 @@ Showing your own avatar
 
 .. code-block:: none
 
-    [p]customcom add simple avatar {author.display_avatar}
+    [p]customcom add simple avatar {author.avatar_url}
     [p]avatar
         https://cdn.discordapp.com/avatars/133801473317404673/be4c4a4fe47cb3e74c31a0504e7a295e.webp?size=1024
 

docs/cog_guides/admin.rst

@@ -389,7 +389,7 @@ announceset channel
 
 .. code-block:: none
 
-    [p]announceset channel <channel>
+    [p]announceset channel [channel]
 
 **Description**
 
@@ -397,8 +397,8 @@ Sets the channel where the bot owner announcements will be sent.
 
 **Arguments**
 
-* ``<channel>``: The channel that will be used for bot announcements.
-  |channel-input|
+* ``[channel]``: The channel that will be used for bot announcements.
+  |channel-input| Defaults to where you typed the command.
 
 .. _admin-command-announceset-clearchannel:
 

docs/cog_guides/bank.rst

@@ -0,0 +1,186 @@
+.. _bank:
+
+====
+Bank
+====
+
+This is the cog guide for the bank cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load bank
+
+.. _bank-usage:
+
+-----
+Usage
+-----
+
+This cog manages the bank. It won't be used often by
+users but this is what makes any interaction with the
+money possible.
+
+You will be able to switch between a global and a server-
+wide bank and choose the bank/currency name.
+
+.. _bank-commands:
+
+--------
+Commands
+--------
+
+.. _bank-command-bankset:
+
+^^^^^^^
+bankset
+^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset
+
+**Description**
+
+Base command for configuring bank settings.
+
+.. _bank-command-bankset-toggleglobal:
+
+""""""""""""""""""""
+bankset toggleglobal
+""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset toggleglobal [confirm=False]
+
+**Description**
+
+Makes the bank global instead of server-wide. If it
+is already global, the command will switch it back
+to the server-wide bank.
+
+.. warning:: Using this command will reset **all** accounts.
+
+**Arguments**
+
+* ``[confirm=False]``: Put ``yes`` to confirm.
+
+.. _bank-command-bankset-creditsname:
+
+"""""""""""""""""""
+bankset creditsname
+"""""""""""""""""""
+
+.. note:: |owner-lock| However, if the bank is server-wide, the
+    server owner or an administrator can use this command.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset creditsname <name>
+
+**Description**
+
+Change the credits name of the bank. It is ``credits`` by default.
+
+For example, if you switch it to ``dollars``, the payday
+command will show this:
+
+.. TODO reference the payday command
+
+.. code-block:: none
+
+    Here, take some dollars. Enjoy! (+120 dollars!)
+
+    You currently have 220 dollars.
+
+**Arguments**
+
+* ``<name>``: The new credits name.
+
+.. _bank-command-bankset-bankname:
+
+""""""""""""""""
+bankset bankname
+""""""""""""""""
+
+.. note:: |owner-lock| However, if the bank is server-wide, the
+    server owner or an administrator can use this command.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset bankname <name>
+
+**Description**
+
+Set bank's name.
+
+**Arguments**
+
+* ``<name>``: The new bank's name.
+
+.. _bank-command-bankset-maxbal:
+
+""""""""""""""
+bankset maxbal
+""""""""""""""
+
+.. note:: |owner-lock| However, if the bank is server-wide, the
+    server owner or an administrator can use this command.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset maxbal <amount>
+
+**Description**
+
+Defines the maximum amount of money a user can have with the bot.
+
+If a user reaches this limit, they will be unable to gain more money.
+
+**Arguments**
+
+*   ``<amount>``: The maximum amount of money for users.
+
+.. _bank-command-bankset-showsettings:
+
+""""""""""""""""""""
+bankset showsettings
+""""""""""""""""""""
+
+.. note:: |owner-lock| However, if the bank is server-wide, the
+    server owner or an administrator can use this command.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bankset showsettings
+
+**Description**
+
+Shows the current settings of your bank.
+
+This will display the following information:
+
+*   Name of the bank
+*   Scope of the bank (global or per server)
+*   Currency name
+*   Default balance
+*   Maximum allowed balance

docs/cog_guides/cog_manager_ui.rst

@@ -171,17 +171,17 @@ removepath
 
 .. code-block:: none
 
-    [p]removepath <path_numbers...>
+    [p]removepath <path_number>
 
 **Description**
 
-Removes one or more paths from the list of available paths. Its cogs won't be
-accessible anymore.
+Removes a path from the list of available paths. Its cogs won't be accessible
+anymore.
 
 **Arguments**
 
-*   ``<path_numbers>``: The number of the path(s) to remove. You can get it with
-    the :ref:`paths <cogmanagerui-command-paths>` command.
+*   ``<path_number>``: The number of the path to remove. You can get it with
+    the :ref:`paths <cogmanagerui>` command.
 
 .. _cogmanagerui-command-reorderpath:
 

docs/cog_guides/customcommands.rst

@@ -68,7 +68,7 @@ customcom cooldown
 
 Set, edit, or view the cooldown for a custom command.
 
-You may set cooldowns per member, thread/channel, or guild. Multiple
+You may set cooldowns per member, channel, or guild. Multiple
 cooldowns may be set. All cooldowns must be cooled to call the
 custom command.
 
@@ -267,7 +267,7 @@ customcom search
 
 Searches through custom commands, according to the query.
 
-Uses fuzzy searching to find close matches.
+Uses fuzzywuzzy searching to find close matches.
 
 **Arguments:**
 

docs/cog_guides/economy.rst

@@ -68,6 +68,133 @@ Example:
 
 - ``<user>`` The user to check the balance of. If omitted, defaults to your own balance.
 
+.. _economy-command-bank-prune:
+
+""""""""""
+bank prune
+""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune 
+
+**Description**
+
+Base command for pruning bank accounts.
+
+.. _economy-command-bank-prune-global:
+
+"""""""""""""""""
+bank prune global
+"""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune global [confirmation=False]
+
+**Description**
+
+Prune bank accounts for users who no longer share a server with the bot.
+
+Cannot be used without a global bank. See ``[p]bank prune server``.
+
+Examples:
+    - ``[p]bank prune global`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune global yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-prune-server:
+
+"""""""""""""""""
+bank prune server
+"""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune server [confirmation=False]
+
+.. tip:: Aliases: ``bank prune guild``, ``bank prune local``
+
+**Description**
+
+Prune bank accounts for users no longer in the server.
+
+Cannot be used with a global bank. See ``[p]bank prune global``.
+
+Examples:
+    - ``[p]bank prune server`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune server yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-prune-user:
+
+"""""""""""""""
+bank prune user
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune user <user> [confirmation=False]
+
+**Description**
+
+Delete the bank account of a specified user.
+
+Examples:
+    - ``[p]bank prune user @TwentySix`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune user @TwentySix yes``
+
+**Arguments**
+
+- ``<user>`` The user to delete the bank of. Takes mentions, names, and user ids.
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-reset:
+
+""""""""""
+bank reset
+""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank reset [confirmation=False]
+
+**Description**
+
+Delete all bank accounts.
+
+Examples:
+    - ``[p]bank reset`` - Did not confirm. Shows the help message.
+    - ``[p]bank reset yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
 .. _economy-command-bank-set:
 
 """"""""
@@ -190,6 +317,29 @@ Examples:
 - | ``<duration>`` The new duration to wait in between uses of payday. Default is 5 minutes.
   | Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
 
+.. _economy-command-economyset-registeramount:
+
+"""""""""""""""""""""""""
+economyset registeramount
+"""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset registeramount <creds>
+
+**Description**
+
+Set the initial balance for new bank accounts.
+
+Example:
+    - ``[p]economyset registeramount 5000``
+
+**Arguments**
+
+- ``<creds>`` The new initial balance amount. Default is 0.
+
 .. _economy-command-economyset-rolepaydayamount:
 
 """""""""""""""""""""""""""

docs/cog_guides/filter.rst

@@ -115,12 +115,11 @@ Add words to the filter.
 Use double quotes to add sentences.
 
 Examples:
-    - ``[p]filter channel add #channel word1 word2 word3``
-    - ``[p]filter channel add #channel "This is a sentence"``
+    - ``[p]filter channel add word1 word2 word3``
+    - ``[p]filter channel add "This is a sentence"``
 
 **Arguments:**
 
-- ``<channel>`` The text, voice, stage, or forum channel to add filtered words to.
 - ``[words...]`` The words or sentences to filter.
 
 .. _filter-command-filter-channel-clear:
@@ -165,7 +164,7 @@ filter channel remove
 
 .. code-block:: none
 
-    [p]filter channel remove <channel> [words...]
+    [p]filter channel remove [words...]
 
 **Description**
 
@@ -174,12 +173,11 @@ Remove words from the filter.
 Use double quotes to remove sentences.
 
 Examples:
-    - ``[p]filter channel remove #channel word1 word2 word3``
-    - ``[p]filter channel remove #channel "This is a sentence"``
+    - ``[p]filter channel remove word1 word2 word3``
+    - ``[p]filter channel remove "This is a sentence"``
 
 **Arguments:**
 
-- ``<channel>`` The text, voice, stage, or forum channel to add filtered words to.
 - ``[words...]`` The words or sentences to no longer filter.
 
 .. _filter-command-filter-clear:

docs/cog_guides/mod.rst

@@ -215,11 +215,11 @@ modset deletenames
 
 **Description**
 
-Delete all stored usernames, global display names, and server nicknames.
+Delete all stored usernames and nicknames.
 
 **Arguments**
 
-- ``<confirmation>``: Whether to delete all stored usernames, global display names, and server nicknames. |bool-input|
+- ``<confirmation>``: Whether to delete all stored usernames and nicknames. |bool-input|
 
 .. _mod-command-modset-deleterepeats:
 
@@ -469,7 +469,7 @@ modset tracknicknames
 
 **Description**
 
-Toggle whether server nickname changes should be tracked.
+Toggle whether nickname changes should be tracked.
 
 This setting will be overridden if trackallnames is disabled.
 
@@ -527,7 +527,7 @@ names
 
 **Description**
 
-Show previous usernames, global display names, and server nicknames of a member.
+Show previous names and nicknames of a member.
 
 **Arguments**
 
@@ -549,14 +549,14 @@ rename
 
 **Description**
 
-Change a member's server nickname.
+Change a member's nickname.
 
-Leaving the nickname argument empty will remove it.
+Leaving the nickname empty will remove it.
 
 **Arguments**
 
 * ``<member>``: |member-input|
-* ``[nickname]``: The new server nickname for the member.
+* ``[nickname]``: The new nickname for the member.
 
 .. _mod-command-slowmode:
 
@@ -574,14 +574,14 @@ slowmode
 
 **Description**
 
-Changes thread's or channel's slowmode setting.
+Changes channel's slowmode setting.
 
 Interval can be anything from 0 seconds to 6 hours.
 Use without parameters to disable.
 
 **Arguments**
 
-* ``[interval=0:00:00]``: The time for the thread's/channel's slowmode settings.
+* ``[interval=0:00:00]``: The time for the channel's slowmode settings.
 
 .. note::
     Interval can be anything from 0 seconds to 6 hours.
@@ -684,9 +684,9 @@ userinfo
 Show information about a user.
 
 This includes fields for status, discord join date, server
-join date, voice state and previous usernames/global display names/nicknames.
+join date, voice state and previous names/nicknames.
 
-If the user has no roles, previous usernames, global display names, or server nicknames,
+If the user has no roles, previous names or previous nicknames,
 these fields will be omitted.
 
 **Arguments**

docs/cog_guides/modlog.rst

@@ -19,7 +19,7 @@ find detailed docs about usage and commands.
 Usage
 -----
 
-Browse and manage modlog cases.
+Manage log channels for moderation actions.
 
 
 .. _modlog-commands:
@@ -88,6 +88,85 @@ List cases for the specified member.
 
 * ``<member>``: The member to get cases for. |member-input|
 
+.. _modlog-command-modlogset:
+
+^^^^^^^^^
+modlogset
+^^^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modlogset 
+
+**Description**
+
+Manage modlog settings.
+
+.. _modlog-command-modlogset-cases:
+
+"""""""""""""""
+modlogset cases
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modlogset cases [action]
+
+**Description**
+
+Enable or disable case creation for a mod action, like disabling warnings, enabling bans, etc.
+
+**Examples:**
+    - ``[p]modlogset cases kick`` - Enables/disables modlog messages for kicks.
+    - ``[p]modlogset cases ban`` - Enables/disables modlog messages for bans.
+
+**Arguments:**
+    - ``[action]`` - The type of mod action to be enabled/disabled for case creation.
+
+.. _modlog-command-modlogset-modlog:
+
+""""""""""""""""
+modlogset modlog
+""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modlogset modlog [channel]
+
+.. tip:: Alias: ``modlogset channel``
+
+**Description**
+
+Set a channel as the modlog.
+
+**Arguments**
+
+* ``[channel]``: The channel to set as the modlog. If omitted, the modlog will be disabled.
+
+.. _modlog-command-modlogset-resetcases:
+
+""""""""""""""""""""
+modlogset resetcases
+""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modlogset resetcases 
+
+**Description**
+
+Reset all modlog cases in this server.
+
 .. _modlog-command-reason:
 
 ^^^^^^

docs/cog_guides/mutes.rst

@@ -91,7 +91,7 @@ mutechannel
 
 **Description**
 
-Mute a user in the current text channel (or in the parent of the current thread).
+Mute a user in the current text channel.
 
 Examples:
 
@@ -355,7 +355,7 @@ unmutechannel
 
 **Description**
 
-Unmute a user in this channel (or in the parent of this thread).
+Unmute a user in this channel.
 
 **Arguments**
 

docs/cog_guides/permissions.rst

@@ -29,7 +29,7 @@ Global rules (set by the owner) are checked first, then rules set for servers. I
 
 1. Rules about a user.
 2. Rules about the voice channel a user is in.
-3. Rules about the text channel or a parent of the thread a command was issued in.
+3. Rules about the text channel a command was issued in.
 4. Rules about a role the user has (The highest role they have with a rule will be used).
 5. Rules about the server a user is in (Global rules only).
 

docs/cog_guides/reports.rst

@@ -73,7 +73,7 @@ report interact
 
 Open a message tunnel.
 
-This tunnel will forward things you say in this channel or thread
+This tunnel will forward things you say in this channel
 to the ticket opener's direct messages.
 
 Tunnels do not persist across bot restarts.

docs/cog_guides/streams.rst

@@ -338,22 +338,6 @@ To set the Twitch API tokens, follow these steps:
 .. attention:: These tokens are sensitive and should only be 
                used in a private channel or in DM with the bot.
 
-.. _streams-command-streamset-usebuttons:
-
-^^^^^^^^^^^^^^^^^^^^
-streamset usebuttons
-^^^^^^^^^^^^^^^^^^^^
-
-**Syntax**
-
-.. code-block:: none
-
-    [p]streamset usebuttons
-
-**Description**
-
-Toggle whether to use buttons for stream alerts.
-
 .. _streams-command-picarto:
 
 ^^^^^^^

docs/cog_permissions.rst

@@ -31,8 +31,8 @@ In terms of scope, global rules will be checked first, then server rules.
 For each of those, the first rule pertaining to one of the following models will be used:
 
 1. User
-2. Voice/stage channel a user is connected to
-3. The channel command was issued in (parent channel in case of invocations in threads)
+2. Voice channel
+3. Text channel
 4. Channel category
 5. Roles, highest to lowest
 6. Server (can only be in global rules)

docs/conf.py

@@ -19,7 +19,6 @@
 #
 import os
 import sys
-import time
 
 sys.path.insert(0, os.path.abspath(".."))
 sys.path.insert(0, os.path.abspath("_ext"))
@@ -62,7 +61,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Red - Discord Bot"
-copyright = f"2018-{time.strftime('%Y')}, Cog Creators"
+copyright = "2018-2021, Cog Creators"
 author = "Cog Creators"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -70,7 +69,7 @@ author = "Cog Creators"
 # built documents.
 #
 from redbot.core import __version__
-from discord import __version__ as dpy_version, version_info as dpy_version_info
+from discord import __version__ as dpy_version
 
 # The short X.Y version.
 version = __version__
@@ -82,7 +81,7 @@ release = __version__
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = "en"
+language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -228,17 +227,10 @@ linkcheck_retries = 3
 
 # -- Options for extensions -----------------------------------------------
 
-if dpy_version_info.releaselevel == "final":
-    # final release - versioned docs should be available
-    dpy_docs_url = f"https://discordpy.readthedocs.io/en/v{dpy_version}/"
-else:
-    # alpha release - `latest` version of docs should be used
-    dpy_docs_url = "https://discordpy.readthedocs.io/en/latest/"
-
 # Intersphinx
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "dpy": (dpy_docs_url, None),
+    "dpy": (f"https://discordpy.readthedocs.io/en/v{dpy_version}/", None),
     "motor": ("https://motor.readthedocs.io/en/stable/", None),
     "babel": ("http://babel.pocoo.org/en/stable/", None),
     "dateutil": ("https://dateutil.readthedocs.io/en/stable/", None),
@@ -248,9 +240,9 @@ intersphinx_mapping = {
 # This allows to create links to d.py docs with
 # :dpy_docs:`link text <site_name.html>`
 extlinks = {
-    "dpy_docs": (f"{dpy_docs_url}%s", None),
-    "issue": ("https://github.com/Cog-Creators/Red-DiscordBot/issues/%s", "#%s"),
-    "ghuser": ("https://github.com/%s", "@%s"),
+    "dpy_docs": (f"https://discordpy.readthedocs.io/en/v{dpy_version}/%s", None),
+    "issue": ("https://github.com/Cog-Creators/Red-DiscordBot/issues/%s", "#"),
+    "ghuser": ("https://github.com/%s", "@"),
 }
 
 # Doctest
@@ -261,21 +253,3 @@ doctest_test_doctest_blocks = ""
 # Autodoc options
 autodoc_default_options = {"show-inheritance": True}
 autodoc_typehints = "none"
-
-
-from docutils import nodes
-from sphinx.transforms import SphinxTransform
-
-
-# d.py's |coro| substitution leaks into our docs because we don't replace some of the docstrings
-class IgnoreCoroSubstitution(SphinxTransform):
-    default_priority = 210
-
-    def apply(self, **kwargs) -> None:
-        for ref in self.document.traverse(nodes.substitution_reference):
-            if ref["refname"] == "coro":
-                ref.replace_self(nodes.Text(""))
-
-
-def setup(app):
-    app.add_transform(IgnoreCoroSubstitution)

docs/framework_apikeys.rst

@@ -69,13 +69,9 @@ Additional References
 .. py:currentmodule:: redbot.core.bot
 
 .. automethod:: Red.get_shared_api_tokens
-    :noindex:
 
 .. automethod:: Red.set_shared_api_tokens
-    :noindex:
 
 .. automethod:: Red.remove_shared_api_tokens
-    :noindex:
 
 .. automethod:: Red.remove_shared_api_services
-    :noindex:

docs/framework_bank.rst

@@ -21,7 +21,9 @@ Basic Usage
 
     class MyCog(commands.Cog):
         @commands.command()
-        async def balance(self, ctx, user: discord.Member = commands.Author):
+        async def balance(self, ctx, user: discord.Member = None):
+            if user is None:
+                user = ctx.author
             bal = await bank.get_balance(user)
             currency = await bank.get_currency_name(ctx.guild)
             await ctx.send(

docs/framework_bot.rst

@@ -6,12 +6,18 @@ Bot
 
 .. automodule:: redbot.core.bot
 
+RedBase
+^^^^^^^
+
+.. autoclass:: RedBase
+    :members:
+    :exclude-members: get_context
+
+    .. automethod:: register_rpc_handler
+    .. automethod:: unregister_rpc_handler
+
 Red
 ^^^
 
 .. autoclass:: Red
     :members:
-    :exclude-members: get_context, get_embed_color
-
-    .. automethod:: register_rpc_handler
-    .. automethod:: unregister_rpc_handler

docs/framework_checks.rst

@@ -8,4 +8,4 @@ The following are all decorators for commands, which add restrictions to where a
 run.
 
 .. automodule:: redbot.core.commands
-    :members: permissions_check, bot_has_permissions, bot_in_a_guild, bot_can_manage_channel, bot_can_react, has_permissions, can_manage_channel, has_guild_permissions, is_owner, guildowner, guildowner_or_can_manage_channel, guildowner_or_permissions, admin, admin_or_can_manage_channel, admin_or_permissions, mod, mod_or_can_manage_channel, mod_or_permissions
+    :members: permissions_check, bot_has_permissions, bot_in_a_guild, has_permissions, has_guild_permissions, is_owner, guildowner, guildowner_or_permissions, admin, admin_or_permissions, mod, mod_or_permissions

docs/framework_cogmanager.rst

@@ -0,0 +1,8 @@
+.. cog manager docs
+
+===========
+Cog Manager
+===========
+
+.. automodule:: redbot.core.cog_manager
+    :members:

docs/framework_commands.rst

@@ -11,12 +11,8 @@ extend functionalities used throughout the bot, as outlined below.
 
 .. autofunction:: redbot.core.commands.command
 
-.. autofunction:: redbot.core.commands.hybrid_command
-
 .. autofunction:: redbot.core.commands.group
 
-.. autofunction:: redbot.core.commands.hybrid_group
-
 .. autoclass:: redbot.core.commands.Cog
 
     .. automethod:: format_help_for_context
@@ -25,21 +21,13 @@ extend functionalities used throughout the bot, as outlined below.
     
     .. automethod:: red_delete_data_for_user
 
-.. autoclass:: redbot.core.commands.GroupCog
-
 .. autoclass:: redbot.core.commands.Command
     :members:
     :inherited-members: format_help_for_context
 
-.. autoclass:: redbot.core.commands.HybridCommand
-    :members:
-
 .. autoclass:: redbot.core.commands.Group
     :members:
 
-.. autoclass:: redbot.core.commands.HybridGroup
-    :members:
-
 .. autoclass:: redbot.core.commands.Context
     :members:
 

docs/framework_config.rst

@@ -98,13 +98,13 @@ in various ways:
 .. code-block:: python
 
     @commands.command()
-    @commands.admin_or_permissions(manage_guild=True)
+    @checks.admin_or_permissions(manage_guild=True)
     async def setbaz(self, ctx, new_value):
         await self.config.guild(ctx.guild).baz.set(new_value)
         await ctx.send("Value of baz has been changed!")
 
     @commands.command()
-    @commands.is_owner()
+    @checks.is_owner()
     async def setfoobar(self, ctx, new_value):
         await self.config.foobar.set(new_value)
 
@@ -161,7 +161,7 @@ Here is an example of the :code:`async with` syntax:
     * :py:meth:`Config.member` which takes :py:class:`discord.Member`.
     * :py:meth:`Config.user` which takes :py:class:`discord.User`.
     * :py:meth:`Config.role` which takes :py:class:`discord.Role`.
-    * :py:meth:`Config.channel` which takes :py:class:`discord.abc.GuildChannel` or :py:class:`discord.Thread`.
+    * :py:meth:`Config.channel` which takes :py:class:`discord.TextChannel`.
 
 If you need to wipe data from the config, you want to look at :py:meth:`Group.clear`, or :py:meth:`Config.clear_all`
 and similar methods, such as :py:meth:`Config.clear_all_guilds`.
@@ -259,7 +259,7 @@ Now let's see an example that uses multiple identifiers:
 
 .. code-block:: python
 
-    from redbot.core import Config, commands
+    from redbot.core import Config, commands, checks
 
 
     class ChannelAccess(commands.Cog):
@@ -273,7 +273,7 @@ Now let's see an example that uses multiple identifiers:
             self.config.register_custom("ChannelAccess", **default_access)
 
         @commands.command()
-        @commands.is_owner()
+        @checks.is_owner()
         async def grantaccess(self, ctx, channel: discord.TextChannel, member: discord.Member):
             await self.config.custom("ChannelAccess", channel.id, member.id).allowed.set(True)
             await ctx.send("Member has been granted access to that channel")
@@ -467,7 +467,7 @@ much the same way they would in V2. The following examples will demonstrate how
     async def setup(bot):
         cog = ExampleCog()
         await cog.load_data()
-        await bot.add_cog(cog)
+        bot.add_cog(cog)
 
 ************************************
 Best practices and performance notes
@@ -540,14 +540,30 @@ Value
     :members:
     :special-members: __call__
 
-IdentifierData
-^^^^^^^^^^^^^^
 
-.. autoclass:: IdentifierData
+****************
+Driver Reference
+****************
+
+.. autofunction:: redbot.core.drivers.get_driver
+
+.. autoclass:: redbot.core.drivers.BackendType
     :members:
 
-ConfigCategory
-^^^^^^^^^^^^^^
-
-.. autoclass:: ConfigCategory
+.. autoclass:: redbot.core.drivers.ConfigCategory
+    :members:
+
+Base Driver
+^^^^^^^^^^^
+.. autoclass:: redbot.core.drivers.BaseDriver
+    :members:
+
+JSON Driver
+^^^^^^^^^^^
+.. autoclass:: redbot.core.drivers.JsonDriver
+    :members:
+
+Postgres Driver
+^^^^^^^^^^^^^^^
+.. autoclass:: redbot.core.drivers.PostgresDriver
     :members:

docs/framework_modlog.rst

@@ -21,7 +21,7 @@ Basic Usage
 
     class MyCog(commands.Cog):
         @commands.command()
-        @commands.admin_or_permissions(ban_members=True)
+        @checks.admin_or_permissions(ban_members=True)
         async def ban(self, ctx, user: discord.Member, reason: str = None):
             await ctx.guild.ban(user)
             case = await modlog.create_case(
@@ -35,7 +35,8 @@ Basic Usage
 Registering Case types
 **********************
 
-To register case types, use a special ``cog_load()`` method which is called when you add a cog:
+To register case types, use an asynchronous ``initialize()`` method and call
+it from your setup function:
 
 .. code-block:: python
 
@@ -45,7 +46,7 @@ To register case types, use a special ``cog_load()`` method which is called when
 
     class MyCog(commands.Cog):
 
-        async def cog_load(self):
+        async def initialize(self):
             await self.register_casetypes()
 
         @staticmethod
@@ -86,7 +87,8 @@ To register case types, use a special ``cog_load()`` method which is called when
 
     async def setup(bot):
         cog = MyCog()
-        await bot.add_cog(cog)
+        await cog.initialize()
+        bot.add_cog(cog)
 
 .. important::
     Image should be the emoji you want to represent your case type with.

docs/framework_rpc.rst

@@ -20,9 +20,9 @@ Examples
 
 .. code-block:: Python
 
-    async def setup(bot):
+    def setup(bot):
         c = Cog()
-        await bot.add_cog(c)
+        bot.add_cog(c)
         bot.register_rpc_handler(c.rpc_method)
 
 *******************************
@@ -64,4 +64,4 @@ All cog-based methods expect their parameter list to take one argument, a JSON o
 API Reference
 *************
 
-Please see the :class:`redbot.core.bot.Red` class for details on the RPC handler register and unregister methods.
+Please see the :class:`redbot.core.bot.RedBase` class for details on the RPC handler register and unregister methods.

docs/framework_tree.rst

@@ -1,21 +0,0 @@
-.. tree module docs
-
-====
-Tree
-====
-
-Red uses a subclass of discord.py's ``CommandTree`` object in order to allow Cog Creators to add application commands to their cogs without worrying about the command count limit and to support caching ``AppCommand`` objects. When an app command is added to the bot's tree, it will not show up in ``tree.get_commands`` or other similar methods unless the command is "enabled" with ``[p]slash enable`` (similar to "load"ing a cog) and ``tree.red_check_enabled`` has been run since the command was added to the tree.
-
-.. note::
-
-    If you are adding app commands to the tree during load time, the loading process will call ``tree.red_check_enabled`` for your cog and its app commands. If you are adding app commands to the bot **outside of load time**, a call to ``tree.red_check_enabled`` after adding the commands is required to ensure the commands will appear properly.
-
-    If application commands from your cog show up in ``[p]slash list`` as enabled from an ``(unknown)`` cog and disabled from your cog at the same time, you did not follow the instructions above. You must manually call ``tree.red_check_enabled`` **after** adding the commands to the tree.
-
-.. automodule:: redbot.core.tree
-
-RedTree
-^^^^^^^
-
-.. autoclass:: RedTree
-    :members:

docs/framework_utils.rst

@@ -8,7 +8,7 @@ General Utility
 ===============
 
 .. automodule:: redbot.core.utils
-    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter, get_end_user_data_statement, get_end_user_data_statement_or_raise, can_user_send_messages_in, can_user_manage_channel, can_user_react_in
+    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter, get_end_user_data_statement, get_end_user_data_statement_or_raise
 
 .. autoclass:: AsyncIter
     :members:
@@ -27,10 +27,6 @@ Chat Formatting
 
 .. automodule:: redbot.core.utils.chat_formatting
     :members:
-    :exclude-members: pagify
-
-    .. autofunction:: pagify(text, delims=('\n',), *, priority=False, escape_mass_mentions=True, shorten_by=8, page_length=2000)
-        :for:
 
 Embed Helpers
 =============
@@ -39,8 +35,8 @@ Embed Helpers
     :members:
     :exclude-members: randomize_color
 
-Menus
-=====
+Reaction Menus
+==============
 
 .. automodule:: redbot.core.utils.menus
     :members:
@@ -71,81 +67,9 @@ Tunnel
 
 .. automodule:: redbot.core.utils.tunnel
     :members: Tunnel
-    :exclude-members: files_from_attatch
 
 Common Filters
 ==============
 
 .. automodule:: redbot.core.utils.common_filters
     :members:
-
-Utility UI
-==========
-
-.. automodule:: redbot.core.utils.views
-    :members:
-    :exclude-members: ConfirmView
-
-    .. autoclass:: ConfirmView
-        :members:
-        :exclude-members: confirm_button, dismiss_button
-
-        .. autoattribute:: confirm_button
-            :no-value:
-
-            A `discord.ui.Button` to confirm the message.
-
-            The button's callback will set `result` to ``True``, defer the response,
-            and call `on_timeout()` to clean up the view.
-
-            .. rubric:: Example
-
-            Changing the style and label of this `discord.ui.Button`::
-
-                view = ConfirmView(ctx.author)
-                view.confirm_button.style = discord.ButtonStyle.red
-                view.confirm_button.label = "Delete"
-                view.dismiss_button.label = "Cancel"
-                view.message = await ctx.send(
-                    "Are you sure you want to remove #very-important-channel?", view=view
-                )
-                await view.wait()
-                if view.result:
-                    await ctx.send("Channel #very-important-channel deleted.")
-                else:
-                    await ctx.send("Canceled.")
-
-            :type: discord.ui.Button
-
-        .. autoattribute:: dismiss_button
-            :no-value:
-
-            A `discord.ui.Button` to dismiss the message.
-
-            The button's callback will set `result` to ``False``, defer the response,
-            and call `on_timeout()` to clean up the view.
-
-            .. rubric:: Example
-
-            Changing the style and label of this `discord.ui.Button`::
-
-                view = ConfirmView(ctx.author)
-                view.confirm_button.style = discord.ButtonStyle.red
-                view.confirm_button.label = "Delete"
-                view.dismiss_button.label = "Cancel"
-                view.message = await ctx.send(
-                    "Are you sure you want to remove #very-important-channel?", view=view
-                )
-                await view.wait()
-                if view.result:
-                    await ctx.send("Channel #very-important-channel deleted.")
-                else:
-                    await ctx.send("Canceled.")
-
-            :type: discord.ui.Button
-
-AntiSpam
-========
-
-.. automodule:: redbot.core.utils.antispam
-    :members:

docs/getting_started.rst

@@ -134,7 +134,7 @@ Red is built with cogs, a fancy term for plugins. They are
 modules that add functionality to Red. They contain
 commands to use.
 
-Red comes with 18 cogs containing the basic features, such
+Red comes with 19 cogs containing the basic features, such
 as moderation, utility, music, streams...
 
 You can see your loaded and unloaded cogs with the ``[p]cogs``
@@ -225,7 +225,7 @@ Administrator
 ~~~~~~~~~~~~~
 
 The administrator is defined by its roles. You can set multiple admin roles
-with the ``[p]set roles addadminrole`` and ``[p]set roles removeadminrole`` commands.
+with the ``[p]set addadminrole`` and ``[p]set removeadminrole`` commands.
 
 For example, in the mod cog, an admin can use the ``[p]modset`` command
 which defines the cog settings.
@@ -235,7 +235,7 @@ Moderator
 ~~~~~~~~~
 
 A moderator is a step above the average users. You can set multiple moderator
-roles with the ``[p]set roles addmodrole`` and ``[p]set roles removemodrole`` commands.
+roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands.
 
 For example, in the filter cog, a mod will be able to use the various commands 
 under ``[p]filter`` (such as adding and removing filtered words), but they will

docs/guide_cog_creation.rst

@@ -102,8 +102,8 @@ Open :code:`__init__.py`. In that file, place the following:
     from .mycog import MyCog
 
 
-    async def setup(bot):
-        await bot.add_cog(MyCog(bot))
+    def setup(bot):
+        bot.add_cog(MyCog(bot))
 
 Make sure that both files are saved.
 

docs/guide_cog_creators.rst

@@ -73,7 +73,7 @@ Any Cog Creator that does not follow these requirements will have their repo rem
 
   - Cogs that are more than what is able to be run in a simple eval.
   - Cogs that are more than just a simple API access request.
-  - Cogs that properly use Red utilities, for example Config, or any other utility functions.
+  - Cogs that properly use Red utilities, including Config, checks, and any other utility functions.
   - Cogs that use event listeners (bot.wait_for or cog-wide listeners) or custom tasks that are efficient and handle exceptions appropriately.
   - Cogs that handle errors properly.
   - Cogs that handle permissions properly.
@@ -84,7 +84,7 @@ Any Cog Creator that does not follow these requirements will have their repo rem
 - The default locale must be English.
 - The main cog class and every command must have a doc-string.
 - No cog allows for escalation of permissions. (e.g., sending a mass ping through the bot without having permission to do so)
-- Respect the role hierarchy. Don't let a lower role have a way to grant a higher role.
+- Respect the role hierarchy. Don’t let a lower role have a way to grant a higher role.
 - If your cog install comes with any pre-packaged data, use `bundled_data_path()` to access it.
 - If your cog install creates any non-config data, use `cog_data_path()` to store it.
 - Unless the cog is intentionally designed to listen to certain input from bots, cogs should ignore input from bots.
@@ -94,6 +94,8 @@ Any Cog Creator that does not follow these requirements will have their repo rem
   - If that's not possible, don't break anything in core or any other cog with your code.
   - If you have to use private methods, lock the cog to specific Red versions you can guarantee it works on without breaking anything using the ``min_bot_version`` and ``max_bot_version`` keys in that cog's ``info.json`` file.
 
+- Cog Creators must keep their cogs up-to-date with core Red or be delisted until cogs meet Red API changes. Repositories must be kept up to date with the latest version of Red within 3 months of its release.
+
 .. _recommendations-for-cog-creators:
 
 --------------------------------
@@ -136,15 +138,14 @@ While not required for approved Cog Creators, they are still recommended in orde
   - ``ctx.embed_color``
   - ``bot.is_automod_immune``
 
-- Use decorators to limit command use, restrict usage, or define whether the bot needs special permissions.
-  You can find all of the permission and cooldown related decorators under the ``redbot.core.commands`` namespace.
+- Use checks to limit command use when the bot needs special permissions.
 - Check against user input before doing things. Common things to check:
 
   - Resulting output is safe.
   - Values provided make sense. (eg. no negative numbers for payday)
   - Don't unsafely use user input for things like database input.
 
-- Check events against `bot.cog_disabled_in_guild() <Red.cog_disabled_in_guild()>`\
+- Check events against `bot.cog_disabled_in_guild() <RedBase.cog_disabled_in_guild()>`\
 
   - Not all events need to be checked, only those that interact with a guild.
   - Some discretion may apply, for example,
@@ -194,12 +195,7 @@ Other Details
 - The reviewer of your application has the final word.
 - Hidden cogs will not be explicitly reviewed, however they are not allowed to contain malicious or ToS breaking code.
 - QA reserves the right to revoke these roles and all privileges if you are found to be in gross negligence, malicious intent, or reckless abandonment of your repository.
-- Cogs must be functionally working to the quality of an approved cog on the latest minor version of Red to be listed on the Red Index. Cogs that are not updated within 1 month of initial breakage will be delisted from the index until they are updated. Examples of potential breakage include, but are not limited to:
-
-  - A dependency without version constraints receiving a breaking update
-  - An API changing the schema of its endpoints
-  - Red itself releasing a new minor version
-
+- If a Cog Creator's repository is not maintained and kept up to date, that repo will be removed from the approved repo listings until such issues are addressed.
 - Only 1 person is allowed to be the Cog Creator for a particular repo. Multiple people are allowed to maintain the repo, however the "main" owner (and the Cog Creator) is responsible for any code on the repo.
 - The Cog Creator status for a repo can be transferred to another user if the Cog Creator requests it.
 - An approved Cog Creator can ask QA to add additional repos they have created to the approved pool.

docs/guide_migration.rst

@@ -7,7 +7,7 @@
 Migrating cogs from Red V2
 ==========================
 
-First, be sure to read :dpy_docs:`discord.py's migration guide <migrating_to_v1.html>`
+First, be sure to read :dpy_docs:`discord.py's migration guide <migrating.html>`
 as that covers all of the changes to discord.py that will affect the migration process
 
 ----------------

docs/guide_slash_and_interactions.rst

@@ -1,334 +0,0 @@
-.. Slash Commands and Interactions
-
-.. role:: python(code)
-    :language: python
-
-===============================
-Slash Commands and Interactions
-===============================
-
-This guide is going to cover on how to write a simple slash command into a Red cog.
-This guide will assume that you have a working basic cog.
-If you do not have a basic cog, please refer to the :ref:`getting started <getting-started>` guide.
-It is also adviced to make yourself familiar with `Application Commands <https://discord.com/developers/docs/interactions/application-commands>`__ from Discord's documentation. 
-
----------------
-Getting Started
----------------
-
-To start off, we will have to import some additional modules to our cog file.
-We will be using the ``redbot.core.app_commands`` module to create our slash commands.
-Once we have imported the module, we can start creating our slash commands in our cog class.
-For this example we will use a basic hello world command.
-
-.. code-block:: python
-
-    import discord
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        async def hello(self, interaction: discord.Interaction):
-            await interaction.response.send_message("Hello World!", ephemeral=True)
-
-Go ahead and load your cog. Once it is loaded, we will have to enable and sync our slash commands.
-We can do this by using the :ref:`[p]slash<core-command-slash>` command to manage our slash commands.
-Once you have registered your slash commands, you can test them out by typing ``/hello`` in your server.
-
-----------------------------
-Slash Commands and Arguments
-----------------------------
-
-There is a lot of flexibility when it comes to slash commands.
-Below we will go over some of the different stuff you can do with slash commands.
-
-Decorators
-----------
-Just like with text commands, we can use decorators to modify the behaviour of our slash commands.
-For example, we can use the `app_commands.guild_only() <discord.app_commands.guild_only>` decorator to make our slash command only work in guilds.
-
-.. code-block:: python
-
-    import discord
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.guild_only()
-        async def hello(self, interaction: discord.Interaction):
-            await interaction.response.send_message("Hello World!", ephemeral=True)
-
-One of the more useful decorators is the `app_commands.choices() <discord.app_commands.choices>` decorator.
-This decorator allows us to specify a list of choices for a specific argument.
-This is useful for arguments that have a limited number of options.
-For example, we can use this to create a command that allows us to choose between two different colors.
-
-.. code-block:: python
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(color="The color you want to choose")
-        @app_commands.choices(color=[
-             app_commands.Choice(name="Red", value="red"),
-             app_commands.Choice(name="Blue", value="blue"),
-        ])
-        async def color(self, interaction: discord.Interaction, color: app_commands.Choice[str]):
-            await interaction.response.send_message(f"Your color is {color.value}", ephemeral=True)
-
-The user will be shown the ``name`` of the choice, and the argument will be passed a
-`app_commands.Choice <discord.app_commands.Choice>` object with the ``name`` and ``value`` associated with that choice.
-This allows user-facing names to be prettier than what is actually processed by the command.
-
-Alternatively, ``Literal`` can be used if the argument does not need a different
-user-facing label. When done this way, the resulting parameter will be one of
-the literal values listed.
-
-.. code-block:: python
-
-    from redbot.core import commands, app_commands
-    from typing import Literal
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(color="The color you want to choose")
-        async def color(self, interaction: discord.Interaction, color: Literal["Red", "Blue"]):
-            await interaction.response.send_message(f"Your color is {color}", ephemeral=True)
-
-Finally, an `enum.Enum` subclass can be used to specify choices. When done this way, the
-resulting parameter will be an instance of that enum, rather than `app_commands.Choice <discord.app_commands.Choice>`.
-
-.. code-block:: python
-
-    from enum import Enum
-    from redbot.core import commands, app_commands
-
-    class Color(Enum):
-        Red = "red"
-        Blue = "blue"
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(color="The color you want to choose")
-        async def color(self, interaction: discord.Interaction, color: Color):
-            await interaction.response.send_message(f"Your color is {color.value}", ephemeral=True)
-
-Check out :dpy_docs:`the full reference of decorators at Discord.py's documentation <interactions/api.html#decorators>`.
-
-
-Groups & Subcommands
---------------------
-Slash commands can also be grouped together into groups and subcommands.
-These can be used to create a more complex command structure.
-
-.. note::
-    Unlike text command groups, top level slash command groups **cannot** be invoked.
-
-.. code-block:: python
-
-    import discord
-    
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        zoo = app_commands.Group(name="zoo", description="Zoo related commands")
-
-        @zoo.command(name="add", description="Add an animal to the zoo")
-        @app_commands.describe(animal="The animal you want to add")
-        async def zoo_add(self, interaction: discord.Interaction, animal: str):
-            await interaction.response.send_message(f"Added {animal} to the zoo", ephemeral=True)
-
-        @zoo.command(name="remove", description="Remove an animal from the zoo")
-        @app_commands.describe(animal="The animal you want to remove")
-        async def zoo_remove(self, interaction: discord.Interaction, animal: str):
-            await interaction.response.send_message(f"Removed {animal} from the zoo", ephemeral=True)
-
-Arguments
----------
-As shown in some of the above examples, we can amplify our slash commands with arguments.
-However with slash commands Discord allows us to do a few more things.
-Such as specifically select a channel that we'd like to use in our commands,
-we can do the same with roles and members.
-Let's take a look at how we can do that.
-
-.. code-block:: python
-
-    import discord
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(channel="The channel you want to mention")
-        async def mentionchannel(self, interaction: discord.Interaction, channel: discord.abc.GuildChannel):
-            await interaction.response.send_message(f"That channel is {channel.mention}", ephemeral=True)
-
-        @app_commands.command()
-        @app_commands.describe(role="The role you want to mention")
-        async def mentionrole(self, interaction: discord.Interaction, role: discord.Role):
-            await interaction.response.send_message(f"That role is {role.mention}", ephemeral=True)
-
-        @app_commands.command()
-        @app_commands.describe(member="The member you want to mention")
-        async def mentionmember(self, interaction: discord.Interaction, member: discord.Member):
-            await interaction.response.send_message(f"That member is {member.mention}", ephemeral=True)
-
-If you try out the mentionchannel command, you will see that it currently accepts any type of channel,
-however let's say we want to limit this to voice channels only.
-We can do so by adjusting our type hint to :class:`discord.VoiceChannel` instead of :class:`discord.abc.GuildChannel`.
-
-.. code-block:: python
-
-    import discord
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(channel="The channel you want to mention")
-        async def mentionchannel(self, interaction: discord.Interaction, channel: discord.VoiceChannel):
-            await interaction.response.send_message(f"That channel is {channel.mention}", ephemeral=True)
-
-With integer and float arguments, we can also specify a minimum and maximum value.
-This can also be done to strings to set a minimum and maximum length.
-These limits will be reflected within Discord when the user is filling out the command.
-
-.. code-block:: python
-
-    import discord
-
-    from redbot.core import commands, app_commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @app_commands.command()
-        @app_commands.describe(number="The number you want to say, max 10")
-        async def saynumber(self, interaction: discord.Interaction, number: app_commands.Range[int, None, 10]):
-            await interaction.response.send_message(f"Your number is {number}", ephemeral=True)
-
-See the `Discord.py documentation <https://discordpy.readthedocs.io/en/stable/interactions/api.html#range>`__ for more information on this.
-
-
----------------
-Hybrid Commands
----------------
-Hybrid commands are a way to bridge the gap between text commands and slash commands.
-These types of commands allow you to write a text and slash command simultaneously using the same function.
-This is useful for commands that you want to be able to use in both text and slash commands.
-
-.. note::
-    As with slash command groups, top level hybrid command groups **cannot** be invoked as a slash command. They can however be invoked as a text command.
-
-.. code-block:: python
-
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        def __init__(self, bot):
-            self.bot = bot
-
-        @commands.hybrid_command(name="cat")
-        async def cat(self, ctx: commands.Context):
-            await ctx.send("Meow")
-
-        @commands.hybrid_group(name="dog")
-        async def dog(self, ctx: commands.Context):
-            await ctx.send("Woof")
-            # As discussed above, top level hybrid command groups cannot be invoked as a slash command.
-            # Thus, this will not work as a slash command.
-
-        @dog.command(name="bark")
-        async def bark(self, ctx: commands.Context):
-            await ctx.send("Bark", ephemeral=True)
-
-After syncing your cog via the :ref:`[p]slash<core-command-slash>` command, you'll be able to use the commands as both a slash and text command.
-
----------------------
-Context Menu Commands
----------------------
-Context menu commands are a way to provide a interaction via the context menu.
-These are seen under ``Apps`` in the Discord client when you right click on a message or user.
-Context menu commands are a great way to provide a quick way to interact with your bot.
-These commands accept one arguement, the contextual ``user`` or ``message`` that was right clicked.
-
-Setting up context commands is a bit more involved then setting up slash commands.
-First lets setup our context commands in our cog.
-
-.. code-block:: python
-    
-    import discord
-
-    from redbot.core import commands, app_commands
-
-
-    # Important: we're building the commands outside of our cog class.
-    @app_commands.context_menu(name="Get message ID")
-    async def get_message_id(interaction: discord.Interaction, message: discord.Message):
-        await interaction.response.send_message(f"Message ID: {message.id}", ephemeral=True)
-
-    @app_commands.context_menu(name="Get user ID")
-    async def get_user_id(interaction: discord.Interaction, user: discord.User):
-        await interaction.response.send_message(f"User ID: {user.id}", ephemeral=True)
-
-Once we've prepared our main cog file, we have to add a small bit of code to our ``__init__.py`` file.
-
-.. code-block:: python
-
-    from .my_cog import get_message_id, get_user_id
-
-    async def setup(bot):
-        bot.tree.add_command(get_message_id)
-        bot.tree.add_command(get_user_id)
-
-    async def teardown(bot):
-        # We're removing the commands here to ensure they get unloaded properly when the cog is unloaded.
-        bot.tree.remove_command("Get message ID", type=discord.AppCommandType.message)
-        bot.tree.remove_command("Get user ID", type=discord.AppCommandType.user)
-
-Now we're ready to sync our commands to Discord.
-We can do this by using the :ref:`[p]slash<core-command-slash>` command.
-Take note of the specific arguments you have to use to sync a context command.
-
----------------------------------
-Closing Words and Further Reading
----------------------------------
-If you're reading this, it means that you've made it to the end of this guide.
-Congratulations! You are now prepared with the basics of slash commands for Red.
-However there is a lot we didn't touch on in this guide.
-Below this paragraph you'll find a list of resources that you can use to learn more about slash commands.
-As always, if you have any questions, feel free to ask in the `Red support server <https://discord.gg/red>`__.
-
-For more information on `Application Commands <https://discord.com/developers/docs/interactions/application-commands>`__ as a whole, please refer to the official Discord documentation.
-Discord.py also offers documentation regarding everything discussed on this page.
-You can find the documentation `here <https://discordpy.readthedocs.io/en/stable/interactions/api.html>`__.
-And lastly, AbstractUmbra has a great write up of `examples <https://gist.github.com/AbstractUmbra/a9c188797ae194e592efe05fa129c57f>`__.
-

docs/incompatible_changes/3.5.rst

@@ -1,810 +0,0 @@
-.. _incompatible-changes-3.5:
-
-========================================
-Backward incompatible changes in Red 3.5
-========================================
-
-.. include:: _includes/preamble.rst
-
-.. contents::
-    :depth: 4
-    :local:
-
-For Users
-*********
-
-Removals
-~~~~~~~~
-
-redbot-launcher
-^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.2.0
-
-The vast majority of functionality provided by ``redbot-launcher`` can already be
-achieved through other means.
-
-In Red 3.2.0, ``redbot-launcher`` has been stripped most of its functionality
-as it can already be done through other (better supported) means:
-
-- Updating Red (a proper way to update Red is now documented in `../update_red`)
-- Creating instances (as documented in install guides, it should be done through ``redbot-setup``)
-- Removing instances (available under ``redbot-setup delete``)
-- Removing all instances (no direct alternative, can be done through ``redbot-setup delete``)
-- Debug information (available under ``redbot --debuginfo`` and ``[p]debuginfo`` bot command)
-
-Currently, ``redbot-launcher`` only provides auto-restart functionality
-which we now document how to do properly on each of the supported systems.
-
-If you wish to continue using auto-restart functionality, we recommend following the instructions for setting up a service dedicated to your operating system:
-
-- `../autostart_windows`
-- `../autostart_mac`
-- `../autostart_systemd`
-
-Behavior changes
-~~~~~~~~~~~~~~~~
-
-x86-64 CPUs are now only supported if they support x86-64-v2 instruction set
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-On x86-64 systems, we now require that your CPU supports x86-64-v2 instruction set.
-This roughly translates to us dropping support for Intel CPUs that have been released before 2009
-and AMD CPUs that have been releasesd before 2012.
-
-This has been mostly dictated by one of our dependencies but some Linux distributions
-are already dropping support for it in their latest versions as well.
-
-Thread-related changes
-^^^^^^^^^^^^^^^^^^^^^^
-
-While many of these aren't breaking, we thought it is important to make it clear
-how Red approaches its features in regard to threads:
-
-- Red's command permission system doesn't have dedicated rules for threads and instead uses
-  that thread's parent channel rules
-- Channel embed settings (``[p]embedset``) cannot be set for threads and usage of embeds is based
-  on that thread's parent channel embed settings
-
-    - This also means that a forum channel can have its own embed settings
-- Using channel mute/unmute commands (e.g. ``[p]mutechannel`` from Mutes cog) in a thread
-  will mute that user in the thread's parent channel
-- Filter cog doesn't have a dedicated word list for threads and uses server's and parent channel's word lists
-
-    - This also means that a word list can now also be added for a forum channel
-- CustomCom's ``{channel}`` substitution parameter will now be a thread when the command is used in a thread
-- CustomCom's channel cooldowns are applied per thread
-- When used in a thread, ``[p]slowmode`` command from Mod cog will apply the slowmode to that thread
-- The logic for the ``[p]ignore``-related checks has changed for threads:
-
-    - ``[p]ignore channel`` accepts ignoring command in a specific thread
-    - When the command is sent in a thread, it first checks server-wide ignore settings and then runs if:
-
-        - the user has Manage Channel permission in the parent channel, or
-        - the parent channel is not ignored *and* the user has Manage Threads permission in the parent channel, or
-        - the thread channel and its parent aren't ignored
-    - This also means that a forum channel can now also be ignored
-- The Mutes cog now denies Send Messages in Threads, Create Public Threads,
-  and Create Private Threads permissions
-
-Commands for changing Bank and Modlog settings are now core commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-These commands allow users to change settings of core APIs that are always available
-(similarly to ``[p]autoimmune``, ``[p]allowlist``, or ``[p]blocklist``)
-so it makes sense to allow using them without having to load anything.
-
-The following commands have been moved to Core:
-
-- ``[p]modlogset``
-- ``[p]bankset``
-- ``[p]economyset registeramount`` (now named ``[p]bankset registeramount``)
-- ``[p]bank reset`` (now named ``[p]bankset reset``)
-- ``[p]bank prune`` (now named ``[p]bankset prune``)
-
-This has also resulted in the removal of the ``bank`` cog
-as it no longer contained any commands.
-
-If you have any custom settings for this cog or these commands,
-you may need to readd them with the new command names.
-
-Commands in the ``[p]set`` group have been reorganized
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The list of commands in the ``[p]set`` group has gotten quite long over the years
-so we decided to reorganize it.
-
-The following changes have been made:
-
-- Commands related to metadata about the bot have been moved to the ``[p]set bot`` subgroup:
-
-    - ``[p]set avatar`` is now ``[p]set bot avatar``
-    - ``[p]set custominfo`` is now ``[p]set bot custominfo``
-    - ``[p]set description`` is now ``[p]set bot description``
-    - ``[p]set nickname`` is now ``[p]set bot nickname``
-    - ``[p]set username`` is now ``[p]set bot username``
-- Commands related to server's admin and mod roles have been moved to the ``[p]set roles`` subgroup:
-
-    - ``[p]set addadminrole`` is now ``[p]set roles addadminrole``
-    - ``[p]set removeadminrole`` is now ``[p]set roles removeadminrole``
-    - ``[p]set addmodrole`` is now ``[p]set roles addmodrole``
-    - ``[p]set removemodrole`` is now ``[p]set roles removemodrole``
-- Commands related to bot user's activity and status have been moved to the ``[p]set status`` subgroup:
-
-    - ``[p]set status`` has been split into ``[p]set status online/idle/dnd/invisible`` subcommands
-    - ``[p]set competing`` is now ``[p]set status competing``
-    - ``[p]set listening`` is now ``[p]set status listening``
-    - ``[p]set playing`` is now ``[p]set status playing``
-    - ``[p]set streaming`` is now ``[p]set status streaming``
-    - ``[p]set watching`` is now ``[p]set status watching``
-- ``[p]set globallocale`` has been renamed to ``[p]set locale global``
-- ``[p]set locale`` is now also available under ``[p]set locale server``
-- ``[p]set globalregionalformat`` has been renamed to ``[p]set regionalformat global``
-- ``[p]set regionalformat`` is now also available under ``[p]set regionalformat server``
-
-If you have any custom settings for these commands,
-you may need to readd them with the new command names.
-
-Red requires to have at least one owner
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-There was never a reason to allow users to run the bot without having an owner set
-and it had been a point of confusion for new users that are trying to set up Red
-using a team application which, by default, doesn't have any owners set.
-
-If your instance does not have any owner set, Red will print an error message on startup
-and exit before connecting to Discord. This error message contains all
-the needed information on how to set a bot owner and the security implications of it.
-
-If, for some reason, you intentionally are running Red without any owner set,
-please make a feature request with your use case on
-`our issue tracker <https://github.com/Cog-Creators/Red-DiscordBot/issues/new/choose>`__.
-
-
-For Developers
-**************
-
-Removals
-~~~~~~~~
-
-``Config.driver`` and ``redbot.core.drivers`` package
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-These are Red's internal implementation details and as such they have been privatized.
-
-``redbot.core.data_manager.load_bundled_data()`` function
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.0.0rc3
-
-This function has been deprecated basically forever and we have somehow never removed it.
-
-Use the `redbot.core.data_manager.bundled_data_path()` function directly instead.
-
-``is_mod_or_superior()``, ``is_admin_or_superior()``, and ``check_permissions()`` functions in ``redbot.core.checks``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.0.0rc1
-
-These functions have been deprecated basically forever and we have somehow never removed them.
-
-Use the `redbot.core.utils.mod.is_mod_or_superior()`, `redbot.core.utils.mod.is_admin_or_superior()`,
-and `redbot.core.utils.mod.check_permissions()` functions instead.
-
-``bordered()`` function
-^^^^^^^^^^^^^^^^^^^^^^^
-
-This function was primarily used in Red's command-line code and had very limited use
-for 3rd-party cogs. Since we no longer use this function, it has been removed.
-
-``commands.DM_PERMS`` constant
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This was mostly used by the internal implementation and it isn't anymore now. Since this constant
-was a maintenance burden and hasn't really seen any usage in 3rd-party code, we decided to just
-remove it.
-
-``redbot.core.utils.caching`` and ``redbot.core.utils.safety`` modules
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-These modules contain utilities that were only really useful in Red's own code.
-We no longer use them for anything and have not seen any 3rd-party usage
-and as such we have removed these modules.
-
-``guild_id`` parameter to ``Red.allowed_by_whitelist_blacklist()``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.4.8
-
-``guild_id`` parameter to `Red.allowed_by_whitelist_blacklist()` has been removed as
-it is not possible to properly handle the local allowlist/blocklist logic with just
-the guild ID. Part of the local allowlist/blocklist handling is to check
-whether the provided user is a guild owner.
-
-Use the ``guild`` parameter instead.
-
-Example:
-
-.. code:: python
-
-    if await bot.allowed_by_whitelist(who_id=user_id, guild_id=guild.id, role_ids=role_ids):
-        ...
-
-Becomes:
-
-.. code:: python
-
-    if await bot.allowed_by_whitelist(who_id=user_id, guild=guild, role_ids=role_ids):
-        ...
-
-``redbot.core.commands.converter.GuildConverter``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.4.8
-
-This is now included in the upstream discord.py library.
-
-Use `discord.Guild`/``redbot.core.commands.GuildConverter`` instead.
-
-Example:
-
-.. code:: python
-
-    from redbot.core import commands
-    from redbot.core.commands.converter import GuildConverter
-
-    class MyCog(commands.Cog):
-        @commands.command()
-        async def command(self, ctx, server: GuildConverter):
-            await ctx.send(f"You chose {server.name}!")
-
-Becomes:
-
-.. code:: python
-
-    import discord
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.command()
-        async def command(self, ctx, server: discord.Guild):
-            await ctx.send(f"You chose {server.name}!")
-
-``redbot.core.utils.mod.is_allowed_by_hierarchy()``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.4.1
-
-This was an internal function that was never meant to be part of the public API.
-It was also not really possible to use it in a supported way as it required
-internal objects to be passed as parameters.
-
-If you have a use case for this function, you should be able to achieve the same result
-with this code:
-
-.. code:: python
-
-    async def is_allowed_by_hierarchy(guild, moderator, member):
-        is_special = moderator == guild.owner or await self.bot.is_owner(moderator)
-        return moderator.top_role > member.top_role or is_special
-
-
-Behavior changes
-~~~~~~~~~~~~~~~~
-
-Update to version guarantees and privatization of many APIs
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-With this release, we're limiting what changes we will consider breaking.
-`The new Developer Guarantees <developer-guarantees>` describe this in detail
-but the gist of it is that we will now only consider names included in ``__all__``
-of ``redbot`` and ``redbot.core`` modules and ``__all__`` of public submodules
-of ``redbot.core`` to be part of the public API that shouldn't be broken without notice.
-
-With this change, we introduced or updated ``__all__`` in all of those modules
-and added ``_`` prefix to private modules to specify what is actually part of the public API.
-This has resulted in the following being removed/privatized:
-
-- ``create_temp_config()``, ``load_basic_configuration()``, and ``core_data_path()`` in the ``redbot.core.data_manager`` module
-- ``set_locale()`` and ``reload_locales()`` in the ``redbot.core.i18n`` module
-- ``MIN_PYTHON_VERSION`` in the ``redbot`` module
-- ``redbot.core.cog_manager``, ``redbot.core.settings_caches``, ``redbot.core.global_checks``, ``redbot.core.events``, ``redbot.core.cli``, and ``redbot.core.rpc`` modules
-
-``redbot.core.data_manager.storage_details()`` returns a deep copy of underlying dict now
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Changing storage details during Red's runtime is not supported and as such,
-this function now returns a deep copy of the underlying dictionary to prevent changes.
-
-Changed the version order of final dev releases and dev pre-releases
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To be consistent with :pep:`440`, we've changed the order between final dev releases (e.g.
-``3.5.0.dev1``) and dev pre-releases (e.g. ``3.5.0a1.dev1``, ``3.5.0b1.dev1``, ``3.5.0rc1.dev1``).
-
-Here's an example of a list of versions sorted using the new order (oldest version first):
-
-- 3.5.0.dev1
-- 3.5.0.dev2
-- 3.5.0a1.dev1
-- 3.5.0a1
-- 3.5.0a2.dev1
-- 3.5.0b1.dev1
-- 3.5.0
-- 3.5.0.post1.dev1
-- 3.5.0.post1
-- 3.5.1
-
-``Red.get_owner_notification_destinations()`` may now return instances of ``discord.Voice/StageChannel``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-With the introduction of Text in Voice feature, we added the ability to add a voice/stage channel
-as an owner notifications destination. This means that `redbot.core.modlog.get_modlog_channel()`
-may now return instances of `discord.VoiceChannel` and `discord.StageChannel`.
-
-``modlog.get_modlog_channel()`` may now return instances of ``discord.Voice/StageChannel``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-With the introduction of Text in Voice feature, we added the ability to set a modlog
-channel to a voice/stage channel. This means that `redbot.core.modlog.get_modlog_channel()`
-may now return instances of `discord.VoiceChannel` and `discord.StageChannel`.
-
-``menus.DEFAULT_CONTROLS`` and ``ReactionPredicate.*_EMOJIS`` use immutable types now
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The type of `redbot.core.utils.menus.DEFAULT_CONTROLS` has been changed from `dict`
-to a `collections.abc.Mapping` while the type of `ReactionPredicate.ALPHABET_EMOJIS`
-and `ReactionPredicate.NUMBER_EMOJIS` has been changed from `list` to a `tuple`.
-
-This should prevent the developers from accidentally changing the provided constants
-instead of making a copy and changing that copy.
-
-This should be a transparent change in most cases but here is an example usage that is affected:
-
-.. code:: python
-
-    import copy
-    from redbot.core.utils import menus
-
-    # somewhere in your code...
-
-    controls = copy.copy(menus.DEFAULT_CONTROLS)
-    controls["\N{SMILING FACE WITH OPEN MOUTH}"] = custom_function
-    await menu(ctx, ["page 1", "page 2"], controls)
-
-To make this code work on Red 3.5 and higher, you can replace it with any of the following:
-
-.. code:: python
-
-    from redbot.core.utils import menus
-
-    # example 1
-
-    controls = {
-        **menus.DEFAULT_CONTROLS,
-        "\N{SMILING FACE WITH OPEN MOUTH}": custom_function,
-    }
-    await menu(ctx, ["page 1", "page 2"], controls)
-
-    # example 2
-
-    controls = menus.DEFAULT_CONTROLS.copy()
-    controls["\N{SMILING FACE WITH OPEN MOUTH}"] = custom_function
-    await menu(ctx, ["page 1", "page 2"], controls)
-
-    # example 3
-
-    controls = dict(menus.DEFAULT_CONTROLS)
-    controls["\N{SMILING FACE WITH OPEN MOUTH}"] = custom_function
-    await menu(ctx, ["page 1", "page 2"], controls)
-
-Similarly, if you copied lists before:
-
-.. code:: python
-
-    emojis = ReactionPredicate.NUMBER_EMOJIS.copy()
-    emojis.insert(0, "\N{DOG}")
-    emojis.append("\N{CAT}")
-
-You could use sequence unpacking instead:
-
-.. code:: python
-
-    emojis = ["\N{DOG}", *ReactionPredicate.NUMBER_EMOJIS, "\N{CAT}"]
-
-Permissions defined in ``@commands.*_permissions()`` decorators are always merged now
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This is mostly a bugfix but it means that the permissions in stacked decorators are now
-always merged instead of being *sometimes* overridden and *sometimes* merged.
-
-For example, this code has only checked for ``embed_links`` permission on 3.4
-but now checks for both ``add_reactions`` and ``embed_links`` permissions:
-
-.. code:: python
-
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.command()
-        @commands.bot_has_permissions(embed_links=True)
-        @commands.bot_has_permissions(add_reactions=True)
-        async def example(self, ctx):
-            msg = await ctx.send(embed=discord.Embed(description="Hello!"))
-            await msg.add_reaction("\N{SMILING FACE WITH OPEN MOUTH}")
-
-Note that stacking `@commands.has_permissions() <redbot.core.commands.has_permissions()>`
-with ``@commands.*_or_permissions()`` decorators still behaves differently depending on
-the decorator order.
-
-Some of the primary dependencies have been removed or replaced
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-While this may not technically fall under `our version guarantees <../version_guarantees>`,
-we recognize that this may affect some people.
-As such, below we list the noteworthy dependency replacements and removals (package names
-are PyPI distribution names):
-
-- ``appdirs`` package has been replaced with ``platformdirs``
-- ``chardet`` package has been replaced with ``charset-normalizer``
-- ``fuzzywuzzy`` package has been replaced with ``rapidfuzz``
-- Red no longers depends on ``aiosqlite``, ``PyNaCl``, and ``python-Levenshtein-wheels``
-
-discord.py version has been updated to 2.2.3
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To allow Red to continue operating *and* use the newer features (threads, text in voice/stage channels,
-buttons, application commands, and AutoMod, to name a few), we've updated discord.py from version
-1.7.3 to 2.2.3. Since this is a major upgrade, it will require you to update your code accordingly.
-discord.py's documentation has :dpy_docs:`a migration guide <migrating.html>` that you can follow in order to
-update your cogs.
-
-Red itself has already been updated to support all of these changes that happened over the years.
-In order to do so, we've also had to make a few breaking changes of our own. Those changes are
-normal sections in the current document so be sure to follow it in full and you should be able to
-perform all the necessary changes.
-
-To help support some of the newer features, we've also added a few things:
-
-- Utilities that allow to **properly** check whether a member can do something in threads (or channels)
-  for cases where it isn't as simple as checking permissions:
-
-    - Command check decorators: `bot_can_manage_channel()`, `bot_can_react()`
-    - Permission check decorators: `can_manage_channel()`, `guildowner_or_can_manage_channel()`,
-      `admin_or_can_manage_channel()`, `mod_or_can_manage_channel()`
-    - Functions: `can_user_send_messages_in()`, `can_user_manage_channel()`, `can_user_react_in()`
-
-- New module (`redbot.core.utils.views`) with useful `discord.ui.View` subclasses
-
-    - `SetApiModal`, `SetApiView`, `SimpleMenu`
-
-``Case.channel`` can now be a ``discord.Thread``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In order to properly support threads, `Case.channel` can now also be an instance of `discord.Thread`.
-New `Case.parent_channel` attribute will be set to the thread's parent text or forum channel,
-if the case's channel is a thread.
-
-``commands.BadArgument`` is no longer wrapped in ``commands.ConversionFailure`` containing parameter and its value
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-We used to wrap `commands.BadArgument <discord.ext.commands.BadArgument>` exceptions
-in a ``commands.ConversionFailure`` containing, in addition to the actual exception,
-the `inspect.Parameter` instance and the passed value for the argument
-that failed the conversion.
-
-With discord.py 2.x, these are now exposed through the
-`commands.Context.current_parameter <discord.ext.commands.Context.current_parameter>`
-and `commands.Context.current_argument <discord.ext.commands.Context.current_argument>`
-making this wrapping no longer necessary.
-
-Some of the method arguments in the bot class and ``commands`` package have been made positional-only
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The following arguments have been positional-only to be consistent with the upstream discord.py package:
-
-- ``name`` in `Red.get_command()`
-- ``name`` in `Red.get_cog()`
-- ``coro`` in `Red.before_invoke()`
-- ``user`` in `Red.is_owner()`
-- ``message`` in ``Red.get_context()``
-- ``message`` in `Red.process_commands()`
-- ``cogname`` in `Red.remove_cog()`
-- ``cog`` in `Red.add_cog()`
-- ``command`` in `Red.add_command()`
-- ``command`` in `Red.remove_command()`
-- ``ctx`` in `redbot.core.commands.Command.can_run()`
-- ``ctx`` in ``redbot.core.commands.CogMixin.can_run()``
-- ``ctx`` in ``redbot.core.commands.CogMixin.can_see()``
-- ``error`` in `redbot.core.commands.Command.error()`
-
-``bot.add_cog()`` will now raise ``discord.ClientException`` instead of ``RuntimeError`` when cog is already loaded
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To make Red's bot class more consistent with the discord.py implementation that it overrides,
-the `discord.ClientException` is now being raised instead of `RuntimeError` when a cog
-with the same name is already loaded.
-
-Many functions and methods do not support ``discord.PartialMessageable`` objects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This isn't technically breaking since they never did *but* since those objects may appear now,
-we think it is important to mention that due to the limited information that `discord.PartialMessageable`
-objects provide, they cannot be passed to the following methods directly:
-
-- `Red.ignored_channel_or_guild()`
-- `Red.embed_requested()`
-- `redbot.core.modlog.create_case()`
-- `redbot.core.modlog.Case.edit()`
-
-Additionally, the `Red.message_eligible_as_command()` will return ``False``
-if a `discord.PartialMessageable` object for a channel that isn't a DM is passed.
-
-If you *have to* use these, you should try fetching the full messageable object first
-or looking at the documentation to see whether there are any alternative solutions.
-
-Cog package (extension) and cog loading / unloading is now asynchronous
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This follows the changes that discord.py 2.x has introduced - we now **require** for
-the ``setup()`` and ``teardown()`` functions to be asynchronous and have made
-the `Red.add_cog()` and `Red.remove_cog()` methods asynchronous as well.
-
-``Red.embed_requested()``'s parameters and their default values have changed
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-We have made a bunch of changes to the signature of `Red.embed_requested()`. This method now
-accepts only a single **positional** argument called ``channel``, making the ``command``
-keyword-only. The ``user`` argument has been removed as the ``channel`` argument now supports
-the `discord.abc.User` objects directly, dropping the support for `discord.DMChannel`
-in the process.
-
-These changes together allowed us to support checking whether an embed should be sent in a DM
-using only the `discord.abc.User` object - without the `discord.DMChannel` which is often
-not present in the cache. Furthermore, it means that a `discord.abc.User` object no longer needs
-to be passed unnecessarily when the method is used with a guild channel.
-
-We've also changed the default value of ``check_permissions`` to ``True``
-as it makes the typical usage of this method more ergonomic.
-
-Example:
-
-.. code:: python
-
-    import discord
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.guild_only()
-        @commands.command()
-        async def sayhello(self, ctx, recipient: discord.Member):
-            content = "Hello world!"
-            embed = discord.Embed(title="Message for you!", description=content)
-            try:
-                # try sending the message in DMs
-                if await ctx.bot.embed_requested(
-                    await recipient.create_dm(), recipient, ctx.command, check_permissions=True
-                ):
-                    await recipient.send(embed=embed)
-                else:
-                    await recipient.send(content)
-            except discord.Forbidden:
-                # DMs are closed, send a message in a moderator or current channel
-                channel = ctx.guild.public_updates_channel or ctx
-                if await ctx.bot.embed_requested(
-                    channel, ctx.author, ctx.command, check_permissions=True
-                ):
-                    await channel.send(embed=embed)
-                else:
-                    await channel.send(content)
-
-After:
-
-.. code:: python
-
-    import discord
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.guild_only()
-        @commands.command()
-        async def sayhello(self, ctx, recipient: discord.Member):
-            content = "Hello world!"
-            embed = discord.Embed(title="Message for you!", description=content)
-            try:
-                # try sending the message in DMs
-                if await ctx.bot.embed_requested(recipient, command=ctx.command):
-                    await recipient.send(embed=embed)
-                else:
-                    await recipient.send(content)
-            except discord.Forbidden:
-                # DMs are closed, send a message in a moderator or current channel
-                channel = ctx.guild.public_updates_channel or ctx
-                if await ctx.bot.embed_requested(channel, command=ctx.command):
-                    await channel.send(embed=embed)
-                else:
-                    await channel.send(content)
-
-``modlog.create_case()`` now raises instead of silently returning on error
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To help avoid passing invalid arguments, `modlog.create_case()` now raises:
-
-- `ValueError` when the ``action_type`` argument is not a valid action type
-- `RuntimeError` when the ``user`` argument is passed with the bot's user object/ID
-
-Proper usage of these methods is unlikely to be affected
-and this should mostly just help detect bugs earlier.
-
-.. _config-register-1:
-
-``Config``'s register methods now only accept JSON-castable types
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. seealso:: `config-register-2`
-
-This change has fixed the inconsistencies between what can be registered as a default value
-and what can be set through `Value.set()`. It mostly resulted in confusion when it was not
-possible to use the registered type in `Value.set()`.
-
-If you need to use custom types, you'll have to manually construct them *after* getting the
-"raw" value from `Config`.
-
-.. _config-register-2:
-
-``Config`` now always returns base JSON types, never subclasses
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. seealso:: `config-register-1`
-
-It used to be possible to register an instance of a subclass of `dict` such as
-`collections.Counter` and have the `redbot.core.config.Group` cast the returned value to that type
-before returning it. With this change, `redbot.core.config.Group` will now always return an instance of
-`dict` containing only base JSON types, without subclasses.
-
-``Config.*_from_id/*_from_ids()`` methods now raise when ``int`` is not passed
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To help avoid setting values under non-integer keys, we now raise an error
-when the passed argument is not an ``int``.
-
-We're not expecting any **proper** usage of these methods to be affected
-and this should only help detect bugs earlier.
-
-``Case.message`` can now be ``discord.PartialMessage``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This change allowed to us to make enormous performance improvements (subsecond durations
-compared to many minutes) to `modlog.get_all_cases()` and commands that use it
-such as the commonly used ``[p]casesfor`` command.
-
-With this change, we no longer fetch the whole `discord.Message` object for case's message
-and instead only construct a `discord.PartialMessage` object for it. This object is rarely if ever needed so it is unlikely to affect a lot of code. Additionally, this change doesn't apply to `modlog.create_case()` which will still return a `Case` object with `message <Case.message>` attribute set to an instance of `discord.Message` or ``None``.
-
-If you have a reason to use a full message object, you can use :meth:`discord.PartialMessage.fetch()`
-to fetch it.
-
-Example:
-
-.. code:: python
-
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.guild_only()
-        @commands.command()
-        async def command(self, ctx, case_number: int):
-            case = await modlog.get_case(case_number, ctx.guild, ctx.bot)
-            if case.message is None:
-                await ctx.send("No message is available for this case.")
-                return
-
-            await ctx.send(
-                "People reacted to this modlog case with: "
-                + ", ".join(case.message.reactions)
-            )
-
-After:
-
-.. code:: python
-
-    import discord
-    from redbot.core import commands
-
-    class MyCog(commands.Cog):
-        @commands.guild_only()
-        @commands.command()
-        async def command(self, ctx, case_number: int):
-            case = await modlog.get_case(case_number, ctx.guild, ctx.bot)
-            if case.message is None:
-                await ctx.send("No message is available for this case.")
-                return
-
-            try:
-                msg = await case.message.fetch()
-            except discord.NotFound:
-                await ctx.send("No message is available for this case.")
-            else:
-                await ctx.send(
-                    "People reacted to this modlog case with: "
-                    + ", ".join(msg.reactions)
-                )
-
-``redbot.core.bot.RedBase`` has been merged into ``redbot.core.bot.Red``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Historically, ``RedBase`` existed to allow using Red for self/user bots back when
-it was not against Discord's Terms of Service. Since this is no longer a concern,
-everything from ``RedBase`` have been moved directly to `Red` and ``RedBase`` class
-has been removed.
-
-If you were using ``RedBase`` for runtime type checking or type annotations,
-you should now use `Red` instead. Since both of these classes resided in the same
-module, it should be a matter of simple find&replace.
-
-``Context.maybe_send_embed()`` requires content with length of 1-2000 characters
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`Context.maybe_send_embed()` now requires the message's length to be
-between 1 and 2000 characters.
-
-Since the length limits for regular message content and embed's description are
-different, it is easy to miss an issue with inappropriate handling of length limits
-during development. This change should aid with early detection of such issue by
-consistently rejecting messages with length that can't be used with
-both embed and non-embed messages.
-
-This change only affects code that is already not guaranteed to work.
-You should make sure that your code properly handles message length limits.
-
-``menu()`` listens to both reaction add and remove
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Listening only to reaction add results in bad user experience.
-If the bot had Manage Messages permission, it removed the user's reaction
-so that they don't have to click twice but this comes with a noticeable delay.
-This issue is even more noticeable under load, when the bot ended up hitting
-Discord-imposed rate limits.
-
-If your calls to `menu()` are using the default controls (``redbot.core.utils.menus.DEFAULT_CONTROLS``),
-you don't have to do anything.
-
-Otherwise, you should ensure that your custom functions used for the menu controls
-do not depend on this behavior in some way. In particular, you should make sure that
-your functions do not automatically remove the author's reaction.
-
-Here's an example code that needs to be updated:
-
-.. code:: python
-
-    import contextlib
-
-    import discord
-    from redbot.core.utils.menus import close_menu, menu
-
-    CUSTOM_CONTROLS = {
-        "\N{CROSS MARK}": close_menu,
-        "\N{WAVING HAND SIGN}": custom_control,
-    }
-
-
-    async def custom_control(ctx, pages, controls, message, page, timeout, emoji):
-        perms = message.channel.permissions_for(ctx.me)
-        if perms.manage_messages:  # Can manage messages, so remove react
-            with contextlib.suppress(discord.NotFound):
-                await message.remove_reaction(emoji, ctx.author)
-
-        await ctx.send("Hello world!")
-        return await menu(ctx, pages, controls, message=message, page=page, timeout=timeout)
-
-
-    async def show_menu(ctx):
-        await menu(ctx, ["Click :wave: to say hi!"], CUSTOM_CONTROLS)
-
-To make this code work on Red 3.5 and higher, you need to update ``custom_control()`` function:
-
-.. code:: python
-
-    async def custom_control(ctx, pages, controls, message, page, timeout, emoji):
-        await ctx.send("Hello world!")
-        return await menu(ctx, pages, controls, message=message, page=page, timeout=timeout)

docs/incompatible_changes/_includes/preamble.rst

@@ -1,3 +0,0 @@
-This page lists all functionalities that are currently deprecated, features that have been removed in past minor releases, and any other backward incompatible changes that are planned or have been removed in past minor releases. The objective is to give users a clear rationale why a certain change has been made, and what alternatives (if any) should be used instead.
-
-These changes are sorted (in their respective sections) in a reverse chronological order.

docs/incompatible_changes/future.rst

@@ -1,31 +0,0 @@
-.. _deprecated-functionality:
-
-===================================================
-Future changes (currently deprecated functionality)
-===================================================
-
-.. include:: _includes/preamble.rst
-
-.. contents::
-    :depth: 4
-    :local:
-
-For Developers
-**************
-
-Removals
-~~~~~~~~
-
-Downloader's shared libraries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. deprecated:: 3.2.0
-
-Shared libraries have been deprecated in favor of pip-installable libraries.
-Shared libraries do not provide any functionality that can't already be achieved
-with pip requirements *and* as such don't provide much value in return for
-the added complexity.
-
-Known issues, especially those related to hot-reload, were not handled automatically
-for shared libraries, same as they are not handled for the libraries installed
-through pip.

docs/incompatible_changes/index.rst

@@ -1,12 +0,0 @@
-.. Backward incompatible changes list
-
-Backward incompatible changes
-=============================
-
-.. include:: _includes/preamble.rst
-
-.. toctree::
-   :maxdepth: 4
-
-   future
-   3.5

docs/index.rst

@@ -36,7 +36,7 @@ Welcome to Red - Discord Bot's documentation!
     intents
     cog_guides/admin
     cog_guides/alias
-    cog_guides/audio
+    cog_guides/bank
     cog_guides/cleanup
     cog_guides/cog_manager_ui
     cog_guides/core
@@ -63,13 +63,13 @@ Welcome to Red - Discord Bot's documentation!
 
     guide_migration
     guide_cog_creation
-    guide_slash_and_interactions
     guide_publish_cogs
     guide_cog_creators
     framework_apikeys
     framework_bank
     framework_bot
     framework_checks
+    framework_cogmanager
     framework_commands
     framework_config
     framework_datamanager
@@ -77,7 +77,6 @@ Welcome to Red - Discord Bot's documentation!
     framework_i18n
     framework_modlog
     framework_rpc
-    framework_tree
     framework_utils
     version_guarantees
 
@@ -86,7 +85,6 @@ Welcome to Red - Discord Bot's documentation!
     :caption: Others
 
     changelog
-    incompatible_changes/index
     host-list
 
 

docs/install_guides/_includes/_create-env-with-venv-outro.rst

@@ -1,10 +0,0 @@
-And activate it with the following command:
-
-.. prompt:: bash
-
-    source ~/redenv/bin/activate
-
-.. important::
-
-    You must activate the virtual environment with the above command every time you open a new
-    shell to run, install or update Red.

docs/install_guides/_includes/create-env-with-venv.rst

@@ -21,3 +21,18 @@ to keep it in a location which is easy to type out the path to. From now, we'll
 ``redenv`` and it will be located in your home directory.
 
 Create your virtual environment with the following command:
+
+.. prompt:: bash
+
+    python3.9 -m venv ~/redenv
+
+And activate it with the following command:
+
+.. prompt:: bash
+
+    source ~/redenv/bin/activate
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red.

docs/install_guides/_includes/create-env-with-venv3.10.rst

@@ -1,7 +0,0 @@
-.. include:: _includes/_create-env-with-venv-intro.rst
-
-.. prompt:: bash
-
-    python3.10 -m venv ~/redenv
-
-.. include:: _includes/_create-env-with-venv-outro.rst

docs/install_guides/_includes/create-env-with-venv3.11.rst

@@ -1,7 +0,0 @@
-.. include:: _includes/_create-env-with-venv-intro.rst
-
-.. prompt:: bash
-
-    python3.11 -m venv ~/redenv
-
-.. include:: _includes/_create-env-with-venv-outro.rst

docs/install_guides/_includes/create-env-with-venv3.9.rst

@@ -1,7 +0,0 @@
-.. include:: _includes/_create-env-with-venv-intro.rst
-
-.. prompt:: bash
-
-    python3.9 -m venv ~/redenv
-
-.. include:: _includes/_create-env-with-venv-outro.rst

docs/install_guides/_includes/install-and-setup-red-unix.rst

@@ -9,7 +9,7 @@ To install without additional config backend support:
 .. prompt:: bash
     :prompts: (redenv) $
 
-    python -m pip install -U pip wheel
+    python -m pip install -U pip setuptools wheel
     python -m pip install -U Red-DiscordBot
 
 Or, to install with PostgreSQL support:
@@ -17,7 +17,7 @@ Or, to install with PostgreSQL support:
 .. prompt:: bash
     :prompts: (redenv) $
 
-    python -m pip install -U pip wheel
+    python -m pip install -U pip setuptools wheel
     python -m pip install -U "Red-DiscordBot[postgres]"
 
 

docs/install_guides/_includes/install-guide-rhel8-derivatives.rst

@@ -1,30 +1,26 @@
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
 Installing the pre-requirements
 -------------------------------
 
-Red Hat Enterprise Linux (RHEL) 8.6-8.x and its derivatives have all required packages available in official repositories.
+Red Hat Enterprise Linux (RHEL) 8.4-8.x and its derivatives have all required packages available in official repositories.
 Install them with dnf:
 
-.. TODO: Use Python 3.11 once RHEL 8.6 goes EOL in 2024.
-
 .. prompt:: bash
 
     sudo dnf -y update
     sudo dnf -y group install development
-    sudo dnf -y install python39 python39-devel java-17-openjdk-headless nano git
+    sudo dnf -y install python39 python39-pip python39-devel java-11-openjdk-headless nano git
 
-Set ``java`` executable to point to Java 17:
+Set ``java`` executable to point to Java 11:
 
 .. prompt:: bash
 
-    sudo alternatives --set java "java-17-openjdk.$(uname -i)"
+    sudo alternatives --set java "java-11-openjdk.$(uname -i)"
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/_includes/install-guide-rhel9-derivatives.rst

@@ -1,5 +1,3 @@
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
@@ -9,14 +7,12 @@ Installing the pre-requirements
 Red Hat Enterprise Linux (RHEL) 9 and its derivatives have all required packages available in official repositories.
 Install them with dnf:
 
-.. TODO: Use Python 3.11 once RHEL 9.0 goes EOL in 2024.
-
 .. prompt:: bash
 
-    sudo dnf -y install python39 python3-devel git java-17-openjdk-headless @development nano
+    sudo dnf -y install python39 git java-11-openjdk-headless @development nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/_includes/install-python-pyenv.rst

@@ -10,7 +10,7 @@ virtual environment.
 
 .. prompt:: bash
 
-    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.9.18 -v
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.9.16 -v
 
 This may take a long time to complete, depending on your hardware. For some machines (such as
 Raspberry Pis and micro-tier VPSes), it may take over an hour; in this case, you may wish to remove
@@ -22,6 +22,6 @@ After that is finished, run:
 
 .. prompt:: bash
 
-    pyenv global 3.9.18
+    pyenv global 3.9.16
 
 Pyenv is now installed and your system should be configured to run Python 3.9.

docs/install_guides/_includes/install-python38-pyenv.rst

@@ -2,7 +2,7 @@
 Installing Python with pyenv
 ----------------------------
 
-On distributions where Python 3.10 needs to be compiled from source, we recommend the use of pyenv.
+On distributions where Python 3.8 needs to be compiled from source, we recommend the use of pyenv.
 This simplifies the compilation process and has the added bonus of simplifying setting up Red in a
 virtual environment.
 
@@ -10,7 +10,7 @@ virtual environment.
 
 .. prompt:: bash
 
-    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.10.13 -v
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.16 -v
 
 This may take a long time to complete, depending on your hardware. For some machines (such as
 Raspberry Pis and micro-tier VPSes), it may take over an hour; in this case, you may wish to remove
@@ -22,6 +22,6 @@ After that is finished, run:
 
 .. prompt:: bash
 
-    pyenv global 3.10.13
+    pyenv global 3.8.16
 
-Pyenv is now installed and your system should be configured to run Python 3.10.
+Pyenv is now installed and your system should be configured to run Python 3.8.

docs/install_guides/_includes/supported-arch-aarch64+armv7l.rst

@@ -1,2 +0,0 @@
-| We support hosting Red on computers running an **aarch64** or **armv7l** version of this system.
-| You can read more about systems and processor architectures we support in our `end-user-guarantees`.

docs/install_guides/_includes/supported-arch-armv7l.rst

@@ -1,2 +0,0 @@
-| We support hosting Red on computers running an **armv7l** version of this system.
-| You can read more about systems and processor architectures we support in our `end-user-guarantees`.

docs/install_guides/_includes/supported-arch-x64+aarch64+armv7l.rst

@@ -1,2 +0,0 @@
-| We support hosting Red on computers running an **x86-64**, **aarch64**, or **armv7l** version of this system.
-| You can read more about systems and processor architectures we support in our `end-user-guarantees`.

docs/install_guides/_includes/supported-arch-x64+aarch64.rst

@@ -1,2 +0,0 @@
-| We support hosting Red on computers running an **x86-64** or **aarch64** version of this system.
-| You can read more about systems and processor architectures we support in our `end-user-guarantees`.

docs/install_guides/_includes/supported-arch-x64.rst

@@ -1,2 +0,0 @@
-| We support hosting Red on computers running an **x86-64** version of this system.
-| You can read more about systems and processor architectures we support in our `end-user-guarantees`.

docs/install_guides/alma-linux-8.rst

@@ -1,7 +1,7 @@
 .. _install-alma-linux-8:
 
 ====================================
-Installing Red on Alma Linux 8.6-8.x
+Installing Red on Alma Linux 8.4-8.x
 ====================================
 
 .. include:: _includes/install-guide-rhel8-derivatives.rst

docs/install_guides/arch.rst

@@ -4,8 +4,6 @@
 Installing Red on Arch Linux
 ============================
 
-.. include:: _includes/supported-arch-x64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
@@ -16,7 +14,7 @@ Install the pre-requirements with pacman:
 
 .. prompt:: bash
 
-    sudo pacman -Syu git jre17-openjdk-headless base-devel nano
+    sudo pacman -Syu git jre11-openjdk-headless base-devel nano
 
 On Arch Linux, Python 3.9 can be installed from the Arch User Repository (AUR) from the ``python39`` package.
 
@@ -32,6 +30,6 @@ The manual build process is the Arch-supported install method for AUR packages.
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/centos-7.rst

@@ -4,8 +4,6 @@
 Installing Red on CentOS 7
 ==========================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
@@ -37,9 +35,7 @@ In order to install Git 2.11 or greater, we recommend adding the IUS repository:
 
 .. Include common instructions:
 
-.. Python 3.10 requires OpenSSL 1.1.1 which CentOS 7 doesn't provide in base repository.
-
-.. include:: _includes/install-python39-pyenv.rst
+.. include:: _includes/install-python-pyenv.rst
 
 .. include:: _includes/create-env-with-pyenv-virtualenv.rst
 

docs/install_guides/debian-10.rst

@@ -0,0 +1,28 @@
+.. _install-debian-10:
+
+==================================
+Installing Red on Debian 10 Buster
+==================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+We recommend installing pyenv as a method of installing non-native versions of Python on
+Debian Buster. This guide will tell you how. First, run the following commands:
+
+.. prompt:: bash
+
+    sudo apt update
+    sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless nano
+    CXX=/usr/bin/g++
+
+.. Include common instructions:
+
+.. include:: _includes/install-python-pyenv.rst
+
+.. include:: _includes/create-env-with-pyenv-virtualenv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/debian-11.rst

@@ -4,8 +4,6 @@
 Installing Red on Debian 11 Bullseye
 ====================================
 
-.. include:: _includes/supported-arch-x64+aarch64+armv7l.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
@@ -18,10 +16,10 @@ with apt:
 .. prompt:: bash
 
     sudo apt update
-    sudo apt -y install python3 python3-dev python3-venv git openjdk-17-jre-headless build-essential nano
+    sudo apt -y install python3 python3-dev python3-venv python3-pip git openjdk-11-jre-headless build-essential nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/debian-12.rst

@@ -1,27 +0,0 @@
-.. _install-debian-12:
-
-====================================
-Installing Red on Debian 12 Bookworm
-====================================
-
-.. include:: _includes/supported-arch-x64+aarch64+armv7l.rst
-
-.. include:: _includes/linux-preamble.rst
-
--------------------------------
-Installing the pre-requirements
--------------------------------
-
-Debian 12 "Bookworm" has all required packages available in official repositories. Install them
-with apt:
-
-.. prompt:: bash
-
-    sudo apt update
-    sudo apt -y install python3 python3-dev python3-venv git openjdk-17-jre-headless build-essential nano
-
-.. Include common instructions:
-
-.. include:: _includes/create-env-with-venv3.11.rst
-
-.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/fedora.rst

@@ -4,23 +4,21 @@
 Installing Red on Fedora Linux
 ==============================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
 Installing the pre-requirements
 -------------------------------
 
-Fedora Linux 37 and above has all required packages available in official repositories. Install
+Fedora Linux 35 and above has all required packages available in official repositories. Install
 them with dnf:
 
 .. prompt:: bash
 
-    sudo dnf -y install python3.11 python3.11-devel git java-17-openjdk-headless @development-tools nano
+    sudo dnf -y install python39 git java-11-openjdk-headless @development-tools nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.11.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/index.rst

@@ -19,8 +19,8 @@ we recommend **Ubuntu 22.04 LTS**.
    centos-7
    centos-stream-8
    centos-stream-9
+   debian-10
    debian-11
-   debian-12
    fedora
    opensuse-leap-15
    opensuse-tumbleweed
@@ -32,6 +32,7 @@ we recommend **Ubuntu 22.04 LTS**.
    rhel-9
    rocky-linux-8
    rocky-linux-9
+   ubuntu-1804
    ubuntu-2004
    ubuntu-2204
    ubuntu-non-lts

docs/install_guides/mac.rst

@@ -4,8 +4,6 @@
 Installing Red on macOS
 =======================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 -------------------------------
 Installing the pre-requirements
 -------------------------------
@@ -26,21 +24,21 @@ one-by-one:
 
 .. prompt:: bash
 
-    brew install python@3.11
+    brew install python@3.9
     brew install git
     brew tap homebrew/cask-versions
-    brew install --cask temurin17
+    brew install --cask temurin11
 
 By default, Python installed through Homebrew is not added to the load path.
 To fix this, you should run these commands:
 
 .. prompt:: bash
 
-    echo 'export PATH="$(brew --prefix)/opt/python@3.11/bin:$PATH"' >> "$([ -n "$ZSH_VERSION" ] && echo ~/.zprofile || ([ -f ~/.bash_profile ] && echo ~/.bash_profile || echo ~/.profile))"
-    export PATH="$(brew --prefix)/opt/python@3.11/bin:$PATH"
+    echo 'export PATH="$(brew --prefix)/opt/python@3.9/bin:$PATH"' >> "$([ -n "$ZSH_VERSION" ] && echo ~/.zprofile || ([ -f ~/.bash_profile ] && echo ~/.bash_profile || echo ~/.profile))"
+    export PATH="$(brew --prefix)/opt/python@3.9/bin:$PATH"
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.11.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/opensuse-leap-15.rst

@@ -1,27 +1,25 @@
 .. _install-opensuse-leap-15:
 
 =====================================
-Installing Red on openSUSE Leap 15.4+
+Installing Red on openSUSE Leap 15.3+
 =====================================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
 Installing the pre-requirements
 -------------------------------
 
-openSUSE Leap 15.4+ has all required dependencies available in official repositories. Install them
+openSUSE Leap 15.3+ has all required dependencies available in official repositories. Install them
 with zypper:
 
 .. prompt:: bash
 
-    sudo zypper -n install python310 python310-devel git-core java-17-openjdk-headless nano
+    sudo zypper -n install python39-base python39-pip git-core java-11-openjdk-headless nano
     sudo zypper -n install -t pattern devel_basis
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.10.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/opensuse-tumbleweed.rst

@@ -4,8 +4,6 @@
 Installing Red on openSUSE Tumbleweed
 =====================================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
@@ -17,11 +15,11 @@ with zypper:
 
 .. prompt:: bash
 
-    sudo zypper -n install python311 python311-devel git-core java-17-openjdk-headless nano
+    sudo zypper -n install python39-base python39-pip git-core java-11-openjdk-headless nano
     sudo zypper -n install -t pattern devel_basis
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.11.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/oracle-linux-8.rst

@@ -1,7 +1,7 @@
 .. _install-oracle-linux-8:
 
 ======================================
-Installing Red on Oracle Linux 8.6-8.x
+Installing Red on Oracle Linux 8.4-8.x
 ======================================
 
 .. include:: _includes/install-guide-rhel8-derivatives.rst

docs/install_guides/raspberry-pi-os-10.rst

@@ -4,8 +4,6 @@
 Installing Red on Raspberry Pi OS (Legacy) 10 Buster
 ====================================================
 
-.. include:: _includes/supported-arch-armv7l.rst
-
 .. note::
 
     While we do provide support and install instructions for running Red
@@ -35,20 +33,15 @@ Installing the pre-requirements
 We recommend installing pyenv as a method of installing non-native versions of Python on
 Raspberry Pi OS. This guide will tell you how. First, run the following commands:
 
-.. cmake is necessary to be able to successfully build rapidfuzz.
-
 .. prompt:: bash
 
     sudo apt update
-    sudo apt -y install cmake make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-17-jre-headless nano
+    sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless nano
     CXX=/usr/bin/g++
 
 .. Include common instructions:
 
-.. We should only build and install even versions of Python on Raspberry Pi OS as odd
-.. versions are part of piwheels and can cause installs of pip packages that won't work.
-
-.. include:: _includes/install-python310-pyenv.rst
+.. include:: _includes/install-python38-pyenv.rst
 
 .. include:: _includes/create-env-with-pyenv-virtualenv.rst
 

docs/install_guides/raspberry-pi-os-11.rst

@@ -4,8 +4,6 @@
 Installing Red on Raspberry Pi OS 11 Bullseye
 =============================================
 
-.. include:: _includes/supported-arch-aarch64+armv7l.rst
-
 .. note::
 
     This guide can only be used with Raspberry Pi OS 11 Bullseye,
@@ -33,10 +31,10 @@ with apt:
 .. prompt:: bash
 
     sudo apt update
-    sudo apt -y install python3 python3-dev python3-venv git openjdk-17-jre-headless build-essential nano
+    sudo apt -y install python3 python3-dev python3-venv python3-pip git openjdk-11-jre-headless build-essential nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/rhel-8.rst

@@ -1,7 +1,7 @@
 .. _install-rhel-8:
 
 =========================================================
-Installing Red on Red Hat Enterprise Linux (RHEL) 8.6-8.x
+Installing Red on Red Hat Enterprise Linux (RHEL) 8.4-8.x
 =========================================================
 
 .. include:: _includes/install-guide-rhel8-derivatives.rst

docs/install_guides/rocky-linux-8.rst

@@ -1,7 +1,7 @@
 .. _install-rocky-linux-8:
 
-=====================================
-Installing Red on Rocky Linux 8.6-8.x
-=====================================
+===============================
+Installing Red on Rocky Linux 8
+===============================
 
 .. include:: _includes/install-guide-rhel8-derivatives.rst

docs/install_guides/ubuntu-1804.rst

@@ -0,0 +1,37 @@
+.. _install-ubuntu-1804:
+
+==================================
+Installing Red on Ubuntu 18.04 LTS
+==================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
+
+.. prompt:: bash
+
+    sudo apt update
+    sudo apt -y install software-properties-common
+    sudo add-apt-repository -y ppa:git-core/ppa
+
+We recommend adding the ``deadsnakes`` ppa to install Python 3.9:
+
+.. prompt:: bash
+
+    sudo add-apt-repository -y ppa:deadsnakes/ppa
+
+Now install the pre-requirements with apt:
+
+.. prompt:: bash
+
+    sudo apt -y install python3.9 python3.9-dev python3.9-venv python3-pip git openjdk-11-jre-headless build-essential nano
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/ubuntu-2004.rst

@@ -4,24 +4,28 @@
 Installing Red on Ubuntu 20.04 LTS
 ==================================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
 Installing the pre-requirements
 -------------------------------
 
-Ubuntu 20.04 LTS has all required packages available in official repositories. Install them
-with apt:
+We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
 
 .. prompt:: bash
 
     sudo apt update
-    sudo apt -y install python3.9 python3.9-dev python3.9-venv git openjdk-17-jre-headless build-essential nano
+    sudo apt -y install software-properties-common
+    sudo add-apt-repository -y ppa:git-core/ppa
+
+Now install the pre-requirements with apt:
+
+.. prompt:: bash
+
+    sudo apt -y install python3.9 python3.9-dev python3.9-venv python3-pip git openjdk-11-jre-headless build-essential nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.9.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/ubuntu-2204.rst

@@ -4,24 +4,28 @@
 Installing Red on Ubuntu 22.04 LTS
 ==================================
 
-.. include:: _includes/supported-arch-x64+aarch64.rst
-
 .. include:: _includes/linux-preamble.rst
 
 -------------------------------
 Installing the pre-requirements
 -------------------------------
 
-Ubuntu 22.04 LTS has all required packages available in official repositories. Install them
-with apt:
+We recommend adding the ``deadsnakes`` ppa to install Python 3.9:
 
 .. prompt:: bash
 
     sudo apt update
-    sudo apt -y install python3.10 python3.10-dev python3.10-venv git openjdk-17-jre-headless build-essential nano
+    sudo apt -y install software-properties-common
+    sudo add-apt-repository -y ppa:deadsnakes/ppa
+
+Now install the pre-requirements with apt:
+
+.. prompt:: bash
+
+    sudo apt -y install python3.9 python3.9-dev python3.9-venv python3-pip git openjdk-11-jre-headless build-essential nano
 
 .. Include common instructions:
 
-.. include:: _includes/create-env-with-venv3.10.rst
+.. include:: _includes/create-env-with-venv.rst
 
 .. include:: _includes/install-and-setup-red-unix.rst