Version bump to 3.4.12 (#5145)

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

.gitattributes

@@ -0,0 +1,4 @@
+* text eol=lf
+
+# binary file excludsions
+*.png binary

.github/CODEOWNERS

@@ -1,65 +1,23 @@
-# Default
-*                                   @Twentysix26
-
-# Core
-redbot/core/bank.py                      @palmtree5
-redbot/core/checks.py                    @tekulvw
-redbot/core/cli.py                       @tekulvw
-redbot/core/config.py                    @tekulvw
-redbot/core/cog_manager.py               @tekulvw
-redbot/core/core_commands.py             @tekulvw
-redbot/core/context.py                   @Tobotimus
-redbot/core/commands/*                   @mikeshardmind
-redbot/core/data_manager.py              @tekulvw
-redbot/core/dev_commands.py              @tekulvw
-redbot/core/drivers/*                    @tekulvw
-redbot/core/events.py                    @tekulvw
-redbot/core/global_checks.py             @tekulvw
-redbot/core/i18n.py                      @tekulvw
-redbot/core/modlog.py                    @palmtree5
-redbot/core/rpc.py                       @tekulvw
-redbot/core/utils/chat_formatting.py     @tekulvw
-redbot/core/utils/mod.py                 @palmtree5
-redbot/core/utils/data_converter.py      @mikeshardmind
-redbot/core/utils/antispam.py            @mikeshardmind
-redbot/core/utils/tunnel.py              @mikeshardmind
-redbot/core/utils/caching.py             @mikeshardmind
-redbot/core/utils/common_filters.py      @mikeshardmind
-redbot/core/utils/dbtools.py             @mikeshardmind
-
 # Cogs
-redbot/cogs/admin/*                 @tekulvw
-redbot/cogs/alias/*                 @tekulvw
-redbot/cogs/audio/*                 @aikaterna @Drapersniper
-redbot/cogs/bank/*                  @tekulvw
-redbot/cogs/cleanup/*               @palmtree5
-redbot/cogs/customcom/*             @palmtree5
-redbot/cogs/downloader/*            @tekulvw @jack1142
-redbot/cogs/economy/*               @palmtree5
-redbot/cogs/filter/*                @palmtree5
-redbot/cogs/general/*               @palmtree5
-redbot/cogs/image/*                 @palmtree5
-redbot/cogs/mod/*                   @palmtree5
-redbot/cogs/modlog/*                @palmtree5
-redbot/cogs/streams/*               @Twentysix26 @palmtree5
-redbot/cogs/trivia/*                @Tobotimus
-redbot/cogs/reports/*               @mikeshardmind
-redbot/cogs/permissions/*           @mikeshardmind
-redbot/cogs/warnings/*              @palmtree5
+/redbot/cogs/audio/** @aikaterna @PredaaA
+/redbot/cogs/downloader/* @jack1142
+/redbot/cogs/streams/* @palmtree5
+/redbot/cogs/mutes/* @TrustyJAID
 
-# Docs
-docs/*                              @tekulvw @palmtree5
+# Trivia Lists
+/redbot/cogs/trivia/data/lists/whosthatpokemon*.yaml @aikaterna
 
 # Tests
-tests/cogs/downloader/*             @jack1142
+/redbot/pytest/downloader* @jack1142
+/tests/cogs/downloader/* @jack1142
 
-# Setup, instance setup, and running the bot
-setup.py                            @tekulvw
-redbot/__init__.py                  @tekulvw
-redbot/__main__.py                  @tekulvw @mikeshardmind
-redbot/setup.py                     @tekulvw
+# Schemas
+/schema/* @jack1142
 
-# Others
-.travis.yml                         @Kowlin
-crowdin.yml                         @Kowlin
-.github/workflows/*                 @Kowlin
+# CI
+/.travis.yml @Kowlin
+/crowdin.yml @Kowlin
+/.github/workflows/* @Kowlin
+
+# Excludes
+**/locales/* @ghost

.github/ISSUE_TEMPLATE/01_command_bug.yml

@@ -0,0 +1,86 @@
+name: Bug reports for commands
+description: For bugs that involve commands found within Red.
+labels: 'Type: Bug'
+body:
+- type: markdown
+  attributes:
+    value: |
+      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?"
+    options:
+      - Admin
+      - Alias
+      - Audio
+      - Bank
+      - Cleanup
+      - CogManagerUI
+      - Core
+      - Customcom
+      - Dev
+      - Downloader
+      - Economy
+      - Filter
+      - General
+      - Image
+      - Mod
+      - Modlog
+      - Mutes
+      - Permissions
+      - Reports
+      - Streams
+      - Trivia
+      - Warnings
+  validations:
+    required: true
+- type: input
+  id: command-name
+  attributes:
+    label: "Command name"
+    description: "What is the command that caused the error?"
+    placeholder: "play"
+  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: |
+      A clear and concise description of what the bug is.
+      If the issue is visual in nature, consider posting a screenshot.
+  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."
+    value: |
+      1.
+      2.
+      3.
+      ...
+  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

@@ -0,0 +1,54 @@
+name: Bug report
+description: "For bugs that don't involve a command."
+labels: 'Type: Bug'
+body:
+- type: markdown
+  attributes:
+    value: |
+      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:  |
+      If the issue is visual in nature, consider posting a screenshot.
+  validations:
+    required: true
+- type: textarea
+  id: reproduction-steps
+  attributes:
+    label: "How can we reproduce this error?"
+    description: |
+      List of steps required to reproduce the error. If the bug is code related, a minimal code example that reproduces the problem would be a big help.
+    value: |
+      1.
+      2.
+      3.
+      ...
+  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

@@ -0,0 +1,29 @@
+name: Enhancement proposal
+description: For feature requests and improvements related to already existing functionality.
+labels: 'Type: Enhancement'
+body:
+- type: markdown
+  attributes:
+    value: |
+      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

@@ -0,0 +1,52 @@
+name: Feature request
+description: For feature requests regarding Red itself.
+labels: 'Type: Feature'
+body:
+- type: markdown
+  attributes:
+    value: |
+      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?"
+    multiple: true
+    options:
+      - API functionality
+      - Cog
+      - Command
+      - Other
+  validations:
+    required: true
+- type: textarea
+  id: proposal
+  attributes:
+    label: "Description of the feature you're suggesting"
+    description: |
+      Feel free to describe in as much detail as you wish.
+
+      If you are requesting API functionality:
+        - Describe what it should do
+        - Note whether it is to extend existing functionality or introduce new functionality
+
+      If you are requesting a cog to be included in core: 
+        - Describe the functionality in as much detail as possible
+        - Include the command structure, if possible
+        - Please note that unless it's something that should be core functionality,
+          we reserve the right to reject your suggestion and point you to our cog 
+          board to request it for a third-party cog
+      
+      If you are requesting a command:
+        - Include what cog it should be in and a name for the command
+        - Describe the intended functionality for the command
+        - 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/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -1,20 +0,0 @@
-Please be sure to read through other issues as well to make sure what you are suggesting/reporting has not already
-been suggested/reported
-
-### Type:
-
-- [ ] Suggestion
-- [ ] Bug
-
-### Brief description of the problem
-
-### Expected behavior
-
-### Actual behavior
-
-### Steps to reproduce
-
-1. 
-2. 
-3. 
-4. 

.github/ISSUE_TEMPLATE/command_bug.md

@@ -1,34 +0,0 @@
----
-name: Bug reports for commands
-about: For bugs that involve commands found within Red
-title: ''
-labels: 'Type: Bug'
-assignees: ''
-
----
-
-# Command bugs
-
-<!-- 
-Did you find a bug with a command? Fill out the following:
--->
-
-#### Command name
-
-<!-- Replace this line with the name of the command -->
-
-#### What cog is this command from?
-
-<!-- Replace this line with the name of the cog -->
-
-#### What were you expecting to happen?
-
-<!-- Replace this line with a description of what you were expecting to happen -->
-
-#### What actually happened?
-
-<!-- Replace this line with a description of what actually happened. Include any error messages -->
-
-#### How can we reproduce this issue?
-
-<!-- Replace with numbered steps to reproduce the issue -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Support question
+    url: https://discord.gg/red
+    about: For any questions regarding on how to operate and run Red.

.github/ISSUE_TEMPLATE/feature_req.md

@@ -1,44 +0,0 @@
----
-name: Feature request
-about: For feature requests regarding Red itself.
-title: ''
-labels: 'Type: Feature'
-assignees: ''
-
----
-
-# Feature request
-
-<!-- This template is for feature requests. Please fill out the following: -->
-
-
-#### Select the type of feature you are requesting:
-
-<!-- To check a box, replace the space between the [] with a x -->
-
-- [ ] Cog
-- [ ] Command
-- [ ] API functionality
-
-#### Describe your requested feature
-
-<!--
-Feel free to describe in as much detail as you wish.
-
-If you are requesting a cog to be included in core: 
-    - Describe the functionality in as much detail as possible
-    - Include the command structure, if possible
-    - Please note that unless it's something that should be core functionality,
-      we reserve the right to reject your suggestion and point you to our cog 
-      board to request it for a third-party cog
-      
-If you are requesting a command:
-    - Include what cog it should be in and a name for the command
-    - Describe the intended functionality for the command
-    - Note any restrictions on who can use the command or where it can be used
-
-If you are requesting API functionality:
-    - Describe what it should do
-    - Note whether it is to extend existing functionality or introduce new functionality
-   
--->

.github/ISSUE_TEMPLATE/other_bug.md

@@ -1,30 +0,0 @@
----
-name: Bug report
-about: For bugs that don't involve a command.
-title: ''
-labels: 'Type: Bug'
-assignees: ''
-
----
-
-# Other bugs
-
-<!-- 
-Did you find a bug with something other than a command? Fill out the following:
--->
-
-#### What were you trying to do?
-
-<!-- Replace this line with a description of what you were trying to do -->
-
-#### What were you expecting to happen?
-
-<!-- Replace this line with a description of what you were expecting to happen -->
-
-#### What actually happened?
-
-<!-- Replace this line with a description of what actually happened. Include any error messages -->
-
-#### How can we reproduce this issue?
-
-<!-- Replace with numbered steps to reproduce the issue -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,0 @@
-### 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

@@ -0,0 +1,185 @@
+"Category: Admin":
+  # Source
+  - redbot/cogs/admin/*
+  # Docs
+  - docs/cog_guides/admin.rst
+"Category: Alias":
+  # Source
+  - redbot/cogs/alias/*
+  # Docs
+  - docs/cog_guides/alias.rst
+"Category: Audio Cog":
+  - any:
+      - redbot/cogs/audio/**/*
+    all:
+      - "!redbot/cogs/audio/**/locales/*"
+"Category: Bank API":
+  # Source
+  - redbot/core/bank.py
+  # Docs
+  - docs/framework_bank.rst
+"Category: Bank Cog":
+  # Source
+  - redbot/cogs/bank/*
+  # Docs
+  - docs/cog_guides/bank.rst
+"Category: Bot Core":
+  # Source
+  - redbot/*
+  - redbot/core/__init__.py
+  - redbot/core/_sharedlibdeprecation.py
+  - redbot/core/bot.py
+  - redbot/core/checks.py
+  - redbot/core/cli.py
+  - redbot/core/cog_manager.py
+  - redbot/core/core_commands.py
+  - redbot/core/data_manager.py
+  - redbot/core/errors.py
+  - redbot/core/events.py
+  - redbot/core/global_checks.py
+  - redbot/core/settings_caches.py
+  # Docs
+  - docs/framework_apikeys.rst
+  - docs/framework_bot.rst
+  - docs/framework_cogmanager.rst
+  - docs/framework_datamanager.rst
+  - docs/framework_events.rst
+  - docs/cog_guides/cog_manager_ui.rst
+  - docs/cog_guides/core.rst
+"Category: CI":
+  - .github/workflows/*
+"Category: Cleanup Cog":
+  # Source
+  - redbot/cogs/cleanup/*
+  # Docs
+  - docs/cog_guides/cleanup.rst
+"Category: Command Module":
+  # Source
+  - any:
+      # Source
+      - redbot/core/commands/*
+      # Docs
+      - docs/framework_checks.rst
+      - docs/framework_commands.rst
+    all:
+      - "!redbot/core/commands/help.py"
+"Category: Config":
+  # Source
+  - redbot/core/drivers/*
+  - redbot/core/config.py
+  # Docs
+  - docs/framework_config.rst
+"Category: CustomCom":
+  # Source
+  - redbot/cogs/customcom/*
+  # Docs
+  - docs/cog_customcom.rst
+  - docs/cog_guides/customcommands.rst
+"Category: Dev Cog":
+  - redbot/core/dev_commands.py
+"Category: Docs":
+  - docs/**/*
+"Category: Downloader":
+  # Source
+  - redbot/cogs/downloader/*
+  # Docs
+  - docs/cog_guides/downloader.rst
+"Category: Economy Cog":
+  # Source
+  - redbot/cogs/economy/*
+  # Docs
+  - docs/cog_guides/economy.rst
+"Category: Filter":
+  # Source
+  - redbot/cogs/filter/*
+  # Docs
+  - docs/cog_guides/filter.rst
+"Category: General Cog":
+  # Source
+  - redbot/cogs/general/*
+  # Docs
+  - docs/cog_guides/general.rst
+"Category: Help":
+  - redbot/core/commands/help.py
+"Category: i18n":
+  # Source
+  - redbot/core/i18n.py
+  # Locale files
+  - redbot/**/locales/*
+  # Docs
+  - docs/framework_i18n.rst
+"Category: Image":
+  # Source
+  - redbot/cogs/image/*
+  # Docs
+  - docs/cog_guides/image.rst
+"Category: Meta":
+  - ./*
+  - .github/*
+  - .github/ISSUE_TEMPLATE/*
+  - .github/PULL_REQUEST_TEMPLATE/*
+  - schema/*
+  - tools/*
+"Category: Mod Cog":
+  # Source
+  - redbot/cogs/mod/*
+  # Docs
+  - docs/cog_guides/mod.rst
+"Category: Modlog API":
+  # Source
+  - redbot/core/generic_casetypes.py
+  - redbot/core/modlog.py
+  # Docs
+  - docs/framework_modlog.rst
+"Category: 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
+  # Docs
+  - docs/framework_rpc.rst
+"Category: Streams":
+  # Source
+  - redbot/cogs/streams/*
+  # Docs
+  - docs/cog_guides/streams.rst
+"Category: Tests":
+  - redbot/pytest/*
+  - tests/**/*
+"Category: Trivia Cog":
+  # Source
+  - redbot/cogs/trivia/*
+  # Docs
+  - docs/cog_guides/trivia.rst
+  - docs/guide_trivia_list_creation.rst
+"Category: Trivia Lists":
+  - redbot/cogs/trivia/data/lists/*
+"Category: Utility Functions":
+  # Source
+  - redbot/core/utils/*
+  # Docs
+  - docs/framework_utils.rst
+"Category: Warnings":
+  # Source
+  - redbot/cogs/warnings/*
+  # Docs
+  - docs/cog_guides/warnings.rst

.github/workflows/auto_labeler_issues.yml

@@ -1,15 +1,18 @@
-name: Auto Labeler
+name: Auto Labeler - Issues
 on:
   issues:
     types: [opened]
 
+permissions:
+  issues: write
+
 jobs:
   build:
 
     runs-on: ubuntu-latest
     steps:
       - name: Apply Triage Label
-        uses: actions/github-script@0.4.0
+        uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |

.github/workflows/auto_labeler_pr.yml

@@ -0,0 +1,16 @@
+name: Auto Labeler - PRs
+on:
+  pull_request_target:
+
+permissions:
+  pull-requests: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply Type Label
+        uses: actions/labeler@v3
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          sync-labels: ""  # this is a temporary workaround, see #4844

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,58 @@
+name: "CodeQL"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 14 * * 4'
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      actions: read
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.8"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install -U pip setuptools wheel
+        python -m pip install -r ./tools/dev-requirements.txt
+        # Set the `CODEQL-PYTHON` environment variable to the Python executable
+        # that includes the dependencies
+        echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: 'python'
+        # Override the default behavior so that the action doesn't attempt
+        # to auto-install Python dependencies
+        # Learn more...
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#analyzing-python-dependencies
+        setup-python-dependencies: false
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/crowdin_upload_strings.yml

@@ -0,0 +1,32 @@
+name: Crowdin - Upload strings
+on:
+  push:
+    branches:
+      - V3/develop
+
+jobs:
+  deploy:
+    if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        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.3
+    - name: Generate source files
+      run: |
+        make gettext
+    - name: Upload source files
+      run: |
+        make upload_translations
+      env:
+        CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
+        CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}

.github/workflows/lint_python.yaml

@@ -17,9 +17,9 @@ jobs:
       - uses: actions/checkout@v2
         with:
           ref: ${{ env.ref }}
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v2
         with:
-          python_version: "3.8"
+          python-version: "3.8"
       - run: "python -m pip install git+https://github.com/pycqa/pyflakes@1911c20#egg=pyflakes git+https://github.com/pycqa/pycodestyle@d219c68#egg=pycodestyle git+https://gitlab.com/pycqa/flake8@3.7.9#egg=flake8"
         name: Install Flake8
       - run: "python -m flake8 . --count --select=E9,F7,F82 --show-source"

.github/workflows/prepare_release.yml

@@ -0,0 +1,130 @@
+name: Prepare Release
+on:
+  workflow_dispatch:
+    inputs:
+      new_stable_version:
+        description: Version number for the new stable release (leave empty to just strip `.dev1`)
+        required: false
+        default: 'auto'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  crowdin_download_translations:
+    needs: pr_stable_bump
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - name: Install dependencies
+        run: |
+          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.3
+
+      - name: Generate source files
+        run: |
+          make gettext
+      - name: Download translations
+        run: |
+          make download_translations
+        env:
+          CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
+          CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}
+
+      - name: Create Pull Request
+        id: cpr_crowdin
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Automated Crowdin downstream
+          title: "[i18n] Automated Crowdin downstream"
+          body: |
+            This is an automated PR that is part of Prepare Release automated workflow (2 out of 2).
+            Please ensure that there are no errors or invalid files are in the PR.
+          labels: "Automated PR, Category: i18n, Changelog Entry: Skipped"
+          branch: "automated/i18n"
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          milestone: ${{ needs.pr_stable_bump.outputs.milestone_number }}
+
+      - name: Close and reopen the PR with different token to trigger CI
+        uses: actions/github-script@v3
+        env:
+          PR_NUMBER: ${{ steps.cpr_crowdin.outputs.pull-request-number }}
+          PR_OPERATION: ${{ steps.cpr_crowdin.outputs.pull-request-operation }}
+        with:
+          github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
+            );
+            console.log(script({github, context}));
+
+  pr_stable_bump:
+    runs-on: ubuntu-latest
+    outputs:
+      milestone_number: ${{ steps.get_milestone_number.outputs.result }}
+    steps:
+      # Checkout repository and install Python
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      # Create PR for stable version bump
+      - name: Update Red version number from input
+        id: bump_version_stable
+        run: |
+          python .github/workflows/scripts/bump_version.py
+        env:
+          PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
+          NEW_STABLE_VERSION: ${{ github.event.inputs.new_stable_version }}
+
+      # Get milestone number of the milestone for the new stable version
+      - name: Get milestone number
+        id: get_milestone_number
+        uses: actions/github-script@v3
+        env:
+          MILESTONE_TITLE: ${{ steps.bump_version_stable.outputs.new_version }}
+        with:
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/get_milestone_number_by_exact_title.js`
+            );
+            return await script({github, context});
+
+      - name: Create Pull Request
+        id: cpr_bump_stable
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Version bump to ${{ steps.bump_version_stable.outputs.new_version }}
+          title: Version bump to ${{ steps.bump_version_stable.outputs.new_version }}
+          body: |
+            This is an automated PR that is part of Prepare Release automated workflow (1 out of 2).
+            Please ensure that there are no errors or invalid files are in the PR.
+          labels: "Automated PR, Changelog Entry: Skipped"
+          branch: "automated/pr_bumps/${{ steps.bump_version_stable.outputs.new_version }}"
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          milestone: ${{ steps.get_milestone_number.outputs.result }}
+
+      - name: Close and reopen the PR with different token to trigger CI
+        uses: actions/github-script@v3
+        env:
+          PR_NUMBER: ${{ steps.cpr_bump_stable.outputs.pull-request-number }}
+          PR_OPERATION: ${{ steps.cpr_bump_stable.outputs.pull-request-operation }}
+        with:
+          github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
+            );
+            console.log(await script({github, context}));

.github/workflows/publish_crowdin.yml

@@ -1,51 +0,0 @@
-name: Publish to Crowdin
-on:
-  schedule:
-    - cron: '0 12 * * THU'
-  repository_dispatch:
-    types: crowdin
-
-env:
-  CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
-  CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}
-
-jobs:
-  deploy:
-    if: github.repository == 'Cog-Creators/Red-DiscordBot'
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v1
-      with:
-        python-version: '3.8'
-    - name: Install dependencies
-      run: |
-        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
-    - name: Generate source files
-      run: |
-        make gettext
-    - name: Upload source files
-      run: |
-        make upload_translations
-    - name: Download translations
-      run: |
-        make download_translations
-    - name: Remove files from PR which only have a date changed
-      run: |
-        git checkout HEAD -- $(git diff HEAD --numstat | awk 'BEGIN {ORS=" "} $1 == "1" && $2 == "1" && $3 ~ /.po$/ {print $3}')
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v2
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        commit-message: Automated Crowdin downstream
-        title: "[i18n] Automated Crowdin downstream"
-        body: |
-          This is an automated PR.
-          Please ensure that there are no errors or invalid files are in the PR.
-        labels: "Automated PR, Category: i18n, Changelog Entry: Skipped"
-        branch: "automated/i18n"

.github/workflows/publish_pypi.yml

@@ -1,27 +0,0 @@
-name: Publish to PyPI
-on:
-  push:
-    tags:
-     - "*"
-
-jobs:
-  deploy:
-    if: github.repository == 'Cog-Creators/Red-DiscordBot'
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v1
-      with:
-        python-version: '3.8'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.pypi_token }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*

.github/workflows/publish_release.yml

@@ -0,0 +1,93 @@
+name: Publish Release
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release_to_pypi:
+    if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: V3/develop
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.pypi_token }}
+        run: |
+          python -m build
+          twine upload dist/*
+
+  pr_dev_bump:
+    permissions:
+      contents: write
+      pull-requests: write
+    needs: release_to_pypi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+
+      # Version bump to development version
+      - name: Update Red version number to dev
+        id: bump_version_dev
+        run: |
+          python .github/workflows/scripts/bump_version.py
+        env:
+          PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
+          DEV_BUMP: '1'
+
+      # Get milestone number of the milestone for the old version
+      - name: Get milestone number
+        id: get_milestone_number
+        uses: actions/github-script@v3
+        env:
+          MILESTONE_TITLE: ${{ steps.bump_version_dev.outputs.old_version }}
+        with:
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/get_milestone_number_by_exact_title.js`
+            );
+            return await script({github, context});
+
+      - name: Create Pull Request
+        id: cpr_bump_dev
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Version bump to ${{ steps.bump_version_dev.outputs.new_version }}
+          title: Version bump to ${{ steps.bump_version_dev.outputs.new_version }}
+          body: |
+            This is an automated PR.
+            Please ensure that there are no errors or invalid files are in the PR.
+          labels: "Automated PR, Changelog Entry: Skipped"
+          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: V3/develop
+
+      - name: Close and reopen the PR with different token to trigger CI
+        uses: actions/github-script@v3
+        env:
+          PR_NUMBER: ${{ steps.cpr_bump_dev.outputs.pull-request-number }}
+          PR_OPERATION: ${{ steps.cpr_bump_dev.outputs.pull-request-operation }}
+        with:
+          github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
+            );
+            console.log(await script({github, context}));

.github/workflows/scripts/bump_version.py

@@ -0,0 +1,47 @@
+import os
+import re
+import sys
+from typing import Match
+
+import redbot
+
+
+version_info = None
+
+
+def repl(match: Match[str]) -> str:
+    global version_info
+
+    print(f"::set-output name=old_version::{match.group('version')}")
+
+    new_stable_version = os.environ.get("NEW_STABLE_VERSION", "auto")
+    if new_stable_version == "auto":
+        version_info = redbot.VersionInfo.from_str(match.group("version"))
+        version_info.dev_release = None
+    else:
+        version_info = redbot.VersionInfo.from_str(new_stable_version)
+
+    if int(os.environ.get("DEV_BUMP", 0)):
+        version_info.micro += 1
+        version_info.dev_release = 1
+
+    return f'__version__ = "{version_info}"'
+
+
+with open("redbot/__init__.py", encoding="utf-8") as fp:
+    new_contents, found = re.subn(
+        pattern=r'^__version__ = "(?P<version>[^"]*)"$',
+        repl=repl,
+        string=fp.read(),
+        count=1,
+        flags=re.MULTILINE,
+    )
+
+if not found:
+    print("Couldn't find `__version__` line!")
+    sys.exit(1)
+
+with open("redbot/__init__.py", "w", encoding="utf-8", newline="\n") as fp:
+    fp.write(new_contents)
+
+print(f"::set-output name=new_version::{version_info}")

.github/workflows/scripts/close_and_reopen_pr.js

@@ -0,0 +1,25 @@
+module.exports = (async function ({github, context}) {
+    const pr_number = process.env.PR_NUMBER;
+    const pr_operation = process.env.PR_OPERATION;
+    let sleep_time = 0;
+
+    if (!['created', 'updated'].includes(pr_operation)) {
+        console.log('PR was not created as there were no changes.')
+        return;
+    }
+
+    for (const new_state of ['closed', 'open']) {
+        // some sleep time needed to make sure API handles open after close
+        if (sleep_time)
+            await new Promise(r => setTimeout(r, sleep_time));
+
+        github.issues.update({
+            issue_number: pr_number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            state: new_state
+        });
+
+        sleep_time = 2000;
+    }
+})

.github/workflows/scripts/get_milestone_number_by_exact_title.js

@@ -0,0 +1,49 @@
+module.exports = (async function ({github, context}) {
+    const milestone_title = process.env.MILESTONE_TITLE;
+    const [repo_owner, repo_name] = process.env.GITHUB_REPOSITORY.split('/');
+
+    const {
+        repository: {
+            milestones: {
+                nodes: milestones,
+                pageInfo: {hasNextPage}
+            }
+        }
+    } = await github.graphql({
+        query: `
+        query getMilestoneNumberByTitle(
+          $repo_owner: String!
+          $repo_name: String!
+          $milestone_title: String!
+        ) { 
+          repository(owner:$repo_owner name:$repo_name) {
+            milestones(query:$milestone_title states:OPEN first:100) {
+              nodes {
+                number
+                title
+              }
+              pageInfo {
+                hasNextPage
+              }
+            }
+          }
+        }`,
+        repo_owner: repo_owner,
+        repo_name: repo_name,
+        milestone_title: milestone_title,
+    });
+
+    if (hasNextPage) {
+        // this should realistically never happen so let's just error
+        core.setFailed('Impossible happened! :)');
+        return;
+    }
+
+    for (const milestone of milestones)
+        if (milestone.title === milestone_title)
+            return milestone.number;
+
+    // if no exact match is found, assume the milestone doesn't exist
+    console.log('The milestone was not found. API returned the array: %o', milestones);
+    return null;
+})

.github/workflows/tests.yml

@@ -34,7 +34,7 @@ jobs:
           with:
             ref: ${{ env.ref }}
         - name: Set up Python
-          uses: actions/setup-python@v1
+          uses: actions/setup-python@v2
           with:
             python-version: ${{ matrix.python_version }}
         - name: Install tox
@@ -68,7 +68,7 @@ jobs:
           with:
             ref: ${{ env.ref }}
         - name: Set up Python
-          uses: actions/setup-python@v1
+          uses: actions/setup-python@v2
           with:
             python-version: ${{ matrix.python_version }}
         - name: Install tox

.gitignore

@@ -1,4 +1,3 @@
-*.json
 *.exe
 *.dll
 *.pot
@@ -15,6 +14,9 @@ Pipfile.lock
 # User-specific stuff:
 .idea/
 *.iws
+.vscode/
+*.sublime-project
+*.sublime-workspace
 
 ## Plugin-specific files:
 
@@ -141,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!
 
@@ -83,7 +83,7 @@ We're using [tox](https://github.com/tox-dev/tox) to run all of our tests. It's
 Currently, tox does the following, creating its own virtual environments for each stage:
 - Runs all of our unit tests with [pytest](https://github.com/pytest-dev/pytest) on python 3.8 (test environment `py38`)
 - Ensures documentation builds without warnings, and all hyperlinks have a valid destination (test environment `docs`)
-- Ensures that the code meets our style guide with [black](https://github.com/ambv/black) (test environment `style`)
+- Ensures that the code meets our style guide with [black](https://github.com/psf/black) (test environment `style`)
 
 To run all of these tests, just run the command `tox` in the project directory.
 
@@ -92,9 +92,9 @@ To run a subset of these tests, use the command `tox -e <env>`, where `<env>` is
 Your PR will not be merged until all of these tests pass.
 
 ### 4.3 Style
-Our style checker of choice, [black](https://github.com/ambv/black), actually happens to be an auto-formatter. The checking functionality simply detects whether or not it would try to reformat something in your code, should you run the formatter on it. For this reason, we recommend using this tool as a formatter, regardless of any disagreements you might have with the style it enforces.
+Our style checker of choice, [black](https://github.com/psf/black), actually happens to be an auto-formatter. The checking functionality simply detects whether or not it would try to reformat something in your code, should you run the formatter on it. For this reason, we recommend using this tool as a formatter, regardless of any disagreements you might have with the style it enforces.
 
-Use the command `black --help` to see how to use this tool. The full style guide is explained in detail on [black's GitHub repository](https://github.com/ambv/black). **There is one exception to this**, however, which is that we set the line length to 99, instead of black's default 88. This is already set in `pyproject.toml` configuration file in the repo so you can simply format code with Black like so: `black <src>`.
+Use the command `black --help` to see how to use this tool. The full style guide is explained in detail on [black's GitHub repository](https://github.com/psf/black). **There is one exception to this**, however, which is that we set the line length to 99, instead of black's default 88. This is already set in `pyproject.toml` configuration file in the repo so you can simply format code with Black like so: `black <src>`.
 
 ### 4.4 Make
 You may have noticed we have a `Makefile` and a `make.bat` in the top-level directory. For now, you can do a few things with them:

LICENSE

@@ -632,7 +632,8 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     Red - A fully customizable Discord bot
-    Copyright (C) 2015-2020  Twentysix
+    Copyright (C) 2017-2021  Cog Creators
+    Copyright (C) 2015-2017  Twentysix
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +653,8 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    Red-DiscordBot  Copyright (C) 2015-2020  Twentysix
+    Red-DiscordBot  Copyright (C) 2017-2021  Cog Creators
+    Red-DiscordBot  Copyright (C) 2015-2017  Twentysix
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -700,3 +702,6 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+This project vendors discord.ext.menus package (https://github.com/Rapptz/discord-ext-menus) made by Danny Y. (Rapptz) which is distributed under MIT License.
+Copy of this license can be found in discord-ext-menus.LICENSE file in redbot/vendored folder of this repository.

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]

Makefile

@@ -1,12 +1,41 @@
+.DEFAULT_GOAL := help
+
 PYTHON ?= python3.8
 
+ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+
+ifneq ($(wildcard $(ROOT_DIR)/.venv/.),)
+	VENV_PYTHON = $(ROOT_DIR)/.venv/bin/python
+else
+	VENV_PYTHON = $(PYTHON)
+endif
+
+define HELP_BODY
+Usage:
+  make <command>
+
+Commands:
+  reformat                   Reformat all .py files being tracked by git.
+  stylecheck                 Check which tracked .py files need reformatting.
+  stylediff                  Show the post-reformat diff of the tracked .py files
+                             without modifying them.
+  gettext                    Generate pot files.
+  upload_translations        Upload pot files to Crowdin.
+  download_translations      Download translations from Crowdin.
+  bumpdeps                   Run script bumping dependencies.
+  newenv                     Create or replace this project's virtual environment.
+  syncenv                    Sync this project's virtual environment to Red's latest
+                             dependencies.
+endef
+export HELP_BODY
+
 # Python Code Style
 reformat:
-	$(PYTHON) -m black `git ls-files "*.py"`
+	$(VENV_PYTHON) -m black $(ROOT_DIR)
 stylecheck:
-	$(PYTHON) -m black --check `git ls-files "*.py"`
+	$(VENV_PYTHON) -m black --check $(ROOT_DIR)
 stylediff:
-	$(PYTHON) -m black --check --diff `git ls-files "*.py"`
+	$(VENV_PYTHON) -m black --check --diff $(ROOT_DIR)
 
 # Translations
 gettext:
@@ -23,7 +52,11 @@ bumpdeps:
 # Development environment
 newenv:
 	$(PYTHON) -m venv --clear .venv
-	.venv/bin/pip install -U pip setuptools
+	.venv/bin/pip install -U pip setuptools wheel
 	$(MAKE) syncenv
 syncenv:
 	.venv/bin/pip install -Ur ./tools/dev-requirements.txt
+
+# Help
+help:
+	@echo "$$HELP_BODY"

README.md

@@ -12,32 +12,35 @@
   <a href="https://discord.gg/red">
     <img src="https://discordapp.com/api/guilds/133049272517001216/widget.png?style=shield" alt="Discord Server">
   </a>
-  <a href="https://www.patreon.com/Red_Devs">
-    <img src="https://img.shields.io/badge/Support-Red!-yellow.svg" alt="Support Red on Patreon!">
+  <a href="https://pypi.org/project/Red-DiscordBot/">
+     <img alt="PyPI" src="https://img.shields.io/pypi/v/Red-Discordbot">
   </a>
   <a href="https://www.python.org/downloads/">
-    <img src="https://img.shields.io/badge/Made%20With-Python%203.8-blue.svg?style=for-the-badge" alt="Made with Python 3.8">
-  </a>
-  <a href="https://crowdin.com/project/red-discordbot">
-    <img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg" alt="Localized with Crowdin">
+    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/Red-Discordbot">
   </a>
   <a href="https://github.com/Rapptz/discord.py/">
-      <img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
+     <img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
+  </a>
+  <a href="https://www.patreon.com/Red_Devs">
+    <img src="https://img.shields.io/badge/Support-Red!-red.svg" alt="Support Red on Patreon!">
   </a>
 </p>
 <p align="center">
   <a href="https://github.com/Cog-Creators/Red-DiscordBot/actions">
-    <img src="https://github.com/Cog-Creators/Red-DiscordBot/workflows/Tests/badge.svg" alt="GitHub Actions">
+    <img src="https://img.shields.io/github/workflow/status/Cog-Creators/Red-Discordbot/Tests?label=tests" alt="GitHub Actions">
   </a>
   <a href="http://red-discordbot.readthedocs.io/en/stable/?badge=stable">
     <img src="https://readthedocs.org/projects/red-discordbot/badge/?version=stable" alt="Red on readthedocs.org">
   </a>
-  <a href="https://github.com/ambv/black">
+  <a href="https://github.com/psf/black">
     <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
   </a>
   <a href="http://makeapullrequest.com">
     <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
   </a>
+  <a href="https://crowdin.com/project/red-discordbot">
+    <img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg" alt="Localized with Crowdin">
+  </a>
 </p>
 
 <p align="center">
@@ -57,19 +60,19 @@
 # Overview
 
 Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your
-liking, making it completely customizable. This is also a *self-hosted bot* – meaning you will need
+liking, making it completely customizable. This is a *self-hosted bot* – meaning you will need
 to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot,
 new best friend or all of these together!  
 
 [Installation](#installation) is easy, and you do **NOT** need to know anything about coding! Aside
-from installation and updating, every part of the bot can be controlled from within Discord.
+from installing and updating, every part of the bot can be controlled from within Discord.
 
 **The default set of modules includes and is not limited to:**
 
 - 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, Mixer, Hitbox, Picarto)
+- Stream alerts (Twitch, Youtube, Picarto)
 - Bank (slot machine, user credits)
 - Custom commands
 - Imgur/gif search
@@ -104,14 +107,14 @@ plugins directly from Discord! A few examples are:
 - AniList
 - And much, much more!
 
-Feel free to take a [peek](https://cogboard.red/t/approved-repositories/210) at a list of
+Feel free to take a [peek](https://index.discord.red) at a list of
 available 3rd party cogs!
 
 # Join the community!
 
 **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!
 
@@ -126,3 +129,6 @@ Red is named after the main character of "Transistor", a video game by
 
 Artwork created by [Sinlaire](https://sinlaire.deviantart.com/) on Deviant Art for the Red Discord
 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.
+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/_ext/deprecated_removed.py

@@ -0,0 +1,129 @@
+"""
+A Sphinx extension adding a ``deprecated-removed`` directive that works
+similarly to CPython's directive with the same name.
+
+The key difference is that instead of passing the version of planned removal,
+the writer must provide the minimum amount of days that must pass
+since the date of the release it was deprecated in.
+
+Due to lack of a concrete release schedule for Red, this ensures that
+we give enough time to people affected by the changes no matter
+when the releases actually happen.
+
+`DeprecatedRemoved` class is heavily based on
+`sphinx.domains.changeset.VersionChange` class that is available at:
+https://github.com/sphinx-doc/sphinx/blob/0949735210abaa05b6448e531984f159403053f4/sphinx/domains/changeset.py
+
+Copyright 2007-2020 by the Sphinx team, see AUTHORS:
+https://github.com/sphinx-doc/sphinx/blob/82f495fed386c798735adf675f867b95d61ee0e1/AUTHORS
+
+The original copy was distributed under BSD License and this derivative work
+is distributed under GNU GPL Version 3.
+"""
+
+import datetime
+import multiprocessing
+import subprocess
+from typing import Any, Dict, List, Optional
+
+from docutils import nodes
+from sphinx import addnodes
+from sphinx.application import Sphinx
+from sphinx.util.docutils import SphinxDirective
+
+
+class TagDateCache:
+    def __init__(self) -> None:
+        self._tags: Dict[str, datetime.date] = {}
+
+    def _populate_tags(self) -> None:
+        with _LOCK:
+            if self._tags:
+                return
+            out = subprocess.check_output(
+                ("git", "tag", "-l", "--format", "%(creatordate:raw)\t%(refname:short)"),
+                text=True,
+            )
+            lines = out.splitlines(False)
+            for line in lines:
+                creator_date, tag_name = line.split("\t", maxsplit=1)
+                timestamp = int(creator_date.split(" ", maxsplit=1)[0])
+                self._tags[tag_name] = datetime.datetime.fromtimestamp(
+                    timestamp, tz=datetime.timezone.utc
+                ).date()
+
+    def get_tag_date(self, tag_name: str) -> Optional[datetime.date]:
+        self._populate_tags()
+        return self._tags.get(tag_name)
+
+
+_LOCK = multiprocessing.Manager().Lock()
+_TAGS = TagDateCache()
+
+
+class DeprecatedRemoved(SphinxDirective):
+    has_content = True
+    required_arguments = 2
+    optional_arguments = 1
+    final_argument_whitespace = True
+
+    def run(self) -> List[nodes.Node]:
+        # Some Sphinx stuff
+        node = addnodes.versionmodified()
+        node.document = self.state.document
+        self.set_source_info(node)
+        node["type"] = self.name
+        node["version"] = tuple(self.arguments)
+        if len(self.arguments) == 3:
+            inodes, messages = self.state.inline_text(self.arguments[2], self.lineno + 1)
+            para = nodes.paragraph(self.arguments[2], "", *inodes, translatable=False)
+            self.set_source_info(para)
+            node.append(para)
+        else:
+            messages = []
+
+        # Text generation
+        deprecation_version = self.arguments[0]
+        minimum_days = int(self.arguments[1])
+        tag_date = _TAGS.get_tag_date(deprecation_version)
+        text = (
+            f"Will be deprecated in version {deprecation_version},"
+            " and removed in the first minor version that gets released"
+            f" after {minimum_days} days since deprecation"
+            if tag_date is None
+            else f"Deprecated since version {deprecation_version},"
+            " will be removed in the first minor version that gets released"
+            f" after {tag_date + datetime.timedelta(days=minimum_days)}"
+        )
+
+        # More Sphinx stuff
+        if self.content:
+            self.state.nested_parse(self.content, self.content_offset, node)
+        classes = ["versionmodified"]
+        if len(node):
+            if isinstance(node[0], nodes.paragraph) and node[0].rawsource:
+                content = nodes.inline(node[0].rawsource, translatable=True)
+                content.source = node[0].source
+                content.line = node[0].line
+                content += node[0].children
+                node[0].replace_self(nodes.paragraph("", "", content, translatable=False))
+
+            node[0].insert(0, nodes.inline("", f"{text}: ", classes=classes))
+        else:
+            para = nodes.paragraph(
+                "", "", nodes.inline("", f"{text}.", classes=classes), translatable=False
+            )
+            node.append(para)
+
+        ret = [node]
+        ret += messages
+
+        return ret
+
+
+def setup(app: Sphinx) -> Dict[str, Any]:
+    app.add_directive("deprecated-removed", DeprecatedRemoved)
+    return {
+        "version": "1.0",
+        "parallel_read_safe": True,
+    }

docs/autostart_mac.rst

@@ -0,0 +1,109 @@
+.. 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: 
+
+- all instances of :code:`username` with your Mac username 
+- :code:`path` with the path you copied earlier
+- :code:`instance-name` with your instance name:
+
+.. code-block:: none
+
+    <?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,44 +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:
-
-:code:`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, such as :code:`--dev`.
-
-.. code-block:: none
-
-    pm2 start redbot --name "<Insert a name here>" --interpreter "<Location to your Python Interpreter>" --interpreter-args "-O" -- <Red Instance> --no-prompt
-
-.. code-block:: none
-
-    Arguments to replace.
-
-    <Insert a name here>
-    A name to identify the bot within pm2, this is not your Red instance.
-
-    <Location to your Python Interpreter>
-    The location of your Python interpreter, to find out where that is use the following command inside activated venv:
-    which python
-
-    <Red Instance>
-    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:
-
-:code:`pm2 save` & :code:`pm2 startup`

docs/autostart_systemd.rst

@@ -4,6 +4,8 @@
 Setting up auto-restart using systemd on Linux
 ==============================================
 
+.. note:: This guide is for setting up systemd on a Linux environment. This guide assumes that you already have a working Red instance.
+
 -------------------------
 Creating the service file
 -------------------------
@@ -12,25 +14,27 @@ In order to create the service file, you will first need to know two things, you
 
 First, your Linux :code:`username` can be fetched with the following command:
 
-.. code-block:: bash
+.. prompt:: bash
 
     whoami
 
 Next, your python :code:`path` can be fetched with the following commands:
 
-.. code-block:: bash
+.. prompt:: bash
+    :prompts: $,(redenv) $
+    :modifiers: auto
 
     # If redbot is installed in a venv
-    source ~/redenv/bin/activate
-    which python
+    $ source ~/redenv/bin/activate
+    (redenv) $ which python
 
     # If redbot is installed in a pyenv virtualenv
-    pyenv shell <virtualenv_name>
-    pyenv which python
+    $ pyenv shell <virtualenv_name>
+    (redenv) $ pyenv which python
 
 Then create the new service file:
 
-:code:`sudo -e /etc/systemd/system/red@.service`
+:code:`sudo nano /etc/systemd/system/red@.service`
 
 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.
 
@@ -65,20 +69,34 @@ Starting and enabling the service
 
 To start the bot, run the service and add the instance name after the **@**:
 
-:code:`sudo systemctl start red@instancename`
+.. prompt:: bash
+
+    sudo systemctl start red@instancename
 
 To set the bot to start on boot, you must enable the service, again adding the instance name after the **@**:
 
-:code:`sudo systemctl enable red@instancename`
+.. prompt:: bash
+
+    sudo systemctl enable red@instancename
 
 If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
 type the following command in the terminal, still by adding the instance name after the **@**:
 
-:code:`sudo systemctl stop red@instancename`
+.. prompt:: bash
+
+    sudo systemctl stop red@instancename
 
 .. 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 **@**:
 
-:code:`sudo journalctl -eu red@instancename`
+.. prompt:: bash
+
+    sudo systemctl disable red@instancename
+
+You can access Red's log through journalctl:
+
+.. prompt:: bash
+
+    sudo journalctl -eu red@instancename

docs/bot_application_guide.rst

@@ -0,0 +1,79 @@
+===========================================
+Creating a bot account
+===========================================
+
+To use Red you will require a bot account and to enable privileged intents. Both these steps will be covered below.
+
+.. _creating-a-bot-account:
+
+-------------------------------
+Creating the bot application
+-------------------------------
+
+In order to use Red, we must first create a Discord Bot account.
+
+Creating a Bot account is a pretty straightforward process.
+
+1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
+2. Navigate to the `application page <https://discord.com/developers/applications>`_
+3. Click on the "New Application" button.
+
+    .. image:: /.resources/bot-guide/discord_create_app_button.png
+        :alt: The new application button.
+
+4. Give the application a name and click "Create".
+
+    .. image::  /.resources/bot-guide/discord_create_app_form.png
+        :alt: The new application form filled in.
+
+5. Create a Bot User by navigating to the "Bot" tab and clicking "Add Bot".
+
+    - Click "Yes, do it!" to continue.
+
+    .. image::  /.resources/bot-guide/discord_create_bot_user.png
+        :alt: The Add Bot button.
+6. If you want others to be able to invite your bot tick the **Public Bot**. Keeping it unticked will prevent others from inviting your bot to their servers and only you will be able to add the bot to servers (provided that you have needed permissions in the server you want to add the bot to).
+
+    - Make sure **Require OAuth2 Code Grant** is unchecked.
+
+    .. image::  /.resources/bot-guide/discord_bot_user_options.png
+        :alt: How the Bot User options should look like for most people.
+
+7. Copy the token using the "Copy" button.
+
+    - **This is not the Client Secret at the General Information page**
+
+    .. warning::
+
+        Do not share your token as it is like your password.
+        If you shared your token you can regenerate it.
+
+Continue to the next section to enable privileged intents.
+
+.. _enabling-privileged-intents:
+
+-------------------------------
+Enabling Privileged Intents
+-------------------------------
+.. warning::
+    Due to Discord API changes, Red Bot requires all intents.
+    \This section is required.
+
+1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
+2. Navigate to the `application page <https://discord.com/developers/applications>`_
+3. Click on the bot you want to enable privileged intents for.
+4. Navigate to the bot tab on the left side of the screen.
+
+    .. image:: /.resources/bot-guide/discord_bot_tab.png
+        :alt: The bot tab in the application page.
+
+5. Scroll down to the "Privileged Gateway Intents" section, enable both privileged intents and save your changes.
+
+    .. image:: /.resources/bot-guide/discord_privileged_intents.png
+        :alt: The privileged gateway intents selector.
+
+.. 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.
+
+*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

@@ -1,5 +1,542 @@
 .. 3.3.x Changelogs
 
+Redbot 3.3.12 (2020-08-18)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`Dav-Git`, :ghuser:`douglas-cpp`, :ghuser:`flaree`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`MeatyChunks`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`thisisjvgrace`, :ghuser:`Vexed01`, :ghuser:`zephyrkul`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Red now logs clearer error if it can't find package to load in any cog path during bot startup (:issue:`4079`)
+
+Mod
+***
+
+- ``[p]mute voice`` and ``[p]unmute voice`` now take action instantly if bot has Move Members permission (:issue:`4064`)
+- Added typing to ``[p](un)mute guild`` to indicate that mute is being processed (:issue:`4066`, :issue:`4172`)
+
+Streams
+*******
+
+- Improve error messages for invalid channel names/IDs (:issue:`4147`, :issue:`4148`)
+
+Trivia Lists
+************
+
+- Added ``whosthatpokemon2`` trivia containing Pokémons from 2nd generation (:issue:`4102`)
+- Added ``whosthatpokemon3`` trivia containing Pokémons from 3rd generation (:issue:`4141`)
+
+
+Miscellaneous
+-------------
+
+- Updated features list in ``[p]serverinfo`` with the latest changes from Discord (:issue:`4116`)
+- Simple version of ``[p]serverinfo`` now shows info about more detailed ``[p]serverinfo 1`` (:issue:`4121`)
+
+
+Redbot 3.3.11 (2020-08-10)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`douglas-cpp`, :ghuser:`Drapersniper`, :ghuser:`Flame`, :ghuser:`jack1142`, :ghuser:`MeatyChunks`, :ghuser:`Vexed01`, :ghuser:`yamikaitou`
+
+End-user changelog
+------------------
+
+Audio
+*****
+
+- Audio should now work again on all voice regions (:issue:`4162`, :issue:`4168`)
+- Removed an edge case where an unfriendly error message was sent in Audio cog (:issue:`3879`)
+
+Cleanup
+*******
+
+- Fixed a bug causing ``[p]cleanup`` commands to clear all messages within last 2 weeks when ``0`` is passed as the amount of messages to delete (:issue:`4114`, :issue:`4115`)
+
+CustomCommands
+**************
+
+- ``[p]cc show`` now sends an error message when command with the provided name couldn't be found (:issue:`4108`)
+
+Downloader
+**********
+
+- ``[p]findcog`` no longer fails for 3rd-party cogs without any author (:issue:`4032`, :issue:`4042`)
+- Update commands no longer crash when a different repo is added under a repo name that was once used (:issue:`4086`)
+
+Permissions
+***********
+
+- ``[p]permissions removeserverrule`` and ``[p]permissions removeglobalrule`` no longer error when trying to remove a rule that doesn't exist (:issue:`4028`, :issue:`4036`)
+
+Warnings
+********
+
+- ``[p]warn`` now sends an error message (instead of no feedback) when an unregistered reason is used by someone who doesn't have Administrator permission (:issue:`3839`, :issue:`3840`)
+
+
+Redbot 3.3.10 (2020-07-09)
+==========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`bobloy`, :ghuser:`Dav-Git`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`Injabie3`, :ghuser:`jack1142`, :ghuser:`mikeshardmind`, :ghuser:`MiniJennJenn`, :ghuser:`NeuroAssassin`, :ghuser:`thisisjvgrace`, :ghuser:`Vexed01`
+
+End-user changelog
+------------------
+
+Audio
+*****
+
+- Added information about internally managed jar to ``[p]audioset info`` (:issue:`3915`)
+- Updated to Lavaplayer 1.3.50
+- Twitch playback and YouTube searching should be functioning again.
+
+Core Bot
+********
+
+- Fixed delayed help when ``[p]set deletedelay`` is enabled (:issue:`3884`, :issue:`3883`)
+- Bumped the Discord.py requirement from 1.3.3 to 1.3.4 (:issue:`4053`)
+- Added settings view commands for nearly all cogs. (:issue:`4041`)
+- Added more strings to be fully translatable by i18n. (:issue:`4044`)
+
+Downloader
+**********
+
+- Added ``[p]cog listpinned`` subcommand to see currently pinned cogs (:issue:`3974`)
+- Fixed unnecessary typing when running downloader commands (:issue:`3964`, :issue:`3948`)
+- Added embed version of ``[p]findcog`` (:issue:`3965`, :issue:`3944`)
+- Fixed ``[p]findcog`` not differentiating between core cogs and local cogs(:issue:`3969`, :issue:`3966`)
+
+Filter
+******
+
+- Added ``[p]filter list`` to show filtered words, and removed DMs when no subcommand was passed (:issue:`3973`)
+
+Image
+*****
+
+- Updated instructions for obtaining and setting the GIPHY API key (:issue:`3994`)
+
+Mod
+***
+
+- Added option to delete messages within the passed amount of days with ``[p]tempban`` (:issue:`3958`)
+- Added the ability to permanently ban a temporary banned user with ``[p]hackban`` (:issue:`4025`)
+- Fixed the passed reason not being used when using ``[p]tempban`` (:issue:`3958`)
+- Fixed invite being sent with ``[p]tempban`` even when no invite was set (:issue:`3991`)
+- Prevented an issue whereby the author may lock him self out of using the bot via whitelists (:issue:`3903`)
+- Reduced the number of API calls made to the storage APIs (:issue:`3910`)
+
+Permissions
+***********
+
+- Uploaded YAML files now accept integer commands without quotes (:issue:`3987`, :issue:`3185`)
+- Uploaded YAML files now accept command rules with empty dictionaries (:issue:`3987`, :issue:`3961`)
+
+Streams
+*******
+
+- Fixed streams cog sending multiple owner notifications about twitch secret not set (:issue:`3901`, :issue:`3587`)
+- Fixed old bearer tokens not being invalidated when the API key is updated (:issue:`3990`, :issue:`3917`)
+
+Trivia Lists
+************
+
+- Fixed URLs in ``whosthatpokemon`` (:issue:`3975`, :issue:`3023`)
+- Fixed trivia files ``leagueults`` and ``sports`` (:issue:`4026`)
+- Updated ``greekmyth`` to include more answer variations (:issue:`3970`)
+- Added new ``lotr`` trivia list (:issue:`3980`)
+- Added new ``r6seige`` trivia list (:issue:`4026`)
+
+
+Developer changelog
+-------------------
+
+- Added the utility functions ``map``, ``find``, and ``next`` to ``AsyncIter`` (:issue:`3921`, :issue:`3887`)
+- Updated deprecation times for ``APIToken``, and loops being passed to various functions to the first minor release (represented by ``X`` in ``3.X.0``) after 2020-08-05 (:issue:`3608`)
+- Updated deprecation warnings for shared libs to reflect that they have been moved for an undefined time (:issue:`3608`)
+- Added new ``discord.com`` domain to ``INVITE_URL_RE`` common filter (:issue:`4012`)
+- Fixed incorrect role mention regex in ``MessagePredicate`` (:issue:`4030`)
+- Vendor the ``discord.ext.menus`` module (:issue:`4039`)
+
+
+Miscellaneous
+-------------
+
+- Improved error responses for when Modlog and Autoban on mention spam were already disabled (:issue:`3951`, :issue:`3949`)
+- Clarified that ``[p]embedset user`` only affects commands executed in DMs (:issue:`3972`, :issue:`3953`)
+- Added link to Getting Started guide if the bot was not in any guilds (:issue:`3906`)
+- Fixed exceptions being ignored or not sent to log files in special cases (:issue:`3895`)
+- Added the option of using dots in the instance name when creating your instances (:issue:`3920`)
+- Added a confirmation when using hyphens in instance names to discourage the use of them (:issue:`3920`)
+- Fixed migration owner notifications being sent even when migration was not necessary (:issue:`3911`. :issue:`3909`)
+- Fixed commands being translated where they should not be (:issue:`3938`, :issue:`3919`)
+- Fixed grammar errors and added full stopts in ``core_commands.py`` (:issue:`4023`)
+
+
+Redbot 3.3.9 (2020-06-12)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Dav-Git`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`mikeshardmind`, :ghuser:`NeuroAssassin`, :ghuser:`Predeactor`, :ghuser:`Vexed01`
+|
+| **Read before updating**:
+| 1. Bot owners can no longer restrict access to some commands in Permissions cog using global permissions rules. Look at `Permissions changelog <important-339-2>` for full details.
+| 2. There's been a change in behavior of warning messages. Look at `Warnings changelog <important-339-1>` for full details.
+
+
+End-user changelog
+------------------
+
+Security
+********
+
+**NOTE**: If you can't update immediately, we recommend disabling the affected command until you can.
+
+- **Mod** - ``[p]tempban`` now properly respects Discord's hierarchy rules (:issue:`3957`)
+
+Core Bot
+********
+
+- ``[p]info`` command can now be used when bot doesn't have Embed Links permission (:issue:`3907`, :issue:`3102`)
+- Fixed ungraceful error that happened in ``[p]set custominfo`` when provided text was too long (:issue:`3923`)
+- Red's start up message now shows storage type (:issue:`3935`)
+
+Audio
+*****
+
+- Audio now properly ignores streams when max length is enabled (:issue:`3878`, :issue:`3877`)
+- Commands that should work in DMs no longer error (:issue:`3880`)
+
+Filter
+******
+
+- Fixed behavior of detecting quotes in commands for adding/removing filtered words (:issue:`3925`)
+
+.. _important-339-2:
+
+Permissions
+***********
+
+- **Both global and server rules** can no longer prevent guild owners from accessing commands for changing server rules. Bot owners can still use ``[p]command disable`` if they wish to completely disable any command in Permissions cog (:issue:`3955`, :issue:`3107`)
+
+  Full list of affected commands:
+
+  - ``[p]permissions acl getserver``
+  - ``[p]permissions acl setserver``
+  - ``[p]permissions acl updateserver``
+  - ``[p]permissions addserverrule``
+  - ``[p]permissions removeserverrule``
+  - ``[p]permissions setdefaultserverrule``
+  - ``[p]permissions clearserverrules``
+  - ``[p]permissions canrun``
+  - ``[p]permissions explain``
+
+.. _important-339-1:
+
+Warnings
+********
+
+- Warnings sent to users don't show the moderator who warned the user by default now. Newly added ``[p]warningset showmoderators`` command can be used to switch this behaviour (:issue:`3781`)
+- Warn channel functionality has been fixed (:issue:`3781`)
+
+
+Developer changelog
+-------------------
+
+Core Bot
+********
+
+- Added `bot.set_prefixes() <RedBase.set_prefixes()>` method that allows developers to set global/server prefixes (:issue:`3890`)
+
+
+Documentation changes
+---------------------
+
+- Added Oracle Cloud to free hosting section in :ref:`host-list` (:issue:`3916`)
+
+Miscellaneous
+-------------
+
+- Added missing help message for Downloader, Reports and Streams cogs (:issue:`3892`)
+- **Core Bot** - cooldown in ``[p]contact`` no longer applies when it's used without any arguments (:issue:`3942`)
+- **Core Bot** - improved instructions on obtaining user ID in help of ``[p]dm`` command (:issue:`3946`)
+- **Alias** - ``[p]alias global`` group, ``[p]alias help``, and ``[p]alias show`` commands can now be used in DMs (:issue:`3941`, :issue:`3940`)
+- **Audio** - Typo fix (:issue:`3889`, :issue:`3900`)
+- **Audio** - Fixed ``[p]audioset autoplay`` being available in DMs (:issue:`3899`)
+- **Bank** - ``[p]bankset`` now displays bank's scope (:issue:`3954`)
+- **Mod** - Preemptive fix for d.py 1.4 (:issue:`3891`)
+
+
+Redbot 3.3.8 (2020-05-29)
+==================================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Bakersbakebread`, :ghuser:`DariusStClair`, :ghuser:`Dav-Git`, :ghuser:`Drapersniper`, :ghuser:`Flame442`, :ghuser:`jack1142`, :ghuser:`mikeshardmind`, :ghuser:`NeuroAssassin`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`qaisjp`, :ghuser:`Tobotimus`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Important fixes to how PostgreSQL data backend saves data in bulks (:issue:`3829`)
+- Fixed ``[p]localwhitelist`` and ``[p]localblacklist`` commands (:issue:`3857`)
+- Red now includes information on how to update when sending information about being out of date (:issue:`3744`)
+- Using backslashes in bot's username/nickname no longer causes issues (:issue:`3826`, :issue:`3825`)
+
+Admin
+*****
+
+- Fixed server lock (:issue:`3815`, :issue:`3814`)
+
+Alias
+*****
+
+- Added pagination to ``[p]alias list`` and ``[p]alias global list`` to avoid errors for users with a lot of aliases (:issue:`3844`, :issue:`3834`)
+- ``[p]alias help`` should now work more reliably (:issue:`3864`)
+
+Audio
+*****
+
+- Twitch playback is functional once again (:issue:`3873`)
+- Recent errors with YouTube playback should be resolved (:issue:`3873`)
+- Added new option (settable with ``[p]audioset lyrics``) that makes Audio cog prefer (prioritize) tracks with lyrics (:issue:`3519`)
+- Added global daily (historical) queues (:issue:`3518`)
+- Added ``[p]audioset countrycode`` that allows to set the country code for spotify searches (:issue:`3528`)
+- Fixed ``[p]local search`` (:issue:`3528`, :issue:`3501`)
+- Local folders with special characters should work properly now (:issue:`3528`, :issue:`3467`)
+- Audio no longer fails to take the last spot in the voice channel with user limit (:issue:`3528`)
+- ``[p]local play`` no longer enqueues tracks from nested folders (:issue:`3528`)
+- Fixed ``[p]playlist dedupe`` not removing tracks (:issue:`3518`)
+- ``[p]disconnect`` now allows to disconnect if both DJ mode and voteskip aren't enabled (:issue:`3502`, :issue:`3485`)
+- Many UX improvements and fixes, including, among other things:
+
+  - Creating playlists without explicitly passing ``-scope`` no longer causes errors (:issue:`3500`)
+  - ``[p]playlist list`` now shows all accessible playlists if ``--scope`` flag isn't used (:issue:`3518`)
+  - ``[p]remove`` now also accepts a track URL in addition to queue index (:issue:`3201`)
+  - ``[p]playlist upload`` now accepts a playlist file uploaded in the message with a command (:issue:`3251`)
+  - Commands now send friendly error messages for common errors like lost Lavalink connection or bot not connected to voice channel (:issue:`3503`, :issue:`3528`, :issue:`3353`, :issue:`3712`)
+
+CustomCommands
+**************
+
+- ``[p]customcom create`` no longer allows spaces in custom command names (:issue:`3816`)
+
+Mod
+***
+
+- ``[p]userinfo`` now shows default avatar when no avatar is set (:issue:`3819`)
+
+Modlog
+******
+
+- Fixed (again) ``AttributeError`` for cases whose moderator doesn't share the server with the bot (:issue:`3805`, :issue:`3784`, :issue:`3778`)
+
+Permissions
+***********
+
+- Commands for settings ACL using yaml files now properly works on PostgreSQL data backend (:issue:`3829`, :issue:`3796`)
+
+Warnings
+********
+
+- Warnings cog no longer allows to warn bot users (:issue:`3855`, :issue:`3854`)
+
+
+Developer changelog
+-------------------
+
+| **Important:**
+| If you're using RPC, please see the full annoucement about current state of RPC in main Red server
+  `by clicking here <https://discord.com/channels/133049272517001216/411381123101491200/714560168465137694>`_.
+
+
+Core Bot
+********
+
+- Red now inherits from `discord.ext.commands.AutoShardedBot` for better compatibility with code expecting d.py bot (:issue:`3822`)
+- Libraries using ``pkg_resources`` (like ``humanize`` or ``google-api-python-client``) that were installed through Downloader should now work properly (:issue:`3843`)
+- All bot owner IDs can now be found under ``bot.owner_ids`` attribute (:issue:`3793`)
+
+  -  Note: If you want to use this on bot startup (e.g. in cog's initialisation), you need to await ``bot.wait_until_red_ready()`` first
+
+
+Documentation changes
+---------------------
+
+- Added information about provisional status of RPC (:issue:`3862`)
+- Revised install instructions (:issue:`3847`)
+- Improved navigation in `document about updating Red <update_red>` (:issue:`3856`, :issue:`3849`)
+
+
+Miscellaneous
+-------------
+
+- Few clarifications and typo fixes in few command help docstrings (:issue:`3817`, :issue:`3823`, :issue:`3837`, :issue:`3851`, :issue:`3861`)
+- **Downloader** - Downloader no longer removes the repo when it fails to load it (:issue:`3867`)
+
+
+Redbot 3.3.7 (2020-04-28)
+=========================
+
+This is a hotfix release fixing issue with generating messages for new cases in Modlog.
+
+
+Redbot 3.3.6 (2020-04-27)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Drapersniper`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`MiniJennJenn`, :ghuser:`NeuroAssassin`, :ghuser:`PredaaA`, :ghuser:`TrustyJAID`, :ghuser:`yamikaitou`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Converting from and to Postgres driver with ``redbot-setup convert`` have been fixed (:issue:`3714`, :issue:`3115`)
+- Fixed big delays in commands that happened when the bot was owner-less (or if it only used co-owners feature) and command caller wasn't the owner (:issue:`3782`)
+- Various optimizations
+
+  - Reduced calls to data backend when loading bot's commands (:issue:`3764`)
+  - Reduced calls to data backend when showing help for cogs/commands (:issue:`3766`)
+  - Improved performance for bots with big amount of guilds (:issue:`3767`)
+  - Mod cog no longer fetches guild's bans every 60 seconds when handling unbanning for tempbans (:issue:`3783`)
+  - Reduced the bot load for messages starting with a prefix when fuzzy search is disabled (:issue:`3718`)
+  - Aliases in Alias cog are now cached for better performance (:issue:`3788`)
+
+Core Commands
+*************
+
+- ``[p]set avatar`` now supports setting avatar using attachment (:issue:`3747`)
+- Added ``[p]set avatar remove`` subcommand for removing bot's avatar (:issue:`3757`)
+- Fixed list of ignored channels that is shown in ``[p]ignore``/``[p]unignore`` (:issue:`3746`)
+
+Audio
+*****
+
+- Age-restricted tracks, live streams, and mix playlists from YouTube should work in Audio again (:issue:`3791`)
+- Soundcloud's sets and playlists with more than 50 tracks should work in Audio again (:issue:`3791`)
+
+CustomCommands
+**************
+
+- Added ``[p]cc raw`` command that gives you the raw response of a custom command for ease of copy pasting (:issue:`3795`)
+
+Modlog
+******
+
+- Fixed ``AttributeError`` for cases whose moderator doesn't share the server with the bot (:issue:`3784`, :issue:`3778`)
+
+Streams
+*******
+
+- Fixed incorrect stream URLs for Twitch channels that have localised display name (:issue:`3773`, :issue:`3772`)
+
+Trivia
+******
+
+- Fixed the error in ``[p]trivia stop`` that happened when there was no ongoing trivia session in the channel (:issue:`3774`)
+
+Trivia Lists
+************
+
+- Updated ``leagueoflegends`` list with new changes to League of Legends (`b8ac70e <https://github.com/Cog-Creators/Red-DiscordBot/commit/b8ac70e59aa1328f246784f14f992d6ffe00d778>`_)
+
+
+Developer changelog
+-------------------
+
+Utility Functions
+*****************
+
+- Added `redbot.core.utils.AsyncIter` utility class which allows you to wrap regular iterable into async iterator yielding items and sleeping for ``delay`` seconds every ``steps`` items (:issue:`3767`, :issue:`3776`)
+- `bold()`, `italics()`, `strikethrough()`, and `underline()` now accept ``escape_formatting`` argument that can be used to disable escaping of markdown formatting in passed text (:issue:`3742`)
+
+
+Documentation changes
+---------------------
+
+- Added `document about updating Red <update_red>` (:issue:`3790`)
+- ``pyenv`` instructions will now update ``pyenv`` if it's already installed (:issue:`3740`)
+- Updated Python version in ``pyenv`` instructions (:issue:`3740`)
+- Updated install docs to include Ubuntu 20.04 (:issue:`3792`)
+
+
+Miscellaneous
+-------------
+
+- **Config** - JSON driver will now properly have only one lock per cog name (:issue:`3780`)
+- **Core Commands** - ``[p]debuginfo`` now shows used storage type (:issue:`3794`)
+- **Trivia** - Corrected spelling of Compact Disc in ``games`` list (:issue:`3759`, :issue:`3758`)
+
+
+Redbot 3.3.5 (2020-04-09)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`jack1142`, :ghuser:`Kowlin`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- "Outdated" field no longer shows in ``[p]info`` when Red is up-to-date (:issue:`3730`)
+
+Alias
+*****
+
+- Fixed regression in ``[p]alias add`` that caused it to reject commands containing arguments (:issue:`3734`)
+
+
+Redbot 3.3.4 (2020-04-05)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`jack1142`, :ghuser:`kennnyshiwa`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Fixed checks related to bank's global state that were used in commands in Bank, Economy and Trivia cogs (:issue:`3707`)
+
+Alias
+*****
+
+- ``[p]alias add`` now sends an error when command user tries to alias doesn't exist (:issue:`3710`, :issue:`3545`)
+
+Developer changelog
+-------------------
+
+Core Bot
+********
+
+- Bump dependencies, including update to discord.py 1.3.3 (:issue:`3723`)
+
+Utility Functions
+*****************
+
+- `redbot.core.utils.common_filters.filter_invites` now filters ``discord.io/discord.li`` invites links (:issue:`3717`)
+- Fixed false-positives in `redbot.core.utils.common_filters.filter_invites` (:issue:`3717`)
+
+Documentation changes
+---------------------
+
+- Versions of pre-requirements are now included in Windows install guide (:issue:`3708`)
+
+
 Redbot 3.3.3 (2020-03-28)
 =========================
 
@@ -16,7 +553,7 @@ Core Bot
 - Fixed various bugs with blacklist and whitelist (:issue:`3643`, :issue:`3642`)
 - Added ``[p]set regionalformat`` command that allows users to set regional formatting that is different from bot's locale (:issue:`3677`, :issue:`3588`)
 - ``[p]set locale`` allows any valid locale now, not just locales for which Red has translations (:issue:`3676`, :issue:`3596`)
-- Permissions for commands in Bank, Economy and Trivia cogs can now be overriden by Permissions cog (:issue:`3672`, :issue:`3233`)
+- Permissions for commands in Bank, Economy and Trivia cogs can now be overridden by Permissions cog (:issue:`3672`, :issue:`3233`)
 - Outages of ``pypi.org`` no longer prevent the bot from starting (:issue:`3663`)
 - Fixed formatting of help strings in fuzzy search results (:issue:`3673`, :issue:`3507`)
 - Fixed few deprecation warnings related to menus and uvloop (:issue:`3644`, :issue:`3700`)
@@ -370,4 +907,4 @@ Mod
 Permissions
 -----------
 
-- Now has stronger enforcement of prioritizing botwide settings.
+- Now has stronger enforcement of prioritizing botwide settings.

docs/cog_customcom.rst

@@ -1,4 +1,5 @@
 .. CustomCommands Cog Reference
+.. _cog_customcom:
 
 ============================
 CustomCommands Cog Reference

docs/cog_guides/admin.rst

@@ -0,0 +1,438 @@
+.. _admin:
+
+=====
+Admin
+=====
+
+This is the cog guide for the admin 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 admin
+
+.. _admin-usage:
+
+-----
+Usage
+-----
+
+This cog will provide tools for server admins and bot owners.
+
+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 it joins) and announcements, which
+can send something in all the servers of the bot.
+
+.. _admin-commands:
+
+--------
+Commands
+--------
+
+Here's a list of all commands available for this cog.
+
+.. _admin-command-selfrole:
+
+^^^^^^^^
+selfrole
+^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfrole <selfrole>
+
+**Description**
+
+Add or remove a role from yourself. It must have been configured as user settable
+by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
+
+**Arguments**
+
+* ``<selfrole>``: The role you want to attribute or remove from yourself. |role-input|
+
+.. _admin-command-selfrole-add:
+
+""""""""""""
+selfrole add
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfrole add <selfrole>
+
+**Description**
+
+Add a role to yourself. It must have been configured as user settable
+by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
+
+**Arguments**
+
+* ``<selfrole>``: The role you want to attribute to yourself. |role-input|
+
+.. _admin-command-selfrole-remove:
+
+"""""""""""""""
+selfrole remove
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfrole remove <selfrole>
+
+**Description**
+
+Remove a role from yourself. It must have been configured as user settable
+by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
+
+**Arguments**
+
+* ``<selfrole>``: The role you want to remove from yourself. |role-input|
+
+
+.. _admin-command-selfrole-list:
+
+"""""""""""""
+selfrole list
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfrole list
+
+**Description**
+
+List all of the available roles you can assign to yourself.
+
+.. _admin-command-selfroleset:
+
+^^^^^^^^^^^
+selfroleset
+^^^^^^^^^^^
+
+.. note:: |admin-lock| This is also usable by the members with the
+    ``Manage roles`` permission.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfroleset
+
+**Description**
+
+Define the list of user settable roles. Those roles will be available to any
+member using the :ref:`selfrole command <admin-command-selfrole>`.
+
+.. _admin-command-selfroleset-add:
+
+"""""""""""""""
+selfroleset add
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfroleset add <role>
+
+**Description**
+
+Add a role to the list of selfroles.
+
+.. warning:: Members will be able to assign themselves the role.
+    Make sure it doesn't give extra perms or anything that can break
+    your server's security.
+
+**Arguments**
+
+* ``<role>``: The role to add to the list. |role-input|
+
+.. _admin-command-selfroleset-remove:
+
+""""""""""""""""""
+selfroleset remove
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]selfroleset remove <role>
+
+**Description**
+
+Removes a role from the list of selfroles.
+
+**Arguments**
+
+* ``<role>``: The role to remove from the list. |role-input|
+
+.. _admin-command-addrole:
+
+^^^^^^^
+addrole
+^^^^^^^
+
+.. note:: |admin-lock| This is also usable by the members with the ``Manage
+    roles`` permission.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]addrole <rolename> [user]
+
+**Description**
+
+Adds a role to a member. If ``user`` is not given, it will be considered
+as yourself, the command author.
+
+**Arguments**
+
+* ``<role>``: The role to add to the member. |role-input-quotes|
+
+* ``[user]``: The member you want to add the role to. Defaults to the
+  command author. |member-input|
+
+.. _admin-command-removerole:
+
+^^^^^^^^^^
+removerole
+^^^^^^^^^^
+
+.. note:: |admin-lock| This is also usable by the members with the
+    ``Manage roles`` permission.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]removerole <rolename> [user]
+
+**Description**
+
+Removes a role from a member. If ``user`` is not given, it will be considered
+as yourself, the command author.
+
+**Arguments**
+
+* ``<role>``: The role to remove. |role-input-quotes|
+
+* ``[user]``: The member to remove the role from. |member-input| Defaults
+    to the command author.
+
+.. _admin-command-editrole:
+
+^^^^^^^^
+editrole
+^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]editrole
+
+**Description**
+
+Edits the settings of a role.
+
+.. _admin-command-editrole-name:
+
+"""""""""""""
+editrole name
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]editrole name <role> <name>
+
+**Description**
+
+Edits the name of a role.
+
+**Arguments**
+
+* ``<role>``: The role name to edit. |role-input-quotes|
+
+* ``<name>``: The new role name. If it has spaces, you must use quotes.
+
+.. _admin-command-editrole-color:
+
+""""""""""""""
+editrole color
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]editrole color <role> <color>
+
+**Description**
+
+Edits the color of a role.
+
+**Arguments**
+
+* ``<role>``: The role name to edit. |role-input-quotes|
+
+* ``<color>``: The new color to assign. |color-input|
+
+**Examples**
+
+* ``[p]editrole color "My role" #ff0000``
+
+* ``[p]editrole color "My role" dark_blue``
+
+.. _admin-command-announce:
+
+^^^^^^^^
+announce
+^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]announce <message>
+
+**Description**
+
+Announce your message to all of the servers the bot is in.
+
+The bot will announce the message in the guild's announcements channel.
+If this channel is not set, the message won't be announced.
+
+**Arguments**
+
+* ``<message>``: The message to send.
+
+.. _admin-command-announce-cancel:
+
+"""""""""""""""
+announce cancel
+"""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]announce cancel
+
+**Description**
+
+Cancels an active announcement.
+
+.. _admin-command-announceset:
+
+^^^^^^^^^^^
+announceset
+^^^^^^^^^^^
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]announceset
+
+**Description**
+
+Change how announcements are received in this guild.
+
+.. _admin-command-announceset-channel:
+
+"""""""""""""""""""
+announceset channel
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]announceset channel [channel]
+
+**Description**
+
+Sets the channel where the bot owner announcements will be sent.
+
+**Arguments**
+
+* ``[channel]``: The channel that will be used for bot announcements.
+  |channel-input| Defaults to where you typed the command.
+
+.. _admin-command-announceset-clearchannel:
+
+""""""""""""""""""""""""
+announceset clearchannel
+""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]announceset clearchannel
+
+**Description**
+
+Disables announcements on your server. To enable them again, you will have to
+re-enter your announcements channel with the :ref:`announceset channel
+<admin-command-announceset-channel>` command.
+
+.. _admin-command-serverlock:
+
+^^^^^^^^^^
+serverlock
+^^^^^^^^^^
+
+.. note:: |owner-lock| This is also usable by the members with the
+    ``Administrator`` permission.
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]serverlock
+
+**Description**
+
+Lock a bot to its current servers only.
+
+This means that, once you enable this, if someone invites the bot to a new
+server, the bot will automatically leave the server.
+
+.. tip:: Another way to prevent your bot from being invited on more servers is
+    making it private directly from the developer portal.
+
+    Once a bot is private, it can only be invited by its owner (or team
+    owners). Other users will get an error on Discord's webpage explaining that
+    the bot is private.
+
+    To do this, go to the `Discord developer portal
+    <https://discord.com/developers>`_, select your application, click "Bot" in
+    the sidebar, then untick "Public bot".
+
+    .. image:: ../.resources/admin/public_bot.png

docs/cog_guides/alias.rst

@@ -0,0 +1,277 @@
+.. _alias:
+
+=====
+Alias
+=====
+
+This is the cog guide for the alias cog. You will
+find detailed docs about the usage and the commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load alias
+
+.. _alias-usage:
+
+-----
+Usage
+-----
+
+This cog is used to create shortcuts for commands.
+
+Here's an example:
+
+.. code-block:: python
+
+    [p]play
+    # with an alias, you can call the command above with a shortcut like this:
+    [p]p
+    # "p" is now a shortcut for "play"
+
+In this example, we made an alias named ``p`` that will
+invoke the ``play`` command. If you use ``[p]play`` or ``[p]p``, the result will
+be the same.
+
+----
+
+Here's another example
+
+.. code-block:: python
+
+    [p]cleanup messages
+    # now we're creating another alias that will group both the command and the subcommand into this:
+    [p]clear
+    # "clear" is now a shortcut for "cleanup messages"
+
+In this second example, we made an alias called ``clear`` that will
+invoke the ``cleanup messages`` subcommand. Now if you use ``[p]cleanup
+message`` or ``[p]clear``, the result will be the same.
+
+----
+
+This is the basic usage, where you can define an alias for the first part of
+the command and give the second part when invoking the command. A more advanced
+usage of aliases is the usage of arguments.
+
+Let's suppose you want to make an alias to ban someone, delete 7 days of
+messages and set the reason to "Spam bot.", that cannot be done with a classic
+alias since the required member argument is the first one. If you create the
+alias "spamban" using arguments like this ``ban {0} 7 Spam bot.``, ``{0}`` will
+be replaced by the first argument of your alias:
+
+.. code-block:: none
+
+    # we created the following alias named "spamban"
+    [p]spamban Slime#3160
+    # this alias will execute the following command:
+    [p]ban Slime#3160 7 Spam bot.
+
+For a more detailed explaination, read :ref:`this <alias-command-alias-add>`.
+
+.. _alias-commands:
+
+--------
+Commands
+--------
+
+.. _alias-command-alias:
+
+^^^^^
+alias
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias
+
+**Description**
+
+This is the main command used for setting up the cog.
+It will be used for all other commands.
+
+.. _alias-command-alias-add:
+
+"""""""""
+alias add
+"""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias add <alias_name> <command>
+
+**Description**
+
+Creates an alias. It will be used like this ``[p]alias_name <arguments>``
+and will be equal to this ``[p]command <arguments>``.
+
+Let's develop the examples given :ref:`earlier <alias-usage>` a bit more,
+the left part of the command is the alias (blue), and the right part is the
+parameters members have to give for the command (orange).
+
+.. image:: ../.resources/alias/example-1.png
+
+One more thing you can do with aliases is using arguments, a bit like
+CustomCommands. Let's suppose you want an alias that bans x member and deletes
+7 days of messages. Without aliases, the command would look like this:
+
+``[p]ban NotSoTrustyJAID#0001 7 My random reason``
+
+A classic alias wouldn't work because the member argument is the first one,
+and you can only shorten the left part before the required argument.
+
+An alias with arguments can fix that, you can define the alias on the whole
+command and replace the required argument by ``{0}``, which will be replaced
+by the first parameter given when invoking the alias.
+
+Back to our example, let's make an alias named ``bigban`` which will be
+assigned to this expression: ``ban {0} 7``
+
+.. image:: ../.resources/alias/example-2.png
+
+You can see in blue the "static" part of the alias, what is contained and
+doesn't need to be given, the orange part is the arguments given at the end of
+the command, just like a classic alias, and the green part is the positional
+argument we defined: the first argument of the alias will be the green part.
+
+You can add as many arguments as you want, they can start at ``{0}`` or ``{1}``
+and must be in order: ``{1}`` will be the first argument, ``{2}`` will be the
+second one...
+
+.. attention:: The numbers must be in order, you cannot use ``{0}`` and ``{2}``
+    without using ``{1}``.
+
+Here are more examples:
+
+*   *   Full command: ``[p]cleanup messages 75 True``
+    *   Alias: ``[p]alias add fullclear cleanup messages {0} True``
+    *   Invoked alias: ``[p]fullclear 75``
+
+    *The* ``True`` *at the end tells the bot to also clear pinned messages.*
+
+*   *   Full command: ``[p]repo add SinbadCogs
+        https://github.com/mikeshardmind/SinbadCogs v3``
+    
+    *   Alias: ``[p]alias add newrepo repo add {2} https://github.com/{1}/{2}``
+    *   Invoked with alias: ``[p]newrepo mikeshardmind SinbadCogs v3``
+
+**Arguments**
+
+* ``<alias_name>``: The new command name.
+
+* ``<command>``: The command to execute when ``[p]alias_name`` is invoked.
+
+.. _alias-command-alias-delete:
+
+""""""""""""
+alias delete
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias [delete|remove|del] <alias_name>
+
+**Description**
+
+Removes an alias from the list. Check the list with
+the :ref:`alias list <alias-command-alias-list>` command.
+
+**Arguments**
+
+* ``<alias_name>``: The alias' name to delete.
+
+.. _alias-command-alias-list:
+
+""""""""""
+alias list
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias list
+
+**Description**
+
+Shows all of the existing aliases on the current server.
+
+.. _alias-command-alias-show:
+
+""""""""""
+alias show
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias show <alias_name>
+
+**Description**
+
+Shows the command associated to the alias.
+
+**Arguments**
+
+* ``<alias_name>``: The alias you want information from.
+
+.. _alias-command-alias-help:
+
+""""""""""
+alias help
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias help <alias_name>
+
+**Description**
+
+Shows help message for an alias.
+
+**Arguments**
+
+* ``<alias_name>``: Alias you want to get help from.
+
+.. _alias-command-alias-global:
+
+""""""""""""
+alias global
+""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]alias global
+
+**Description**
+
+Another group command which contains the :ref:`add
+<alias-command-alias-add>`, :ref:`del
+<alias-command-alias-delete>` and :ref:`list
+<alias-command-alias-list>` commands.
+
+They work the same, except the created aliases will be
+global instead of being only server-wide.
+
+Please refer to these docs for the commands, they work with the
+same arguments. For example, if you want to add a global alias,
+instead of doing ``[p]alias add <arguments>``, do ``[p]alias
+global add <arguments>``.

docs/cog_guides/bank.rst

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

docs/cog_guides/cleanup.rst

@@ -0,0 +1,296 @@
+.. _cleanup:
+
+=======
+Cleanup
+=======
+
+This is the cog guide for the cleanup 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 cleanup
+
+.. _cleanup-usage:
+
+-----
+Usage
+-----
+
+This cog contains commands used for "cleaning up" (deleting) messages.
+
+This is designed as a moderator tool and offers many convenient use cases.
+All cleanup commands only apply to the channel the command is executed in.
+
+Messages older than two weeks cannot be mass deleted.
+This is a limitation of the API.
+
+
+.. _cleanup-commands:
+
+--------
+Commands
+--------
+
+.. _cleanup-command-cleanup:
+
+^^^^^^^
+cleanup
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup 
+
+**Description**
+
+Base command for deleting messages.
+
+.. _cleanup-command-cleanup-after:
+
+"""""""""""""
+cleanup after
+"""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup after <message_id> [delete_pinned=False]
+
+**Description**
+
+Delete all messages after a specified message.
+
+To get a message id, enable developer mode in Discord's
+settings, 'appearance' tab. Then right click a message
+and copy its id.
+
+**Arguments:**
+
+- ``<message_id>`` The id of the message to cleanup after. This message won't be deleted.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-before:
+
+""""""""""""""
+cleanup before
+""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup before <message_id> <number> [delete_pinned=False]
+
+**Description**
+
+Deletes X messages before the specified message.
+
+To get a message id, enable developer mode in Discord's
+settings, 'appearance' tab. Then right click a message
+and copy its id.
+
+**Arguments:**
+
+- ``<message_id>`` The id of the message to cleanup before. This message won't be deleted.
+- ``<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-cleanup-between:
+
+"""""""""""""""
+cleanup between
+"""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup between <one> <two> [delete_pinned=False]
+
+**Description**
+
+Delete the messages between Message One and Message Two, providing the messages IDs.
+
+The first message ID should be the older message and the second one the newer.
+
+Example:
+    - ``[p]cleanup between 123456789123456789 987654321987654321``
+
+**Arguments:**
+
+- ``<one>`` The id of the message to cleanup after. This message won't be deleted.
+- ``<two>`` The id of the message to cleanup before. This message won't be deleted.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-bot:
+
+"""""""""""
+cleanup bot
+"""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup bot <number> [delete_pinned=False]
+
+**Description**
+
+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.
+
+**Arguments:**
+
+- ``<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-cleanup-messages:
+
+""""""""""""""""
+cleanup messages
+""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup messages <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages in the current channel.
+
+Example:
+    - ``[p]cleanup messages 26``
+
+**Arguments:**
+
+- ``<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-cleanup-self:
+
+""""""""""""
+cleanup self
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup self <number> [match_pattern] [delete_pinned=False]
+
+**Description**
+
+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.
+
+Examples:
+    - ``[p]cleanup self 6``
+    - ``[p]cleanup self 10 Pong``
+    - ``[p]cleanup self 7 "" True``
+
+**Arguments:**
+
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<match_pattern>`` The text that messages must contain to be deleted. Use "" to skip this.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-spam:
+
+""""""""""""
+cleanup spam
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup spam [number=50]
+
+**Description**
+
+Deletes duplicate messages in the channel from the last X messages and keeps only one copy.
+
+Defaults to 50.
+
+**Arguments:**
+
+- ``<number>`` The number of messages to check for duplicates. Must be a positive integer.
+
+.. _cleanup-command-cleanup-text:
+
+""""""""""""
+cleanup text
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup text <text> <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages matching the specified text in the current channel.
+
+Example:
+    - ``[p]cleanup text "test" 5``
+
+Remember to use double quotes.
+
+**Arguments:**
+
+- ``<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-cleanup-user:
+
+""""""""""""
+cleanup user
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup user <user> <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages from a specified user in the current channel.
+
+Examples:
+    - ``[p]cleanup user @Twentysix 2``
+    - ``[p]cleanup user Red 6``
+
+**Arguments:**
+
+- ``<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

docs/cog_guides/cog_manager_ui.rst

@@ -0,0 +1,249 @@
+.. _cogmanagerui:
+
+==============
+Cog Manager UI
+==============
+
+This is the cog guide for the core cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: This cog is not like the other cogs. It is loaded by default, not
+    included in the cogs paths and it cannot be unloaded. It contains needed
+    commands for cog management.
+
+.. _cogmanaerui-usage:
+
+-----
+Usage
+-----
+
+This cog allows you to manage your cogs and where you can install them. Unlike
+V2, which had a ``cogs`` folder where everything was installed, you can
+install V3 cogs everywhere, and also make them cross-compatible with other
+instances!
+
+If you want to install your cogs using a Github repo (usually what you will
+always be looking for), you need to use the downloader cog. However, if you
+have the files of a cog or want to code one, this cog is what you should be
+looking for.
+
+The most basic command is :ref:`paths <cogmanagerui-command-paths>`, which
+will list you all of the currently set paths.
+
+You can add a path by using the :ref:`addpath <cogmanagerui-command-addpath>`
+command. All cogs in that path will be available for the bot and listed in
+the :ref:`cogs <cogmanagerui-command-cogs>`. You can then load
+or unload them.
+
+.. TODO add ref to load and unload commands
+
+.. _cogmanagerui-usage-installation:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+How to install a local package without using downloader
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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:
+
+.. image:: ../.resources/cog_manager_ui/custom-cog-example.png
+
+You will first need to add a cog path to your instance. For that, use the
+:ref:`addpath <cogmanagerui-command-addpath>` command with a new directory.
+
+Create a folder somewhere (should stay accessible) and copy its path. A path
+looks like this:
+
+*   Windows: ``C:\Users\username\Documents\MyCogs``
+*   macOS: ``/Users/username/Documents/MyCogs``
+*   Linux: ``/home/username/Documents/MyCogs``
+
+You can now use the command we talked about before: type ``[p]addpath
+<your_path>``.
+
+.. attention:: A path shouldn't have spaces in it. If it does, add quotation
+    marks around the path, or a backslash before the space.
+
+In that ``MyCogs`` folder, you can drop your cog folder. You should now have
+something that looks like this:
+
+.. image:: ../.resources/cog_manager_ui/cog-path.png
+
+Now if you type ``[p]cogs``, your new cog should be listed, and you will be
+able to load it!
+
+.. _cogmanagerui-commands:
+
+--------
+Commands
+--------
+
+.. note:: The whole cog is locked to the
+    :ref:`bot owner <getting-started-permissions>`. If you are not the owner
+    of the instance, you can ignore this.
+
+.. _cogmanagerui-command-cogs:
+
+^^^^
+cogs
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cogs
+
+**Description**
+
+Returns a list of loaded and unloaded cogs on the bot.
+
+Cogs are unloaded by default. This is where you can find your cogs if you
+installed some recently.
+
+All of the cogs located inside a cog path will be listed here. You can see a
+list of the paths with the :ref:`paths <cogmanagerui-command-paths>` command.
+
+.. _cogmanagerui-command-paths:
+
+^^^^^
+paths
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]paths
+
+**Description**
+
+Lists the registered cog paths, with the install path for the downloader and
+the core path for the core cogs.
+
+.. TODO add ref to downloader
+
+You can use the :ref:`reorderpath <cogmanagerui-command-reorderpath>` command
+to reorder the listed paths.
+
+.. tip:: The number before a cog path can be used for the
+    :ref:`removepath <cogmanagerui-command-removepath>` command.
+
+.. _cogmanagerui-command-addpath:
+
+^^^^^^^
+addpath
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]addpath <path>
+
+**Description**
+
+Adds a path to the list of available cog paths. This means that all valid cogs
+under the path will be added to the list of available cogs, listed in
+:ref:`cogs <cogmanagerui-command-cogs>`.
+
+**Arguments**
+
+*   ``<path>``: A path that should look like this and point to a folder:
+
+    *   Windows: ``C:\Users\username\Documents\MyCogs``
+    *   macOS: ``/Users/username/Documents/MyCogs``
+    *   Linux: ``/home/username/Documents/MyCogs``
+
+    Try to avoid paths with spaces. If there are spaces, add a backslash before
+    the space on Linux. Add quotation marks around the path if needed.
+
+.. _cogmanagerui-command-removepath:
+
+^^^^^^^^^^
+removepath
+^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]removepath <path_number>
+
+**Description**
+
+Removes a path from the list of available paths. Its cogs won't be accessible
+anymore.
+
+**Arguments**
+
+*   ``<path_number>``: The number of the path to remove. You can get it with
+    the :ref:`paths <cogmanagerui>` command.
+
+.. _cogmanagerui-command-reorderpath:
+
+^^^^^^^^^^^
+reorderpath
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reorderpath <from_> <to>
+
+**Description**
+
+Reorders the paths listed with the :ref:`paths <cogmanagerui-command-paths>`
+command. The goal of this command is to allow the discovery of different cogs.
+If there are multiple packages with the same names, the one that is inside the
+highest folder in the list will be kept and the other ones will be ignored.
+
+For example, let's suppose this is the output of
+:ref:`paths <cogmanagerui-command-paths>`:
+
+    1.  ``/usr/local/lib/python3.7/site-packages/redbot/cogs``
+    2.  ``/home/laggron/custom_cogs``
+    3.  ``/mnt/not_suspicious_usb_drive/not_suspicious_cogs``
+
+The folders 2 and 3 both have a package named ``leveler`` while being different
+cogs, and you want to load the one located in the 3rd folder. To do that, you
+have to put the 3rd path higher than the 2nd path, let's swap them! Type
+``[p]reorderpath 2 3`` and the output of
+:ref:`paths <cogmanagerui-command-paths>` will then be the following:
+
+    1.  ``/usr/local/lib/python3.7/site-packages/redbot/cogs``
+    2.  ``/mnt/not_suspicious_usb_drive/not_suspicious_cogs``
+    3.  ``/home/laggron/custom_cogs``
+
+**Arguments**
+
+*   ``<from_>``: The index of the path you want to move.
+*   ``<to>``: The location where you want to insert the path.
+
+.. _cogmanagerui-command-installpath:
+
+^^^^^^^^^^^
+installpath
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]installpath [path]
+
+**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.
+
+.. warning:: If you edit the install path, the cogs won't be transfered.
+
+**Arguments**
+
+*   ``[path]``: The absolute path to set. If omitted, the current path will
+    be returned instead.

docs/cog_guides/customcommands.rst

@@ -0,0 +1,294 @@
+.. _customcommands:
+
+==============
+CustomCommands
+==============
+
+This is the cog guide for the customcommands 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 customcom
+
+.. _customcommands-usage:
+
+-----
+Usage
+-----
+
+This cog contains commands for creating and managing custom commands that display text.
+
+These are useful for storing information members might need, like FAQ answers or invite links.
+Custom commands can be used by anyone by default, so be careful with pings.
+Commands can only be lowercase, and will not respond to any uppercase letters.
+
+
+.. _customcommands-commands:
+
+--------
+Commands
+--------
+
+.. _customcommands-command-customcom:
+
+^^^^^^^^^
+customcom
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom 
+
+.. tip:: Alias: ``cc``
+
+**Description**
+
+Base command for Custom Commands management.
+
+.. _customcommands-command-customcom-cooldown:
+
+""""""""""""""""""
+customcom cooldown
+""""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom cooldown <command> [cooldown] [per=member]
+
+**Description**
+
+Set, edit, or view the cooldown for a custom command.
+
+You may set cooldowns per member, channel, or guild. Multiple
+cooldowns may be set. All cooldowns must be cooled to call the
+custom command.
+
+Examples:
+    - ``[p]customcom cooldown pingrole``
+    - ``[p]customcom cooldown yourcommand 30``
+    - ``[p]cc cooldown mycommand 30 guild``
+
+**Arguments:**
+
+- ``<command>`` The custom command to check or set the cooldown.
+- ``<cooldown>`` The number of seconds to wait before allowing the command to be invoked again. If omitted, will instead return the current cooldown settings.
+- ``<per>`` The group to apply the cooldown on. Defaults to per member. Valid choices are server, guild, user, and member.
+
+.. _customcommands-command-customcom-create:
+
+""""""""""""""""
+customcom create
+""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom create <command> <text>
+
+.. tip:: Alias: ``customcom add``
+
+**Description**
+
+Create custom commands.
+
+If a type is not specified, a simple CC will be created.
+CCs can be enhanced with arguments, see the guide
+:ref:`here <cog_customcom>`.
+
+.. _customcommands-command-customcom-create-random:
+
+"""""""""""""""""""""""
+customcom create random
+"""""""""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom create random <command>
+
+**Description**
+
+Create a CC where it will randomly choose a response!
+
+Note: This command is interactive.
+
+**Arguments:**
+
+- ``<command>`` The command executed to return the text. Cast to lowercase.
+
+.. _customcommands-command-customcom-create-simple:
+
+"""""""""""""""""""""""
+customcom create simple
+"""""""""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom create simple <command> <text>
+
+**Description**
+
+Add a simple custom command.
+
+Example:
+    - ``[p]customcom create simple yourcommand Text you want``
+
+**Arguments:**
+
+- ``<command>`` The command executed to return the text. Cast to lowercase.
+- ``<text>`` The text to return when executing the command. See guide for enhanced usage.
+
+.. _customcommands-command-customcom-delete:
+
+""""""""""""""""
+customcom delete
+""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom delete <command>
+
+.. tip:: Aliases: ``customcom del``, ``customcom remove``
+
+**Description**
+
+Delete a custom command.
+
+Example:
+    - ``[p]customcom delete yourcommand``
+
+**Arguments:**
+
+- ``<command>`` The custom command to delete.
+
+.. _customcommands-command-customcom-edit:
+
+""""""""""""""
+customcom edit
+""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom edit <command> [text]
+
+**Description**
+
+Edit a custom command.
+
+Example:
+    - ``[p]customcom edit yourcommand Text you want``
+
+**Arguments:**
+
+- ``<command>`` The custom command to edit.
+- ``<text>`` The new text to return when executing the command.
+
+.. _customcommands-command-customcom-list:
+
+""""""""""""""
+customcom list
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom list 
+
+**Description**
+
+List all available custom commands.
+
+The list displays a preview of each command's response, with
+markdown escaped and newlines replaced with spaces.
+
+.. _customcommands-command-customcom-raw:
+
+"""""""""""""
+customcom raw
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom raw <command>
+
+**Description**
+
+Get the raw response of a custom command, to get the proper markdown.
+
+This is helpful for copy and pasting.
+
+**Arguments:**
+
+- ``<command>`` The custom command to get the raw response of.
+
+.. _customcommands-command-customcom-search:
+
+""""""""""""""""
+customcom search
+""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom search <query>
+
+**Description**
+
+Searches through custom commands, according to the query.
+
+Uses fuzzywuzzy searching to find close matches.
+
+**Arguments:**
+
+- ``<query>`` The query to search for. Can be multiple words.
+
+.. _customcommands-command-customcom-show:
+
+""""""""""""""
+customcom show
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]customcom show <command_name>
+
+**Description**
+
+Shows a custom command's responses and its settings.
+
+**Arguments:**
+
+- ``<command>`` The custom command to show.

docs/cog_guides/downloader.rst

@@ -0,0 +1,538 @@
+.. _downloader:
+
+==========
+Downloader
+==========
+
+This is the cog guide for the downloader 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 downloader
+
+.. _downloader-usage:
+
+-----
+Usage
+-----
+
+Install community cogs made by Cog Creators.
+
+Community cogs, also called third party cogs, are not included
+in the default Red install.
+
+Community cogs come in repositories. Repos are a group of cogs
+you can install. You always need to add the creator's repository
+using the ``[p]repo`` command before you can install one or more
+cogs from the creator.
+
+
+.. _downloader-commands:
+
+--------
+Commands
+--------
+
+.. _downloader-command-cog:
+
+^^^
+cog
+^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog 
+
+**Description**
+
+Base command for cog installation management commands.
+
+.. _downloader-command-cog-checkforupdates:
+
+"""""""""""""""""""
+cog checkforupdates
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog checkforupdates 
+
+**Description**
+
+Check for available cog updates (including pinned cogs).
+
+This command doesn't update cogs, it only checks for updates.
+Use ``[p]cog update`` to update cogs.
+
+.. _downloader-command-cog-info:
+
+""""""""
+cog info
+""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog info <repo> <cog>
+
+**Description**
+
+List information about a single cog.
+
+Example:
+    - ``[p]cog info 26-Cogs defender``
+
+**Arguments**
+
+- ``<repo>`` The repo to get cog info from.
+- ``<cog>`` The cog to get info on.
+
+.. _downloader-command-cog-install:
+
+"""""""""""
+cog install
+"""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog install <repo> <cogs...>
+
+**Description**
+
+Install a cog from the given repo.
+
+Examples:
+    - ``[p]cog install 26-Cogs defender``
+    - ``[p]cog install Laggrons-Dumb-Cogs say roleinvite``
+
+**Arguments**
+
+- ``<repo>`` The name of the repo to install cogs from.
+- ``<cogs...>`` The cog or cogs to install.
+
+.. _downloader-command-cog-installversion:
+
+""""""""""""""""""
+cog installversion
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog installversion <repo> <revision> <cogs...>
+
+**Description**
+
+Install a cog from the specified revision of given repo.
+
+Revisions are "commit ids" that point to the point in the code when a specific change was made.
+The latest revision can be found in the URL bar for any GitHub repo by `pressing "y" on that repo <https://docs.github.com/en/free-pro-team@latest/github/managing-files-in-a-repository/getting-permanent-links-to-files#press-y-to-permalink-to-a-file-in-a-specific-commit>`_.
+
+Older revisions can be found in the URL bar by `viewing the commit history of any repo <https://cdn.discordapp.com/attachments/133251234164375552/775760247787749406/unknown.png>`_
+
+Example:
+    - ``[p]cog installversion Broken-Repo e798cc268e199612b1316a3d1f193da0770c7016 cog_name``
+
+**Arguments**
+
+- ``<repo>`` The name of the repo to install cogs from.
+- ``<revision>`` The revision to install from.
+- ``<cogs...>`` The cog or cogs to install.
+
+.. _downloader-command-cog-list:
+
+""""""""
+cog list
+""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog list <repo>
+
+**Description**
+
+List all available cogs from a single repo.
+
+Example:
+    - ``[p]cog list 26-Cogs``
+
+**Arguments**
+
+- ``<repo>`` The repo to list cogs from.
+
+.. _downloader-command-cog-listpinned:
+
+""""""""""""""
+cog listpinned
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog listpinned 
+
+**Description**
+
+List currently pinned cogs.
+
+.. _downloader-command-cog-pin:
+
+"""""""
+cog pin
+"""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog pin <cogs...>
+
+**Description**
+
+Pin cogs - this will lock cogs on their current version.
+
+Examples:
+    - ``[p]cog pin defender``
+    - ``[p]cog pin outdated_cog1 outdated_cog2``
+
+**Arguments**
+
+- ``<cogs...>`` The cog or cogs to pin. Must already be installed.
+
+.. _downloader-command-cog-uninstall:
+
+"""""""""""""
+cog uninstall
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog uninstall <cogs...>
+
+**Description**
+
+Uninstall cogs.
+
+You may only uninstall cogs which were previously installed
+by Downloader.
+
+Examples:
+    - ``[p]cog uninstall defender``
+    - ``[p]cog uninstall say roleinvite``
+
+**Arguments**
+
+- ``<cogs...>`` The cog or cogs to uninstall.
+
+.. _downloader-command-cog-unpin:
+
+"""""""""
+cog unpin
+"""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog unpin <cogs...>
+
+**Description**
+
+Unpin cogs - this will remove the update lock from those cogs.
+
+Examples:
+    - ``[p]cog unpin defender``
+    - ``[p]cog unpin updated_cog1 updated_cog2``
+
+**Arguments**
+
+- ``<cogs...>`` The cog or cogs to unpin. Must already be installed and pinned.
+
+.. _downloader-command-cog-update:
+
+""""""""""
+cog update
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog update [cogs...]
+
+**Description**
+
+Update all cogs, or ones of your choosing.
+
+Examples:
+    - ``[p]cog update``
+    - ``[p]cog update defender``
+
+**Arguments**
+
+- ``[cogs...]`` The cog or cogs to update. If omitted, all cogs are updated.
+
+.. _downloader-command-cog-updateallfromrepos:
+
+""""""""""""""""""""""
+cog updateallfromrepos
+""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog updateallfromrepos <repos...>
+
+**Description**
+
+Update all cogs from repos of your choosing.
+
+Examples:
+    - ``[p]cog updateallfromrepos 26-Cogs``
+    - ``[p]cog updateallfromrepos Laggrons-Dumb-Cogs 26-Cogs``
+
+**Arguments**
+
+- ``<repos...>`` The repo or repos to update all cogs from.
+
+.. _downloader-command-cog-updatetoversion:
+
+"""""""""""""""""""
+cog updatetoversion
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cog updatetoversion <repo> <revision> [cogs...]
+
+**Description**
+
+Update all cogs, or ones of your choosing to chosen revision of one repo.
+
+Note that update doesn't mean downgrade and therefore ``revision``
+has to be newer than the version that cog currently has installed. If you want to
+downgrade the cog, uninstall and install it again.
+
+See ``[p]cog installversion`` for an explanation of ``revision``.
+
+Example:
+    - ``[p]cog updatetoversion Broken-Repo e798cc268e199612b1316a3d1f193da0770c7016 cog_name``
+
+**Arguments**
+
+- ``<repo>`` The repo or repos to update all cogs from.
+- ``<revision>`` The revision to update to.
+- ``[cogs...]`` The cog or cogs to update.
+
+.. _downloader-command-findcog:
+
+^^^^^^^
+findcog
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]findcog <command_name>
+
+**Description**
+
+Find which cog a command comes from.
+
+This will only work with loaded cogs.
+
+Example:
+    - ``[p]findcog ping``
+
+**Arguments**
+
+- ``<command_name>`` The command to search for.
+
+.. _downloader-command-pipinstall:
+
+^^^^^^^^^^
+pipinstall
+^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]pipinstall <deps...>
+
+**Description**
+
+Install a group of dependencies using pip.
+
+Examples:
+    - ``[p]pipinstall bs4``
+    - ``[p]pipinstall py-cpuinfo psutil``
+
+Improper usage of this command can break your bot, be careful.
+
+**Arguments**
+
+- ``<deps...>`` The package or packages you wish to install.
+
+.. _downloader-command-repo:
+
+^^^^
+repo
+^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo 
+
+**Description**
+
+Base command for repository management.
+
+.. _downloader-command-repo-add:
+
+""""""""
+repo add
+""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo add <name> <repo_url> [branch]
+
+**Description**
+
+Add a new repo.
+
+Examples:
+    - ``[p]repo add 26-Cogs https://github.com/Twentysix26/x26-Cogs``
+    - ``[p]repo add Laggrons-Dumb-Cogs https://github.com/retke/Laggrons-Dumb-Cogs v3``
+
+Repo names can only contain characters A-z, numbers, underscores, and hyphens.
+The branch will be the default branch if not specified.
+
+**Arguments**
+
+- ``<name>`` The name given to the repo.
+- ``<repo_url>`` URL to the cog branch. Usually GitHub or GitLab.
+- ``[branch]`` Optional branch to install cogs from.
+
+.. _downloader-command-repo-delete:
+
+"""""""""""
+repo delete
+"""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo delete <repo>
+
+.. tip:: Aliases: ``repo remove``, ``repo del``
+
+**Description**
+
+Remove repos and their files.
+
+Examples:
+    - ``[p]repo delete 26-Cogs``
+    - ``[p]repo delete 26-Cogs Laggrons-Dumb-Cogs``
+
+**Arguments**
+
+- ``<repos...>`` The repo or repos to remove.
+
+.. _downloader-command-repo-info:
+
+"""""""""
+repo info
+"""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo info <repo>
+
+**Description**
+
+Show information about a repo.
+
+Example:
+    - ``[p]repo info 26-Cogs``
+
+**Arguments**
+
+- ``<repo>`` The name of the repo to show info about.
+
+.. _downloader-command-repo-list:
+
+"""""""""
+repo list
+"""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo list 
+
+**Description**
+
+List all installed repos.
+
+.. _downloader-command-repo-update:
+
+"""""""""""
+repo update
+"""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repo update [repos...]
+
+**Description**
+
+Update all repos, or ones of your choosing.
+
+This will *not* update the cogs installed from those repos.
+
+Examples:
+    - ``[p]repo update``
+    - ``[p]repo update 26-Cogs``
+    - ``[p]repo update 26-Cogs Laggrons-Dumb-Cogs``
+
+**Arguments**
+
+- ``[repos...]`` The name or names of repos to update. If omitted, all repos are updated.

docs/cog_guides/economy.rst

@@ -0,0 +1,539 @@
+.. _economy:
+
+=======
+Economy
+=======
+
+This is the cog guide for the economy 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 economy
+
+.. _economy-usage:
+
+-----
+Usage
+-----
+
+Get rich and have fun with imaginary currency!
+
+
+.. _economy-commands:
+
+--------
+Commands
+--------
+
+.. _economy-command-bank:
+
+^^^^
+bank
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank 
+
+**Description**
+
+Base command to manage the bank.
+
+.. _economy-command-bank-balance:
+
+""""""""""""
+bank balance
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank balance [user]
+
+**Description**
+
+Show the user's account balance.
+
+Example:
+    - ``[p]bank balance``
+    - ``[p]bank balance @Twentysix``
+
+**Arguments**
+
+- ``<user>`` The user to check the balance of. If omitted, defaults to your own balance.
+
+.. _economy-command-bank-prune:
+
+""""""""""
+bank prune
+""""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune 
+
+**Description**
+
+Base command for pruning bank accounts.
+
+.. _economy-command-bank-prune-global:
+
+"""""""""""""""""
+bank prune global
+"""""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune global [confirmation=False]
+
+**Description**
+
+Prune bank accounts for users who no longer share a server with the bot.
+
+Cannot be used without a global bank. See ``[p]bank prune server``.
+
+Examples:
+    - ``[p]bank prune global`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune global yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-prune-server:
+
+"""""""""""""""""
+bank prune server
+"""""""""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune server [confirmation=False]
+
+.. tip:: Aliases: ``bank prune guild``, ``bank prune local``
+
+**Description**
+
+Prune bank accounts for users no longer in the server.
+
+Cannot be used with a global bank. See ``[p]bank prune global``.
+
+Examples:
+    - ``[p]bank prune server`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune server yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-prune-user:
+
+"""""""""""""""
+bank prune user
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank prune user <user> [confirmation=False]
+
+**Description**
+
+Delete the bank account of a specified user.
+
+Examples:
+    - ``[p]bank prune user @TwentySix`` - Did not confirm. Shows the help message.
+    - ``[p]bank prune user @TwentySix yes``
+
+**Arguments**
+
+- ``<user>`` The user to delete the bank of. Takes mentions, names, and user ids.
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-reset:
+
+""""""""""
+bank reset
+""""""""""
+
+.. note:: |guildowner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank reset [confirmation=False]
+
+**Description**
+
+Delete all bank accounts.
+
+Examples:
+    - ``[p]bank reset`` - Did not confirm. Shows the help message.
+    - ``[p]bank reset yes``
+
+**Arguments**
+
+- ``<confirmation>`` This will default to false unless specified.
+
+.. _economy-command-bank-set:
+
+""""""""
+bank set
+""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank set <to> <creds>
+
+**Description**
+
+Set the balance of a user's bank account.
+
+Putting + or - signs before the amount will add/remove currency on the user's bank account instead.
+
+Examples:
+    - ``[p]bank set @Twentysix 26`` - Sets balance to 26
+    - ``[p]bank set @Twentysix +2`` - Increases balance by 2
+    - ``[p]bank set @Twentysix -6`` - Decreases balance by 6
+
+**Arguments**
+
+- ``<to>`` The user to set the currency of.
+- ``<creds>`` The amount of currency to set their balance to.
+
+.. _economy-command-bank-transfer:
+
+"""""""""""""
+bank transfer
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank transfer <to> <amount>
+
+**Description**
+
+Transfer currency to other users.
+
+This will come out of your balance, so make sure you have enough.
+
+Example:
+    - ``[p]bank transfer @Twentysix 500``
+
+**Arguments**
+
+- ``<to>`` The user to give currency to.
+- ``<amount>`` The amount of currency to give.
+
+.. _economy-command-economyset:
+
+^^^^^^^^^^
+economyset
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset 
+
+**Description**
+
+Base command to manage Economy settings.
+
+.. _economy-command-economyset-paydayamount:
+
+"""""""""""""""""""""""
+economyset paydayamount
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset paydayamount <creds>
+
+**Description**
+
+Set the amount earned each payday.
+
+Example:
+    - ``[p]economyset paydayamount 400``
+
+**Arguments**
+
+- ``<creds>`` The new amount to give when using the payday command. Default is 120.
+
+.. _economy-command-economyset-paydaytime:
+
+"""""""""""""""""""""
+economyset paydaytime
+"""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset paydaytime <duration>
+
+**Description**
+
+Set the cooldown for the payday command.
+
+Examples:
+    - ``[p]economyset paydaytime 86400``
+    - ``[p]economyset paydaytime 1d``
+
+**Arguments**
+
+- | ``<duration>`` The new duration to wait in between uses of payday. Default is 5 minutes.
+  | Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
+
+.. _economy-command-economyset-registeramount:
+
+"""""""""""""""""""""""""
+economyset registeramount
+"""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset registeramount <creds>
+
+**Description**
+
+Set the initial balance for new bank accounts.
+
+Example:
+    - ``[p]economyset registeramount 5000``
+
+**Arguments**
+
+- ``<creds>`` The new initial balance amount. Default is 0.
+
+.. _economy-command-economyset-rolepaydayamount:
+
+"""""""""""""""""""""""""""
+economyset rolepaydayamount
+"""""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset rolepaydayamount <role> <creds>
+
+**Description**
+
+Set the amount earned each payday for a role. Setting to 0 will remove the custom payday for that role instead.
+
+Only available when not using a global bank.
+
+Example:
+    - ``[p]economyset rolepaydayamount @Members 400``
+
+**Arguments**
+
+- ``<role>`` The role to assign a custom payday amount to.
+- ``<creds>`` The new amount to give when using the payday command.
+
+.. _economy-command-economyset-showsettings:
+
+"""""""""""""""""""""""
+economyset showsettings
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset showsettings 
+
+**Description**
+
+Shows the current economy settings
+
+.. _economy-command-economyset-slotmax:
+
+""""""""""""""""""
+economyset slotmax
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slotmax <bid>
+
+**Description**
+
+Set the maximum slot machine bid.
+
+Example:
+    - ``[p]economyset slotmax 50``
+
+**Arguments**
+
+- ``<bid>`` The new maximum bid for using the slot machine. Default is 100.
+
+.. _economy-command-economyset-slotmin:
+
+""""""""""""""""""
+economyset slotmin
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slotmin <bid>
+
+**Description**
+
+Set the minimum slot machine bid.
+
+Example:
+    - ``[p]economyset slotmin 10``
+
+**Arguments**
+
+- ``<bid>`` The new minimum bid for using the slot machine. Default is 5.
+
+.. _economy-command-economyset-slottime:
+
+"""""""""""""""""""
+economyset slottime
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slottime <duration>
+
+**Description**
+
+Set the cooldown for the slot machine.
+
+Examples:
+    - ``[p]economyset slottime 10``
+    - ``[p]economyset slottime 10m``
+
+**Arguments**
+
+- | ``<duration>`` The new duration to wait in between uses of the slot machine. Default is 5 seconds.
+  | Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
+
+.. _economy-command-leaderboard:
+
+^^^^^^^^^^^
+leaderboard
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]leaderboard [top=10] [show_global=False]
+
+**Description**
+
+Print the leaderboard.
+
+Defaults to top 10.
+
+Examples:
+    - ``[p]leaderboard``
+    - ``[p]leaderboard 50`` - Shows the top 50 instead of top 10.
+    - ``[p]leaderboard 100 yes`` - Shows the top 100 from all servers.
+
+**Arguments**
+
+- ``<top>`` How many positions on the leaderboard to show. Defaults to 10 if omitted.
+- ``<show_global>`` Whether to include results from all servers. This will default to false unless specified.
+
+.. _economy-command-payday:
+
+^^^^^^
+payday
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]payday 
+
+**Description**
+
+Get some free currency.
+
+The amount awarded and frequency can be configured.
+
+.. _economy-command-payouts:
+
+^^^^^^^
+payouts
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]payouts 
+
+**Description**
+
+Show the payouts for the slot machine.
+
+.. _economy-command-slot:
+
+^^^^
+slot
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]slot <bid>
+
+**Description**
+
+Use the slot machine.
+
+Example:
+    - ``[p]slot 50``
+
+**Arguments**
+
+- ``<bid>`` The amount to bet on the slot machine. Winning payouts are higher when you bet more.

docs/cog_guides/filter.rst

@@ -0,0 +1,303 @@
+.. _filter:
+
+======
+Filter
+======
+
+This is the cog guide for the filter 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 filter
+
+.. _filter-usage:
+
+-----
+Usage
+-----
+
+This cog is designed for "filtering" unwanted words and phrases from a server.
+
+It provides tools to manage a list of words or sentences, and to customize automatic actions to be taken against users who use those words in channels or in their name/nickname.
+
+This can be used to prevent inappropriate language, off-topic discussions, invite links, and more.
+
+
+.. _filter-commands:
+
+--------
+Commands
+--------
+
+.. _filter-command-filter:
+
+^^^^^^
+filter
+^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter 
+
+**Description**
+
+Base command to add or remove words from the server filter.
+
+Use double quotes to add or remove sentences.
+
+.. _filter-command-filter-add:
+
+""""""""""
+filter add
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter add [words...]
+
+**Description**
+
+Add words to the filter.
+
+Use double quotes to add sentences.
+
+Examples:
+    - ``[p]filter add word1 word2 word3``
+    - ``[p]filter add "This is a sentence"``
+
+**Arguments:**
+
+- ``[words...]`` The words or sentences to filter.
+
+.. _filter-command-filter-channel:
+
+""""""""""""""
+filter channel
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter channel 
+
+**Description**
+
+Base command to add or remove words from the channel filter.
+
+Use double quotes to add or remove sentences.
+
+.. _filter-command-filter-channel-add:
+
+""""""""""""""""""
+filter channel add
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter channel add [words...]
+
+**Description**
+
+Add words to the filter.
+
+Use double quotes to add sentences.
+
+Examples:
+    - ``[p]filter channel add word1 word2 word3``
+    - ``[p]filter channel add "This is a sentence"``
+
+**Arguments:**
+
+- ``[words...]`` The words or sentences to filter.
+
+.. _filter-command-filter-channel-list:
+
+"""""""""""""""""""
+filter channel list
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter channel list 
+
+**Description**
+
+Send a list of the channel's filtered words.
+
+.. _filter-command-filter-channel-remove:
+
+"""""""""""""""""""""
+filter channel remove
+"""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter channel remove [words...]
+
+**Description**
+
+Remove words from the filter.
+
+Use double quotes to remove sentences.
+
+Examples:
+    - ``[p]filter channel remove word1 word2 word3``
+    - ``[p]filter channel remove "This is a sentence"``
+
+**Arguments:**
+
+- ``[words...]`` The words or sentences to no longer filter.
+
+.. _filter-command-filter-delete:
+
+"""""""""""""
+filter delete
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter delete [words...]
+
+.. tip:: Aliases: ``filter remove``, ``filter del``
+
+**Description**
+
+Remove words from the filter.
+
+Use double quotes to remove sentences.
+
+Examples:
+    - ``[p]filter remove word1 word2 word3``
+    - ``[p]filter remove "This is a sentence"``
+
+**Arguments:**
+
+- ``[words...]`` The words or sentences to no longer filter.
+
+.. _filter-command-filter-list:
+
+"""""""""""
+filter list
+"""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter list 
+
+**Description**
+
+Send a list of this server's filtered words.
+
+.. _filter-command-filter-names:
+
+""""""""""""
+filter names
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filter names 
+
+**Description**
+
+Toggle name and nickname filtering.
+
+This is disabled by default.
+
+.. _filter-command-filterset:
+
+^^^^^^^^^
+filterset
+^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filterset 
+
+**Description**
+
+Base command to manage filter settings.
+
+.. _filter-command-filterset-ban:
+
+"""""""""""""
+filterset ban
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filterset ban <count> <timeframe>
+
+**Description**
+
+Set the filter's autoban conditions.
+
+Users will be banned if they send ``<count>`` filtered words in
+``<timeframe>`` seconds.
+
+Set both to zero to disable autoban.
+
+Examples:
+    - ``[p]filterset ban 5 5`` - Ban users who say 5 filtered words in 5 seconds.
+    - ``[p]filterset ban 2 20`` - Ban users who say 2 filtered words in 20 seconds.
+
+**Arguments:**
+
+- ``<count>`` The amount of filtered words required to trigger a ban.
+- ``<timeframe>`` The period of time in which too many filtered words will trigger a ban.
+
+.. _filter-command-filterset-defaultname:
+
+"""""""""""""""""""""
+filterset defaultname
+"""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]filterset defaultname <name>
+
+**Description**
+
+Set the nickname for users with a filtered name.
+
+Note that this has no effect if filtering names is disabled
+(to toggle, run ``[p]filter names``).
+
+The default name used is *John Doe*.
+
+Example:
+    - ``[p]filterset defaultname Missingno``
+
+**Arguments:**
+
+- ``<name>`` The new nickname to assign.

docs/cog_guides/general.rst

@@ -0,0 +1,218 @@
+.. _general:
+
+=======
+General
+=======
+
+This is the cog guide for the general 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 general
+
+.. _general-usage:
+
+-----
+Usage
+-----
+
+This cog includes a miscellaneous group of games, useful
+tools, and informative commands such as ``serverinfo`` or ``urban``.
+
+.. _general-commands:
+
+--------
+Commands
+--------
+
+Here's a list of all commands available for this cog.
+
+.. _general-command-8:
+
+^^^^^^^^^
+8 (8ball)
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]8 <question>
+
+**Description**
+
+Ask 8 ball a question. 
+
+.. note:: Your question must end with a question mark.
+
+**Arguments**
+
+* ``<question>``: The question you would like to ask 8 ball.
+
+.. _general-command-choose:
+
+^^^^^^
+choose
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]choose <first> <second> [others...]
+
+**Description**
+
+Choose between multiple options.
+Options are separated by spaces.
+
+.. 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**
+
+* ``<first>``: The first mandatory option.
+* ``<second>``: The second mandatory option.
+* ``[others...]``: Any remaining optional options.
+
+
+.. _general-command-flip:
+
+^^^^
+flip
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]flip [user]
+
+**Description**
+
+Flip a coin... or a user.
+
+**Arguments**
+
+* ``[user]``: The user to flip. Defaults to flipping a coin if no user is provided.
+
+.. _general-command-lmgtfy:
+
+^^^^^^
+lmgtfy
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]lmgtfy <search_terms>
+
+**Description**
+
+Create a lmgtfy link.
+
+**Arguments**
+
+* ``<search_terms>``: The terms used to generate the lmgtfy link.
+
+.. _general-command-roll:
+
+^^^^
+roll
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]roll [number=100]
+
+**Description**
+
+Roll a random number. The result will be between 1 and ``<number>``.
+
+**Arguments**
+
+* ``[number]``: The maximum number that can be rolled. Defaults to 100.
+
+.. _general-command-rps:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^
+rps (Rock Paper Scissors)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]rps <your_choice>
+
+**Description**
+
+Play Rock Paper Scissors.
+
+**Arguments**
+
+* ``<your_choice>``: The choice that you choose.
+
+.. note:: Choices **must** be between ``rock``, ``paper``, or ``scissors``.
+
+.. _general-commands-serverinfo:
+
+^^^^^^^^^^
+serverinfo
+^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]serverinfo [details=False]
+
+**Description**
+
+Show server information.
+
+**Arguments**
+
+* ``[details]``: Show extra details about the server when set to True. Defaults to False.
+
+.. _general-commands-stopwatch:
+
+^^^^^^^^^
+stopwatch
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]stopwatch
+
+**Description**
+
+Start or stop the stopwatch.
+
+.. _general-commands-urban:
+
+^^^^^
+urban
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]urban <word>
+
+**Description**
+
+Search the Urban Dictionary.
+
+**Arguments**
+
+* ``<word>``: The term to search for.

docs/cog_guides/image.rst

@@ -0,0 +1,205 @@
+.. _image:
+
+=====
+Image
+=====
+
+This is the cog guide for the image 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 image
+
+.. _image-usage:
+
+-----
+Usage
+-----
+
+This cog provides commands for retrieving pictures from
+websites such as Giphy and Imgur.
+
+.. _image-commands:
+
+--------
+Commands
+--------
+
+Here's a list of all commands available for this cog.
+
+.. _image-command-gif:
+
+^^^
+gif
+^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]gif <keywords...>
+
+**Description**
+
+Retrieve the first search result from Giphy. This command requires API tokens
+to be set via the :ref:`giphycreds <image-command-giphycreds>` command.
+
+**Arguments**
+
+* ``<keywords...>``: The keywords used to search Giphy.
+
+.. _image-command-gifr:
+
+^^^^
+gifr
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]gifr <keywords...>
+
+**Description**
+
+Retrieve a random GIF from a Giphy search. This command requires API tokens
+to be set via the :ref:`giphycreds <image-command-giphycreds>` command.
+
+**Arguments**
+
+* ``<keywords...>``: The keywords used to generate a random GIF.
+
+.. _image-command-imgur:
+
+^^^^^
+imgur
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]imgur
+
+**Description**
+
+Retrieves pictures from Imgur. This command requires API tokens to be set
+via the :ref:`imgurcreds <image-command-imgurcreds>` command.
+
+.. _image-command-imgur-search:
+
+""""""""""""
+imgur search
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]imgur search [count=1] <terms...>
+
+**Description**
+
+Search for pictures on Imgur. This command requires API tokens to be set
+via the :ref:`imgurcreds <image-command-imgurcreds>` command.
+
+**Arguments**
+
+* ``[count]``: How many images should be returned (maximum 5). Defaults to 1.
+
+* ``<terms...>``: The terms used to search Imgur.
+
+.. _image-command-imgur-subreddit:
+
+"""""""""""""""
+imgur subreddit
+"""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]imgur subreddit <subreddit> [count=1] [sort_type=top] [window=day]
+
+**Description**
+
+Get images from a subreddit. This command requires API tokens to be set
+via the :ref:`imgurcreds <image-command-imgurcreds>` command.
+
+**Arguments**
+
+* ``<subreddit>``: The subreddit to get images from.
+
+* ``[count]``: The number of images to return (maximum 5). Defaults to 1.
+
+* ``[sort_type]``: New, or top results. Defaults to top.
+
+* ``[window]``: The timeframe, can be the past day, week, month, year or all. Defaults to day.
+
+.. _image-command-giphycreds:
+
+^^^^^^^^^^
+giphycreds
+^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]giphycreds
+
+**Description**
+
+Explains how to set GIPHY API tokens.
+
+**Getting your API key**
+
+1. Login (or create) a GIPHY account.
+2. Visit `this page <https://developers.giphy.com/dashboard>`__.
+3. Press 'Create an App'.
+4. Click 'Select API', and then 'Next Step'.
+5. Add an app name, for example 'Red'.
+6. Add an app description, for example 'Used for Red's image cog'.
+7. Click 'Create App'. You'll need to agree to the GIPHY API terms.
+8. Copy the API Key.
+9. In Discord, run the following command::
+
+        [p]set api GIPHY api_key <your_api_key_here>
+
+.. _image-command-imgurcreds:
+
+^^^^^^^^^^
+imgurcreds
+^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]imgurcreds
+
+**Description**
+
+Explains how to set Imgur API tokens.
+
+**Getting your API key**
+
+1. Login to (or create) an Imgur account.
+2. Visit `this page <https://api.imgur.com/oauth2/addclient>`__.
+3. Add an app name for your application, for example 'Red'.
+4. Select 'Anonymous usage without user authorization' for the auth type.
+5. Set the authorization callback URL to ``https://localhost``
+6. Leave the app website blank.
+7. Enter a valid email address and a description.
+8. Check the captcha box and click next.
+9. Your Client ID will be on the next page.
+10. In Discord, run the following command::
+
+        [p]set api imgur client_id <your_client_id_here>

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 Twentysix 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 Twentysix 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 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

@@ -0,0 +1,517 @@
+.. _streams:
+
+=======
+Streams
+=======
+
+This is the cog guide for the Streams 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 streams
+
+.. _streams-usage:
+
+-----
+Usage
+-----
+
+This cog provides commands to check if a channel 
+on a supported streaming service is live as well 
+as to create and manage alerts for channels.
+
+Supported streaming services are:
+
+- Twitch
+- Youtube
+- Picarto
+
+Youtube and Twitch both require setting authentication 
+details for commands for those services to work. See 
+:ref:`[p]streamset twitchtoken <streams-command-streamset-twitchtoken>` and 
+:ref:`[p]streamset youtubekey <streams-command-streamset-youtubekey>`
+for more information.
+
+.. _streams-commands:
+
+--------
+Commands
+--------
+
+.. _streams-command-streamset:
+
+^^^^^^^^^
+streamset
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset
+
+**Description**
+
+Manage stream alert settings.
+
+.. _streams-command-streamset-autodelete:
+
+^^^^^^^^^^^^^^^^^^^^
+streamset autodelete
+^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset autodelete <on_off>
+
+**Description**
+
+Toggles automatic deletion of stream alerts when the 
+stream goes offline.
+
+**Arguments**
+
+* ``<on_off>``: Whether to turn on or off
+
+.. _streams-command-streamset-ignorereruns:
+
+^^^^^^^^^^^^^^^^^^^^^^
+streamset ignorereruns
+^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset ignorereruns
+
+**Description**
+
+Toggles excluding reruns from the alerts.
+
+At this time, this functionality only applies to Twitch stream alerts.
+
+.. _streams-command-streamset-mention:
+
+^^^^^^^^^^^^^^^^^
+streamset mention
+^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset mention
+
+**Description**
+
+Toggle mentions for stream alerts.
+
+.. _streams-command-streamset-mention-all:
+
+^^^^^^^^^^^^^^^^^^^^^
+streamset mention all
+^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset mention all
+
+**Description**
+
+Toggle mentioning ``@everyone`` for stream alerts.
+
+.. _streams-command-streamset-mention-online:
+
+^^^^^^^^^^^^^^^^^^^^^^^^
+streamset mention online
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset mention online
+
+**Description**
+
+Toggle mentioning ``@here`` for stream alerts.
+
+.. _streams-command-streamset-mention-role:
+
+^^^^^^^^^^^^^^^^^^^^^^
+streamset mention role
+^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset mention role <role>
+
+**Description**
+
+Toggle mentioning a role for stream alerts.
+
+**Arguments**
+
+* ``<role>``: The role to toggle a mention for. |role-input|
+
+.. _streams-command-streamset-message:
+
+^^^^^^^^^^^^^^^^^
+streamset message
+^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset message
+
+**Description**
+
+Manage custom messages for stream alerts.
+
+.. _streams-command-streamset-message-mention:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^
+streamset message mention
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset message mention <message>
+
+**Description**
+
+Sets a stream alert message for when mentions are enabled.
+
+Use ``{mention}`` in the message to insert the selected mentions.
+
+Use ``{stream}`` in the message to insert the channel or user name.
+
+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**
+
+* ``<message>``: Your alert message
+
+.. _streams-command-streamset-message-nomention:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+streamset message nomention
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset message nomention <message>
+
+**Description**
+
+Sets a stream alert message for when mentions are disabled.
+
+Use ``{stream}`` in the message to insert the channel or user name.
+
+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**
+
+* ``<message>``: Your alert message
+
+.. _streams-command-streamset-message-clear:
+
+^^^^^^^^^^^^^^^^^^^^^^^
+streamset message clear
+^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset message clear
+
+**Description**
+
+Resets the stream alert messages for the server.
+
+.. _streams-command-streamset-timer:
+
+^^^^^^^^^^^^^^^
+streamset timer
+^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset timer <refresh_timer>
+
+**Description**
+
+Sets the refresh time for stream alerts (how frequently they will be checked).
+
+This cannot be set to anything less than 60 seconds.
+
+**Arguments**
+
+* ``<refresh_timer>``: The frequency with which streams should be checked, in seconds
+
+.. _streams-command-streamset-youtubekey:
+
+^^^^^^^^^^^^^^^^^^^^
+streamset youtubekey
+^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset youtubekey
+
+**Description**
+
+Explains how to set the YouTube token.
+
+To get one, do the following:
+
+1. Create a project
+(see https://support.google.com/googleapi/answer/6251787 for details)
+
+2. Enable the YouTube Data API v3
+(see https://support.google.com/googleapi/answer/6158841 for instructions)
+
+3. Set up your API key
+(see https://support.google.com/googleapi/answer/6158862 for instructions)
+
+4. Copy your API key and run the command ``[p]set api youtube api_key <your_api_key_here>``
+
+.. attention:: These tokens are sensitive and should only be 
+               used in a private channel or in DM with the bot.
+
+.. _streams-command-streamset-twitchtoken:
+
+^^^^^^^^^^^^^^^^^^^^^
+streamset twitchtoken
+^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamset twitchtoken
+
+**Description**
+
+Explains how to set the Twitch token.
+
+To set the Twitch API tokens, follow these steps:
+
+1. Go to this page: https://dev.twitch.tv/dashboard/apps.
+
+2. Click Register Your Application.
+
+3. Enter a name, set the OAuth Redirect URI to http://localhost, and select an Application Category of your choosing.
+
+4. Click Register.
+
+5. Copy your client ID and your client secret into:
+``[p]set api twitch client_id <your_client_id_here> client_secret <your_client_secret_here>``
+
+.. attention:: These tokens are sensitive and should only be 
+               used in a private channel or in DM with the bot.
+
+.. _streams-command-picarto:
+
+^^^^^^^
+picarto
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]picarto <channel_name>
+
+**Description**
+
+Check if a Picarto channel is live.
+
+**Arguments**
+
+* ``<channel_name>``: The Picarto channel to check.
+
+.. _streams-command-twitchstream:
+
+^^^^^^^^^^^^
+twitchstream
+^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]twitchstream <channel_name>
+
+**Description**
+
+Check if a Twitch channel is live.
+
+**Arguments**
+
+* ``<channel_name>``: The Twitch channel to check.
+
+.. _streams-command-youtubestream:
+
+^^^^^^^^^^^^^
+youtubestream
+^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]youtubestream <channel_id_or_name>
+
+**Description**
+
+Check if a YouTube channel is live.
+
+**Arguments**
+
+* ``<channel_id_or_name>``: The name or id of the YouTube channel to be checked.
+
+.. _streams-command-streamalert:
+
+^^^^^^^^^^^
+streamalert
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert
+
+**Description**
+
+Manage automated stream alerts.
+
+.. _streams-command-streamalert-list:
+
+^^^^^^^^^^^^^^^^
+streamalert list
+^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert list
+
+**Description**
+
+Lists all active alerts in the current server.
+
+.. _streams-command-streamalert-picarto:
+
+^^^^^^^^^^^^^^^^^^^
+streamalert picarto
+^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert picarto <channel_name>
+
+**Description**
+
+Toggle alerts in the current channel for the 
+specified Picarto channel.
+
+**Arguments**
+
+* ``<channel_name>``: The Picarto channel to toggle the alert for.
+
+.. _streams-command-streamalert-twitch-channel:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+streamalert twitch channel
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert twitch channel <channel_name>
+
+**Description**
+
+Toggle alerts in the current channel for the 
+specified Twitch channel.
+
+**Arguments**
+
+* ``<channel_name>``: The Twitch channel to toggle the alert for.
+
+.. _streams-command-streamalert-youtube:
+
+^^^^^^^^^^^^^^^^^^^
+streamalert youtube
+^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert youtube <channel_name>
+
+**Description**
+
+Toggle alerts in the current channel for the 
+specified Picarto channel.
+
+**Arguments**
+
+* ``<channel_id_or_name>``: The name or id of the YouTube channel to be checked.
+
+.. _streams-command-streamalert-stop:
+
+^^^^^^^^^^^^^^^^
+streamalert stop
+^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert stop [disable-all=No]
+
+**Description**
+
+Disable all stream alerts for this channel or server.
+
+**Arguments**
+
+* ``[disable-all]``: Defaults to ``no``. If this is set to ``yes``, all 
+  stream alerts in the current server will be disabled. 
+  If ``no`` or unspecified, all stream alerts in the 
+  current channel will be stopped. 

docs/cog_guides/trivia.rst

@@ -0,0 +1,439 @@
+.. _trivia:
+
+======
+Trivia
+======
+
+This is the cog guide for the trivia 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 trivia
+
+.. _trivia-usage:
+
+-----
+Usage
+-----
+
+This cog allows for playing trivia with others. You may 
+choose to play just one category at a time or choose 
+multiple to add variety to your game. You can even create 
+your own lists!
+
+.. _trivia-commands:
+
+--------
+Commands
+--------
+
+Here is a list of all of the commands for this cog:
+
+.. _trivia-command-triviaset:
+
+^^^^^^^^^
+triviaset
+^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset
+
+**Description**
+
+Commands for managing trivia settings.
+
+.. _trivia-command-triviaset-botplays:
+
+^^^^^^^^^^^^^^^^^^
+triviaset botplays
+^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset botplays <true_or_false>
+
+**Description**
+
+Sets whether the bot gains a point if nobody guesses correctly.
+
+**Arguments**
+
+- ``<true_or_false>`` If ``true``, the bot will gain a point if nobody
+  guesses correctly, otherwise it will not.
+
+.. _trivia-command-triviaset-maxscore:
+
+^^^^^^^^^^^^^^^^^^
+triviaset maxscore
+^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset maxscore <score>
+
+**Description**
+
+Sets the total points required to win.
+
+**Arguments**
+
+- ``<score>`` The amount of points required to win.
+
+.. _trivia-command-triviaset-override:
+
+^^^^^^^^^^^^^^^^^^
+triviaset override
+^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset override <enabled>
+
+**Description**
+
+Allow/disallow trivia lists to override the settings.
+
+**Arguments**
+
+- ``<enabled>`` Whether trivia lists should be able to override settings.
+
+.. _trivia-command-triviaset-payout:
+
+^^^^^^^^^^^^^^^^
+triviaset payout
+^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset payout <multiplier>
+
+**Description**
+
+Sets the payout multiplier. 
+
+If a user wins trivia when at least 3 users are playing, they will receive credits; 
+the amount received is determined by multiplying their total score by this multiplier.
+
+**Arguments**
+
+- ``<multiplier>`` The amount to multiply the winner's score by to determine payout.
+  This can be any positive decimal number. Setting this to 0 will disable.
+
+.. _trivia-command-triviaset-revealanswer:
+
+^^^^^^^^^^^^^^^^^^^^^^
+triviaset revealanswer
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset revealanswer <true_or_false>
+
+**Description**
+
+Sets whether or not the answer is revealed if the time limit for answering runs out.
+
+**Arguments**
+
+- ``<true_or_false>`` If ``true``, the bot will reveal the answer if there is no
+  correct guess within the time limit.
+
+.. _trivia-command-triviaset-showsettings:
+
+^^^^^^^^^^^^^^^^^^^^^^
+triviaset showsettings
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset showsettings
+
+**Description**
+
+Shows the current trivia settings.
+
+.. _trivia-command-triviaset-stopafter:
+
+^^^^^^^^^^^^^^^^^^^
+triviaset stopafter
+^^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset stopafter <seconds>
+
+**Description**
+
+Sets how long the bot should wait before stopping the trivia 
+session due to lack of response.
+
+**Arguments**
+
+- ``<seconds>`` The number of seconds to wait before stopping the session.
+
+.. _trivia-command-triviaset-timelimit:
+
+^^^^^^^^^^^^^^^^^^^
+triviaset timelimit
+^^^^^^^^^^^^^^^^^^^
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset timelimit <seconds>
+
+**Description**
+
+Sets the maximum time permitted to answer a question.
+
+**Arguments**
+
+- ``<seconds>`` The number of seconds to wait for an answer.
+
+.. _trivia-command-triviaset-custom:
+
+^^^^^^^^^^^^^^^^
+triviaset custom
+^^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset custom
+
+**Description**
+
+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:
+
+^^^^^^^^^^^^^^^^^^^^^^^
+triviaset custom upload
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset custom upload
+
+**Description**
+
+Upload a custom trivia list. The bot will prompt you to upload 
+your list as an attachment in Discord.
+
+.. _trivia-command-triviaset-custom-list:
+
+^^^^^^^^^^^^^^^^^^^^^
+triviaset custom list
+^^^^^^^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset custom list
+
+**Description**
+
+List all uploaded custom trivia lists.
+
+.. _trivia-command-triviaset-custom-delete:
+
+^^^^^^^^^^^^^^^^^^^^^^^
+triviaset custom delete
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]triviaset custom delete <name>
+
+**Description**
+
+Delete a custom trivia list.
+
+**Arguments**
+
+- ``<name>`` The name of the custom list to be deleted.
+
+.. _trivia-command-trivia:
+
+^^^^^^
+trivia
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia <categories...>
+
+**Description**
+
+Start a trivia session on the specified category.
+
+Multiple categories can be listed, in which case the trivia session 
+will use all of the specified lists to select questions from.
+
+**Arguments**
+
+- ``<categories...>`` The category to play. Can be multiple.
+
+.. _trivia-command-trivia-leaderboard:
+
+^^^^^^^^^^^^^^^^^^
+trivia leaderboard
+^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia leaderboard
+
+**Description**
+
+Shows the trivia leaderboard. Defaults to the top ten in the 
+current server, sorted by total wins. The subcommands provide 
+more customized leaderboards.
+
+.. _trivia-command-trivia-leaderboard-global:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^
+trivia leaderboard global
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia leaderboard global [sort_by=wins] [top=10]
+
+**Description**
+
+The global trivia leaderboard.
+
+**Arguments**
+
+- ``[sort_by=wins]`` The method by which to sort the leaderboard (defaults to wins). Can be one of:
+
+    - ``wins`` Total wins
+    - ``avg`` Average score
+    - ``total`` Total correct answers from all sessions
+    - ``games`` Total games played.
+
+- ``[top=10]`` The number of ranks to show on the leaderboard. Defaults to 10
+
+.. _trivia-command-trivia-leaderboard-server:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^
+trivia leaderboard server
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia leaderboard server [sort_by=wins] [top=10]
+
+**Description**
+
+The trivia leaderboard for this server.
+
+**Arguments**
+
+- ``[sort_by=wins]`` The method by which to sort the leaderboard (defaults to wins). Can be one of:
+
+    - ``wins`` Total wins
+    - ``avg`` Average score
+    - ``total`` Total correct answers from all sessions
+    - ``games`` Total games played.
+
+- ``[top=10]`` The number of ranks to show on the leaderboard. Defaults to 10
+
+.. _trivia-command-trivia-list:
+
+^^^^^^^^^^^
+trivia list
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia list
+
+**Description**
+
+Lists the available trivia categories
+
+.. _trivia-command-trivia-stop:
+
+^^^^^^^^^^^
+trivia stop
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]trivia stop
+
+**Description**
+
+Stops an ongoing trivia session.

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

@@ -21,6 +21,7 @@ import os
 import sys
 
 sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("_ext"))
 
 os.environ["BUILDING_DOCS"] = "1"
 
@@ -42,6 +43,8 @@ extensions = [
     "sphinx.ext.napoleon",
     "sphinx.ext.doctest",
     "sphinxcontrib_trio",
+    "sphinx-prompt",
+    "deprecated_removed",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -58,7 +61,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Red - Discord Bot"
-copyright = "2018-2020, Cog Creators"
+copyright = "2018-2021, Cog Creators"
 author = "Cog Creators"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -108,9 +111,6 @@ rst_prolog += f"\n.. |DPY_VERSION| replace:: {dpy_version}"
 #
 html_theme = "sphinx_rtd_theme"
 
-# This will be needed until sphinx_rtd_theme supports the html5 writer
-html4_writer = True
-
 # 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.

docs/framework_apikeys.rst

@@ -73,3 +73,5 @@ Additional References
 .. automethod:: Red.set_shared_api_tokens
 
 .. automethod:: Red.remove_shared_api_tokens
+
+.. automethod:: Red.remove_shared_api_services

docs/framework_checks.rst

@@ -7,5 +7,5 @@ Command Check Decorators
 The following are all decorators for commands, which add restrictions to where and when they can be
 run.
 
-.. automodule:: redbot.core.checks
-    :members:
+.. automodule:: redbot.core.commands
+    :members: permissions_check, bot_has_permissions, bot_in_a_guild, has_permissions, has_guild_permissions, is_owner, guildowner, guildowner_or_permissions, admin, admin_or_permissions, mod, mod_or_permissions

docs/framework_commands.rst

@@ -13,6 +13,14 @@ extend functionalities used throughout the bot, as outlined below.
 
 .. autofunction:: redbot.core.commands.group
 
+.. autoclass:: redbot.core.commands.Cog
+
+    .. automethod:: format_help_for_context
+    
+    .. automethod:: red_get_data_for_user
+    
+    .. automethod:: red_delete_data_for_user
+
 .. autoclass:: redbot.core.commands.Command
     :members:
     :inherited-members: format_help_for_context
@@ -32,5 +40,24 @@ extend functionalities used throughout the bot, as outlined below.
 
 .. automodule:: redbot.core.commands.converter
     :members:
-    :exclude-members: convert
+    :exclude-members: UserInputOptional, convert
     :no-undoc-members:
+
+    .. autodata:: UserInputOptional
+        :annotation:
+
+.. _framework-commands-help:
+
+******************
+Help Functionality
+******************
+
+.. warning::
+
+    The content in this section is provisional and may change
+    without prior notice or warning. Updates to this will be communicated
+    on `this issue <https://github.com/Cog-Creators/Red-DiscordBot/issues/4084>`_
+
+
+.. automodule:: redbot.core.commands.help
+    :members:

docs/framework_config.rst

@@ -21,8 +21,9 @@ Basic Usage
 .. code-block:: python
 
     from redbot.core import Config
+    from redbot.core import commands
 
-    class MyCog:
+    class MyCog(commands.Cog):
         def __init__(self):
             self.config = Config.get_conf(self, identifier=1234567890)
 
@@ -52,7 +53,7 @@ Then, in the class's :code:`__init__` function, you need to get a config instanc
 
 .. code-block:: python
 
-    class MyCog:
+    class MyCog(commands.Cog):
         def __init__(self):
             self.config = Config.get_conf(self, identifier=1234567890)
 
@@ -68,7 +69,7 @@ After we've gotten that, we need to register default values:
 
 .. code-block:: python
 
-    class MyCog:
+    class MyCog(commands.Cog):
         def __init__(self):
             self.config = Config.get_conf(self, identifier=1234567890)
             default_global = {
@@ -188,29 +189,130 @@ features within Config to enable developers to work with data how they wish.
 
 This usage guide will cover the following features:
 
+- :py:meth:`Config.init_custom`
+- :py:meth:`Config.register_custom`
+- :py:meth:`Config.custom`
 - :py:meth:`Group.get_raw`
 - :py:meth:`Group.set_raw`
 - :py:meth:`Group.clear_raw`
 
+
+Custom Groups
+^^^^^^^^^^^^^
+While Config has built-in groups for the common discord objects,
+sometimes you need a combination of these or your own defined grouping.
+Config handles this by allowing you to define custom groups.
+
+Let's start by showing how :py:meth:`Config.custom` can be equivalent to :py:meth:`Config.guild` by modifying the above
+Tutorial example.
+
+.. code-block:: python
+
+    from redbot.core import Config, commands
+
+
+    class MyCog(commands.Cog):
+        def __init__(self):
+            self.config = Config.get_conf(self, identifier=1234567890)
+            default_guild = {
+                "blah": [],
+                "baz": 1234567890
+            }
+
+            # self.config.register_guild(**default_guild)
+
+            self.config.init_custom("CustomGuildGroup", 1)
+            self.config.register_custom("CustomGuildGroup", **default_guild)
+
+In the above, we registered the custom group named "CustomGuildGroup" to contain the same defaults
+that :code:`self.config.guild` normally would. First, we initialized the group "CustomGuildGroup" to
+accept one identifier by calling :py:meth:`Config.init_custom` with the argument :code:`1`. Then we used
+:py:meth:`Config.register_custom` to register the default values.
+
+.. important::
+
+    :py:meth:`Config.init_custom` **must** be called prior to using a custom group.
+
+
+Now let's use this custom group:
+
+.. code-block:: python
+
+    @commands.command()
+    async def setbaz(self, ctx, new_value):
+        # await self.config.guild(ctx.guild).baz.set(new_value)
+
+        await self.config.custom("CustomGuildGroup", ctx.guild.id).baz.set(new_value)
+        await ctx.send("Value of baz has been changed!")
+
+    @commands.command()
+    async def checkbaz(self, ctx):
+        # baz_val = await self.config.guild(ctx.guild).baz()
+
+        baz_val = await self.config.custom("CustomGuildGroup", ctx.guild.id).baz()
+        await ctx.send("The value of baz is {}".format("True" if baz_val else "False"))
+
+Here we used :py:meth:`Config.custom` to access our custom group much like we would have used :py:meth:`Config.guild`.
+Since it's a custom group, we need to use :code:`id` attribute of guild to get a unique identifier.
+
+Now let's see an example that uses multiple identifiers:
+
+.. code-block:: python
+
+    from redbot.core import Config, commands, checks
+
+
+    class ChannelAccesss(commands.Cog):
+        def __init__(self):
+            self.config = Config.get_conf(self, identifier=1234567890)
+            default_access = {
+                "allowed": False
+            }
+
+            self.config.init_custom("ChannelAccess", 2)
+            self.config.register_custom("ChannelAccess", **default_access)
+
+        @commands.command()
+        @checks.is_owner()
+        async def grantaccess(self, ctx, channel: discord.TextChannel, member: discord.Member):
+            await self.config.custom("ChannelAccess", channel.id, member.id).allowed.set(True)
+            await ctx.send("Member has been granted access to that channel")
+
+        @commands.command()
+        async def checkaccess(self, ctx, channel: discord.TextChannel):
+            allowed = await self.config.custom("ChannelAccess", channel.id, ctx.author.id).allowed()
+            await ctx.send("Your access to this channel is {}".format("Allowed" if allowed else "Denied"))
+
+In the above example, we defined the custom group "ChannelAccess" to accept two identifiers
+using :py:meth:`Config.init_custom`. Then, we were able to set the default value for any member's
+access to any channel to `False` until the bot owner grants them access.
+
+.. important::
+
+    The ordering of the identifiers matter. :code:`custom("ChannelAccess", channel.id, member.id)` is NOT the same
+    as :code:`custom("ChannelAccess", member.id, channel.id)`
+
+Raw Group Access
+^^^^^^^^^^^^^^^^
+
 For this example let's suppose that we're creating a cog that allows users to buy and own multiple pets using
 the built-in Economy credits::
 
     from redbot.core import bank
-    from redbot.core import Config
-    from discord.ext import commands
+    from redbot.core import Config, commands
 
 
-    class Pets:
+    class Pets(commands.Cog):
         def __init__(self):
-            self.conf = Config.get_conf(self, 1234567890)
+            self.config = Config.get_conf(self, 1234567890)
 
             # Here we'll assign some default costs for the pets
-            self.conf.register_global(
+            self.config.register_global(
                 dog=100,
                 cat=100,
                 bird=50
             )
-            self.conf.register_user(
+            self.config.register_user(
                 pets={}
             )
 
@@ -229,7 +331,7 @@ And now that the cog is set up we'll need to create some commands that allow use
 
             # We will need to use "get_raw"
             try:
-                cost = await self.conf.get_raw(pet_type)
+                cost = await self.config.get_raw(pet_type)
             except KeyError:
                 # KeyError is thrown whenever the data you try to access does not
                 # exist in the registered defaults or in the saved data.
@@ -241,15 +343,15 @@ assign a new pet to the user. This is very easily done using the V3 bank API and
 
     # continued
             if await bank.can_spend(ctx.author, cost):
-                await self.conf.user(ctx.author).pets.set_raw(
+                await self.config.user(ctx.author).pets.set_raw(
                     pet_name, value={'cost': cost, 'hunger': 0}
                 )
 
                 # this is equivalent to doing the following
 
-                pets = await self.conf.user(ctx.author).pets()
+                pets = await self.config.user(ctx.author).pets()
                 pets[pet_name] = {'cost': cost, 'hunger': 0}
-                await self.conf.user(ctx.author).pets.set(pets)
+                await self.config.user(ctx.author).pets.set(pets)
 
 Since the pets can get hungry we're gonna need a command that let's pet owners check how hungry their pets are::
 
@@ -257,7 +359,7 @@ Since the pets can get hungry we're gonna need a command that let's pet owners c
         @commands.command()
         async def hunger(self, ctx, pet_name: str):
             try:
-                hunger = await self.conf.user(ctx.author).pets.get_raw(pet_name, 'hunger')
+                hunger = await self.config.user(ctx.author).pets.get_raw(pet_name, 'hunger')
             except KeyError:
                 # Remember, this is thrown if something in the provided identifiers
                 # is not found in the saved data or the defaults.
@@ -274,7 +376,7 @@ We're responsible pet owners here, so we've also got to have a way to feed our p
             # This is a bit more complicated because we need to check if the pet is
             # owned first.
             try:
-                pet = await self.conf.user(ctx.author).pets.get_raw(pet_name)
+                pet = await self.config.user(ctx.author).pets.get_raw(pet_name)
             except KeyError:
                 # If the given pet name doesn't exist in our data
                 await ctx.send("You don't own that pet!")
@@ -285,12 +387,12 @@ We're responsible pet owners here, so we've also got to have a way to feed our p
             # Determine the new hunger and make sure it doesn't go negative
             new_hunger = max(hunger - food, 0)
 
-            await self.conf.user(ctx.author).pets.set_raw(
+            await self.config.user(ctx.author).pets.set_raw(
                 pet_name, 'hunger', value=new_hunger
             )
 
             # We could accomplish the same thing a slightly different way
-            await self.conf.user(ctx.author).pets.get_attr(pet_name).hunger.set(new_hunger)
+            await self.config.user(ctx.author).pets.get_attr(pet_name).hunger.set(new_hunger)
 
             await ctx.send("Your pet is now at {}/100 hunger!".format(new_hunger)
 
@@ -300,7 +402,7 @@ Of course, if we're less than responsible pet owners, there are consequences::
         @commands.command()
         async def adopt(self, ctx, pet_name: str, *, member: discord.Member):
             try:
-                pet = await self.conf.user(member).pets.get_raw(pet_name)
+                pet = await self.config.user(member).pets.get_raw(pet_name)
             except KeyError:
                 await ctx.send("That person doesn't own that pet!")
                 return
@@ -310,15 +412,15 @@ Of course, if we're less than responsible pet owners, there are consequences::
                 await ctx.send("That pet is too well taken care of to be adopted.")
                 return
 
-            await self.conf.user(member).pets.clear_raw(pet_name)
+            await self.config.user(member).pets.clear_raw(pet_name)
 
             # this is equivalent to doing the following
 
-            pets = await self.conf.user(member).pets()
+            pets = await self.config.user(member).pets()
             del pets[pet_name]
-            await self.conf.user(member).pets.set(pets)
+            await self.config.user(member).pets.set(pets)
 
-            await self.conf.user(ctx.author).pets.set_raw(pet_name, value=pet)
+            await self.config.user(ctx.author).pets.set_raw(pet_name, value=pet)
             await ctx.send(
                 "Your request to adopt this pet has been granted due to "
                 "how poorly it was taken care of."
@@ -346,20 +448,20 @@ much the same way they would in V2. The following examples will demonstrate how
 
 .. code-block:: python
 
-    from redbot.core import Config
+    from redbot.core import Config, commands
 
 
-    class ExampleCog:
+    class ExampleCog(commands.Cog):
         def __init__(self):
-            self.conf = Config.get_conf(self, 1234567890)
-
+            self.config = Config.get_conf(self, 1234567890)
+            self.config.init_custom("V2", 1)
             self.data = {}
 
         async def load_data(self):
-            self.data = await self.conf.custom("V2", "V2").all()
+            self.data = await self.config.custom("V2", "V2").all()
 
         async def save_data(self):
-            await self.conf.custom("V2", "V2").set(self.data)
+            await self.config.custom("V2", "V2").set(self.data)
 
 
     async def setup(bot):
@@ -407,13 +509,13 @@ API Reference
     includes keys within a `dict` when one is being set, as well as keys in  nested dictionaries
     within that `dict`. For example::
 
-        >>> conf = Config.get_conf(self, identifier=999)
-        >>> conf.register_global(foo={})
-        >>> await conf.foo.set_raw(123, value=True)
-        >>> await conf.foo()
+        >>> config = Config.get_conf(self, identifier=999)
+        >>> config.register_global(foo={})
+        >>> await config.foo.set_raw(123, value=True)
+        >>> await config.foo()
         {'123': True}
-        >>> await conf.foo.set({123: True, 456: {789: False}}
-        >>> await conf.foo()
+        >>> await config.foo.set({123: True, 456: {789: False}}
+        >>> await config.foo()
         {'123': True, '456': {'789': False}}
 
 .. automodule:: redbot.core.config

docs/framework_i18n.rst

@@ -33,21 +33,17 @@ Tutorial
 
 After making your cog, generate a :code:`messages.pot` file
 
-The process of generating this will depend on the operating system
-you are using
+We recommend using redgettext - a modified version of pygettext for Red.
+You can install redgettext by running :code:`pip install redgettext` in a command prompt.
 
-In a command prompt in your cog's package (where yourcog.py is),
-create a directory called "locales".
-Then do one of the following:
-
-Windows: :code:`python <your python install path>\Tools\i18n\pygettext.py -D -n -p locales`
-
-Mac: ?
-
-Linux: :code:`pygettext3 -D -n -p locales`
-
-This will generate a messages.pot file with strings to be translated, including
+To generate the :code:`messages.pot` file, you will now need to run
+:code:`python -m redgettext -c [path_to_cog]`
+This file will contain all strings to be translated, including
 docstrings.
+(For advanced usage check :code:`python -m redgettext -h`)
+
+You can now use a tool like `poedit
+<https://poedit.net/>`_ to translate the strings in your messages.pot file.
 
 -------------
 API Reference

docs/framework_rpc.rst

@@ -4,6 +4,10 @@
 RPC
 ===
 
+.. important::
+
+  RPC support is included in Red on a provisional basis. Backwards incompatible changes (up to and including removal of the RPC) may occur if deemed necessary.
+
 V3 comes default with an internal RPC server that may be used to remotely control the bot in various ways.
 Cogs must register functions to be exposed to RPC clients.
 Each of those functions must only take JSON serializable parameters and must return JSON serializable objects.

docs/framework_utils.rst

@@ -8,7 +8,19 @@ General Utility
 ===============
 
 .. automodule:: redbot.core.utils
-    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter
+    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter, get_end_user_data_statement, get_end_user_data_statement_or_raise
+
+.. autoclass:: AsyncIter
+    :members:
+    :special-members: __await__
+    :exclude-members: enumerate, filter
+
+    .. automethod:: enumerate
+        :async-for:
+
+    .. automethod:: filter
+        :async-for:
+
 
 Chat Formatting
 ===============

docs/getting_started.rst

@@ -81,15 +81,30 @@ parameters.
 
     [p]help command
 
-The parameters are shown as enclosed in ``< >`` if they're required, or
-``[ ]`` if optional.
-As an example, the ban command will show this in the help message, assuming
-your prefix is ``!``:
-``Syntax: !ban <user> [days] [reason]``
+.. note::
+    Arguments enclosed in ``< >`` are **required** for the command to work.
 
-This means that it is necessary to provide ``user``. However, the
-``days`` value (number of messages to delete) is optional, as well as
-the ``reason`` value, used for the modlog.
+    Arguments enclosed in ``[ ]`` are **optional** for the command;
+    you can decide whether to use them or not.
+    
+    If your argument includes spaces like ``Hello world!``, most of the time
+    you will need to place it in double quotes like this: ``"Hello world!"``.
+    Sometimes (especially for the last argument) these double quotes are not
+    required.
+
+    Arguments followed by an ellipsis ``...`` means that you may provide
+    multiple arguments for the command.
+
+    For example, the command ``[p]cog install`` in the downloader cog has
+    the syntax ``cog install <repo> <cogs...>``, meaning that you can provide
+    1 or more ``cogs`` to install from the ``repo``.
+
+    Arguments followed by ``=value`` means that, if not specified,
+    the argument will be equal to ``value``.
+
+    For example, the command ``[p]cleanup messages`` in the cleanup cog has
+    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):
@@ -153,14 +168,10 @@ download them using the downloader cog.
 
 You can start using the downloader cog by loading it: ``[p]load downloader``
 
-You can find cogs by searching on ``cogs.red``. Find whatever you want,
+You can find cogs by searching on `<https://index.discord.red>`_. Find whatever you want,
 there are hundreds of cogs available!
 
-.. note:: ``cogs.red``, the website that list all of the cogs is not
-    ready for v3 yet. For now, you can refer to `this post
-    <https://cogboard.red/t/approved-repositories/210>`_.
-
-.. 26-cogs not available, let's use my repo :3
+.. note:: An even better way to discover new cogs and repositories is in the works! Stay tuned!
 
 Cogs come in repositories. A repository is a container of cogs
 that you can install. Let's suppose you want to install the ``say``
@@ -242,9 +253,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.
@@ -261,8 +272,8 @@ If you want to do it, follow these steps.
 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 list <host-list>` for
-  quality VPS providers.
+  on an online service. Please check :ref:`this page <host-list>` for
+  more information.
 
   You can also buy a Raspberry Pi (~$20), which is a micro-computer that will
   be able to host Red. The model 3 or above is recommended.
@@ -270,10 +281,10 @@ 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 18**.
+  you're a beginner, we recommend **Ubuntu 20.04 LTS**.
 
   For Raspberry Pi users, just install `Raspbian
-  <https://www.raspberrypi.org/downloads/raspbian/>`_ on a micro-SD card.
+  <https://www.raspberrypi.org/software/>`_ on a micro-SD card.
 
 2.1. **Log in**
 
@@ -344,22 +355,3 @@ The cog guides are formatted the same. They're divided into 3 sections:
   * **Arguments**
 
     A list of all arguments needed (or not) for the command, with more details.
-
-    .. tip::
-        Arguments enclosed in ``< >`` means that the argument is **required**
-        for the command to work.
-
-        Arguments enclosed in ``[ ]`` means that the argument is **optional**
-        for the command; you can decide to use it or not.
-        
-        If your argument includes spaces like ``Hello world!``, most of the time
-        you will need to place it in double quotes like this: ``"Hello world!"``.
-        Sometimes (especially for the last argument) these double quotes are not
-        required.
-
-        Arguments followed by ``=something`` means that, if not specified,
-        the argument will be equal to ``something``.
-
-        For example, ``[days=1]`` in the ``ban`` command means that the number
-        of days of messages to be deleted will be equal to ``1`` if not
-        specified.

docs/guide_cog_creation.rst

@@ -35,8 +35,8 @@ Open a terminal or command prompt and type one of the following
   intended for normal users.** We will not support anyone using the development version in any
   support channels. Using the development version may break third party cogs and not all core
   commands may work. Downgrading to stable after installing the development version may cause
-  data loss, crashes or worse. Please keep this in mind when using the Development version
-  While working on cog creation.
+  data loss, crashes or worse. Please keep this in mind when using the development version
+  while working on cog creation.
 
   .. code-block:: none
 
@@ -83,9 +83,12 @@ In that file, place the following code:
 
     from redbot.core import commands
 
-    class Mycog(commands.Cog):
+    class MyCog(commands.Cog):
         """My custom cog"""
 
+        def __init__(self, bot):
+            self.bot = bot
+
         @commands.command()
         async def mycom(self, ctx):
             """This does stuff!"""
@@ -96,10 +99,11 @@ Open :code:`__init__.py`. In that file, place the following:
 
 .. code-block:: python
 
-    from .mycog import Mycog
+    from .mycog import MyCog
+
 
     def setup(bot):
-        bot.add_cog(Mycog())
+        bot.add_cog(MyCog(bot))
 
 Make sure that both files are saved.
 
@@ -155,6 +159,12 @@ Publishing your cog
 
 Go to :doc:`/guide_publish_cogs`
 
+--------------------------------
+Becoming an Approved Cog Creator
+--------------------------------
+
+:doc:`/guide_cog_creators` explains the Cog Creator Application process and lists requirements and good practices for Cog Creators.  This information is worth following for anyone creating cogs for Red, regardless of if you plan to publish your cogs or not.
+
 --------------------
 Additional resources
 --------------------
@@ -162,70 +172,3 @@ Additional resources
 Be sure to check out the :doc:`/guide_migration` for some resources
 on developing cogs for V3. This will also cover differences between V2 and V3 for
 those who developed cogs for V2.
-
-
----------------------------
-Guidelines for Cog Creators
----------------------------
-
-The following are a list of guidelines Cog Creators should strive to follow.
-Not all of these are strict requirements (some are) but are all generally advisable.
-
-1. Cogs should follow a few naming conventions for consistency.
-
-  - Cog classes should be TitleCased, using alphabetic characters only.
-  - Commands should be lower case, using alphanumeric characters only.
-  - Cog modules should be lower case, using alphabetic characters only.
-
-2. Cogs and commands should have docstrings suitable for use in help output.
-
-  - This one is slightly flexible if using other methods of setting help.
-
-3. Don't prevent normal operation of the bot without the user opting into this.
-
-  - This includes as a side effect by blocking the event loop.
-
-4. If your cog uses logging:
-
-  - The namespace for logging should be: ``red.your_repo_name.cog_name``.
-  - Print statements are not a substitute for proper logging.
-
-5. If you use asyncio.create_task, your tasks need to:
-
-  - Be cancelled on cog unload.
-  - Handle errors.
-
-6. Event listeners should exit early if it is an event you don't need.
-   This makes your events less expensive in terms of CPU time. Examples below:
-
-  - Checking that you are in a guild before interacting with config for an antispam command.
-  - Checking that you aren't reacting to a bot message (``not message.author.bot``) early on.
-
-7. Use .gitignore (or something else) to keep unwanted files out of your cog repo.
-8. Put a license on your cog repo.
-
-  - By default, in most jurisdictions, without a license that at least offers the code for use,
-    users cannot legally use your code.
-
-9. Use botwide features when they apply. Some examples of this:
-
-  - ``ctx.embed_color``
-  - ``bot.is_automod_immune``
-
-10. Use checks to limit command use when the bot needs special permissions.
-11. Check against user input before doing things. Common things to check:
-
-  - Resulting output is safe.
-  - Values provided make sense. (eg. no negative numbers for payday)
-  - Don't unsafely use user input for things like database input.
-
-12. Don't abuse bot internals.
-
-  - If you need access to something, ask us or open an issue.
-  - If you're sure the current usage is safe, document why,
-    but we'd prefer you work with us on ensuring you have access to what you need.
-
-13. Update your cogs for breakage.
-
-  - We announce this in advance.
-  - If you need help, ask.

docs/guide_cog_creators.rst

@@ -0,0 +1,201 @@
+.. Cog Creator Applications
+
+.. role:: python(code)
+    :language: python
+
+================================
+Becoming an Approved Cog Creator
+================================
+
+This guide serves to explain the Cog Creator Application process and lays out the requirements to be a Cog Creator.
+
+----------------------------------
+Creating a Cog Creator Application
+----------------------------------
+
+.. note::
+  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.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.
+
+-----------------------------
+Requirements for Cog Creators
+-----------------------------
+
+The following is a list of the requirements for approved Cog Creators.
+QA uses this list to request changes for Cog Creator Applications.
+Handling these requirements before submitting your application can streamline the review process.
+Any Cog Creator that does not follow these requirements will have their repo removed from approved listings and may have their Cog Creator status revoked.
+
+- Readme that contains
+
+  - Repository name
+  - Installation instructions
+  - Extra setup instructions (if applicable)
+  - Credits (if applicable)
+
+- Repo-wide ``info.json`` file with the keys
+
+  - ``author``
+  - ``name``
+  - ``short``
+  - ``description``
+
+- Cog ``info.json`` files with the keys
+
+  - ``author``
+  - ``name``
+  - ``short``
+  - ``requirements`` (if applicable)
+  - ``description``
+
+  See `info-json-format` for more information on how to set up ``info.json`` files.
+
+- No cog contains malicious code.
+- No cog contains code that could impact the stability of the bot, such as blocking the event loop for an extended period of time, unreasonably high IO usage, etc.
+- No cog contains copied code that does not respect the license of the source.
+- Disclose in the ``install_msg`` key of the ``info.json`` file of each cog that contains any of the following:
+
+  - Heavy memory or I/O usage.
+  - Any NSFW material.
+  - Bundled data.
+  - Stored data (outside of using Config).
+  - Interactions with outside services.
+  - Any extra setup instructions required.
+
+- No cog breaks the Discord TOS.
+- No cog conflicts with any core cogs (e.g., causing a core cog to fail to load) unless it is intended to replace that cog.
+- Your repo shows an understanding of a range of common cog practices. This requirement exists to ensure QA can trust the safety and functionality of any future code you will create. This is handled on a case-by-case basis, however the following points should outline what we are looking to see:
+
+  - Cogs that are more than what is able to be run in a simple eval.
+  - Cogs that are more than just a simple API access request.
+  - Cogs that properly use Red utilities, including Config, checks, and any other utility functions.
+  - Cogs that use event listeners (bot.wait_for or cog-wide listeners) or custom tasks that are efficient and handle exceptions appropriately.
+  - Cogs that handle errors properly.
+  - Cogs that handle permissions properly.
+
+  *While we're looking for these things to qualify your code, you don't need to apply all of them in order to qualify.*
+
+- Any unusable or broken commands or cogs are hidden.
+- The default locale must be English.
+- The main cog class and every command must have a doc-string.
+- No cog allows for escalation of permissions. (e.g., sending a mass ping through the bot without having permission to do so)
+- Respect the role hierarchy. Don’t let a lower role have a way to grant a higher role.
+- If your cog install comes with any pre-packaged data, use `bundled_data_path()` to access it.
+- If your cog install creates any non-config data, use `cog_data_path()` to store it.
+- Unless the cog is intentionally designed to listen to certain input from bots, cogs should ignore input from bots.
+- Cogs use public methods of Red where possible.
+- Use the proper method if one exists. (and ask for one if it doesn't exist)
+
+  - If that's not possible, don't break anything in core or any other cog with your code.
+  - If you have to use private methods, lock the cog to specific Red versions you can guarantee it works on without breaking anything using the ``min_bot_version`` and ``max_bot_version`` keys in that cog's ``info.json`` file.
+
+- Cog Creators must keep their cogs up-to-date with core Red or be delisted until cogs meet Red API changes. Repositories must be kept up to date with the latest version of Red within 3 months of its release.
+
+.. _recommendations-for-cog-creators:
+
+--------------------------------
+Recommendations for Cog Creators
+--------------------------------
+
+The following is a list of recommendations for Cog Creators.
+While not required for approved Cog Creators, they are still recommended in order to ensure consistency between repos.
+
+- Cogs should follow a few naming conventions for consistency.
+
+  - Cog classes should be TitleCased, using alphabetic characters only.
+  - Commands should be lower case, using alphanumeric characters only.
+  - Cog modules should be lower case, using alphabetic characters only.
+
+- If your cog uses logging:
+
+  - The namespace for logging should be: ``red.your_repo_name.cog_name``.
+  - Print statements are not a substitute for proper logging.
+
+- If you use asyncio.create_task, your tasks should:
+
+  - Be cancelled on cog unload.
+  - Handle errors.
+
+- | Event listeners should exit early if it is an event you don't need.
+  | This makes your events less expensive in terms of CPU time. Examples below:
+
+  - Checking that you are in a guild before interacting with config for an antispam command.
+  - Checking that you aren't reacting to a bot message (``not message.author.bot``) early on.
+
+- Use .gitignore (or something else) to keep unwanted files out of your cog repo.
+- Put a license on your cog repo.
+
+  - By default, in most jurisdictions, without a license that at least offers the code for use,
+    users cannot legally use your code.
+
+- Use botwide features when they apply. Some examples of this:
+
+  - ``ctx.embed_color``
+  - ``bot.is_automod_immune``
+
+- Use checks to limit command use when the bot needs special permissions.
+- Check against user input before doing things. Common things to check:
+
+  - Resulting output is safe.
+  - Values provided make sense. (eg. no negative numbers for payday)
+  - Don't unsafely use user input for things like database input.
+
+- Check events against `bot.cog_disabled_in_guild() <RedBase.cog_disabled_in_guild()>`\
+
+  - Not all events need to be checked, only those that interact with a guild.
+  - Some discretion may apply, for example,
+    a cog which logs command invocation errors could choose to ignore this
+    but a cog which takes actions based on messages should not.
+
+- Respect settings when treating non-command messages as commands.
+- Handle user data responsibly
+
+  - Don't do unexpected things with user data.
+  - Don't expose user data to additional audiences without permission.
+  - Don't collect data your cogs don't need.
+  - | Don't store data in unexpected locations.
+    | Utilize the cog data path, Config, or if you need something more
+      prompt the owner to provide it.
+
+- Utilize the data deletion and statement APIs
+
+  - See `redbot.core.commands.Cog.red_delete_data_for_user()`
+  - | Make a statement about what data your cogs use with the module level
+      variable ``__red_end_user_data_statement__``.
+    | This should be a string containing a user friendly explanation of what data
+      your cog stores and why.
+
+- Set contextual locales in events and other background tasks that use i18n APIs
+
+  - See `redbot.core.i18n.set_contextual_locales_from_guild()`
+  - Usage of i18n APIs within commands automatically has proper contextual locales set.
+
+----------------------------
+Perks of being a Cog Creator
+----------------------------
+
+- Added to a growing, curated list of approved repositories hosted on the `Red Index <https://index.discord.red/>`__.
+- The Cog Creator role on the main Red Server and the Cog Support Server.
+- Access to an additional testing channel and the #advanced-coding channel on the main Red Server.
+- Write permission in the #v3-burndown channel on the main Red Server.
+- Access to an additional testing channel and the Cog Creators channel on the Support Server.
+- Alerted about breaking changes in Red before anyone else.
+- Ability to request a channel in the Cog Support Server if you feel like the traffic/question volume for your cogs warrants it.
+
+-------------
+Other Details
+-------------
+
+- Once a QA member has conducted a final review, you will have up to 14 days to make the necessary changes.
+- The reviewer of your application has the final word.
+- Hidden cogs will not be explicitly reviewed, however they are not allowed to contain malicious or ToS breaking code.
+- QA reserves the right to revoke these roles and all privileges if you are found to be in gross negligence, malicious intent, or reckless abandonment of your repository.
+- If a Cog Creator's repository is not maintained and kept up to date, that repo will be removed from the approved repo listings until such issues are addressed.
+- Only 1 person is allowed to be the Cog Creator for a particular repo. Multiple people are allowed to maintain the repo, however the "main" owner (and the Cog Creator) is responsible for any code on the repo.
+- The Cog Creator status for a repo can be transferred to another user if the Cog Creator requests it.
+- An approved Cog Creator can ask QA to add additional repos they have created to the approved pool.

docs/guide_publish_cogs.rst

@@ -55,6 +55,9 @@ Keys common to both repo and cog info.json (case sensitive)
 Keys specific to the cog info.json (case sensitive)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+- ``end_user_data_statement`` (string) - A statement explaining what end user data the cog is storing.
+  This is displayed when a user executes ``[p]cog info``. If the statement has changed since last update, user will be informed during the update.
+
 - ``min_bot_version`` (string) - Min version number of Red in the format ``MAJOR.MINOR.MICRO``
 
 - ``max_bot_version`` (string) - Max version number of Red in the format ``MAJOR.MINOR.MICRO``,
@@ -82,5 +85,13 @@ Keys specific to the cog info.json (case sensitive)
   ``SHARED_LIBRARY``. If ``SHARED_LIBRARY`` then ``hidden`` will be ``True``.
 
 .. warning::
-    Shared libraries are deprecated since version 3.2 and are marked for removal in version 3.4.
+    Shared libraries are deprecated since version 3.2 and are marked for removal in the future.
 
+Adding to the Index
+-------------------
+
+Repositories that are correctly configured can be added to the `public index of cogs <https://index.discord.red/>`_.
+
+To be added to the index, make a pull request to the `Red-Index repository <https://github.com/Cog-Creators/Red-Index>`_ in the unapproved section. You can learn more about this process in the repository description.
+
+To be added to the approved repositories, first see `guide_cog_creators`.

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:`here <trivia-command-triviaset-custom>` for more details.
+
+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

@@ -2,16 +2,42 @@
 
 .. _host-list:
 
-=============
-VPS providers
-=============
+===================
+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
-    if you don't know how to host Red on a VPS.
+    if you don't know how to host Red.
 
-This is a list of the recommended VPS providers.
+
+| For your instance of Red to stay online 24/7, it needs to be hosted on a dedicated system.
+  This page contains hosting related information and advice for beginners in 
+  topics such as picking a provider.
+
+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. 
+    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
+    support if an issue occurs when hosting on any of these platforms.
+
+
+------------------------------------
+Hosting on a VPS or Dedicated Server
+------------------------------------
+
+| You can host Red in a VPS running Linux or Windows. Using a Linux VPS is the
+  recommended option. Dedicated servers also work but are overpowered and cost 
+  ineffective unless one plans to run a very large bot or use their server for 
+  more than just hosting Red. If you have already created an instance, Red can be moved to a different 
+  server for hosting with a backup/restore process. More information and guidance
+  about this process is available in the `Red Support Server <https://discord.com/invite/red>`_.
 
 .. warning::
     Please be aware that a Linux server is controlled through a command line.
@@ -19,66 +45,106 @@ This is a list of the recommended VPS providers.
     <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
     from DigitalOcean which will introduce you to the Linux basics.
 
--------------
-Linux hosting
--------------
-
-+------------------------------------+------------------------------------------------------+
-|Link                                |Description                                           |
-+====================================+======================================================+
-|`Scaleway                           |Incredibly cheap but powerful VPSes, owned by         |
-|<https://www.scaleway.com/>`_       |`<https://online.net/>`_, based in Europe.            |
-+------------------------------------+------------------------------------------------------+
-|`DigitalOcean                       |US-based cheap VPSes. The gold standard. Locations    |
-|<https://www.digitalocean.com/>`_   |available world wide.                                 |
-+------------------------------------+------------------------------------------------------+
-|`OVH <https://www.ovh.co.uk/>`_     |Cheap VPSes, used by many people. French and Canadian |
-|                                    |locations available.                                  |
-+------------------------------------+------------------------------------------------------+
-|`Time4VPS                           |Cheap VPSes, seemingly based in Lithuania.            |
-|<https://www.time4vps.eu/>`_        |                                                      |
-+------------------------------------+------------------------------------------------------+
-|`Linode <https://www.linode.com/>`_ |More cheap VPSes!                                     |
-+------------------------------------+------------------------------------------------------+
-|`Vultr <https://www.vultr.com/>`_   |US-based, DigitalOcean-like.                          |
-+------------------------------------+------------------------------------------------------+
-
-------
-Others
-------
-
-+-------------------------------------+-----------------------------------------------------+
-|Link                                 |                                                     |
-+=====================================+=====================================================+
-|`AWS <https://aws.amazon.com/>`_     |Amazon Web Services. Free for a year (with certain   |
-|                                     |limits), but very pricey after that.                 |
-+-------------------------------------+-----------------------------------------------------+
-|`Google Cloud                        |Same as AWS, but it's Google.                        |
-|<https://cloud.google.com/compute/>`_|                                                     |
-+-------------------------------------+-----------------------------------------------------+
-|`Microsoft Azure                     |Same as AWS, but it's Microsoft.                     |
-|<https://azure.microsoft.com>`_      |                                                     |
-+-------------------------------------+-----------------------------------------------------+
-|`LowEndBox <http://lowendbox.com/>`_ |A curator for lower specced servers.                 |
-+-------------------------------------+-----------------------------------------------------+
 
 ------------
-Self-hosting
+Self Hosting
 ------------
 
-You can always self-host on your own hardware.
-A Raspberry Pi 3 will be more than sufficient for small to medium sized bots.
+| It's possible to self host Red with your own hardware. A Raspberry Pi 3 
+  will have enough computing capacity to handle a small to medium sized bot. 
+  You can also host on your own computer or rack server. Any modern hardware 
+  should work without issues. However, this option leaves you responsible for
+  keeping the bot online by paying for electricity costs and dealing with power outages.
 
-For bigger bots, you can build your own server PC for usage, or buy a rack
-server. Any modern hardware should work 100% fine.
+-------------------
+Choosing a Provider
+-------------------
+
+| The following are some common providers suitable for hosting Red. With
+  each having their pros and cons, this list is mainly intended to act as a
+  starting point. You should conduct your own research and come to
+  a conclusion depending on your needs and budget, taking into account
+  providers not listed here if desired. The key is the provider offering 
+  an OS supported by Red.
+
+.. tip::
+ You will have better results with Audio when the region in your Discord 
+ server settings is closer to the bulk of the server's audience and
+ the location you picked for your Red host.
+
+
+-----------------
+Average Providers
+-----------------
+
+| `Scaleway <https://www.scaleway.com/>`_ is a VPS and dedicated server
+ provider French in origin with locations in Poland and Netherlands.
+
+| `DigitalOcean <https://www.digitalocean.com/>`_ is a US based cloud services company 
+ with locations available worldwide, the VPS service is provided under the brand name
+ "Droplet".
+
+| `OVH <https://us.ovhcloud.com/vps/>`_ is a company focused on providing hosting
+ and cloud services with locations in Europe, North America and Asia Pacific.
+
+| `Time4VPS <https://www.time4vps.eu/>`_ is a Lithuanian VPS provider mainly focused
+ on lower cost.
+
+| `GalaxyGate <https://galaxygate.net/>`_ is a VPS and dedicated server provider
+ with a single location in New York.
+
+| `Linode <https://www.linode.com/>`_ is a US based cloud services company similar
+ to DigitalOcean with locations available worldwide.
+
+| `AWS Lightsail <https://aws.amazon.com/lightsail/>`_ is a VPS service from Amazon
+ Web Services priced lower than their enterprise offerings.
+
+| `Vultr <https://www.vultr.com/>`_ is a US based provider of VPS and dedicated servers
+ with locations available worldwide.
+
+| `Hetzner Online <https://www.hetzner.com/>`_ is a German VPS and dedicated server
+ provider with locations in Germany and Finland.
+
+| `Contabo <https://contabo.com/>`_ is also a German VPS and dedicated server provider
+ with locations in Germany 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.
+
+| `LowEndBox <http://lowendbox.com/>`_ is a website where hosting providers are
+ discussed and curated, often with lower costs and less known providers.
+
+--------------------
+Higher End Providers
+--------------------
+
+| `AWS EC2 <https://aws.amazon.com/ec2/>`__ is the enterprise offering of Amazon Web Services.
+ A limited free plan is available for 12 months, after which a complex pricing model with
+ high costs take over.
+
+| `Google Compute Engine <https://cloud.google.com/compute/>`__ is Google's EC2 competitor.
+ However, an always free plan with limited resources is offered.
+
+| `Microsoft Azure VM <https://azure.microsoft.com/services/virtual-machines/>`__ is
+ Microsoft's EC2 competitor with lower costs than EC2 for Windows instances, but similar
+ otherwise.
+
+| `Oracle Cloud Compute  <https://www.oracle.com/cloud/compute/>`__ is Oracle's EC2
+ competitor. But an always free plan is available with slightly higher specifications
+ compared to that of Google Compute Engine.
 
 ------------
-Free hosting
+Free Hosting
 ------------
 
-Google Cloud and AWS both have free tier VPS suitable for small bots.
-Additionally, new Google Cloud customers get a $300 credit which is valid
-for 12 months.
+| `Google Compute Engine <https://cloud.google.com/free/docs/gcp-free-tier>`_,
+  `Oracle Cloud Compute <https://oracle.com/cloud/free/#always-free>`_ and
+  `AWS EC2 <https://aws.amazon.com/free/>`_ have free tier VPSes suitable for small bots.
 
-Other than that... no. There is no good free VPS hoster, outside of
-persuading somebody to host for you, which is incredibly unlikely.
+| **Note:** The free tier offered by AWS for EC2 only lasts for 12 months, while
+ 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.
+
+| 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

@@ -14,9 +14,11 @@ Welcome to Red - Discord Bot's documentation!
 
     install_windows
     install_linux_mac
+    bot_application_guide
+    update_red
     about_venv
     autostart_systemd
-    autostart_pm2
+    autostart_mac
 
 .. toctree::
     :maxdepth: 2
@@ -24,12 +26,34 @@ Welcome to Red - Discord Bot's documentation!
 
     cog_customcom
     cog_permissions
+    guide_trivia_list_creation
 
 .. toctree::
     :maxdepth: 2
     :caption: User guides:
 
     getting_started
+    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::
     :maxdepth: 2
@@ -38,6 +62,7 @@ Welcome to Red - Discord Bot's documentation!
     guide_migration
     guide_cog_creation
     guide_publish_cogs
+    guide_cog_creators
     framework_apikeys
     framework_bank
     framework_bot
@@ -57,6 +82,7 @@ Welcome to Red - Discord Bot's documentation!
     :maxdepth: 2
     :caption: Changelogs:
 
+    changelog_3_4_0
     changelog_3_3_0
     release_notes_3_2_0
     changelog_3_2_0

docs/install_linux_mac.rst

@@ -17,13 +17,12 @@ 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.8.1 or greater; **Python 3.9 is currently not supported!**
  - Pip 18.1 or greater
  - Git 2.11+
- - Java Runtime Environment 11 or later (for audio support)
+ - 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.
+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.
 
 
 *****************
@@ -41,73 +40,59 @@ Operating systems
 Arch Linux
 ~~~~~~~~~~
 
-.. code-block:: none
+.. warning::
 
-    sudo pacman -Syu python python-pip git jre-openjdk-headless base-devel
+    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 7
-~~~~~~~~~~~~~~~~~
-
-.. code-block:: none
-
-    yum -y groupinstall development
-    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
-    sudo yum -y install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel \
-      openssl-devel xz xz-devel libffi-devel findutils git2u java-11-openjdk
-
-Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-centos8:
-.. _install-rhel8:
-
 ~~~~~~~~~~~~~~~~~
 CentOS and RHEL 8
 ~~~~~~~~~~~~~~~~~
 
-.. code-block:: none
+.. prompt:: bash
 
-    yum -y install epel-release
-    yum update -y
-    yum -y groupinstall development
-    yum -y install git zlib-devel bzip2 bzip2-devel readline-devel sqlite \
-     sqlite-devel openssl-devel xz xz-devel libffi-devel findutils java-11-openjdk
-     
-Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
-
-----
-
-.. _install-debian-stretch:
-
-~~~~~~~~~~~~~~
-Debian Stretch
-~~~~~~~~~~~~~~
-
-.. note::
-
-    This guide is only for Debian Stretch users, these instructions won't work with
-    Raspbian Stretch. Raspbian Buster is the only version of Raspbian supported by Red.
-
-We recommend installing pyenv as a method of installing non-native versions of python on
-Debian Stretch. This guide will tell you how. First, run the following commands:
-
-.. code-block:: none
-
-    sudo echo "deb http://deb.debian.org/debian stretch-backports main" >> /etc/apt/sources.list.d/red-sources.list
-    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
-    CXX=/usr/bin/g++
+    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>`.
 
@@ -123,12 +108,10 @@ 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:
 
-.. code-block:: none
+.. 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
+    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>`.
@@ -141,12 +124,12 @@ Complete the rest of the installation by `installing Python 3.8 with pyenv <inst
 Fedora Linux
 ~~~~~~~~~~~~
 
-Fedora Linux 30 and above has all required packages available in official repositories. Install
+Fedora Linux 32 and above has all required packages available in official repositories. Install
 them with dnf:
 
-.. code-block:: none
+.. prompt:: bash
 
-    sudo dnf -y install python38 git java-latest-openjdk-headless @development-tools
+    sudo dnf -y install python38 git java-11-openjdk-headless @development-tools nano
 
 Continue by `creating-venv-linux`.
 
@@ -161,20 +144,20 @@ Mac
 Install Brew: in Finder or Spotlight, search for and open *Terminal*. In the terminal, paste the
 following, then press Enter:
 
-.. code-block:: none
+.. 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:
 
-.. code-block:: none
+.. 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 cask install adoptopenjdk/openjdk/adoptopenjdk11
+    brew install --cask adoptopenjdk/openjdk/adoptopenjdk11
 
 Continue by `creating-venv-linux`.
 
@@ -186,37 +169,38 @@ Continue by `creating-venv-linux`.
 openSUSE
 ~~~~~~~~
 
-openSUSE Leap
-*************
+openSUSE Leap 15.2+
+*******************
 
-We recommend installing a community package to get Python 3.8 on openSUSE Leap. This package will
+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:
 
-.. code-block:: none
+.. prompt:: bash
 
     source /etc/os-release
-    sudo zypper ar -f https://download.opensuse.org/repositories/home:/Rotkraut:/Opt-Python/openSUSE_Leap_${VERSION_ID}/ Opt-Python
+    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:
 
-.. code-block:: none
+.. prompt:: bash
 
-    sudo zypper install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless
-    sudo zypper install -t pattern devel_basis
+    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:
 
-.. code-block:: none
+.. 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:
 
-.. code-block:: none
+.. prompt:: bash
 
     sudo /opt/python/bin/easy_install-3.8 pip
 
@@ -228,10 +212,40 @@ openSUSE Tumbleweed
 openSUSE Tumbleweed has all required dependencies available in official repositories. Install them
 with zypper:
 
-.. code-block:: none
+.. prompt:: bash
 
-    sudo zypper install python3-base python3-pip git-core java-12-openjdk-headless
-    sudo zypper install -t pattern devel_basis
+    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`.
 
@@ -239,30 +253,23 @@ Continue by `creating-venv-linux`.
 
 .. _install-ubuntu:
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Ubuntu LTS versions (18.04 and 16.04)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
+Ubuntu 20.04 LTS
+~~~~~~~~~~~~~~~~
 
 We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
 
-.. code-block:: none
+.. prompt:: bash
 
     sudo apt update
     sudo apt -y install software-properties-common
-    sudo add-apt-repository -yu ppa:git-core/ppa
-
-We recommend adding the ``deadsnakes`` ppa to install Python 3.8.1 or greater:
-
-.. code-block:: none
-
-    sudo add-apt-repository -yu ppa:deadsnakes/ppa
+    sudo add-apt-repository -y ppa:git-core/ppa
 
 Now install the pre-requirements with apt:
 
-.. code-block:: none
+.. prompt:: bash
 
-    sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git default-jre-headless \
-      build-essential
+    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`.
 
@@ -276,7 +283,7 @@ Ubuntu non-LTS versions
 
 We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
 
-.. code-block:: none
+.. prompt:: bash
 
     sudo apt update
     sudo apt -y install software-properties-common
@@ -285,11 +292,9 @@ We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
 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:
 
-.. code-block:: none
+.. 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
+    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>`.
@@ -311,18 +316,18 @@ On distributions where Python 3.8 needs to be compiled from source, we recommend
 This simplifies the compilation process and has the added bonus of simplifying setting up Red in a
 virtual environment.
 
-.. code-block:: none
+.. prompt:: bash
 
-    curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | 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.
+**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:
 
-.. code-block:: none
+.. prompt:: bash
 
-    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.1 -v
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.10 -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
@@ -332,9 +337,9 @@ slower.
 
 After that is finished, run:
 
-.. code-block:: none
+.. prompt:: bash
 
-    pyenv global 3.8.1
+    pyenv global 3.8.10
 
 Pyenv is now installed and your system should be configured to run Python 3.8.
 
@@ -372,11 +377,15 @@ First, choose a directory where you would like to create your virtual environmen
 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::
+Create your virtual environment with the following command:
+
+.. prompt:: bash
 
     python3.8 -m venv ~/redenv
 
-And activate it with the following command::
+And activate it with the following command:
+
+.. prompt:: bash
 
     source ~/redenv/bin/activate
 
@@ -398,18 +407,24 @@ 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::
+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::
+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::
+Now activate your virtualenv with the following command:
+
+.. prompt:: bash
 
     pyenv shell <name>
 
@@ -433,17 +448,19 @@ Choose one of the following commands to install Red.
 
 To install without additional config backend support:
 
-.. code-block:: none
+.. 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:
 
-.. code-block:: none
+.. prompt:: bash
+    :prompts: (redenv) $
 
     python -m pip install -U pip setuptools wheel
-    python -m pip install -U Red-DiscordBot[postgres]
+    python -m pip install -U "Red-DiscordBot[postgres]"
 
 
 .. note::
@@ -456,7 +473,8 @@ Setting Up and Running Red
 
 After installation, set up your instance with the following command:
 
-.. code-block:: none
+.. prompt:: bash
+    :prompts: (redenv) $
 
     redbot-setup
 
@@ -466,14 +484,14 @@ running the bot).
 
 Once done setting up the instance, run the following command to run Red:
 
-.. code-block:: none
+.. 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
-:dpy_docs:`this guide <discord.html#creating-a-bot-account>`,
-section "Creating a Bot Account".
+`this guide <bot_application_guide>`.
 
 .. tip::
    If it's the first time you're using Red, you should check our `getting-started` guide

docs/install_windows.rst

@@ -4,41 +4,55 @@
 Installing Red on Windows
 =========================
 
----------------
-Needed Software
----------------
+-------------------------------
+Installing the pre-requirements
+-------------------------------
 
-The following software dependencies can all be installed quickly and easily through PowerShell,
-using a trusted package manager for Windows called `Chocolatey <https://chocolatey.org>`_
+Please install the pre-requirements by following instructions from one of the following subsections.
 
-We also provide instructions for manually installing all of the dependencies.
+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)
 
-******************************************
-Installing using powershell and chocolatey
-******************************************
+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:
+
+----
+
+*********************************************
+Using PowerShell and Chocolatey (recommended)
+*********************************************
 
 To install via PowerShell, search "powershell" in the Windows start menu,
-right-click on it and then click "Run as administrator"
+right-click on it and then click "Run as administrator".
 
 Then run each of the following commands:
 
-.. code-block:: none
+.. prompt:: powershell
 
     Set-ExecutionPolicy Bypass -Scope Process -Force
+    [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
+    choco upgrade python3 -y --version 3.8.10
 
 For Audio support, you should also run the following command before exiting:
 
-.. code-block:: none
+.. prompt:: powershell
 
     choco upgrade adoptopenjdk11jre -y
 
 
 From here, exit the prompt then continue onto `creating-venv-windows`.
 
+----
+
 ********************************
 Manually installing dependencies
 ********************************
@@ -50,17 +64,20 @@ Manually installing dependencies
 
 * `MSVC Build tools <https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2019>`_
 
-* `Python <https://www.python.org/downloads/>`_ - Red needs Python 3.8.1 or greater
+* `Python 3.8.1 or greater <https://www.python.org/downloads/>`_; **Python 3.9 is currently not supported!**
 
 .. 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.
 
-* `Git <https://git-scm.com/download/win>`_
+* `Git 2.11+ <https://git-scm.com/download/win>`_
 
 .. attention:: Please choose the option to "Git from the command line and also from 3rd-party software" in Git's setup.
 
-* `Java <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>`_ - needed for Audio
+* `Java 11 <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>`_ - needed for Audio
 
+From here, continue onto `creating-venv-windows`.
+
+----
 
 .. _creating-venv-windows:
 
@@ -70,7 +87,7 @@ Creating a Virtual Environment
 
 .. tip::
 
-    If you want to learn more about virtual environments, see page: `about-venvs`
+    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.
@@ -79,17 +96,26 @@ First, choose a directory where you would like to create your virtual environmen
 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.
 
-Start with opening a command prompt (open Start, search for "command prompt", then click it)
+Start with opening a command prompt (open Start, search for "command prompt", then click it).
+
+.. note:: 
+
+    You shouldn't run command prompt as administrator when creating your virtual environment, or
+    running Red.
 
 .. warning::
 
     These commands will not work in PowerShell - you have to use command prompt as said above.
 
-Then create your virtual environment with the following command::
+Then create your virtual environment with the following command
+
+.. prompt:: batch
 
     py -3.8 -m venv "%userprofile%\redenv"
 
-And activate it with the following command::
+And activate it with the following command
+
+.. prompt:: batch
 
     "%userprofile%\redenv\Scripts\activate.bat"
 
@@ -112,30 +138,28 @@ Run **one** of the following set of commands, depending on what extras you want
 
   * Normal installation:
 
-    .. code-block:: none
+    .. prompt:: batch
+        :prompts: (redenv) C:\\>
 
         python -m pip install -U pip setuptools wheel
         python -m pip install -U Red-DiscordBot
 
   * With PostgreSQL support:
 
-    .. code-block:: none
+    .. prompt:: batch
+        :prompts: (redenv) C:\\>
 
         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:
 
-.. code-block:: none
+.. prompt:: batch
+    :prompts: (redenv) C:\\>
 
     redbot-setup
 
@@ -145,14 +169,14 @@ running the bot).
 
 Once done setting up the instance, run the following command to run Red:
 
-.. code-block:: none
+.. prompt:: batch
+    :prompts: (redenv) C:\\>
 
     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
-:dpy_docs:`this guide <discord.html#creating-a-bot-account>`,
-section "Creating a Bot Account".
+`this guide <bot_application_guide>`.
 
 .. tip::
    If it's the first time you're using Red, you should check our `getting-started` guide

docs/prolog.txt

@@ -22,20 +22,33 @@
 
 .. This is for describing how a format should be formatted
 
-.. |quotes| replace:: enclosed in quotes if there are spaces
-
 .. |role-input| replace:: Please give **the exact role name or ID**, or it won't be detected.
+
+.. |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 (|quotes|).
+.. |member-input| replace:: You can either mention the member, provide their ID, their exact name with
+    the tag or not, or their nickname.
 
-.. |user-input| replace:: You can either provide the member's ID or its exact name with the tag or
-    not (|quotes|).
+.. |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 their exact name with the tag or
+    not.
+
+.. |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.
 
-.. |vc-input| replace:: You can either provide the voice channel's ID or its exact name, |quotes|.
+.. |vc-input| replace:: You can either provide the voice channel's ID or its exact name.
+
+.. |vc-input-quotes| replace:: You can either provide the voice channel's ID or its exact name,
+    enclosed in quotes if there are spaces.
 
 .. |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/red_core_data_statement.rst

@@ -0,0 +1,87 @@
+.. Red Core Data Statement
+
+=====================
+Red and End User Data
+=====================
+
+Notes for everyone
+******************
+
+What data Red collects
+----------------------
+
+Red and the cogs included with it collect some amount of data
+about users for the bot's normal operations. 
+
+The bot will keep track of a short history of usernames/nicknames. It will also
+remember which actions were taken using your Discord account (such as creating a playlist)
+as well as the content of specific messages used directly as commands for the bot
+(such as reports sent to servers).
+
+By default, Red will not collect any more data than it needs, and will not use it
+for anything other than the portion of the Red's functionality that necessitated it.
+
+3rd party extensions may store additional data beyond what Red does by default.
+You can use the command ``[p]mydata 3rdparty``
+to view statements about how extensions use your data made by the authors of 
+the specific 3rd party extensions an instance of Red has installed.
+
+How can I delete data Red has about me?
+---------------------------------------
+
+The command ``[p]mydata forgetme`` provides a way for users to remove
+large portions of their own data from the bot. This command will not
+remove operational data, such as a record that your
+Discord account was the target of a moderation action.
+
+3rd party extensions to Red are able to delete data when this command
+is used as well, but this is something each extension must implement.
+If a loaded extension does not implement this, the user will be informed.
+
+Additional Notes for Bot Owners and Hosts
+*****************************************
+
+How to comply with a request from Discord Trust & Safety
+--------------------------------------------------------
+
+There are a handful of these available to bot owners in the command group
+``[p]mydata ownermanagement``.
+
+The most pertinent one if asked to delete data by a member of Trust & Safety
+is
+
+``[p]mydata ownermanagement processdiscordrequest`` 
+
+This will cause the bot to get rid of or disassociate all data
+from the specified user ID. 
+
+.. warning::
+
+    You should not use this unless
+    Discord has specifically requested this with regard to a deleted user.
+    This will remove the user from various anti-abuse measures.
+    If you are processing a manual request from a user, read the next section
+
+
+How to process deletion requests from users
+-------------------------------------------
+
+You can point users to the command ``[p]mydata forgetme`` as a first step.
+
+If users cannot use that for some reason, the command
+
+``[p]mydata ownermanagement deleteforuser``
+
+exists as a way to handle this as if the user had done it themselves.
+
+Be careful about using the other owner level deletion options on behalf of users,
+as this may also result in losing operational data such as data used to prevent spam.
+
+What owners and hosts are responsible for
+-----------------------------------------
+
+Owners and hosts must comply both with Discord's terms of service and any applicable laws.
+Owners and hosts are responsible for all actions their bot takes.
+
+We cannot give specific guidance on this, but recommend that if there are any issues
+you be forthright with users, own up to any mistakes, and do your best to handle it.

docs/requirements.txt

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

docs/update_red.rst

@@ -0,0 +1,147 @@
+============
+Updating Red
+============
+
+Updating to the latest version of Red has several benefits:
+
+- New features and improvements are added.
+- Bugs are fixed.
+- Your bot is safe from security vulnerabilities that have been found.
+
+Here are some things to consider to help make your upgrade as smooth as possible.
+
+.. note::
+
+    If you're developing for Red, you should also look for "Breaking changes" sections in release notes for each minor (X.Y.0) version that's been released since you last updated Red.
+
+.. important::
+
+    Make sure to read the **Read before updating** sections of the changelogs for all releases that were published since you last updated your instance. They contain important information and if you don't read them, you might run into some issues later.
+
+Updating differs depending on the version you currently have. Next sections will explain how to upgrade to latest version of Red (|version|) from the version that is in the header of the section.
+
+.. contents:: Choose the version you're currently on from the list below:
+    :local:
+    :depth: 1
+
+
+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:
+
+1. Shut your bot down.
+
+2. Activate your venv with the following command:
+
+    .. prompt:: batch
+
+        "%userprofile%\redenv\Scripts\activate.bat"
+
+3. Update Red with this command:
+
+    .. prompt:: batch
+        :prompts: (redenv) C:\\>
+
+        python -m pip install -U Red-DiscordBot
+
+.. attention::
+
+    If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
+
+4. Start your bot.
+
+5. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
+
+Linux & Mac
+-----------
+
+If you have Red 3.2.0 or newer, you can upgrade by following these 4 easy steps:
+
+1. Shut your bot down.
+
+2. Activate your virtual environment.
+  
+    If you used ``venv`` for your virtual environment, use:
+
+    .. prompt:: bash
+
+        source ~/redenv/bin/activate
+
+    If you used ``pyenv`` for your virtual environment, use:
+
+    .. prompt:: bash
+
+        pyenv shell <name>
+
+3. Update Red with this command:
+
+    .. prompt:: bash
+        :prompts: (redenv) $
+
+        python -m pip install -U Red-DiscordBot
+
+.. attention::
+
+    If you're using PostgreSQL data backend, replace ``Red-DiscordBot`` in the second command with ``Red-DiscordBot[postgres]``
+
+4. Start your bot.
+
+5. If you have any 3rd-party cogs installed, we highly recommend you update them with this command in Discord: ``[p]cog update`` (``[p]`` is considered as your prefix)
+
+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.
+
+**If you already have Red installed in a virtual environment, you will need to delete it before starting this process.**
+
+.. attention::
+
+    Red 3.2 dropped support for the MongoDB driver
+
+     - If you were not using the MongoDB driver, this does not affect you.
+     - If you were using a 3rd party cog which required MongoDB, it probably still does.
+     - If you were using the MongoDB driver, **prior to launching your instance after update**,
+       you will need to run the following commands to convert:
+
+         .. prompt:: bash
+           :prompts: (redenv) $
+
+           python -m pip install dnspython~=1.16.0 motor~=2.0.0 pymongo~=3.8.0
+           redbot-setup convert [instancename] json
+
+
+Red 3.0.2 and older
+*******************
+
+.. important::
+
+    Red 3.2 dropped support for the MongoDB driver
+
+     - If you were not using the MongoDB driver, this does not affect you.
+     - If you were using a 3rd party cog which required MongoDB, it probably still does.
+     - If you were using the MongoDB driver, **prior to updating**, you will need to convert your data to JSON backend,
+       using following command:
+
+         .. prompt:: bash
+           :prompts: (redenv) $
+
+           redbot-setup --edit
+
+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.
+
+**If you already have Red installed in a virtual environment, you will need to delete it before starting this process.**

docs/version_guarantees.rst

@@ -17,9 +17,16 @@ Guarantees
 Anything in the ``redbot.core`` module or any of its submodules 
 which is not private (even if not documented) should not break without notice.
 
-Anything in the ``redbot.cogs`` module or any of it's submodules is specifically
+Anything in the ``redbot.cogs`` and ``redbot.vendored`` modules or any of their submodules is specifically
 excluded from being guaranteed.
 
+Method names and names of attributes of classes, functions, extensions, and modules
+provided by or provided to the bot should not begin with 
+``red_`` or be of the form ``__red_*__`` except as documented.
+This allows us to add certain optional features non-breakingly without a name conflict.
+
+Any RPC method exposed by Red may break without notice.
+
 If you would like something in here to be guaranteed,
 open an issue making a case for it to be moved.
 

make.bat

@@ -2,37 +2,38 @@
 
 if [%1] == [] goto help
 
-REM This allows us to expand variables at execution
-setlocal ENABLEDELAYEDEXPANSION
-
-REM This will set PYFILES as a list of tracked .py files
-set PYFILES=
-for /F "tokens=* USEBACKQ" %%A in (`git ls-files "*.py"`) do (
-    set PYFILES=!PYFILES! %%A
+if exist "%~dp0.venv\" (
+    set "VENV_PYTHON=%~dp0.venv\Scripts\python"
+) else (
+    set VENV_PYTHON=python
 )
 
 goto %1
 
 :reformat
-black !PYFILES!
-exit /B %ERRORLEVEL%
+"%VENV_PYTHON%" -m black "%~dp0."
+goto:eof
 
 :stylecheck
-black --check !PYFILES!
-exit /B %ERRORLEVEL%
+"%VENV_PYTHON%" -m black --check "%~dp0."
+goto:eof
 
 :stylediff
-black --check --diff !PYFILES!
-exit /B %ERRORLEVEL%
+"%VENV_PYTHON%" -m black --check --diff "%~dp0."
+goto:eof
 
 :newenv
 py -3.8 -m venv --clear .venv
-.\.venv\Scripts\python -m pip install -U pip setuptools
+"%~dp0.venv\Scripts\python" -m pip install -U pip setuptools wheel
 goto syncenv
 
 :syncenv
-.\.venv\Scripts\python -m pip install -Ur .\tools\dev-requirements.txt
-exit /B %ERRORLEVEL%
+"%~dp0.venv\Scripts\python" -m pip install -Ur .\tools\dev-requirements.txt
+goto:eof
+
+:activateenv
+CALL "%~dp0.venv\Scripts\activate.bat"
+goto:eof
 
 :help
 echo Usage:
@@ -41,6 +42,9 @@ echo.
 echo Commands:
 echo   reformat                   Reformat all .py files being tracked by git.
 echo   stylecheck                 Check which tracked .py files need reformatting.
+echo   stylediff                  Show the post-reformat diff of the tracked .py files
+echo                              without modifying them.
 echo   newenv                     Create or replace this project's virtual environment.
 echo   syncenv                    Sync this project's virtual environment to Red's latest
 echo                              dependencies.
+echo   activateenv                Activates project's virtual environment.