[3.4] Version bump to 3.4.17 (#5767)

Version bump to 3.4.17

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

.cherry_picker.toml

@@ -0,0 +1,5 @@
+team = "Cog-Creators"
+repo = "Red-DiscordBot"
+check_sha = "6251c585e4ec0a53813a9993ede3ab5309024579"
+fix_commit_msg = false
+default_branch = "V3/develop"

.github/CODEOWNERS

@@ -1,5 +1,5 @@
 # Cogs
-/redbot/cogs/audio/** @aikaterna @Drapersniper
+/redbot/cogs/audio/** @aikaterna @PredaaA
 /redbot/cogs/downloader/* @jack1142
 /redbot/cogs/streams/* @palmtree5
 /redbot/cogs/mutes/* @TrustyJAID

.github/ISSUE_TEMPLATE/01_command_bug.yml

@@ -1,9 +1,6 @@
 name: Bug reports for commands
-about: For bugs that involve commands found within Red.
-title: ''
+description: For bugs that involve commands found within Red.
 labels: 'Type: Bug'
-assignees: ''
-issue_body: true
 body:
 - type: markdown
   attributes:
@@ -11,12 +8,14 @@ body:
       Thank you for taking the time to fill out an issue. This template is meant for any issues related to commands.
       If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
 - type: input
+  id: red-version
   attributes:
     label: "What Red version are you using?"
     placeholder: 3.4.5
   validations:
     required: true
 - type: dropdown
+  id: cog-name
   attributes:
     label: "Cog name"
     description: "From which cog does the command come from?"
@@ -46,6 +45,7 @@ body:
   validations:
     required: true
 - type: input
+  id: command-name
   attributes:
     label: "Command name"
     description: "What is the command that caused the error?"
@@ -53,11 +53,13 @@ body:
   validations:
     required: true
 - type: textarea
+  id: weh
   attributes:
     label: "What did you expect to happen?"
   validations:
     required: true
 - type: textarea
+  id: wah
   attributes:
     label: "What actually happened?"
     description: |
@@ -66,6 +68,7 @@ body:
   validations:
     required: true
 - type: textarea
+  id: reproduction-steps
   attributes:
     label: "How can we reproduce this error?"
     description: "List of steps required to reproduce this error."
@@ -76,3 +79,8 @@ body:
       ...
   validations:
     required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.

.github/ISSUE_TEMPLATE/02_other_bugs.yml

@@ -1,9 +1,6 @@
 name: Bug report
-about: "For bugs that don't involve a command."
-title: ''
+description: "For bugs that don't involve a command."
 labels: 'Type: Bug'
-assignees: ''
-issue_body: true
 body:
 - type: markdown
   attributes:
@@ -11,22 +8,26 @@ body:
       Thank you for taking the time to fill out an issue. This template is meant for any issues not related to any existing command.
       If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
 - type: input
+  id: red-version
   attributes:
     label: "What Red version are you using?"
     placeholder: 3.4.5
   validations:
     required: true
 - type: textarea
+  id: what-happened
   attributes:
     label: "What were you trying to do?"
   validations:
     required: true
 - type: textarea
+  id: weh
   attributes:
     label: "What did you expect to happen?"
   validations:
     required: true
 - type: textarea
+  id: wah
   attributes:
     label: "What actually happened?"
     description:  |
@@ -34,6 +35,7 @@ body:
   validations:
     required: true
 - type: textarea
+  id: reproduction-steps
   attributes:
     label: "How can we reproduce this error?"
     description: |
@@ -45,3 +47,8 @@ body:
       ...
   validations:
     required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.

.github/ISSUE_TEMPLATE/03_enhancements.yml

@@ -1,9 +1,6 @@
 name: Enhancement proposal
-about: For feature requests and improvements related to already existing functionality.
-title: ''
+description: For feature requests and improvements related to already existing functionality.
 labels: 'Type: Enhancement'
-assignees: ''
-issue_body: true
 body:
 - type: markdown
   attributes:
@@ -11,15 +8,22 @@ body:
       Thank you for taking the time to fill out an issue. This template is meant for feature requests and improvements to already existing functionality.
       If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
 - type: input
+  id: component-name
   attributes:
     label: "What component of Red (cog, command, API) would you like to see improvements on?"
     placeholder: Audio
   validations:
     required: true
 - type: textarea
+  id: proposal
   attributes:
     label: "Describe the enhancement you're suggesting."
     description: |
       Feel free to describe in as much detail as you wish.
   validations:
     required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.

.github/ISSUE_TEMPLATE/04_feature_request.yml

@@ -1,9 +1,6 @@
 name: Feature request
-about: For feature requests regarding Red itself.
-title: ''
+description: For feature requests regarding Red itself.
 labels: 'Type: Feature'
-assignees: ''
-issue_body: true
 body:
 - type: markdown
   attributes:
@@ -11,6 +8,7 @@ body:
       Thank you for taking the time to fill out an issue, this template is meant for any feature suggestions.
       If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
 - type: dropdown
+  id: feature-name
   attributes:
     label: "Type of feature request"
     description: "What type of feature would you like to request?"
@@ -23,6 +21,7 @@ body:
   validations:
     required: true
 - type: textarea
+  id: proposal
   attributes:
     label: "Description of the feature you're suggesting"
     description: |
@@ -45,4 +44,9 @@ body:
         - Note any restrictions on who can use the command or where it can be used
   validations:
     required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1 @@
-### Type
-
-- [ ] Bugfix
-- [ ] Enhancement
-- [ ] New feature
-
 ### Description of the changes

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,0 @@
-### Type
-
-- [ ] Bugfix
-- [ ] Enhancement
-- [ ] New feature
-
-### Description of the changes

.github/labeler.yml

@@ -27,6 +27,7 @@
   # Source
   - redbot/*
   - redbot/core/__init__.py
+  - redbot/core/_diagnoser.py
   - redbot/core/_sharedlibdeprecation.py
   - redbot/core/bot.py
   - redbot/core/checks.py
@@ -45,6 +46,7 @@
   - 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":
@@ -120,7 +122,10 @@
   - schema/*
   - tools/*
 "Category: Mod Cog":
+  # Source
   - redbot/cogs/mod/*
+  # Docs
+  - docs/cog_guides/mod.rst
 "Category: Modlog API":
   # Source
   - redbot/core/generic_casetypes.py
@@ -128,16 +133,26 @@
   # Docs
   - docs/framework_modlog.rst
 "Category: Modlog Cog":
+  # Source
   - redbot/cogs/modlog/*
+  # Docs
+  - docs/cog_guides/modlog.rst
 "Category: Mutes Cog":
+  # Source
   - 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
@@ -156,6 +171,7 @@
   - 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":
@@ -164,4 +180,7 @@
   # Docs
   - docs/framework_utils.rst
 "Category: Warnings":
+  # Source
   - redbot/cogs/warnings/*
+  # Docs
+  - docs/cog_guides/warnings.rst

.github/workflows/auto_labeler_issues.yml

@@ -3,6 +3,9 @@ on:
   issues:
     types: [opened]
 
+permissions:
+  issues: write
+
 jobs:
   build:
 

.github/workflows/auto_labeler_pr.yml

@@ -2,6 +2,9 @@ name: Auto Labeler - PRs
 on:
   pull_request_target:
 
+permissions:
+  pull-requests: write
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/codeql-analysis.yml

@@ -11,6 +11,9 @@ jobs:
   analyze:
     name: Analyze
     runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      actions: read
 
     steps:
     - name: Checkout repository
@@ -24,7 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install -U pip setuptools wheel
-        python -m pip install -r ./tools/dev-requirements.txt
+        python -m pip install -e .[all]
         # Set the `CODEQL-PYTHON` environment variable to the Python executable
         # that includes the dependencies
         echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV

.github/workflows/prepare_release.yml

@@ -7,6 +7,10 @@ on:
         required: false
         default: 'auto'
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   crowdin_download_translations:
     needs: pr_stable_bump

.github/workflows/publish_release.yml

@@ -5,8 +5,58 @@ on:
       - "*"
 
 jobs:
-  release_to_pypi:
+  release_information:
     if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    name: GO HERE BEFORE APPROVING
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout repository and install Python
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      # Get version to release
+      - name: Get version to release
+        id: version_to_release
+        run: |
+          python .github/workflows/scripts/bump_version.py
+        env:
+          PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
+          JUST_RETURN_VERSION: '1'
+
+      # Print release information
+      - name: REVIEW OUTPUT OF THIS STEP BEFORE APPROVING
+        env:
+          TAG_BASE_BRANCH: ${{ github.event.base_ref }}
+          TAG_REF_NAME: ${{ github.ref }}
+          RELEASE_VERSION: ${{ steps.version_to_release.outputs.version }}
+        run: |
+          echo 'Release information:'
+          echo "- Branch the tag was based off: ${TAG_BASE_BRANCH#'refs/heads/'}"
+          echo "- Tag name: ${TAG_REF_NAME#'refs/tags/'}"
+          echo "- Release version: $RELEASE_VERSION"
+
+          echo "TAG_NAME=${TAG_REF_NAME#'refs/tags/'}" >> $GITHUB_ENV
+
+      - name: Ensure the tag name corresponds to the released version
+        env:
+          RELEASE_VERSION: ${{ steps.version_to_release.outputs.version }}
+        run: |
+          if [[ "$TAG_NAME" != "$RELEASE_VERSION" ]]; then
+              echo -n "The tag name ($TAG_NAME) is not the same as"
+              echo " the release version ($RELEASE_VERSION)!"
+              exit 1
+          else
+              echo "The tag name and the release version are the same ($TAG_NAME)."
+              echo 'Continuing...'
+          fi
+
+  release_to_pypi:
+    needs: release_information
+    environment: Release
+    name: Release to PyPI
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -17,20 +67,32 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
+          pip install build twine
       - name: Build and publish
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
           twine upload dist/*
 
   pr_dev_bump:
+    permissions:
+      contents: write
+      pull-requests: write
     needs: release_to_pypi
+    name: Update Red version number to dev
     runs-on: ubuntu-latest
     steps:
+      - name: Get base branch
+        env:
+          TAG_BASE_BRANCH: ${{ github.event.base_ref }}
+        run: |
+          echo "BASE_BRANCH=${TAG_BASE_BRANCH#'refs/heads/'}" >> $GITHUB_ENV
+
       - uses: actions/checkout@v2
+        with:
+          ref: ${{ env.BASE_BRANCH }}
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
@@ -72,6 +134,7 @@ jobs:
           branch: "automated/pr_bumps/${{ steps.bump_version_dev.outputs.new_version }}"
           author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
           milestone: ${{ steps.get_milestone_number.outputs.result }}
+          base: ${{ env.BASE_BRANCH }}
 
       - name: Close and reopen the PR with different token to trigger CI
         uses: actions/github-script@v3

.github/workflows/scripts/bump_version.py

@@ -6,6 +6,11 @@ from typing import Match
 import redbot
 
 
+if int(os.environ.get("JUST_RETURN_VERSION", 0)):
+    print(f"::set-output name=version::{redbot.__version__}")
+    sys.exit(0)
+
+
 version_info = None
 
 

.github/workflows/tests.yml

@@ -17,12 +17,18 @@ jobs:
           python_version:
             - "3.8"
           tox_env:
-            - py
             - style
             - docs
           include:
-            - tox_env: py
-              friendly_name: Tests
+            - tox_env: py38
+              python_version: "3.8"
+              friendly_name: Python 3.8 - Tests
+            - tox_env: py39
+              python_version: "3.9"
+              friendly_name: Python 3.9 - Tests
+            - tox_env: py310
+              python_version: "3.10-dev"
+              friendly_name: Python 3.10-dev - Tests
             - tox_env: style
               friendly_name: Style
             - tox_env: docs
@@ -52,6 +58,8 @@ jobs:
         matrix:
           python_version:
             - "3.8"
+            - "3.9"
+            - "3.10-dev"
         fail-fast: false
       name: Tox - Postgres
       services:

.gitignore

@@ -143,3 +143,86 @@ ENV/
 
 # Pre-commit hooks
 /.pre-commit-config.yaml
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### SublimeText template
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+
+# SFTP configuration file
+sftp-config.json
+sftp-config-alt*.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+

.readthedocs.yml

@@ -1,15 +1,11 @@
 version: 2
 
-formats:
-  - pdf
-
 build:
   image: latest
 
 python:
   version: 3.8
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
       extra_requirements:

.travis.yml

@@ -1,65 +0,0 @@
-dist: xenial
-language: python
-cache: pip
-notifications:
-  email: false
-
-python:
-- 3.8.1
-env:
-  global:
-    - PIPENV_IGNORE_VIRTUALENVS=1
-
-install:
-- pip install --upgrade pip tox
-
-script:
-- tox
-
-jobs:
-  include:
-    - env: TOXENV=py
-    - env: TOXENV=docs
-    - env: TOXENV=style
-    - env: TOXENV=postgres
-      services: postgresql
-      addons:
-        postgresql: "10"
-      before_script:
-        - psql -c 'create database red_db;' -U postgres
-    # These jobs only occur on tag creation if the prior ones succeed
-    - stage: PyPi Deployment
-      if: tag IS present
-      python: 3.8.1
-      env:
-        - DEPLOYING=true
-        - TOXENV=py38
-      deploy:
-        - provider: pypi
-          distributions: sdist bdist_wheel
-          user: Red-DiscordBot
-          password:
-            secure: Ty9vYnd/wCuQkVC/OsS4E2jT9LVDVfzsFrQc4U2hMYcTJnYbl/3omyObdCWCOBC40vUDkVHAQU8ULHzoCA+2KX9Ds/7/P5zCumAA0uJRR9Smw7OlRzSMxJI+/lGq4CwXKzxDZKuo5rsxXEbW5qmYjtO8Mk6KuLkvieb1vyr2DcqWEFzg/7TZNDfD1oP8et8ITQ26lLP1dtQx/jlAiIBzgK9wziuwj1Divb9A///VsGz43N8maZ+jfsDjYqrfUVWTy3ar7JPUplletenYCR1PmQ5C46XfV0kitKd1aITJ48YPAKyYgKy8AIT+Uz1JArTnqdzLSFRNELS57qS00lzgllbteCyWQ8Uzy0Zpxb/5DDH8/mL1n0MyJrF8qjZd2hLNAXg3z/k9bGXeiMLGwoxRlGXkL2XpiVgI93UKKyVyooGNMgPTc/QdSc7krjAWcOtX/HgLR34jxeLPFEdzJNAFIimfDD8N+XTFcNBw6EvOYm/n5MXkckNoX/G+ThNobHZ7VKSASltZ9zBRAJ2dDh35G3CYmVEk33U77RKbL9le/Za9QVBcAO8i6rqVGYkdO7thHHKHc/1CB1jNnjsFSDt0bURtNfAqfwKCurQC8487zbEzT+2fog3Wygv7g3cklaRg4guY8UjZuFWStYGqbroTsOCd9ATNqeO5B13pNhllSzU=
-          skip_cleanup: true
-          on:
-            repo: Cog-Creators/Red-DiscordBot
-            tags: true
-    - stage: Crowdin Deployment
-      if: tag IS present OR ENV(BUILD_CROWDIN)
-      python: 3.8.1
-      env:
-        - DEPLOYING=true
-        - TOXENV=py38
-      before_deploy:
-      - curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
-      - 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.1
-      deploy:
-      - provider: script
-        script: make upload_translations
-        skip_cleanup: true
-        on:
-          repo: Cog-Creators/Red-DiscordBot
-          tags: true

CONTRIBUTING.md

@@ -42,7 +42,7 @@ Unsure of how to get started contributing to Red? Please take a look at the Issu
 * beginner - issues that can normally be fixed in just a few lines of code and maybe a test or two.
 * help-wanted - issues that are currently unassigned to anyone and may be a bit more involved/complex than issues tagged with beginner.
 
-**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github)
 
 At this point you're ready to start making changes. Feel free to ask for help; everyone was a beginner at some point!
 

MANIFEST.in

@@ -0,0 +1,27 @@
+# include license files
+include LICENSE
+recursive-include redbot *.LICENSE
+
+# include locale files
+recursive-include redbot locales/*.po
+
+# include data folders for cogs
+recursive-include redbot/**/data *
+
+# include *.export files from the test fixtures
+recursive-include redbot *.export
+
+# include the py.typed file informing about Red being typed
+recursive-include redbot py.typed
+
+# include *.sql files from postgres driver
+recursive-include redbot/core/drivers/postgres *.sql
+
+# include tests
+graft tests
+
+# include tox configuration
+include tox.ini
+
+# exclude files containing byte-code and compiled libs
+global-exclude *.py[cod]

README.md

@@ -72,7 +72,7 @@ from installing and updating, every part of the bot can be controlled from withi
 - Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)
 - Trivia (lists are included and can be easily added)
 - Music features (YouTube, SoundCloud, local files, playlists, queues)
-- Stream alerts (Twitch, Youtube, Hitbox, Picarto)
+- Stream alerts (Twitch, Youtube, Picarto)
 - Bank (slot machine, user credits)
 - Custom commands
 - Imgur/gif search
@@ -114,7 +114,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://cogboard.red/t/approved-repositories/210) the cog you’re looking for,
+[find](https://index.discord.red) the cog you’re looking for,
 consult our [guide](https://red-discordbot.readthedocs.io/en/stable/guide_cog_creation.html) on
 building your own cogs!
 
@@ -131,4 +131,4 @@ Artwork created by [Sinlaire](https://sinlaire.deviantart.com/) on Deviant Art f
 Bot Project.
 
 This project vendors [discord.ext.menus](https://github.com/Rapptz/discord-ext-menus) package made by Danny Y. (Rapptz) which is distributed under MIT License.
-Copy of this license can be found in [discord-ext-menus.LICENSE](redbot/vendored/discord-ext-menus.LICENSE) file in [redbot/vendored](redbot/vendored) folder of this repository.
+A copy of this license can be found in the [discord-ext-menus.LICENSE](redbot/vendored/discord-ext-menus.LICENSE) file in the [redbot/vendored](redbot/vendored) folder of this repository.

docs/_html/robots.txt

@@ -0,0 +1,6 @@
+User-agent: *
+Disallow: /
+Allow: /en/stable
+Allow: /en/latest
+
+Sitemap: https://docs.discord.red/sitemap.xml

docs/autostart_mac.rst

@@ -0,0 +1,110 @@
+.. launchd guide
+
+==============================
+Setting up auto-restart on Mac
+==============================
+
+-----------------------
+Creating the plist file
+-----------------------
+
+Start by activating your venv. Then run the following command:
+
+.. code-block:: none
+
+    which python
+
+Copy the output of that command.
+
+Now run :code:`sudo nano /Library/LaunchDaemons/red.plist`
+
+Paste the following and replace the following: 
+
+- :code:`username` (but not :code:`UserName`) with your Mac username
+- :code:`path` with the path you copied earlier
+- :code:`instance-name` with your instance name:
+
+.. code-block:: none
+    :emphasize-lines: 9, 13, 28
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+    <plist version="1.0">
+        <dict>
+            <key>Label</key>
+            <string>red</string>
+            <key>ProgramArguments</key>
+            <array>
+                <string>path</string>
+                <string>-O</string>
+                <string>-m</string>
+                <string>redbot</string>
+                <string>instance-name</string>
+                <string>--no-prompt</string>
+            </array>
+            <key>RunAtLoad</key>
+            <true/>
+            <key>KeepAlive</key>
+            <dict>
+                <key>SuccessfulExit</key>
+                <false/>
+            </dict>
+            <key>StandardOutPath</key>
+            <string>/tmp/red_out.log</string>
+            <key>StandardErrorPath</key>
+            <string>/tmp/red_err.log</string>
+            <key>UserName</key>
+            <string>username</string>
+            <key>InitGroups</key>
+            <true/>
+        </dict>
+    </plist>
+
+.. note::
+
+    You may add any additional arguments you need to add to the :code:`redbot` command by 
+    adding them to the end of the array under :code:`ProgramArguments`
+
+.. note::
+
+    Should you need to set up auto-restart for additional bots, create a :code:`.plist` file for
+    each bot under a different file name, and use the respective file names for the commands below.
+
+Save and exit :code:`ctrl + O; enter; ctrl + x`
+
+-------------------------------
+Starting and loading the plist
+-------------------------------
+
+To start the bot and set it to start on boot, you must run the following command:
+
+.. prompt:: bash
+
+    sudo launchctl load -w /Library/LaunchDaemons/red.plist
+
+If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
+type the following command in the terminal:
+
+.. prompt:: bash
+
+    sudo launchctl stop red
+
+To start the bot again after a shutdown, run the following:
+
+.. prompt:: bash
+
+    sudo launchctl start red
+
+To stop the bot and set it to not start on boot anymore, run the following:
+
+.. prompt:: bash
+
+    sudo launchctl unload -w /Library/LaunchDaemons/red.plist
+
+To view Red's log, run the following (:code:`red_out.log` is for the console output, and
+:code:`red_err.log` for the error logs):
+
+.. prompt:: bash
+
+    nano /tmp/red_out.log
+    nano /tmp/red_err.log

docs/autostart_pm2.rst

@@ -1,56 +0,0 @@
-.. pm2 service guide
-
-==============================================
-Setting up auto-restart using pm2 on Linux
-==============================================
-
-.. note:: This guide is for setting up PM2 on a Linux environment. This guide assumes that you already have a working Red instance.
-
---------------
-Installing PM2
---------------
-
-Start by installing Node.JS and NPM via your favorite package distributor. From there run the following command:
-
-.. prompt:: bash
-
-    npm install pm2 -g
-
-After PM2 is installed, run the following command to enable your Red instance to be managed by PM2. Replace the brackets with the required information.
-You can add additional Red based arguments after the instance name, such as :code:`--dev`.
-
-.. prompt:: bash
-
-    pm2 start "<path>" --name "<app_name>" -- -O -m redbot <instance_name> --no-prompt
-
-**Arguments to replace**
-
-- ``<app_name>`` - A name to identify the bot within pm2, this is not your Red instance.
-
-- | ``<path>`` - The location of your Python interpreter.
-  | To find out where that is, use the proper set of commands:
-
-  .. prompt:: bash
-      :prompts: $,(redenv) $
-      :modifiers: auto
-
-      # If redbot is installed in a venv
-      $ source ~/redenv/bin/activate
-      (redenv) $ which python
-
-      # If redbot is installed in a pyenv virtualenv
-      $ pyenv shell <virtualenv_name>
-      (redenv) $ pyenv which python
-
-- ``<instance_name>`` - The name of your Red instance.
-
-------------------------------
-Ensuring that PM2 stays online
-------------------------------
-
-To make sure that PM2 stays online and persistence between machine restarts, run the following commands:
-
-.. prompt:: bash
-
-    pm2 save
-    pm2 startup

docs/autostart_systemd.rst

@@ -26,7 +26,7 @@ Next, your python :code:`path` can be fetched with the following commands:
 
     # If redbot is installed in a venv
     $ source ~/redenv/bin/activate
-    (redenv) $ which python
+    (redenv) $ /usr/bin/which python
 
     # If redbot is installed in a pyenv virtualenv
     $ pyenv shell <virtualenv_name>
@@ -39,6 +39,7 @@ Then create the new service file:
 Paste the following in the file, and replace all instances of :code:`username` with the Linux username you retrieved above, and :code:`path` with the python path you retrieved above.
 
 .. code-block:: none
+    :emphasize-lines: 8-10
 
     [Unit]
     Description=%I redbot
@@ -89,7 +90,13 @@ type the following command in the terminal, still by adding the instance name af
 .. warning:: If the service doesn't stop in the next 10 seconds, the process is killed.
     Check your logs to know the cause of the error that prevents the shutdown.
 
-To view Red’s log, you can acccess through journalctl:
+To set the bot to not start on boot anymore, you must disable the service by running the following command, adding the instance name after the **@**:
+
+.. prompt:: bash
+
+    sudo systemctl disable red@instancename
+
+You can access Red's log through journalctl:
 
 .. prompt:: bash
 

docs/bot_application_guide.rst

@@ -56,7 +56,7 @@ Continue to the next section to enable privileged intents.
 Enabling Privileged Intents
 -------------------------------
 .. warning::
-    Due to Discord API changes, Red Bot requires all intents.
+    :ref:`Red Bot requires all intents. <intents>`
     \This section is required.
 
 1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
@@ -75,5 +75,6 @@ Enabling Privileged Intents
 .. warning::
 
     Red bots with over 100 servers require `bot verification <https://support.discord.com/hc/en-us/articles/360040720412>`_ which is not covered in this guide.
+    Remember that :ref:`we do not support public bots <intents>`. We encourage you to read that page before scaling up your bot.
 
 *Parts of this guide have been adapted from* `discord.py intro <https://discordpy.readthedocs.io/en/stable/discord.html#discord-intro>`_ *and* `discord.py privileged intents <https://discordpy.readthedocs.io/en/stable/intents.html#privileged-intents>`_.

docs/changelog_3_3_0.rst

@@ -650,7 +650,7 @@ Dev Cog
 Documentation changes
 ---------------------
 
-- Fixed install instructions for Mac in `install_linux_mac` (:issue:`3675`, :issue:`3436`)
+- Fixed install instructions for Mac (:issue:`3675`, :issue:`3436`)
 - Windows install instructions now use ``choco upgrade`` commands instead of ``choco install`` to ensure up-to-date packages (:issue:`3684`)
 
 

docs/changelog_3_4_0.rst

@@ -1,5 +1,638 @@
 .. 3.4.x Changelogs
 
+Redbot 3.4.17 (2022-06-07)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`ltzmax`, :ghuser:`matcha19`, :ghuser:`mina9999`, :ghuser:`ponte-vecchio`, :ghuser:`PredaaA`, :ghuser:`TrustyJAID`, :ghuser:`untir-l`, :ghuser:`Vexed01`
+
+Read before updating
+--------------------
+
+#. Fedora 34 is no longer supported as it has already reached its end of life.
+#. 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.4.17 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.4.0_1347>`__.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Fedora 33 is no longer supported as it has already reached its its end of life (:issue:`5701`)
+- Added instructions on how to respond to the message received from ``[p]contact`` in the embed footer of the message sent to the bot owner (:issue:`5528`, :issue:`5529`)
+- Updated ``[p]servers`` command to escape Discord markdown in server names (:issue:`5696`, :issue:`5744`)
+- Fixed a bug that prevented users from changing the name and data location with ``redbot --edit`` command (:issue:`5545`, :issue:`5540`, :issue:`5541`)
+- Fixed grammar in the ``[p]uptime`` command (:issue:`5596`)
+
+Audio
+*****
+
+- Added timestamps to all embeds sent by Audio cog (:issue:`5632`)
+- Improved handling of voice connection close codes received from Discord (:issue:`5712`)
+- Fixed plain word YT searching with ``[p]play`` and ``[p]search`` commands (:issue:`5712`)
+- Fixed YT age-restricted track playback (:issue:`5712`)
+- Fixed the cog not sending any Track Error message on track decoding errors (:issue:`5716`)
+- Fixed the ``UnboundLocalError`` exception happening when using ``[p]playlist list`` with an empty playlist (:issue:`5378`, :issue:`5394`)
+
+Downloader
+**********
+
+- Added information about the commit hash at which the cog is pinned in the output of ``[p]cog listpinned`` command (:issue:`5551`, :issue:`5563`)
+
+Filter
+******
+
+- Fixed a potential memory leak in Filter cog (:issue:`5578`)
+
+General
+*******
+
+- Updated features list in ``[p]serverinfo`` with the latest changes from Discord (:issue:`5655`)
+
+Mod
+***
+
+- Updated Red's ban commands to address the breaking change that Discord made in their ban list API endpoint (:issue:`5656`)
+
+Modlog
+******
+
+- Modlog's automated case creation for bans now properly checks that the guild is available before further processing (:issue:`5647`)
+
+Mutes
+*****
+
+- Added proper error handling for VERY long durations in mute commands (:issue:`5605`)
+
+Permissions
+***********
+
+- Updated ``[p]permissions acl setglobal`` and ``[p]permissions acl setserver`` to allow sending the file in a follow-up message (:issue:`5473`, :issue:`5685`)
+- ``[p]permissions canrun`` now prepends an emoji to the response to better differentiate between the positive and negative results (:issue:`5711`)
+
+Trivia
+******
+
+- Allowed passing ``use_spoilers`` setting in the CONFIG section of the trivia list file (:issue:`5566`)
+
+Trivia Lists
+************
+
+- Added a trivia list for the FIFA World Cup with questions based on hosts, placements, venues, continental confederations, number of participants, top goal scorers, qualification shocks, and more (:issue:`5639`)
+- Updated ``geography`` trivia list with up-to-date answers and removed questions that lack sources for their claimed answers (:issue:`5638`)
+- Updated Kazakhstan's capital city in the ``worldcapitals`` trivia list (:issue:`5598`, :issue:`5599`)
+- Fixed spelling error in the answer to one of the questions in ``computers`` trivia list (:issue:`5587`, :issue:`5588`)
+
+
+Developer changelog
+-------------------
+
+- Updated ``discord.ext.menus`` vendor (:issue:`5579`)
+
+
+Documentation changes
+---------------------
+
+- Added CentOS Stream 9, RHEL 9, Alma Linux 9, Oracle Linux 9, and Rocky Linux 9 install guides (:issue:`5537`, :issue:`5721`)
+- Added Ubuntu 22.04 install guide (:issue:`5720`)
+- Changed the recommended operating system for hosting Red from Ubuntu 20.04 LTS to Ubuntu 22.04 LTS (:issue:`5720`)
+- Updated Python version in ``pyenv`` and Windows instructions (:issue:`5719`)
+- Replaced install instructions for discontinued AdoptOpenJDK package with Temurin 11 package in the macOS install guide (:issue:`5718`)
+- Updated Visual Studio Build Tools version in Windows install guide (:issue:`5702`)
+- Updated systemd guide to use the absolute path to ``which`` command to avoid triggering shell aliases on some OSes (:issue:`5547`)
+- Emphasized lines that contain text that needs to be replaced by the user (:issue:`5548`)
+- Prevented Google and other search engines from indexing versioned documentation (:issue:`5549`)
+- Pinned Temurin version on Windows until a fixed version becomes available (:issue:`5717`)
+- Fixed git installation instructions in CentOS 7 install guide (:issue:`5700`)
+
+
+Redbot 3.4.16 (2021-12-31)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`jack1142`, :ghuser:`PredaaA`
+
+This is a hotfix release fixing issues with invite URL API that caused
+``[p]invite`` command and ``CORE__INVITE_URL`` RPC method to not work.
+
+End-user changelog
+------------------
+
+- **Core Bot** - Fixed ``[p]invite`` command (:issue:`5517`)
+
+
+Developer changelog
+-------------------
+
+- Fixed ``CORE__INVITE_URL`` RPC method (:issue:`5517`)
+
+
+Documentation changes
+---------------------
+
+- Changed Arch install guide to temporarily use ``python39`` AUR package instead of ``python`` package as Red does not currently support Python 3.10 (:issue:`5518`)
+
+
+Redbot 3.4.15 (2021-12-31)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`aleclol`, :ghuser:`Arman0334`, :ghuser:`Crossedfall`, :ghuser:`Dav-Git`, :ghuser:`fixator10`, :ghuser:`Flame442`, :ghuser:`jack1142`, :ghuser:`Jan200101`, :ghuser:`Just-Jojo`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`laggron42`, :ghuser:`ltzmax`, :ghuser:`Parnassius`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`RasmusWL`, :ghuser:`sravan1946`, :ghuser:`Stonedestroyer`, :ghuser:`the-krak3n`, :ghuser:`Tobotimus`, :ghuser:`vertyco`, :ghuser:`Vexed01`, :ghuser:`WreckRox`, :ghuser:`yamikaitou`
+
+Read before updating
+--------------------
+
+#. Fedora 33 and CentOS 8 are no longer supported as they have already reached end of life.
+#. 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.4.15 uses a new Lavalink jar that you MUST manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.4.0_1275>`__ to be able to continue using Audio.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Added new CLI options for non-interactive usage of ``redbot-setup`` (:issue:`2396`, :issue:`5448`)
+
+    See output of ``redbot-setup --help`` for more information.
+
+- JSON is now more strongly recommended and is used by default for new instances in ``redbot-setup`` (:issue:`5448`)
+- The embed setting for ``[p]help`` command set with ``[p]embedset command`` will now affect all help messages, not just the ones sent when invoking ``[p]help`` command directly (:issue:`5452`)
+- ``[p]traceback`` command now indicates that it DMed the command caller with a tick reaction (:issue:`5353`)
+- Improved ``[p]helpset showaliases`` responses (:issue:`5376`)
+- Added plural forms to the responses of ``[p]leave`` command (:issue:`5391`)
+- Fedora 33 and CentOS 8 are no longer supported as they have already reached end of life (:issue:`5440`)
+- Corrected usage examples in help of ``[p]set api`` and ``[p]set api remove`` (:issue:`5444`)
+- Updated prefix length limit to ``25`` to allow setting bot mention as a prefix (:issue:`5476`)
+- Confirmation prompts (accepting "yes/no" or "I agree" as the answer) no longer wrongfully translate the answer that needs to be sent when only English answers are accepted by the bot (:issue:`5363`, :issue:`5364`, :issue:`5404`)
+- Fixed short help for some of the commands in Core Red (:issue:`5502`)
+- Fixed issues with rendering of modlog cases with usernames written in a right-to-left language (:issue:`5422`)
+- Fixed an issue with instance backup failing for non-JSON storage backends (:issue:`5315`)
+- Running Red with ``--no-instance`` CLI flag no longer fails when no instance was ever created by the user (:issue:`5415`, :issue:`5416`)
+- ``[p]command enable guild`` and ``[p]command disable guild`` commands no longer error out for commands that *only* check for user permissions, not caller's roles (:issue:`5477`)
+
+Admin
+*****
+
+- Added ``[p]selfroleset clear`` command which can be used to clear the list of available selfroles in the server (:issue:`5387`)
+
+Audio
+*****
+
+- Added native Mac M1 support for Java runtimes supporting Mac M1 (:issue:`5474`)
+- Enabled JDA-NAS on all system architectures which should limit stuttering/buffering issues on some machines (:issue:`5474`)
+- The bot will now disconnect from the voice channel when all members are bots if the auto-disconnect setting is enabled (:issue:`5421`)
+- Fixed an issue with resuming playback after changing voice channels (:issue:`5170`)
+- Fixed issues with Soundcloud private playlists and mobile links (:issue:`5474`)
+- Fixed searching music with some of the queries containing quotes or backslashes (:issue:`5474`)
+- Fixed an exception caused by unavailable YT tracks in Mix playlists (:issue:`5474`)
+- Fixed ``IndexError`` in ``[p]queue`` command which occurred when the user provides negative integer as the page number (:issue:`5429`)
+
+Cleanup
+*******
+
+- Restricted ``[p]cleanupset notify`` to only be invokable in server channels (:issue:`5466`)
+
+Custom Commands
+***************
+
+- Added 2000 character limit for custom command responses to prevent Nitro users from adding longer responses than a Discord bot can send (:issue:`5499`)
+
+Dev Cog
+*******
+
+- ``[p]mockmsg`` now allows mocking attachment-only messages (:issue:`5446`)
+
+Downloader
+**********
+
+- Added repo name to the response of ``[p]findcog`` command (:issue:`5382`, :issue:`5383`)
+
+Economy
+*******
+
+- ``[p]economyset showsettings`` now includes configured role payday amounts (:issue:`5455`, :issue:`5457`)
+
+General
+*******
+
+- Removed voice region field from ``[p]serverinfo`` command as Discord no longer provides this setting for servers (:issue:`5449`)
+
+Mod
+***
+
+- ``[p]voicekick`` now sends a response when the action succeeds (:issue:`5367`)
+- Fixed an error with ``[p]tempban`` failing to send an invite link when a server has an unset vanity URL (:issue:`5472`)
+- Fixed explanations of example usage for ``[p]ban``, ``[p]kick``, and ``[p]tempban`` commands (:issue:`5372`)
+- Fixed a typo in one of ``[p]unban``'s error messages (:issue:`5470`)
+
+Modlog
+******
+
+- Added the new native Discord timestamps in ``[p]case``, ``[p]casesfor``, and ``[p]listcases`` commands (:issue:`5395`)
+
+Warnings
+********
+
+- Warning actions no longer error out when the action is set to use a command that *only* checks for user permissions, not caller's roles (:issue:`5477`)
+
+
+Developer changelog
+-------------------
+
+- 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`)
+- Added optional ``check_permissions`` keyword-only argument to `RedBase.embed_requested()` which, if ``True``, will make the method also check whether the bot can send embeds in the given channel (:issue:`5452`)
+- Added `RedBase.get_invite_url()` and `RedBase.is_invite_url_public()` that expose the functionality of ``[p]invite`` programmatically (:issue:`5152`, :issue:`5424`)
+- Changed the output of ``CORE__LOAD``, ``CORE__RELOAD``, and ``CORE__UNLOAD`` RPC methods to a dictionary (:issue:`5451`, :issue:`5453`)
+
+
+Documentation changes
+---------------------
+
+- Added install guide for Alma Linux 8.4-8.x and Raspberry Pi OS 11 Bullseye (:issue:`5440`)
+- Updated the Java distribution used in the Windows install guide to Temurin - rebranded AdoptOpenJDK (:issue:`5403`)
+- Improved Mac and pyenv instructions to address common issues with load path configuration (:issue:`5356`)
+- Updated the server locations for Hetzner and Contabo in :ref:`host-list` document (:issue:`5475`)
+- Updated Python version in ``pyenv`` and Windows instructions (:issue:`5447`)
+- Removed inaccurate note from Unix install guides about install commands also being used for updating Red (:issue:`5439`)
+- Removed LXC from unsupported hosting platforms as many VPS providers utilize that technology (:issue:`5351`)
+- Specified that Red currently requires Python 3.8.1 - 3.9.x (:issue:`5403`)
+
+
+Redbot 3.4.14 (2021-09-23)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`L33Tech`, :ghuser:`maxbooiii`, :ghuser:`RheingoldRiver`
+
+Read before updating
+--------------------
+
+#. Versions of RHEL older than 8.4 (including 7) and versions of CentOS older than 8.4 (excluding 7) are no longer supported.
+#. 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.4.14 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.3.2.3_1239>`__.
+
+
+End-user changelog
+------------------
+
+- **Core Bot** - Added the new native Discord timestamp in the ``[p]uptime`` command (:issue:`5323`)
+- **Core Bot** - ``redbot-setup delete`` command no longer requires database connection if the data deletion was not requested (:issue:`5312`, :issue:`5313`)
+- **Audio** - Fixed intermittent 403 Forbidden errors (:issue:`5329`)
+- **Modlog** - Fixed formatting of **Last modified at** field in Modlog cases (:issue:`5317`)
+
+
+Documentation changes
+---------------------
+
+- Each operating system now has a dedicated install guide (:issue:`5328`)
+- Fixed Raspberry Pi OS install guide (:issue:`5314`, :issue:`5328`)
+- Added install guide for CentOS Stream 8, Oracle Linux 8.4-8.x, and Rocky Linux 8 (:issue:`5328`)
+- Install guides for RHEL derivatives no longer require the use of pyenv (:issue:`5328`)
+
+
+Redbot 3.4.13 (2021-09-09)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Arman0334`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`fredster33`, :ghuser:`Injabie3`, :ghuser:`jack1142`, :ghuser:`Just-Jojo`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`leblancg`, :ghuser:`maxbooiii`, :ghuser:`npc203`, :ghuser:`palmtree5`, :ghuser:`phenom4n4n`, :ghuser:`PredaaA`, :ghuser:`qenu`, :ghuser:`TheDataLeek`, :ghuser:`Twentysix26`, :ghuser:`TwinDragon`, :ghuser:`Vexed01`
+
+Read before updating
+--------------------
+
+1. If you're hosting a public/big bot (>75 servers) or strive to scale your bot at that level, you should read :doc:`our stance on (privileged) intents and public bots <intents>`.
+2. Fedora 32 is no longer supported as it has already reached end of life.
+3. 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.4.13 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.3.2.3_1238>`__.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Added a new ``[p]diagnoseissues`` command to allow the bot owners to diagnose issues with various command checks with ease (:issue:`4717`, :issue:`5243`)
+
+    Since some of us are pretty excited about this feature, here's a very small teaser showing a part of what it can do:
+
+    .. figure:: https://user-images.githubusercontent.com/6032823/132610057-d6c65d67-c244-4f0b-9458-adfbe0c68cab.png
+
+- Revamped the ``[p]debuginfo`` to make it more useful for... You guessed it, debugging! (:issue:`4997`, :issue:`5156`)
+
+    More specifically, added information about CPU and RAM, bot's instance name and owners
+
+- The formatting of Red's console logs has been updated to make it more copy-paste friendly (:issue:`4868`, :issue:`5181`)
+- Added the new native Discord timestamps in Modlog cases, ``[p]userinfo``, ``[p]serverinfo``, and ``[p]tempban`` (:issue:`5155`, :issue:`5241`)
+- Added a setting for ``[p]help``'s reaction timeout (:issue:`5205`)
+
+    This can be changed with ``[p]helpset reacttimeout`` command
+
+- Red 3.4.13 is the first release to (finally) support Python 3.9! (:issue:`4655`, :issue:`5121`)
+- Upgraded all Red's dependencies (:issue:`5121`)
+- Fedora 32 is no longer supported as it has already reached end of life (:issue:`5121`)
+- Fixed a bunch of errors related to the missing permissions and channels/messages no longer existing (:issue:`5109`, :issue:`5163`, :issue:`5172`, :issue:`5191`)
+
+Admin
+*****
+
+- The ``[p]selfroleset add`` and ``[p]selfroleset remove`` commands can now be used to add multiple selfroles at once (:issue:`5237`, :issue:`5238`)
+
+Alias
+*****
+
+- Added commands for editing existing aliases (:issue:`5108`)
+
+Audio
+*****
+
+- Added a per-guild max volume setting (:issue:`5165`)
+
+    This can be changed with the ``[p]audioset maxvolume`` command
+
+- Fixed an issue with short clips being cutoff when auto-disconnect on queue end is enabled (:issue:`5158`, :issue:`5188`)
+- Fixed fetching of age-restricted tracks (:issue:`5233`)
+- Fixed searching of YT Music (:issue:`5233`)
+- Fixed playback from SoundCloud (:issue:`5233`)
+- ``[p]summon`` will now indicate that it has succeeded or failed to summon the bot (:issue:`5186`)
+
+Cleanup
+*******
+
+- The ``[p]cleanup user`` command can now be used to clean messages of a user that is no longer in the server (:issue:`5169`)
+- All ``[p]cleanup`` commands will now send a notification with the number of deleted messages. The notification is deleted automatically after 5 seconds (:issue:`5218`)
+
+    This can be disabled with the ``[p]cleanupset notify`` command
+
+Downloader
+**********
+
+- The dot character (``.``) can now be used in repo names. No more issues with adding repositories using the commands provided by the Cog Index! (:issue:`5214`)
+
+Filter
+******
+
+- Added ``[p]filter clear`` and ``[p]filter channel clear`` commands for clearing the server's/channel's filter list (:issue:`4841`, :issue:`4981`)
+
+Mod
+***
+
+- Fixed an error with handling of temporary ban expirations while the guild is unavailable due to Discord outage (:issue:`5173`)
+- The DM message from the ``[p]tempban`` command will now include the ban reason if ``[p]modset dm`` setting is enabled (:issue:`4836`, :issue:`4837`)
+- The ``[p]rename`` command will no longer permit changing nicknames of members that are not lower in the role hierarchy than the command caller (:issue:`5187`, :issue:`5211`)
+
+Streams
+*******
+
+- Fixed an issue with some YouTube streamers getting removed from stream alerts after a while (:issue:`5195`, :issue:`5223`)
+- Made small optimizations in regards to stream alerts (:issue:`4968`)
+
+Trivia
+******
+
+- Added schema validation of the custom trivia files (:issue:`4571`, :issue:`4659`)
+
+Warnings
+********
+
+- 0 point warnings are, once again, allowed. (:issue:`5177`, :issue:`5178`)
+
+
+Developer changelog
+-------------------
+
+- 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.
+    In addition to regular timedelta arguments, it also accepts months and years!
+
+- Added more APIs for allowlists and blocklists (:issue:`5206`)
+
+    Here's the list of the methods that were added to the ``bot`` object:
+
+        - `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()>`
+
+- Added `CommandConverter` and `CogConverter` to the ``redbot.core.commands`` package (:issue:`5037`)
+
+
+Documentation changes
+---------------------
+
+- Added a document about (privileged) intents and our stance regarding "public bots" (:issue:`5216`, :issue:`5221`)
+- Added install instructions for Debian 11 Bullseye (:issue:`5213`, :issue:`5217`)
+- Added Oracle Cloud's Always Free offering to the :ref:`host-list` (:issue:`5225`)
+- Updated the commands in the install guide for Mac OS to work properly on Apple Silicon devices (:issue:`5234`)
+- Fixed the examples of commands that are only available to people with the mod role (:issue:`5180`)
+- Fixed few other small issues with the documentation :) (:issue:`5048`, :issue:`5092`, :issue:`5149`, :issue:`5207`, :issue:`5209`, :issue:`5215`, :issue:`5219`, :issue:`5220`)
+
+
+Miscellaneous
+-------------
+
+- **Core Bot** - The console error about missing Privileged Intents stands out more now (:issue:`5184`)
+- **Core Bot** - The ``[p]invite`` command will now add a tick reaction after it DMs an invite link to the user (:issue:`5184`)
+- **Downloader** - Added a few missing line breaks (:issue:`5185`, :issue:`5187`)
+
+
+Redbot 3.4.12 (2021-06-17)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Flame442`, :ghuser:`jack1142`, :ghuser:`Just-Jojo`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`npc203`, :ghuser:`PredaaA`, :ghuser:`retke`, :ghuser:`Stonedestroyer`
+
+This is a hotfix release related to Red ceasing to use the Audio Global API service.
+
+Full changelog
+--------------
+
+- **Audio** - Updated URL of the curated playlist (:issue:`5135`)
+- **Audio** - All local caches are now enabled by default (:issue:`5140`)
+- **Audio** - Global API service will no longer be used in Audio and as such support for it has been removed from the cog (:issue:`5143`)
+- **Core Bot** - ``[p]set serverprefix`` command will now prevent the user from setting a prefix with length greater than 20 characters (:issue:`5091`, :issue:`5117`)
+- **Core Bot** - ``[p]set prefix`` command will now warn the user when trying to set a prefix with length greater than 20 characters (:issue:`5091`, :issue:`5117`)
+- **Core Bot** - ``applications.commands`` scope can now be included in the invite URL returned from ``[p]invite`` by enabling it with``[p]inviteset commandscope``
+- **Dev Cog** - ``[p]debug`` command will now confirm the code finished running with a tick reaction (:issue:`5107`)
+- **Filter** - Fixed an edge case that caused the cog to sometimes check contents of DM messages (:issue:`5125`)
+- **Warnings** - Prevented users from applying 0 or less points in custom warning reasons (:issue:`5119`, :issue:`5120`)
+
+
+Redbot 3.4.11 (2021-06-12)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`Onii-Chan-Discord`
+
+This is a hotfix release fixing a crash involving guild uploaded stickers.
+
+Full changelog
+--------------
+
+- discord.py version has been bumped to 1.7.3 (:issue:`5129`)
+- Links to the CogBoard in Red's documentation have been updated to use the new domain (:issue:`5124`)
+
+
+Redbot 3.4.10 (2021-05-28)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`aleclol`, :ghuser:`benno1237`, :ghuser:`bobloy`, :ghuser:`BoyDownTown`, :ghuser:`Danstr5544`, :ghuser:`DeltaXWizard`, :ghuser:`Drapersniper`, :ghuser:`Fabian-Evolved`, :ghuser:`fixator10`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`Kreusada`, :ghuser:`Lifeismana`, :ghuser:`Obi-Wan3`, :ghuser:`OofChair`, :ghuser:`palmtree5`, :ghuser:`plofts`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`TrustyJAID`, :ghuser:`Vexed01`
+
+Read before updating
+--------------------
+
+1. PM2 process manager is no longer supported as it is not a viable solution due to certain parts of its behavior.
+
+    We highly recommend you to switch to one of the other supported solutions:
+        - `autostart_systemd`
+        - `autostart_mac`
+
+    If you experience any issues when trying to configure it, you can join `our discord server <https://discord.gg/red>`__ and ask in the **support** channel for help.
+2. 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.4.10 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.3.2.3_1233>`__.
+    - We've updated our `application.yml file <https://github.com/Cog-Creators/Red-DiscordBot/blob/3.4.10/redbot/cogs/audio/data/application.yml>`__ and you should update your instance's ``application.yml`` appropriately.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Fixed terminal colors on Windows (:issue:`5063`)
+- Fixed the ``--rich-traceback-extra-lines`` flag (:issue:`5028`)
+- Added missing information about the ``showaliases`` setting in ``[p]helpset showsettings`` (:issue:`4971`)
+- The help command no longer errors when it doesn't have permission to read message history and menus are enabled (:issue:`4959`, :issue:`5030`)
+- Fixed a bug in ``[p]embedset user`` that made it impossible to reset the user's embed setting (:issue:`4962`)
+- ``[p]embedset command`` and its subcommands now properly check whether any of the passed command's parents require Embed Links permission (:issue:`4962`)
+- Fixed an issue with Red reloading unrelated modules when using ``[p]load`` and ``[p]reload`` (:issue:`4956`, :issue:`4958`)
+
+Admin
+*****
+
+- The cog will now log when it leaves a guild due to the serverlock (:issue:`5008`, :issue:`5073`)
+
+Audio
+*****
+
+- Fixed an issue that made it possible to remove Aikaterna's curated tracks playlist (:issue:`5018`)
+- Fixed auto-resume of auto play after Lavalink restart (:issue:`5051`)
+- The ``[p]audiostats`` command can now only be used by bot owners (:issue:`5017`)
+- Fixed an error with ``[p]audiostats`` caused by players not always having their connection time stored (:issue:`5046`)
+- Fixed track resuming in a certain edge case (:issue:`4996`)
+- Fixed an error in ``[p]audioset restart`` (:issue:`4987`)
+- The cog will now check whether it has speak permissions in the channel before performing any actions (:issue:`5012`)
+- Fixed an issue with Audio failing when it's missing permissions to send a message in the notification channel (:issue:`4960`)
+- Fixed fetching of age-restricted tracks (:issue:`5085`)
+- Fixed an issue with Soundcloud URLs that ended with a slash (``/``) character (:issue:`5085`)
+
+Custom Commands
+***************
+
+- ``[p]customcom create simple`` no longer errors for a few specific names (:issue:`5026`, :issue:`5027`)
+
+Downloader
+**********
+
+- ``[p]repo remove`` can now remove multiple repos at the same time (:issue:`4765`, :issue:`5082`)
+- ``[p]cog install`` now properly shows the repo name rather than ``{repo.name}`` (:issue:`4954`)
+
+Mod
+***
+
+- ``[p]mute`` no longer errors on muting a bot user if the ``senddm`` option is enabled (:issue:`5071`)
+
+Mutes
+*****
+
+- Forbidden errors during the channel mute are now handled properly in a rare edge case (:issue:`4994`)
+
+Modlog
+******
+
+- ``[p]modlogset resetcases`` will now ask for confirmation before proceeding (:issue:`4976`)
+- Modlog will no longer try editing the case's Discord message once it knows that it no longer exists (:issue:`4975`)
+
+Streams
+*******
+
+- Fixed Picarto support (:issue:`4969`, :issue:`4970`)
+- ``[p]twitchstream``, ``[p]youtubestream``, and ``[p]picarto`` commands can no longer be run in DMs (:issue:`5036`, :issue:`5035`)
+- Smashcast service has been closed and for that reason we have removed support for it from the cog (:issue:`5039`, :issue:`5040`)
+- Fixed Twitch stream alerts for streams that use localized display names (:issue:`5050`, :issue:`5066`)
+- The cog no longer errors when trying to delete a cached message from a channel that no longer exists (:issue:`5032`, :issue:`5031`)
+- In message template, ``{stream.display_name}`` can now be used to refer to streamer's display name (:issue:`5050`, :issue:`5066`)
+
+    - This is not always the same as ``{stream}`` which refers to the streamer's channel or username
+
+Warnings
+********
+
+- The warn action is now taken *after* sending the warn message to the member (:issue:`4713`, :issue:`5004`)
+
+
+Developer changelog
+-------------------
+
+- Bumped discord.py to 1.7.2 (:issue:`5066`)
+- The log messages shown by the global error handler will now show the trace properly for task done callbacks (:issue:`4980`)
+- **Dev** - ``[p]eval``, ``[p]repl``, and ``[p]debug`` commands no longer fail to send very long syntax errors (:issue:`5041`)
+- **Dev** - ``[p]eval``, ``[p]repl``, and ``[p]debug`` commands now, in addition to ``py``, support code blocks with ``python`` syntax (:issue:`5083`)
+
+
+Documentation changes
+---------------------
+
+- Added `a guide for making auto-restart service on Mac <autostart_mac>` (:issue:`4082`, :issue:`5020`)
+- Added `cog guide for core commands <cog_guides/core>` (:issue:`1734`, :issue:`4597`)
+- Added `cog guide for Mod cog <cog_guides/mod>` (:issue:`1734`, :issue:`4886`)
+- Added `cog guide for Modlog cog <cog_guides/modlog>` (:issue:`1734`, :issue:`4919`)
+- Added `cog guide for Mutes cog <cog_guides/mutes>` (:issue:`1734`, :issue:`4875`)
+- Added `cog guide for Permissions cog <cog_guides/permissions>` (:issue:`1734`, :issue:`4985`)
+- Added `cog guide for Reports cog <cog_guides/reports>` (:issue:`1734`, :issue:`4882`)
+- Added `cog guide for Warnings cog <cog_guides/warnings>` (:issue:`1734`, :issue:`4920`)
+- Added :ref:`a guide about Trivia list creation <guide_trivia_list_creation>` (:issue:`4595`, :issue:`5023`)
+- Added the documentation for `redbot.core.modlog.Case` (:issue:`4979`)
+- Removed PM2 guide (:issue:`4991`)
+
+
+Miscellaneous
+-------------
+
+- Clarified that ``[p]cleanup`` commands only delete the messages from the current channel (:issue:`5070`)
+- Updated Python version in ``pyenv`` and Windows instructions (:issue:`5025`)
+- Added information on how to set the bot not to start on boot anymore to auto-restart docs (:issue:`5020`)
+- Improved logging in Audio cog (:issue:`5044`)
+- Improved logging of API errors in Streams cog (:issue:`4995`)
+- The command ``[p]urban`` from the General cog will now use the default embed color of the bot (:issue:`5014`)
+- Cog creation guide now includes the ``bot`` as an argument to the cog class (:issue:`4988`)
+- Rephrased a few strings and fixed maaaaany grammar issues and typos (:issue:`4793`, :issue:`4832`, :issue:`4955`, :issue:`4966`, :issue:`5015`, :issue:`5019`, :issue:`5029`, :issue:`5038`, :issue:`5055`, :issue:`5080`, :issue:`5081`)
+
+
+Redbot 3.4.9 (2021-04-06)
+=========================
+
+This is a hotfix release fixing an issue with command error handling.
+
+discord.py version has been bumped to 1.7.1.
+
+Thanks again to :ghuser:`Rapptz` for quick response on this issue.
+
+
 Redbot 3.4.8 (2021-04-06)
 =========================
 | Thanks to all these amazing people that contributed to this release:
@@ -317,7 +950,7 @@ Documentation changes
 - Added information about the Red Index to `guide_publish_cogs` (:issue:`4778`)
 - Restructured the host list (:issue:`4710`)
 - Clarified how to use pm2 with ``pyenv virtualenv`` (:issue:`4709`)
-- Updated the pip command for Red with the postgres extra in `install_linux_mac` document to work on zsh shell (:issue:`4697`)
+- Updated the pip command for Red with the postgres extra in Linux/macOS install guide to work on zsh shell (:issue:`4697`)
 - Updated Python version in ``pyenv`` and Windows instructions (:issue:`4770`)
 
 
@@ -537,7 +1170,7 @@ Documentation changes
 ---------------------
 
 - Added `cog guide for Cleanup cog <cleanup>` (:issue:`4488`)
-- Removed multi-line commands from `install_linux_mac` to avoid confusing readers (:issue:`4550`)
+- Removed multi-line commands from Linux install guides to avoid confusing readers (:issue:`4550`)
 
 
 Redbot 3.4.1 (2020-10-27)
@@ -868,7 +1501,7 @@ Core Bot
 
 - Added data request API (:issue:`4045`,  :issue:`4169`)
 
-    - New special methods added to `commands.Cog`: `red_get_data_for_user()` (documented provisionally), `red_delete_data_for_user()`
+    - New special methods added to `redbot.core.commands.Cog`: `red_get_data_for_user()` (documented provisionally), `red_delete_data_for_user()`
     - 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

docs/cog_guides/admin.rst

@@ -25,8 +25,8 @@ It can add or remove a role to a member, edit one or make some available
 for members so they can self-assign them as they wish.
 
 It also provides tools for the bot owner such as server locking (once enabled,
-the bot will instantly leave new servers she joins) and announcements, which
-will send something in all the servers of the bot.
+the bot will instantly leave new servers it joins) and announcements, which
+can send something in all the servers of the bot.
 
 .. _admin-commands:
 
@@ -150,7 +150,7 @@ selfroleset add
 
 **Description**
 
-Add a role to the list of selfroles.
+Add a role, or a selection of roles, to the list of available selfroles.
 
 .. warning:: Members will be able to assign themselves the role.
     Make sure it doesn't give extra perms or anything that can break
@@ -160,6 +160,22 @@ Add a role to the list of selfroles.
 
 * ``<role>``: The role to add to the list. |role-input|
 
+.. _admin-command-selfroleset-clear:
+
+"""""""""""""""""
+selfroleset clear
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfroleset clear
+
+**Description**
+
+Clear the list of available selfroles for this server.
+
 .. _admin-command-selfroleset-remove:
 
 """"""""""""""""""
@@ -174,7 +190,7 @@ selfroleset remove
 
 **Description**
 
-Removes a role from the list of selfroles.
+Remove a role, or a selection of roles, from the list of available selfroles.
 
 **Arguments**
 
@@ -232,7 +248,7 @@ as yourself, the command author.
 * ``<role>``: The role to remove. |role-input-quotes|
 
 * ``[user]``: The member to remove the role from. |member-input| Defaults
-    to the command author.
+  to the command author.
 
 .. _admin-command-editrole:
 

docs/cog_guides/cleanup.rst

@@ -150,7 +150,7 @@ cleanup bot
 
 **Description**
 
-Clean up command messages and messages from the bot.
+Clean up command messages and messages from the bot in the current channel.
 
 Can only cleanup custom commands and alias commands if those cogs are loaded.
 
@@ -175,7 +175,7 @@ cleanup messages
 
 **Description**
 
-Delete the last X messages.
+Delete the last X messages in the current channel.
 
 Example:
     - ``[p]cleanup messages 26``
@@ -199,7 +199,7 @@ cleanup self
 
 **Description**
 
-Clean up messages owned by the bot.
+Clean up messages owned by the bot in the current channel.
 
 By default, all messages are cleaned. If a second argument is specified,
 it is used for pattern matching - only messages containing the given text will be deleted.
@@ -255,7 +255,7 @@ cleanup text
 
 **Description**
 
-Delete the last X messages matching the specified text.
+Delete the last X messages matching the specified text in the current channel.
 
 Example:
     - ``[p]cleanup text "test" 5``
@@ -283,7 +283,7 @@ cleanup user
 
 **Description**
 
-Delete the last X messages from a specified user.
+Delete the last X messages from a specified user in the current channel.
 
 Examples:
     - ``[p]cleanup user @Twentysix 2``
@@ -294,3 +294,40 @@ Examples:
 - ``<user>`` The user whose messages are to be cleaned up.
 - ``<number>`` The max number of messages to cleanup. Must be a positive integer.
 - ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanupset:
+
+^^^^^^^^^^
+cleanupset
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanupset 
+
+**Description**
+
+Manage the settings for the cleanup command.
+
+.. _cleanup-command-cleanupset-notify:
+
+"""""""""""""""""
+cleanupset notify
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanupset notify
+
+**Description**
+
+Toggle clean up notification settings.
+
+When enabled, a message will be sent per cleanup, showing how many messages were deleted.
+This message will be deleted after 5 seconds.

docs/cog_guides/cog_manager_ui.rst

@@ -45,7 +45,7 @@ or unload them.
 How to install a local package without using downloader
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Let's suppose you made a cog request on the `cog board <https://cogboard.red>`_
+Let's suppose you made a cog request on the `cog board <https://cogboard.discord.red>`_
 and now you want to add your own cog to Red. You should have a folder that
 looks like this:
 
@@ -238,8 +238,10 @@ installpath
 
 **Description**
 
-Shows the install path, or sets a new one. If you want to set a new path, the
-same rules as for :ref:`addpath <cogmanagerui-command-addpath>` applies.
+Shows the install path, or sets a new one.
+
+If you want to set a new path, the same rules as for
+:ref:`addpath <cogmanagerui-command-addpath>` apply
 
 .. warning:: If you edit the install path, the cogs won't be transfered.
 

docs/cog_guides/customcommands.rst

@@ -291,4 +291,4 @@ Shows a custom command's responses and its settings.
 
 **Arguments:**
 
-- ``<command>`` The custom command to show.
+- ``<command_name>`` The custom command to show.

docs/cog_guides/downloader.rst

@@ -235,8 +235,8 @@ You may only uninstall cogs which were previously installed
 by Downloader.
 
 Examples:
-    - ``[p]cog uninstall 26-Cogs defender``
-    - ``[p]cog uninstall Laggrons-Dumb-Cogs say roleinvite``
+    - ``[p]cog uninstall defender``
+    - ``[p]cog uninstall say roleinvite``
 
 **Arguments**
 
@@ -461,14 +461,15 @@ repo delete
 
 **Description**
 
-Remove a repo and its files.
+Remove repos and their files.
 
-Example:
+Examples:
     - ``[p]repo delete 26-Cogs``
+    - ``[p]repo delete 26-Cogs Laggrons-Dumb-Cogs``
 
 **Arguments**
 
-- ``<repo>`` The name of an already added repo
+- ``<repos...>`` The repo or repos to remove.
 
 .. _downloader-command-repo-info:
 

docs/cog_guides/economy.rst

@@ -354,7 +354,9 @@ economyset rolepaydayamount
 
 **Description**
 
-Set the amount earned each payday for a role. Setting to 0 will remove the custom payday for that role instead.
+Set the amount earned each payday for a role.
+
+Set to 0 will remove the custom payday for that role instead.
 
 Only available when not using a global bank.
 

docs/cog_guides/filter.rst

@@ -122,6 +122,22 @@ Examples:
 
 - ``[words...]`` The words or sentences to filter.
 
+.. _filter-command-filter-channel-clear:
+
+""""""""""""""""""""
+filter channel clear
+""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter channel clear
+
+**Description**
+
+Clears this channel's filter list.
+
 .. _filter-command-filter-channel-list:
 
 """""""""""""""""""
@@ -164,6 +180,22 @@ Examples:
 
 - ``[words...]`` The words or sentences to no longer filter.
 
+.. _filter-command-filter-clear:
+
+""""""""""""
+filter clear
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter clear
+
+**Description**
+
+Clears this server's filter list.
+
 .. _filter-command-filter-delete:
 
 """""""""""""

docs/cog_guides/general.rst

@@ -62,18 +62,22 @@ choose
 
 .. code-block:: none
 
-    [p]choose [choices...]
+    [p]choose <first> <second> [others...]
 
 **Description**
 
 Choose between multiple options.
+Options are separated by spaces.
 
-.. note:: To denote options which include whitespace, you should use
-    double quotes.
+.. note::  There must be at least 2 options to pick from.
+.. note::  To denote options which include whitespace, you should enclose the option in double quotes.
 
 **Arguments**
 
-* ``[choices...]``: The arguments for Red to randomly choose from.
+* ``<first>``: The first mandatory option.
+* ``<second>``: The second mandatory option.
+* ``[others...]``: Any remaining optional options.
+
 
 .. _general-command-flip:
 

docs/cog_guides/mod.rst

@@ -0,0 +1,763 @@
+.. _mod:
+
+===
+Mod
+===
+
+This is the cog guide for the mod 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 mod
+
+.. _mod-usage:
+
+-----
+Usage
+-----
+
+A range of highly customizable moderation tools used to protect your 
+guild from users who cannot follow the rules.
+
+
+.. _mod-commands:
+
+--------
+Commands
+--------
+
+.. _mod-command-ban:
+
+^^^
+ban
+^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]ban <user> [days] [reason]
+
+**Description**
+
+Ban a user from this server and optionally delete days of messages.
+
+``days`` is the amount of days of messages to cleanup on ban.
+
+**Arguments**
+
+* ``<user>``: The user to ban. |user-input|
+* ``[days]``: The amount of days of messages to cleanup on ban. This parameter defaults to the defaultdays setting, or no days if this has not yet been configured.
+* ``[reason]``: The reason why the user was banned (optional).
+
+**Example Usage**
+
+* ``[p]ban 428675506947227648 7 Continued to spam after told to stop.``
+    This will ban the user with ID 428675506947227648 and it will delete 7 days worth of messages.
+* ``[p]ban @Twentysix 7 Continued to spam after told to stop.``
+    This will ban Twentysix and it will delete 7 days worth of messages.
+
+A user ID should be provided if the user is not a member of this server.
+If days is not a number, it's treated as the first word of the reason.
+Minimum 0 days, maximum 7. If not specified, the defaultdays setting will be used instead.
+
+.. _mod-command-kick:
+
+^^^^
+kick
+^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]kick <member> [reason]
+
+**Description**
+
+Kick a user.
+
+**Arguments**
+
+* ``<member>``: The member to kick. |member-input|
+* ``[reason]``: The reason why the user was kicked (optional).
+
+**Example Usage**
+
+* ``[p]kick 428675506947227648 wanted to be kicked.``
+    This will kick the user with ID 428675506947227648 from the server.
+* ``[p]kick @Twentysix wanted to be kicked.``
+    This will kick Twentysix from the server.
+
+If a reason is specified, it will be the reason that shows up
+in the audit log.
+
+.. _mod-command-massban:
+
+^^^^^^^
+massban
+^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]massban <user_ids...> [days] [reason]
+
+.. tip:: Alias: ``hackban``
+
+**Description**
+
+Mass bans user(s) from the server.
+
+**Arguments**
+
+* ``<user_ids...>``: The users to ban. This must be a list of user IDs separated by spaces.
+* ``[days]``: The amount of days of messages to cleanup on massban.
+* ``[reason]``: The reason why these users were banned.
+
+**Example Usage**
+
+* ``[p]massban 345628097929936898 57287406247743488 7 they broke all rules.``
+    This will ban all the added userids and delete 7 days worth of their messages.
+
+.. _mod-command-modset:
+
+^^^^^^
+modset
+^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset 
+
+**Description**
+
+Manage server administration settings.
+
+.. _mod-command-modset-defaultdays:
+
+""""""""""""""""""
+modset defaultdays
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset defaultdays [days=0]
+
+**Description**
+
+Set the default number of days worth of messages to be deleted when a user is banned.
+
+The number of days must be between 0 and 7.
+
+**Arguments**
+
+* ``[days=0]``: The default number of days of messages to be deleted when a user is banned.
+
+.. note:: This value must be between 0 and 7.
+
+.. _mod-command-modset-defaultduration:
+
+""""""""""""""""""""""
+modset defaultduration
+""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset defaultduration <duration>
+
+**Description**
+
+Set the default time to be used when a user is tempbanned.
+
+Accepts: seconds, minutes, hours, days, weeks
+
+**Arguments**
+
+* ``<duration>``: The default duration for when a user is temporarily banned. Accepts seconds, minutes, hours, days or weeks.
+
+**Example Usage**
+
+* ``[p]modset defaultduration 7d12h10m``
+* ``[p]modset defaultduration 7 days 12 hours 10 minutes``
+
+.. _mod-command-modset-deletenames:
+
+""""""""""""""""""
+modset deletenames
+""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset deletenames [confirmation=False]
+
+**Description**
+
+Delete all stored usernames and nicknames.
+
+**Arguments**
+
+- ``<confirmation>``: Whether to delete all stored usernames and nicknames. |bool-input|
+
+.. _mod-command-modset-deleterepeats:
+
+""""""""""""""""""""
+modset deleterepeats
+""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset deleterepeats [repeats]
+
+**Description**
+
+Enable auto-deletion of repeated messages.
+
+**Arguments**
+
+* ``[repeats]``: The number of repeated messages needed before further messages are deleted.
+
+.. note:: Must be between 2 and 20. Set to -1 to disable this feature.
+
+.. _mod-command-modset-dm:
+
+"""""""""
+modset dm
+"""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset dm [enabled]
+
+**Description**
+
+Toggle whether a message should be sent to a user when they are kicked/banned.
+
+If this option is enabled, the bot will attempt to DM the user with the guild name
+and reason as to why they were kicked/banned.
+
+**Arguments**
+
+* ``[enabled]``: Whether a message should be sent to a user when they are kicked/banned. |bool-input|
+
+.. _mod-command-modset-hierarchy:
+
+""""""""""""""""
+modset hierarchy
+""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset hierarchy 
+
+**Description**
+
+Toggle role hierarchy check for mods and admins.
+
+.. warning:: Disabling this setting will allow mods to take actions on users above them in the role hierarchy!
+
+This is enabled by default.
+
+.. _mod-command-modset-mentionspam:
+
+""""""""""""""""""
+modset mentionspam
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset mentionspam 
+
+**Description**
+
+Manage the automoderation settings for mentionspam.
+
+.. _mod-command-modset-mentionspam-ban:
+
+""""""""""""""""""""""
+modset mentionspam ban
+""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset mentionspam ban <max_mentions>
+
+**Description**
+
+Set the autoban conditions for mention spam.
+
+Users will be banned if they send any message which contains more than
+``<max_mentions>`` mentions.
+
+**Arguments**
+
+* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
+
+.. _mod-command-modset-mentionspam-kick:
+
+"""""""""""""""""""""""
+modset mentionspam kick
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset mentionspam kick <max_mentions>
+
+**Description**
+
+Set the autokick conditions for mention spam.
+
+Users will be kicked if they send any message which contains more than
+``<max_mentions>`` mentions.
+
+**Arguments**
+
+* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
+
+.. _mod-command-modset-mentionspam-strict:
+
+"""""""""""""""""""""""""
+modset mentionspam strict
+"""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset mentionspam strict [enabled]
+
+**Description**
+
+Setting to account for duplicate mentions.
+
+If enabled all mentions will count including duplicated mentions.
+If disabled only unique mentions will count.
+
+Use this command without any parameter to see the current setting.
+
+**Arguments**
+
+* ``[enabled]``: Whether all mentions will count, including duplicated mentions. |bool-input|
+
+.. _mod-command-modset-mentionspam-warn:
+
+"""""""""""""""""""""""
+modset mentionspam warn
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset mentionspam warn <max_mentions>
+
+**Description**
+
+Sets the autowarn conditions for mention spam.
+
+Users will be warned if they send any messages which contain more than
+``<max_mentions>`` mentions.
+
+**Arguments**
+
+* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
+
+.. _mod-command-modset-reinvite:
+
+"""""""""""""""
+modset reinvite
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset reinvite 
+
+**Description**
+
+Toggle whether an invite will be sent to a user when unbanned.
+
+If this is True, the bot will attempt to create and send a single-use invite
+to the newly-unbanned user.
+
+.. _mod-command-modset-showsettings:
+
+"""""""""""""""""""
+modset showsettings
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset showsettings 
+
+**Description**
+
+Show the current server administration settings.
+
+.. _mod-command-modset-trackallnames:
+
+""""""""""""""""""""
+modset trackallnames
+""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset trackallnames [enabled]
+
+**Description**
+
+Toggle whether all name changes should be tracked.
+
+Toggling this off also overrides the tracknicknames setting.
+
+**Arguments**
+
+* ``[enabled]``: Whether all name changes should be tracked. |bool-input|
+
+.. _mod-command-modset-tracknicknames:
+
+"""""""""""""""""""""
+modset tracknicknames
+"""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]modset tracknicknames [enabled]
+
+**Description**
+
+Toggle whether nickname changes should be tracked.
+
+This setting will be overridden if trackallnames is disabled.
+
+**Arguments**
+
+* ``[enabled]``: Whether all nickname changes should be tracked. |bool-input|
+
+.. _mod-command-movedeletedelay:
+
+^^^^^^^^^^^^^^^
+movedeletedelay
+^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]movedeletedelay 
+
+**Description**
+
+Move deletedelay settings to core
+
+.. _mod-command-moveignoredchannels:
+
+^^^^^^^^^^^^^^^^^^^
+moveignoredchannels
+^^^^^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]moveignoredchannels 
+
+**Description**
+
+Move ignored channels and servers to core
+
+.. _mod-command-names:
+
+^^^^^
+names
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]names <member>
+
+**Description**
+
+Show previous names and nicknames of a member.
+
+**Arguments**
+
+* ``<member>``: |member-input|
+
+.. _mod-command-rename:
+
+^^^^^^
+rename
+^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]rename <member> [nickname]
+
+**Description**
+
+Change a member's nickname.
+
+Leaving the nickname empty will remove it.
+
+**Arguments**
+
+* ``<member>``: |member-input|
+* ``[nickname]``: The new nickname for the member.
+
+.. _mod-command-slowmode:
+
+^^^^^^^^
+slowmode
+^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]slowmode [interval=0:00:00]
+
+**Description**
+
+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 channel's slowmode settings.
+
+.. note::
+    Interval can be anything from 0 seconds to 6 hours.
+    Use without parameters to disable.
+
+.. _mod-command-softban:
+
+^^^^^^^
+softban
+^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]softban <member> [reason]
+
+**Description**
+
+Kick a member and delete 1 day's worth of their messages.
+
+**Arguments**
+
+* ``<member>``: The member to softban. |member-input-quotes|
+* ``[reason]``: Reason for the kick (optional).
+
+.. _mod-command-tempban:
+
+^^^^^^^
+tempban
+^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]tempban <member> [duration] [days] [reason]
+
+**Description**
+
+Temporarily ban a user from this server.
+
+**Arguments**
+
+* ``<member>``: The member to temporarily ban. |member-input-quotes|
+* ``[duration]``: The amount of time the user should be banned for.
+* ``[days]``: The amount of days of messages to cleanup on tempban.
+* ``[reason]``: The reason for the tempban (optional).
+
+**Example Usage**
+
+* ``[p]tempban @Twentysix Because I say so``
+    This will ban Twentysix for the default amount of time set by an administrator.
+* ``[p]tempban @Twentysix 15m You need a timeout``
+    This will ban Twentysix for 15 minutes.
+* ``[p]tempban 428675506947227648 1d2h15m 5 Evil person``
+    This will ban the user with ID 428675506947227648 for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages.
+
+.. _mod-command-unban:
+
+^^^^^
+unban
+^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]unban <user_id> [reason]
+
+**Description**
+
+Unban a user from this server.
+
+**Arguments**
+
+* ``<user_id>``: |user-input|
+* ``[reason]``: The reason for the unban (optional).
+
+.. _mod-command-userinfo:
+
+^^^^^^^^
+userinfo
+^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]userinfo [member]
+
+**Description**
+
+Show information about a user.
+
+This includes fields for status, discord join date, server
+join date, voice state and previous names/nicknames.
+
+If the user has no roles, previous names or previous nicknames,
+these fields will be omitted.
+
+**Arguments**
+
+* ``[member]``: |member-input|
+
+.. _mod-command-voiceban:
+
+^^^^^^^^
+voiceban
+^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]voiceban <member> [reason]
+
+**Description**
+
+Ban a user from speaking and listening in the server's voice channels.
+
+**Arguments**
+
+* ``<member>``: The member to ban from voice. |member-input|
+* ``[reason]``: The reason for the voiceban (optional).
+
+.. _mod-command-voicekick:
+
+^^^^^^^^^
+voicekick
+^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]voicekick <member> [reason]
+
+**Description**
+
+Kick a member from a voice channel.
+
+**Arguments**
+
+* ``<member>``: |member-input|
+* ``[reason]``: The reason for the voicekick (optional).
+
+.. _mod-command-voiceunban:
+
+^^^^^^^^^^
+voiceunban
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]voiceunban <member> [reason]
+
+**Description**
+
+Unban a user from speaking and listening in the server's voice channels.
+
+**Arguments**
+
+* ``<member>``: The member to unban from voice. |member-input-quotes|
+* ``[reason]``: The reason for the voiceunban (optional).

docs/cog_guides/modlog.rst

@@ -0,0 +1,191 @@
+.. _modlog:
+
+======
+ModLog
+======
+
+This is the cog guide for the modlog 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 modlog
+
+.. _modlog-usage:
+
+-----
+Usage
+-----
+
+Manage log channels for moderation actions.
+
+
+.. _modlog-commands:
+
+--------
+Commands
+--------
+
+.. _modlog-command-case:
+
+^^^^
+case
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]case <number>
+
+**Description**
+
+Show the specified case.
+
+**Arguments**
+
+* ``<case>``: The case number to get information for.
+
+.. _modlog-command-casesfor:
+
+^^^^^^^^
+casesfor
+^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]casesfor <member>
+
+**Description**
+
+Display cases for the specified member.
+
+**Arguments**
+
+* ``<member>``: The member to get cases for. |member-input|
+
+.. _modlog-command-listcases:
+
+^^^^^^^^^
+listcases
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]listcases <member>
+
+**Description**
+
+List cases for the specified member.
+
+**Arguments**
+
+* ``<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.
+
+**Arguments**
+
+* ``[action]``: The action to enable or disable case creation for.
+
+.. _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:
+
+^^^^^^
+reason
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reason [case] <reason>
+
+**Description**
+
+Specify a reason for a modlog case.
+
+Please note that you can only edit cases you are
+the owner of unless you are a mod, admin or server owner.
+
+**Arguments**
+
+* ``[case]``: The case number to update the reason for.
+* ``<reason>``: The new reason for the specified case.
+
+.. note:: If no case number is specified, the latest case will be used.

docs/cog_guides/mutes.rst

@@ -0,0 +1,410 @@
+.. _mutes:
+
+=====
+Mutes
+=====
+
+This is the cog guide for the mutes 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 mutes
+
+.. _mutes-usage:
+
+-----
+Usage
+-----
+
+Mute users temporarily or indefinitely.
+
+.. _mutes-commands:
+
+--------
+Commands
+--------
+
+.. _mutes-command-activemutes:
+
+^^^^^^^^^^^
+activemutes
+^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]activemutes 
+
+**Description**
+
+Displays active mutes on this server.
+
+.. _mutes-command-mute:
+
+^^^^
+mute
+^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]mute <users...> [time_and_reason]
+
+**Description**
+
+Mute users.
+
+Examples:
+
+* ``[p]mute @member1 @member2 spam 5 hours``
+* ``[p]mute @member1 3 days``
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
+
+.. _mutes-command-mutechannel:
+
+^^^^^^^^^^^
+mutechannel
+^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]mutechannel <users...> [time_and_reason]
+
+.. tip:: Alias: ``channelmute``
+
+**Description**
+
+Mute a user in the current text channel.
+
+Examples:
+
+* ``[p]mutechannel @member1 @member2 spam 5 hours``
+* ``[p]mutechannel @member1 3 days``
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
+
+.. _mutes-command-muteset:
+
+^^^^^^^
+muteset
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset 
+
+**Description**
+
+Mute settings.
+
+.. _mutes-command-muteset-defaulttime:
+
+"""""""""""""""""""
+muteset defaulttime
+"""""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset defaulttime [time]
+
+.. tip:: Alias: ``muteset time``
+
+**Description**
+
+Set the default mute time for the mute command.
+
+If no time interval is provided this will be cleared.
+
+**Arguments**
+
+* ``[time]``: The length of time for a default mute.
+
+.. _mutes-command-muteset-forcerole:
+
+"""""""""""""""""
+muteset forcerole
+"""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset forcerole <true_or_false>
+
+**Description**
+
+Whether or not to force role only mutes on the bot.
+
+**Arguments**
+
+* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
+
+.. _mutes-command-muteset-makerole:
+
+""""""""""""""""
+muteset makerole
+""""""""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset makerole <name>
+
+**Description**
+
+Create a Muted role.
+
+This will create a role and apply overwrites to all available channels
+to more easily setup muting a user.
+
+If you already have a muted role created on the server use
+``[p]muteset role ROLE_NAME_HERE``
+
+**Arguments**
+
+* ``<name>``: The name of the muted role to create.
+
+.. _mutes-command-muteset-notification:
+
+""""""""""""""""""""
+muteset notification
+""""""""""""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset notification [channel]
+
+**Description**
+
+Set the notification channel for automatic unmute issues.
+
+If no channel is provided this will be cleared and notifications
+about issues when unmuting users will not be sent anywhere.
+
+**Arguments**
+
+* ``[channel]``: The channel to receive unmute issue updates. |channel-input|
+
+.. _mutes-command-muteset-role:
+
+""""""""""""
+muteset role
+""""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset role [role]
+
+**Description**
+
+Sets the role to be applied when muting a user.
+
+If no role is setup the bot will attempt to mute a user by setting
+channel overwrites in all channels to prevent the user from sending messages.
+
+.. Note:: 
+    
+    If no role is setup a user may be able to leave the server
+    and rejoin no longer being muted.
+
+**Arguments**
+
+* ``[role]``: The role for muted users to receive. |role-input|
+
+.. _mutes-command-muteset-senddm:
+
+""""""""""""""
+muteset senddm
+""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset senddm <true_or_false>
+
+**Description**
+
+Set whether mute notifications should be sent to users in DMs.
+
+**Arguments**
+
+* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
+
+.. _mutes-command-muteset-settings:
+
+""""""""""""""""
+muteset settings
+""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset settings 
+
+.. tip:: Alias: ``muteset showsettings``
+
+**Description**
+
+Shows the current mute settings for this guild.
+
+.. _mutes-command-muteset-showmoderator:
+
+"""""""""""""""""""""
+muteset showmoderator
+"""""""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]muteset showmoderator <true_or_false>
+
+**Description**
+
+Decide whether the name of the moderator muting a user should be included in the DM to that user.
+
+**Arguments**
+
+* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
+
+.. _mutes-command-unmute:
+
+^^^^^^
+unmute
+^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]unmute <users...> [reason]
+
+**Description**
+
+Unmute users.
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[reason]``: The reason for the unmute.
+
+.. _mutes-command-unmutechannel:
+
+^^^^^^^^^^^^^
+unmutechannel
+^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]unmutechannel <users...> [reason]
+
+.. tip:: Alias: ``channelunmute``
+
+**Description**
+
+Unmute a user in this channel.
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[reason]``: The reason for the unmute.
+
+.. _mutes-command-voicemute:
+
+^^^^^^^^^
+voicemute
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]voicemute <users...> [reason]
+
+**Description**
+
+Mute a user in their current voice channel.
+
+Examples:
+
+* ``[p]voicemute @member1 @member2 spam 5 hours``
+* ``[p]voicemute @member1 3 days``
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
+
+.. _mutes-command-voiceunmute:
+
+^^^^^^^^^^^
+voiceunmute
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]voiceunmute <users...> [reason]
+
+**Description**
+
+Unmute a user in their current voice channel.
+
+**Arguments**
+
+* ``<users...>``: A space separated list of usernames, ID's, or mentions.
+* ``[reason]``: The reason for the unmute.

docs/cog_guides/permissions.rst

@@ -0,0 +1,440 @@
+.. _permissions:
+
+===========
+Permissions
+===========
+
+This is the cog guide for the permissions 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 permissions
+
+.. _permissions-usage:
+
+-----
+Usage
+-----
+
+Customise permissions for commands and cogs.
+
+This cog extends the default permission model of the bot. By default, many commands are restricted based on what the command can do.
+This cog allows you to refine some of those restrictions. You can allow wider or narrower access to most commands using it. You cannot, however, change the restrictions on owner-only commands.
+
+When additional rules are set using this cog, those rules will be checked prior to checking for the default restrictions of the command.
+Global rules (set by the owner) are checked first, then rules set for servers. If multiple global or server rules apply to the case, the order they are checked in is:
+
+1. Rules about a user.
+2. Rules about the voice channel a user is 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).
+
+
+.. _permissions-commands:
+
+--------
+Commands
+--------
+
+.. _permissions-command-permissions:
+
+^^^^^^^^^^^
+permissions
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions 
+
+**Description**
+
+Command permission management tools.
+
+.. _permissions-command-permissions-acl:
+
+"""""""""""""""
+permissions acl
+"""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl 
+
+**Description**
+
+Manage permissions with YAML files.
+
+.. tip:: See :ref:`here <cog_permissions>` for more information with configuring these yaml files.
+
+.. _permissions-command-permissions-acl-getglobal:
+
+"""""""""""""""""""""""""
+permissions acl getglobal
+"""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl getglobal 
+
+**Description**
+
+Get a YAML file detailing all global rules.
+
+.. _permissions-command-permissions-acl-getserver:
+
+"""""""""""""""""""""""""
+permissions acl getserver
+"""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl getserver 
+
+**Description**
+
+Get a YAML file detailing all rules in this server.
+
+.. _permissions-command-permissions-acl-setglobal:
+
+"""""""""""""""""""""""""
+permissions acl setglobal
+"""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl setglobal 
+
+**Description**
+
+Set global rules with a YAML file.
+
+.. warning::    
+    This will override reset *all* global rules
+    to the rules specified in the uploaded file.
+
+This does not validate the names of commands and cogs before
+setting the new rules.
+
+.. _permissions-command-permissions-acl-setserver:
+
+"""""""""""""""""""""""""
+permissions acl setserver
+"""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl setserver 
+
+**Description**
+
+Set rules for this server with a YAML file.
+
+.. warning::    
+    This will override reset *all* rules in this
+    server to the rules specified in the uploaded file.
+
+.. _permissions-command-permissions-acl-updateglobal:
+
+""""""""""""""""""""""""""""
+permissions acl updateglobal
+""""""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl updateglobal 
+
+**Description**
+
+Update global rules with a YAML file.
+
+This won't touch any rules not specified in the YAML
+file.
+
+.. _permissions-command-permissions-acl-updateserver:
+
+""""""""""""""""""""""""""""
+permissions acl updateserver
+""""""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl updateserver 
+
+**Description**
+
+Update rules for this server with a YAML file.
+
+This won't touch any rules not specified in the YAML
+file.
+
+.. _permissions-command-permissions-acl-yamlexample:
+
+"""""""""""""""""""""""""""
+permissions acl yamlexample
+"""""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions acl yamlexample 
+
+**Description**
+
+Sends an example of the yaml layout for permissions
+
+.. _permissions-command-permissions-addglobalrule:
+
+"""""""""""""""""""""""""
+permissions addglobalrule
+"""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions addglobalrule <allow_or_deny> <cog_or_command> <who_or_what...>
+
+**Description**
+
+Add a global rule to a cog or command.
+
+**Arguments**
+
+* ``<allow_or_deny>``: This should be one of "allow" or "deny".
+* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
+
+.. _permissions-command-permissions-addserverrule:
+
+"""""""""""""""""""""""""
+permissions addserverrule
+"""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions addserverrule <allow_or_deny> <cog_or_command> <who_or_what...>
+
+**Description**
+
+Add a rule to a cog or command in this server.
+
+**Arguments**
+
+* ``<allow_or_deny>``: This should be one of "allow" or "deny".
+* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
+
+.. _permissions-command-permissions-canrun:
+
+""""""""""""""""""
+permissions canrun
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions canrun <user> <command>
+
+**Description**
+
+Check if a user can run a command.
+
+This will take the current context into account, such as the
+server and text channel.
+
+**Arguments**
+
+* ``<user>``: The user to check permissions for.
+* ``<command>``: The command to check whether the user can run it or not.
+
+.. _permissions-command-permissions-clearglobalrules:
+
+""""""""""""""""""""""""""""
+permissions clearglobalrules
+""""""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions clearglobalrules 
+
+**Description**
+
+Reset all global rules.
+
+.. _permissions-command-permissions-clearserverrules:
+
+""""""""""""""""""""""""""""
+permissions clearserverrules
+""""""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions clearserverrules 
+
+**Description**
+
+Reset all rules in this server.
+
+.. _permissions-command-permissions-explain:
+
+"""""""""""""""""""
+permissions explain
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions explain 
+
+**Description**
+
+Explain how permissions works.
+
+.. _permissions-command-permissions-removeglobalrule:
+
+""""""""""""""""""""""""""""
+permissions removeglobalrule
+""""""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions removeglobalrule <cog_or_command> <who_or_what...>
+
+**Description**
+
+Remove a global rule from a command.
+
+**Arguments**
+
+* ``<cog_or_command>``: The cog or command to remove the rule from. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
+
+.. _permissions-command-permissions-removeserverrule:
+
+""""""""""""""""""""""""""""
+permissions removeserverrule
+""""""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions removeserverrule <cog_or_command> <who_or_what...>
+
+**Description**
+
+Remove a server rule from a command.
+
+**Arguments**
+
+* ``<cog_or_command>``: The cog or command to remove the rule from. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
+
+.. _permissions-command-permissions-setdefaultglobalrule:
+
+""""""""""""""""""""""""""""""""
+permissions setdefaultglobalrule
+""""""""""""""""""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions setdefaultglobalrule <allow_or_deny> <cog_or_command>
+
+**Description**
+
+Set the default global rule for a command or a cog.
+
+This is the rule a command will default to when no other rule
+is found.
+
+**Arguments**
+
+* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
+
+.. _permissions-command-permissions-setdefaultserverrule:
+
+""""""""""""""""""""""""""""""""
+permissions setdefaultserverrule
+""""""""""""""""""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]permissions setdefaultserverrule <allow_or_deny> <cog_or_command>
+
+**Description**
+
+Set the default rule for a command or a cog in this server.
+
+This is the rule a command will default to when no other rule
+is found.
+
+**Arguments**
+
+* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
+* ``<who_or_what...>``: One or more users, channels or roles the rule is for.

docs/cog_guides/reports.rst

@@ -0,0 +1,141 @@
+.. _reports:
+
+=======
+Reports
+=======
+
+This is the cog guide for the reports 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 reports
+
+.. _reports-usage:
+
+-----
+Usage
+-----
+
+Create user reports that server staff can respond to.
+
+Users can open reports using ``[p]report``. These are then sent
+to a channel in the server for staff, and the report creator
+gets a DM. Both can be used to communicate.
+
+
+.. _reports-commands:
+
+--------
+Commands
+--------
+
+.. _reports-command-report:
+
+^^^^^^
+report
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]report [text]
+
+**Description**
+
+Send a report.
+
+Use without arguments for interactive reporting, or do
+``[p]report [text]`` to use it non-interactively.
+
+**Arguments**
+
+* ``[text]``: The content included within the report.
+
+.. _reports-command-report-interact:
+
+"""""""""""""""
+report interact
+"""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]report interact <ticket_number>
+
+**Description**
+
+Open a message tunnel.
+
+This tunnel will forward things you say in this channel
+to the ticket opener's direct messages.
+
+Tunnels do not persist across bot restarts.
+
+**Arguments**
+
+* ``<ticket_number>``: The ticket number to open the tunnel in.
+
+.. _reports-command-reportset:
+
+^^^^^^^^^
+reportset
+^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reportset 
+
+**Description**
+
+Manage Reports.
+
+.. _reports-command-reportset-output:
+
+""""""""""""""""
+reportset output
+""""""""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reportset output <channel>
+
+**Description**
+
+Set the channel where reports will be sent.
+
+**Arguments**
+
+* ``<channel>``: |channel-input|
+
+.. _reports-command-reportset-toggle:
+
+""""""""""""""""
+reportset toggle
+""""""""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reportset toggle 
+
+**Description**
+
+Enable or disable reporting for this server.  

docs/cog_guides/streams.rst

@@ -27,7 +27,6 @@ Supported streaming services are:
 
 - Twitch
 - Youtube
-- Smashcast
 - Picarto
 
 Youtube and Twitch both require setting authentication 
@@ -201,7 +200,10 @@ Use ``{mention}`` in the message to insert the selected mentions.
 
 Use ``{stream}`` in the message to insert the channel or user name.
 
-For example: ``[p]streamset message mention {mention}, {stream} is live!``
+Use ``{stream.display_name}`` in the message to insert the channel's display name
+(on Twitch, this may be different from ``{stream}``).
+
+For example: ``[p]streamset message mention {mention}, {stream.display_name} is live!``
 
 **Arguments**
 
@@ -225,7 +227,10 @@ Sets a stream alert message for when mentions are disabled.
 
 Use ``{stream}`` in the message to insert the channel or user name.
 
-For example: ``[p]streamset message nomention {stream} is live!``
+Use ``{stream.display_name}`` in the message to insert the channel's display name
+(on Twitch, this may be different from ``{stream}``).
+
+For example: ``[p]streamset message nomention {stream.display_name} is live!``
 
 **Arguments**
 
@@ -353,26 +358,6 @@ Check if a Picarto channel is live.
 
 * ``<channel_name>``: The Picarto channel to check.
 
-.. _streams-command-smashcast:
-
-^^^^^^^^^
-smashcast
-^^^^^^^^^
-
-**Syntax**
-
-.. code-block:: none
-    
-    [p]smashcast <channel_name>
-
-**Description**
-
-Check if a Smashcast channel is live.
-
-**Arguments**
-
-* ``<channel_name>``: The Smashcast channel to check.
-
 .. _streams-command-twitchstream:
 
 ^^^^^^^^^^^^
@@ -466,27 +451,6 @@ specified Picarto channel.
 
 * ``<channel_name>``: The Picarto channel to toggle the alert for.
 
-.. _streams-command-streamalert-smashcast:
-
-^^^^^^^^^^^^^^^^^^^^^
-streamalert smashcast
-^^^^^^^^^^^^^^^^^^^^^
-
-**Syntax**
-
-.. code-block:: none
-    
-    [p]streamalert smashcast <channel_name>
-
-**Description**
-
-Toggle alerts in the current channel for the 
-specified Smashcast channel.
-
-**Arguments**
-
-* ``<channel_name>``: The Smashcast channel to toggle the alert for.
-
 .. _streams-command-streamalert-twitch-channel:
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/cog_guides/trivia.rst

@@ -247,6 +247,11 @@ triviaset custom
 
 Manage custom trivia lists.
 
+.. tip:: 
+
+    Looking to learn how to create your own trivia lists?
+    See :ref:`here <guide_trivia_list_creation>` for more information.
+
 .. _trivia-command-triviaset-custom-upload:
 
 ^^^^^^^^^^^^^^^^^^^^^^^

docs/cog_guides/warnings.rst

@@ -0,0 +1,403 @@
+.. _warnings:
+
+========
+Warnings
+========
+
+This is the cog guide for the warnings 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 warnings
+
+.. _warnings-usage:
+
+-----
+Usage
+-----
+
+Warn misbehaving users and take automated actions.
+
+
+.. _warnings-commands:
+
+--------
+Commands
+--------
+
+.. _warnings-command-actionlist:
+
+^^^^^^^^^^
+actionlist
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]actionlist 
+
+**Description**
+
+List all configured automated actions for Warnings.
+
+.. _warnings-command-mywarnings:
+
+^^^^^^^^^^
+mywarnings
+^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]mywarnings 
+
+**Description**
+
+List warnings for yourself.
+
+.. _warnings-command-reasonlist:
+
+^^^^^^^^^^
+reasonlist
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reasonlist 
+
+**Description**
+
+List all configured reasons for Warnings.
+
+.. _warnings-command-unwarn:
+
+^^^^^^
+unwarn
+^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]unwarn <member> <warn_id> [reason]
+
+**Description**
+
+Remove a warning from a member.
+
+**Arguments**
+
+* ``<member>``: The member to remove the warning from. |member-input-quotes|
+* ``<warn_id>``: The warning ID to remove from the member.
+* ``[reason]``: The reason for unwarning this member.
+
+.. _warnings-command-warn:
+
+^^^^
+warn
+^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warn <member> [points=1] <reason>
+
+**Description**
+
+Warn the user for the specified reason.
+
+**Arguments**
+
+* ``<member>``: The member to warn. |member-input-quotes|
+* ``[points]``: The number of points the warning should be for. If no number is supplied, 1 point will be given. Pre-set warnings disregard this.
+* ``<reason>``: The reason for the warning. This can be a registered reason, or a custom reason if ``[p]warningset allowcustomreasons`` is set.
+
+.. _warnings-command-warnaction:
+
+^^^^^^^^^^
+warnaction
+^^^^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnaction 
+
+**Description**
+
+Manage automated actions for Warnings.
+
+Actions are essentially command macros. Any command can be run
+when the action is initially triggered, and/or when the action
+is lifted.
+
+Actions must be given a name and a points threshold. When a
+user is warned enough so that their points go over this
+threshold, the action will be executed.
+
+.. _warnings-command-warnaction-add:
+
+""""""""""""""
+warnaction add
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnaction add <name> <points>
+
+**Description**
+
+Create an automated action.
+
+Duplicate action names are not allowed.
+
+**Arguments**
+
+* ``<name>``: The name of the action.
+* ``<points>``: The number of points for this action.
+
+.. _warnings-command-warnaction-delete:
+
+"""""""""""""""""
+warnaction delete
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnaction delete <action_name>
+
+**Description**
+
+Delete the action with the specified name.
+
+**Arguments**
+
+* ``<action_name>``: The name of the action to delete.
+
+.. _warnings-command-warnings:
+
+^^^^^^^^
+warnings
+^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnings <member>
+
+**Description**
+
+List the warnings for the specified member.
+
+**Arguments**
+
+* ``<member>``: The member to get the warnings for. |member-input|
+
+.. _warnings-command-warningset:
+
+^^^^^^^^^^
+warningset
+^^^^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset 
+
+**Description**
+
+Manage settings for Warnings.
+
+.. _warnings-command-warningset-allowcustomreasons:
+
+"""""""""""""""""""""""""""""
+warningset allowcustomreasons
+"""""""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset allowcustomreasons <true_or_false>
+
+**Description**
+
+Enable or disable custom reasons for a warning.
+
+**Arguments**
+
+* ``<true_or_false>``: |bool-input|
+
+.. _warnings-command-warningset-senddm:
+
+"""""""""""""""""
+warningset senddm
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset senddm <true_or_false>
+
+**Description**
+
+Set whether warnings should be sent to users in DMs.
+
+**Arguments**
+
+* ``<true_or_false>``: |bool-input|
+
+.. _warnings-command-warningset-showmoderator:
+
+""""""""""""""""""""""""
+warningset showmoderator
+""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset showmoderator <true_or_false>
+
+**Description**
+
+Decide whether the name of the moderator warning a user should be included in the DM to that user.
+
+**Arguments**
+
+* ``<true_or_false>``: |bool-input|
+
+.. _warnings-command-warningset-usewarnchannel:
+
+"""""""""""""""""""""""""
+warningset usewarnchannel
+"""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset usewarnchannel <true_or_false>
+
+**Description**
+
+Set if warnings should be sent to a channel set with ``[p]warningset warnchannel``.
+
+**Arguments**
+
+* ``<true_or_false>``: |bool-input|
+
+.. _warnings-command-warningset-warnchannel:
+
+""""""""""""""""""""""
+warningset warnchannel
+""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warningset warnchannel [channel]
+
+**Description**
+
+Set the channel where warnings should be sent to.
+
+**Arguments**
+
+* ``[channel]``: |channel-input| Leave empty to use the channel ``[p]warn`` command was called in.
+
+.. _warnings-command-warnreason:
+
+^^^^^^^^^^
+warnreason
+^^^^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnreason 
+
+**Description**
+
+Manage warning reasons.
+
+Reasons must be given a name, description and points value. The
+name of the reason must be given when a user is warned.
+
+.. _warnings-command-warnreason-create:
+
+"""""""""""""""""
+warnreason create
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnreason create <name> <points> <description>
+
+.. tip:: Alias: ``warnreason add``
+
+**Description**
+
+Create a warning reason.
+
+**Arguments**
+
+* ``<name>``: The name for the new reason.
+* ``<points>``: The number of points with the new reason.
+* ``<description>``: The description of the new warn reason.
+
+.. _warnings-command-warnreason-delete:
+
+"""""""""""""""""
+warnreason delete
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]warnreason delete <reason_name>
+    
+**Description**
+
+Delete a warning reason.
+
+**Arguments**
+
+* ``<reason_name>``: The name of the reason to delete.

docs/cog_permissions.rst

@@ -1,4 +1,5 @@
 .. Permissions Cog Reference
+.. _cog_permissions:
 
 =========================
 Permissions Cog Reference

docs/conf.py

@@ -86,10 +86,16 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    # to ensure that include files (partial pages) aren't built, exclude them
+    "**/_includes/**",
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = "default"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -111,6 +117,12 @@ rst_prolog += f"\n.. |DPY_VERSION| replace:: {dpy_version}"
 #
 html_theme = "sphinx_rtd_theme"
 
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+html_extra_path = ["_html"]
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -218,6 +230,7 @@ intersphinx_mapping = {
     "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),
 }
 
 # Extlinks

docs/getting_started.rst

@@ -13,7 +13,7 @@ This is a quick start guide for a general usage.
 .. note::
 
     If you haven't installed Red, please do it by following
-    the :ref:`installation guides <main>`.
+    one of the `installation guides <install_guides/index>`.
 
 Assuming you correctly installed Red, you should have a
 window like this:
@@ -26,8 +26,8 @@ window like this:
 Invite Red to your server
 -------------------------
 
-When started, the console will show you ``Invite URL`` (here at
-the bottom of the screenshot).
+When started, the console will show you the ``Invite URL``
+(visible at the bottom of the screenshot above).
 Paste the link into your browser and select the server you want
 to invite the bot in, like any other bot.
 
@@ -63,7 +63,7 @@ example, if your prefix is ``!``, you will execute your command like this:
 The commands
 ~~~~~~~~~~~~
 
-The command you're going to use the most is help. That command will
+The command you're going to use the most is **help**. This command will
 show you **all of the available commands** of the bot with a small description.
 
 .. code-block:: none
@@ -106,8 +106,8 @@ parameters.
     the syntax ``cleanup messages <number> [delete_pinned=False]``, which means
     ``delete_pinned`` default will be false, unless you specify it as true.
 
-You can use help to show the **categories** too, generally called cogs.
-Just do something like this (notice the capitalization):
+You can use help to show the **categories** too, generally called cogs,
+by doing the following (notice the capitalization):
 
 .. code-block:: none
 
@@ -122,7 +122,7 @@ To get the description of a subcommand, type this:
 
 When using subcommands, you also need to specify the command group.
 As an example, ``cleanup`` has 6 subcommands. If you want
-to use one, do it like this: ``[p]cleanup messages 10``
+to use one of them, do: ``[p]cleanup messages 10``
 
 .. _getting-started-cogs:
 
@@ -217,7 +217,7 @@ Server owner
 ~~~~~~~~~~~~
 
 The server owner can access all commands on his guild, except the global
-ones or those who can interact with system files (available for the
+ones or those that can interact with system files (available for the
 bot owner).
 
 ~~~~~~~~~~~~~
@@ -237,12 +237,13 @@ Moderator
 A moderator is a step above the average users. You can set multiple moderator
 roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands.
 
-For example, in the mod cog (again), a mod will be able to mute, kick and ban;
-but he won't be able to modify the cog settings with the ``[p]modset`` command.
+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
+not be able to modify the cog settings with the ``[p]filterset`` command.
 
 .. tip::
     If you don't like the default permission settings for some commands or
-    if want to restrict a cog or a command to a channel/member, you can use
+    want to restrict a cog or a command to a channel/member, you can use
     the permissions cog.
 
 .. _getting-started-hosting:
@@ -253,9 +254,9 @@ Hosting
 
 If you are hosting Red on your personal computer, you will soon notice that
 if you close the window or if you shut down you computer, Red will be offline.
-She needs an environment to work and respond.
+It needs an environment to work and respond.
 
-You can try to host Red somewhere she will always be online, like on a virtual
+You can try to host Red somewhere it will always be online, like on a virtual
 private server (VPS) or on a personal server (e.g. Raspberry Pi).
 
 If you want to do it, follow these steps.
@@ -265,14 +266,14 @@ If you want to do it, follow these steps.
     basics of the Unix commands, such as navigating the system files or use
     a terminal text editor.
 
-    You should follow `this guide
+    You should read `DigitalOcean's tutorial: An Introduction to Linux Basics
     <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
-    from DigitalOcean which will introduce you to the Linux basics.
+    if you have not used Linux before.
 
 1. **Find a host**
 
   You need to find a server to host Red. You can rent a VPS (it can be free)
-  on an online service. Please check :ref:`this page <host-list>` for
+  on an online service. Please check :ref:`this list of hosts <host-list>` for
   more information.
 
   You can also buy a Raspberry Pi (~$20), which is a micro-computer that will
@@ -281,7 +282,7 @@ If you want to do it, follow these steps.
 2. **Install Linux**
 
   Most of the VPS providers have tools for installing Linux automatically. If
-  you're a beginner, we recommend **Ubuntu 20.04 LTS**.
+  you're a beginner, we recommend **Ubuntu 22.04 LTS**.
 
   For Raspberry Pi users, just install `Raspbian
   <https://www.raspberrypi.org/software/>`_ on a micro-SD card.
@@ -306,8 +307,8 @@ If you want to do it, follow these steps.
 
 3. **Install and set up Red**
 
-  Just follow one of the Linux installation guide. We provide guides for the
-  most used distributions. Check the :ref:`home page <main>` and search for
+  Follow one of the Linux installation guides. We provide guides for the
+  most used distributions. Check the `list of install guides <install_guides/index>` and search for
   your distribution.
 
 4. **Set up an auto-restart**
@@ -317,7 +318,7 @@ If you want to do it, follow these steps.
   side task and handle fatal errors, so you can just leave your server running
   and enjoy Red!
 
-  For that, just follow :ref:`this guide <systemd-service-guide>`.
+  For that, follow :ref:`the systemd service guide <systemd-service-guide>`.
 
 .. _getting-started-userdocs:
 
@@ -343,9 +344,12 @@ The cog guides are formatted the same. They're divided into 3 sections:
 
     A line that will show how the command must be invoked, with the arguments.
 
-    .. tip:: If the command show something like ``[lavalinkset|llset]``, that means
-        you can invoke the command with ``lavalinkset`` or with ``llset``, this is
-        called an alias.
+  * **Aliases**
+  
+    Each command may have one or more aliases, which are alternative command names
+    you can use to invoke the same command. For example, ``[p]set colour`` can also
+    be invoked with ``[p]set color``. If there are aliases for a command, they will
+    appear just under the syntax.
 
   * **Description**
 

docs/guide_cog_creation.rst

@@ -86,6 +86,9 @@ In that file, place the following code:
     class MyCog(commands.Cog):
         """My custom cog"""
 
+        def __init__(self, bot):
+            self.bot = bot
+
         @commands.command()
         async def mycom(self, ctx):
             """This does stuff!"""
@@ -100,7 +103,7 @@ Open :code:`__init__.py`. In that file, place the following:
 
 
     def setup(bot):
-        bot.add_cog(MyCog())
+        bot.add_cog(MyCog(bot))
 
 Make sure that both files are saved.
 

docs/guide_cog_creators.rst

@@ -17,7 +17,7 @@ Creating a Cog Creator Application
   You will need to have created and published your cogs before you create a Cog Creator Application!
   See `guide_cog_creation` and `guide_publish_cogs` for more information.
 
-Cog Creator Applications are hosted on the `cogboard <https://cogboard.red/c/apps/12>`__.
+Cog Creator Applications are hosted on the `cogboard <https://cogboard.discord.red/c/apps/12>`__.
 To create an application, start a new topic in the "Applications" category and fill out all of the required information.
 QA reviews Cog Creator Applications for security and functionality on a first come, first serve basis.
 Once your application is reviewed, you will have 14 days to make any requested changes, or to check in with the member of QA who is reviewing your application.

docs/guide_trivia_list_creation.rst

@@ -0,0 +1,125 @@
+.. _guide_trivia_list_creation:
+
+==========================
+Trivia List Creation Guide
+==========================
+
+The Trivia cog allows you to create your own "trivia lists", 
+which are then processed in the cog - allowing you to create as
+many questions as you'd like, with easy to use syntax.
+
+---------------
+Getting Started
+---------------
+
+Let's start off by creating a file named ``mytrivia.yaml``.
+Our trivia list will be named after the file, so in this case,
+it will be called ``mytrivia``.
+
+------------
+Author Field
+------------
+
+We should first include an ``AUTHOR`` field,
+to let the user know who wrote the questions.
+
+When the user starts the trivia, the author(s) will
+be sent in the starting message (see below).
+
+.. image:: .resources/trivia/trivia_author.png
+
+The following should be placed at the top of your file, replacing "Red" 
+with your name:
+
+.. code-block:: yaml
+
+    AUTHOR: Red
+
+If there are multiple authors, we can separate them with commas.
+
+.. code-block:: yaml
+
+    AUTHOR: Red, Rojo, Rouge
+
+---------------------
+Questions and Answers
+---------------------
+
+Writing questions and answers is simple. Once you've finished your
+``AUTHOR`` field, you can move on to your questions just below.
+
+Questions should consist of at least one answer, with other
+possible answers included if necessary. You must put a colon at the end 
+of the question, for example:
+
+.. code-block:: yaml
+
+    How many days are there in a regular year?:
+
+Answers will follow below, each separated by a line break and with a
+hyphen at the start of the line.
+
+.. code-block:: yaml
+
+    How many days are there in a regular year?:
+    - 365
+    - three hundred and sixty five
+
+It's always nice to include alternative answers if a question needs it. 
+We can add as many valid answers as we'd like below this question. Answers
+are **NOT** case sensitive, so you don't need to worry about adding the same
+answer multiple times in different casings.
+
+There are multiple special characters in YAML, such as colons, hashtags, hyphens
+and more. If these characters are included within our questions or answers,
+you'll need to enclose the content with quotation marks.
+
+.. code-block:: yaml
+
+    "Who is the #1 followed user on Twitter?":
+
+If we didn't have these quotation marks, the question would not render.
+
+.. code-block:: yaml
+
+    Who is the #1 followed user on Twitter?:
+
+.. tip::
+
+    We can also include line breaks within our questions by using ``\n``, like
+    this for example:
+
+    .. code-block:: yaml 
+
+        "My first line\nMy second line":
+
+As you've added more questions, your file should look something like this:
+
+.. code-block:: yaml
+
+    AUTHOR: Red
+    How many days are there in a regular year?:
+    - 365
+    - three hundred and sixty five
+    "Who is the #1 followed user on Twitter?":
+    - Barack Obama
+    - Obama
+    What is the only sea without any coasts?:
+    - Sargasso
+    - Sargasso Sea
+    Who won the Premier League in 2015?:
+    - Chelsea
+    - chelsea f.c.
+    How much money is a US Olympic gold medalist awarded?:
+    - $25,000
+    - 25,000
+    - 25k
+    - 25000
+    - $25000
+
+You can keep adding questions until you are satisfied, and then you can upload and
+play your very own trivia! See :ref:`[p]triviaset custom <trivia-command-triviaset-custom>` for more information.
+
+Still stuck? Take a look at 
+`the core trivia lists <https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop/redbot/cogs/trivia/data/lists>`_
+for reference.

docs/host-list.rst

@@ -8,7 +8,7 @@ Hosting Information
 
 .. note::
     This doc is written for the :ref:`hosting section <getting-started-hosting>`
-    of the :ref:`getting started <getting-started>` guide. Please take a look
+    of the :ref:`getting started guide <getting-started>`. Please take a look
     if you don't know how to host Red.
 
 
@@ -21,7 +21,7 @@ First, we would like to make something clear:
 .. warning::
     Due to their inability to handle Red's data structure and meet the
     conditions of being a supported platform; platforms such as Heroku, 
-    Pterodactyl, repl.it, Termux, LXC and alike are **NOT** officially supported. 
+    Pterodactyl, repl.it, Termux and alike are **NOT** officially supported. 
     Docker support found in GitHub is also a work in progress and not ready
     for daily use. Workarounds for getting Red running on those platforms
     are imperfect due to Red's nature. You will not be able to receive
@@ -41,9 +41,9 @@ Hosting on a VPS or Dedicated Server
 
 .. warning::
     Please be aware that a Linux server is controlled through a command line.
-    If you don't know Unix basics, please take a look at `this guide
-    <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
-    from DigitalOcean which will introduce you to the Linux basics.
+    If you don't know Unix basics, please take a look at
+    `DigitalOcean's tutorial: An Introduction to Linux Basics
+    <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_.
 
 
 ------------
@@ -103,10 +103,10 @@ Average Providers
  with locations available worldwide.
 
 | `Hetzner Online <https://www.hetzner.com/>`_ is a German VPS and dedicated server
- provider with locations in Germany and Finland.
+ provider with locations in Germany, US and Finland.
 
 | `Contabo <https://contabo.com/>`_ is also a German VPS and dedicated server provider
- with locations in Germany and the United States.
+ with locations in Germany, Asia and the United States.
 
 | `Ramnode <https://www.ramnode.com/>`_ is a US based VPS provider focused on
  low to middle end VPS with locations in the US and Netherlands.
@@ -145,6 +145,7 @@ Free Hosting
  Oracle Cloud and Google Cloud offer always free tiers with limited resources.
 
 | Additionally, new Google Cloud customers get a $300 credit which is valid for 3 months.
+ New Oracle Cloud customers also get $300 of free credit, but only valid for 30 days.
 
 | Excluding the above, there is no recommended free VPS host. Persuasion of
  another individual for hosting Red is an option, albeit low in success rate.

docs/index.rst

@@ -12,13 +12,12 @@ Welcome to Red - Discord Bot's documentation!
     :maxdepth: 1
     :caption: Installation Guides:
 
-    install_windows
-    install_linux_mac
+    install_guides/index
     bot_application_guide
     update_red
     about_venv
     autostart_systemd
-    autostart_pm2
+    autostart_mac
 
 .. toctree::
     :maxdepth: 2
@@ -26,25 +25,34 @@ Welcome to Red - Discord Bot's documentation!
 
     cog_customcom
     cog_permissions
+    guide_trivia_list_creation
 
 .. toctree::
     :maxdepth: 2
     :caption: User guides:
 
     getting_started
+    intents
     cog_guides/admin
     cog_guides/alias
     cog_guides/bank
     cog_guides/cleanup
     cog_guides/cog_manager_ui
+    cog_guides/core
     cog_guides/customcommands
     cog_guides/downloader
     cog_guides/economy
     cog_guides/filter
     cog_guides/general
     cog_guides/image
+    cog_guides/permissions
+    cog_guides/mod
+    cog_guides/modlog
+    cog_guides/mutes
+    cog_guides/reports
     cog_guides/streams
     cog_guides/trivia
+    cog_guides/warnings
     red_core_data_statement
 
 .. toctree::

docs/install_guides/_includes/_install-pyenv-and-setup-path.rst

@@ -0,0 +1,19 @@
+To install/update pyenv, run the following command:
+
+.. prompt:: bash
+
+    command -v pyenv && pyenv update || curl https://pyenv.run | bash
+
+After this command, you will see a warning about 'pyenv' not being in the load path. To address this,
+you should run these commands:
+
+.. prompt:: bash
+
+    profile=$([ -n "$ZSH_VERSION" ] && echo ~/.zprofile || ([ -f ~/.bash_profile ] && echo ~/.bash_profile || echo ~/.profile))
+    rcfile=$([ -n "$ZSH_VERSION" ] && echo ~/.zshrc || echo ~/.bashrc)
+    printf '%s\n%s\n%s\n' 'export PYENV_ROOT="$HOME/.pyenv"' 'export PATH="$PYENV_ROOT/bin:$PATH"' "$([ -f "$profile" ] && cat "$profile")" > "$profile"
+    echo 'eval "$(pyenv init --path)"' >> "$profile"
+    echo 'eval "$(pyenv init -)"' >> "$rcfile"
+    echo 'eval "$(pyenv virtualenv-init -)"' >> "$rcfile"
+
+Then **log out and log back in** and run the following command:

docs/install_guides/_includes/create-env-with-pyenv-virtualenv.rst

@@ -0,0 +1,44 @@
+------------------------------
+Creating a Virtual Environment
+------------------------------
+
+.. tip::
+
+    If you want to learn more about virtual environments, see page: `about-venvs`
+
+We require installing Red into a virtual environment. Don't be scared, it's very
+straightforward.
+
+**************************
+Using ``pyenv virtualenv``
+**************************
+
+Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
+environments. This option is only available if you installed Python with pyenv.
+
+First, ensure your pyenv interpreter is set to python 3.8.1 or greater with the following command:
+
+.. prompt:: bash
+
+    pyenv version
+
+Now, create a virtual environment with the following command:
+
+.. prompt:: bash
+
+    pyenv virtualenv <name>
+
+Replace ``<name>`` with whatever you like. If you ever forget what you named it,
+you can always use the command ``pyenv versions`` to list all virtual environments.
+
+Now activate your virtualenv with the following command:
+
+.. prompt:: bash
+
+    pyenv shell <name>
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red. You can check out other commands like ``pyenv local`` and
+    ``pyenv global`` if you wish to keep the virtualenv activated all the time.

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

@@ -0,0 +1,38 @@
+------------------------------
+Creating a Virtual Environment
+------------------------------
+
+.. tip::
+
+    If you want to learn more about virtual environments, see page: `about-venvs`
+
+We require installing Red into a virtual environment. Don't be scared, it's very
+straightforward.
+
+**************
+Using ``venv``
+**************
+
+This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
+python.
+
+First, choose a directory where you would like to create your virtual environment. It's a good idea
+to keep it in a location which is easy to type out the path to. From now, we'll call it
+``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/install-and-setup-red-unix.rst

@@ -0,0 +1,52 @@
+--------------
+Installing Red
+--------------
+
+Choose one of the following commands to install Red.
+
+To install without additional config backend support:
+
+.. prompt:: bash
+    :prompts: (redenv) $
+
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U Red-DiscordBot
+
+Or, to install with PostgreSQL support:
+
+.. prompt:: bash
+    :prompts: (redenv) $
+
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U "Red-DiscordBot[postgres]"
+
+
+--------------------------
+Setting Up and Running Red
+--------------------------
+
+After installation, set up your instance with the following command:
+
+.. prompt:: bash
+    :prompts: (redenv) $
+
+    redbot-setup
+
+This will set the location where data will be stored, as well as your
+storage backend and the name of the instance (which will be used for
+running the bot).
+
+Once done setting up the instance, run the following command to run Red:
+
+.. prompt:: bash
+    :prompts: (redenv) $
+
+    redbot <your instance name>
+
+It will walk through the initial setup, asking for your token and a prefix.
+You can find out how to obtain a token with
+`this guide <../bot_application_guide>`.
+
+.. tip::
+   If it's the first time you're using Red, you should check our `getting-started` guide
+   that will walk you through all essential information on how to interact with Red.

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

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

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

@@ -0,0 +1,18 @@
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+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:
+
+.. prompt:: bash
+
+    sudo dnf -y install python39 git java-11-openjdk-headless @development nano
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

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

@@ -0,0 +1,27 @@
+----------------------------
+Installing Python with pyenv
+----------------------------
+
+On distributions where Python 3.9 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.
+
+.. include:: _includes/_install-pyenv-and-setup-path.rst
+
+.. prompt:: bash
+
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.9.13 -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
+the ``CONFIGURE_OPTS=--enable-optimizations`` part from the front of the command, which will
+drastically reduce the install time. However, be aware that this will make Python run about 10%
+slower.
+
+After that is finished, run:
+
+.. prompt:: bash
+
+    pyenv global 3.9.13
+
+Pyenv is now installed and your system should be configured to run Python 3.9.

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

@@ -0,0 +1,27 @@
+----------------------------
+Installing Python with 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.
+
+.. include:: _includes/_install-pyenv-and-setup-path.rst
+
+.. prompt:: bash
+
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.12 -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
+the ``CONFIGURE_OPTS=--enable-optimizations`` part from the front of the command, which will
+drastically reduce the install time. However, be aware that this will make Python run about 10%
+slower.
+
+After that is finished, run:
+
+.. prompt:: bash
+
+    pyenv global 3.8.12
+
+Pyenv is now installed and your system should be configured to run Python 3.8.

docs/install_guides/_includes/linux-preamble.rst

@@ -0,0 +1,5 @@
+.. warning::
+
+    For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
+    a new user on Linux, see `DigitalOcean's tutorial: How To Create a New Sudo-enabled User
+    <https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart>`_.

docs/install_guides/alma-linux-8.rst

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

docs/install_guides/alma-linux-9.rst

@@ -0,0 +1,7 @@
+.. _install-alma-linux-9:
+
+==============================
+Installing Red on Alma Linux 9
+==============================
+
+.. include:: _includes/install-guide-rhel9-derivatives.rst

docs/install_guides/arch.rst

@@ -0,0 +1,35 @@
+.. _install-arch:
+
+============================
+Installing Red on Arch Linux
+============================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Install the pre-requirements with pacman:
+
+.. prompt:: bash
+
+    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.
+
+The manual build process is the Arch-supported install method for AUR packages. You can install ``python39`` package with the following commands:
+
+.. prompt:: bash
+
+    git clone https://aur.archlinux.org/python39.git /tmp/python39
+    cd /tmp/python39
+    makepkg -sicL
+    cd -
+    rm -rf /tmp/python39
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/centos-7.rst

@@ -0,0 +1,42 @@
+.. _install-centos-7:
+
+==========================
+Installing Red on CentOS 7
+==========================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Install the pre-requirements with yum:
+
+.. prompt:: bash
+
+    sudo yum -y groupinstall development
+    sudo yum -y install gcc zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel tk-devel libffi-devel xz-devel java-11-openjdk-headless nano git
+
+In order to install gcc 8, we'll use SCL repository:
+
+.. prompt:: bash
+
+    sudo yum -y install centos-release-scl
+    sudo yum -y install devtoolset-8-gcc devtoolset-8-gcc-c++
+    echo "source scl_source enable devtoolset-8" >> ~/.bashrc
+    source ~/.bashrc
+
+In order to install Git 2.11 or greater, we recommend adding the IUS repository:
+
+.. prompt:: bash
+
+    sudo yum -y install https://repo.ius.io/ius-release-el7.rpm
+    sudo yum -y swap git git236
+
+.. 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/centos-stream-8.rst

@@ -0,0 +1,7 @@
+.. _install-centos-stream-8:
+
+=================================
+Installing Red on CentOS Stream 8
+=================================
+
+.. include:: _includes/install-guide-rhel8-derivatives.rst

docs/install_guides/centos-stream-9.rst

@@ -0,0 +1,7 @@
+.. _install-centos-stream-9:
+
+=================================
+Installing Red on CentOS Stream 9
+=================================
+
+.. include:: _includes/install-guide-rhel9-derivatives.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

@@ -0,0 +1,25 @@
+.. _install-debian-11:
+
+====================================
+Installing Red on Debian 11 Bullseye
+====================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Debian 11 "Bullseye" 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 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/fedora.rst

@@ -0,0 +1,24 @@
+.. _install-fedora:
+
+==============================
+Installing Red on Fedora Linux
+==============================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Fedora Linux 35 and above has all required packages available in official repositories. Install
+them with dnf:
+
+.. prompt:: bash
+
+    sudo dnf -y install python39 git java-11-openjdk-headless @development-tools nano
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/index.rst

@@ -0,0 +1,38 @@
+.. _install-guides:
+
+Installing Red
+==============
+
+The list below shows the installation guides available based on the operating system being used.
+
+If you want to host Red on a VPS and are unsure what operating system you should choose,
+we recommend **Ubuntu 22.04 LTS**.
+
+.. toctree::
+   :maxdepth: 1
+
+   windows
+   mac
+   alma-linux-8
+   alma-linux-9
+   arch
+   centos-7
+   centos-stream-8
+   centos-stream-9
+   debian-10
+   debian-11
+   fedora
+   opensuse-leap-15
+   opensuse-tumbleweed
+   oracle-linux-8
+   oracle-linux-9
+   raspberry-pi-os-10
+   raspberry-pi-os-11
+   rhel-8
+   rhel-9
+   rocky-linux-8
+   rocky-linux-9
+   ubuntu-1804
+   ubuntu-2004
+   ubuntu-2204
+   ubuntu-non-lts

docs/install_guides/mac.rst

@@ -0,0 +1,42 @@
+.. _install-mac:
+
+=======================
+Installing Red on macOS
+=======================
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+To install pre-requirements, we first have to install Brew.
+In Finder or Spotlight, search for and open *Terminal*. In the terminal, paste the
+following, then press Enter:
+
+.. prompt:: bash
+
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
+
+After the installation, install the required packages by pasting the commands and pressing enter,
+one-by-one:
+
+.. prompt:: bash
+
+    brew install python@3.9
+    brew install git
+    brew tap homebrew/cask-versions
+    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
+
+    profile=$([ -n "$ZSH_VERSION" ] && echo ~/.zprofile || ([ -f ~/.bash_profile ] && echo ~/.bash_profile || echo ~/.profile))
+    echo 'export PATH="$(brew --prefix)/opt/python@3.9/bin:$PATH"' >> "$profile"
+    source "$profile"
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/opensuse-leap-15.rst

@@ -0,0 +1,54 @@
+.. _install-opensuse-leap-15:
+
+=====================================
+Installing Red on openSUSE Leap 15.2+
+=====================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+We recommend installing a community package to get Python 3.9 on openSUSE Leap 15.2+. This package will
+be installed to the ``/opt`` directory.
+
+First, add the Opt-Python community repository:
+
+.. prompt:: bash
+
+    source /etc/os-release
+    sudo zypper -n ar -f https://download.opensuse.org/repositories/home:/Rotkraut:/Opt-Python/openSUSE_Leap_${VERSION_ID}/ Opt-Python
+    sudo zypper -n --gpg-auto-import-keys ref
+
+Now install the pre-requirements with zypper:
+
+.. prompt:: bash
+
+    sudo zypper -n install opt-python39 opt-python39-setuptools git-core java-11-openjdk-headless nano
+    sudo zypper -n install -t pattern devel_basis
+
+Since Python is now installed to ``/opt/python``, we should add it to PATH. You can add a file in
+``/etc/profile.d/`` to do this:
+
+.. prompt:: bash
+
+    echo 'export PATH="/opt/python/bin:$PATH"' | sudo tee /etc/profile.d/opt-python.sh
+    source /etc/profile.d/opt-python.sh
+
+Now, bootstrap pip with ensurepip:
+
+.. prompt:: bash
+
+    sudo /opt/python/bin/python3.9 -m ensurepip --altinstall
+
+.. note::
+
+    After this command, a warning about running pip as root might be printed.
+    For this specific command, this warning can be safely ignored.
+
+.. Include common instructions:
+
+.. include:: _includes/create-env-with-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/opensuse-tumbleweed.rst

@@ -0,0 +1,25 @@
+.. _install-opensuse-tumbleweed:
+
+=====================================
+Installing Red on openSUSE Tumbleweed
+=====================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+openSUSE Tumbleweed has all required dependencies available in official repositories. Install them
+with zypper:
+
+.. prompt:: bash
+
+    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-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/oracle-linux-8.rst

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

docs/install_guides/oracle-linux-9.rst

@@ -0,0 +1,7 @@
+.. _install-oracle-linux-9:
+
+================================
+Installing Red on Oracle Linux 9
+================================
+
+.. include:: _includes/install-guide-rhel9-derivatives.rst

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

@@ -0,0 +1,48 @@
+.. _install-raspberry-pi-os-10:
+
+====================================================
+Installing Red on Raspberry Pi OS (Legacy) 10 Buster
+====================================================
+
+.. note::
+
+    While we do provide support and install instructions for running Red
+    on Raspberry Pi OS (Legacy) 10 Buster, we highly recommend installing/upgrading to
+    the new version - Raspberry Pi OS 11 Bullseye.
+
+    If you're not sure what version you are using,
+    you can check your version of Raspberry Pi OS by running:
+
+    .. prompt:: bash
+
+        lsb_release -a
+
+    If you're running Bullseye already, read `install-raspberry-pi-os-11` document instead.
+
+    If you're using Buster, please consider upgrading to Bullseye if possible.
+    You can read
+    `the post about Bullseye release from Raspberry Pi Foundation <https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/>`__
+    to learn how you can install/upgrade to the new version.
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+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:
+
+.. 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-python38-pyenv.rst
+
+.. include:: _includes/create-env-with-pyenv-virtualenv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

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

@@ -0,0 +1,40 @@
+.. _install-raspberry-pi-os-11:
+
+=============================================
+Installing Red on Raspberry Pi OS 11 Bullseye
+=============================================
+
+.. note::
+
+    This guide can only be used with Raspberry Pi OS 11 Bullseye,
+    it will not work with any older (e.g. Raspberry Pi OS 10 Buster)
+    or newer (e.g. Raspberry Pi OS 12 Bookworm) releases.
+    You can check your version of Raspberry Pi OS by running:
+
+    .. prompt:: bash
+
+        lsb_release -a
+
+    If you're not running Bullseye, you should read
+    `the post about Bullseye release from Raspberry Pi Foundation <https://www.raspberrypi.com/news/raspberry-pi-os-debian-bullseye/>`__
+    to learn how you can install/upgrade to the new version.
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Raspberry Pi OS "Bullseye" 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 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/rhel-8.rst

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

docs/install_guides/rhel-9.rst

@@ -0,0 +1,7 @@
+.. _install-rhel-9:
+
+===================================================
+Installing Red on Red Hat Enterprise Linux (RHEL) 9
+===================================================
+
+.. include:: _includes/install-guide-rhel9-derivatives.rst

docs/install_guides/rocky-linux-8.rst

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

docs/install_guides/rocky-linux-9.rst

@@ -0,0 +1,7 @@
+.. _install-rocky-linux-9:
+
+===============================
+Installing Red on Rocky Linux 9
+===============================
+
+.. include:: _includes/install-guide-rhel9-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

@@ -0,0 +1,31 @@
+.. _install-ubuntu-2004:
+
+==================================
+Installing Red on Ubuntu 20.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
+
+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-2204.rst

@@ -0,0 +1,31 @@
+.. _install-ubuntu-2204:
+
+==================================
+Installing Red on Ubuntu 22.04 LTS
+==================================
+
+.. include:: _includes/linux-preamble.rst
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+We recommend adding the ``deadsnakes`` ppa to install Python 3.9:
+
+.. prompt:: bash
+
+    sudo apt update
+    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-venv.rst
+
+.. include:: _includes/install-and-setup-red-unix.rst

docs/install_guides/ubuntu-non-lts.rst

@@ -0,0 +1,35 @@
+.. _install-ubuntu-non-lts:
+
+=========================================
+Installing Red on Ubuntu non-LTS versions
+=========================================
+
+.. 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 -yu ppa:git-core/ppa
+
+Now, to install non-native version of python on non-LTS versions of Ubuntu, we recommend
+installing pyenv. To do this, first run the following commands:
+
+.. prompt:: bash
+
+    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/windows.rst

@@ -10,15 +10,6 @@ Installing the pre-requirements
 
 Please install the pre-requirements by following instructions from one of the following subsections.
 
-The pre-requirements are:
- - Python 3.8.1 or greater; **Python 3.9 is currently not supported!**
- - Pip 18.1 or greater
- - Git 2.11+
- - Java Runtime Environment 11 (for audio support)
-
-We also recommend installing some basic compiler tools, in case our dependencies don't provide
-pre-built "wheels" for your architecture.
-
 .. contents:: Choose a method of installing pre-requirements:
     :local:
 
@@ -39,14 +30,14 @@ Then run each of the following commands:
     [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072
     iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
     choco upgrade git --params "/GitOnlyOnPath /WindowsTerminal" -y
-    choco upgrade visualstudio2019-workload-vctools -y
-    choco upgrade python3 -y --version 3.8.9
+    choco upgrade visualstudio2022-workload-vctools -y
+    choco upgrade python3 -y --version 3.9.13
 
 For Audio support, you should also run the following command before exiting:
 
 .. prompt:: powershell
 
-    choco upgrade adoptopenjdk11jre -y
+    choco upgrade temurin11 -y --version 11.0.14.10100
 
 
 From here, exit the prompt then continue onto `creating-venv-windows`.
@@ -64,7 +55,7 @@ Manually installing dependencies
 
 * `MSVC Build tools <https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2019>`_
 
-* `Python 3.8.1 or greater <https://www.python.org/downloads/>`_; **Python 3.9 is currently not supported!**
+* `Python 3.8.1 - 3.9.x <https://www.python.org/downloads/windows/>`_
 
 .. attention:: Please make sure that the box to add Python to PATH is CHECKED, otherwise
                you may run into issues when trying to run Red.
@@ -73,7 +64,7 @@ Manually installing dependencies
 
 .. attention:: Please choose the option to "Git from the command line and also from 3rd-party software" in Git's setup.
 
-* `Java 11 <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>`_ - needed for Audio
+* `Java 11 <https://adoptium.net/?variant=openjdk11>`_ - needed for Audio
 
 From here, continue onto `creating-venv-windows`.
 
@@ -111,7 +102,7 @@ Then create your virtual environment with the following command
 
 .. prompt:: batch
 
-    py -3.8 -m venv "%userprofile%\redenv"
+    py -3.9 -m venv "%userprofile%\redenv"
 
 And activate it with the following command
 
@@ -175,8 +166,7 @@ Once done setting up the instance, run the following command to run Red:
     redbot <your instance name>
 
 It will walk through the initial setup, asking for your token and a prefix.
-You can find out how to obtain a token with
-`this guide <bot_application_guide>`.
+`See how to obtain a token. <../bot_application_guide>`
 
 .. tip::
    If it's the first time you're using Red, you should check our `getting-started` guide

docs/install_linux_mac.rst

@@ -1,498 +0,0 @@
-.. _linux-mac-install-guide:
-
-==============================
-Installing Red on Linux or Mac
-==============================
-
-.. warning::
-
-    For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
-    a new user on Linux, see `this guide by DigitalOcean
-    <https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart>`_.
-
--------------------------------
-Installing the pre-requirements
--------------------------------
-
-Please install the pre-requirements using the commands listed for your operating system.
-
-The pre-requirements are:
- - Python 3.8.1 or greater; **Python 3.9 is currently not supported!**
- - Pip 18.1 or greater
- - Git 2.11+
- - Java Runtime Environment 11 (for audio support)
-
-We recommend installing the nano text editor as our guides may instruct you to create or edit some files. We also recommend installing some basic compiler tools in case our dependencies don't provide pre-built "wheels" for your architecture.
-
-
-*****************
-Operating systems
-*****************
-
-.. contents::
-    :local:
-
-----
-
-.. _install-arch:
-
-~~~~~~~~~~
-Arch Linux
-~~~~~~~~~~
-
-.. warning::
-
-    Latest Python packages for Arch Linux provide Python 3.9 which Red does not currently support.
-    To use Red on Arch Linux, you will need to install latest version of Python 3.8 on your own.
-
-.. prompt:: bash
-
-    sudo pacman -Syu python python-pip git jre11-openjdk-headless base-devel nano
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-centos7:
-.. _install-rhel7:
-
-~~~~~~~~~~~~~~~~~
-CentOS and RHEL 7
-~~~~~~~~~~~~~~~~~
-
-.. prompt:: bash
-
-    sudo yum -y groupinstall development
-    sudo yum -y install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless nano
-    sudo yum -y install centos-release-scl
-    sudo yum -y install devtoolset-8-gcc devtoolset-8-gcc-c++
-    echo "source scl_source enable devtoolset-8" >> ~/.bashrc
-    source ~/.bashrc
-
-In order to install Git 2.11 or greater, we recommend adding the IUS repository:
-
-.. prompt:: bash
-
-    sudo yum -y install https://repo.ius.io/ius-release-el7.rpm
-    sudo yum -y swap git git224
-
-Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-centos:
-.. _install-rhel:
-
-~~~~~~~~~~~~~~~~~
-CentOS and RHEL 8
-~~~~~~~~~~~~~~~~~
-
-.. prompt:: bash
-
-    sudo yum -y install epel-release
-    sudo yum -y update
-    sudo yum -y groupinstall development
-    sudo yum -y install git zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel openssl-devel xz xz-devel tk-devel libffi-devel findutils java-11-openjdk-headless nano
-
-Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-debian:
-.. _install-raspbian:
-
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-Debian and Raspbian Buster
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-We recommend installing pyenv as a method of installing non-native versions of python on
-Debian/Raspbian 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++
-
-Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-fedora:
-
-~~~~~~~~~~~~
-Fedora Linux
-~~~~~~~~~~~~
-
-Fedora Linux 32 and above has all required packages available in official repositories. Install
-them with dnf:
-
-.. prompt:: bash
-
-    sudo dnf -y install python38 git java-11-openjdk-headless @development-tools nano
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-mac:
-
-~~~
-Mac
-~~~
-
-Install Brew: in Finder or Spotlight, search for and open *Terminal*. In the terminal, paste the
-following, then press Enter:
-
-.. prompt:: bash
-
-    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
-
-After the installation, install the required packages by pasting the commands and pressing enter,
-one-by-one:
-
-.. prompt:: bash
-
-    brew install python@3.8
-    echo 'export PATH="/usr/local/opt/python@3.8/bin:$PATH"' >> ~/.profile
-    source ~/.profile
-    brew install git
-    brew install --cask adoptopenjdk/openjdk/adoptopenjdk11
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-opensuse:
-
-~~~~~~~~
-openSUSE
-~~~~~~~~
-
-openSUSE Leap 15.2+
-*******************
-
-We recommend installing a community package to get Python 3.8 on openSUSE Leap 15.2+. This package will
-be installed to the ``/opt`` directory.
-
-First, add the Opt-Python community repository:
-
-.. prompt:: bash
-
-    source /etc/os-release
-    sudo zypper -n ar -f https://download.opensuse.org/repositories/home:/Rotkraut:/Opt-Python/openSUSE_Leap_${VERSION_ID}/ Opt-Python
-    sudo zypper -n --gpg-auto-import-keys ref
-
-Now install the pre-requirements with zypper:
-
-.. prompt:: bash
-
-    sudo zypper -n install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless nano
-    sudo zypper -n install -t pattern devel_basis
-
-Since Python is now installed to ``/opt/python``, we should add it to PATH. You can add a file in
-``/etc/profile.d/`` to do this:
-
-.. prompt:: bash
-
-    echo 'export PATH="/opt/python/bin:$PATH"' | sudo tee /etc/profile.d/opt-python.sh
-    source /etc/profile.d/opt-python.sh
-
-Now, install pip with easy_install:
-
-.. prompt:: bash
-
-    sudo /opt/python/bin/easy_install-3.8 pip
-
-Continue by `creating-venv-linux`.
-
-openSUSE Tumbleweed
-*******************
-
-openSUSE Tumbleweed has all required dependencies available in official repositories. Install them
-with zypper:
-
-.. prompt:: bash
-
-    sudo zypper -n install python38-base python38-pip git-core java-11-openjdk-headless nano
-    sudo zypper -n install -t pattern devel_basis
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-ubuntu-1804:
-
-~~~~~~~~~~~~~~~~
-Ubuntu 18.04 LTS
-~~~~~~~~~~~~~~~~
-
-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.8.1 or greater:
-
-.. prompt:: bash
-
-    sudo add-apt-repository -y ppa:deadsnakes/ppa
-
-Now install the pre-requirements with apt:
-
-.. prompt:: bash
-
-    sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential nano
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-ubuntu:
-
-~~~~~~~~~~~~~~~~
-Ubuntu 20.04 LTS
-~~~~~~~~~~~~~~~~
-
-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
-
-Now install the pre-requirements with apt:
-
-.. prompt:: bash
-
-    sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential nano
-
-Continue by `creating-venv-linux`.
-
-----
-
-.. _install-ubuntu-non-lts:
-
-~~~~~~~~~~~~~~~~~~~~~~~
-Ubuntu non-LTS versions
-~~~~~~~~~~~~~~~~~~~~~~~
-
-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 -yu ppa:git-core/ppa
-
-Now, to install non-native version of python on non-LTS versions of Ubuntu, we recommend
-installing pyenv. To do this, first run the following commands:
-
-.. prompt:: bash
-
-    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++
-
-And then complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-python-pyenv:
-
-****************************
-Installing Python with pyenv
-****************************
-
-.. note::
-
-    If you followed one of the sections above, and weren't linked here afterwards, you should skip
-    this section.
-
-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.
-
-.. prompt:: bash
-
-    command -v pyenv && pyenv update || curl https://pyenv.run | bash
-
-**After this command, you may see a warning about 'pyenv' not being in the load path. Follow the
-instructions given to fix that, then close and reopen your shell.**
-
-Then run the following command:
-
-.. prompt:: bash
-
-    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.9 -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
-the ``CONFIGURE_OPTS=--enable-optimizations`` part from the front of the command, which will
-drastically reduce the install time. However, be aware that this will make Python run about 10%
-slower.
-
-After that is finished, run:
-
-.. prompt:: bash
-
-    pyenv global 3.8.9
-
-Pyenv is now installed and your system should be configured to run Python 3.8.
-
-Continue by `creating-venv-linux`.
-
-.. _creating-venv-linux:
-
-------------------------------
-Creating a Virtual Environment
-------------------------------
-
-.. tip::
-
-    If you want to learn more about virtual environments, see page: `about-venvs`
-
-We require installing Red into a virtual environment. Don't be scared, it's very
-straightforward.
-
-You have 2 options:
-
-* :ref:`using-venv` (quick and easy, involves just two commands)
-* :ref:`using-pyenv-virtualenv` (only available and recommended when you installed Python with pyenv)
-
-----
-
-.. _using-venv:
-
-**************
-Using ``venv``
-**************
-This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
-python.
-
-First, choose a directory where you would like to create your virtual environment. It's a good idea
-to keep it in a location which is easy to type out the path to. From now, we'll call it
-``redenv`` and it will be located in your home directory.
-
-Create your virtual environment with the following command:
-
-.. prompt:: bash
-
-    python3.8 -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.
-
-Continue by `installing-red-linux-mac`.
-
-----
-
-.. _using-pyenv-virtualenv:
-
-**************************
-Using ``pyenv virtualenv``
-**************************
-
-Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
-environments. This option is only available if you installed Python with pyenv.
-
-First, ensure your pyenv interpreter is set to python 3.8.1 or greater with the following command:
-
-.. prompt:: bash
-
-    pyenv version
-
-Now, create a virtual environment with the following command:
-
-.. prompt:: bash
-
-    pyenv virtualenv <name>
-
-Replace ``<name>`` with whatever you like. If you ever forget what you named it,
-you can always use the command ``pyenv versions`` to list all virtual environments.
-
-Now activate your virtualenv with the following command:
-
-.. prompt:: bash
-
-    pyenv shell <name>
-
-.. important::
-
-    You must activate the virtual environment with the above command every time you open a new
-    shell to run, install or update Red. You can check out other commands like ``pyenv local`` and
-    ``pyenv global`` if you wish to keep the virtualenv activated all the time.
-
-Continue by `installing-red-linux-mac`.
-
-.. _pyenv-installer: https://github.com/pyenv/pyenv-installer/blob/master/README.rst
-
-.. _installing-red-linux-mac:
-
---------------
-Installing Red
---------------
-
-Choose one of the following commands to install Red.
-
-To install without additional config backend support:
-
-.. prompt:: bash
-    :prompts: (redenv) $
-
-    python -m pip install -U pip setuptools wheel
-    python -m pip install -U Red-DiscordBot
-
-Or, to install with PostgreSQL support:
-
-.. prompt:: bash
-    :prompts: (redenv) $
-
-    python -m pip install -U pip setuptools wheel
-    python -m pip install -U "Red-DiscordBot[postgres]"
-
-
-.. note::
-
-    These commands are also used for updating Red
-
---------------------------
-Setting Up and Running Red
---------------------------
-
-After installation, set up your instance with the following command:
-
-.. prompt:: bash
-    :prompts: (redenv) $
-
-    redbot-setup
-
-This will set the location where data will be stored, as well as your
-storage backend and the name of the instance (which will be used for
-running the bot).
-
-Once done setting up the instance, run the following command to run Red:
-
-.. prompt:: bash
-    :prompts: (redenv) $
-
-    redbot <your instance name>
-
-It will walk through the initial setup, asking for your token and a prefix.
-You can find out how to obtain a token with
-`this guide <bot_application_guide>`.
-
-.. tip::
-   If it's the first time you're using Red, you should check our `getting-started` guide
-   that will walk you through all essential information on how to interact with Red.

docs/intents.rst

@@ -0,0 +1,134 @@
+.. _intents:
+.. |br| raw:: html
+
+   <br />
+
+==========================================
+About (privileged) intents and public bots
+==========================================
+
+This page aims to explain Red's current intents requirements,
+our stance regarding "public bots" and the impact of some announced
+Discord changes coming in April 2022.
+
+To clarify:
+
+- **Small bots** are bots under 100 servers. They currently do not need to undergo Discord's
+  bot verification process
+- **Public bots** (or big bots) are bots that have reached 100 servers. They need to be
+  `verified <https://support.discord.com/hc/en-us/articles/360040720412-Bot-Verification-and-Data-Whitelisting>`_
+  by Discord to join more than 100 servers and gain privileged intents
+
+.. warning::
+
+  It is **very** important that you fully read this page if you're the owner of a public bot or strive to scale your bot at that level.
+
+.. _intents-intents:
+
+-------
+Intents
+-------
+
+Red currently requires **all intents** to be active in order to function properly.
+
+The reason for this requirement is that there are some technical challenges that need
+to be overcome before we're able to adapt Red to function with only *some* intents:
+these challenges are mainly due to the modular / extensible nature of Red and the fact
+that Red has a long history (dating back to 2016!), making big changes naturally slower
+to happen. In comparison, intents have been introduced fairly recently. |br|
+This is not a problem if you have a small bot: you can simply go to the
+`Discord development portal <https://discord.com/developers/applications/me>`_
+and enable them. However, if you have a public bot Discord will want you to attain
+verified status: you should read :ref:`our stance regarding public bots <intents-public-bots>`
+and our guidelines for the :ref:`verification process <intents-bot-verification-process>`.
+
+.. _intents-public-bots:
+
+-----------
+Public bots
+-----------
+
+Public bots, or big bots, are not our target audience and we **do not** offer support for them.
+
+Red was designed with one single goal in mind: a bot that you can host on your own hardware
+and customize to your needs, making it really *your* bot. **The target audience of Red are server
+owners with a few servers**, often with specific needs that can be covered by the vast cog ecosystem
+that the community has built over the years. |br| Red was never built with big bots in mind,
+bots with thousands upon thousands of servers: these bots face unique challenges.
+Such Red instances *do exist*, it is not impossible to adapt Red and meet those criteria,
+but it requires work and bot owners with the technical knowledge to make it happen.
+It is **not** something that we support. |br|
+When your bot reaches the public bot scale and it is therefore required to be verified it
+is *expected* that you know what's in your bot and how it works: that doesn't just mean on the
+surface level, it means coding knowledge and the ability to maintain it on your own.
+
+.. _intents-bot-verification-process:
+
+------------------------
+Bot verification process
+------------------------
+
+When your bot ceases to be a small bot Discord will require you to verify your bot before allowing
+it to join more servers and gain privileged intents. If you've read the previous section,
+you will know that we do **not** support public bots. Logically, we also do not provide help for
+the verification process.
+
+Regardless of our stance, we do feel the need to give some pointers: many bot owners reach this point
+and become fairly lost, as they've simply been *users* so far.
+They have installed their bot, some cogs, personalized it, yadda yadda. Again, they have been users,
+not developers. Unless they also have an interest in development, they will likely not have a clue about
+what's going under the hood, much like you're not expected to be a mechanic to drive your car. And there's
+nothing wrong with that! Red has been designed to be as user friendly as possible. |br|
+The problem is this: Red is an outlier. Discord has built the bot verification process with the expectation
+that the owner knows *on a technical level* what their bot does and how it works. And this is because outside
+Red, the typical bot owner is also a developer who coded their own bot from scratch.
+
+While, again, we *cannot* support you going forward we want to give you some pointers to follow when filling
+out your application:
+
+- Learn on a technical level what intents are and what's going on, under the hood, in your bot. Knowing its
+  features at a surface level is not enough. What features need intents to work and why?
+- Forget that you're hosting Red. You're hosting *a bot* and Discord wants to know what *your bot* does and why
+  you're requesting privileged intents. |br| A **very bad** answer is: *"Because Red needs them"*. |br|
+  A **good** answer is: *"My bot has X features and it needs Y intents to work properly"*. |br| We've had a fair share
+  of people that in their naivety went with the bad answer and it seems that at this point merely mentioning Red
+  is a guaranteed way to have your application rejected.
+
+.. _intents-slash-commands:
+
+---------------------------------
+Message intent and slash commands
+---------------------------------
+
+.. warning::
+
+  If you own a public bot it is extremely important that you read this section.
+
+Discord has announced that **starting April 2022** the content of users' messages
+`will be "locked" behind message intent <https://support-dev.discord.com/hc/en-us/articles/4404772028055>`_ |br|
+If you're the owner of a small bot, fear not, this is yet another box that you have to tick from the
+`Discord development portal <https://discord.com/developers/applications/me>`_. |br|
+But if you're the owner of a public bot, things might be a lot less pleasant.
+
+To recap, unless you have
+message intent, you will only receive message content for:
+
+- Messages that your bot sends
+- Messages that your bot receives in DM
+- Messages in which your bot is mentioned
+
+In case it's not clear by now, your bot needs message content to parse (see) the commands it receives. And if
+you don't attain message intent, your bot will not be able to... well, do anything. |br|
+The *bandaid fix* is for you to change your bot's prefix to a mention and a good portion of your commands will likely
+still work. You will however lose many functions, namely anything that relies on seeing message content to act. |br|
+The more *proper fix* is also not easy. You will need to justify your need for the message intent to Discord and
+they will only accept "compelling use cases".
+`It is not known what those even entail <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-what-usecases-will-be-valid>`_ at this point, but they have already stated that "parsing commands" is not a valid justification. |br|
+To make the matter worse, Discord is making `a huge push for all bot developers to implement slash commands <https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ>`_, which at the moment
+are rather lacking in features and cannot cover all the functionalities that standard commands offer. |br|
+Discord staff
+`stated that they will want your bot to have slash commands when you ask for message intent <https://gist.github.com/spiralw/091714718718379b6efcdbcaf807a024#q-if-we-are-granted-this-intent-will-bots-be-sanctioned-if-they-use-it-for-their-own-use-case-but-also-to-continue-to-run-normal-non-slash-commands-or-do-we-assume-that-if-you-are-granted-the-intent-you-are-trusted-with-it-and-are-allowed-to-use-it-for-additional-uses>`_. |br|
+Slash commands might very well turn out to be a big undertaking for the Red team to implement, even more now that our
+underlying library, `discord.py <https://github.com/Rapptz/discord.py>`_, has been discontinued. |br|
+The time window that Discord is giving us to adapt is very narrow: **Red will likely not be able to support slash
+commands for April 2022** and you should plan accordingly.

docs/prolog.txt

@@ -27,16 +27,16 @@
 .. |role-input-quotes| replace:: Please give **the exact role name or ID**, or it won't be detected.
     If the role name has spaces, provide it enclosed in quotes like this: ``"my role with spaces"``
 
-.. |member-input| replace:: You can either mention the member, provide its ID, its exact name with
-    the tag or not, or its nickname.
+.. |member-input| replace:: You can either mention the member, provide their ID, their exact name with
+    the tag or not, or their nickname.
 
-.. |member-input-quotes| replace:: You can either mention the member, provide its ID, its exact
-    name with the tag or not, or its nickname enclosed in quotes if there are spaces.
+.. |member-input-quotes| replace:: You can either mention the member, provide their ID, their exact
+    name with the tag or not, or their nickname enclosed in quotes if there are spaces.
 
-.. |user-input| replace:: You can either provide the member's ID or its exact name with the tag or
+.. |user-input| replace:: You can either provide the member's ID or their exact name with the tag or
     not.
 
-.. |user-input-quotes| replace:: You can either provide the member's ID or its exact name with the
+.. |user-input-quotes| replace:: You can either provide the member's ID or their exact name with the
     tag or not, enclosed in quotes if there are spaces.
 
 .. |channel-input| replace:: You can either mention the channel, provide its exact name or its ID.
@@ -48,3 +48,7 @@
 
 .. |color-input| replace:: You can either provide the hexadecimal code of the color, or one of the
     colors listed here: :class:`discord.Color`.
+
+.. These are the comments for parameter types such as `bool`.
+
+.. |bool-input| replace:: You should provide either 'true' or 'false'.

docs/requirements.txt

@@ -1,2 +0,0 @@
-# We still need this because RTD is special
-setuptools==40.8.0

docs/update_red.rst

@@ -31,7 +31,7 @@ Red 3.2.0 or newer
 Windows
 -------
 
-If you have Red 3.2.0 or newer, you can upgrade by following these 4 easy steps:
+If you have Red 3.2.0 or newer, you can upgrade by following these steps:
 
 1. Shut your bot down.
 
@@ -59,7 +59,7 @@ If you have Red 3.2.0 or newer, you can upgrade by following these 4 easy steps:
 Linux & Mac
 -----------
 
-If you have Red 3.2.0 or newer, you can upgrade by following these 4 easy steps:
+If you have Red 3.2.0 or newer, you can upgrade by following these steps:
 
 1. Shut your bot down.
 
@@ -97,10 +97,7 @@ Red 3.1.X
 
 If you have Red 3.1.X, you will need to follow the install instructions for your operating system. Make sure that you turn your bot off first.
 
-- `Windows <install_windows>`
-- `Linux & Mac <install_linux_mac>`
-
-Follow every step to ensure you have all dependencies up-to-date and only skip ``redbot-setup`` step as you already have a bot instance.
+Go to the `install_guides/index` guide and follow every step to ensure you have all dependencies up-to-date and only skip the ``redbot-setup`` step as you already have a bot instance.
 
 **If you already have Red installed in a virtual environment, you will need to delete it before starting this process.**
 
@@ -139,9 +136,6 @@ Red 3.0.2 and older
 
 If you have Red 3.0.2 or older, you will need to follow the install instructions for your operating system. Make sure that you turn your bot off first.
 
-- `Windows <install_windows>`
-- `Linux & Mac <install_linux_mac>`
-
-Follow every step to ensure you have all dependencies up-to-date and only skip ``redbot-setup`` step as you already have a bot instance.
+Go to the `install_guides/index` guide and follow every step to ensure you have all dependencies up-to-date and only skip the ``redbot-setup`` step as you already have a bot instance.
 
 **If you already have Red installed in a virtual environment, you will need to delete it before starting this process.**

pyproject.toml

@@ -1,3 +1,7 @@
+[build-system]
+    requires = ["setuptools", "wheel"]
+    build-backend = "setuptools.build_meta"
+
 [tool.black]
     line-length = 99
     target-version = ['py38']

redbot/__init__.py

@@ -191,7 +191,30 @@ def _update_event_loop_policy():
             _asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy())
 
 
-__version__ = "3.4.8"
+def _ensure_no_colorama():
+    # a hacky way to ensure that nothing initialises colorama
+    # if we're not running with legacy Windows command line mode
+    from rich.console import detect_legacy_windows
+
+    if not detect_legacy_windows():
+        import colorama
+        import colorama.initialise
+
+        colorama.deinit()
+
+        def _colorama_wrap_stream(stream, *args, **kwargs):
+            return stream
+
+        colorama.wrap_stream = _colorama_wrap_stream
+        colorama.initialise.wrap_stream = _colorama_wrap_stream
+
+
+def _early_init():
+    _update_event_loop_policy()
+    _ensure_no_colorama()
+
+
+__version__ = "3.4.17"
 version_info = VersionInfo.from_str(__version__)
 
 # Filter fuzzywuzzy slow sequence matcher warning
@@ -204,3 +227,12 @@ if "--debug" not in _sys.argv:
     # Individual warnings - tracked in https://github.com/Cog-Creators/Red-DiscordBot/issues/3529
     # DeprecationWarning: an integer is required (got type float).  Implicit conversion to integers using __int__ is deprecated, and may be removed in a future version of Python.
     _warnings.filterwarnings("ignore", category=DeprecationWarning, module="importlib", lineno=219)
+    # DeprecationWarning: The loop argument is deprecated since Python 3.8, and scheduled for removal in Python 3.10
+    #   stdin, stdout, stderr = await tasks.gather(stdin, stdout, stderr,
+    # this is a bug in CPython
+    _warnings.filterwarnings(
+        "ignore",
+        category=DeprecationWarning,
+        module="asyncio",
+        message="The loop argument is deprecated since Python 3.8",
+    )

redbot/__main__.py

@@ -18,13 +18,14 @@ from pathlib import Path
 from typing import NoReturn
 
 import discord
+import rich
 
 # Set the event loop policies here so any subsequent `new_event_loop()`
 # calls, in particular those as a result of the following imports,
 # return the correct loop object.
-from redbot import _update_event_loop_policy, __version__
+from redbot import _early_init, __version__
 
-_update_event_loop_policy()
+_early_init()
 
 import redbot.logging
 from redbot.core.bot import Red, ExitCodes
@@ -84,8 +85,7 @@ def debug_info():
         os_info = platform.mac_ver()
         osver = "Mac OSX {} {}".format(os_info[0], os_info[2])
     else:
-        os_info = distro.linux_distribution()
-        osver = "{} {}".format(os_info[0], os_info[1]).strip()
+        osver = f"{distro.name()} {distro.version()}".strip()
     user_who_ran = getpass.getuser()
     info = (
         "Debug Info for Red\n\n"
@@ -222,7 +222,7 @@ def _edit_instance_name(old_name, new_name, confirm_overwrite, no_prompt):
                 " run this command with --overwrite-existing-instance flag."
             )
     elif not no_prompt and confirm("Would you like to change the instance name?", default=False):
-        name = get_name()
+        name = get_name("")
         if name in _get_instance_names():
             print(
                 "WARNING: An instance already exists with this name. "
@@ -270,7 +270,9 @@ def _edit_data_path(data, instance_name, data_path, copy_data, no_prompt):
             print("Can't copy data to non-empty location. Data location will remain unchanged.")
             data["DATA_PATH"] = data_manager.basic_config["DATA_PATH"]
     elif not no_prompt and confirm("Would you like to change the data location?", default=False):
-        data["DATA_PATH"] = get_data_dir(instance_name)
+        data["DATA_PATH"] = get_data_dir(
+            instance_name=instance_name, data_path=None, interactive=True
+        )
         if confirm("Do you want to copy the data from old location?", default=True):
             if not _copy_data(data):
                 print("Can't copy the data to non-empty location.")
@@ -395,10 +397,12 @@ async def run_bot(red: Red, cli_flags: Namespace) -> None:
                 sys.exit(0)
         sys.exit(1)
     except discord.PrivilegedIntentsRequired:
-        print(
+        console = rich.get_console()
+        console.print(
             "Red requires all Privileged Intents to be enabled.\n"
             "You can find out how to enable Privileged Intents with this guide:\n"
-            "https://docs.discord.red/en/stable/bot_application_guide.html#enabling-privileged-intents"
+            "https://docs.discord.red/en/stable/bot_application_guide.html#enabling-privileged-intents",
+            style="red",
         )
         sys.exit(1)
 
@@ -446,13 +450,18 @@ def global_exception_handler(red, loop, context):
     """
     Logs unhandled exceptions in other tasks
     """
-    msg = context.get("exception", context["message"])
+    exc = context.get("exception")
     # These will get handled later when it *also* kills loop.run_forever
-    if not isinstance(msg, (KeyboardInterrupt, SystemExit)):
-        if isinstance(msg, Exception):
-            log.critical("Caught unhandled exception in task:\n", exc_info=msg)
-        else:
-            log.critical("Caught unhandled exception in task: %s", msg)
+    if exc is not None and isinstance(exc, (KeyboardInterrupt, SystemExit)):
+        return
+    # Maybe in the future we should handle some of the other things
+    # that the default exception handler handles, but this should work fine for now.
+    log.critical(
+        "Caught unhandled exception in %s:\n%s",
+        context.get("future", "event loop"),
+        context["message"],
+        exc_info=exc,
+    )
 
 
 def red_exception_handler(red, red_task: asyncio.Future):

redbot/cogs/admin/__init__.py

@@ -2,4 +2,4 @@ from .admin import Admin
 
 
 def setup(bot):
-    bot.add_cog(Admin())
+    bot.add_cog(Admin(bot))

redbot/cogs/admin/admin.py

@@ -3,10 +3,11 @@ import logging
 from typing import Tuple
 
 import discord
-
 from redbot.core import Config, checks, commands
 from redbot.core.i18n import Translator, cog_i18n
 from redbot.core.utils.chat_formatting import box
+from redbot.core.utils.predicates import MessagePredicate
+
 from .announcer import Announcer
 from .converters import SelfRole
 
@@ -56,7 +57,7 @@ ROLE_USER_HIERARCHY_ISSUE = _(
     " in the Discord hierarchy."
 )
 
-NEED_MANAGE_ROLES = _("I need manage roles permission to do that.")
+NEED_MANAGE_ROLES = _('I need the "Manage Roles" permission to do that.')
 
 RUNNING_ANNOUNCEMENT = _(
     "I am already announcing something. If you would like to make a"
@@ -70,7 +71,9 @@ _ = T_
 class Admin(commands.Cog):
     """A collection of server administration utilities."""
 
-    def __init__(self):
+    def __init__(self, bot):
+        self.bot = bot
+
         self.config = Config.get_conf(self, 8237492837454039, force_registration=True)
 
         self.config.register_global(serverlocked=False, schema_version=0)
@@ -448,45 +451,98 @@ class Admin(commands.Cog):
         pass
 
     @selfroleset.command(name="add")
-    async def selfroleset_add(self, ctx: commands.Context, *, role: discord.Role):
+    async def selfroleset_add(self, ctx: commands.Context, *roles: discord.Role):
         """
-        Add a role to the list of available selfroles.
+        Add a role, or a selection of roles, to the list of available selfroles.
 
         NOTE: The role is case sensitive!
         """
-        if not self.pass_user_hierarchy_check(ctx, role):
-            await ctx.send(
-                _(
-                    "I cannot let you add {role.name} as a selfrole because that role is higher than or equal to your highest role in the Discord hierarchy."
-                ).format(role=role)
-            )
-            return
-        async with self.config.guild(ctx.guild).selfroles() as curr_selfroles:
-            if role.id not in curr_selfroles:
-                curr_selfroles.append(role.id)
-                await ctx.send(_("Added."))
+        current_selfroles = await self.config.guild(ctx.guild).selfroles()
+        for role in roles:
+            if not self.pass_user_hierarchy_check(ctx, role):
+                await ctx.send(
+                    _(
+                        "I cannot let you add {role.name} as a selfrole because that role is"
+                        " higher than or equal to your highest role in the Discord hierarchy."
+                    ).format(role=role)
+                )
+                return
+            if role.id not in current_selfroles:
+                current_selfroles.append(role.id)
+            else:
+                await ctx.send(
+                    _('The role "{role.name}" is already a selfrole.').format(role=role)
+                )
                 return
 
-        await ctx.send(_("That role is already a selfrole."))
+        await self.config.guild(ctx.guild).selfroles.set(current_selfroles)
+        if (count := len(roles)) > 1:
+            message = _("Added {count} selfroles.").format(count=count)
+        else:
+            message = _("Added 1 selfrole.")
+
+        await ctx.send(message)
 
     @selfroleset.command(name="remove")
-    async def selfroleset_remove(self, ctx: commands.Context, *, role: SelfRole):
+    async def selfroleset_remove(self, ctx: commands.Context, *roles: SelfRole):
         """
-        Remove a role from the list of available selfroles.
+        Remove a role, or a selection of roles, from the list of available selfroles.
 
         NOTE: The role is case sensitive!
         """
-        if not self.pass_user_hierarchy_check(ctx, role):
-            await ctx.send(
-                _(
-                    "I cannot let you remove {role.name} from being a selfrole because that role is higher than or equal to your highest role in the Discord hierarchy."
-                ).format(role=role)
-            )
-            return
-        async with self.config.guild(ctx.guild).selfroles() as curr_selfroles:
-            curr_selfroles.remove(role.id)
+        current_selfroles = await self.config.guild(ctx.guild).selfroles()
+        for role in roles:
+            if not self.pass_user_hierarchy_check(ctx, role):
+                await ctx.send(
+                    _(
+                        "I cannot let you remove {role.name} from being a selfrole because that role is higher than or equal to your highest role in the Discord hierarchy."
+                    ).format(role=role)
+                )
+                return
+            current_selfroles.remove(role.id)
 
-        await ctx.send(_("Removed."))
+        await self.config.guild(ctx.guild).selfroles.set(current_selfroles)
+
+        if (count := len(roles)) > 1:
+            message = _("Removed {count} selfroles.").format(count=count)
+        else:
+            message = _("Removed 1 selfrole.")
+
+        await ctx.send(message)
+
+    @selfroleset.command(name="clear")
+    async def selfroleset_clear(self, ctx: commands.Context):
+        """Clear the list of available selfroles for this server."""
+        current_selfroles = await self.config.guild(ctx.guild).selfroles()
+
+        if not current_selfroles:
+            return await ctx.send(_("There are currently no selfroles."))
+
+        await ctx.send(
+            _("Are you sure you want to clear this server's selfrole list?") + " (yes/no)"
+        )
+        try:
+            pred = MessagePredicate.yes_or_no(ctx, user=ctx.author)
+            await ctx.bot.wait_for("message", check=pred, timeout=60)
+        except asyncio.TimeoutError:
+            await ctx.send(_("You took too long to respond."))
+            return
+        if pred.result:
+            for role in current_selfroles:
+                role = ctx.guild.get_role(role)
+                if role is None:
+                    continue
+                if not self.pass_user_hierarchy_check(ctx, role):
+                    await ctx.send(
+                        _(
+                            "I cannot clear the selfroles because the selfrole '{role.name}' is higher than or equal to your highest role in the Discord hierarchy."
+                        ).format(role=role)
+                    )
+                    return
+            await self.config.guild(ctx.guild).selfroles.clear()
+            await ctx.send(_("Selfrole list cleared."))
+        else:
+            await ctx.send(_("No changes have been made."))
 
     @commands.command()
     @checks.is_owner()
@@ -504,6 +560,13 @@ class Admin(commands.Cog):
     @commands.Cog.listener()
     async def on_guild_join(self, guild: discord.Guild):
         if await self.config.serverlocked():
+            if len(self.bot.guilds) == 1:  # will be 0 once left
+                log.warning(
+                    f"Leaving guild '{guild.name}' ({guild.id}) due to serverlock. You can "
+                    "temporarily disable serverlock by starting up the bot with the --no-cogs flag."
+                )
+            else:
+                log.info(f"Leaving guild '{guild.name}' ({guild.id}) due to serverlock.")
             await guild.leave()