Version bump to 3.4.7 (#4856)

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

.bandit.yml

@@ -0,0 +1,396 @@
+
+### Bandit config file generated
+
+### This config may optionally select a subset of tests to run or skip by
+### filling out the 'tests' and 'skips' lists given below. If no tests are
+### specified for inclusion then it is assumed all tests are desired. The skips
+### set will remove specific tests from the include set. This can be controlled
+### using the -t/-s CLI options. Note that the same test ID should not appear
+### in both 'tests' and 'skips', this would be nonsensical and is detected by
+### Bandit at runtime.
+
+# Available tests:
+# B101 : assert_used
+# B102 : exec_used
+# B103 : set_bad_file_permissions
+# B104 : hardcoded_bind_all_interfaces
+# B105 : hardcoded_password_string
+# B106 : hardcoded_password_funcarg
+# B107 : hardcoded_password_default
+# B108 : hardcoded_tmp_directory
+# B110 : try_except_pass
+# B112 : try_except_continue
+# B201 : flask_debug_true
+# B301 : pickle
+# B302 : marshal
+# B303 : md5
+# B304 : ciphers
+# B305 : cipher_modes
+# B306 : mktemp_q
+# B307 : eval
+# B308 : mark_safe
+# B309 : httpsconnection
+# B310 : urllib_urlopen
+# B311 : random
+# B312 : telnetlib
+# B313 : xml_bad_cElementTree
+# B314 : xml_bad_ElementTree
+# B315 : xml_bad_expatreader
+# B316 : xml_bad_expatbuilder
+# B317 : xml_bad_sax
+# B318 : xml_bad_minidom
+# B319 : xml_bad_pulldom
+# B320 : xml_bad_etree
+# B321 : ftplib
+# B322 : input
+# B323 : unverified_context
+# B324 : hashlib_new_insecure_functions
+# B325 : tempnam
+# B401 : import_telnetlib
+# B402 : import_ftplib
+# B403 : import_pickle
+# B404 : import_subprocess
+# B405 : import_xml_etree
+# B406 : import_xml_sax
+# B407 : import_xml_expat
+# B408 : import_xml_minidom
+# B409 : import_xml_pulldom
+# B410 : import_lxml
+# B411 : import_xmlrpclib
+# B412 : import_httpoxy
+# B413 : import_pycrypto
+# B501 : request_with_no_cert_validation
+# B502 : ssl_with_bad_version
+# B503 : ssl_with_bad_defaults
+# B504 : ssl_with_no_version
+# B505 : weak_cryptographic_key
+# B506 : yaml_load
+# B507 : ssh_no_host_key_verification
+# B601 : paramiko_calls
+# B602 : subprocess_popen_with_shell_equals_true
+# B603 : subprocess_without_shell_equals_true
+# B604 : any_other_function_with_shell_equals_true
+# B605 : start_process_with_a_shell
+# B606 : start_process_with_no_shell
+# B607 : start_process_with_partial_path
+# B608 : hardcoded_sql_expressions
+# B609 : linux_commands_wildcard_injection
+# B610 : django_extra_used
+# B611 : django_rawsql_used
+# B701 : jinja2_autoescape_false
+# B702 : use_of_mako_templates
+# B703 : django_mark_safe
+
+# (optional) list included test IDs here, eg '[B101, B406]':
+tests:
+
+# (optional) list skipped test IDs here, eg '[B101, B406]':
+skips:  ['B322']
+
+### (optional) plugin settings - some test plugins require configuration data
+### that may be given here, per-plugin. All bandit test plugins have a built in
+### set of sensible defaults and these will be used if no configuration is
+### provided. It is not necessary to provide settings for every (or any) plugin
+### if the defaults are acceptable.
+
+any_other_function_with_shell_equals_true:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+hardcoded_tmp_directory:
+  tmp_dirs:
+  - /tmp
+  - /var/tmp
+  - /dev/shm
+linux_commands_wildcard_injection:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+ssl_with_bad_defaults:
+  bad_protocol_versions:
+  - PROTOCOL_SSLv2
+  - SSLv2_METHOD
+  - SSLv23_METHOD
+  - PROTOCOL_SSLv3
+  - PROTOCOL_TLSv1
+  - SSLv3_METHOD
+  - TLSv1_METHOD
+ssl_with_bad_version:
+  bad_protocol_versions:
+  - PROTOCOL_SSLv2
+  - SSLv2_METHOD
+  - SSLv23_METHOD
+  - PROTOCOL_SSLv3
+  - PROTOCOL_TLSv1
+  - SSLv3_METHOD
+  - TLSv1_METHOD
+start_process_with_a_shell:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+start_process_with_no_shell:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+start_process_with_partial_path:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+subprocess_popen_with_shell_equals_true:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+subprocess_without_shell_equals_true:
+  no_shell:
+  - os.execl
+  - os.execle
+  - os.execlp
+  - os.execlpe
+  - os.execv
+  - os.execve
+  - os.execvp
+  - os.execvpe
+  - os.spawnl
+  - os.spawnle
+  - os.spawnlp
+  - os.spawnlpe
+  - os.spawnv
+  - os.spawnve
+  - os.spawnvp
+  - os.spawnvpe
+  - os.startfile
+  shell:
+  - os.system
+  - os.popen
+  - os.popen2
+  - os.popen3
+  - os.popen4
+  - popen2.popen2
+  - popen2.popen3
+  - popen2.popen4
+  - popen2.Popen3
+  - popen2.Popen4
+  - commands.getoutput
+  - commands.getstatusoutput
+  subprocess:
+  - subprocess.Popen
+  - subprocess.call
+  - subprocess.check_call
+  - subprocess.check_output
+  - subprocess.run
+try_except_continue:
+  check_typed_exception: false
+try_except_pass:
+  check_typed_exception: false
+weak_cryptographic_key:
+  weak_key_size_dsa_high: 1024
+  weak_key_size_dsa_medium: 2048
+  weak_key_size_ec_high: 160
+  weak_key_size_ec_medium: 224
+  weak_key_size_rsa_high: 1024
+  weak_key_size_rsa_medium: 2048
+

.codeclimate.yml

@@ -0,0 +1,52 @@
+version: "2"  # required to adjust maintainability checks
+checks:
+  argument-count:
+    config:
+      threshold: 8  # work on this later
+  complex-logic:
+    enabled: false  # Disabled in favor of using Radon for this
+    config:
+      threshold: 4
+  file-lines:
+    enabled: false  # enable after audio stuff...
+    config:
+      threshold: 2000  # I would set this lower if not for cogs as command containers.
+  method-complexity:
+    enabled: false  # Disabled in favor of using Radon for this
+    config:
+      threshold: 5
+  method-count:
+    enabled: false  # I would set this lower if not for cogs as command containers.
+    config:
+      threshold: 20
+  method-lines:
+    enabled: false
+    config:
+      threshold: 25  # I'm fine with long methods, cautious about the complexity of a single method.
+  nested-control-flow:
+    config:
+      threshold: 6
+  return-statements:
+    config:
+      threshold: 6
+  similar-code:
+    enabled: false
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+  identical-code:
+    enabled: false
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+plugins:
+  bandit:
+    enabled: false
+  radon: 
+    enabled: false
+    config: 
+      threshold: "D"
+  duplication:
+    enabled: false
+    config:
+      languages:
+        python:
+          python_version: 3

.gitattributes

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

.github/CODEOWNERS

@@ -1,60 +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
-
 # Cogs
-redbot/cogs/admin/*                 @tekulvw
-redbot/cogs/alias/*                 @tekulvw
-redbot/cogs/audio/*                 @aikaterna
-redbot/cogs/bank/*                  @tekulvw
-redbot/cogs/cleanup/*               @palmtree5
-redbot/cogs/customcom/*             @palmtree5
-redbot/cogs/downloader/*            @tekulvw
-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 @Drapersniper
+/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
 
-# Setup, instance setup, and running the bot
-setup.py                            @tekulvw
-redbot/__init__.py                  @tekulvw
-redbot/__main__.py                  @tekulvw
-redbot/setup.py                     @tekulvw
+# Tests
+/redbot/pytest/downloader* @jack1142
+/tests/cogs/downloader/* @jack1142
 
-# Others
-.travis.yml                         @Kowlin
-crowdin.yml                         @Kowlin
+# Schemas
+/schema/* @jack1142
+
+# CI
+/.travis.yml @Kowlin
+/crowdin.yml @Kowlin
+/.github/workflows/* @Kowlin
+
+# Excludes
+**/locales/* @ghost

.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,31 +0,0 @@
----
-name: Bug reports for commands
-about: For bugs that involve commands found within Red
-
----
-
-# 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/command_bug.yml

@@ -0,0 +1,78 @@
+name: Bug reports for commands
+about: For bugs that involve commands found within Red.
+title: ''
+labels: 'Type: Bug'
+assignees: ''
+issue_body: true
+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
+  attributes:
+    label: "What Red version are you using?"
+    placeholder: 3.4.5
+  validations:
+    required: true
+- type: dropdown
+  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
+  attributes:
+    label: "Command name"
+    description: "What is the command that caused the error?"
+    placeholder: "play"
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "What did you expect to happen?"
+  validations:
+    required: true
+- type: textarea
+  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
+  attributes:
+    label: "How can we reproduce this error?"
+    description: "List of steps required to reproduce this error."
+    value: |
+      1.
+      2.
+      3.
+      ...
+  validations:
+    required: true

.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/enhancements.yml

@@ -0,0 +1,25 @@
+name: Enhancement proposal
+about: For feature requests and improvements related to already existing functionality.
+title: ''
+labels: 'Type: Enhancement'
+assignees: ''
+issue_body: true
+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
+  attributes:
+    label: "What component of Red (cog, command, API) would you like to see improvements on?"
+    placeholder: Audio
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "Describe the enhancement you're suggesting."
+    description: |
+      Feel free to describe in as much detail as you wish.
+  validations:
+    required: true

.github/ISSUE_TEMPLATE/feature_req.md

@@ -1,41 +0,0 @@
----
-name: Feature request
-about: For feature requests regarding Red itself.
-
----
-
-# 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/feature_request.yml

@@ -0,0 +1,48 @@
+name: Feature request
+about: For feature requests regarding Red itself.
+title: ''
+labels: 'Type: Feature'
+assignees: ''
+issue_body: true
+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
+  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
+  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
+

.github/ISSUE_TEMPLATE/other_bug.md

@@ -1,27 +0,0 @@
----
-name: Bug report
-about: For bugs that don't involve a command.
-
----
-
-# 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/ISSUE_TEMPLATE/other_bugs.yml

@@ -0,0 +1,47 @@
+name: Bug report
+about: "For bugs that don't involve a command."
+title: ''
+labels: 'Type: Bug'
+assignees: ''
+issue_body: true
+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
+  attributes:
+    label: "What Red version are you using?"
+    placeholder: 3.4.5
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "What were you trying to do?"
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "What did you expect to happen?"
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "What actually happened?"
+    description:  |
+      If the issue is visual in nature, consider posting a screenshot.
+  validations:
+    required: true
+- type: textarea
+  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

.github/labeler.yml

@@ -0,0 +1,95 @@
+"Category: Admin":
+  - redbot/cogs/admin/*
+"Category: Alias":
+  - redbot/cogs/alias/*
+"Category: Audio Cog":
+  - any:
+      - redbot/cogs/audio/**/*
+    all:
+      - "!redbot/cogs/audio/**/locales/*"
+"Category: Bank API":
+  - redbot/core/bank.py
+"Category: Bank Cog":
+  - redbot/cogs/bank/*
+"Category: Bot Core":
+  - 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
+"Category: CI":
+  - .github/workflows/*
+"Category: Cleanup Cog":
+  - redbot/cogs/cleanup/*
+"Category: Command Module":
+  - any:
+      - redbot/core/commands/*
+    all:
+      - "!redbot/core/commands/help.py"
+"Category: Config":
+  - redbot/core/drivers/*
+  - redbot/core/config.py
+"Category: CustomCom":
+  - redbot/cogs/customcom/*
+"Category: Dev Cog":
+  - redbot/core/dev_commands.py
+"Category: Docs":
+  - docs/**/*
+"Category: Downloader":
+  - redbot/cogs/downloader/*
+"Category: Economy Cog":
+  - redbot/cogs/economy/*
+"Category: Filter":
+  - redbot/cogs/filter/*
+"Category: General Cog":
+  - redbot/cogs/general/*
+"Category: Help":
+  - redbot/core/commands/help.py
+"Category: i18n":
+  - redbot/core/i18n.py
+  - redbot/**/locales/*
+"Category: Image":
+  - redbot/cogs/image/*
+"Category: Meta":
+  - ./*
+  - .github/*
+  - .github/ISSUE_TEMPLATE/*
+  - .github/PULL_REQUEST_TEMPLATE/*
+  - schema/*
+  - tools/*
+"Category: Mod Cog":
+  - redbot/cogs/mod/*
+"Category: Modlog API":
+  - redbot/core/generic_casetypes.py
+  - redbot/core/modlog.py
+"Category: Modlog Cog":
+  - redbot/cogs/modlog/*
+"Category: Mutes Cog":
+  - redbot/cogs/mutes/*
+"Category: Permissions":
+  - redbot/cogs/permissions/*
+"Category: Reports Cog":
+  - redbot/cogs/reports/*
+"Category: RPC/ZMQ API":
+  - redbot/core/rpc.py
+"Category: Streams":
+  - redbot/cogs/streams/*
+"Category: Tests":
+  - redbot/pytest/*
+  - tests/**/*
+"Category: Trivia Cog":
+  - redbot/cogs/trivia/*
+"Category: Trivia Lists":
+  - redbot/cogs/trivia/data/lists/*
+"Category: Utility Functions":
+  - redbot/core/utils/*
+"Category: Warnings":
+  - redbot/cogs/warnings/*

.github/workflows/auto_labeler_issues.yml

@@ -0,0 +1,26 @@
+name: Auto Labeler - Issues
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply Triage Label
+        uses: actions/github-script@v3
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const is_status_label = (label) => label.name.startsWith('Status: ');
+            if (context.payload.issue.labels.some(is_status_label)) {
+                console.log('Issue already has Status label, skipping...');
+                return;
+            }
+            github.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: ['Status: Needs Triage']
+            });

.github/workflows/auto_labeler_pr.yml

@@ -0,0 +1,13 @@
+name: Auto Labeler - PRs
+on:
+  pull_request_target:
+
+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,55 @@
+name: "CodeQL"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 14 * * 4'
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    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

@@ -0,0 +1,26 @@
+name: Lint Python
+on:
+  pull_request:
+  push:
+  repository_dispatch:
+    types:
+      - dispatched_test
+
+env:
+  ref: ${{ github.event.client_payload.ref || '' }}
+
+jobs:
+  lint_python:
+    name: Lint Python
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ env.ref }}
+      - uses: actions/setup-python@v2
+        with:
+          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"
+        name: Flake8 Linting

.github/workflows/prepare_release.yml

@@ -0,0 +1,108 @@
+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'
+
+jobs:
+  crowdin_download_translations:
+    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.
+            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>
+
+      - 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
+    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 }}
+
+      - 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.
+            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>
+
+      - 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_release.yml

@@ -0,0 +1,67 @@
+name: Publish the release
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release_to_pypi:
+    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: |
+          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/*
+
+  pr_dev_bump:
+    needs: release_to_pypi
+    runs-on: ubuntu-latest
+    steps:
+      # 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'
+
+      - 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>
+
+      - 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,45 @@
+import os
+import re
+import sys
+from typing import Match
+
+import redbot
+
+
+version_info = None
+
+
+def repl(match: Match[str]) -> str:
+    global version_info
+
+    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/tests.yml

@@ -0,0 +1,85 @@
+name: Tests
+on:
+  pull_request:
+  push:
+  repository_dispatch:
+    types:
+      - dispatched_test
+
+env:
+  ref: ${{ github.event.client_payload.ref || '' }}
+
+jobs:
+    tox:
+      runs-on: ubuntu-latest
+      strategy:
+        matrix:
+          python_version:
+            - "3.8"
+          tox_env:
+            - py
+            - style
+            - docs
+          include:
+            - tox_env: py
+              friendly_name: Tests
+            - tox_env: style
+              friendly_name: Style
+            - tox_env: docs
+              friendly_name: Docs
+        fail-fast: false
+      name: Tox - ${{ matrix.friendly_name }}
+      steps:
+        - uses: actions/checkout@v2
+          with:
+            ref: ${{ env.ref }}
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: ${{ matrix.python_version }}
+        - name: Install tox
+          run: |
+            python -m pip install --upgrade pip
+            pip install tox
+        - name: Tox test
+          env:
+            TOXENV: ${{ matrix.tox_env }}
+          run: tox
+
+    tox-postgres:
+      runs-on: ubuntu-latest
+      strategy:
+        matrix:
+          python_version:
+            - "3.8"
+        fail-fast: false
+      name: Tox - Postgres
+      services:
+        postgresql:
+          image: postgres:10
+          ports:
+            - 5432:5432
+          env:
+            POSTGRES_DB: red_db
+            POSTGRES_PASSWORD: postgres
+            POSTGRES_USER: postgres
+      steps:
+        - uses: actions/checkout@v2
+          with:
+            ref: ${{ env.ref }}
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: ${{ matrix.python_version }}
+        - name: Install tox
+          run: |
+            python -m pip install --upgrade pip
+            pip install tox
+        - name: Tox test
+          env:
+            TOXENV: postgres
+            PGDATABASE: red_db
+            PGUSER: postgres
+            PGPASSWORD: postgres
+            PGPORT: 5432
+          run: tox

.gitignore

@@ -1,4 +1,3 @@
-*.json
 *.exe
 *.dll
 *.pot
@@ -6,6 +5,7 @@
 !/tests/cogs/dataconverter/data/**/*.json
 Pipfile
 Pipfile.lock
+.directory
 
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
@@ -14,6 +14,7 @@ Pipfile.lock
 # User-specific stuff:
 .idea/
 *.iws
+.vscode/
 
 ## Plugin-specific files:
 
@@ -57,6 +58,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -136,3 +138,6 @@ ENV/
 
 # pytest
 .pytest_cache/
+
+# Pre-commit hooks
+/.pre-commit-config.yaml

.readthedocs.yml

@@ -7,11 +7,10 @@ build:
   image: latest
 
 python:
-  version: 3.7
+  version: 3.8
   install:
     - requirements: docs/requirements.txt
     - method: pip
       path: .
       extra_requirements:
         - docs
-        - mongo

.travis.yml

@@ -5,14 +5,10 @@ notifications:
   email: false
 
 python:
-- 3.7.2
+- 3.8.1
 env:
   global:
     - PIPENV_IGNORE_VIRTUALENVS=1
-  matrix:
-    - TOXENV=py
-    - TOXENV=docs
-    - TOXENV=style
 
 install:
 - pip install --upgrade pip tox
@@ -22,13 +18,22 @@ script:
 
 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.7.2
+      python: 3.8.1
       env:
         - DEPLOYING=true
-        - TOXENV=py36
+        - TOXENV=py38
       deploy:
         - provider: pypi
           distributions: sdist bdist_wheel
@@ -40,11 +45,11 @@ jobs:
             repo: Cog-Creators/Red-DiscordBot
             tags: true
     - stage: Crowdin Deployment
-      if: tag IS present
-      python: 3.7.2
+      if: tag IS present OR ENV(BUILD_CROWDIN)
+      python: 3.8.1
       env:
         - DEPLOYING=true
-        - TOXENV=py36
+        - 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

CONTRIBUTING.md

@@ -29,9 +29,8 @@ Red is an open source project. This means that each and every one of the develop
 We love receiving contributions from our community. Any assistance you can provide with regards to bug fixes, feature enhancements, and documentation is more than welcome.
 
 # 2. Ground Rules
-We've made a point to use [ZenHub](https://www.zenhub.com/) (a plugin for GitHub) as our main source of collaboration and coordination. Your experience contributing to Red will be greatly improved if you go get that plugin.
 1. Ensure cross compatibility for Windows, Mac OS and Linux.
-2. Ensure all Python features used in contributions exist and work in Python 3.7 and above.
+2. Ensure all Python features used in contributions exist and work in Python 3.8.1 and above.
 3. Create new tests for code you add or bugs you fix. It helps us help you by making sure we don't accidentally break anything :grinning:
 4. Create any issues for new features you'd like to implement and explain why this feature is useful to everyone and not just you personally.
 5. Don't add new cogs unless specifically given approval in an issue discussing said cog idea.
@@ -53,7 +52,7 @@ Red's repository is configured to follow a particular development workflow, usin
 
 ### 4.1 Setting up your development environment
 The following requirements must be installed prior to setting up:
- - Python 3.7.0 or greater
+ - Python 3.8.1 or greater
  - git
  - pip
  
@@ -79,10 +78,10 @@ If you're not on Windows, you should also have GNU make installed, and you can o
 **Note:** If you're comfortable with setting up virtual environments yourself and would rather do it manually, just run `pip install -Ur tools/dev-requirements.txt` after setting it up.
 
 ### 4.2 Testing
-We've recently started using [tox](https://github.com/tox-dev/tox) to run all of our tests. It's extremely simple to use, and if you followed the previous section correctly, it is already installed to your virtual environment.
+We're using [tox](https://github.com/tox-dev/tox) to run all of our tests. It's extremely simple to use, and if you followed the previous section correctly, it is already installed to your virtual environment.
 
 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.7 (test environment `py37`)
+- 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`)
 
@@ -95,15 +94,19 @@ 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.
 
-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. When using `black` on the command line, simply use it like so: `black -l 99 -N <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/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>`.
 
 ### 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 three things with them:
+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:
 1. `make reformat`: Reformat all python files in the project with Black
 2. `make stylecheck`: Check if any `.py` files in the project need reformatting
 3. `make newenv`: Set up a new virtual environment in the `.venv` subdirectory, and install Red and its dependencies. If one already exists, it is cleared out and replaced.
 4. `make syncenv`: Sync your environment with Red's latest dependencies.
 
+The other make recipes are most likely for project maintainers rather than contributors.
+
+You can specify the Python executable used in the make recipes with the `PYTHON` environment variable, e.g. `make PYTHON=/usr/bin/python3.8 newenv`.
+
 ### 4.5 Keeping your dependencies up to date
 Whenever you pull from upstream (V3/develop on the main repository) and you notice either of the files `setup.cfg` or `tools/dev-requirements.txt` have been changed, it can often mean some package dependencies have been updated, added or removed. To make sure you're testing and formatting with the most up-to-date versions of our dependencies, run `make syncenv`. You could also simply do `make newenv` to install them to a clean new virtual environment.
 
@@ -114,6 +117,10 @@ Whenever you pull from upstream (V3/develop on the main repository) and you noti
 3. If you like the changes and think the main Red project could use it:
     * Run tests with `tox` to ensure your code is up to scratch
     * Create a Pull Request on GitHub with your changes
+      - If you are contributing a behavior change, please keep in mind that behavior changes
+        are conditional on them being appropriate for the project's current goals.
+        If you would like to reduce the risk of putting in effort for something we aren't
+        going to use, open an issue discussing it first.
 
 ### 4.7 How To Report A Bug
 Please see our **ISSUES.MD** for more information.
@@ -137,7 +144,7 @@ Pull requests are evaluated by their quality and how effectively they solve thei
 
 1. A pull request is submitted
 2. Core team members will review and test the pull request (usually within a week)
-3. After a majority of the core team approves your pull request:
+3. After a member of the core team approves your pull request:
     * If your pull request is considered an improvement or enhancement the project owner will have 1 day to veto or approve your pull request.
     * If your pull request is considered a new feature the project owner will have 1 week to veto or approve your pull request.
 4. If any feedback is given we expect a response within 1 week or we may decide to close the PR.

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-2019  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-2019  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.

Makefile

@@ -1,26 +1,31 @@
+PYTHON ?= python3.8
+
+ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+
 # Python Code Style
 reformat:
-	black -l 99 `git ls-files "*.py"`
+	$(PYTHON) -m black $(ROOT_DIR)
 stylecheck:
-	black --check -l 99 `git ls-files "*.py"`
+	$(PYTHON) -m black --check $(ROOT_DIR)
+stylediff:
+	$(PYTHON) -m black --check --diff $(ROOT_DIR)
 
 # Translations
 gettext:
-	redgettext --command-docstrings --verbose --recursive redbot --exclude-files "redbot/pytest/**/*"
+	$(PYTHON) -m redgettext --command-docstrings --verbose --recursive redbot --exclude-files "redbot/pytest/**/*"
 upload_translations:
-	$(MAKE) gettext
 	crowdin upload sources
 download_translations:
 	crowdin download
 
 # Dependencies
 bumpdeps:
-	python tools/bumpdeps.py
+	$(PYTHON) tools/bumpdeps.py
 
 # Development environment
 newenv:
-	python3.7 -m venv --clear .venv
-	.venv/bin/pip install -U pip setuptools
+	$(PYTHON) -m venv --clear .venv
+	.venv/bin/pip install -U pip setuptools wheel
 	$(MAKE) syncenv
 syncenv:
 	.venv/bin/pip install -Ur ./tools/dev-requirements.txt

README.md

@@ -12,22 +12,22 @@
   <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.7-blue.svg?style=for-the-badge" alt="Made with Python 3.7">
-  </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://travis-ci.com/Cog-Creators/Red-DiscordBot">
-    <img src="https://api.travis-ci.com/Cog-Creators/Red-DiscordBot.svg?branch=V3/develop" alt="Travis CI">
+  <a href="https://github.com/Cog-Creators/Red-DiscordBot/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">
@@ -38,6 +38,9 @@
   <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, Hitbox, Picarto)
 - Bank (slot machine, user credits)
 - Custom commands
 - Imgur/gif search
@@ -85,12 +88,7 @@ community of cog repositories.**
 
 - [Windows](https://red-discordbot.readthedocs.io/en/stable/install_windows.html)
 - [MacOS](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-- [Ubuntu](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-- [Debian Stretch](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-- [CentOS 7](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-- [Arch Linux](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-- [Raspbian Stretch](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
-
+- [Most major linux distributions](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
 
 If after reading the guide you are still experiencing issues, feel free to join the
 [Official Discord Server](https://discord.gg/red) and ask in the **#support** channel for help.
@@ -109,7 +107,7 @@ 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!
@@ -131,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.
+Copy of this license can be found in [discord-ext-menus.LICENSE](redbot/vendored/discord-ext-menus.LICENSE) file in [redbot/vendored](redbot/vendored) folder of this repository.

crowdin.yml

@@ -1,6 +1,7 @@
 api_key_env: CROWDIN_API_KEY
 project_identifier_env: CROWDIN_PROJECT_ID
 base_path: ./redbot/
+preserve_hierarchy: true
 files:
   - source: cogs/**/messages.pot
     translation: /%original_path%/%locale%.po

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = python -msphinx
+SPHINXBUILD   = python3 -msphinx
 SPHINXPROJ    = Red-DiscordBot
 SOURCEDIR     = .
 BUILDDIR      = _build
@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_templates/layout.html

@@ -0,0 +1,18 @@
+{% extends '!layout.html' %}
+{% block document %}
+{% if version_slug == 'latest' %}
+<div class="admonition warning">
+    <p class="first admonition-title">Warning</p>
+    <p class="last">
+        This document is for Red's development version, which can be significantly different from previous releases.
+        If you're a regular user, you should read the <a href="{{ dict(versions)['stable'] }}">Red documentation for the current stable release</a>.
+    </p>
+</div>
+{% endif %}
+{{ super() }}
+<a href="https://github.com/Cog-Creators/Red-DiscordBot">
+    <img style="position: absolute; top: 0; right: 0; border: 0;"
+    src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png?resize=149%2C149"
+    class="attachment-full size-full" alt="Fork me on GitHub">
+</a>
+{% endblock %}

docs/about_venv.rst

@@ -0,0 +1,39 @@
+.. _about-venvs:
+
+==========================
+About Virtual Environments
+==========================
+Creating a virtual environment is really easy and usually prevents many common installation
+problems.
+
+**What Are Virtual Environments For?**
+
+Virtual environments allow you to isolate Red's library dependencies, cog dependencies and python
+binaries from the rest of your system. There is no performance overhead to using virtual environment
+and it saves you from a lot of troubles during setup. It also makes sure Red and its dependencies
+are installed to a predictable location which makes uninstalling Red as simple as removing a single folder,
+without worrying about losing your data or other things on your system becoming broken.
+
+
+--------------------------------------------
+Virtual Environments with Multiple Instances
+--------------------------------------------
+If you are running multiple instances of Red on the same machine, you have the option of either
+using the same virtual environment for all of them, or creating separate ones.
+
+.. note::
+
+    This only applies for multiple instances of V3. If you are running a V2 instance as well,
+    you **must** use separate virtual environments.
+
+The advantages of using a *single* virtual environment for all of your V3 instances are:
+
+- When updating Red, you will only need to update it once for all instances (however you will still need to restart all instances for the changes to take effect)
+- It will save space on your hard drive
+
+On the other hand, you may wish to update each of your instances individually.
+
+.. important::
+
+    Windows users with multiple instances should create *separate* virtual environments, as
+    updating multiple running instances at once is likely to cause errors.

docs/autostart_pm2.rst

@@ -0,0 +1,55 @@
+.. 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.
+
+If you used :code:`pyenv virtualenv` to create your virtual environment, please make the following changes to the above generated command
+
+.. code-block:: none
+
+    <Location to your Python Interpreter>
+    Run the following instead to get your Python interpreter
+    pyenv which python
+
+    Replace the `redbot` part of `pm2 start redbot` with the output of the following (when ran inside your activated venv)
+    pyenv which redbot
+
+------------------------------
+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

@@ -1,27 +1,51 @@
-.. systemd service guide
+.. _systemd-service-guide:
 
 ==============================================
 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
 -------------------------
 
-Create the new service file:
+In order to create the service file, you will first need to know two things, your Linux :code:`username` and your Python :code:`path`
+
+First, your Linux :code:`username` can be fetched with the following command:
+
+.. code-block:: bash
+
+    whoami
+
+Next, your python :code:`path` can be fetched with the following commands:
+
+.. code-block:: bash
+
+    # If redbot is installed in a venv
+    source ~/redenv/bin/activate
+    which python
+
+    # If redbot is installed in a pyenv virtualenv
+    pyenv shell <virtualenv_name>
+    pyenv which python
+
+Then create the new service file:
 
 :code:`sudo -e /etc/systemd/system/red@.service`
 
-Paste the following and replace all instances of :code:`username` with the username your bot is running under (hopefully not root):
+Paste the following in the file, and replace all instances of :code:`username` with the Linux username you retrieved above, and :code:`path` with the python path you retrieved above.
 
 .. code-block:: none
 
     [Unit]
     Description=%I redbot
     After=multi-user.target
+    After=network-online.target
+    Wants=network-online.target
 
     [Service]
-    ExecStart=/home/username/.local/bin/redbot %I --no-prompt
+    ExecStart=path -O -m redbot %I --no-prompt
     User=username
     Group=username
     Type=idle
@@ -59,4 +83,4 @@ type the following command in the terminal, still by adding the instance name af
 
 To view Red’s log, you can acccess through journalctl:
 
-:code:`sudo journalctl -u red@instancename`
+:code:`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_1_0.rst

@@ -110,7 +110,7 @@ Downloader
  * ``[p]cog uninstall`` allows to uninstall multiple cogs now (`#2592`_)
  * ``[p]cog uninstall`` will now remove cog from installed cogs even if it can't find the cog in install path anymore (`#2595`_)
  * ``[p]cog install`` will not allow to install cogs which aren't suitable for installed version of Red anymore (`#2605`_)
- * Cog Developers now have to use ``min_bot_version`` in form of version string instead of ``bot_version`` in info.json and they can also use ``max_bot_version`` to specify maximum version of Red, more in :doc:`framework_downloader`. (`#2605`_)
+ * Cog Developers now have to use ``min_bot_version`` in form of version string instead of ``bot_version`` in info.json and they can also use ``max_bot_version`` to specify maximum version of Red, more in :ref:`info-json-format`. (`#2605`_)
 
 ------
 Filter

docs/changelog_3_2_0.rst

@@ -0,0 +1,565 @@
+.. 3.2.x Changelogs
+
+Redbot 3.2.3 (2020-01-17)
+=========================
+
+Core Bot Changes
+----------------
+
+- Further improvements have been made to bot startup and shutdown.
+- Prefixes are now cached for performance.
+- Added the means for cog creators to use a global preinvoke hook.
+- The bot now ensures it has at least the bare neccessary permissions before running commands.
+- Deleting instances works as intended again.
+- Sinbad stopped fighting it and embraced the entrypoint madness.
+
+Core Commands
+-------------
+
+- The servers command now also shows the ids.
+
+Admin Cog
+---------
+
+- The selfrole command now has reasonable expectations about hierarchy.
+
+Help Formatter
+--------------
+
+- ``[botname]`` is now replaced with the bot's display name in help text.
+- New features added for cog creators to further customize help behavior.
+  
+  - Check out our command reference for details on new ``format_help_for_context`` method.
+- Embed settings are now consistent.
+
+Downloader
+----------
+
+- Improved a few user facing messages.
+- Added pagination of output on cog update.
+- Added logging of failures.
+
+Docs
+----
+
+There's more detail to the below changes, so go read the docs.
+For some reason, documenting documentation changes is hard.
+
+- Added instructions about git version.
+- Clarified instructions for installation and update.
+- Added more details to the API key reference.
+- Fixed some typos and versioning mistakes.
+
+
+Audio
+-----
+
+Draper did things.
+
+- No seriously, Draper did things.
+- Wait you wanted details? Ok, I guess we can share those.
+- Audio properly disconnects with autodisconnect, even if notify is being used.
+- Symbolic links now work as intended for local tracks.
+- Bump play now shows the correct time till next track.
+- Multiple user facing messages have been made more correct.
+
+Redbot 3.2.2 (2020-01-10)
+=========================
+
+Hotfixes
+--------
+
+- Fix Help Pagination issue
+
+Docs
+----
+
+- Correct venv docs
+
+
+Redbot 3.2.1 (2020-01-10)
+=========================
+
+Hotfixes
+--------
+
+- Fix Mongo conversion from being incorrectly blocked
+- Fix announcer not creating a message for success feedback
+- Log an error with creating case types rather than crash
+
+
+Redbot 3.2.0 (2020-01-09)
+=========================
+Core Bot Changes
+----------------
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+
+- Modlog casetypes no longer have an attribute for auditlog action type. (`#2897 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2897>`_)
+- Removed ``redbot.core.modlog.get_next_case_number()``. (`#2908 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2908>`_)
+- Removed ``bank.MAX_BALANCE``, use ``bank.get_max_balance()`` from now on. (`#2926 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2926>`_)
+- The main bot config is no longer directly accessible to cogs. New methods have been added for use where this is concerned.
+  New methods for this include
+
+    - ``bot.get_shared_api_tokens``
+    - ``bot.set_shared_api_tokens``
+    - ``bot.get_embed_color``
+    - ``bot.get_embed_colour``
+    - ``bot.get_admin_roles``
+    - ``bot.get_admin_role_ids``
+    - ``bot.get_mod_roles``
+    - ``bot.get_mod_role_ids`` (`#2967 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2967>`_)
+- Reserved some command names for internal Red use. These are available programatically as ``redbot.core.commands.RESERVED_COMMAND_NAMES``. (`#2973 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2973>`_)
+- Removed ``bot._counter``, Made a few more attrs private (``cog_mgr``, ``main_dir``). (`#2976 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2976>`_)
+- Extension's ``setup()`` function should no longer assume that we are, or even will be connected to Discord.
+  This also means that cog creators should no longer use ``bot.wait_until_ready()`` inside it. (`#3073 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3073>`_)
+- Removed the mongo driver. (`#3099 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3099>`_)
+
+
+Bug Fixes
+~~~~~~~~~
+
+- Help now properly hides disabled commands. (`#2863 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2863>`_)
+- Fixed ``bot.remove_command`` throwing an error when trying to remove a non-existent command. (`#2888 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2888>`_)
+- ``Command.can_see`` now works as intended for disabled commands. (`#2892 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2892>`_)
+- Modlog entries now show up properly without the mod cog loaded. (`#2897 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2897>`_)
+- Fixed an error in ``[p]reason`` when setting the reason for a case without a moderator. (`#2908 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2908>`_)
+- Bank functions now check the recipient balance before transferring and stop the transfer if the recipient's balance will go above the maximum allowed balance. (`#2923 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2923>`_)
+- Removed potential for additional bad API calls per ban/unban. (`#2945 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2945>`_)
+- The ``[p]invite`` command no longer errors when a user has the bot blocked or DMs disabled in the server. (`#2948 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2948>`_)
+- Stopped using the ``:`` character in backup's filename - Windows doesn't accept it. (`#2954 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2954>`_)
+- ``redbot-setup delete`` no longer errors with "unexpected keyword argument". (`#2955 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2955>`_)
+- ``redbot-setup delete`` no longer prompts about backup when the user passes the option ``--no-prompt``. (`#2956 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2956>`_)
+- Cleaned up the ``[p]inviteset public`` and ``[p]inviteset perms`` help strings.  (`#2963 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2963>`_)
+- ```[p]embedset user`` now only affects DM's. (`#2966 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2966>`_)
+- Fixed an unfriendly error when the provided instance name doesn't exist. (`#2968 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2968>`_)
+- Fixed the help text and response of ``[p]set usebotcolor`` to accurately reflect what the command is doing. (`#2974 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2974>`_)
+- Red no longer types infinitely when a command with a cooldown is called within the last second of a cooldown. (`#2985 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2985>`_)
+- Removed f-string usage in the launcher to prevent our error handling from causing an error. (`#3002 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3002>`_)
+- Fixed ``MessagePredicate.greater`` and ``MessagePredicate.less`` allowing any valid int instead of only valid ints/floats that are greater/less than the given value. (`#3004 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3004>`_)
+- Fixed an error in ``[p]uptime`` when the uptime is under a second. (`#3009 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3009>`_)
+- Added quotation marks to the response of ``[p]helpset tagline`` so that two consecutive full stops do not appear. (`#3010 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3010>`_)
+- Fixed an issue with clearing rules in permissions. (`#3014 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3014>`_)
+- Lavalink will now be restarted after an unexpected shutdown. (`#3033 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3033>`_)
+- Added a 3rd-party lib folder to ``sys.path`` before loading cogs. This prevents issues with 3rd-party cogs failing to load when Downloader is not loaded to install requirements. (`#3036 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3036>`_)
+- Escaped track descriptions so that they do not break markdown. (`#3047 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3047>`_)
+- Red will now properly send a message when the invoked command is guild-only. (`#3057 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3057>`_)
+- Arguments ``--co-owner`` and ``--load-cogs`` now properly require at least one argument to be passed. (`#3060 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3060>`_)
+- Now always appends the 3rd-party lib folder to the end of ``sys.path`` to avoid shadowing Red's dependencies. (`#3062 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3062>`_)
+- Fixed ``is_automod_immune``'s handling of the guild check and added support for checking webhooks. (`#3100 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3100>`_)
+- Fixed the generation of the ``repos.json`` file in the backup process. (`#3114 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3114>`_)
+- Fixed an issue where calling audio commands when not in a voice channel could result in a crash. (`#3120 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3120>`_)
+- Added handling for invalid folder names in the data path gracefully in ``redbot-setup`` and ``redbot --edit``. (`#3171 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3171>`_)
+- ``--owner`` and ``-p`` cli flags now work when added from launcher. (`#3174 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3174>`_)
+- Red will now prevent users from locking themselves out with localblacklist. (`#3207 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3207>`_)
+- Fixed help ending up a little too large for discord embed limits. (`#3208 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3208>`_)
+- Fixed formatting issues in commands that list whitelisted/blacklisted users/roles when the list is empty. (`#3219 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3219>`_)
+- Red will now prevent users from locking the guild owner out with localblacklist (unless the command caller is bot owner). (`#3221 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3221>`_)
+- Guild owners are no longer affected by the local whitelist and blacklist. (`#3221 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3221>`_)
+- Fixed an attribute error that can be raised in ``humanize_timedelta`` if ``seconds = 0``. (`#3231 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3231>`_)
+- Fixed ``ctx.clean_prefix`` issues resulting from undocumented changes from discord. (`#3249 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3249>`_)
+- ``redbot.core.bot.Bot.owner_id`` is now set in the post connection startup. (`#3273 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3273>`_)
+- ``redbot.core.bot.Bot.send_to_owners()`` and ``redbot.core.bot.Bot.get_owner_notification_destinations()`` now wait until Red is done with post connection startup to ensure owner ID is available. (`#3273 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3273>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Added the option to modify the RPC port with the ``--rpc-port`` flag. (`#2429 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2429>`_)
+- Slots now has a 62.5% expected payout and will not inflate economy when spammed. (`#2875 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2875>`_)
+- Allowed passing ``cls`` in the ``redbot.core.commands.group()`` decorator. (`#2881 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2881>`_)
+- Red's Help Formatter is now considered to have a stable API. (`#2892 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2892>`_)
+- Modlog no longer generates cases without being told to for actions the bot did. (`#2897 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2897>`_)
+- Some generic modlog casetypes are now pre-registered for cog creator use. (`#2897 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2897>`_)
+- ModLog is now much faster at creating cases, especially in large servers. (`#2908 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2908>`_)
+- JSON config files are now stored without indentation, this is to reduce the file size and increase the performance of write operations. (`#2921 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2921>`_)
+- ``--[no-]backup``, ``--[no-]drop-db`` and ``--[no-]remove-datapath`` in the ``redbot-setup delete`` command are now on/off flags. (`#2958 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2958>`_)
+- The confirmation prompts in ``redbot-setup`` now have default values for user convenience. (`#2958 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2958>`_)
+- ``redbot-setup delete`` now has the option to leave Red's data untouched on database backends. (`#2962 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2962>`_)
+- Red now takes less time to fetch cases, unban members, and list warnings. (`#2964 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2964>`_)
+- Red now handles more things prior to connecting to discord to reduce issues during the initial load. (`#3045 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3045>`_)
+- ``bot.send_filtered`` now returns the message that is sent. (`#3052 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3052>`_)
+- Red will now send a message when the invoked command is DM-only. (`#3057 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3057>`_)
+- All ``y/n`` confirmations in cli commands are now unified. (`#3060 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3060>`_)
+- Changed ``[p]info`` to say "This bot is an..." instead of "This is an..." for clarity. (`#3121 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3121>`_)
+- ``redbot-setup`` will now use the instance name in default data paths to avoid creating a second instance with the same data path. (`#3171 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3171>`_)
+- Instance names can now only include characters A-z, numbers, underscores, and hyphens. Old instances are unaffected by this change. (`#3171 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3171>`_)
+- Clarified that ``[p]backup`` saves the **bot's** data in the help text. (`#3172 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3172>`_)
+- Added ``redbot --debuginfo`` flag which shows useful information for debugging. (`#3183 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3183>`_)
+- Added the Python executable field to ``[p]debuginfo``. (`#3184 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3184>`_)
+- When Red prompts for a token, it will now print a link to the guide explaining how to obtain a token. (`#3204 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3204>`_)
+- ``redbot-setup`` will no longer log to disk. (`#3269 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3269>`_)
+- ``redbot.core.bot.Bot.send_to_owners()`` and ``redbot.core.bot.Bot.get_owner_notification_destinations()`` now log when they are not able to find the owner notification destination. (`#3273 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3273>`_)
+- The lib folder is now cleared on minor Python version changes. ``[p]cog reinstallreqs`` in Downloader can be used to regenerate the lib folder for a new Python version. (`#3274 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3274>`_)
+- If Red detects operating system or architecture change, it will now warn the owner about possible problems with the lib folder. (`#3274 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3274>`_)
+- ``[p]playlist download`` will now compress playlists larger than the server attachment limit and attempt to send that. (`#3279 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3279>`_)
+
+
+New Features
+~~~~~~~~~~~~
+
+- Added functions to acquire locks on Config groups and values. These locks are acquired by default when calling a value as a context manager. See ``Value.get_lock`` for details. (`#2654 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2654>`_)
+- Added a config driver for PostgreSQL. (`#2723 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2723>`_)
+- Added methods to Config for accessing things by id without mocked objects
+
+    - ``Config.guild_from_id``
+    - ``Config.user_from_id``
+    - ``Config.role_from_id``
+    - ``Config.channel_from_id``
+    - ``Config.member_from_ids``
+      - This one requires multiple ids, one for the guild, one for the user
+      - Consequence of discord's object model (`#2804 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2804>`_)
+- New method ``humanize_number`` in ``redbot.core.utils.chat_formatting`` to convert numbers into text that respects the current locale. (`#2836 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2836>`_)
+- Added new commands to Economy
+
+  - ``[p]bank prune user`` - This will delete a user's bank account.
+  - ``[p]bank prune local`` - This will prune the bank of accounts for users who are no longer in the server.
+  - ``[p]bank prune global`` - This will prune the global bank of accounts for users who do not share any servers with the bot. (`#2845 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2845>`_)
+- Red now uses towncrier for changelog generation. (`#2872 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2872>`_)
+- Added ``redbot.core.modlog.get_latest_case`` to fetch the case object for the most recent ModLog case. (`#2908 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2908>`_)
+- Added ``[p]bankset maxbal`` to set the maximum bank balance. (`#2926 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2926>`_)
+- Added a few methods and classes replacing direct config access (which is no longer supported)
+
+   - ``redbot.core.Red.allowed_by_whitelist_blacklist``
+   - ``redbot.core.Red.get_valid_prefixes``
+   - ``redbot.core.Red.clear_shared_api_tokens``
+   - ``redbot.core.commands.help.HelpSettings`` (`#2976 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2976>`_)
+- Added the cli flag ``redbot --edit`` which is used to edit the instance name, token, owner, and datapath. (`#3060 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3060>`_)
+- Added ``[p]licenseinfo``. (`#3090 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3090>`_)
+- Ensured that people can migrate from MongoDB. (`#3108 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3108>`_)
+- Added a command to list disabled commands globally or per guild. (`#3118 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3118>`_)
+- New event ``on_red_api_tokens_update`` is now dispatched when shared api keys for a service are updated. (`#3134 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3134>`_)
+- Added ``redbot-setup backup``. (`#3235 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3235>`_)
+- Added the method ``redbot.core.bot.Bot.wait_until_red_ready()`` that waits until Red's post connection startup is done. (`#3273 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3273>`_)
+
+
+Removals
+~~~~~~~~
+
+- ``[p]set owner`` and ``[p]set token`` have been removed in favor of managing server side. (`#2928 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2928>`_)
+- Shared libraries are marked for removal in Red 3.4. (`#3106 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3106>`_)
+- Removed ``[p]backup``. Use the cli command ``redbot-setup backup`` instead. (`#3235 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3235>`_)
+- Removed the functions ``safe_delete``, ``fuzzy_command_search``, ``format_fuzzy_results`` and ``create_backup`` from ``redbot.core.utils``. (`#3240 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3240>`_)
+- Removed a lot of the launcher's handled behavior. (`#3289 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3289>`_)
+
+
+Miscellaneous changes
+~~~~~~~~~~~~~~~~~~~~~
+
+- `#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_, `#2571 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2571>`_, `#2723 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2723>`_, `#2836 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2836>`_, `#2849 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2849>`_, `#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_, `#2885 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2885>`_, `#2890 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2890>`_, `#2897 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2897>`_, `#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_, `#2924 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2924>`_, `#2939 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2939>`_, `#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_, `#2941 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2941>`_, `#2949 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2949>`_, `#2953 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2953>`_, `#2964 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2964>`_, `#2986 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2986>`_, `#2993 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2993>`_, `#2997 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2997>`_, `#3008 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3008>`_, `#3017 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3017>`_, `#3048 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3048>`_, `#3059 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3059>`_, `#3080 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3080>`_, `#3089 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3089>`_, `#3104 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3104>`_, `#3106 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3106>`_, `#3129 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3129>`_, `#3152 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3152>`_, `#3160 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3160>`_, `#3168 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3168>`_, `#3173 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3173>`_, `#3176 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3176>`_, `#3186 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3186>`_, `#3192 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3192>`_, `#3193 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3193>`_, `#3195 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3195>`_, `#3202 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3202>`_, `#3214 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3214>`_, `#3223 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3223>`_, `#3229 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3229>`_, `#3245 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3245>`_, `#3247 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3247>`_, `#3248 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3248>`_, `#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_, `#3254 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3254>`_, `#3255 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3255>`_, `#3256 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3256>`_, `#3258 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3258>`_, `#3261 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3261>`_, `#3275 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3275>`_, `#3276 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3276>`_, `#3293 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3293>`_, `#3278 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3278>`_, `#3285 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3285>`_, `#3296 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3296>`_,
+
+
+Dependency changes
+~~~~~~~~~~~~~~~~~~~~~~~
+
+- Added ``pytest-mock`` requirement to ``tests`` extra. (`#2571 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2571>`_)
+- Updated the python minimum requirement to 3.8.1, updated JRE to Java 11. (`#3245 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3245>`_)
+- Bumped dependency versions. (`#3288 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3288>`_)
+- Bumped red-lavalink version. (`#3290 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3290>`_)
+
+
+Documentation Changes
+~~~~~~~~~~~~~~~~~~~~~
+
+- Started the user guides covering cogs and the user interface of the bot. This includes, for now, a "Getting started" guide. (`#1734 <https://github.com/Cog-Creators/Red-DiscordBot/issues/1734>`_)
+- Added documentation for PM2 support. (`#2105 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2105>`_)
+- Updated linux install docs, adding sections for Fedora Linux, Debian/Raspbian Buster, and openSUSE. (`#2558 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2558>`_)
+- Created documentation covering what we consider a developer facing breaking change and the guarantees regarding them. (`#2882 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2882>`_)
+- Fixed the user parameter being labeled as ``discord.TextChannel`` instead of ``discord.abc.User`` in ``redbot.core.utils.predicates``. (`#2914 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2914>`_)
+- Updated towncrier info in the contribution guidelines to explain how to create a changelog for a standalone PR. (`#2915 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2915>`_)
+- Reworded the virtual environment guide to make it sound less scary. (`#2920 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2920>`_)
+- Driver docs no longer show twice. (`#2972 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2972>`_)
+- Added more information about ``redbot.core.utils.humanize_timedelta`` into the docs. (`#2986 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2986>`_)
+- Added a direct link to the "Installing Red" section in "Installing using powershell and chocolatey". (`#2995 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2995>`_)
+- Updated Git PATH install (Windows), capitalized some words, stopped mentioning the launcher. (`#2998 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2998>`_)
+- Added autostart documentation for Red users who installed Red inside of a virtual environment. (`#3005 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3005>`_)
+- Updated the Cog Creation guide with a note regarding the Develop version as well as the folder layout for local cogs. (`#3021 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3021>`_)
+- Added links to the getting started guide at the end of installation guides. (`#3025 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3025>`_)
+- Added proper docstrings to enums that show in drivers docs. (`#3035 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3035>`_)
+- Discord.py doc links will now always use the docs for the currently used version of discord.py. (`#3053 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3053>`_)
+- Added ``|DPY_VERSION|`` substitution that will automatically get replaced by the current discord.py version. (`#3053 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3053>`_)
+- Added missing descriptions for function returns. (`#3054 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3054>`_)
+- Stopped overwriting the ``docs/prolog.txt`` file in ``conf.py``. (`#3082 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3082>`_)
+- Fixed some typos and wording, added MS Azure to the host list. (`#3083 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3083>`_)
+- Updated the docs footer copyright to 2019. (`#3105 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3105>`_)
+- Added a deprecation note about shared libraries in the Downloader Framework docs. (`#3106 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3106>`_)
+- Updated the apikey framework documentation. Changed ``bot.get_shared_api_keys()`` to ``bot.get_shared_api_tokens()``. (`#3110 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3110>`_)
+- Added information about ``info.json``'s ``min_python_version`` key in Downloader Framework docs. (`#3124 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3124>`_)
+- Added an event reference for the ``on_red_api_tokens_update`` event in the Shared API Keys docs. (`#3134 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3134>`_)
+- Added notes explaining the best practices with config. (`#3149 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3149>`_)
+- Documented additional attributes in Context. (`#3151 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3151>`_)
+- Updated Windows docs with up to date dependency instructions. (`#3188 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3188>`_)
+- Added a "Publishing cogs for V3" document explaining how to make user's cogs work with Downloader. (`#3234 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3234>`_)
+- Fixed broken docs for ``redbot.core.commands.Context.react_quietly``. (`#3257 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3257>`_)
+- Updated copyright notices on License and RTD config to 2020. (`#3259 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3259>`_)
+- Added a line about setuptools and wheel. (`#3262 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3262>`_)
+- Ensured development builds are not advertised to the wrong audience. (`#3292 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3292>`_)
+- Clarified the usage intent of some of the chat formatting functions. (`#3292 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3292>`_)
+
+
+Admin
+-----
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+
+- Changed ``[p]announce ignore`` and ``[p]announce channel`` to ``[p]announceset ignore`` and ``[p]announceset channel``. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+- Changed ``[p]selfrole <role>`` to ``[p]selfrole add <role>``, changed ``[p]selfrole add`` to ``[p]selfroleset add`` , and changed ``[p]selfrole delete`` to ``[p]selfroleset remove``. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+
+
+Bug Fixes
+~~~~~~~~~
+
+- Fixed ``[p]announce`` failing after encountering an error attempting to message the bot owner. (`#3166 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3166>`_)
+- Improved the clarity of user facing messages when the user is not allowed to do something due to Discord hierarchy rules. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+- Fixed some role managing commands not properly checking if Red had ``manage_roles`` perms before attempting to manage roles. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+- Fixed ``[p]editrole`` commands not checking if roles to be edited are higher than Red's highest role before trying to edit them. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+- Fixed ``[p]announce ignore`` and ``[p]announce channel`` not being able to be used by guild owners and administrators. (`#3250 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3250>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Added custom issue messages for adding and removing roles, this makes it easier to create translations. (`#3016 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3016>`_)
+
+
+Audio
+-----
+
+Bug Fixes
+~~~~~~~~~
+
+- ``[p]playlist remove`` now removes the playlist url if the playlist was created through ``[p]playlist save``. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- Users are no longer able to accidentally overwrite existing playlist if a new one with the same name is created/renamed. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- ``[p]audioset settings`` no longer shows lavalink JAR version. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- Fixed a ``KeyError: loadType`` when trying to play tracks. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]audioset settings`` now uses ``ctx.is_owner()`` to check if the context author is the bot owner. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- Fixed track indexs being off by 1 in ``[p]search``. (`#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_)
+- Fixed an issue where updating your Spotify and YouTube Data API tokens did not refresh them. (`#3047 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3047>`_)
+- Fixed an issue where the blacklist was not being applied correctly. (`#3047 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3047>`_)
+- Fixed an issue in ``[p]audioset restrictions blacklist list`` where it would call the list a ``Whitelist``. (`#3047 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3047>`_)
+- Red's status is now properly cleared on emptydisconnect. (`#3050 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3050>`_)
+- Fixed a console spam caused sometimes when auto disconnect and auto pause are used. (`#3123 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3123>`_)
+- Fixed an error that was thrown when running ``[p]audioset dj``. (`#3165 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3165>`_)
+- Fixed a crash that could happen when the bot can't connect to the lavalink node. (`#3238 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3238>`_)
+- Restricted the number of songs shown in the queue to first 500 to avoid heartbeats. (`#3279 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3279>`_)
+- Added more cooldowns to playlist commands and restricted the queue and playlists to 10k songs to avoid bot errors. (`#3286 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3286>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- ``[p]playlist upload`` will now load playlists generated via ``[p]playlist download`` much faster if the playlist uses the new scheme. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- ``[p]playlist`` commands now can be used by everyone regardless of DJ settings, however it will respect DJ settings when creating/modifying playlists in the server scope. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- Spotify, Youtube Data, and Lavalink API calls can be cached to avoid repeated calls in the future, see ``[p]audioset cache``. (`#2890 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2890>`_)
+- Playlists will now start playing as soon as first track is loaded. (`#2890 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2890>`_)
+- ``[p]audioset localpath`` can set a path anywhere in your machine now. Note: This path needs to be visible by ``Lavalink.jar``. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]queue`` now works when there are no tracks in the queue, showing the track currently playing. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]audioset settings`` now reports Red Lavalink version. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- Adding and removing reactions in Audio is no longer a blocking action. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- When shuffle is on, queue now shows the correct play order. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]seek`` and ``[p]skip`` can be used by user if they are the song requester while DJ mode is enabled and votes are disabled. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- Adding a playlist and an album to a saved playlist skips tracks already in the playlist. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- DJ mode is now turned off if the DJ role is deleted. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- When playing a localtrack, ``[p]play`` and ``[p]bumpplay`` no longer require the use of the prefix "localtracks\\".
+
+  Before: ``[p]bumpplay localtracks\\ENM\\501 - Inside The Machine.mp3``
+  Now: ``[p]bumpplay ENM\\501 - Inside The Machine.mp3``
+  Now nested folders: ``[p]bumpplay Parent Folder\\Nested Folder\\track.mp3`` (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- Removed commas in explanations about how to set API keys. (`#2905 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2905>`_)
+- Expanded local track support to all file formats (m3u, m4a, mp4, etc). (`#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_)
+- Cooldowns are now reset upon failure of commands that have a cooldown timer. (`#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_)
+- Improved the explanation in the help string for ``[p]audioset emptydisconnect``. (`#3051 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3051>`_)
+- Added a typing indicator to playlist dedupe. (`#3058 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3058>`_)
+- Exposed clearer errors to users in the play commands. (`#3085 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3085>`_)
+- Better error handling when the player is unable to play multiple tracks in the sequence. (`#3165 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3165>`_)
+
+
+New Features
+~~~~~~~~~~~~
+
+- Added support for nested folders in the localtrack folder. (`#270 <https://github.com/Cog-Creators/Red-DiscordBot/issues/270>`_)
+- Now auto pauses the queue when the voice channel is empty. (`#721 <https://github.com/Cog-Creators/Red-DiscordBot/issues/721>`_)
+- All Playlist commands now accept optional arguments, use ``[p]help playlist <subcommand>`` for more details. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- ``[p]playlist rename`` will now allow users to rename existing playlists. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- ``[p]playlist update`` will now allow users to update non-custom Playlists to the latest available tracks. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- There are now 3 different scopes of playlist. To define them, use the ``--scope`` argument.
+
+      ``Global Playlist``
+
+      - These playlists will be available in all servers the bot is in.
+      - These can be managed by the Bot Owner only.
+
+      ``Server Playlist``
+
+      - These playlists will only be available in the server they were created in.
+      - These can be managed by the Bot Owner, Guild Owner, Mods, Admins, DJs, and the Creator (if the DJ role is disabled).
+
+      ``User Playlist``
+
+      - These playlists will be available in all servers both the bot and the creator are in.
+      - These can be managed by the Bot Owner and Creator only. (`#2861 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2861>`_)
+- ``[p]audioset cache`` can be used to set the cache level. **It's off by default**. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]genre`` can be used to play spotify playlists. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]audioset cacheage`` can be used to set the maximum age of an entry in the cache. **Default is 365 days**. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]audioset autoplay`` can be used to enable auto play once the queue runs out. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- New events dispatched by Audio.
+
+   - ``on_red_audio_track_start(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)``
+   - ``on_red_audio_track_end(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)``
+   - ``on_red_audio_track_enqueue(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)``
+   - ``on_red_audio_track_auto_play(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)``
+   - ``on_red_audio_queue_end(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)``
+   - ``on_red_audio_audio_disconnect(guild: discord.Guild)``
+   - ``on_red_audio_skip_track(guild: discord.Guild, track: lavalink.Track, requester: discord.Member)`` (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]queue shuffle`` can be used to shuffle the queue manually. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]queue clean self`` can be used to remove all songs you requested from the queue. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]audioset restrictions`` can be used to add or remove keywords which songs must have or are not allowed to have. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]playlist dedupe`` can be used to remove duplicated tracks from a playlist. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]autoplay`` can be used to play a random song. (`#2904 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2904>`_)
+- ``[p]bumpplay`` can be used to add a song to the front of the queue. (`#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_)
+- ``[p]shuffle`` has an additional argument to tell the bot whether it should shuffle bumped tracks. (`#2940 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2940>`_)
+- Added global whitelist/blacklist commands. (`#3047 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3047>`_)
+- Added self-managed daily playlists in the GUILD scope, these are called "Daily playlist - YYYY-MM-DD" and auto delete after 7 days. (`#3199 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3199>`_)
+
+
+CustomCom
+---------
+
+Enhancements
+~~~~~~~~~~~~
+
+- The group command ``[p]cc create`` can now be used to create simple CCs without specifying "simple". (`#1767 <https://github.com/Cog-Creators/Red-DiscordBot/issues/1767>`_)
+- Added a query option for CC typehints for URL-based CCs. (`#3228 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3228>`_)
+- Now uses the ``humanize_list`` utility for iterable parameter results, e.g. ``{#:Role.members}``. (`#3277 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3277>`_)
+
+
+Downloader
+----------
+
+Bug Fixes
+~~~~~~~~~
+
+- Made the regex for repo names use raw strings to stop causing a ``DeprecationWarning`` for invalid escape sequences. (`#2571 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2571>`_)
+- Downloader will no longer attempt to install cogs that are already installed. (`#2571 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2571>`_)
+- Repo names can now only contain the characters listed in the help text (A-Z, 0-9, underscores, and hyphens). (`#2827 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2827>`_)
+- ``[p]findcog`` no longer attempts to find a cog for commands without a cog. (`#2902 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2902>`_)
+- Downloader will no longer attempt to install a cog with same name as another cog that is already installed. (`#2927 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2927>`_)
+- Added error handling for when a remote repository or branch is deleted, now notifies the which repository failed and continues to update the others. (`#2936 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2936>`_)
+- ``[p]cog install`` will no longer error if a cog has an empty install message. (`#3024 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3024>`_)
+- Made ``redbot.cogs.downloader.repo_manager.Repo.clean_url`` work with relative urls. This property is ``str`` type now. (`#3141 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3141>`_)
+- Fixed an error on repo add from empty string values for the ``install_msg`` info.json field. (`#3153 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3153>`_)
+- Disabled all git auth prompts when adding/updating a repo with Downloader. (`#3159 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3159>`_)
+- ``[p]findcog`` now properly works for cogs with less typical folder structure. (`#3177 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3177>`_)
+- ``[p]cog uninstall`` now fully unloads cog - the bot will not try to load it on next startup. (`#3179 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3179>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Downloader will now check if the Python and bot versions match requirements in ``info.json`` during update. (`#1866 <https://github.com/Cog-Creators/Red-DiscordBot/issues/1866>`_)
+- ``[p]cog install`` now accepts multiple cog names. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- When passing cogs to ``[p]cog update``, it will now only update those cogs, not all cogs from the repo those cogs are from. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added error messages for failures when installing/reinstalling requirements and copying cogs and shared libraries. (`#2571 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2571>`_)
+- ``[p]findcog`` now uses sanitized urls (without HTTP Basic Auth fragments). (`#3129 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3129>`_)
+- ``[p]repo info`` will now show the repo's url, branch, and authors. (`#3225 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3225>`_)
+- ``[p]cog info`` will now show cog authors. (`#3225 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3225>`_)
+- ``[p]findcog`` will now show the repo's branch. (`#3225 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3225>`_)
+
+
+New Features
+~~~~~~~~~~~~
+
+- Added ``[p]repo update [repos]`` which updates repos without updating the cogs from them. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog installversion <repo_name> <revision> <cogs>`` which installs cogs from a specified revision (commit, tag) of the given repo. When using this command, the cog will automatically be pinned. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog pin <cogs>`` and ``[p]cog unpin <cogs>`` for pinning cogs. Cogs that are pinned will not be updated when using update commands. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog checkforupdates`` that lists which cogs can be updated (including pinned cog) without updating them. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog updateallfromrepos <repos>`` that updates all cogs from the given repos. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog updatetoversion <repo_name> <revision> [cogs]`` that updates all cogs or ones of user's choosing to chosen revision of the given repo. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Added ``[p]cog reinstallreqs`` that reinstalls cog requirements and shared libraries for all installed cogs. (`#3167 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3167>`_)
+
+
+Documentation Changes
+~~~~~~~~~~~~~~~~~~~~~
+
+- Added ``redbot.cogs.downloader.installable.InstalledModule`` to Downloader's framework docs. (`#2527 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2527>`_)
+- Removed API References for Downloader. (`#3234 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3234>`_)
+
+
+Image
+-----
+
+Enhancements
+~~~~~~~~~~~~
+
+- Updated the giphycreds command to match the formatting of the other API commands. (`#2905 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2905>`_)
+- Removed commas from explanations about how to set API keys. (`#2905 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2905>`_)
+
+
+Mod
+---
+
+Bug Fixes
+~~~~~~~~~
+
+- ``[p]userinfo`` no longer breaks when a user has an absurd numbers of roles. (`#2910 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2910>`_)
+- Fixed Mod cog not recording username changes for ``[p]names`` and ``[p]userinfo`` commands. (`#2918 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2918>`_)
+- Fixed ``[p]modset deletedelay`` deleting non-command messages. (`#2924 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2924>`_)
+- Fixed an error when reloading Mod. (`#2932 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2932>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Slowmode now accepts integer-only inputs as seconds. (`#2884 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2884>`_)
+
+
+Permissions
+-----------
+
+Bug Fixes
+~~~~~~~~~
+
+- Defaults are now cleared properly when clearing all rules. (`#3037 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3037>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Better explained the usage of commands with the ``<who_or_what>`` argument. (`#2991 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2991>`_)
+
+
+Streams
+-------
+
+Bug Fixes
+~~~~~~~~~
+
+- Fixed a ``TypeError`` in the ``TwitchStream`` class when calling Twitch client_id from Red shared APIs tokens. (`#3042 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3042>`_)
+- Changed the ``stream_alert`` function for Twitch alerts to make it work with how the ``TwitchStream`` class works now. (`#3042 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3042>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Removed commas from explanations about how to set API keys. (`#2905 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2905>`_)
+
+
+Trivia
+------
+
+Bug Fixes
+~~~~~~~~~
+
+- Fixed a typo in Ahsoka Tano's name in the Starwars trivia list. (`#2909 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2909>`_)
+- Fixed a bug where ``[p]trivia leaderboard`` failed to run. (`#2911 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2911>`_)
+- Fixed a typo in the Greek mythology trivia list regarding Hermes' staff. (`#2994 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2994>`_)
+- Fixed a question in the Overwatch trivia list that accepted blank responses. (`#2996 <https://github.com/Cog-Creators/Red-DiscordBot/issues/2996>`_)
+- Fixed questions and answers that were incorrect in the Clash Royale trivia list. (`#3236 <https://github.com/Cog-Creators/Red-DiscordBot/issues/3236>`_)
+
+
+Enhancements
+~~~~~~~~~~~~
+
+- Added trivia lists for Prince and Michael Jackson lyrics. (`#12 <https://github.com/Cog-Creators/Red-DiscordBot/issues/12>`_)

docs/changelog_3_3_0.rst

@@ -0,0 +1,910 @@
+.. 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)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`AnonGuy`, :ghuser:`Dav-Git`, :ghuser:`FancyJesse`, :ghuser:`Ianardo-DiCaprio`, :ghuser:`jack1142`, :ghuser:`kennnyshiwa`, :ghuser:`Kowlin`, :ghuser:`NeuroAssassin`, :ghuser:`PredaaA`, :ghuser:`Stonedestroyer`, :ghuser:`TrustyJAID`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Delete delay for command messages has been moved from Mod cog to Core (:issue:`3638`, :issue:`3636`)
+- 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 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`)
+
+Core Commands
+*************
+
+- ``[p]set game`` no longer errors when trying to clear the status (:issue:`3630`, :issue:`3628`)
+- All owner notifcations in Core now use proper prefixes in messages (:issue:`3632`)
+- Added ``[p]set playing`` and ``[p]set streaming`` aliases for respectively ``[p]set game`` and ``[p]set stream`` (:issue:`3646`, :issue:`3590`)
+
+ModLog
+******
+
+- Modlog's cases now keep last known username to prevent losing that information from case's message on edit (:issue:`3674`, :issue:`3443`)
+
+CustomCom
+*********
+
+- Added ``[p]cc search`` command that allows users to search through created custom commands (:issue:`2573`)
+
+Cleanup
+*******
+
+- Added ``[p]cleanup spam`` command that deletes duplicate messages from the last X messages and keeps only one copy (:issue:`3688`)
+- Removed regex support in ``[p]cleanup self`` (:issue:`3704`)
+
+Downloader
+**********
+
+- ``[p]cog checkforupdates`` now includes information about cogs that can't be installed due to Red/Python version requirements (:issue:`3678`, :issue:`3448`)
+
+General
+*******
+
+- Added more detailed mode to ``[p]serverinfo`` command that can be accessed with ``[p]serverinfo 1`` (:issue:`2382`, :issue:`3659`)
+
+Image
+*****
+
+- Users can now specify how many images should be returned in ``[p]imgur search`` and ``[p]imgur subreddit`` using ``[count]`` argument (:issue:`3667`, :issue:`3044`)
+- ``[p]imgur search`` and ``[p]imgur subreddit`` now return one image by default (:issue:`3667`, :issue:`3044`)
+
+Mod
+***
+
+- ``[p]userinfo`` now shows user's activities (:issue:`3669`)
+- ``[p]userinfo`` now shows status icon near the username (:issue:`3669`)
+- Muting no longer fails if user leaves while applying overwrite (:issue:`3627`)
+- Fixed error that happened when Mod cog was loaded for the first time during bot startup (:issue:`3632`, :issue:`3626`)
+
+Permissions
+***********
+
+- Commands for setting default rules now error when user tries to deny access to command designated as being always available (:issue:`3504`, :issue:`3465`)
+
+Streams
+*******
+
+- Fixed an error that happened when no game was set on Twitch stream (:issue:`3631`)
+- Preview picture for YouTube stream alerts is now bigger (:issue:`3689`, :issue:`3685`)
+- YouTube channels with a livestream that doesn't have any current viewer are now properly showing as streaming (:issue:`3690`)
+- Failures in Twitch API authentication are now logged (:issue:`3657`)
+
+Trivia
+******
+
+- Added ``[p]triviaset custom upload/delete/list`` commands for managing custom trivia lists from Discord (:issue:`3420`, :issue:`3307`)
+- Trivia sessions no longer error on payout when winner's balance would exceed max balance (:issue:`3666`, :issue:`3584`)
+
+Warnings
+********
+
+- Sending warnings to warned user can now be disabled with ``[p]warnset toggledm`` command (:issue:`2929`, :issue:`2800`)
+- Added ``[p]warnset warnchannel`` command that allows to set a channel where warnings should be sent to instead of the channel command was called in (:issue:`2929`, :issue:`2800`)
+- Added ``[p]warnset togglechannel`` command that allows to disable sending warn message in guild channel (:issue:`2929`, :issue:`2800`)
+- ``[p]warn`` now tells the moderator when bot wasn't able to send the warning to the user (:issue:`3653`, :issue:`3633`)
+
+
+Developer changelog
+-------------------
+
+Core Bot
+********
+
+- Deprecation warnings issued by Red now use correct stack level so that the cog developers can find the cause of them (:issue:`3644`)
+
+Dev Cog
+*******
+
+- Add ``__name__`` to environment's globals (:issue:`3649`, :issue:`3648`)
+
+
+Documentation changes
+---------------------
+
+- Fixed install instructions for Mac in `install_linux_mac` (:issue:`3675`, :issue:`3436`)
+- Windows install instructions now use ``choco upgrade`` commands instead of ``choco install`` to ensure up-to-date packages (:issue:`3684`)
+
+
+Miscellaneous
+-------------
+
+- **Core Bot** - Command errors (i.e. command on cooldown, dm-only and guild-only commands, etc) can now be translated (:issue:`3665`, :issue:`2988`)
+- **Core Bot** - ``redbot-setup`` now prints link to Getting started guide at the end of the setup (:issue:`3027`)
+- **Core Bot** - Whitelist and blacklist commands now properly require passing at least one user (or role in case of local whitelist/blacklist) (:issue:`3652`, :issue:`3645`)
+- **Downloader** - Fix misleading error appearing when repo name is already taken in ``[p]repo add`` (:issue:`3695`)
+- **Downloader** - Improved error messages for unexpected errors in ``[p]repo add`` (:issue:`3656`)
+- **Downloader** - Prevent encoding errors from crashing ``[p]cog update`` (:issue:`3639`, :issue:`3637`)
+- **Trivia** - Non-finite numbers can no longer be passed to ``[p]triviaset timelimit``, ``[p]triviaset stopafter`` and ``[p]triviaset payout`` (:issue:`3668`, :issue:`3583`)
+- **Utility Functions** - `redbot.core.utils.menus.menu()` now checks permissions *before* trying to clear reactions (:issue:`3589`, :issue:`3145`)
+
+
+Redbot 3.3.2 (2020-02-28)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`chasehult`, :ghuser:`Dav-Git`, :ghuser:`DiscordLiz`, :ghuser:`Drapersniper`, :ghuser:`fixator10`, :ghuser:`Flame442`, :ghuser:`Hedlund01`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`mikeshardmind`, :ghuser:`PredaaA`, :ghuser:`Stonedestroyer`, :ghuser:`trundleroo`, :ghuser:`TrustyJAID`, :ghuser:`zephyrkul`
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Ignored guilds/channels and whitelist/blacklist are now cached for performance (:issue:`3472`)
+- Ignored guilds/channels have been moved from Mod cog to Core (:issue:`3472`)
+- ``[p]ignore channel`` command can now also ignore channel categories (:issue:`3472`)
+
+Core Commands
+*************
+
+- Core cogs will now send bot mention prefix properly in places where discord doesn't render mentions (:issue:`3579`, :issue:`3591`, :issue:`3499`)
+- Fix a bug with ``[p]blacklist add`` that made it impossible to blacklist users that bot doesn't share a server with (:issue:`3472`, :issue:`3220`)
+- Improve user experience of ``[p]set game/listening/watching/`` commands (:issue:`3562`)
+- Add ``[p]licenceinfo`` alias for ``[p]licenseinfo`` command to conform with non-American English (:issue:`3460`)
+
+Admin
+*****
+
+- ``[p]announce`` will now only send error message if an actual errors occurs (:issue:`3514`, :issue:`3513`)
+
+Alias
+*****
+
+- ``[p]alias help`` will now properly work in non-English locales (:issue:`3546`)
+
+Audio
+*****
+
+- Users should be able to play age-restricted tracks from YouTube again (:issue:`3620`)
+
+Economy
+*******
+
+- Next payday time will now be adjusted for users when payday time is changed (:issue:`3496`, :issue:`3438`)
+
+Downloader
+**********
+
+- Downloader will no longer fail because of invalid ``info.json`` files (:issue:`3533`, :issue:`3456`)
+- Add better logging of errors when Downloader fails to add a repo (:issue:`3558`)
+
+Image
+*****
+
+- Fix load error for users that updated Red from version lower than 3.1 to version 3.2 or newer (:issue:`3617`)
+
+Mod
+***
+
+- ``[p]hackban`` and ``[p]unban`` commands support user mentions now (:issue:`3524`)
+- Ignored guilds/channels have been moved from Mod cog to Core (:issue:`3472`)
+
+Streams
+*******
+
+- Fix stream alerts for Twitch (:issue:`3487`)
+- Significantly reduce the quota usage for YouTube stream alerts (:issue:`3237`)
+- Add ``[p]streamset timer`` command which can be used to control how often the cog checks for live streams (:issue:`3237`)
+
+Trivia
+******
+
+- Add better handling for errors in trivia session (:issue:`3606`)
+
+Trivia Lists
+************
+
+- Remove empty answers in trivia lists (:issue:`3581`)
+
+Warnings
+********
+
+- Users can now pass a reason to ``[p]unwarn`` command (:issue:`3490`, :issue:`3093`)
+
+
+Developer changelog
+-------------------
+
+Core Bot
+********
+
+- Updated all our dependencies - we're using discord.py 1.3.2 now (:issue:`3609`)
+- Add traceback logging to task exception handling (:issue:`3517`)
+- Developers can now create a command from an async function wrapped in `functools.partial` (:issue:`3542`)
+- Bot will now show deprecation warnings in logs (:issue:`3527`, :issue:`3615`)
+- Subcommands of command group with ``invoke_without_command=True`` will again inherit this group's checks (:issue:`3614`)
+
+Config
+******
+
+- Fix Config's singletons (:issue:`3137`, :issue:`3136`)
+
+Utility Functions
+*****************
+
+- Add clearer error when page is of a wrong type in `redbot.core.utils.menus.menu()` (:issue:`3571`)
+
+Dev Cog
+*******
+
+- Allow for top-level `await`, `async for` and `async with` in ``[p]debug`` and ``[p]repl`` commands (:issue:`3508`)
+
+Downloader
+**********
+
+- Downloader will now replace ``[p]`` with clean prefix same as it does in help command (:issue:`3592`)
+- Add schema validation to ``info.json`` file processing - it should now be easier to notice any issues with those files (:issue:`3533`, :issue:`3442`)
+
+
+Documentation changes
+---------------------
+
+- Add guidelines for Cog Creators in `guide_cog_creation` document (:issue:`3568`)
+- Restructure virtual environment instructions to improve user experience (:issue:`3495`, :issue:`3411`, :issue:`3412`)
+- Getting started guide now explain use of quotes for arguments with spaces (:issue:`3555`, :issue:`3111`)
+- ``latest`` version of docs now displays a warning about possible differences from current stable release (:issue:`3570`)
+- Make systemd guide clearer on obtaining username and python path (:issue:`3537`, :issue:`3462`)
+- Indicate instructions for different venv types in systemd guide better (:issue:`3538`)
+- Service file in `autostart_systemd` now also waits for network connection to be ready (:issue:`3549`)
+- Hide alias of ``randomize_colour`` in docs (:issue:`3491`)
+- Add separate headers for each event predicate class for better navigation (:issue:`3595`, :issue:`3164`)
+- Improve wording of explanation for ``required_cogs`` key in `guide_publish_cogs` (:issue:`3520`)
+
+
+Miscellaneous
+-------------
+
+- Use more reliant way of checking if command is bot owner only in ``[p]warnaction`` (Warnings cog) (:issue:`3516`, :issue:`3515`)
+- Update PyPI domain in ``[p]info`` and update checker (:issue:`3607`)
+- Stop using deprecated code in core (:issue:`3610`)
+
+
+Redbot 3.3.1 (2020-02-05)
+=========================
+
+
+Core Bot
+--------
+
+- Add a cli flag for setting a max size of message cache
+- Allow to edit prefix from command line using ``redbot --edit``.
+- Some functions have been changed to no longer use deprecated asyncio functions
+
+Core Commands
+-------------
+
+- The short help text for dm has been made more useful
+- dm no longer allows owners to have the bot attempt to DM itself
+
+Utils
+-----
+
+- Passing the event loop explicitly in utils is deprecated (Removal in 3.4)
+
+Mod Cog
+-------
+
+- Hackban now works properly without being provided a number of days
+
+Documentation Changes
+---------------------
+
+- Add ``-e`` flag to ``journalctl`` command in systemd guide so that it takes the user to the end of logs automatically.
+- Added section to install docs for CentOS 8
+- Improve usage of apt update in docs
+
+Redbot 3.3.0 (2020-01-26)
+=========================
+
+Core Bot
+--------
+
+- The bot's description is now configurable.
+- We now use discord.py 1.3.1, this comes with added teams support.
+- The commands module has been slightly restructured to provide more useful data to developers.
+- Help is now self consistent in the extra formatting used.
+
+Core Commands
+-------------
+
+- Slowmode should no longer error on nonsensical time quantities.
+- Embed use can be configured per channel as well.
+
+Documentation
+-------------
+
+- We've made some small fixes to inaccurate instructions about installing with pyenv.
+- Notes about deprecating in 3.3 have been altered to 3.4 to match the intended timeframe.
+
+Admin
+-----
+
+- Gives feedback when adding or removing a role doesn't make sense.
+
+Audio
+-----
+
+- Playlist finding is more intuitive.
+- disconnect and repeat commands no longer interfere with eachother.
+
+CustomCom
+---------
+
+- No longer errors when exiting an interactive menu.
+
+Cleanup
+-------
+
+- A rare edge case involving messages which are deleted during cleanup and are the only message was fixed.
+
+Downloader
+----------
+
+- Some user facing messages were improved.
+- Downloader's initialization can no longer time out at startup.
+
+General
+-------
+
+- Roll command will no longer attempt to roll obscenely large amounts.
+
+Mod
+---
+
+- You can set a default amount of days to clean up when banning.
+- Ban and hackban now use that default.
+- Users can now optionally be DMed their ban reason.
+
+Permissions
+-----------
+
+- Now has stronger enforcement of prioritizing botwide settings.

docs/changelog_3_4_0.rst

@@ -0,0 +1,782 @@
+.. 3.4.x Changelogs
+
+Redbot 3.4.7 (2021-02-26)
+=========================
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`elijabesu`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`kreusada`, :ghuser:`palmtree5`, :ghuser:`TrustyJAID`
+
+End-user changelog
+------------------
+
+- Added proper permission checks to ``[p]muteset senddm`` and ``[p]muteset showmoderator`` (:issue:`4849`)
+- Updated the ``[p]lmgtfy`` command to use the new domain (:issue:`4840`)
+- Updated the ``[p]info`` command to more clearly indicate that the instance is owned by a team (:issue:`4851`)
+- Fixed minor issues with error messages in Mutes cog (:issue:`4847`, :issue:`4850`, :issue:`4853`)
+
+Documentation changes
+---------------------
+
+- Added `cog guide for General cog <cog_guides/trivia>` (:issue:`4797`)
+- Added `cog guide for Trivia cog <cog_guides/trivia>` (:issue:`4566`)
+
+
+Redbot 3.4.6 (2021-02-16)
+=========================
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`aleclol`, :ghuser:`Andeeeee`, :ghuser:`bobloy`, :ghuser:`BreezeQS`, :ghuser:`Danstr5544`, :ghuser:`Dav-Git`, :ghuser:`Elysweyr`, :ghuser:`Fabian-Evolved`, :ghuser:`fixator10`, :ghuser:`Flame442`, :ghuser:`Injabie3`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`kreusada`, :ghuser:`leblancg`, :ghuser:`maxbooiii`, :ghuser:`NeuroAssassin`, :ghuser:`phenom4n4n`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`retke`, :ghuser:`siu3334`, :ghuser:`Strafee`, :ghuser:`TheWyn`, :ghuser:`TrustyJAID`, :ghuser:`Vexed01`, :ghuser:`yamikaitou`
+
+Read before updating
+--------------------
+
+1. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+    Red 3.4.6 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.3.2.3_1199>`__.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Fixed the rotation of Red's logs that could before result in big disk usage (:issue:`4405`, :issue:`4738`)
+- Fixed command usage in the help messages for few commands in Red (:issue:`4599`, :issue:`4733`)
+- Fixed errors in ``[p]command defaultdisablecog`` and ``[p]command defaultenablecog`` commands (:issue:`4767`, :issue:`4768`)
+- ``[p]command listdisabled guild`` can no longer be run in DMs (:issue:`4771`, :issue:`4772`)
+- Improvements and fixes for our new (colorful) logging (:issue:`4702`, :issue:`4726`)
+
+    - The colors used have been adjusted to be readable on many more terminal applications
+    - The ``NO_COLOR`` environment variable can now be set to forcefully disable all colors in the console output
+    - Tracebacks will now use the full width of the terminal again
+    - Tracebacks no longer contain multiple lines per stack level (this can now be changed with the flag ``-rich-traceback-extra-lines``)
+    - Disabled syntax highlighting on the log messages
+    - Dev cog no longer captures logging output
+    - Added some cool features for developers
+
+        - Added the flag ``--rich-traceback-extra-lines`` which can be used to set the number of additional lines in tracebacks
+        - Added the flag ``--rich-traceback-show-locals`` which enables showing local variables in tracebacks
+
+    - Improved and fixed a few other minor things
+
+- Added a friendly error message to ``[p]load`` that is shown when trying to load a cog with a command name that is already taken by a different cog (:issue:`3870`)
+- Help now includes command aliases in the command help (:issue:`3040`)
+
+    - This can be disabled with ``[p]helpset showaliases`` command
+
+- Fixed errors appearing when using Ctrl+C to interrupt ``redbot --edit`` (:issue:`3777`, :issue:`4572`)
+
+Admin
+*****
+
+- ``[p]selfrole`` can now be used without a subcommand and passed with a selfrole directly to add/remove it from the user running the command (:issue:`4826`)
+
+Audio
+*****
+
+- Improved detection of embed players for fallback on age-restricted YT tracks (:issue:`4818`, :issue:`4819`)
+- Improved MP4/AAC decoding (:issue:`4818`, :issue:`4819`)
+- Requests for YT tracks are now retried if the initial request causes a connection reset (:issue:`4818`, :issue:`4819`)
+
+Cleanup
+*******
+
+- Renamed the ``[p]cleanup spam`` command to ``[p]cleanup duplicates``, with the old name kept as an alias for the time being (:issue:`4814`)
+- Fixed an error from passing an overly large integer as a message ID to ``[p]cleanup after`` and ``[p]cleanup before`` (:issue:`4791`)
+
+Dev Cog
+*******
+
+- Help descriptions of the cog and its commands now get translated properly (:issue:`4815`)
+
+Economy
+*******
+
+- ``[p]economyset rolepaydayamount`` can now remove the previously set payday amount (:issue:`4661`, :issue:`4758`)
+
+Filter
+******
+
+- Added a case type ``filterhit`` which is used to log filter hits (:issue:`4676`, :issue:`4739`)
+
+Mod
+***
+
+- The ``[p]tempban`` command no longer errors out when trying to ban a user in a guild with the vanity url feature that doesn't have a vanity url set (:issue:`4714`)
+- Fixed an edge case in role hierarchy checks (:issue:`4740`)
+- Added two new settings for disabling username and nickname tracking (:issue:`4799`)
+
+    - Added a command ``[p]modset trackallnames`` that disables username tracking and overrides the nickname tracking setting for all guilds
+    - Added a command ``[p]modset tracknicknames`` that disables nickname tracking in a specific guild
+
+- Added a command ``[p]modset deletenames`` that deletes all stored usernames and nicknames (:issue:`4827`)
+- Added usage examples to ``[p]kick``, ``[p]ban``, ``[p]massban``, and ``[p]tempban`` (:issue:`4712`, :issue:`4715`)
+- Updated DM on kick/ban to use bot's default embed color (:issue:`4822`)
+
+Modlog
+******
+
+- Added a command ``[p]listcases`` that allows you to see multiple cases for a user at once (:issue:`4426`)
+- Added typing indicator to ``[p]casesfor`` command (:issue:`4426`)
+
+Mutes
+*****
+
+- Fixed an edge case in role hierarchy checks (:issue:`4740`)
+- The modlog reason no longer contains leading whitespace when it's passed *after* the mute time (:issue:`4749`)
+- A DM can now be sent to the (un)muted user on mute and unmute (:issue:`3752`, :issue:`4563`)
+
+    - Added ``[p]muteset senddm`` to set whether the DM should be sent (function disabled by default)
+    - Added ``[p]muteset showmoderator`` to set whether the DM sent to the user should include the name of the moderator that muted the user (function disabled by default)
+
+- Added more role hierarchy checks to ensure permission escalations cannot occur on servers with a careless configuration (:issue:`4741`)
+- Help descriptions of the cog and its commands now get translated properly (:issue:`4815`)
+
+Reports
+*******
+
+- Reports now use the default embed color of the bot (:issue:`4800`)
+
+Streams
+*******
+
+- Fixed incorrect timezone offsets for some YouTube stream schedules (:issue:`4693`, :issue:`4694`)
+- Fixed meaningless errors happening when the YouTube API key becomes invalid or when the YouTube quota is exceeded (:issue:`4745`)
+
+Trivia
+******
+
+- Payout for trivia sessions ending in a tie now gets split between all the players with the highest score (:issue:`3931`, :issue:`4649`)
+
+Trivia Lists
+************
+
+- Added new Who's That Pokémon - Gen. VI trivia list (:issue:`4785`)
+- Updated answers regarding some of the hero's health and abilities in the ``overwatch`` trivia list (:issue:`4805`)
+
+
+Developer changelog
+-------------------
+
+Core Bot
+********
+
+- Updated versions of the libraries used in Red: discord.py to 1.6.0, aiohttp to 3.7.3 (:issue:`4728`)
+- Added an event ``on_red_before_identify`` that is dispatched before IDENTIFYing a session (:issue:`4647`)
+
+Utility Functions
+*****************
+
+- Added a function `redbot.core.utils.chat_formatting.spoiler()` that wraps the given text in a spoiler (:issue:`4754`)
+
+Dev Cog
+*******
+
+- Cogs can now add their own variables to the environment of ``[p]debug``, ``[p]eval``, and ``[p]repl`` commands (:issue:`4667`)
+
+    - Variables can be added and removed from the environment of Dev cog using two new methods:
+
+        - `bot.add_dev_env_value() <RedBase.add_dev_env_value()>`
+        - `bot.remove_dev_env_value() <RedBase.remove_dev_env_value()>`
+
+
+Documentation changes
+---------------------
+
+- Added `cog guide for Filter cog <cog_guides/filter>` (:issue:`4579`)
+- Added information about the Red Index to `guide_publish_cogs` (:issue:`4778`)
+- Restructured the host list (:issue:`4710`)
+- Clarified how to use pm2 with ``pyenv virtualenv`` (:issue:`4709`)
+- Updated the pip command for Red with the postgres extra in `install_linux_mac` document to work on zsh shell (:issue:`4697`)
+- Updated Python version in ``pyenv`` and Windows instructions (:issue:`4770`)
+
+
+Miscellaneous
+-------------
+
+- Various grammar fixes (:issue:`4705`, :issue:`4748`, :issue:`4750`, :issue:`4763`, :issue:`4788`, :issue:`4792`, :issue:`4810`)
+- Red's dependencies have been bumped (:issue:`4572`)
+
+
+Redbot 3.4.5 (2020-12-24)
+=========================
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`Injabie3`, :ghuser:`NeuroAssassin`
+
+End-user changelog
+------------------
+
+Streams
+*******
+
+- Fixed Streams failing to load and work properly (:issue:`4687`, :issue:`4688`)
+
+
+Redbot 3.4.4 (2020-12-24)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`bobloy`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`kreus7`, :ghuser:`NeuroAssassin`, :ghuser:`npc203`, :ghuser:`palmtree5`, :ghuser:`phenom4n4n`, :ghuser:`Predeactor`, :ghuser:`retke`, :ghuser:`siu3334`, :ghuser:`Vexed01`, :ghuser:`yamikaitou`
+
+Read before updating
+--------------------
+
+1. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+    Red 3.4.4 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.3.2.2_1170>`__.
+
+2. Ubuntu 16.04 is no longer supported as it will soon reach its end of life and it is no longer viable for us to maintain support for it.
+
+    While you might still be able to run Red on it, we will no longer put any resources into supporting it. If you're using Ubuntu 16.04, we highly recommend that you upgrade to the latest LTS version of Ubuntu.
+
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Red's logging will now shine in your terminal more than ever (:issue:`4577`)
+- Improved consistency of command usage in the help messages within all commands in Core Red (:issue:`4589`)
+- Added a friendly error when the duration provided to commands that use the ``commands.TimedeltaConverter`` converter is out of the maximum bounds allowed by Python interpreter (:issue:`4019`, :issue:`4628`, :issue:`4630`)
+- Fixed an error when removing path from a different operating system than the bot is currently running on with ``[p]removepath`` (:issue:`2609`, :issue:`4662`, :issue:`4466`)
+
+Audio
+*****
+
+- Fixed ``[p]llset java`` failing to set the Java executable path (:issue:`4621`, :issue:`4624`)
+- Fixed Soundcloud playback (:issue:`4683`)
+- Fixed YouTube age-restricted track playback (:issue:`4683`)
+- Added more friendly messages for 429 errors to let users know they have been temporarily banned from accessing the service instead of a generic Lavalink error (:issue:`4683`)
+- Environment information will now be appended to Lavalink tracebacks in the spring.log (:issue:`4683`)
+
+Cleanup
+*******
+
+- ``[p]cleanup self`` will now delete the command message when the bot has permissions to do so (:issue:`4640`)
+
+Dev
+***
+
+- Added new ``[p]bypasscooldown`` command that allows owners to bypass command cooldowns (:issue:`4440`)
+
+Economy
+*******
+
+- ``[p]economyset slotmin`` and ``[p]economyset slotmax`` now warn when the new value will cause the slots command to not work (:issue:`4583`)
+
+General
+*******
+
+- Updated features list in ``[p]serverinfo`` with the latest changes from Discord (:issue:`4678`)
+
+Mod
+***
+
+- ``[p]ban`` command will no longer error out when the given reason is too long (:issue:`4187`, :issue:`4189`)
+
+Streams
+*******
+
+- Scheduled YouTube streams now work properly with the cog (:issue:`3691`, :issue:`4615`)
+- YouTube stream schedules are now announced before the stream (:issue:`4615`)
+
+    - Alerts about YouTube stream schedules can be disabled with a new ``[p]streamset ignoreschedule`` command (:issue:`4615`)
+
+- Improved error logging (:issue:`4680`)
+
+Trivia Lists
+************
+
+- Added ``whosthatpokemon5`` trivia list containing Pokémon from the 5th generation (:issue:`4646`)
+- Added ``geography`` trivia list (:issue:`4618`)
+
+
+Developer changelog
+-------------------
+
+- `get_audit_reason()` can now be passed a ``shorten`` keyword argument which will automatically shorten the returned audit reason to fit the max length allowed by Discord audit logs (:issue:`4189`)
+- ``bot.remove_command()`` now returns the command object of the removed command as does the equivalent method from `discord.ext.commands.Bot` class (:issue:`4636`)
+
+
+Documentation changes
+---------------------
+
+- Added `cog guide for Downloader cog <cog_guides/downloader>` (:issue:`4511`)
+- Added `cog guide for Economy cog <cog_guides/economy>` (:issue:`4519`)
+- Added `cog guide for Streams cog <cog_guides/streams>` (:issue:`4521`)
+- Added `guide_cog_creators` document (:issue:`4637`)
+- Removed install instructions for Ubuntu 16.04 (:issue:`4650`)
+
+
+Redbot 3.4.3 (2020-11-16)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`bobloy`, :ghuser:`Flame442`, :ghuser:`jack1142`, :ghuser:`KianBral`, :ghuser:`maxbooiii`, :ghuser:`phenom4n4n`, :ghuser:`Predeactor`, :ghuser:`retke`
+
+Read before updating
+--------------------
+
+1. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+    Red 3.4.3 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.3.1.4_1132>`__.
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Added ``[p]set competing`` command that allows users to set the bot's competing status (:issue:`4607`, :issue:`4609`)
+
+Audio
+*****
+
+- Volume changes on ARM systems running a 64 bit OS will now work again (:issue:`4608`)
+- Fixed only 100 results being returned on a Youtube playlist (:issue:`4608`)
+- Fixed YouTube VOD duration being set to unknown (:issue:`3885`, :issue:`4608`)
+- Fixed some YouTube livestreams getting stuck (:issue:`4608`)
+- Fixed internal Lavalink manager failing for Java with untypical version formats (:issue:`4608`)
+- Improved AAC audio handling (:issue:`4608`)
+- Added support for SoundCloud HLS streams (:issue:`4608`)
+
+Economy
+*******
+
+- The ``[p]leaderboard`` command no longer fails in DMs when a global bank is used (:issue:`4569`)
+
+Mod
+***
+
+- The ban reason is now properly set in the audit log and modlog when using the ``[p]massban`` command (:issue:`4575`)
+- The ``[p]userinfo`` command now shows the new Competing activity (:issue:`4610`, :issue:`4611`)
+
+Modlog
+******
+
+- The ``[p]case`` and ``[p]casesfor`` commands no longer fail when the bot doesn't have Read Message History permission in the modlog channel (:issue:`4587`, :issue:`4588`)
+
+Mutes
+*****
+
+- Fixed automatic remuting on member join for indefinite mutes (:issue:`4568`)
+
+Trivia
+******
+
+- ``[p]triviaset custom upload`` now ensures that the filename is lowercase when uploading (:issue:`4594`)
+
+Developer changelog
+-------------------
+
+- ``modlog.get_case()`` and methods using it no longer raise when the bot doesn't have Read Message History permission in the modlog channel (:issue:`4587`, :issue:`4588`)
+
+Documentation changes
+---------------------
+
+- Added `guide for Cog Manager UI <cogmanagerui>` (:issue:`4152`)
+- Added `cog guide for CustomCommands cog <customcommands>` (:issue:`4490`)
+
+
+Redbot 3.4.2 (2020-10-28)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`aikaterna`, :ghuser:`Drapersniper`, :ghuser:`jack1142`, :ghuser:`Kowlin`, :ghuser:`PredaaA`, :ghuser:`Stonedestroyer`
+
+Read before updating
+--------------------
+
+1. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+    Red 3.4.2 uses a new Lavalink jar that you will need to manually update from `our GitHub <https://github.com/Cog-Creators/Lavalink-Jars/releases/tag/3.3.1.4_1128>`__.
+
+End-user changelog
+------------------
+
+- **Core Bot** - Added info about the metadata file to ``redbot --debuginfo`` (:issue:`4557`)
+- **Audio** - Fixed the ``[p]local search`` command (:issue:`4553`)
+- **Audio** - Fixed random "Something broke when playing the track." errors for YouTube tracks (:issue:`4559`)
+- **Audio** - Commands in ``[p]llset`` group can now be used in DMs (:issue:`4562`)
+- **Mod** - Fixed ``[p]massban`` not working for banning members that are in the server (:issue:`4556`, :issue:`4555`)
+- **Streams** - Added error messages when exceeding the YouTube quota in the Streams cog (:issue:`4552`)
+- **Streams** - Improved logging for unexpected errors in the Streams cog (:issue:`4552`)
+
+Documentation changes
+---------------------
+
+- Added `cog guide for Cleanup cog <cleanup>` (:issue:`4488`)
+- Removed multi-line commands from `install_linux_mac` to avoid confusing readers (:issue:`4550`)
+
+
+Redbot 3.4.1 (2020-10-27)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`absj30`, :ghuser:`aikaterna`, :ghuser:`bobloy`, :ghuser:`chloecormier`, :ghuser:`Dav-Git`, :ghuser:`Drapersniper`, :ghuser:`fixator10`, :ghuser:`Flame442`, :ghuser:`flaree`, :ghuser:`Generaleoley`, :ghuser:`hisztendahl`, :ghuser:`jack1142`, :ghuser:`KaiGucci`, :ghuser:`Kowlin`, :ghuser:`maxbooiii`, :ghuser:`MeatyChunks`, :ghuser:`NeuroAssassin`, :ghuser:`nfitzen`, :ghuser:`palmtree5`, :ghuser:`phenom4n4n`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`PythonTryHard`, :ghuser:`SharkyTheKing`, :ghuser:`Stonedestroyer`, :ghuser:`thisisjvgrace`, :ghuser:`TrustyJAID`, :ghuser:`TurnrDev`, :ghuser:`Vexed01`, :ghuser:`Vuks69`, :ghuser:`xBlynd`, :ghuser:`zephyrkul`
+
+Read before updating
+--------------------
+
+1. This release fixes a security issue in Mod cog. See `Security changelog below <important-341-2>` for more information.
+2. This Red update bumps discord.py to version 1.5.1, which explicitly requests Discord intents. Red requires all Privileged Intents to be enabled. More information can be found at :ref:`enabling-privileged-intents`.
+3. Mutes functionality has been moved from the Mod cog to a new separate cog (Mutes) featuring timed and role-based mutes. If you were using it (or want to start now), you can load the new cog with ``[p]load mutes``. You can see the full `Mutes changelog below <important-341-1>`.
+4. Information for Audio users that are using an external Lavalink instance (if you don't know what that is, you should skip this point):
+
+   We've updated our `application.yml file <https://github.com/Cog-Creators/Red-DiscordBot/blob/3.4.1/redbot/cogs/audio/data/application.yml>`__ and you should update your instance's ``application.yml`` appropriately.
+   Please ensure that the WS port in Audio's settings (``[p]llset wsport``) is set to the port from the ``application.yml``.
+
+End-user changelog
+------------------
+
+.. _important-341-2:
+
+Security
+********
+
+**NOTE:** If you can't update immediately, we recommend globally disabling the affected command until you can.
+
+- **Mod** - Fixed unauthorized privilege escalation exploit in ``[p]massban`` (also called ``[p]hackban``) command. Full security advisory `can be found on our GitHub <https://github.com/Cog-Creators/Red-DiscordBot/security/advisories/GHSA-mp9m-g7qj-6vqr>`__.
+
+Core Bot
+********
+
+- Fixed an incorrect error being reported on ``[p]set name`` when the passed name was longer than 32 characters (:issue:`4364`, :issue:`4363`)
+- Fixed ``[p]set nickname`` erroring when the passed name was longer than 32 characters (:issue:`4364`, :issue:`4363`)
+- Fixed an ungraceful error being raised when running ``[p]traceback`` with closed DMs (:issue:`4329`)
+- Fixed errors that could arise from invalid URLs in ``[p]set avatar`` (:issue:`4437`)
+- Fixed an error being raised with ``[p]set nickname`` when no nickname was provided (:issue:`4451`)
+- Fixed and clarified errors being raised with ``[p]set username`` (:issue:`4463`)
+- Fixed an ungraceful error being raised when the output of ``[p]unload`` is larger than 2k characters (:issue:`4469`)
+- Fixed an ungraceful error being raised when running ``[p]choose`` with empty options (:issue:`4499`)
+- Fixed an ungraceful error being raised when a bot left a guild while a menu was open (:issue:`3902`)
+- Fixed info missing on the non-embed version of ``[p]debuginfo`` (:issue:`4524`)
+- Added ``[p]set api list`` to list all currently set API services, without tokens (:issue:`4370`)
+- Added ``[p]set api remove`` to remove API services, including tokens (:issue:`4370`)
+- Added ``[p]helpset usetick``, toggling command message being ticked when help is sent to DM (:issue:`4467`, :issue:`4075`)
+- Added a default color field to ``[p]set showsettings`` (:issue:`4498`, :issue:`4497`)
+- Added the datapath and metadata file to ``[p]debuginfo`` (:issue:`4524`)
+- Added a list of disabled intents to ``[p]debuginfo`` (:issue:`4423`)
+- Bumped discord.py dependency to version 1.5.1 (:issue:`4423`)
+- Locales and regional formats can now be set in individual guilds using ``[p]set locale`` and ``[p]set regionalformat`` (:issue:`3896`, :issue:`1970`)
+
+    - Global locale and regional format setters have been renamed to ``[p]set globallocale`` and ``[p]set globalregionalformat``
+
+Audio
+*****
+
+- Scattered grammar and typo fixes (:issue:`4446`)
+- Fixed Bandcamp playback (:issue:`4504`)
+- Fixed YouTube playlist playback (:issue:`4504`)
+- Fixed YouTube searching issues (:issue:`4504`)
+- Fixed YouTube age restricted track playback (:issue:`4504`)
+- Fixed the Audio cog not being translated when setting locale (:issue:`4492`, :issue:`4495`)
+- Fixed tracks getting stuck at 0:00 after long player sessions (:issue:`4529`)
+- Removed lavalink logs from being added to backup (:issue:`4453`, :issue:`4452`)
+- Removed stream durations from being in queue duration (:issue:`4513`)
+- Added the Global Audio API, to cut down on Youtube 429 errors and allow Spotify playback past user's quota. (:issue:`4446`)
+- Added persistent queues, allowing for queues to be restored on a bot restart or cog reload (:issue:`4446`)
+- Added ``[p]audioset restart``, allowing for Lavalink connection to be restarted (:issue:`4446`)
+- Added ``[p]audioset autodeafen``, allowing for bot to auto-deafen itself when entering voice channel (:issue:`4446`)
+- Added ``[p]audioset mycountrycode``, allowing Spotify search locale per user (:issue:`4446`)
+- Added ``[p]llsetup java``, allowing for a custom Java executable path (:issue:`4446`)
+- Added ``[p]llset info`` to show Lavalink settings (:issue:`4527`)
+- Added ``[p]audioset logs`` to download Lavalink logs if the Lavalink server is set to internal (:issue:`4527`)
+
+Cleanup
+*******
+
+- Allowed ``[p]cleanup self`` to work in DMs for all users (:issue:`4481`)
+
+Custom Commands
+***************
+
+- Fixed an ungraceful error being thrown on ``[p]cc edit`` (:issue:`4325`)
+
+Dev
+***
+
+- Added ``[p]repl pause`` to pause/resume the REPL session in the current channel (:issue:`4366`)
+
+Economy
+*******
+
+- Added an embed option for ``[p]leaderboard`` (:issue:`4184`, :issue:`4104`)
+
+General
+*******
+
+- Fixed issues with text not being properly URL encoded (:issue:`4024`)
+- Fixed an ungraceful error occurring when a title is longer than 256 characters in ``[p]urban`` (:issue:`4474`)
+- Changed "boosters" to "boosts" in ``[p]serverinfo`` to clarify what the number represents (:issue:`4507`)
+
+Mod
+***
+
+- Added ``[p]modset mentionspam strict`` allowing for duplicated mentions to count towards the mention spam cap (:issue:`4359`)
+- Added an option to ban users not in the guild to ``[p]ban`` (:issue:`4422`, :issue:`4419`)
+- Added a default tempban duration for ``[p]tempban`` (:issue:`4473`, :issue:`3992`)
+- Fixed nicknames not being properly stored and logged (:issue:`4131`)
+- Fixed plural typos in ``[p]userinfo`` (:issue:`4397`, :issue:`4379`)
+- Renamed ``[p]hackban`` to ``[p]massban``, keeping ``[p]hackban`` as an alias, allowing for multiple users to be banned at once (:issue:`4422`, :issue:`4419`)
+- Moved mutes to a separate, individual cog (:issue:`3634`)
+
+.. _important-341-1:
+
+Mutes
+*****
+
+- Added ``[p]muteset forcerole`` to make mutes role based, instead of permission based (:issue:`3634`)
+- Added an optional time argument to all mutes, to specify when the user should be unmuted (:issue:`3634`)
+- Changed ``[p]mute`` to only handle serverwide muting, ``[p]mute voice`` and ``[p]mute channel`` have been moved to separate commands called ``[p]mutechannel`` and ``[p]mutevoice`` (:issue:`3634`)
+- Mute commands can now take multiple user arguments, to mute multiple users at a time (:issue:`3634`)
+
+Modlog
+******
+
+- Fixed an error being raised when running ``[p]casesfor`` and ``[p]case`` (:issue:`4415`)
+- Long reasons in Modlog are now properly shortened in message content (:issue:`4541`)
+
+Trivia Lists
+************
+
+- Fixed incorrect order of Machamp and Machoke questions (:issue:`4424`)
+- Added new MLB trivia list (:issue:`4455`)
+- Added new Who's That Pokémon - Gen. IV trivia list (:issue:`4434`)
+- Added new Hockey trivia list (:issue:`4384`)
+
+Warnings
+********
+
+- Fixed users being able to warn users above them in hierarchy (:issue:`4100`)
+- Added bool arguments to toggle commands to improve consistency (:issue:`4409`)
+
+Developer changelog
+-------------------
+
+| **Important:**
+| 1. Red now allows users to set locale per guild, which requires 3rd-party cogs to set contextual locale manually in code ran outside of command's context. See the `Core Bot changelog below <important-dev-341-1>` for more information.
+
+.. _important-dev-341-1:
+
+Core Bot
+********
+
+- Added API for setting contextual locales (:issue:`3896`, :issue:`1970`)
+
+    - New function added: `redbot.core.i18n.set_contextual_locales_from_guild()`
+    - Contextual locale is automatically set for commands and only needs to be done manually for things like event listeners; see `recommendations-for-cog-creators` for more information
+
+- Added `bot.remove_shared_api_services() <RedBase.remove_shared_api_services()>` to remove all keys and tokens associated with an API service (:issue:`4370`)
+- Added an option to return all tokens for an API service if ``service_name`` is not specified in `bot.get_shared_api_tokens() <RedBase.get_shared_api_tokens()>` (:issue:`4370`)
+- Added `bot.get_or_fetch_user() <RedBase.get_or_fetch_user()>` and `bot.get_or_fetch_member() <RedBase.get_or_fetch_member()>` methods (:issue:`4403`, :issue:`4402`)
+- Moved ``redbot.core.checks.bot_in_a_guild()`` to `redbot.core.commands.bot_in_a_guild()` (old name has been left as an alias) (:issue:`4515`, :issue:`4510`)
+
+Bank
+****
+
+- Bank API methods now consistently throw TypeError if a non-integer amount is supplied (:issue:`4376`)
+
+Mod
+***
+
+- Deprecated ``redbot.core.utils.mod.is_allowed_by_hierarchy`` (:issue:`4435`)
+
+Modlog
+******
+
+- Added an option to accept a ``discord.Object`` in case creation (:issue:`4326`)
+- Added ``last_known_username`` parameter to `modlog.create_case()` function (:issue:`4326`)
+- Fixed an error being raised with a deleted channel in `Case.message_content()` (:issue:`4415`)
+
+Utility
+*******
+
+- Added `redbot.core.utils.get_end_user_data_statement()` and `redbot.core.utils.get_end_user_data_statement_or_raise()` to attempt to fetch a cog's End User Data Statement (:issue:`4404`)
+- Added `redbot.core.utils.chat_formatting.quote()` to quote text in a message (:issue:`4425`)
+
+Documentation changes
+---------------------
+
+Config
+******
+
+- Added custom group documentation and tutorial (:issue:`4416`, :issue:`2896`)
+
+Modlog
+******
+
+- Clarified that naive ``datetime`` objects will be treated as local times for parameters ``created_at`` and ``until`` in `modlog.create_case()` (:issue:`4389`)
+
+Other
+*****
+
+- Added guide to creating a Bot Application in Discord Developer Portal, with enabling intents (:issue:`4502`)
+
+Miscellaneous
+-------------
+
+- Added JSON schema files for ``info.json`` files (:issue:`4375`)
+- Added ``[all]`` and ``[dev]`` bundled install extras (:issue:`4443`)
+- Replaced the link to the approved repository list on CogBoard and references to ``cogs.red`` with a link to new Red Index (:issue:`4439`)
+- Improved documentation about arguments in command syntax (:issue:`4058`)
+- Replaced a few instances of Red with the bot name in command docstrings (:issue:`4470`)
+- Fixed grammar in places scattered throughout bot (:issue:`4500`)
+- Properly define supported Python versions to be lower than 3.9 (:issue:`4538`)
+
+
+Redbot 3.4.0 (2020-08-17)
+=========================
+
+| Thanks to all these amazing people that contributed to this release:
+| :ghuser:`Dav-Git`, :ghuser:`DevilXD`, :ghuser:`douglas-cpp`, :ghuser:`Drapersniper`, :ghuser:`flaree`, :ghuser:`jack1142`, :ghuser:`kablekompany`, :ghuser:`Kowlin`, :ghuser:`maxbooiii`, :ghuser:`MeatyChunks`, :ghuser:`mikeshardmind`, :ghuser:`NeuroAssassin`, :ghuser:`PredaaA`, :ghuser:`Predeactor`, :ghuser:`retke`, :ghuser:`SharkyTheKing`, :ghuser:`thisisjvgrace`, :ghuser:`Tinonb`, :ghuser:`TrustyJAID`, :ghuser:`Twentysix26`, :ghuser:`Vexed01`, :ghuser:`zephyrkul`
+|
+| **Read before updating**:
+| 1. Red 3.4 comes with support for data deletion requests. Bot owners should read `red_core_data_statement` to ensure they know what information about their users is stored by the bot.
+| 2. Debian Stretch, Fedora 30 and lower, and OpenSUSE Leap 15.0 and lower are no longer supported as they have already reached end of life.
+| 3. There's been a change in behavior of ``[p]tempban``. Look at `Mod changelog <important-340-1>` for full details.
+| 4. There's been a change in behavior of announcements in Admin cog. Look at `Admin changelog <important-340-2>` for full details.
+| 5. Red 3.4 comes with breaking changes for cog developers. Look at `Developer changelog <important-340-3>` for full details.
+
+End-user changelog
+------------------
+
+Core Bot
+********
+
+- Added per-guild cog disabling (:issue:`4043`, :issue:`3945`)
+
+    - Bot owners can set the default state for a cog using ``[p]command defaultdisablecog`` and ``[p]command defaultenablecog`` commands
+    - Guild owners can enable/disable cogs for their guild using ``[p]command disablecog`` and ``[p]command enablecog`` commands
+    - Cogs disabled in the guild can be listed with ``[p]command listdisabledcogs``
+
+- Added support for data deletion requests; see `red_core_data_statement` for more information (:issue:`4045`)
+- Red now logs clearer error if it can't find package to load in any cog path during bot startup (:issue:`4079`)
+- ``[p]licenseinfo`` now has a 3 minute cooldown to prevent a single user from spamming channel by using it (:issue:`4110`)
+- Added ``[p]helpset showsettings`` command (:issue:`4013`, :issue:`4022`)
+- Updated Red's emoji usage to ensure consistent rendering accross different devices (:issue:`4106`, :issue:`4105`, :issue:`4127`)
+- Whitelist and blacklist are now called allowlist and blocklist. Old names have been left as aliases (:issue:`4138`)
+
+.. _important-340-2:
+
+Admin
+*****
+
+- ``[p]announce`` will now only send announcements to guilds that have explicitly configured text channel to send announcements to using ``[p]announceset channel`` command (:issue:`4088`, :issue:`4089`)
+
+Downloader
+**********
+
+- ``[p]cog info`` command now shows end user data statement made by the cog creator (:issue:`4169`)
+- ``[p]cog update`` command will now notify the user if cog's end user data statement has changed since last update (:issue:`4169`)
+
+.. _important-340-1:
+
+Mod
+***
+
+- ``[p]tempban`` now respects default days setting (``[p]modset defaultdays``) (:issue:`3993`)
+- Users can now set mention spam triggers which will warn or kick the user. See ``[p]modset mentionspam`` for more information (:issue:`3786`, :issue:`4038`)
+- ``[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`)
+
+ModLog
+******
+
+- Added timestamp to text version of ``[p]casesfor`` and ``[p]case`` commands (:issue:`4118`, :issue:`4137`)
+
+Streams
+*******
+
+- Stream alerts will no longer make roles temporarily mentionable if bot has "Mention @everyone, @here, and All Roles" permission in the channel (:issue:`4182`)
+- Mixer service has been closed and for that reason we've removed support for it from the cog (:issue:`4072`)
+- Hitbox commands have been renamed to smashcast (:issue:`4161`)
+- 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`)
+
+.. _important-340-3:
+
+Developer changelog
+-------------------
+
+| **Important:**
+| 1. Red now offers cog disabling API, which should be respected by 3rd-party cogs in guild-related actions happening outside of command's context. See the `Core Bot changelog below <important-dev-340-1>` for more information.
+| 2. Red now provides data request API, which should be supported by all 3rd-party cogs. See the changelog entries in the `Core Bot changelog below <important-dev-340-1>` for more information.
+
+Breaking changes
+****************
+
+- By default, none of the ``.send()`` methods mention roles or ``@everyone/@here`` (:issue:`3845`)
+
+    - see `discord.AllowedMentions` and ``allowed_mentions`` kwarg of ``.send()`` methods, if your cog requires to mention roles or ``@everyone/@here``
+
+- `Context.maybe_send_embed()` now supresses all mentions, including user mentions (:issue:`4192`)
+- The default value of the ``filter`` keyword argument has been changed to ``None`` (:issue:`3845`)
+- Cog package names (i.e. name of the folder the cog is in and the name used when loading the cog) now have to be `valid Python identifiers <https://docs.python.org/3/reference/lexical_analysis.html#identifiers>`__ (:issue:`3605`, :issue:`3679`)
+- Method/attribute names starting with ``red_`` or being in the form of ``__red_*__`` are now reserved. See `version_guarantees` for more information (:issue:`4085`)
+- `humanize_list()` no longer raises `IndexError` for empty sequences (:issue:`2982`)
+- Removed things past deprecation time: (:issue:`4163`)
+
+    - ``redbot.core.commands.APIToken``
+    - ``loop`` kwarg from `bounded_gather_iter()`, `bounded_gather()`, and `start_adding_reactions()`
+
+.. _important-dev-340-1:
+
+Core Bot
+********
+
+- Added cog disabling API (:issue:`4043`, :issue:`3945`)
+
+    - New methods added: `bot.cog_disabled_in_guild() <RedBase.cog_disabled_in_guild()>`, `bot.cog_disabled_in_guild_raw() <RedBase.cog_disabled_in_guild_raw()>`
+    - Cog disabling is automatically applied for commands and only needs to be done manually for things like event listeners; see `recommendations-for-cog-creators` for more information
+
+- Added data request API (:issue:`4045`,  :issue:`4169`)
+
+    - New special methods added to `commands.Cog`: `red_get_data_for_user()` (documented provisionally), `red_delete_data_for_user()`
+    - New special module level variable added: ``__red_end_user_data_statement__``
+    - These methods and variables should be added by all cogs according to their documentation; see `recommendations-for-cog-creators` for more information
+    - New ``info.json`` key added: ``end_user_data_statement``; see `Info.json format documentation <info-json-format>` for more information
+
+- Added `bot.message_eligible_as_command() <RedBase.message_eligible_as_command()>` utility method which can be used to determine if a message may be responded to as a command (:issue:`4077`)
+- Added a provisional API for replacing the help formatter. See `documentation <framework-commands-help>` for more details (:issue:`4011`)
+- `bot.ignored_channel_or_guild() <RedBase.ignored_channel_or_guild()>` now accepts `discord.Message` objects (:issue:`4077`)
+- `commands.NoParseOptional <NoParseOptional>` is no longer provisional and is now fully supported part of API (:issue:`4142`)
+- Red no longer fails to run subcommands of a command group allowed or denied by permission hook (:issue:`3956`)
+- Autohelp in group commands is now sent *after* invoking the group, which allows before invoke hooks to prevent autohelp from getting triggered (:issue:`4129`)
+- RPC functionality no longer makes Red hang for a minute on shutdown (:issue:`4134`, :issue:`4143`)
+
+Vendored packages
+*****************
+
+- Updated ``discord.ext.menus`` vendor (:issue:`4167`)
+
+Utility Functions
+*****************
+
+- `humanize_list()` now accepts ``locale`` and ``style`` keyword arguments. See its documentation for more information (:issue:`2982`)
+- `humanize_list()` is now properly localized (:issue:`2906`, :issue:`2982`)
+- `humanize_list()` now accepts empty sequences (:issue:`2982`)
+
+
+Documentation changes
+---------------------
+
+- Removed install instructions for Debian Stretch (:issue:`4099`)
+- Added admin user guide (:issue:`3081`)
+- Added alias user guide (:issue:`3084`)
+- Added bank user guide (:issue:`4149`)
+
+
+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`)
+- ``[p]set nickname``, ``[p]set serverprefix``, ``[p]streamalert``, and ``[p]streamset`` commands now can be run by users with permissions related to the actions they're making (:issue:`4109`)
+- `bordered()` now uses ``+`` for corners if keyword argument ``ascii_border`` is set to `True` (:issue:`4097`)
+- Fixed timestamp storage in few places in Red (:issue:`4017`)

docs/cog_customcom.rst

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

docs/cog_downloader.rst

@@ -1,9 +0,0 @@
-.. Downloader Cog Reference
-
-Downloader Cog Reference
-========================
-
-.. automodule:: redbot.cogs.downloader
-
-.. autoclass:: redbot.cogs.downloader.downloader.Downloader
-    :members:

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 she joins) and announcements, which
+will 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.
+
+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.
+
+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.
+
+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.
+
+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.
+
+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.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,537 @@
+.. _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 26-Cogs defender``
+    - ``[p]cog uninstall Laggrons-Dumb-Cogs 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 a repo and its files.
+
+Example:
+    - ``[p]repo delete 26-Cogs``
+
+**Arguments**
+
+- ``<repo>`` The name of an already added repo
+
+.. _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,214 @@
+.. _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 [choices...]
+
+**Description**
+
+Choose between multiple options.
+
+.. note:: To denote options which include whitespace, you should use
+    double quotes.
+
+**Arguments**
+
+* ``[choices...]``: The arguments for Red to randomly choose from.
+
+.. _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/streams.rst

@@ -0,0 +1,553 @@
+.. _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
+- Smashcast
+- 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.
+
+For example: ``[p]streamset message mention {mention}, {stream} 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.
+
+For example: ``[p]streamset message nomention {stream} 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-smashcast:
+
+^^^^^^^^^
+smashcast
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]smashcast <channel_name>
+
+**Description**
+
+Check if a Smashcast channel is live.
+
+**Arguments**
+
+* ``<channel_name>``: The Smashcast channel to check.
+
+.. _streams-command-twitchstream:
+
+^^^^^^^^^^^^
+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-smashcast:
+
+^^^^^^^^^^^^^^^^^^^^^
+streamalert smashcast
+^^^^^^^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+    
+    [p]streamalert smashcast <channel_name>
+
+**Description**
+
+Toggle alerts in the current channel for the 
+specified Smashcast channel.
+
+**Arguments**
+
+* ``<channel_name>``: The Smashcast channel to toggle the alert for.
+
+.. _streams-command-streamalert-twitch-channel:
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+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,434 @@
+.. _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.
+
+.. _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/conf.py

@@ -36,6 +36,7 @@ os.environ["BUILDING_DOCS"] = "1"
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
@@ -57,7 +58,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Red - Discord Bot"
-copyright = "2018, Cog Creators"
+copyright = "2018-2021, Cog Creators"
 author = "Cog Creators"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -65,6 +66,7 @@ author = "Cog Creators"
 # built documents.
 #
 from redbot.core import __version__
+from discord import __version__ as dpy_version
 
 # The short X.Y version.
 version = __version__
@@ -92,6 +94,12 @@ todo_include_todos = False
 # Role which is assigned when you make a simple reference within backticks
 default_role = "any"
 
+# Includes substitutions for all files
+with open("prolog.txt", "r") as file:
+    rst_prolog = file.read()
+
+# Adds d.py version to available substitutions in all files
+rst_prolog += f"\n.. |DPY_VERSION| replace:: {dpy_version}"
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -100,9 +108,6 @@ default_role = "any"
 #
 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.
@@ -199,6 +204,7 @@ texinfo_documents = [
 # A list of regular expressions that match URIs that should not be
 # checked when doing a linkcheck build.
 linkcheck_ignore = [r"https://java.com*", r"https://chocolatey.org*"]
+linkcheck_retries = 3
 
 
 # -- Options for extensions -----------------------------------------------
@@ -206,8 +212,18 @@ linkcheck_ignore = [r"https://java.com*", r"https://chocolatey.org*"]
 # Intersphinx
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "dpy": ("https://discordpy.readthedocs.io/en/v1.0.1/", None),
+    "dpy": (f"https://discordpy.readthedocs.io/en/v{dpy_version}/", None),
     "motor": ("https://motor.readthedocs.io/en/stable/", None),
+    "babel": ("http://babel.pocoo.org/en/stable/", None),
+}
+
+# Extlinks
+# This allows to create links to d.py docs with
+# :dpy_docs:`link text <site_name.html>`
+extlinks = {
+    "dpy_docs": (f"https://discordpy.readthedocs.io/en/v{dpy_version}/%s", None),
+    "issue": ("https://github.com/Cog-Creators/Red-DiscordBot/issues/%s", "#"),
+    "ghuser": ("https://github.com/%s", "@"),
 }
 
 # Doctest
@@ -216,5 +232,5 @@ intersphinx_mapping = {
 doctest_test_doctest_blocks = ""
 
 # Autodoc options
-autodoc_default_flags = ["show-inheritance"]
+autodoc_default_options = {"show-inheritance": True}
 autodoc_typehints = "none"

docs/framework_apikeys.rst

@@ -6,7 +6,7 @@ Shared API Keys
 
 Red has a central API key storage utilising the core bots config. This allows cog creators to add a single location to store API keys for their cogs which may be shared between other cogs.
 
-There needs to be some consistency between cog creators when using shared API keys between cogs. To help make this easier service should be all **lowercase** and the key names should match the naming convetion of the API being accessed. 
+There needs to be some consistency between cog creators when using shared API keys between cogs. To help make this easier service should be all **lowercase** and the key names should match the naming convention of the API being accessed.
 
 Example:
 
@@ -18,7 +18,7 @@ and when accessed in the code it should be done by
 
 .. code-block:: python
 
-    await self.bot.db.api_tokens.get_raw("twitch", default={"client_id": None, "client_secret": None})
+    await self.bot.get_shared_api_tokens("twitch")
 
 Each service has its own dict of key, value pairs for each required key type. If there's only one key required then a name for the key is still required for storing and accessing.
 
@@ -30,7 +30,7 @@ and when accessed in the code it should be done by
 
 .. code-block:: python
 
-    await self.bot.db.api_tokens.get_raw("youtube", default={"api_key": None})
+    await self.bot.get_shared_api_tokens("youtube")
 
 
 ***********
@@ -42,7 +42,36 @@ Basic Usage
     class MyCog:
         @commands.command()
         async def youtube(self, ctx, user: str):
-            apikey = await self.bot.db.api_tokens.get_raw("youtube", default={"api_key": None})
-            if apikey["api_key"] is None:
+            youtube_keys = await self.bot.get_shared_api_tokens("youtube")
+            if youtube_keys.get("api_key") is None:
                 return await ctx.send("The YouTube API key has not been set.")
             # Use the API key to access content as you normally would
+
+
+***************
+Event Reference
+***************
+
+.. function:: on_red_api_tokens_update(service_name, api_tokens)
+
+    Dispatched when service's api keys are updated.
+
+    :param service_name: Name of the service.
+    :type service_name: :class:`str`
+    :param api_tokens: New Mapping of token names to tokens. This contains api tokens that weren't changed too.
+    :type api_tokens: Mapping[:class:`str`, :class:`str`]
+
+
+*********************
+Additional References
+*********************
+
+.. py:currentmodule:: redbot.core.bot
+
+.. automethod:: Red.get_shared_api_tokens
+
+.. 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

@@ -7,14 +7,23 @@ Commands Package
 This package acts almost identically to :doc:`discord.ext.commands <dpy:ext/commands/api>`; i.e.
 all of the attributes from discord.py's are also in ours. 
 Some of these attributes, however, have been slightly modified, while others have been added to
-extend functionlities used throughout the bot, as outlined below.
+extend functionalities used throughout the bot, as outlined below.
 
 .. autofunction:: redbot.core.commands.command
 
 .. 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
 
 .. autoclass:: redbot.core.commands.Group
     :members:
@@ -22,5 +31,33 @@ extend functionlities used throughout the bot, as outlined below.
 .. autoclass:: redbot.core.commands.Context
     :members:
 
+.. autoclass:: redbot.core.commands.GuildContext
+
+.. autoclass:: redbot.core.commands.DMContext
+
 .. automodule:: redbot.core.commands.requires
     :members: PrivilegeLevel, PermState, Requires
+
+.. automodule:: redbot.core.commands.converter
+    :members:
+    :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

@@ -11,6 +11,9 @@ Config was introduced in V3 as a way to make data storage easier and safer for a
 It will take some getting used to as the syntax is entirely different from what Red has used before, but we believe
 Config will be extremely beneficial to both cog developers and end users in the long run.
 
+.. note:: While config is great for storing data safely, there are some caveats to writing performant code which uses it.
+          Make sure to read the section on best practices for more of these details.
+
 ***********
 Basic Usage
 ***********
@@ -18,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)
 
@@ -49,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)
 
@@ -65,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 = {
@@ -185,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={}
             )
 
@@ -226,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.
@@ -238,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::
 
@@ -254,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.
@@ -271,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!")
@@ -282,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)
 
@@ -297,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
@@ -307,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."
@@ -343,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):
@@ -364,6 +469,30 @@ much the same way they would in V2. The following examples will demonstrate how
         await cog.load_data()
         bot.add_cog(cog)
 
+************************************
+Best practices and performance notes
+************************************
+
+Config prioritizes being a safe data store without developers needing to
+know how end users have configured their bot. 
+
+This does come with some performance costs, so keep the following in mind when choosing to
+develop using config
+
+* Config use in events should be kept minimal and should only occur
+  after confirming the event needs to interact with config
+
+* Caching frequently used things, especially things used by events, 
+  results in faster and less event loop blocking code.
+
+* Only use config's context managers when you intend to modify data.
+
+* While config is a great general use option, it may not always be the right one for you. 
+  As a cog developer, even though config doesn't require one,
+  you can choose to require a database or store to something such as an sqlite
+  database stored within your cog's datapath.
+
+
 *************
 API Reference
 *************
@@ -380,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
@@ -416,20 +545,25 @@ Value
 Driver Reference
 ****************
 
-.. automodule:: redbot.core.drivers
+.. autofunction:: redbot.core.drivers.get_driver
+
+.. autoclass:: redbot.core.drivers.BackendType
+    :members:
+
+.. autoclass:: redbot.core.drivers.ConfigCategory
     :members:
 
 Base Driver
 ^^^^^^^^^^^
-.. autoclass:: redbot.core.drivers.red_base.BaseDriver
+.. autoclass:: redbot.core.drivers.BaseDriver
     :members:
 
 JSON Driver
 ^^^^^^^^^^^
-.. autoclass:: redbot.core.drivers.red_json.JSON
+.. autoclass:: redbot.core.drivers.JsonDriver
     :members:
 
-Mongo Driver
-^^^^^^^^^^^^
-.. autoclass:: redbot.core.drivers.red_mongo.Mongo
+Postgres Driver
+^^^^^^^^^^^^^^^
+.. autoclass:: redbot.core.drivers.PostgresDriver
     :members:

docs/framework_downloader.rst

@@ -1,90 +0,0 @@
-.. downloader framework reference
-
-Downloader Framework
-====================
-
-Info.json
-*********
-
-The optional info.json file may exist inside every package folder in the repo, 
-as well as in the root of the repo. The following sections describe the valid 
-keys within an info file (and maybe how the Downloader cog uses them).
-
-Keys common to both repo and cog info.json (case sensitive)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- ``author`` (list of strings) - list of names of authors of the cog or repo.
-
-- ``description`` (string) - A long description of the cog or repo. For cogs, this 
-  is displayed when a user executes ``!cog info``.
-
-- ``install_msg`` (string) - The message that gets displayed when a cog 
-  is installed or a repo is added
-  
-  .. tip:: You can use the ``[p]`` key in your string to use the prefix
-      used for installing.
-
-- ``short`` (string) - A short description of the cog or repo. For cogs, this info 
-  is displayed when a user executes ``!cog list``
-
-Keys specific to the cog info.json (case sensitive)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- ``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``,
-  if ``min_bot_version`` is newer than ``max_bot_version``, ``max_bot_version`` will be ignored
-
-- ``hidden`` (bool) - Determines if a cog is visible in the cog list for a repo.
-
-- ``disabled`` (bool) - Determines if a cog is available for install.
-
-- ``required_cogs`` (map of cogname to repo URL) - A map of required cogs that this cog depends on.
-  Downloader will not deal with this functionality but it may be useful for other cogs.
-
-- ``requirements`` (list of strings) - list of required libraries that are
-  passed to pip on cog install. ``SHARED_LIBRARIES`` do NOT go in this
-  list.
-
-- ``tags`` (list of strings) - A list of strings that are related to the
-  functionality of the cog. Used to aid in searching.
-
-- ``type`` (string) - Optional, defaults to ``COG``. Must be either ``COG`` or
-  ``SHARED_LIBRARY``. If ``SHARED_LIBRARY`` then ``hidden`` will be ``True``.
-
-API Reference
-*************
-
-.. automodule:: redbot.cogs.downloader.json_mixins
-
-.. autoclass RepoJSONMixin
-    :members
-
-.. automodule:: redbot.cogs.downloader.installable
-
-Installable
-^^^^^^^^^^^
-
-.. autoclass:: Installable
-    :members:
-
-.. automodule:: redbot.cogs.downloader.repo_manager
-
-Repo
-^^^^
-
-.. autoclass:: Repo
-    :members:
-
-Repo Manager
-^^^^^^^^^^^^
-
-.. autoclass:: RepoManager
-    :members:
-
-Exceptions
-^^^^^^^^^^
-
-.. automodule:: redbot.cogs.downloader.errors
-    :members:
-

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_modlog.rst

@@ -25,7 +25,7 @@ Basic Usage
         async def ban(self, ctx, user: discord.Member, reason: str = None):
             await ctx.guild.ban(user)
             case = await modlog.create_case(
-                ctx.bot, ctx.guild, ctx.message.created_at, action="ban",
+                ctx.bot, ctx.guild, ctx.message.created_at, action_type="ban",
                 user=user, moderator=ctx.author, reason=reason
             )
             await ctx.send("Done. It was about time.")
@@ -57,9 +57,6 @@ it from your setup function:
                 "default_setting": True,
                 "image": "\N{HAMMER}",
                 "case_str": "Ban",
-                # audit_type should be omitted if the action doesn't show
-                # up in the audit log.
-                "audit_type": "ban",
             }
             try:
                 await modlog.register_casetype(**ban_case)
@@ -73,14 +70,12 @@ it from your setup function:
                     "default_setting": True,
                     "image": "\N{BUST IN SILHOUETTE}\N{HAMMER}",
                     "case_str": "Hackban",
-                    "audit_type": "ban",
                 },
                 {
                     "name": "kick",
                     "default_setting": True,
                     "image": "\N{WOMANS BOOTS}",
                     "case_str": "Kick",
-                    "audit_type": "kick"
                 }
             ]
             await modlog.register_casetypes(new_types)

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
 ===============
@@ -21,6 +33,7 @@ Embed Helpers
 
 .. automodule:: redbot.core.utils.embed
     :members:
+    :exclude-members: randomize_color
 
 Reaction Menus
 ==============
@@ -31,7 +44,16 @@ Reaction Menus
 Event Predicates
 ================
 
-.. automodule:: redbot.core.utils.predicates
+MessagePredicate
+****************
+
+.. autoclass:: redbot.core.utils.predicates.MessagePredicate
+    :members:
+
+ReactionPredicate
+*****************
+
+.. autoclass:: redbot.core.utils.predicates.ReactionPredicate
     :members:
 
 Mod Helpers

docs/getting_started.rst

@@ -0,0 +1,350 @@
+.. don't forget to set permissions hyperlink
+  + commands links + guide links
+
+.. _getting-started:
+
+===============
+Getting started
+===============
+
+If you recently installed Red, you should read this.
+This is a quick start guide for a general usage.
+
+.. note::
+
+    If you haven't installed Red, please do it by following
+    the :ref:`installation guides <main>`.
+
+Assuming you correctly installed Red, you should have a
+window like this:
+
+.. image:: .resources/red-console.png
+
+.. _gettings-started-invite:
+
+-------------------------
+Invite Red to your server
+-------------------------
+
+When started, the console will show you ``Invite URL`` (here at
+the bottom of the screenshot).
+Paste the link into your browser and select the server you want
+to invite the bot in, like any other bot.
+
+.. note:: You need the ``Manage server`` permission to add bots.
+
+Complete the captcha, it should tell you ``Authorized!`` and you
+should see your bot in the members list.
+
+.. attention::
+    If Discord shows ``Bot requires code grant``, please untick this
+    option in your token settings
+
+    .. image:: .resources/code-grant.png
+
+.. _getting-started-interact:
+
+-----------------
+Interact with Red
+-----------------
+
+As a chatbot, you interact with Red via the Discord text channels
+(not from the command prompt). To send commands to the bot, you will have to
+use the prefix you set before, followed by the command you want to use. For
+example, if your prefix is ``!``, you will execute your command like this:
+``!ping``.
+
+.. note:: Since the prefix can be anything, it'll be referenced as ``[p]``
+    in documentations.
+
+.. _getting-started-commands:
+
+~~~~~~~~~~~~
+The commands
+~~~~~~~~~~~~
+
+The command you're going to use the most is help. That command will
+show you **all of the available commands** of the bot with a small description.
+
+.. code-block:: none
+
+    [p]help
+
+.. tip:: The message is generated dynamically and users will only see the
+    commands they can use. You can change what commands users can use with the
+    permissions cog.
+
+You can also pick a command to get its detailed description and the
+parameters.
+
+.. code-block:: none
+
+    [p]help command
+
+.. note::
+    Arguments enclosed in ``< >`` are **required** for the command to work.
+
+    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 ``=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):
+
+.. code-block:: none
+
+    [p]help YourCategory
+
+Help also shows **command groups**. They are group of commands.
+To get the description of a subcommand, type this:
+
+.. code-block:: none
+
+    [p]help commandgroup subcommand
+
+When using subcommands, you also need to specify the command group.
+As an example, ``cleanup`` has 6 subcommands. If you want
+to use one, do it like this: ``[p]cleanup messages 10``
+
+.. _getting-started-cogs:
+
+----
+Cogs
+----
+
+Red is built with cogs, a fancy term for plugins. They are
+modules that add functionality to Red. They contain
+commands to use.
+
+Red comes with 19 cogs containing the basic features, such
+as moderation, utility, music, streams...
+
+You can see your loaded and unloaded cogs with the ``[p]cogs``
+command. By default, all cogs will be unloaded.
+
+You can load or unload a cog by using the load or unload command
+
+.. code-block:: none
+
+    [p]load cogname
+    [p]unload cogname
+
+.. tip:: You can load and unload multiple cogs at once:
+
+    .. code-block:: none
+
+        [p]load cog1 cog2 ...
+
+You can enable and disable everything you want, which means you can
+customize Red how you want!
+
+.. _getting-started-community-cogs:
+
+~~~~~~~~~~~~~~
+Community cogs
+~~~~~~~~~~~~~~
+
+There's an entire `community <https://discord.gg/red>`_ that contributes
+to Red. Those contributors make additional cogs for you to use. You can
+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 `<https://index.discord.red>`_. Find whatever you want,
+there are hundreds of cogs available!
+
+.. 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``
+cog from the repository ``Laggrons-Dumb-Cogs``. You'll first need
+to add the repository.
+
+.. code-block:: none
+
+    [p]repo add Laggrons-Dumb-Cogs https://github.com/retke/Laggrons-Dumb-Cogs
+
+.. note:: You may need to specify a branch. If so, add its name after the link.
+
+Then you can install the cog
+
+.. code-block:: none
+
+    [p]cog install Laggrons-Dumb-Cogs say
+
+Now the cog is installed, but not loaded. You can load it using the ``[p]load``
+command we talked about before.
+
+.. _getting-started-permissions:
+
+-----------
+Permissions
+-----------
+
+Red works with different levels of permissions. Every cog defines
+the level of permission needed for a command.
+
+~~~~~~~~~
+Bot owner
+~~~~~~~~~
+
+The bot owner can access all commands on every guild. They can also use
+exclusive commands that can interact with the global settings
+or system files.
+
+*You* are the owner by default.
+
+~~~~~~~~~~~~
+Server owner
+~~~~~~~~~~~~
+
+The server owner can access all commands on his guild, except the global
+ones or those who can interact with system files (available for the
+bot owner).
+
+~~~~~~~~~~~~~
+Administrator
+~~~~~~~~~~~~~
+
+The administrator is defined by its roles. You can set multiple admin roles
+with the ``[p]set addadminrole`` and ``[p]set removeadminrole`` commands.
+
+For example, in the mod cog, an admin can use the ``[p]modset`` command
+which defines the cog settings.
+
+~~~~~~~~~
+Moderator
+~~~~~~~~~
+
+A moderator is a step above the average users. You can set multiple moderator
+roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands.
+
+For example, in the mod cog (again), a mod will be able to mute, kick and ban;
+but he won't be able to modify the cog settings with the ``[p]modset`` command.
+
+.. tip::
+    If you don't like the default permission settings for some commands or
+    if want to restrict a cog or a command to a channel/member, you can use
+    the permissions cog.
+
+.. _getting-started-hosting:
+
+-------
+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.
+
+You can try to host Red somewhere she 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.
+
+.. warning::
+    Before trying to host Red on a Linux environment, you need to know the
+    basics of the Unix commands, such as navigating the system files or use
+    a terminal text editor.
+
+    You should follow `this guide
+    <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
+    from DigitalOcean which will introduce you to the Linux basics.
+
+1. **Find a host**
+
+  You need to find a server to host Red. You can rent a VPS (it can be free)
+  on an online service. Please check :ref:`this page <host-list>` for
+  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.
+
+2. **Install Linux**
+
+  Most of the VPS providers have tools for installing Linux automatically. If
+  you're a beginner, we recommend **Ubuntu 20.04 LTS**.
+
+  For Raspberry Pi users, just install `Raspbian
+  <https://www.raspberrypi.org/software/>`_ on a micro-SD card.
+
+2.1. **Log in**
+
+  .. note:: This section is for those who have an online server. If you have
+    a local Linux machine, just open the terminal and skip to the next part.
+
+  As we said before, a VPS is controlled through command line. You will have to
+  connect to your VPS through a protocol called SSH.
+
+  .. image:: .resources/instances-ssh-button.png
+
+  On your host page (here, it is Google Cloud), find the SSH button and click on
+  it. You will be connected to your server with command line. You should see
+  something like this.
+
+  .. image:: .resources/ssh-output.png
+
+  .. note:: Don't forget to type the command ``logout`` to close the SSH properly.
+
+3. **Install and set up Red**
+
+  Just follow one of the Linux installation guide. We provide guides for the
+  most used distributions. Check the :ref:`home page <main>` and search for
+  your distribution.
+
+4. **Set up an auto-restart**
+
+  Once you got Red running on your server, it will still shut down if you close
+  the window. You can set up an auto-restarting system that will create a
+  side task and handle fatal errors, so you can just leave your server running
+  and enjoy Red!
+
+  For that, just follow :ref:`this guide <systemd-service-guide>`.
+
+.. _getting-started-userdocs:
+
+------------------
+User documentation
+------------------
+
+You will soon start using the Red core cogs. A detailed documentation is
+available for every core cog, under the :ref:`How to use <main>` section.
+
+The cog guides are formatted the same. They're divided into 3 sections:
+
+* **Guide**
+
+  This will introduce you to the cog and explain you how it works.
+
+* **Commands**
+
+  A list of the available commands, with details and arguments.
+  Each command guide will be formatted like this:
+
+  * **Syntax**
+
+    A line that will show how the command must be invoked, with the arguments.
+
+    .. tip:: If the command show something like ``[lavalinkset|llset]``, that means
+        you can invoke the command with ``lavalinkset`` or with ``llset``, this is
+        called an alias.
+
+  * **Description**
+
+    A detailed description of what the command does, with details about how
+    it must be used.
+
+  * **Arguments**
+
+    A list of all arguments needed (or not) for the command, with more details.

docs/guide_cog_creation.rst

@@ -3,9 +3,9 @@
 .. role:: python(code)
     :language: python
 
-====================
-Creating cogs for V3
-====================
+========================
+Creating cogs for Red V3
+========================
 
 This guide serves as a tutorial on creating cogs for Red V3.
 It will cover the basics of setting up a package for your
@@ -17,10 +17,33 @@ you in the process.
 Getting started
 ---------------
 
-To start off, be sure that you have installed Python 3.7.
-Open a terminal or command prompt and type :code:`pip install -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=redbot[test]`
-(note that if you get an error with this, try again but put :code:`python -m` in front of the command
-This will install the latest version of V3.
+To start off, be sure that you have installed Python 3.8.
+Next, you need to decide if you want to develop against the Stable or Develop version of Red.
+Depending on what your goal is should help determine which version you need.
+
+.. attention::
+    The Develop version may have changes on it which break compatibility with the Stable version and other cogs.
+    If your goal is to support both versions, make sure you build compatibility layers or use separate branches to keep compatibility until the next Red release
+
+Open a terminal or command prompt and type one of the following
+    Stable Version: :code:`python3.8 -m pip install -U Red-DiscordBot`
+
+.. note::
+
+  To install the development version, replace ``Red-DiscordBot`` in the above commands with the
+  link below. **The development version of the bot contains experimental changes. It is not
+  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.
+
+  .. code-block:: none
+
+      git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
+
+
+(Windows users may need to use :code:`py -3.8` or :code:`python` instead of :code:`python3.8`)
 
 --------------------
 Setting up a package
@@ -35,6 +58,20 @@ a text editor or IDE (examples include `Sublime Text 3 <https://www.sublimetext.
 `Visual Studio Code <https://code.visualstudio.com/>`_, `Atom <https://atom.io/>`_, and
 `PyCharm <http://www.jetbrains.com/pycharm/>`_).
 
+.. attention:: 
+    While you can intentionally override Red's cogs/extensions, this may break things.
+    We would prefer if people wanted custom behavior
+    for any core cog/extension, an issue and/or PR is made
+    Overriding Permissions specifically is dangerous.
+
+    Subclassing to make changes to Red's cogs/extensions
+    may not be a safe way to stay up to date either,
+    as changes to cogs and their interactions with red
+    are not guaranteed to not be breaking.
+
+    Any cogs doing this are doing so at their own risk,
+    and should also inform users of associated risks.
+
 --------------
 Creating a cog
 --------------
@@ -61,6 +98,7 @@ Open :code:`__init__.py`. In that file, place the following:
 
     from .mycog import Mycog
 
+
     def setup(bot):
         bot.add_cog(Mycog())
 
@@ -74,7 +112,7 @@ To test your cog, you will need a running instance of V3.
 Assuming you installed V3 as outlined above, run :code:`redbot-setup`
 and provide the requested information. Once that's done, run Red
 by doing :code:`redbot <instance name> --dev` to start Red.
-Complete the inital setup by providing a valid token and setting a
+Complete the initial setup by providing a valid token and setting a
 prefix. Once the bot has started up, use the link provided in the
 console to add it to a server (note that you must have the
 :code:`Manage Server` (or :code:`Administrator`) permission to add bots
@@ -85,6 +123,45 @@ to the directory where your cog package is located. In Discord, do
 The bot should respond with :code:`I can do stuff!`. If it did, you
 have successfully created a cog!
 
+.. note:: **Package/Folder layout**
+
+    You must make sure you structure your local path correctly or 
+    you get an error about missing the setup function. As cogs are 
+    considered packages, they are each contained within separate folders.
+    The folder you need to add using :code:`[p]addpath` is the parent
+    folder of these package folders. Below is an example
+
+    .. code-block:: none
+
+        - D:\
+        -- red-env
+        -- red-data
+        -- red-cogs
+        ---- mycog
+        ------ __init__.py
+        ------ mycog.py
+        ---- coolcog
+        ------ __init__.py
+        ------ coolcog.py
+    
+    You would then use :code:`[p]addpath D:\red-cogs` to add the path
+    and then you can use :code:`[p]load mycog` or :code:`[p]load coolcog`
+    to load them
+    
+    You can also take a look at `our cookiecutter <https://github.com/Cog-Creators/cog-cookiecutter>`_, for help creating the right structure.
+
+-------------------
+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
 --------------------

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.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_migration.rst

@@ -3,11 +3,11 @@
 .. role:: python(code)
     :language: python
 
-====================
-Migrating Cogs to V3
-====================
+==========================
+Migrating cogs from Red V2
+==========================
 
-First, be sure to read `discord.py's migration guide <https://discordpy.readthedocs.io/en/v1.0.1/migrating.html>`_
+First, be sure to read :dpy_docs:`discord.py's migration guide <migrating.html>`
 as that covers all of the changes to discord.py that will affect the migration process
 
 ----------------

docs/guide_publish_cogs.rst

@@ -0,0 +1,97 @@
+.. Publishing cogs for V3
+
+Publishing cogs for Red V3
+==========================
+
+Users of Red install 3rd-party cogs using Downloader cog. To make your cog available
+to install for others, you will have to create a git repository
+and publish it on git repository hosting (for example `GitHub <https://github.com>`_)
+
+Repository Template
+-------------------
+
+We have standardized what a repository's structure should look like to better assist
+our Downloader system and provide essential information to the Red portal.
+
+The main repository should contain at a minimum:
+
+ - :ref:`An info.json file <info-json-format>`
+ - One folder for each cog package in the repository
+
+   - refer to :doc:`/guide_cog_creation` for information on how to create a valid cog package
+   - you should also put :ref:`info.json file <info-json-format>` inside each cog folder
+
+We also recommend adding a license and README file with general information about the repository.
+
+For a simple example of what this might look like when finished,
+take a look at `our example template <https://github.com/Cog-Creators/Applications>`_.
+
+.. _info-json-format:
+
+Info.json format
+----------------
+
+The optional info.json file may exist inside every package folder in the repo, 
+as well as in the root of the repo. The following sections describe the valid 
+keys within an info file (and maybe how the Downloader cog uses them).
+
+Keys common to both repo and cog info.json (case sensitive)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- ``author`` (list of strings) - list of names of authors of the cog or repo.
+
+- ``description`` (string) - A long description of the cog or repo. For cogs, this 
+  is displayed when a user executes ``[p]cog info``.
+
+- ``install_msg`` (string) - The message that gets displayed when a cog 
+  is installed or a repo is added
+  
+  .. tip:: You can use the ``[p]`` key in your string to use the prefix
+      used for installing.
+
+- ``short`` (string) - A short description of the cog or repo. For cogs, this info 
+  is displayed when a user executes ``[p]cog list``
+
+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``,
+  if ``min_bot_version`` is newer than ``max_bot_version``, ``max_bot_version`` will be ignored
+
+- ``min_python_version`` (list of integers) - Min version number of Python
+  in the format ``[MAJOR, MINOR, PATCH]``
+
+- ``hidden`` (bool) - Determines if a cog is visible in the cog list for a repo.
+
+- ``disabled`` (bool) - Determines if a cog is available for install.
+
+- ``required_cogs`` (dict mapping a cog name to repo URL) - A dict of required cogs that this cog depends on
+  in the format ``{cog_name : repo_url}``.
+  Downloader will not deal with this functionality but it may be useful for other cogs.
+
+- ``requirements`` (list of strings) - list of required libraries that are
+  passed to pip on cog install. ``SHARED_LIBRARIES`` do NOT go in this
+  list.
+
+- ``tags`` (list of strings) - A list of strings that are related to the
+  functionality of the cog. Used to aid in searching.
+
+- ``type`` (string) - Optional, defaults to ``COG``. Must be either ``COG`` or
+  ``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 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/host-list.rst

@@ -0,0 +1,150 @@
+.. source: https://gist.github.com/Twentysix26/cb4401c6e507782aa6698e9e470243ed
+
+.. _host-list:
+
+===================
+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.
+
+
+| 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.
+    If you don't know Unix basics, please take a look at `this guide
+    <https://www.digitalocean.com/community/tutorials/an-introduction-to-linux-basics>`_
+    from DigitalOcean which will introduce you to the Linux basics.
+
+
+------------
+Self Hosting
+------------
+
+| 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.
+
+-------------------
+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
+------------
+
+| `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.
+
+| **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

@@ -3,6 +3,8 @@
     You can adapt this file completely to your liking, but it should at least
     contain the root `toctree` directive.
 
+.. _main:
+
 Welcome to Red - Discord Bot's documentation!
 =============================================
 
@@ -12,23 +14,46 @@ Welcome to Red - Discord Bot's documentation!
 
     install_windows
     install_linux_mac
-    venv_guide
+    bot_application_guide
+    update_red
+    about_venv
     autostart_systemd
+    autostart_pm2
 
 .. toctree::
     :maxdepth: 2
     :caption: Cog Reference:
 
     cog_customcom
-    cog_downloader
     cog_permissions
 
+.. 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/customcommands
+    cog_guides/downloader
+    cog_guides/economy
+    cog_guides/filter
+    cog_guides/general
+    cog_guides/streams
+    cog_guides/trivia
+    red_core_data_statement
+
 .. toctree::
     :maxdepth: 2
     :caption: Red Development Framework Reference:
 
     guide_migration
     guide_cog_creation
+    guide_publish_cogs
+    guide_cog_creators
     framework_apikeys
     framework_bank
     framework_bot
@@ -37,19 +62,29 @@ Welcome to Red - Discord Bot's documentation!
     framework_commands
     framework_config
     framework_datamanager
-    framework_downloader
     framework_events
     framework_i18n
     framework_modlog
     framework_rpc
     framework_utils
+    version_guarantees
 
 .. toctree::
     :maxdepth: 2
     :caption: Changelogs:
 
+    changelog_3_4_0
+    changelog_3_3_0
+    release_notes_3_2_0
+    changelog_3_2_0
     changelog_3_1_0
 
+.. toctree::
+    :maxdepth: 2
+    :caption: Others
+
+    host-list
+
 
 Indices and tables
 ==================

docs/install_linux_mac.rst

@@ -7,7 +7,8 @@ Installing Red on Linux or Mac
 .. warning::
 
     For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
-    a new user, see the man page for the ``useradd`` command.
+    a new user on Linux, see `this guide by DigitalOcean
+    <https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart>`_.
 
 -------------------------------
 Installing the pre-requirements
@@ -16,10 +17,23 @@ Installing the pre-requirements
 Please install the pre-requirements using the commands listed for your operating system.
 
 The pre-requirements are:
- - Python 3.7.0 or greater
- - pip 9.0 or greater
- - git
- - Java Runtime Environment 8 or later (for audio support)
+ - Python 3.8.1 or greater; **Python 3.9 is currently not supported!**
+ - Pip 18.1 or greater
+ - Git 2.11+
+ - Java Runtime Environment 11 (for audio support)
+
+We also recommend installing some basic compiler tools, in case our dependencies don't provide
+pre-built "wheels" for your architecture.
+
+
+*****************
+Operating systems
+*****************
+
+.. contents::
+    :local:
+
+----
 
 .. _install-arch:
 
@@ -29,47 +43,93 @@ Arch Linux
 
 .. code-block:: none
 
-    sudo pacman -Syu python-pip git base-devel jre8-openjdk
+    sudo pacman -Syu python python-pip git jre11-openjdk-headless base-devel
 
-.. _install-centos:
-.. _install-fedora:
-.. _install-rhel:
+Continue by `creating-venv-linux`.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-CentOS 7, Fedora, and RHEL
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+----
+
+.. _install-centos7:
+.. _install-rhel7:
+
+~~~~~~~~~~~~~~~~~
+CentOS and RHEL 7
+~~~~~~~~~~~~~~~~~
 
 .. code-block:: none
 
-    yum -y groupinstall development
-    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
-    sudo yum install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel \
-    openssl-devel xz xz-devel libffi-devel git2u java-1.8.0-openjdk
+    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
+    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
 
-Complete the rest of the installation by `installing Python 3.7 with pyenv <install-python-pyenv>`.
+In order to install Git 2.11 or greater, we recommend adding the IUS repository:
+
+.. code-block:: none
+
+    sudo yum -y install https://repo.ius.io/ius-release-el7.rpm
+    sudo yum -y swap git git224
+
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-centos:
+.. _install-rhel:
+
+~~~~~~~~~~~~~~~~~
+CentOS and RHEL 8
+~~~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+    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
+
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
 
 .. _install-debian:
 .. _install-raspbian:
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Debian and Raspbian Stretch
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. warning::
-
-    Audio will not work on Raspberry Pi's **below** 2B. This is a CPU problem and
-    *cannot* be fixed.
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Debian and Raspbian Buster
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 We recommend installing pyenv as a method of installing non-native versions of python on
-Debian/Raspbian Stretch. This guide will tell you how. First, run the following commands:
+Debian/Raspbian Buster. This guide will tell you how. First, run the following commands:
 
 .. code-block:: none
 
-    sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev \
-    libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev \
-    xz-utils tk-dev libffi-dev liblzma-dev python3-openssl git unzip default-jre
+    sudo apt update
+    sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre-headless
+    CXX=/usr/bin/g++
 
-Complete the rest of the installation by `installing Python 3.7 with pyenv <install-python-pyenv>`.
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-fedora:
+
+~~~~~~~~~~~~
+Fedora Linux
+~~~~~~~~~~~~
+
+Fedora Linux 31 and above has all required packages available in official repositories. Install
+them with dnf:
+
+.. code-block:: none
+
+    sudo dnf -y install python38 git java-11-openjdk-headless @development-tools
+
+Continue by `creating-venv-linux`.
+
+----
 
 .. _install-mac:
 
@@ -82,77 +142,188 @@ following, then press Enter:
 
 .. code-block:: none
 
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+    /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
 
-    brew install python --with-brewed-openssl
+    brew install python@3.8
+    echo 'export PATH="/usr/local/opt/python@3.8/bin:$PATH"' >> ~/.profile
+    source ~/.profile
     brew install git
-    brew tap caskroom/versions
-    brew cask install homebrew/cask-versions/adoptopenjdk8
+    brew cask install adoptopenjdk/openjdk/adoptopenjdk11
 
-It's possible you will have network issues. If so, go in your Applications folder, inside it, go in the Python 3.7 folder then double click ``Install certificates.command``
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-opensuse:
+
+~~~~~~~~
+openSUSE
+~~~~~~~~
+
+openSUSE Leap 15.1+
+*******************
+
+We recommend installing a community package to get Python 3.8 on openSUSE Leap 15.1+. This package will
+be installed to the ``/opt`` directory.
+
+First, add the Opt-Python community repository:
+
+.. code-block:: none
+
+    source /etc/os-release
+    sudo zypper -n ar -f https://download.opensuse.org/repositories/home:/Rotkraut:/Opt-Python/openSUSE_Leap_${VERSION_ID}/ Opt-Python
+    sudo zypper -n --gpg-auto-import-keys ref
+
+Now install the pre-requirements with zypper:
+
+.. code-block:: none
+
+    sudo zypper -n install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless
+    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
+
+    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
+
+    sudo /opt/python/bin/easy_install-3.8 pip
+
+Continue by `creating-venv-linux`.
+
+openSUSE Tumbleweed
+*******************
+
+openSUSE Tumbleweed has all required dependencies available in official repositories. Install them
+with zypper:
+
+.. code-block:: none
+
+    sudo zypper -n install python3-base python3-pip git-core java-11-openjdk-headless
+    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:
+
+.. code-block:: none
+
+    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:
+
+.. code-block:: none
+
+    sudo add-apt-repository -y ppa:deadsnakes/ppa
+
+Now install the pre-requirements with apt:
+
+.. code-block:: none
+
+    sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential
+
+Continue by `creating-venv-linux`.
+
+----
 
 .. _install-ubuntu:
-.. _install-ubuntu-bionic:
-.. _install-ubuntu-cosmic:
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Ubuntu 18.04 Bionic Beaver and 18.10 Cosmic Cuttlefish
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
+Ubuntu 20.04 LTS
+~~~~~~~~~~~~~~~~
+
+We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
 
 .. code-block:: none
 
-    sudo apt install python3.7 python3.7-dev python3.7-venv python3-pip build-essential \
-    libssl-dev libffi-dev git unzip default-jre -y
-
-.. _install-ubuntu-xenial:
-
-~~~~~~~~~~~~~~~~~~~~~~~~~
-Ubuntu 16.04 Xenial Xerus
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-We recommend adding the ``deadsnakes`` apt repository to install Python 3.7 or greater:
-
-.. code-block:: none
-
-    sudo apt install software-properties-common
-    sudo add-apt-repository ppa:deadsnakes/ppa
     sudo apt update
+    sudo apt -y install software-properties-common
+    sudo add-apt-repository -y ppa:git-core/ppa
 
-Now, install python, pip, git and java with the following commands:
+Now install the pre-requirements with apt:
 
 .. code-block:: none
 
-    sudo apt install python3.7 python3.7-dev build-essential libssl-dev libffi-dev git \
-    unzip default-jre curl -y
-    curl https://bootstrap.pypa.io/get-pip.py | sudo python3.7
+    sudo apt -y install python3.8 python3.8-dev python3.8-venv python3-pip git openjdk-11-jre-headless build-essential
+
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-ubuntu-non-lts:
+
+~~~~~~~~~~~~~~~~~~~~~~~
+Ubuntu non-LTS versions
+~~~~~~~~~~~~~~~~~~~~~~~
+
+We recommend adding the ``git-core`` ppa to install Git 2.11 or greater:
+
+.. code-block:: none
+
+    sudo apt update
+    sudo apt -y install software-properties-common
+    sudo add-apt-repository -yu ppa:git-core/ppa
+
+Now, to install non-native version of python on non-LTS versions of Ubuntu, we recommend
+installing pyenv. To do this, first run the following commands:
+
+.. code-block:: none
+
+    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
+    CXX=/usr/bin/g++
+
+And then complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
 
 .. _install-python-pyenv:
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+****************************
 Installing Python with pyenv
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+****************************
 
-On distributions where Python 3.7 needs to be compiled from source, we recommend the use of pyenv.
+.. note::
+
+    If you followed one of the sections above, and weren't linked here afterwards, you should skip
+    this section.
+
+On distributions where Python 3.8 needs to be compiled from source, we recommend the use of pyenv.
 This simplifies the compilation process and has the added bonus of simplifying setting up Red in a
 virtual environment.
 
 .. code-block:: none
 
-    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
 
-    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.7.2 -v
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.7 -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
@@ -164,16 +335,94 @@ After that is finished, run:
 
 .. code-block:: none
 
-    pyenv global 3.7.2
+    pyenv global 3.8.7
 
-Pyenv is now installed and your system should be configured to run Python 3.7.
+Pyenv is now installed and your system should be configured to run Python 3.8.
+
+Continue by `creating-venv-linux`.
+
+.. _creating-venv-linux:
 
 ------------------------------
 Creating a Virtual Environment
 ------------------------------
 
-We **strongly** recommend installing Red into a virtual environment. See the section
-`installing-in-virtual-environment`.
+.. tip::
+
+    If you want to learn more about virtual environments, see page: `about-venvs`
+
+We require installing Red into a virtual environment. Don't be scared, it's very
+straightforward.
+
+You have 2 options:
+
+* :ref:`using-venv` (quick and easy, involves just two commands)
+* :ref:`using-pyenv-virtualenv` (only available and recommended when you installed Python with pyenv)
+
+----
+
+.. _using-venv:
+
+**************
+Using ``venv``
+**************
+This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
+python.
+
+First, choose a directory where you would like to create your virtual environment. It's a good idea
+to keep it in a location which is easy to type out the path to. From now, we'll call it
+``redenv`` and it will be located in your home directory.
+
+Create your virtual environment with the following command::
+
+    python3.8 -m venv ~/redenv
+
+And activate it with the following command::
+
+    source ~/redenv/bin/activate
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red.
+
+Continue by `installing-red-linux-mac`.
+
+----
+
+.. _using-pyenv-virtualenv:
+
+**************************
+Using ``pyenv virtualenv``
+**************************
+
+Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
+environments. This option is only available if you installed Python with pyenv.
+
+First, ensure your pyenv interpreter is set to python 3.8.1 or greater with the following command::
+
+    pyenv version
+
+Now, create a virtual environment with the following command::
+
+    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::
+
+    pyenv shell <name>
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    shell to run, install or update Red. You can check out other commands like ``pyenv local`` and
+    ``pyenv global`` if you wish to keep the virtualenv activated all the time.
+
+Continue by `installing-red-linux-mac`.
+
+.. _pyenv-installer: https://github.com/pyenv/pyenv-installer/blob/master/README.rst
 
 .. _installing-red-linux-mac:
 
@@ -183,31 +432,24 @@ Installing Red
 
 Choose one of the following commands to install Red.
 
-.. note::
-
-    If you're not inside an activated virtual environment, include the ``--user`` flag with all
-    ``python3.7 -m pip`` commands.
-
-To install without MongoDB support:
+To install without additional config backend support:
 
 .. code-block:: none
 
-    python3.7 -m pip install -U Red-DiscordBot
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U Red-DiscordBot
 
-Or, to install with MongoDB support:
+Or, to install with PostgreSQL support:
 
 .. code-block:: none
 
-    python3.7 -m pip install -U Red-DiscordBot[mongo]
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U "Red-DiscordBot[postgres]"
+
 
 .. note::
 
-  To install the development version, replace ``Red-DiscordBot`` in the above commands with the
-  following link:
-
-  .. code-block:: none
-
-      git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
+    These commands are also used for updating Red
 
 --------------------------
 Setting Up and Running Red
@@ -231,14 +473,8 @@ Once done setting up the instance, run the following command to run Red:
 
 It will walk through the initial setup, asking for your token and a prefix.
 You can find out how to obtain a token with
-`this guide <https://discordpy.readthedocs.io/en/v1.0.1/discord.html#creating-a-bot-account>`_,
-section "Creating a Bot Account".
-
-You may also run Red via the launcher, which allows you to restart the bot
-from discord, and enable auto-restart. You may also update the bot from the
-launcher menu. Use the following command to run the launcher:
-
-.. code-block:: none
-
-    redbot-launcher
+`this guide <bot_application_guide>`.
 
+.. tip::
+   If it's the first time you're using Red, you should check our `getting-started` guide
+   that will walk you through all essential information on how to interact with Red.

docs/install_windows.rst

@@ -4,48 +4,126 @@
 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.
 
-To install via powershell, search "powershell" in the windows start menu,
-right-click on it and then click "Run as administrator"
+.. 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".
 
 Then run each of the following commands:
 
 .. code-block:: none
 
     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 install git --params "/GitOnlyOnPath /WindowsTerminal" -y
-    choco install jre8 python -y; exit
+    choco upgrade git --params "/GitOnlyOnPath /WindowsTerminal" -y
+    choco upgrade visualstudio2019-workload-vctools -y
+    choco upgrade python3 -y --version 3.8.7
 
+For Audio support, you should also run the following command before exiting:
+
+.. code-block:: none
+
+    choco upgrade adoptopenjdk11jre -y
+
+
+From here, exit the prompt then continue onto `creating-venv-windows`.
+
+----
 
 ********************************
 Manually installing dependencies
 ********************************
 
-* `Python <https://www.python.org/downloads/>`_ - Red needs Python 3.7.0 or greater
+.. attention:: There are additional configuration steps required which are
+               not documented for installing dependencies manually.
+               These dependencies are only listed seperately here for
+               reference purposes.
 
-.. note:: Please make sure that the box to add Python to PATH is CHECKED, otherwise
-          you may run into issues when trying to run Red.
+* `MSVC Build tools <https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2019>`_
 
-* `Git <https://git-scm.com/download/win>`_
+* `Python 3.8.1 or greater <https://www.python.org/downloads/>`_; **Python 3.9 is currently not supported!**
 
-.. attention:: Please choose the option to "Run Git from the Windows Command Prompt" in Git's setup.
+.. 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.
 
-* `Java <https://java.com/en/download/manual.jsp>`_ - needed for Audio
+* `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 11 <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>`_ - needed for Audio
+
+From here, continue onto `creating-venv-windows`.
+
+----
+
+.. _creating-venv-windows:
+
+------------------------------
+Creating a Virtual Environment
+------------------------------
+
+.. tip::
+
+    If you want to learn more about virtual environments, see page: `about-venvs`.
+
+We require installing Red into a virtual environment. Don't be scared, it's very
+straightforward.
+
+First, choose a directory where you would like to create your virtual environment. It's a good idea
+to keep it in a location which is easy to type out the path to. From now, we'll call it
+``redenv`` and it will be located in your home directory.
+
+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
+
+.. code-block:: none
+
+    py -3.8 -m venv "%userprofile%\redenv"
+
+And activate it with the following command
+
+.. code-block:: none
+
+    "%userprofile%\redenv\Scripts\activate.bat"
+
+.. important::
+
+    You must activate the virtual environment with the above command every time you open a new
+    Command Prompt to run, install or update Red.
 
-.. attention:: Please choose the "Windows Online" installer.
 
 .. _installing-red-windows:
 
@@ -56,35 +134,21 @@ Installing Red
 .. attention:: You may need to restart your computer after installing dependencies
                for the PATH changes to take effect.
 
-1. Open a command prompt (open Start, search for "command prompt", then click it)
-2. Create and activate a virtual environment (strongly recommended), see the section `using-venv`
-3. Run **one** of the following commands, depending on what extras you want installed
+Run **one** of the following set of commands, depending on what extras you want installed
 
-  .. note::
-
-      If you're not inside an activated virtual environment, include the ``--user`` flag with all
-      ``pip`` commands.
-
-  * No MongoDB support:
+  * Normal installation:
 
     .. code-block:: none
 
+        python -m pip install -U pip setuptools wheel
         python -m pip install -U Red-DiscordBot
 
-  * With MongoDB support:
+  * With PostgreSQL support:
 
     .. code-block:: none
 
-        python -m pip install -U Red-DiscordBot[mongo]
-
-  .. note::
-
-      To install the development version, replace ``Red-DiscordBot`` in the above commands with the
-      following link:
-
-      .. code-block:: none
-
-          git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
+        python -m pip install -U pip setuptools wheel
+        python -m pip install -U Red-DiscordBot[postgres]
 
 --------------------------
 Setting Up and Running Red
@@ -108,13 +172,8 @@ Once done setting up the instance, run the following command to run Red:
 
 It will walk through the initial setup, asking for your token and a prefix.
 You can find out how to obtain a token with
-`this guide <https://discordpy.readthedocs.io/en/v1.0.1/discord.html#creating-a-bot-account>`_,
-section "Creating a Bot Account".
+`this guide <bot_application_guide>`.
 
-You may also run Red via the launcher, which allows you to restart the bot
-from discord, and enable auto-restart. You may also update the bot from the
-launcher menu. Use the following command to run the launcher:
-
-.. code-block:: none
-
-    redbot-launcher
+.. tip::
+   If it's the first time you're using Red, you should check our `getting-started` guide
+   that will walk you through all essential information on how to interact with Red.

docs/prolog.txt

@@ -0,0 +1,50 @@
+.. This file will be run at the beginning of all files.
+    You can add the subsitutions you need.
+
+.. this is a .txt so sphinx doesn't error because it's
+    missing in the index
+
+
+.. These are the comments for permissions locks
+
+.. |owner-lock| replace:: This command is locked to the
+    :ref:`bot owner <getting-started-permissions>`.
+
+.. |guildowner-lock| replace:: This command is locked to the
+    :ref:`server owner <getting-started-permissions>`.
+
+.. |admin-lock| replace:: This command is locked to the
+    :ref:`admin role <getting-started-permissions>`.
+
+.. |mod-lock| replace:: This command is locked to the
+    :ref:`mod role <getting-started-permissions>`.
+
+
+.. This is for describing how a format should be formatted
+
+.. |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.
+
+.. |member-input-quotes| replace:: You can either mention the member, provide its ID, its exact
+    name with the tag or not, or its nickname enclosed in quotes if there are spaces.
+
+.. |user-input| replace:: You can either provide the member's ID or its exact name with the tag or
+    not.
+
+.. |user-input-quotes| replace:: You can either provide the member's ID or its exact name with the
+    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.
+
+.. |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`.

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/release_notes_3_2_0.rst

@@ -0,0 +1,50 @@
+.. v3.2.0 Release Notes
+
+##################################
+Red DiscordBot 3.2.0 Release Notes
+##################################
+
+
+Please read the following prior to updating.
+
+- 3.2 comes with improvements which required breaking changes for 3rd party cogs.
+  When you update to 3.2, your cogs may not be compatible if the author has not handled
+  the changes yet.
+
+
+- 3.2 requires Python 3.8.1.
+  This was done so that we could better handle some behavior which was not fixed for Python 3.7.
+  If you need help updating, our install docs will cover everything you need to know to update.
+
+  .. note::
+  
+    You may get a notification from the downloader cog about needing to refetch dependencies
+    This is expected, and it will walk you through everything and do as much as it can for you.
+
+
+- 3.2 dropped support for the MongoDB driver
+  
+  - If you were not using the MongoDB driver, this does not effect 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,
+    you will need to run the following commands to convert
+
+      .. code::
+        
+        python -m pip install dnspython~=1.16.0 motor~=2.0.0 pymongo~=3.8.0
+        redbot-setup convert [instancename] json
+
+
+- 3.2 comes with many feature upgrades. A brief high level list of these is below.
+
+  - A metric ton of bugfixes
+  - Bot shutdown is handled significantly better
+  - Audio is much more powerful
+  - We've made it easier for cog creators to interact with the core bot APIs safely
+  - We've supplied cog creators with additional tools
+
+
+.. note:: 
+    
+  The full list of changes is much longer than we can include here,
+  but our changelog has the fine details.

docs/update_red.rst

@@ -0,0 +1,139 @@
+============
+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:
+
+    .. code:: none
+
+        "%userprofile%\redenv\Scripts\activate.bat"
+
+3. Update Red with this command:
+
+    .. code:: none
+
+        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.
+
+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:
+
+    .. code:: none
+
+        source ~/redenv/bin/activate
+
+    If you used ``pyenv`` for your virtual environment, use:
+
+    .. code:: none
+
+        pyenv shell <name>
+
+3. Update Red with this command:
+
+    .. code:: none
+
+        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.
+
+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:
+
+         .. code::
+
+           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:
+
+         .. code::
+
+           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/venv_guide.rst

@@ -1,132 +0,0 @@
-.. _installing-in-virtual-environment:
-
-=======================================
-Installing Red in a Virtual Environment
-=======================================
-Virtual environments allow you to isolate red's library dependencies, cog dependencies and python
-binaries from the rest of your system. It is strongly recommended you use this if you use python
-for more than just Red.
-
-.. _using-venv:
-
---------------
-Using ``venv``
---------------
-This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
-python.
-
-First, choose a directory where you would like to create your virtual environment. It's a good idea
-to keep it in a location which is easy to type out the path to. From now, we'll call it
-``path/to/venv/`` (or ``path\to\venv\`` on Windows).
-
-~~~~~~~~~~~~~~~~~~~~~~~~
-``venv`` on Linux or Mac
-~~~~~~~~~~~~~~~~~~~~~~~~
-Create your virtual environment with the following command::
-
-    python3.7 -m venv path/to/venv/
-
-And activate it with the following command::
-
-    source path/to/venv/bin/activate
-
-.. important::
-
-    You must activate the virtual environment with the above command every time you open a new
-    shell to run, install or update Red.
-
-Continue reading `below <after-activating-virtual-environment>`.
-
-~~~~~~~~~~~~~~~~~~~
-``venv`` on Windows
-~~~~~~~~~~~~~~~~~~~
-Create your virtual environment with the following command::
-
-    python -m venv path\to\venv\
-
-And activate it with the following command::
-
-    path\to\venv\Scripts\activate.bat
-
-.. important::
-
-    You must activate the virtual environment with the above command every time you open a new
-    Command Prompt to run, install or update Red.
-
-Continue reading `below <after-activating-virtual-environment>`.
-
-.. _using-pyenv-virtualenv:
-
---------------------------
-Using ``pyenv virtualenv``
---------------------------
-
-.. note::
-
-    This is for non-Windows users only.
-
-Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
-environments. If you haven't already, install pyenv with `pyenv-installer`_.
-
-First, ensure your pyenv interpreter is set to python 3.7.0 or greater with the following command::
-
-    pyenv version
-
-Now, create a virtual environment with the following command::
-
-    pyenv virtualenv <name>
-
-Replace ``<name>`` with whatever you like. If you forget what you named it, use the command ``pyenv
-versions``.
-
-Now activate your virtualenv with the following command::
-
-    pyenv shell <name>
-
-.. important::
-
-    You must activate the virtual environment with the above command every time you open a new
-    shell to run, install or update Red.
-
-Continue reading `below <after-activating-virtual-environment>`.
-
-.. _pyenv-installer: https://github.com/pyenv/pyenv-installer/blob/master/README.rst
-
-----
-
-.. _after-activating-virtual-environment:
-
-Once activated, your ``PATH`` environment variable will be modified to use the virtual
-environment's python executables, as well as other executables like ``pip``.
-
-From here, install Red using the commands listed on your installation guide (`Windows
-<installing-red-windows>` or `Non-Windows <installing-red-linux-mac>`).
-
-.. note::
-
-    The alternative to activating the virtual environment each time you open a new shell is to
-    provide the full path to the executable. This will automatically use the virtual environment's
-    python interpreter and installed libraries.
-
---------------------------------------------
-Virtual Environments with Multiple Instances
---------------------------------------------
-If you are running multiple instances of Red on the same machine, you have the option of either
-using the same virtual environment for all of them, or creating separate ones.
-
-.. note::
-
-    This only applies for multiple instances of V3. If you are running a V2 instance as well,
-    You **must** use separate virtual environments.
-
-The advantages of using a *single* virtual environment for all of your V3 instances are:
-
-- When updating Red, you will only need to update it once for all instances (however you will still need to restart all instances for the changes to take effect)
-- It will save space on your hard drive
-
-On the other hand, you may wish to update each of your instances individually.
-
-.. important::
-
-    Windows users with multiple instances should create *separate* virtual environments, as
-    updating multiple running instances at once is likely to cause errors.

docs/version_guarantees.rst

@@ -0,0 +1,43 @@
+.. _version-guarantees:
+
+==========
+Versioning
+==========
+
+Red is versioned as ``major.minor.micro``
+
+While this is very similar to SemVer, we have our own set of guarantees.
+
+Major versions are for project wide rewrites and are not expected in the foreseeable future.
+
+==========
+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`` 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.
+
+=======================
+Breaking Change Notices
+=======================
+
+Breaking changes in Red will be noted in the changelog with a special section.
+
+Breaking changes may only occur on a minor or major version bump.
+
+A change not covered by our guarantees may not be considered breaking for these purposes, 
+while still being documented as a breaking change in internal documentation
+for the purposes of other internal APIs.

make.bat

@@ -5,25 +5,23 @@ 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
-)
-
 goto %1
 
 :reformat
-black -l 99 !PYFILES!
+black "%~dp0."
 exit /B %ERRORLEVEL%
 
 :stylecheck
-black -l 99 --check !PYFILES!
+black --check "%~dp0."
+exit /B %ERRORLEVEL%
+
+:stylediff
+black --check --diff "%~dp0."
 exit /B %ERRORLEVEL%
 
 :newenv
-py -3.7 -m venv --clear .venv
-.\.venv\Scripts\python -m pip install -U pip setuptools
+py -3.8 -m venv --clear .venv
+.\.venv\Scripts\python -m pip install -U pip setuptools wheel
 goto syncenv
 
 :syncenv

pyproject.toml

@@ -0,0 +1,23 @@
+[tool.black]
+    line-length = 99
+    target-version = ['py38']
+    include = '\.py$'
+    exclude = '''
+    /(
+          \.eggs
+        | \.git
+        | \.hg
+        | \.mypy_cache
+        | \.tox
+        | \.venv
+        | _build
+        | buck-out
+        | build
+        | dist
+        | redbot\/vendored
+    )/
+    '''
+
+[tool.pytest.ini_options]
+    minversion = "6.0"
+    addopts = "--import-mode=importlib"

redbot/__init__.py

@@ -1,9 +1,10 @@
+import asyncio as _asyncio
+import os as _os
 import re as _re
 import sys as _sys
 import warnings as _warnings
 from math import inf as _inf
 from typing import (
-    Any as _Any,
     ClassVar as _ClassVar,
     Dict as _Dict,
     List as _List,
@@ -14,11 +15,16 @@ from typing import (
 )
 
 
-MIN_PYTHON_VERSION = (3, 7, 0)
+MIN_PYTHON_VERSION = (3, 8, 1)
 
-__all__ = ["MIN_PYTHON_VERSION", "__version__", "version_info", "VersionInfo"]
-
-if _sys.version_info < MIN_PYTHON_VERSION:
+__all__ = [
+    "MIN_PYTHON_VERSION",
+    "__version__",
+    "version_info",
+    "VersionInfo",
+    "_update_event_loop_policy",
+]
+if _sys.version_info < MIN_PYTHON_VERSION and not _os.getenv("READTHEDOCS", False):
     print(
         f"Python {'.'.join(map(str, MIN_PYTHON_VERSION))} is required to run Red, but you have "
         f"{_sys.version}! Please update Python."
@@ -174,8 +180,27 @@ class VersionInfo:
         )
 
 
-__version__ = "3.1.4"
+def _update_event_loop_policy():
+    if _sys.implementation.name == "cpython":
+        # Let's not force this dependency, uvloop is much faster on cpython
+        try:
+            import uvloop as _uvloop
+        except ImportError:
+            pass
+        else:
+            _asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy())
+
+
+__version__ = "3.4.7"
 version_info = VersionInfo.from_str(__version__)
 
 # Filter fuzzywuzzy slow sequence matcher warning
 _warnings.filterwarnings("ignore", module=r"fuzzywuzzy.*")
+# Show DeprecationWarning
+_warnings.filterwarnings("default", category=DeprecationWarning)
+
+if "--debug" not in _sys.argv:
+    # DEP-WARN
+    # Individual warnings - tracked in https://github.com/Cog-Creators/Red-DiscordBot/issues/3529
+    # DeprecationWarning: an integer is required (got type float).  Implicit conversion to integers using __int__ is deprecated, and may be removed in a future version of Python.
+    _warnings.filterwarnings("ignore", category=DeprecationWarning, module="importlib", lineno=219)

redbot/__main__.py

@@ -1,40 +1,37 @@
 #!/usr/bin/env python
 
-# Discord Version check
-
 import asyncio
+import functools
+import getpass
 import json
 import logging
 import os
+import pip
+import pkg_resources
+import platform
+import shutil
+import signal
 import sys
+from argparse import Namespace
+from copy import deepcopy
+from pathlib import Path
+from typing import NoReturn
 
 import discord
 
-# Set the event loop policies here so any subsequent `get_event_loop()`
+# Set the event loop policies here so any subsequent `new_event_loop()`
 # calls, in particular those as a result of the following imports,
 # return the correct loop object.
-if sys.platform == "win32":
-    asyncio.set_event_loop_policy(asyncio.WindowsProactorEventLoopPolicy())
-elif sys.implementation.name == "cpython":
-    # Let's not force this dependency, uvloop is much faster on cpython
-    try:
-        import uvloop
-    except ImportError:
-        uvloop = None
-        pass
-    else:
-        asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
+from redbot import _update_event_loop_policy, __version__
+
+_update_event_loop_policy()
 
 import redbot.logging
 from redbot.core.bot import Red, ExitCodes
-from redbot.core.cog_manager import CogManagerUI
-from redbot.core.global_checks import init_global_checks
-from redbot.core.events import init_events
 from redbot.core.cli import interactive_config, confirm, parse_cli_flags
-from redbot.core.core_commands import Core
-from redbot.core.dev_commands import Dev
-from redbot.core import __version__, modlog, bank, data_manager
-from signal import SIGTERM
+from redbot.setup import get_data_dir, get_name, save_config
+from redbot.core import data_manager, drivers
+from redbot.core._sharedlibdeprecation import SharedLibImportWarner
 
 
 log = logging.getLogger("red.main")
@@ -46,14 +43,10 @@ log = logging.getLogger("red.main")
 #
 
 
-async def _get_prefix_and_token(red, indict):
-    """
-    Again, please blame <@269933075037814786> for this.
-    :param indict:
-    :return:
-    """
-    indict["token"] = await red.db.token()
-    indict["prefix"] = await red.db.prefix()
+def _get_instance_names():
+    with data_manager.config_file.open(encoding="utf-8") as fs:
+        data = json.load(fs)
+    return sorted(data.keys())
 
 
 def list_instances():
@@ -64,115 +57,499 @@ def list_instances():
         )
         sys.exit(1)
     else:
-        with data_manager.config_file.open(encoding="utf-8") as fs:
-            data = json.load(fs)
         text = "Configured Instances:\n\n"
-        for instance_name in sorted(data.keys()):
+        for instance_name in _get_instance_names():
             text += "{}\n".format(instance_name)
         print(text)
         sys.exit(0)
 
 
-async def sigterm_handler(red, log):
-    log.info("SIGTERM received. Quitting...")
-    await red.shutdown(restart=False)
+def debug_info():
+    """Shows debug information useful for debugging."""
+    if sys.platform == "linux":
+        import distro  # pylint: disable=import-error
+
+    IS_WINDOWS = os.name == "nt"
+    IS_MAC = sys.platform == "darwin"
+    IS_LINUX = sys.platform == "linux"
+
+    pyver = sys.version
+    pipver = pip.__version__
+    redver = __version__
+    dpy_version = discord.__version__
+    if IS_WINDOWS:
+        os_info = platform.uname()
+        osver = "{} {} (version {})".format(os_info.system, os_info.release, os_info.version)
+    elif IS_MAC:
+        os_info = platform.mac_ver()
+        osver = "Mac OSX {} {}".format(os_info[0], os_info[2])
+    else:
+        os_info = distro.linux_distribution()
+        osver = "{} {}".format(os_info[0], os_info[1]).strip()
+    user_who_ran = getpass.getuser()
+    info = (
+        "Debug Info for Red\n\n"
+        + "Red version: {}\n".format(redver)
+        + "Python version: {}\n".format(pyver)
+        + "Python executable: {}\n".format(sys.executable)
+        + "Discord.py version: {}\n".format(dpy_version)
+        + "Pip version: {}\n".format(pipver)
+        + "OS version: {}\n".format(osver)
+        + "System arch: {}\n".format(platform.machine())
+        + "User: {}\n".format(user_who_ran)
+        + "Metadata file: {}\n".format(data_manager.config_file)
+    )
+    print(info)
+    sys.exit(0)
 
 
-def main():
-    description = "Red V3"
-    cli_flags = parse_cli_flags(sys.argv[1:])
-    if cli_flags.list_instances:
-        list_instances()
-    elif cli_flags.version:
-        print(description)
-        print("Current Version: {}".format(__version__))
-        sys.exit(0)
-    elif not cli_flags.instance_name and not cli_flags.no_instance:
-        print("Error: No instance name was provided!")
+async def edit_instance(red, cli_flags):
+    no_prompt = cli_flags.no_prompt
+    token = cli_flags.token
+    owner = cli_flags.owner
+    prefix = cli_flags.prefix
+    old_name = cli_flags.instance_name
+    new_name = cli_flags.edit_instance_name
+    data_path = cli_flags.edit_data_path
+    copy_data = cli_flags.copy_data
+    confirm_overwrite = cli_flags.overwrite_existing_instance
+
+    if data_path is None and copy_data:
+        print("--copy-data can't be used without --edit-data-path argument")
         sys.exit(1)
-    if cli_flags.no_instance:
+    if new_name is None and confirm_overwrite:
+        print("--overwrite-existing-instance can't be used without --edit-instance-name argument")
+        sys.exit(1)
+    if (
+        no_prompt
+        and all(to_change is None for to_change in (token, owner, new_name, data_path))
+        and not prefix
+    ):
         print(
-            "\033[1m"
-            "Warning: The data will be placed in a temporary folder and removed on next system "
-            "reboot."
-            "\033[0m"
+            "No arguments to edit were provided."
+            " Available arguments (check help for more information):"
+            " --edit-instance-name, --edit-data-path, --copy-data, --owner, --token, --prefix"
         )
-        cli_flags.instance_name = "temporary_red"
-        data_manager.create_temp_config()
+        sys.exit(1)
+
+    await _edit_token(red, token, no_prompt)
+    await _edit_prefix(red, prefix, no_prompt)
+    await _edit_owner(red, owner, no_prompt)
+
+    data = deepcopy(data_manager.basic_config)
+    name = _edit_instance_name(old_name, new_name, confirm_overwrite, no_prompt)
+    _edit_data_path(data, name, data_path, copy_data, no_prompt)
+
+    save_config(name, data)
+    if old_name != name:
+        save_config(old_name, {}, remove=True)
+
+
+async def _edit_token(red, token, no_prompt):
+    if token:
+        if not len(token) >= 50:
+            print(
+                "The provided token doesn't look a valid Discord bot token."
+                " Instance's token will remain unchanged.\n"
+            )
+            return
+        await red._config.token.set(token)
+    elif not no_prompt and confirm("Would you like to change instance's token?", default=False):
+        await interactive_config(red, False, True, print_header=False)
+        print("Token updated.\n")
+
+
+async def _edit_prefix(red, prefix, no_prompt):
+    if prefix:
+        prefixes = sorted(prefix, reverse=True)
+        await red._config.prefix.set(prefixes)
+    elif not no_prompt and confirm("Would you like to change instance's prefixes?", default=False):
+        print(
+            "Enter the prefixes, separated by a space (please note "
+            "that prefixes containing a space will need to be added with [p]set prefix)"
+        )
+        while True:
+            prefixes = input("> ").strip().split()
+            if not prefixes:
+                print("You need to pass at least one prefix!")
+                continue
+            prefixes = sorted(prefixes, reverse=True)
+            await red._config.prefix.set(prefixes)
+            print("Prefixes updated.\n")
+            break
+
+
+async def _edit_owner(red, owner, no_prompt):
+    if owner:
+        if not (15 <= len(str(owner)) <= 21):
+            print(
+                "The provided owner id doesn't look like a valid Discord user id."
+                " Instance's owner will remain unchanged."
+            )
+            return
+        await red._config.owner.set(owner)
+    elif not no_prompt and confirm("Would you like to change instance's owner?", default=False):
+        print(
+            "Remember:\n"
+            "ONLY the person who is hosting Red should be owner."
+            " This has SERIOUS security implications."
+            " The owner can access any data that is present on the host system.\n"
+        )
+        if confirm("Are you sure you want to change instance's owner?", default=False):
+            print("Please enter a Discord user id for new owner:")
+            while True:
+                owner_id = input("> ").strip()
+                if not (15 <= len(owner_id) <= 21 and owner_id.isdecimal()):
+                    print("That doesn't look like a valid Discord user id.")
+                    continue
+                owner_id = int(owner_id)
+                await red._config.owner.set(owner_id)
+                print("Owner updated.")
+                break
+        else:
+            print("Instance's owner will remain unchanged.")
+        print()
+
+
+def _edit_instance_name(old_name, new_name, confirm_overwrite, no_prompt):
+    if new_name:
+        name = new_name
+        if name in _get_instance_names() and not confirm_overwrite:
+            name = old_name
+            print(
+                "An instance with this name already exists.\n"
+                "If you want to remove the existing instance and replace it with this one,"
+                " run this command with --overwrite-existing-instance flag."
+            )
+    elif not no_prompt and confirm("Would you like to change the instance name?", default=False):
+        name = get_name()
+        if name in _get_instance_names():
+            print(
+                "WARNING: An instance already exists with this name. "
+                "Continuing will overwrite the existing instance config."
+            )
+            if not confirm(
+                "Are you absolutely certain you want to continue with this instance name?",
+                default=False,
+            ):
+                print("Instance name will remain unchanged.")
+                name = old_name
+            else:
+                print("Instance name updated.")
+        else:
+            print("Instance name updated.")
+        print()
+    else:
+        name = old_name
+    return name
+
+
+def _edit_data_path(data, instance_name, data_path, copy_data, no_prompt):
+    # This modifies the passed dict.
+    if data_path:
+        new_path = Path(data_path)
+        try:
+            exists = new_path.exists()
+        except OSError:
+            print(
+                "We were unable to check your chosen directory."
+                " Provided path may contain an invalid character."
+                " Data location will remain unchanged."
+            )
+
+        if not exists:
+            try:
+                new_path.mkdir(parents=True, exist_ok=True)
+            except OSError:
+                print(
+                    "We were unable to create your chosen directory."
+                    " Data location will remain unchanged."
+                )
+        data["DATA_PATH"] = data_path
+        if copy_data and not _copy_data(data):
+            print("Can't copy data to non-empty location. Data location will remain unchanged.")
+            data["DATA_PATH"] = data_manager.basic_config["DATA_PATH"]
+    elif not no_prompt and confirm("Would you like to change the data location?", default=False):
+        data["DATA_PATH"] = get_data_dir(instance_name)
+        if confirm("Do you want to copy the data from old location?", default=True):
+            if not _copy_data(data):
+                print("Can't copy the data to non-empty location.")
+                if not confirm("Do you still want to use the new data location?"):
+                    data["DATA_PATH"] = data_manager.basic_config["DATA_PATH"]
+                    print("Data location will remain unchanged.")
+                    return
+            print("Old data has been copied over to the new location.")
+        print("Data location updated.")
+
+
+def _copy_data(data):
+    if Path(data["DATA_PATH"]).exists():
+        if any(os.scandir(data["DATA_PATH"])):
+            return False
+        else:
+            # this is needed because copytree doesn't work when destination folder exists
+            # Python 3.8 has `dirs_exist_ok` option for that
+            os.rmdir(data["DATA_PATH"])
+    shutil.copytree(data_manager.basic_config["DATA_PATH"], data["DATA_PATH"])
+    return True
+
+
+def handle_edit(cli_flags: Namespace):
+    """
+    This one exists to not log all the things like it's a full run of the bot.
+    """
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
     data_manager.load_basic_configuration(cli_flags.instance_name)
+    red = Red(cli_flags=cli_flags, description="Red V3", dm_help=None)
+    try:
+        driver_cls = drivers.get_driver_class()
+        loop.run_until_complete(driver_cls.initialize(**data_manager.storage_details()))
+        loop.run_until_complete(edit_instance(red, cli_flags))
+        loop.run_until_complete(driver_cls.teardown())
+    except (KeyboardInterrupt, EOFError):
+        print("Aborted!")
+    finally:
+        loop.run_until_complete(asyncio.sleep(1))
+        asyncio.set_event_loop(None)
+        loop.stop()
+        loop.close()
+        sys.exit(0)
+
+
+async def run_bot(red: Red, cli_flags: Namespace) -> None:
+    """
+    This runs the bot.
+
+    Any shutdown which is a result of not being able to log in needs to raise
+    a SystemExit exception.
+
+    If the bot starts normally, the bot should be left to handle the exit case.
+    It will raise SystemExit in a task, which will reach the event loop and
+    interrupt running forever, then trigger our cleanup process, and does not
+    need additional handling in this function.
+    """
+
+    driver_cls = drivers.get_driver_class()
+
+    await driver_cls.initialize(**data_manager.storage_details())
+
     redbot.logging.init_logging(
-        level=cli_flags.logging_level, location=data_manager.core_data_path() / "logs"
+        level=cli_flags.logging_level,
+        location=data_manager.core_data_path() / "logs",
+        cli_flags=cli_flags,
     )
 
     log.debug("====Basic Config====")
     log.debug("Data Path: %s", data_manager._base_data_path())
     log.debug("Storage Type: %s", data_manager.storage_type())
 
-    red = Red(
-        cli_flags=cli_flags, description=description, dm_help=None, fetch_offline_members=True
-    )
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(red.maybe_update_config())
-    init_global_checks(red)
-    init_events(red, cli_flags)
+    # lib folder has to be in sys.path before trying to load any 3rd-party cog (GH-3061)
+    # We might want to change handling of requirements in Downloader at later date
+    LIB_PATH = data_manager.cog_data_path(raw_name="Downloader") / "lib"
+    LIB_PATH.mkdir(parents=True, exist_ok=True)
+    if str(LIB_PATH) not in sys.path:
+        sys.path.append(str(LIB_PATH))
 
-    red.add_cog(Core(red))
-    red.add_cog(CogManagerUI())
-    if cli_flags.dev:
-        red.add_cog(Dev())
-    # noinspection PyProtectedMember
-    loop.run_until_complete(modlog._init())
-    # noinspection PyProtectedMember
-    bank._init()
+        # "It's important to note that the global `working_set` object is initialized from
+        # `sys.path` when `pkg_resources` is first imported, but is only updated if you do
+        # all future `sys.path` manipulation via `pkg_resources` APIs. If you manually modify
+        # `sys.path`, you must invoke the appropriate methods on the `working_set` instance
+        # to keep it in sync."
+        # Source: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#workingset-objects
+        pkg_resources.working_set.add_entry(str(LIB_PATH))
+    sys.meta_path.insert(0, SharedLibImportWarner())
 
-    if os.name == "posix":
-        loop.add_signal_handler(SIGTERM, lambda: asyncio.ensure_future(sigterm_handler(red, log)))
-    tmp_data = {}
-    loop.run_until_complete(_get_prefix_and_token(red, tmp_data))
-    token = os.environ.get("RED_TOKEN", tmp_data["token"])
     if cli_flags.token:
         token = cli_flags.token
-    prefix = cli_flags.prefix or tmp_data["prefix"]
+    else:
+        token = os.environ.get("RED_TOKEN", None)
+        if not token:
+            token = await red._config.token()
+
+    prefix = cli_flags.prefix or await red._config.prefix()
+
     if not (token and prefix):
         if cli_flags.no_prompt is False:
-            new_token = interactive_config(red, token_set=bool(token), prefix_set=bool(prefix))
+            new_token = await interactive_config(
+                red, token_set=bool(token), prefix_set=bool(prefix)
+            )
             if new_token:
                 token = new_token
         else:
             log.critical("Token and prefix must be set in order to login.")
             sys.exit(1)
-    loop.run_until_complete(_get_prefix_and_token(red, tmp_data))
 
     if cli_flags.dry_run:
-        loop.run_until_complete(red.http.close())
+        await red.http.close()
         sys.exit(0)
     try:
-        loop.run_until_complete(red.start(token, bot=True))
+        await red.start(token, bot=True, cli_flags=cli_flags)
     except discord.LoginFailure:
         log.critical("This token doesn't seem to be valid.")
-        db_token = loop.run_until_complete(red.db.token())
+        db_token = await red._config.token()
         if db_token and not cli_flags.no_prompt:
-            print("\nDo you want to reset the token? (y/n)")
-            if confirm("> "):
-                loop.run_until_complete(red.db.token.set(""))
+            if confirm("\nDo you want to reset the token?"):
+                await red._config.token.set("")
                 print("Token has been reset.")
-    except KeyboardInterrupt:
-        log.info("Keyboard interrupt detected. Quitting...")
-        loop.run_until_complete(red.logout())
-        red._shutdown_mode = ExitCodes.SHUTDOWN
-    except Exception as e:
-        log.critical("Fatal exception", exc_info=e)
-        loop.run_until_complete(red.logout())
-    finally:
-        pending = asyncio.Task.all_tasks(loop=red.loop)
-        gathered = asyncio.gather(*pending, loop=red.loop, return_exceptions=True)
-        gathered.cancel()
-        try:
-            loop.run_until_complete(red.rpc.close())
-        except AttributeError:
-            pass
+                sys.exit(0)
+        sys.exit(1)
+    except discord.PrivilegedIntentsRequired:
+        print(
+            "Red requires all Privileged Intents to be enabled.\n"
+            "You can find out how to enable Privileged Intents with this guide:\n"
+            "https://docs.discord.red/en/stable/bot_application_guide.html#enabling-privileged-intents"
+        )
+        sys.exit(1)
 
-        sys.exit(red._shutdown_mode.value)
+    return None
+
+
+def handle_early_exit_flags(cli_flags: Namespace):
+    if cli_flags.list_instances:
+        list_instances()
+    elif cli_flags.version:
+        print("Red V3")
+        print("Current Version: {}".format(__version__))
+        sys.exit(0)
+    elif cli_flags.debuginfo:
+        debug_info()
+    elif not cli_flags.instance_name and (not cli_flags.no_instance or cli_flags.edit):
+        print("Error: No instance name was provided!")
+        sys.exit(1)
+
+
+async def shutdown_handler(red, signal_type=None, exit_code=None):
+    if signal_type:
+        log.info("%s received. Quitting...", signal_type)
+        # Do not collapse the below line into other logic
+        # We need to renter this function
+        # after it interrupts the event loop.
+        sys.exit(ExitCodes.SHUTDOWN)
+    elif exit_code is None:
+        log.info("Shutting down from unhandled exception")
+        red._shutdown_mode = ExitCodes.CRITICAL
+
+    if exit_code is not None:
+        red._shutdown_mode = exit_code
+
+    try:
+        await red.logout()
+    finally:
+        # Then cancels all outstanding tasks other than ourselves
+        pending = [t for t in asyncio.all_tasks() if t is not asyncio.current_task()]
+        [task.cancel() for task in pending]
+        await asyncio.gather(*pending, return_exceptions=True)
+
+
+def global_exception_handler(red, loop, context):
+    """
+    Logs unhandled exceptions in other tasks
+    """
+    msg = context.get("exception", context["message"])
+    # These will get handled later when it *also* kills loop.run_forever
+    if not isinstance(msg, (KeyboardInterrupt, SystemExit)):
+        if isinstance(msg, Exception):
+            log.critical("Caught unhandled exception in task:\n", exc_info=msg)
+        else:
+            log.critical("Caught unhandled exception in task: %s", msg)
+
+
+def red_exception_handler(red, red_task: asyncio.Future):
+    """
+    This is set as a done callback for Red
+
+    must be used with functools.partial
+
+    If the main bot.run dies for some reason,
+    we don't want to swallow the exception and hang.
+    """
+    try:
+        red_task.result()
+    except (SystemExit, KeyboardInterrupt, asyncio.CancelledError):
+        pass  # Handled by the global_exception_handler, or cancellation
+    except Exception as exc:
+        log.critical("The main bot task didn't handle an exception and has crashed", exc_info=exc)
+        log.warning("Attempting to die as gracefully as possible...")
+        red.loop.create_task(shutdown_handler(red))
+
+
+def main():
+    red = None  # Error handling for users misusing the bot
+    cli_flags = parse_cli_flags(sys.argv[1:])
+    handle_early_exit_flags(cli_flags)
+    if cli_flags.edit:
+        handle_edit(cli_flags)
+        return
+    try:
+        loop = asyncio.new_event_loop()
+        asyncio.set_event_loop(loop)
+
+        if cli_flags.no_instance:
+            print(
+                "\033[1m"
+                "Warning: The data will be placed in a temporary folder and removed on next system "
+                "reboot."
+                "\033[0m"
+            )
+            cli_flags.instance_name = "temporary_red"
+            data_manager.create_temp_config()
+
+        data_manager.load_basic_configuration(cli_flags.instance_name)
+
+        red = Red(cli_flags=cli_flags, description="Red V3", dm_help=None)
+
+        if os.name != "nt":
+            # None of this works on windows.
+            # At least it's not a redundant handler...
+            signals = (signal.SIGHUP, signal.SIGTERM, signal.SIGINT)
+            for s in signals:
+                loop.add_signal_handler(
+                    s, lambda s=s: asyncio.create_task(shutdown_handler(red, s))
+                )
+
+        exc_handler = functools.partial(global_exception_handler, red)
+        loop.set_exception_handler(exc_handler)
+        # We actually can't (just) use asyncio.run here
+        # We probably could if we didn't support windows, but we might run into
+        # a scenario where this isn't true if anyone works on RPC more in the future
+        fut = loop.create_task(run_bot(red, cli_flags))
+        r_exc_handler = functools.partial(red_exception_handler, red)
+        fut.add_done_callback(r_exc_handler)
+        loop.run_forever()
+    except KeyboardInterrupt:
+        # We still have to catch this here too. (*joy*)
+        log.warning("Please do not use Ctrl+C to Shutdown Red! (attempting to die gracefully...)")
+        log.error("Received KeyboardInterrupt, treating as interrupt")
+        if red is not None:
+            loop.run_until_complete(shutdown_handler(red, signal.SIGINT))
+    except SystemExit as exc:
+        # We also have to catch this one here. Basically any exception which normally
+        # Kills the python interpreter (Base Exceptions minus asyncio.cancelled)
+        # We need to do something with prior to having the loop close
+        log.info("Shutting down with exit code: %s", exc.code)
+        if red is not None:
+            loop.run_until_complete(shutdown_handler(red, None, exc.code))
+    except Exception as exc:  # Non standard case.
+        log.exception("Unexpected exception (%s): ", type(exc), exc_info=exc)
+        if red is not None:
+            loop.run_until_complete(shutdown_handler(red, None, ExitCodes.CRITICAL))
+    finally:
+        # Allows transports to close properly, and prevent new ones from being opened.
+        # Transports may still not be closed correctly on windows, see below
+        loop.run_until_complete(loop.shutdown_asyncgens())
+        # *we* aren't cleaning up more here, but it prevents
+        # a runtime error at the event loop on windows
+        # with resources which require longer to clean up.
+        # With other event loops, a failure to cleanup prior to here
+        # results in a resource warning instead
+        log.info("Please wait, cleaning up a bit more")
+        loop.run_until_complete(asyncio.sleep(2))
+        asyncio.set_event_loop(None)
+        loop.stop()
+        loop.close()
+        exit_code = red._shutdown_mode if red is not None else 1
+        sys.exit(exit_code)
 
 
 if __name__ == "__main__":