Bump the version to 3.3.2 (#3622)

* 3.3.2 changelog

* few fixes

* add contributors

* that one last change from milestone

.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

.github/CODEOWNERS

@@ -9,27 +9,32 @@ 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/json_io.py                   @tekulvw
 redbot/core/modlog.py                    @palmtree5
 redbot/core/rpc.py                       @tekulvw
-redbot/core/sentry_setup.py              @Kowlin @tekulvw
 redbot/core/utils/chat_formatting.py     @tekulvw
 redbot/core/utils/mod.py                 @palmtree5
+redbot/core/utils/data_converter.py      @mikeshardmind
+redbot/core/utils/antispam.py            @mikeshardmind
+redbot/core/utils/tunnel.py              @mikeshardmind
+redbot/core/utils/caching.py             @mikeshardmind
+redbot/core/utils/common_filters.py      @mikeshardmind
+redbot/core/utils/dbtools.py             @mikeshardmind
 
 # Cogs
 redbot/cogs/admin/*                 @tekulvw
 redbot/cogs/alias/*                 @tekulvw
-redbot/cogs/audio/*                 @tekulvw
+redbot/cogs/audio/*                 @aikaterna @Drapersniper
 redbot/cogs/bank/*                  @tekulvw
 redbot/cogs/cleanup/*               @palmtree5
 redbot/cogs/customcom/*             @palmtree5
-redbot/cogs/downloader/*            @tekulvw
+redbot/cogs/downloader/*            @tekulvw @jack1142
 redbot/cogs/economy/*               @palmtree5
 redbot/cogs/filter/*                @palmtree5
 redbot/cogs/general/*               @palmtree5
@@ -38,12 +43,23 @@ 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
 
 # Docs
 docs/*                              @tekulvw @palmtree5
 
+# Tests
+tests/cogs/downloader/*             @jack1142
+
 # Setup, instance setup, and running the bot
 setup.py                            @tekulvw
 redbot/__init__.py                  @tekulvw
-redbot/__main__.py                  @tekulvw
+redbot/__main__.py                  @tekulvw @mikeshardmind
 redbot/setup.py                     @tekulvw
+
+# Others
+.travis.yml                         @Kowlin
+crowdin.yml                         @Kowlin
+.github/workflows/*                 @Kowlin

.github/CONTRIBUTING.md

@@ -1,23 +1,43 @@
-# Introduction
-### Welcome!
-First off, thank you for contributing to the further development of Red. We're always looking for new ways to improve our project and we appreciate any help you can give us.
+# Contents
+* [1. Introduction](#1-introduction)
+  * [1.1 Why do these guidelines exist?](#11-why-do-these-guidelines-exist)
+  * [1.2 What kinds of contributions are we looking for?](#12-what-kinds-of-contributions-are-we-looking-for)
+* [2. Ground Rules](#2-ground-rules)
+* [3. Your First Contribution](#3-your-first-contribution)
+* [4. Getting Started](#4-getting-started)
+  * [4.1 Setting up your development environment](#41-setting-up-your-development-environment)
+  * [4.2 Testing](#42-testing)
+  * [4.3 Style](#43-style)
+  * [4.4 Make](#44-make)
+  * [4.5 Keeping your dependencies up to date](#45-keeping-your-dependencies-up-to-date)
+  * [4.6 To contribute changes](#46-to-contribute-changes)
+  * [4.7 Using towncrier](#47-using-towncrier)
+  * [4.8 How To Report A Bug](#48-how-to-report-a-bug)
+  * [4.9 How To Suggest A Feature Or Enhancement](#49-how-to-suggest-a-feature-or-enhancement)
+* [5. Code Review Process](#5-code-review-process)
+  * [5.1 Issues](#51-issues)
+  * [5.2 Pull Requests](#52-pull-requests)
+  * [5.3 Differences between "new features" and "improvements"](#53-differences-between-new-features-and-improvements)
+* [6. Community](#6-community)
 
-### Why do these guidelines exist?
+# 1. Introduction
+**Welcome!** First off, thank you for contributing to the further development of Red. We're always looking for new ways to improve our project and we appreciate any help you can give us.
+
+### 1.1 Why do these guidelines exist?
 Red is an open source project. This means that each and every one of the developers and contributors who have helped make Red what it is today have done so by volunteering their time and effort. It takes a lot of time to coordinate and organize issues and new features and to review and test pull requests. By following these guidelines you will help the developers streamline the contribution process and save them time. In doing so we hope to get back to each and every issue and pull request in a timely manner.
 
-### What kinds of contributions are we looking for?
+### 1.2 What kinds of contributions are we looking for?
 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.
 
-# 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.
+# 2. Ground Rules
 1. Ensure cross compatibility for Windows, Mac OS and Linux.
-2. Ensure all Python features used in contributions exist and work in Python 3.5 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.
 6. Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
 
-# Your First Contribution
+# 3. Your First Contribution
 Unsure of how to get started contributing to Red? Please take a look at the Issues section of this repo and sort by the following labels:
 
 * beginner - issues that can normally be fixed in just a few lines of code and maybe a test or two.
@@ -27,49 +47,136 @@ Unsure of how to get started contributing to Red? Please take a look at the Issu
 
 At this point you're ready to start making changes. Feel free to ask for help; everyone was a beginner at some point!
 
-# Getting Started
-### Testing
-We've recently started adding unit-testing into Red. All current tests can be found in the `tests/` directory at the root level of the repository. You will need `py.test` installed in order to run them (which is already in `requirement.txt`). Tests can be run by simply calling `pytest` once you've `cd`'d into the Red repository folder.
+# 4. Getting Started
 
-### To contribute changes
-1. Create your own fork of the Red repository.
-2. Make the changes in your own fork.
+Red's repository is configured to follow a particular development workflow, using various reputable tools. We kindly ask that you stick to this workflow when contributing to Red, by following the guides below. This will help you to easily produce quality code, identify errors early, and streamline the code review process.
+
+### 4.1 Setting up your development environment
+The following requirements must be installed prior to setting up:
+ - Python 3.8.1 or greater
+ - git
+ - pip
+ 
+If you're not on Windows, you should also have GNU make installed, and you can optionally install [pyenv](https://github.com/pyenv/pyenv), which can help you run tests for different python versions.
+
+1. Fork and clone the repository to a directory on your local machine.
+2. Open a command line in that directory and execute the following command:
+    ```bash
+    make newenv
+    ```
+    Red, its dependencies, and all required development tools, are now installed to a virtual environment located in the `.venv` subdirectory. Red is installed in editable mode, meaning that edits you make to the source code in the repository will be reflected when you run Red.
+3. Activate the new virtual environment with one of the following commands:
+    - Posix:
+        ```bash
+        source .venv/bin/activate
+        ```
+    - Windows:
+        ```powershell
+        .venv\Scripts\activate
+        ```
+    Each time you open a new command line, you should execute this command first. From here onwards, we will assume you are executing commands from within this activated virtual environment.
+ 
+**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'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.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`)
+
+To run all of these tests, just run the command `tox` in the project directory.
+
+To run a subset of these tests, use the command `tox -e <env>`, where `<env>` is the test environment you want tox to run. The test environments are noted in the dot points above.
+
+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. This is already set in `pyproject.toml` configuration file in the repo so you can simply format code with Black like so: `black <src>`.
+
+### 4.4 Make
+You may have noticed we have a `Makefile` and a `make.bat` in the top-level directory. For now, you can do a few things with them:
+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.
+
+### 4.6 To contribute changes
+
+1. Create a new branch on your fork
+2. Make the changes
 3. If you like the changes and think the main Red project could use it:
-    * Ensure your code follows (generally) the PEP8 Python style guide
+    * Create a towncrier entry for the changes. (See next section for details)
+    * Run tests with `tox` to ensure your code is up to scratch
     * Create a Pull Request on GitHub with your changes
 
-### How To Report A Bug
+### 4.7 Using towncrier
+
+Red uses towncrier to create changelogs.
+
+To create a towncrier entry for your PR, create a file in `changelog.d` for it. If the changes are for a specific cog, place the file in the related subdirectory.
+
+The filename should be of the format `issuenumber.changetype(.count).rst`, where `(.count)` is an optional
+part of the filename should multiple entries for the same issue number and type be necessary.
+If there is not an issue associated with your PR,
+you may use the PR number in place of the issue number.
+
+Valid changetypes are:
+
+  * breaking : Breaking changes
+  * dep : Changes to dependencies
+  * enhance : Enhancements
+  * feature : New features
+  * bugfix : Bugfixes
+  * docs : documentation improvements and additions
+  * removal : removal of something
+  * misc : any changes which don't have a user facing change, and don't belong in the changelog for users
+
+The contents of the file should be a short, human readable description of the impact of the changes made,
+not the technical details of the change.
+
+### 4.8 How To Report A Bug
 Please see our **ISSUES.MD** for more information.
 
-### How To Suggest A Feature Or Enhancement
+### 4.9 How To Suggest A Feature Or Enhancement
 The goal of Red is to be as useful to as many people as possible, this means that all features must be useful to anyone and any server that uses Red.
 
 If you find yourself wanting a feature that Red does not already have, you're probably not alone. There's bound to be a great number of users out there needing the same thing and a lot of the features that Red has today have been added because of the needs of our users. Open an issue on our issues list and describe the feature you would like to see, how you would use it, how it should work, and why it would be useful to the Red community as a whole.
 
-# Code Review Process
+# 5. Code Review Process
 
 We have a core team working tirelessly to implement new features and fix bugs for the Red community. This core team looks at and evaluates new issues and PRs on a daily basis.
 
 The decisions we make are based on a simple majority of that team or by decree of the project owner.
 
-### Issues
+### 5.1 Issues
 Any new issues will be looked at and evaluated for validity of a bug or for the usefulness of a suggested feature. If we have questions about your issue we will get back as soon as we can (usually in a day or two) and will try to make a decision within a week.
 
-### Pull Requests
+### 5.2 Pull Requests
 Pull requests are evaluated by their quality and how effectively they solve their corresponding issue. The process for reviewing pull requests is as follows:
 
 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.
 5. If your pull request is not vetoed and no core member requests changes then it will be approved and merged into the project.
 
-### Differences between "new features" and "improvements"
+### 5.3 Differences between "new features" and "improvements"
 The difference between a new feature and improvement can be quite fuzzy and the project owner reserves all rights to decide under which category your PR falls.
 
 At a very basic level a PR is a new feature if it changes the intended way any part of the Red project currently works or if it modifies the user experience (UX) in any significant way. Otherwise, it is likely to be considered an improvement.
 
-# Community
+# 6. Community
 You can chat with the core team and other community members about issues or pull requests in the #coding channel of the Red support server located [here](https://discord.gg/red).

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+patreon: Red_Devs

.github/ISSUE_TEMPLATE.md

@@ -1,20 +1,5 @@
-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. 
+<!-- 
+Please be sure to use the correct template, 
+if your report doesn't have the correct template please open an issue describing your issue in detail
+For support regarding the bot itself please visit the discord server over at https://discord.gg/red
+-->

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

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

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

.github/ISSUE_TEMPLATE/feature_req.md

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

.github/ISSUE_TEMPLATE/other_bug.md

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

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

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

.github/PULL_REQUEST_TEMPLATE/bugfix.md

@@ -0,0 +1,15 @@
+# Bugfix request
+
+<!--
+THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
+To be used for pull requests that fix a bug
+-->
+
+#### Describe the bug being fixed
+
+<!-- 
+If an issue exists for the bug, mention 
+that this PR fixes that issue
+-->
+
+#### Anything we need to know about this fix?

.github/PULL_REQUEST_TEMPLATE/enhancement.md

@@ -0,0 +1,21 @@
+# Enhancement request
+
+<!--
+THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
+To be used for PRs which enhance existing features
+-->
+
+#### Describe the enhancement
+
+<!--
+Describe what your changes do.
+If adding commands, describe any restrictions on their usage.
+  - For example, who can use the command? Where can it be used?
+-->
+
+#### Does this enhancement break existing functionality?
+
+<!-- To check a box, replace the space between the [] with a x -->
+
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE/new_feature.md

@@ -0,0 +1,22 @@
+# New feature addition
+
+<!--
+THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
+To be used for PRs which add a new feature
+Examples of this include new APIs, new core cogs, etc.
+-->
+
+#### What type of feature is this?
+
+<!-- To check a box, replace the space between the [] with a x -->
+
+- [ ] New core cog
+- [ ] New API
+- [ ] Other
+
+#### Describe the feature
+
+<!--
+If you are adding a cog, describe its commands in detail (functionality, usage restrictions, etc).
+If the new feature introduces new requirements, please try to explain why they are necessary.
+-->

.github/PULL_REQUEST_TEMPLATE/release.md

@@ -0,0 +1,16 @@
+# New release
+
+<!--
+THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
+To be used by collaborators for doing releases.
+Most contributors will not need to use this.
+-->
+
+#### Version
+
+
+
+#### Has a draft release been created for this?
+
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE/translations.md

@@ -0,0 +1,6 @@
+# Translations update
+
+<!--
+THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
+Used for PRs updating translations from Crowdin
+-->

.github/workflows/auto_labeler.yml

@@ -0,0 +1,26 @@
+name: Auto Labeler
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply Triage Label
+        uses: actions/github-script@0.4.0
+        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/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@v1
+        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/publish_crowdin.yml

@@ -0,0 +1,58 @@
+name: Publish to Crowdin
+on:
+  schedule:
+    - cron: '0 12 * * THU'
+  repository_dispatch:
+    types: crowdin
+
+env:
+  CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
+  CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}
+
+jobs:
+  deploy:
+    if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.8'
+    - name: Install dependencies
+      run: |
+        curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
+        echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
+        sudo apt-get update -qq
+        sudo apt-get install -y crowdin
+        pip install redgettext==3.1
+    - name: Generate source files
+      run: |
+        make gettext
+    - name: Upload source files
+      run: |
+        make upload_translations
+    - name: Download translations
+      run: |
+        make download_translations
+    - name: Remove files from PR which only have a date changed
+      run: |
+        git checkout HEAD -- $(git diff HEAD --numstat | awk 'BEGIN {ORS=" "} $1 == "1" && $2 == "1" && $3 ~ /.po$/ {print $3}')
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v2
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        commit-message: Automated Crowdin downstream
+        title: "[i18n] Automated Crowdin downstream"
+        body: |
+          This is an automated PR.
+          Please ensure that there are no errors or invalid files are in the PR.
+        labels: "Automated PR, Category: i18n"
+        branch: "automated/i18n"
+    - name: Repository Dispatch
+      uses: peter-evans/repository-dispatch@v1
+      with:
+        token: ${{ secrets.cogcreators_bot_repo_scoped }}
+        repository: Cog-Creators/Red-DiscordBot
+        event-type: dispatched_test
+        client-payload: '{"ref": "automated/i18n"}'

.github/workflows/publish_pypi.yml

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

.github/workflows/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@v1
+          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@v1
+          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,40 +1,18 @@
-# Trivia list repo injection
-redbot/trivia/
-
 *.json
 *.exe
 *.dll
+*.pot
 .data
+!/tests/cogs/dataconverter/data/**/*.json
+Pipfile
+Pipfile.lock
 
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
-# Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# CMake
-cmake-build-debug/
-
-# Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
-## File-based project format:
+.idea/
 *.iws
 
 ## Plugin-specific files:
@@ -79,6 +57,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -156,3 +135,8 @@ ENV/
 # mypy
 .mypy_cache/
 
+# pytest
+.pytest_cache/
+
+# Pre-commit hooks
+/.pre-commit-config.yaml

.pylintrc

@@ -0,0 +1,148 @@
+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=pytest
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# DO NOT CHANGE THIS VALUE # Use multiple processes to speed up Pylint.
+jobs=1
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code
+extension-pkg-whitelist=
+
+# Allow optimization of some AST trees. This will activate a peephole AST
+# optimizer, which will apply various small optimizations. For instance, it can
+# be used to obtain the result of joining multiple strings with the addition
+# operator. Joining a lot of strings can lead to a maximum recursion error in
+# Pylint and this flag can prevent that. It has one side effect, the resulting
+# AST will be different than the one from reality.
+optimize-ast=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time. See also the "--disable" option for examples.
+
+
+enable=all
+
+disable=C, # black is enforcing this for us already, incompatibly
+    W, # unbroaden this to the below specifics later on.
+    W0107, # uneccessary pass is stylisitc in most places
+    W0212, # Should likely refactor around protected access warnings later
+    W1203, # fstrings are too fast to care about enforcing this.
+    W0612, # unused vars can sometimes indicate an issue, but ...
+    W1401, # Should probably fix the reason this is disabled (start up screen)
+    W0511, # Nope, todos are fine for future people to see things to do.
+    W0613, # Too many places where we need to take unused args do to d.py ... also menus
+    W0221, # Overriden converters.
+    W0223, # abstractmethod not defined in mixins is expected
+    I, # ...
+    R # While some of these have merit, It's too large a burden to enable this right now.
+
+
+[REPORTS]
+
+output-format=parseable
+files-output=no
+reports=no
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging
+
+
+[TYPECHECK]
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# TODO: Write a plyint plugin to allow this with these mixin classes
+# To use the abstractmethod we know will be defined in the final class.
+ignored-classes=redbot.cogs.mod.movetocore.MoveToCore,
+    redbot.cogs.mod.kickban.KickBanMixin,
+    redbot.cogs.mod.mutes.MuteMixin,
+    redbot.cogs.mod.names.ModInfo,
+    redbot.cogs.mod.settings.ModSettings,
+    redbot.cogs.mod.events.Events
+
+ignored-modules=distutils  # https://github.com/PyCQA/pylint/issues/73
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the name of dummy variables (i.e. expectedly
+# not used).
+dummy-variables-rgx=_$|dummy
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,__call__
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception,discord.DiscordException

.readthedocs.yml

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

.travis.yml

@@ -1,42 +1,65 @@
-dist: trusty
+dist: xenial
 language: python
-python:
-- 3.5.3
-- 3.6.1
-install:
-- echo "pytest>3" >> requirements.txt
-- echo "pytest-asyncio" >> requirements.txt
-- echo "git+https://github.com/Rapptz/discord.py.git@rewrite#egg=discord.py[voice]"
-  >> requirements.txt
-- pip install -r requirements.txt
-- pip install .
-script:
-- python -m compileall ./redbot/cogs
-- python -m pytest
-before_deploy:
-- curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
-- echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
-- sudo apt-get update -qq
-- sudo apt-get install -y crowdin
-deploy:
-  - provider: pypi
-    user: Red-DiscordBot
-    password:
-      secure: Ty9vYnd/wCuQkVC/OsS4E2jT9LVDVfzsFrQc4U2hMYcTJnYbl/3omyObdCWCOBC40vUDkVHAQU8ULHzoCA+2KX9Ds/7/P5zCumAA0uJRR9Smw7OlRzSMxJI+/lGq4CwXKzxDZKuo5rsxXEbW5qmYjtO8Mk6KuLkvieb1vyr2DcqWEFzg/7TZNDfD1oP8et8ITQ26lLP1dtQx/jlAiIBzgK9wziuwj1Divb9A///VsGz43N8maZ+jfsDjYqrfUVWTy3ar7JPUplletenYCR1PmQ5C46XfV0kitKd1aITJ48YPAKyYgKy8AIT+Uz1JArTnqdzLSFRNELS57qS00lzgllbteCyWQ8Uzy0Zpxb/5DDH8/mL1n0MyJrF8qjZd2hLNAXg3z/k9bGXeiMLGwoxRlGXkL2XpiVgI93UKKyVyooGNMgPTc/QdSc7krjAWcOtX/HgLR34jxeLPFEdzJNAFIimfDD8N+XTFcNBw6EvOYm/n5MXkckNoX/G+ThNobHZ7VKSASltZ9zBRAJ2dDh35G3CYmVEk33U77RKbL9le/Za9QVBcAO8i6rqVGYkdO7thHHKHc/1CB1jNnjsFSDt0bURtNfAqfwKCurQC8487zbEzT+2fog3Wygv7g3cklaRg4guY8UjZuFWStYGqbroTsOCd9ATNqeO5B13pNhllSzU=
-    skip_cleanup: true
-    on:
-      repo: Cog-Creators/Red-DiscordBot
-      branch: V3/develop
-      python: 3.5.3
-      tags: true
-  - provider: script
-    script: python3 ./generate_strings.py
-    skip_cleanup: true
-    on:
-      repo: Cog-Creators/Red-DiscordBot
-      branch: V3/develop
-      python: 3.5.3
-      tags: true
 cache: pip
 notifications:
   email: false
+
+python:
+- 3.8.1
+env:
+  global:
+    - PIPENV_IGNORE_VIRTUALENVS=1
+
+install:
+- pip install --upgrade pip tox
+
+script:
+- tox
+
+jobs:
+  include:
+    - env: TOXENV=py
+    - env: TOXENV=docs
+    - env: TOXENV=style
+    - env: TOXENV=postgres
+      services: postgresql
+      addons:
+        postgresql: "10"
+      before_script:
+        - psql -c 'create database red_db;' -U postgres
+    # These jobs only occur on tag creation if the prior ones succeed
+    - stage: PyPi Deployment
+      if: tag IS present
+      python: 3.8.1
+      env:
+        - DEPLOYING=true
+        - TOXENV=py38
+      deploy:
+        - provider: pypi
+          distributions: sdist bdist_wheel
+          user: Red-DiscordBot
+          password:
+            secure: Ty9vYnd/wCuQkVC/OsS4E2jT9LVDVfzsFrQc4U2hMYcTJnYbl/3omyObdCWCOBC40vUDkVHAQU8ULHzoCA+2KX9Ds/7/P5zCumAA0uJRR9Smw7OlRzSMxJI+/lGq4CwXKzxDZKuo5rsxXEbW5qmYjtO8Mk6KuLkvieb1vyr2DcqWEFzg/7TZNDfD1oP8et8ITQ26lLP1dtQx/jlAiIBzgK9wziuwj1Divb9A///VsGz43N8maZ+jfsDjYqrfUVWTy3ar7JPUplletenYCR1PmQ5C46XfV0kitKd1aITJ48YPAKyYgKy8AIT+Uz1JArTnqdzLSFRNELS57qS00lzgllbteCyWQ8Uzy0Zpxb/5DDH8/mL1n0MyJrF8qjZd2hLNAXg3z/k9bGXeiMLGwoxRlGXkL2XpiVgI93UKKyVyooGNMgPTc/QdSc7krjAWcOtX/HgLR34jxeLPFEdzJNAFIimfDD8N+XTFcNBw6EvOYm/n5MXkckNoX/G+ThNobHZ7VKSASltZ9zBRAJ2dDh35G3CYmVEk33U77RKbL9le/Za9QVBcAO8i6rqVGYkdO7thHHKHc/1CB1jNnjsFSDt0bURtNfAqfwKCurQC8487zbEzT+2fog3Wygv7g3cklaRg4guY8UjZuFWStYGqbroTsOCd9ATNqeO5B13pNhllSzU=
+          skip_cleanup: true
+          on:
+            repo: Cog-Creators/Red-DiscordBot
+            tags: true
+    - stage: Crowdin Deployment
+      if: tag IS present OR ENV(BUILD_CROWDIN)
+      python: 3.8.1
+      env:
+        - DEPLOYING=true
+        - TOXENV=py38
+      before_deploy:
+      - curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
+      - echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
+      - sudo apt-get update -qq
+      - sudo apt-get install -y crowdin
+      - pip install redgettext==3.1
+      deploy:
+      - provider: script
+        script: make upload_translations
+        skip_cleanup: true
+        on:
+          repo: Cog-Creators/Red-DiscordBot
+          tags: true

LICENSE

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     Red - A fully customizable Discord bot
-    Copyright (C) 2015-2018  Twentysix
+    Copyright (C) 2015-2020  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 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    Red-DiscordBot  Copyright (C) 2015-2018  Twentysix
+    Red-DiscordBot  Copyright (C) 2015-2020  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.
@@ -672,3 +672,31 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
+The Red-DiscordBot project contains subcomponents in audio.py that have a 
+separate copyright notice and license terms. Your use of the source code for 
+these subcomponents is subject to the terms and conditions of the following 
+licenses.
+
+This product bundles methods from https://github.com/Just-Some-Bots/MusicBot/
+blob/master/musicbot/spotify.py which are available under an MIT license.
+
+Copyright (c) 2015-2018 Just-Some-Bots (https://github.com/Just-Some-Bots)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+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.

MANIFEST.in

@@ -1,4 +0,0 @@
-include README.rst
-include LICENSE
-include requirements.txt
-include discord/bin/*.dll

Makefile

@@ -0,0 +1,34 @@
+PYTHON ?= python3.8
+
+# Python Code Style
+reformat:
+	$(PYTHON) -m black `git ls-files "*.py"`
+stylecheck:
+	$(PYTHON) -m black --check `git ls-files "*.py"`
+stylediff:
+	$(PYTHON) -m black --check --diff `git ls-files "*.py"`
+
+# Translations
+gettext:
+	$(PYTHON) -m redgettext --command-docstrings --verbose --recursive redbot --exclude-files "redbot/pytest/**/*"
+upload_translations:
+	crowdin upload sources
+download_translations:
+	crowdin download
+
+# Dependencies
+bumpdeps:
+	$(PYTHON) tools/bumpdeps.py
+
+# Development environment
+newenv:
+	$(PYTHON) -m venv --clear .venv
+	.venv/bin/pip install -U pip setuptools
+	$(MAKE) syncenv
+syncenv:
+	.venv/bin/pip install -Ur ./tools/dev-requirements.txt
+
+# Changelog check
+checkchangelog:
+	bash tools/check_changelog_entries.sh
+	$(PYTHON) -m towncrier --draft

README.md

@@ -0,0 +1,128 @@
+<h1 align="center">
+  <br>
+  <a href="https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop"><img src="https://imgur.com/pY1WUFX.png" alt="Red - Discord Bot"></a>
+  <br>
+  Red Discord Bot
+  <br>
+</h1>
+
+<h4 align="center">Music, Moderation, Trivia, Stream Alerts and Fully Modular.</h4>
+
+<p align="center">
+  <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>
+  <a href="https://www.python.org/downloads/">
+    <img src="https://img.shields.io/badge/Made%20With-Python%203.8-blue.svg?style=for-the-badge" alt="Made with Python 3.8">
+  </a>
+  <a href="https://crowdin.com/project/red-discordbot">
+    <img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg" alt="Localized with Crowdin">
+  </a>
+  <a href="https://github.com/Rapptz/discord.py/">
+      <img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/Cog-Creators/Red-DiscordBot/actions">
+    <img src="https://github.com/Cog-Creators/Red-DiscordBot/workflows/Tests/badge.svg" alt="GitHub Actions">
+  </a>
+  <a href="http://red-discordbot.readthedocs.io/en/stable/?badge=stable">
+    <img src="https://readthedocs.org/projects/red-discordbot/badge/?version=stable" alt="Red on readthedocs.org">
+  </a>
+  <a href="https://github.com/ambv/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
+  </a>
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#overview">Overview</a>
+  •
+  <a href="#installation">Installation</a>
+  •
+  <a href="http://red-discordbot.readthedocs.io/en/stable/index.html">Documentation</a>
+  •
+  <a href="#plugins">Plugins</a>
+  •
+  <a href="#join-the-community">Community</a>
+  •
+  <a href="#license">License</a>
+</p>
+
+# 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
+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.
+
+**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)
+- Bank (slot machine, user credits)
+- Custom commands
+- Imgur/gif search
+- Admin automation (self-role assignment, cross-server announcements, mod-mail reports)
+- Customisable command permissions
+
+**Additionally, other [plugins](#plugins) (cogs) can be easily found and added from our growing
+community of cog repositories.**
+
+# Installation
+
+**The following platforms are officially supported:** 
+
+- [Windows](https://red-discordbot.readthedocs.io/en/stable/install_windows.html)
+- [MacOS](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
+- [Most major linux distributions](https://red-discordbot.readthedocs.io/en/stable/install_linux_mac.html)
+
+If after reading the guide you are still experiencing issues, feel free to join the
+[Official Discord Server](https://discord.gg/red) and ask in the **#support** channel for help.
+
+# Plugins
+
+Red is fully modular, allowing you to load and unload plugins of your choice, and install 3rd party
+plugins directly from Discord! A few examples are:
+
+- Cleverbot integration (talk to Red and she talks back)
+- Ban sync
+- Welcome messages
+- Casino
+- Reaction roles
+- Slow Mode
+- AniList
+- And much, much more!
+
+Feel free to take a [peek](https://cogboard.red/t/approved-repositories/210) at a list of
+available 3rd party cogs!
+
+# Join the community!
+
+**Red** is in continuous development, and it’s supported by an active community which produces new
+content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t
+[find](https://cogboard.red/t/approved-repositories/210) the cog you’re looking for,
+consult our [guide](https://red-discordbot.readthedocs.io/en/stable/guide_cog_creation.html) on
+building your own cogs!
+
+Join us on our [Official Discord Server](https://discord.gg/red)!
+
+# License
+
+Released under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.
+
+Red is named after the main character of "Transistor", a video game by
+[Super Giant Games](https://www.supergiantgames.com/games/transistor/).
+
+Artwork created by [Sinlaire](https://sinlaire.deviantart.com/) on Deviant Art for the Red Discord
+Bot Project.

README.rst

@@ -1,38 +0,0 @@
-.. image:: https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop
-    :target: http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop
-    :alt: Documentation Status
-
-.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
-    :target: http://makeapullrequest.com
-    :alt: PRs Welcome
-
-.. image:: https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg
-    :target: https://crowdin.com/project/red-discordbot
-    :alt: Crowdin
-
-********************
-Red - Discord Bot v3
-********************
-
-**This is in beta and very much a work in progress. Regular use is not recommended.
-There will not be any effort made to prevent the breaking of current installations.**
-
-How to install
-^^^^^^^^^^^^^^
-
-Using python3 pip::
-
-    pip install --process-dependency-links -U Red-DiscordBot
-    redbot-setup
-    redbot <name>
-
-To install requirements for voice::
-
-    pip install --process-dependency-links -U Red-DiscordBot[voice]
-
-To install all requirements for docs and tests::
-
-    pip install --process-dependency-links -U Red-DiscordBot[test,docs]
-
-For the latest git build, replace ``Red-DiscordBot`` in the above commands with
-``git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop``.

changelog.d/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/3256.dep.rst

@@ -0,0 +1 @@
+Use websockets 8.1

changelog.d/3472.enhance.rst

@@ -0,0 +1,4 @@
+Add caching for ignored channels/guilds.
+Add caching for white/blacklist.
+Add consume-rest for white/blacklist commands.
+Allow ignoring channel categories.

changelog.d/3526.enhance.rst

@@ -0,0 +1 @@
+Show DeprecationWarning's

changelog.d/admin/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/alias/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/audio/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/audio/3201.feature.1.rst

@@ -0,0 +1 @@
+``[p]remove`` command now accepts an URL or Index, if an URL is used it will remove all tracks in the queue with that URL.

changelog.d/bank/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/cleanup/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/customcom/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/downloader/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/economy/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/economy/3438.bugfix.rst

@@ -0,0 +1 @@
+Changes next_payday to last_payday. last_payday stores the latest time the command runned successfully, allows the command to dynamicly change with the PAYDAY_TIME variable, by checking if last_payday + PAYDAY_TIME >= current time.

changelog.d/filter/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/general/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/image/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/mod/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/mod/3472.enhance.rst

@@ -0,0 +1 @@
+Move ignore commands and checks into core.

changelog.d/mod/3523.bugfix.rst

@@ -0,0 +1,2 @@
+Allow mentions in hackban and ban commands.
+Have the correct lower bound on length of a snowflake for the converter.

changelog.d/modlog/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/mutes/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/permissions/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/reports/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/streams/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/streams/3237.enhance.rst

@@ -0,0 +1 @@
+Added ``[p]streamset timer`` command, which can be used to control how often the cog checks for livestreams.

changelog.d/streams/3237.misc.rst

@@ -0,0 +1 @@
+Changed the YouTube streams logic to use an RSS instead of the search endpoint, significantly reducing quota usage.

changelog.d/streams/3487.enhancement.rst

@@ -0,0 +1 @@
+Use new Twitch API and Bearer tokens. Escape markdown and mass mentions for "streamer_name is live!" messages, and use humanize_number for every numbers.

changelog.d/trivia/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/warnings/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changelog.d/warnings/3515.misc.rst

@@ -0,0 +1 @@
+Don't use `inspect.getsource` to check for ``is_owner`` check.

crowdin.yml

@@ -1,5 +1,9 @@
 api_key_env: CROWDIN_API_KEY
 project_identifier_env: CROWDIN_PROJECT_ID
+base_path: ./redbot/
+preserve_hierarchy: true
 files:
-  - source: /**/*.pot
+  - source: cogs/**/messages.pot
+    translation: /%original_path%/%locale%.po
+  - source: core/**/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,44 @@
+.. pm2 service guide
+
+==============================================
+Setting up auto-restart using pm2 on Linux
+==============================================
+
+.. note:: This guide is for setting up PM2 on a Linux environment. This guide assumes that you already have a working Red instance.
+
+--------------
+Installing PM2
+--------------
+
+Start by installing Node.JS and NPM via your favorite package distributor. From there run the following command:
+
+:code:`npm install pm2 -g`
+
+After PM2 is installed, run the following command to enable your Red instance to be managed by PM2. Replace the brackets with the required information.
+You can add additional Red based arguments after the instance, such as :code:`--dev`.
+
+.. code-block:: none
+
+    pm2 start redbot --name "<Insert a name here>" --interpreter "<Location to your Python Interpreter>" --interpreter-args "-O" -- <Red Instance> --no-prompt
+
+.. code-block:: none
+
+    Arguments to replace.
+
+    <Insert a name here>
+    A name to identify the bot within pm2, this is not your Red instance.
+
+    <Location to your Python Interpreter>
+    The location of your Python interpreter, to find out where that is use the following command inside activated venv:
+    which python
+
+    <Red Instance>
+    The name of your Red instance.
+
+------------------------------
+Ensuring that PM2 stays online
+------------------------------
+
+To make sure that PM2 stays online and persistence between machine restarts, run the following commands:
+
+:code:`pm2 save` & :code:`pm2 startup`

docs/autostart_systemd.rst

@@ -0,0 +1,84 @@
+.. _systemd-service-guide:
+
+==============================================
+Setting up auto-restart using systemd on Linux
+==============================================
+
+-------------------------
+Creating the 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 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=path -O -m redbot %I --no-prompt
+    User=username
+    Group=username
+    Type=idle
+    Restart=always
+    RestartSec=15
+    RestartPreventExitStatus=0
+    TimeoutStopSec=10
+
+    [Install]
+    WantedBy=multi-user.target
+
+Save and exit :code:`ctrl + O; enter; ctrl + x`
+
+---------------------------------
+Starting and enabling the service
+---------------------------------
+
+.. note:: This same file can be used to start as many instances of the bot as you wish, without creating more service files, just start and enable more services and add any bot instance name after the **@**
+
+To start the bot, run the service and add the instance name after the **@**:
+
+:code:`sudo systemctl start red@instancename`
+
+To set the bot to start on boot, you must enable the service, again adding the instance name after the **@**:
+
+:code:`sudo systemctl enable red@instancename`
+
+If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
+type the following command in the terminal, still by adding the instance name after the **@**:
+
+:code:`sudo systemctl stop red@instancename`
+
+.. warning:: If the service doesn't stop in the next 10 seconds, the process is killed.
+    Check your logs to know the cause of the error that prevents the shutdown.
+
+To view Red’s log, you can acccess through journalctl:
+
+:code:`sudo journalctl -eu red@instancename`

docs/changelog_3_1_0.rst

@@ -0,0 +1,232 @@
+.. v3.1.0 Changelog
+
+####################
+v3.1.0 Release Notes
+####################
+
+----------------------
+Mongo Driver Migration
+----------------------
+
+Due to the required changes of the Mongo driver for Config, all existing Mongo users will need to
+complete the below instructions to continue to use Mongo after updating to 3.1.
+This includes **all** users, regardless of any prior migration attempt to a development version of
+3.1.
+
+ #. Upgrade to 3.1
+ #. Convert all existing Mongo instances to JSON using the new converters
+ #. Start each bot instance while using JSON and load any and all cogs you have in order to successfully preserve data.
+ #. Turn each instance off and convert back to Mongo.
+    **NOTE:** No data is wiped from your Mongo database when converting to JSON.
+    You may want to use a *new* database name when converting back to Mongo in order to not have duplicate data.
+
+-------------
+Setup Utility
+-------------
+
+New commands were introduced to simplify the conversion/editing/removal process both on our end and the users end.
+Please use ``redbot-setup --help`` to learn how to use the new features.
+
+.. HINT::
+
+    Converting to JSON: ``redbot-setup convert <instance_name> json``
+
+    Converting to Mongo: ``redbot-setup convert <instance_name> mongo``
+
+################
+v3.1.0 Changelog
+################
+
+-----
+Audio
+-----
+
+ * Add Spotify support (`#2328`_)
+ * Play local folders via text command (`#2457`_)
+ * Change pause to a toggle (`#2461`_)
+ * Remove aliases (`#2462`_)
+ * Add track length restriction (`#2465`_)
+ * Seek command can now seek to position (`#2470`_)
+ * Add option for dc at queue end (`#2472`_)
+ * Emptydisconnect and status refactor (`#2473`_)
+ * Queue clean and queue clear addition (`#2476`_)
+ * Fix for audioset status (`#2481`_)
+ * Playlist download addition (`#2482`_)
+ * Add songs when search-queuing (`#2513`_)
+ * Match v2 behavior for channel change (`#2521`_)
+ * Bot will no longer complain about permissions when trying to connect to user-limited channel, if it has "Move Members" permission (`#2525`_)
+ * Fix issue on audiostats command when more than 20 servers to display (`#2533`_)
+ * Fix for prev command display (`#2556`_)
+ * Fix for localtrack playing (`#2557`_)
+ * Fix for playlist queue when not playing (`#2586`_)
+ * Track search and append fixes (`#2591`_)
+ * DJ role should ask for a role (`#2606`_)
+
+----
+Core
+----
+
+ * Warn on usage of ``yaml.load`` (`#2326`_)
+ * New Event dispatch: ``on_message_without_command`` (`#2338`_)
+ * Improve output format of cooldown messages (`#2412`_)
+ * Delete cooldown messages when expired (`#2469`_)
+ * Fix local blacklist/whitelist management (`#2531`_)
+ * ``[p]set locale`` now only accepts actual locales (`#2553`_)
+ * ``[p]listlocales`` now displays ``en-US`` (`#2553`_)
+ * ``redbot --version`` will now give you current version of Red (`#2567`_)
+ * Redesign help and related formatter (`#2628`_)
+ * Default locale changed from ``en`` to ``en-US`` (`#2642`_)
+ * New command ``[p]datapath`` that prints the bot's datapath (`#2652`_)
+
+------
+Config
+------
+
+ * Updated Mongo driver to support large guilds (`#2536`_)
+ * Introduced ``init_custom`` method on Config objects (`#2545`_)
+ * We now record custom group primary key lengths in the core config object (`#2550`_)
+ * Migrated internal UUIDs to maintain cross platform consistency (`#2604`_)
+
+-------------
+DataConverter
+-------------
+
+ * It's dead jim (Removal) (`#2554`_)
+
+----------
+discord.py
+----------
+
+ * No longer vendoring discord.py (`#2587`_)
+ * Upgraded discord.py dependency to version 1.0.1 (`#2587`_)
+
+----------
+Downloader
+----------
+
+ * ``[p]cog install`` will now tell user that cog has to be loaded (`#2523`_)
+ * The message when libraries fail to install is now formatted (`#2576`_)
+ * Fixed bug, that caused Downloader to include submodules on cog list (`#2590`_)
+ * ``[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 :ref:`info-json-format`. (`#2605`_)
+
+------
+Filter
+------
+
+ * Filter performs significantly better on large servers. (`#2509`_)
+
+--------
+Launcher
+--------
+
+* Fixed extras in the launcher (`#2588`_)
+
+---
+Mod
+---
+
+ * Admins can now decide how many times message has to be repeated before ``deleterepeats`` removes it (`#2437`_)
+ * Fix: make ``[p]ban [days]`` optional as per the doc (`#2602`_)
+ * Added the command ``voicekick`` to kick members from a voice channel with optional mod case. (`#2639`_)
+
+-----------
+Permissions
+-----------
+
+ * Removed: ``p`` alias for ``permissions`` command (`#2467`_)
+
+-------------
+Setup Scripts
+-------------
+
+ * ``redbot-setup`` now uses the click CLI library (`#2579`_)
+ * ``redbot-setup convert`` now used to convert between libraries (`#2579`_)
+ * Backup support for Mongo is currently broken (`#2579`_)
+
+-------
+Streams
+-------
+
+ * Add support for custom stream alert messages per guild (`#2600`_)
+ * Add ability to exclude rerun Twitch streams, and note rerun streams in embed status (`#2620`_)
+
+-----
+Tests
+-----
+
+ * Test for ``trivia`` cog uses explicitly utf-8 encoding for checking yaml files (`#2565`_)
+
+------
+Trivia
+------
+
+ * Fix of dead image link for Sao Tome and Principe in ``worldflags`` trivia (`#2540`_)
+
+-----------------
+Utility Functions
+-----------------
+
+ * New: ``chat_formatting.humanize_timedelta`` (`#2412`_)
+ * ``Tunnel`` - Spelling correction of method name - changed ``files_from_attatch`` to ``files_from_attach`` (old name is left for backwards compatibility) (`#2496`_)
+ * ``Tunnel`` - fixed behavior of ``react_close()``, now when tunnel closes message will be sent to other end (`#2507`_)
+ * ``chat_formatting.humanize_list`` - Improved error handling of empty lists (`#2597`_)
+
+.. _#2326: https://github.com/Cog-Creators/Red-DiscordBot/pull/2326
+.. _#2328: https://github.com/Cog-Creators/Red-DiscordBot/pull/2328
+.. _#2338: https://github.com/Cog-Creators/Red-DiscordBot/pull/2338
+.. _#2412: https://github.com/Cog-Creators/Red-DiscordBot/pull/2412
+.. _#2437: https://github.com/Cog-Creators/Red-DiscordBot/pull/2437
+.. _#2457: https://github.com/Cog-Creators/Red-DiscordBot/pull/2457
+.. _#2461: https://github.com/Cog-Creators/Red-DiscordBot/pull/2461
+.. _#2462: https://github.com/Cog-Creators/Red-DiscordBot/pull/2462
+.. _#2465: https://github.com/Cog-Creators/Red-DiscordBot/pull/2465
+.. _#2467: https://github.com/Cog-Creators/Red-DiscordBot/pull/2467
+.. _#2469: https://github.com/Cog-Creators/Red-DiscordBot/pull/2469
+.. _#2470: https://github.com/Cog-Creators/Red-DiscordBot/pull/2470
+.. _#2472: https://github.com/Cog-Creators/Red-DiscordBot/pull/2472
+.. _#2473: https://github.com/Cog-Creators/Red-DiscordBot/pull/2473
+.. _#2476: https://github.com/Cog-Creators/Red-DiscordBot/pull/2476
+.. _#2481: https://github.com/Cog-Creators/Red-DiscordBot/pull/2481
+.. _#2482: https://github.com/Cog-Creators/Red-DiscordBot/pull/2482
+.. _#2496: https://github.com/Cog-Creators/Red-DiscordBot/pull/2496
+.. _#2507: https://github.com/Cog-Creators/Red-DiscordBot/pull/2507
+.. _#2509: https://github.com/Cog-Creators/Red-DiscordBot/pull/2509
+.. _#2513: https://github.com/Cog-Creators/Red-DiscordBot/pull/2513
+.. _#2521: https://github.com/Cog-Creators/Red-DiscordBot/pull/2521
+.. _#2523: https://github.com/Cog-Creators/Red-DiscordBot/pull/2523
+.. _#2525: https://github.com/Cog-Creators/Red-DiscordBot/pull/2525
+.. _#2531: https://github.com/Cog-Creators/Red-DiscordBot/pull/2531
+.. _#2533: https://github.com/Cog-Creators/Red-DiscordBot/pull/2533
+.. _#2536: https://github.com/Cog-Creators/Red-DiscordBot/pull/2536
+.. _#2540: https://github.com/Cog-Creators/Red-DiscordBot/pull/2540
+.. _#2545: https://github.com/Cog-Creators/Red-DiscordBot/pull/2545
+.. _#2550: https://github.com/Cog-Creators/Red-DiscordBot/pull/2550
+.. _#2553: https://github.com/Cog-Creators/Red-DiscordBot/pull/2553
+.. _#2554: https://github.com/Cog-Creators/Red-DiscordBot/pull/2554
+.. _#2556: https://github.com/Cog-Creators/Red-DiscordBot/pull/2556
+.. _#2557: https://github.com/Cog-Creators/Red-DiscordBot/pull/2557
+.. _#2565: https://github.com/Cog-Creators/Red-DiscordBot/pull/2565
+.. _#2567: https://github.com/Cog-Creators/Red-DiscordBot/pull/2567
+.. _#2576: https://github.com/Cog-Creators/Red-DiscordBot/pull/2576
+.. _#2579: https://github.com/Cog-Creators/Red-DiscordBot/pull/2579
+.. _#2586: https://github.com/Cog-Creators/Red-DiscordBot/pull/2586
+.. _#2587: https://github.com/Cog-Creators/Red-DiscordBot/pull/2587
+.. _#2588: https://github.com/Cog-Creators/Red-DiscordBot/pull/2588
+.. _#2590: https://github.com/Cog-Creators/Red-DiscordBot/pull/2590
+.. _#2591: https://github.com/Cog-Creators/Red-DiscordBot/pull/2591
+.. _#2592: https://github.com/Cog-Creators/Red-DiscordBot/pull/2592
+.. _#2595: https://github.com/Cog-Creators/Red-DiscordBot/pull/2595
+.. _#2597: https://github.com/Cog-Creators/Red-DiscordBot/pull/2597
+.. _#2600: https://github.com/Cog-Creators/Red-DiscordBot/pull/2600
+.. _#2602: https://github.com/Cog-Creators/Red-DiscordBot/pull/2602
+.. _#2604: https://github.com/Cog-Creators/Red-DiscordBot/pull/2604
+.. _#2605: https://github.com/Cog-Creators/Red-DiscordBot/pull/2605
+.. _#2606: https://github.com/Cog-Creators/Red-DiscordBot/pull/2606
+.. _#2620: https://github.com/Cog-Creators/Red-DiscordBot/pull/2620
+.. _#2628: https://github.com/Cog-Creators/Red-DiscordBot/pull/2628
+.. _#2639: https://github.com/Cog-Creators/Red-DiscordBot/pull/2639
+.. _#2642: https://github.com/Cog-Creators/Red-DiscordBot/pull/2642
+.. _#2652: https://github.com/Cog-Creators/Red-DiscordBot/pull/2652

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,243 @@
+.. 3.3.x Changelogs
+
+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/cog_customcom.rst

@@ -0,0 +1,109 @@
+.. CustomCommands Cog Reference
+
+============================
+CustomCommands Cog Reference
+============================
+
+------------
+How it works
+------------
+
+CustomCommands allows you to create simple commands for your bot without requiring you to code your own cog for Red.
+
+If the command you attempt to create shares a name with an already loaded command, you cannot overwrite it with this cog.
+
+---------
+Cooldowns
+---------
+
+You can set cooldowns for your custom commands. If a command is on cooldown, it will not be triggered.
+
+You can set cooldowns per member or per channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
+
+------------------
+Context Parameters
+------------------
+
+You can enhance your custom command's response by leaving spaces for the bot to substitute.
+
++-----------+----------------------------------------+
+| Argument  | Substitute                             |
++===========+========================================+
+| {message} | The message the bot is responding to.  |
++-----------+----------------------------------------+
+| {author}  | The user who called the command.       |
++-----------+----------------------------------------+
+| {channel} | The channel the command was called in. |
++-----------+----------------------------------------+
+| {server}  | The server the command was called in.  |
++-----------+----------------------------------------+
+| {guild}   | Same as with {server}.                 |
++-----------+----------------------------------------+
+
+You can further refine the response with dot notation. For example, {author.mention} will mention the user who called the command.
+
+------------------
+Command Parameters
+------------------
+
+You can further enhance your custom command's response by leaving spaces for the user to substitute.
+
+To do this, simply put {#} in the response, replacing # with any number starting with 0. Each number will be replaced with what the user gave the command, in order.
+
+You can refine the response with colon notation. For example, {0:Member} will accept members of the server, and {0:int} will accept a number. If no colon notation is provided, the argument will be returned unchanged.
+
++-----------------+--------------------------------+
+| Argument        | Substitute                     |
++=================+================================+
+| {#:Member}      | A member of your server.       |
++-----------------+--------------------------------+
+| {#:TextChannel} | A text channel in your server. |
++-----------------+--------------------------------+
+| {#:Role}        | A role in your server.         |
++-----------------+--------------------------------+
+| {#:int}         | A whole number.                |
++-----------------+--------------------------------+
+| {#:float}       | A decimal number.              |
++-----------------+--------------------------------+
+| {#:bool}        | True or False.                 |
++-----------------+--------------------------------+
+
+You can specify more than the above with colon notation, but those are the most common.
+
+As with context parameters, you can use dot notation to further refine the response. For example, {0.mention:Member} will mention the Member specified.
+
+----------------
+Example commands
+----------------
+
+Showing your own avatar
+
+.. code-block:: none
+
+    [p]customcom add simple avatar {author.avatar_url}
+    [p]avatar
+        https://cdn.discordapp.com/avatars/133801473317404673/be4c4a4fe47cb3e74c31a0504e7a295e.webp?size=1024
+
+Repeating the user
+
+.. code-block:: none
+
+    [p]customcom add simple say {0}
+    [p]say Pete and Repeat
+        Pete and Repeat
+
+Greeting the specified member
+
+.. code-block:: none
+
+    [p]customcom add simple greet Hello, {0.mention:Member}!
+    [p]greet Twentysix
+        Hello, @Twentysix!
+
+Comparing two text channel's categories
+
+.. code-block:: none
+
+    [p]customcom add simple comparecategory {0.category:TextChannel}  |  {1.category:TextChannel}
+    [p]comparecategory #support #general
+        Red  |  Community

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

@@ -0,0 +1,97 @@
+.. Permissions Cog Reference
+
+=========================
+Permissions Cog Reference
+=========================
+
+------------
+How it works
+------------
+
+When loaded, the permissions cog will allow you to define extra custom rules for who can use a
+command.
+
+If no applicable rules are found, the command will behave normally.
+
+Rules can also be added to cogs, which will affect all commands from that cog. The cog name can be
+found from the help menu.
+
+-------------
+Rule priority
+-------------
+
+Rules set for subcommands will take precedence over rules set for the parent commands, which
+lastly take precedence over rules set for the cog. So for example, if a user is denied the Core
+cog, but allowed the ``[p]set token`` command, the user will not be able to use any command in the
+Core cog except for ``[p]set token``.
+
+In terms of scope, global rules will be checked first, then server rules.
+
+For each of those, the first rule pertaining to one of the following models will be used:
+
+1. User
+2. Voice channel
+3. Text channel
+4. Channel category
+5. Roles, highest to lowest
+6. Server (can only be in global rules)
+7. Default rules
+
+In private messages, only global rules about a user will be checked.
+
+-------------------------
+Setting Rules From a File
+-------------------------
+
+The permissions cog can also set, display or update rules with a YAML file with the
+``[p]permissions yaml`` command. Models must be represented by ID. Rules must be ``true`` for
+allow, or ``false`` for deny. Here is an example:
+
+.. code-block:: yaml
+
+    COG:
+      Admin:
+        78631113035100160: true
+        96733288462286848: false
+      Audio:
+        133049272517001216: true
+        default: false
+    COMMAND:
+      cleanup bot:
+        78631113035100160: true
+        default: false
+      ping:
+        96733288462286848: false
+        default: true
+
+----------------------
+Example configurations
+----------------------
+
+Locking the ``[p]play`` command to approved server(s) as a bot owner:
+
+.. code-block:: none
+
+    [p]permissions setdefaultglobalrule deny play
+    [p]permissions addglobalrule allow play [server ID or name]
+
+Locking the ``[p]play`` command to specific voice channel(s) as a serverowner or admin:
+
+.. code-block:: none
+
+    [p]permissions setdefaultserverrule deny play
+    [p]permissions setdefaultserverrule deny "playlist start"
+    [p]permissions addserverrule allow play [voice channel ID or name]
+    [p]permissions addserverrule allow "playlist start" [voice channel ID or name]
+
+Allowing extra roles to use ``[p]cleanup``:
+
+.. code-block:: none
+
+    [p]permissions addserverrule allow cleanup [role ID]
+
+Preventing ``[p]cleanup`` from being used in channels where message history is important:
+
+.. code-block:: none
+
+    [p]permissions addserverrule deny cleanup [channel ID or mention]

docs/conf.py

@@ -19,9 +19,10 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
 
-os.environ['BUILDING_DOCS'] = "1"
+sys.path.insert(0, os.path.abspath(".."))
+
+os.environ["BUILDING_DOCS"] = "1"
 
 
 # -- General configuration ------------------------------------------------
@@ -34,38 +35,43 @@ os.environ['BUILDING_DOCS'] = "1"
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib.asyncio'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.doctest",
+    "sphinxcontrib_trio",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Red - Discord Bot'
-copyright = '2017, Cog Creators'
-author = 'Cog Creators'
+project = "Red - Discord Bot"
+copyright = "2018-2020, Cog Creators"
+author = "Cog Creators"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
+from redbot.core import __version__
+from discord import __version__ as dpy_version
+
 # The short X.Y version.
-version = '3.0.0a1'
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = '3.0.0a1'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -77,10 +83,10 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -88,13 +94,22 @@ 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 ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+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
@@ -104,16 +119,16 @@ html_theme = 'sphinx_rtd_theme'
 
 html_context = {
     # Enable the "Edit in GitHub link within the header of each page.
-    'display_github': True,
-    'github_user': 'Cog-Creators',
-    'github_repo': 'Red-DiscordBot',
-    'github_version': 'V3/develop/docs/'
+    "display_github": True,
+    "github_user": "Cog-Creators",
+    "github_repo": "Red-DiscordBot",
+    "github_version": "V3/develop/docs/",
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -121,12 +136,12 @@ html_static_path = ['_static']
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-        'donate.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
+        "donate.html",
     ]
 }
 
@@ -134,7 +149,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Red-DiscordBotdoc'
+htmlhelp_basename = "Red-DiscordBotdoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -143,15 +158,12 @@ latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -161,8 +173,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Red-DiscordBot.tex', 'Red - Discord Bot Documentation',
-     'Cog Creators', 'manual'),
+    (master_doc, "Red-DiscordBot.tex", "Red - Discord Bot Documentation", "Cog Creators", "manual")
 ]
 
 
@@ -170,10 +181,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'red-discordbot', 'Red - Discord Bot Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "red-discordbot", "Red - Discord Bot Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -182,15 +190,49 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Red-DiscordBot', 'Red - Discord Bot Documentation',
-     author, 'Red-DiscordBot', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "Red-DiscordBot",
+        "Red - Discord Bot Documentation",
+        author,
+        "Red-DiscordBot",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 
+# -- Options for linkcheck builder ----------------------------------------
+
+# 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
 
 
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python': ('https://docs.python.org/3.5', None),
-                       'dpy': ('https://discordpy.readthedocs.io/en/rewrite/', None),
-                       'motor': ('https://motor.readthedocs.io/en/stable/', None)}
+# -- Options for extensions -----------------------------------------------
+
+# Intersphinx
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "dpy": (f"https://discordpy.readthedocs.io/en/v{dpy_version}/", None),
+    "motor": ("https://motor.readthedocs.io/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
+# If this string is non-empty, all blocks with ``>>>`` in them will be
+# tested, not just the ones explicitly marked with ``.. doctest::``
+doctest_test_doctest_blocks = ""
+
+# Autodoc options
+autodoc_default_options = {"show-inheritance": True}
+autodoc_typehints = "none"

docs/framework_apikeys.rst

@@ -0,0 +1,75 @@
+.. V3 Shared API Key Reference
+
+===============
+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 convention of the API being accessed.
+
+Example:
+
+Twitch has a client ID and client secret so a user should be asked to input
+
+``[p]set api twitch client_id,1234ksdjf client_secret,1234aldlfkd``
+
+and when accessed in the code it should be done by 
+
+.. code-block:: python
+
+    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.
+
+Example:
+
+``[p]set api youtube api_key,1234ksdjf``
+
+and when accessed in the code it should be done by 
+
+.. code-block:: python
+
+    await self.bot.get_shared_api_tokens("youtube")
+
+
+***********
+Basic Usage
+***********
+
+.. code-block:: python
+
+    class MyCog:
+        @commands.command()
+        async def youtube(self, ctx, user: str):
+            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

docs/framework_bank.rst

@@ -16,15 +16,16 @@ Basic Usage
 
 .. code-block:: python
 
-    from redbot.core import bank
+    from redbot.core import bank, commands
+    import discord
 
-    class MyCog:
+    class MyCog(commands.Cog):
         @commands.command()
-        async def balance(self, ctx, user: discord.Member=None):
+        async def balance(self, ctx, user: discord.Member = None):
             if user is None:
                 user = ctx.author
-            bal = bank.get_balance(user)
-            currency = bank.get_currency_name(ctx.guild)
+            bal = await bank.get_balance(user)
+            currency = await bank.get_currency_name(ctx.guild)
             await ctx.send(
                 "{}'s balance is {} {}".format(
                     user.display_name, bal, currency
@@ -40,3 +41,7 @@ Bank
 
 .. automodule:: redbot.core.bank
     :members:
+    :exclude-members: cost
+
+    .. autofunction:: cost
+        :decorator:

docs/framework_bot.rst

@@ -0,0 +1,23 @@
+.. bot module docs
+
+===
+Bot
+===
+
+.. automodule:: redbot.core.bot
+
+RedBase
+^^^^^^^
+
+.. autoclass:: RedBase
+    :members:
+    :exclude-members: get_context
+
+    .. automethod:: register_rpc_handler
+    .. automethod:: unregister_rpc_handler
+
+Red
+^^^
+
+.. autoclass:: Red
+    :members:

docs/framework_checks.rst

@@ -0,0 +1,11 @@
+.. _checks:
+
+========================
+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:

docs/framework_commands.rst

@@ -0,0 +1,36 @@
+.. red commands module documentation
+
+================
+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 functionalities used throughout the bot, as outlined below.
+
+.. autofunction:: redbot.core.commands.command
+
+.. autofunction:: redbot.core.commands.group
+
+.. autoclass:: redbot.core.commands.Command
+    :members:
+    :inherited-members: format_help_for_context
+
+.. autoclass:: redbot.core.commands.Group
+    :members:
+
+.. 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: convert
+    :no-undoc-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
 ***********
@@ -29,7 +32,7 @@ Basic Usage
 
         @commands.command()
         async def return_some_data(self, ctx):
-            await ctx.send(await config.foo())
+            await ctx.send(await self.config.foo())
 
 ********
 Tutorial
@@ -175,6 +178,219 @@ example, :py:meth:`Config.clear_all_guilds` resets all guild data. For member
 data, you can clear on both a per-guild and guild-independent basis, see
 :py:meth:`Config.clear_all_members` for more info.
 
+**************
+Advanced Usage
+**************
+
+Config makes it extremely easy to organize data that can easily fit into one of the standard categories (global,
+guild, user etc.) but there may come a time when your data does not work with the existing categories. There are now
+features within Config to enable developers to work with data how they wish.
+
+This usage guide will cover the following features:
+
+- :py:meth:`Group.get_raw`
+- :py:meth:`Group.set_raw`
+- :py:meth:`Group.clear_raw`
+
+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
+
+
+    class Pets:
+        def __init__(self):
+            self.conf = Config.get_conf(self, 1234567890)
+
+            # Here we'll assign some default costs for the pets
+            self.conf.register_global(
+                dog=100,
+                cat=100,
+                bird=50
+            )
+            self.conf.register_user(
+                pets={}
+            )
+
+And now that the cog is set up we'll need to create some commands that allow users to purchase these pets::
+
+    # continued
+        @commands.command()
+        async def get_pet(self, ctx, pet_type: str, pet_name: str):
+            """
+            Purchase a pet.
+
+            Pet type must be one of: dog, cat, bird
+            """
+            # Now we need to determine what the cost of the pet is and
+            # if the user has enough credits to purchase it.
+
+            # We will need to use "get_raw"
+            try:
+                cost = await self.conf.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.
+                await ctx.send("Bad pet type, try again.")
+                return
+
+After we've determined the cost of the pet we need to check if the user has enough credits and then we'll need to
+assign a new pet to the user. This is very easily done using the V3 bank API and :py:meth:`Group.set_raw`::
+
+    # continued
+            if await bank.can_spend(ctx.author, cost):
+                await self.conf.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[pet_name] = {'cost': cost, 'hunger': 0}
+                await self.conf.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::
+
+    # continued
+        @commands.command()
+        async def hunger(self, ctx, pet_name: str):
+            try:
+                hunger = await self.conf.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.
+                await ctx.send("You don't own that pet!")
+                return
+
+            await ctx.send("Your pet has {}/100 hunger".format(hunger))
+
+We're responsible pet owners here, so we've also got to have a way to feed our pets::
+
+    # continued
+        @commands.command()
+        async def feed(self, ctx, pet_name: str, food: int):
+            # 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)
+            except KeyError:
+                # If the given pet name doesn't exist in our data
+                await ctx.send("You don't own that pet!")
+                return
+
+            hunger = pet.get("hunger")
+
+            # 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(
+                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 ctx.send("Your pet is now at {}/100 hunger!".format(new_hunger)
+
+Of course, if we're less than responsible pet owners, there are consequences::
+
+    #continued
+        @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)
+            except KeyError:
+                await ctx.send("That person doesn't own that pet!")
+                return
+
+            hunger = pet.get("hunger")
+            if hunger < 80:
+                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)
+
+            # this is equivalent to doing the following
+
+            pets = await self.conf.user(member).pets()
+            del pets[pet_name]
+            await self.conf.user(member).pets.set(pets)
+
+            await self.conf.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."
+            )
+
+
+*************
+V2 Data Usage
+*************
+There has been much conversation on how to bring V2 data into V3 and, officially, we recommend that cog developers
+make use of the public interface in Config (using the categories as described in these docs) rather than simply
+copying and pasting your V2 data into V3. Using Config as recommended will result in a much better experience for
+you in the long run and will simplify cog creation and maintenance.
+
+However.
+
+We realize that many of our cog creators have expressed disinterest in writing converters for V2 to V3 style data.
+As a result we have opened up config to take standard V2 data and allow cog developers to manipulate it in V3 in
+much the same way they would in V2. The following examples will demonstrate how to accomplish this.
+
+.. warning::
+
+    By following this method to use V2 data in V3 you may be at risk of data corruption if your cog is used on a bot
+    with multiple shards. USE AT YOUR OWN RISK.
+
+.. code-block:: python
+
+    from redbot.core import Config
+
+
+    class ExampleCog:
+        def __init__(self):
+            self.conf = Config.get_conf(self, 1234567890)
+
+            self.data = {}
+
+        async def load_data(self):
+            self.data = await self.conf.custom("V2", "V2").all()
+
+        async def save_data(self):
+            await self.conf.custom("V2", "V2").set(self.data)
+
+
+    async def setup(bot):
+        cog = ExampleCog()
+        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
 *************
@@ -185,6 +401,21 @@ API Reference
     inside the bot itself! Simply take a peek inside of the :code:`tests/core/test_config.py` file for examples of using
     Config in all kinds of ways.
 
+.. important::
+
+    When getting, setting or clearing values in Config, all keys are casted to `str` for you. This
+    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()
+        {'123': True}
+        >>> await conf.foo.set({123: True, 456: {789: False}}
+        >>> await conf.foo()
+        {'123': True, '456': {'789': False}}
+
 .. automodule:: redbot.core.config
 
 Config
@@ -212,20 +443,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_context.rst

@@ -1,10 +0,0 @@
-.. red invocation context documentation
-
-==========================
-Command Invocation Context
-==========================
-
-.. automodule:: redbot.core.context
-
-.. autoclass:: redbot.core.RedContext
-    :members:

docs/framework_downloader.rst

@@ -1,76 +0,0 @@
-.. downloader framework reference
-
-Downloader Framework
-====================
-
-Info.json
-*********
-
-The info.json file may exist inside every package folder in the repo,
-it is optional however. This string describes the valid keys within
-an info file (and maybe how the Downloader cog uses them).
-
-KEYS (case sensitive):
-
-- ``author`` (list of strings) - list of names of authors of the cog
-
-- ``bot_version`` (list of integer) - Min version number of Red in the format ``(MAJOR, MINOR, PATCH)``
-
-- ``description`` (string) - A long description of the cog that appears when a user executes ```!cog info``.
-
-- ``hidden`` (bool) - Determines if a cog is available for install.
-
-- ``install_msg`` (string) - The message that gets displayed when a cog is installed
-
-- ``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.
-
-- ``short`` (string) - A short description of the cog that appears when
-  a user executes `!cog 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

@@ -13,11 +13,12 @@ Basic Usage
 
 .. code-block:: python
 
-    from discord.ext import commands
-    from redbot.core.i18n import CogI18n
+    from redbot.core import commands
+    from redbot.core.i18n import Translator, cog_i18n
     
-    _ = CogI18n("ExampleCog", __file__)
+    _ = Translator("ExampleCog", __file__)
 
+    @cog_i18n(_)
     class ExampleCog:
         """description"""
 
@@ -39,16 +40,19 @@ 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 -n -p locales`
+Windows: :code:`python <your python install path>\Tools\i18n\pygettext.py -D -n -p locales`
 
 Mac: ?
 
-Linux: :code:`pygettext3 -n -p locales`
+Linux: :code:`pygettext3 -D -n -p locales`
 
-This will generate a messages.pot file with strings to be translated
+This will generate a messages.pot file with strings to be translated, including
+docstrings.
 
 -------------
 API Reference
 -------------
 
-.. automodule:: redbot.core.i18n
+.. automodule:: redbot.core.i18n
+    :members:
+    :special-members: __call__

docs/framework_modlog.rst

@@ -16,17 +16,17 @@ Basic Usage
 
 .. code-block:: python
 
-    from redbot.core import modlog
+    from redbot.core import commands, modlog
     import discord
 
-    class MyCog:
+    class MyCog(commands.Cog):
         @commands.command()
         @checks.admin_or_permissions(ban_members=True)
-        async def ban(self, ctx, user: discord.Member, reason: str=None):
+        async def ban(self, ctx, user: discord.Member, reason: str = None):
             await ctx.guild.ban(user)
-            case = modlog.create_case(
-                ctx.guild, ctx.message.created_at, "ban", user,
-                ctx.author, reason, until=None, channel=None
+            case = await modlog.create_case(
+                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.")
 
@@ -35,50 +35,60 @@ Basic Usage
 Registering Case types
 **********************
 
-To register a single case type:
+To register case types, use an asynchronous ``initialize()`` method and call
+it from your setup function:
 
 .. code-block:: python
 
-    from redbot.core import modlog
+    # mycog/mycog.py
+    from redbot.core import modlog, commands
     import discord
 
-    class MyCog:
-        def __init__(self, bot):
+    class MyCog(commands.Cog):
+
+        async def initialize(self):
+            await self.register_casetypes()
+
+        @staticmethod
+        async def register_casetypes():
+            # Registering a single casetype
             ban_case = {
                 "name": "ban",
                 "default_setting": True,
-                "image": ":hammer:",
+                "image": "\N{HAMMER}",
                 "case_str": "Ban",
-                "audit_type": "ban"
             }
-            modlog.register_casetype(**ban_case)
+            try:
+                await modlog.register_casetype(**ban_case)
+            except RuntimeError:
+                pass
 
-To register multiple case types:
-
-.. code-block:: python
-
-    from redbot.core import modlog
-    import discord
-
-    class MyCog:
-        def __init__(self, bot):
+            # Registering multiple casetypes
             new_types = [
                 {
-                    "name": "ban",
+                    "name": "hackban",
                     "default_setting": True,
-                    "image": ":hammer:",
-                    "case_str": "Ban",
-                    "audit_type": "ban"
+                    "image": "\N{BUST IN SILHOUETTE}\N{HAMMER}",
+                    "case_str": "Hackban",
                 },
                 {
                     "name": "kick",
                     "default_setting": True,
-                    "image": ":boot:",
+                    "image": "\N{WOMANS BOOTS}",
                     "case_str": "Kick",
-                    "audit_type": "kick"
                 }
             ]
-            modlog.register_casetypes(new_types)
+            await modlog.register_casetypes(new_types)
+
+.. code-block:: python
+
+    # mycog/__init__.py
+    from .mycog import MyCog
+
+    async def setup(bot):
+        cog = MyCog()
+        await cog.initialize()
+        bot.add_cog(cog)
 
 .. important::
     Image should be the emoji you want to represent your case type with.

docs/framework_rpc.rst

@@ -0,0 +1,63 @@
+.. rpc docs
+
+===
+RPC
+===
+
+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.
+
+To enable the internal RPC server you must start the bot with the ``--rpc`` flag.
+
+********
+Examples
+********
+
+.. code-block:: Python
+
+    def setup(bot):
+        c = Cog()
+        bot.add_cog(c)
+        bot.register_rpc_handler(c.rpc_method)
+
+*******************************
+Interacting with the RPC Server
+*******************************
+
+The RPC server opens a websocket bound to port ``6133`` on ``127.0.0.1``.
+This is not configurable for security reasons as broad access to this server gives anyone complete control over your bot.
+To access the server you must find a library that implements websocket based JSONRPC in the language of your choice.
+
+There are a few built-in RPC methods to note:
+
+* ``GET_METHODS`` - Returns a list of available RPC methods.
+* ``GET_METHOD_INFO`` - Will return the docstring for an available RPC method. Useful for finding information about the method's parameters and return values.
+* ``GET_TOPIC`` - Returns a list of available RPC message topics.
+* ``GET_SUBSCRIPTIONS`` - Returns a list of RPC subscriptions.
+* ``SUBSCRIBE`` - Subscribes to an available RPC message topic.
+* ``UNSUBSCRIBE`` - Unsubscribes from an RPC message topic.
+
+All RPC methods accept a list of parameters.
+The built-in methods above expect their parameters to be in list format.
+
+All cog-based methods expect their parameter list to take one argument, a JSON object, in the following format::
+
+    params = [
+        {
+            "args": [],  # A list of positional arguments
+            "kwargs": {},  # A dictionary of keyword arguments
+        }
+    ]
+
+    # As an example, here's a call to "get_method_info"
+    rpc_call("GET_METHOD_INFO", ["get_methods",])
+
+    # And here's a call to "core__load"
+    rpc_call("CORE__LOAD", {"args": [["general", "economy", "downloader"],], "kwargs": {}})
+
+*************
+API Reference
+*************
+
+Please see the :class:`redbot.core.bot.RedBase` class for details on the RPC handler register and unregister methods.

docs/framework_utils.rst

@@ -4,14 +4,60 @@
 Utility Functions
 =================
 
+General Utility
+===============
+
+.. automodule:: redbot.core.utils
+    :members: deduplicate_iterables, bounded_gather, bounded_gather_iter
+
 Chat Formatting
 ===============
 
 .. automodule:: redbot.core.utils.chat_formatting
     :members:
 
+Embed Helpers
+=============
+
+.. automodule:: redbot.core.utils.embed
+    :members:
+    :exclude-members: randomize_color
+
+Reaction Menus
+==============
+
+.. automodule:: redbot.core.utils.menus
+    :members:
+
+Event Predicates
+================
+
+MessagePredicate
+****************
+
+.. autoclass:: redbot.core.utils.predicates.MessagePredicate
+    :members:
+
+ReactionPredicate
+*****************
+
+.. autoclass:: redbot.core.utils.predicates.ReactionPredicate
+    :members:
+
 Mod Helpers
 ===========
 
 .. automodule:: redbot.core.utils.mod
     :members:
+
+Tunnel
+======
+
+.. automodule:: redbot.core.utils.tunnel
+    :members: Tunnel
+
+Common Filters
+==============
+
+.. automodule:: redbot.core.utils.common_filters
+    :members:

docs/getting_started.rst

@@ -0,0 +1,365 @@
+.. 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
+
+The parameters are shown as enclosed in ``< >`` if they're required, or
+``[ ]`` if optional.
+As an example, the ban command will show this in the help message, assuming
+your prefix is ``!``:
+``Syntax: !ban <user> [days] [reason]``
+
+This means that it is necessary to provide ``user``. However, the
+``days`` value (number of messages to delete) is optional, as well as
+the ``reason`` value, used for the modlog.
+
+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 ``cogs.red``. Find whatever you want,
+there are hundreds of cogs available!
+
+.. note:: ``cogs.red``, the website that list all of the cogs is not
+    ready for v3 yet. For now, you can refer to `this post
+    <https://cogboard.red/t/approved-repositories/210>`_.
+
+.. 26-cogs not available, let's use my repo :3
+
+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 list <host-list>` for
+  quality VPS providers.
+
+  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 18**.
+
+  For Raspberry Pi users, just install `Raspbian
+  <https://www.raspberrypi.org/downloads/raspbian/>`_ 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.
+
+    .. tip::
+        Arguments enclosed in ``< >`` means that the argument is **required**
+        for the command to work.
+
+        Arguments enclosed in ``[ ]`` means that the argument is **optional**
+        for the command; you can decide to use it or not.
+        
+        If your argument includes spaces like ``Hello world!``, most of the time
+        you will need to place it in double quotes like this: ``"Hello world!"``.
+        Sometimes (especially for the last argument) these double quotes are not
+        required.
+
+        Arguments followed by ``=something`` means that, if not specified,
+        the argument will be equal to ``something``.
+
+        For example, ``[days=1]`` in the ``ban`` command means that the number
+        of days of messages to be deleted will be equal to ``1`` if not
+        specified.

docs/guide_cog_creation.rst

@@ -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,11 +17,33 @@ you in the process.
 Getting started
 ---------------
 
-To start off, be sure that you have installed Python 3.5 or higher (if you
-are on Windows, stick with 3.5). Open a terminal or command prompt and type
-:code:`pip install --process-dependency-links -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
@@ -36,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
 --------------
@@ -45,9 +81,9 @@ In that file, place the following code:
 
 .. code-block:: python
 
-    from discord.ext import commands
+    from redbot.core import commands
 
-    class Mycog:
+    class Mycog(commands.Cog):
         """My custom cog"""
 
         @commands.command()
@@ -75,7 +111,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
@@ -86,10 +122,110 @@ 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`
+
 --------------------
 Additional resources
 --------------------
 
-Be sure to check out the `migration guide </guide_migration>`_ for some resources
+Be sure to check out the :doc:`/guide_migration` for some resources
 on developing cogs for V3. This will also cover differences between V2 and V3 for
 those who developed cogs for V2.
+
+
+---------------------------
+Guidelines for Cog Creators
+---------------------------
+
+The following are a list of guidelines Cog Creators should strive to follow.
+Not all of these are strict requirements (some are) but are all generally advisable.
+
+1. Cogs should follow a few naming conventions for consistency.
+
+  - Cog classes should be TitleCased, using alphabetic characters only.
+  - Commands should be lower case, using alphanumeric characters only.
+  - Cog modules should be lower case, using alphabetic characters only.
+
+2. Cogs and commands should have docstrings suitable for use in help output.
+
+  - This one is slightly flexible if using other methods of setting help.
+
+3. Don't prevent normal operation of the bot without the user opting into this.
+
+  - This includes as a side effect by blocking the event loop.
+
+4. If your cog uses logging:
+
+  - The namespace for logging should be: ``red.your_repo_name.cog_name``.
+  - Print statements are not a substitute for proper logging.
+
+5. If you use asyncio.create_task, your tasks need to:
+
+  - Be cancelled on cog unload.
+  - Handle errors.
+
+6. Event listeners should exit early if it is an event you don't need.
+   This makes your events less expensive in terms of CPU time. Examples below:
+
+  - Checking that you are in a guild before interacting with config for an antispam command.
+  - Checking that you aren't reacting to a bot message (``not message.author.bot``) early on.
+
+7. Use .gitignore (or something else) to keep unwanted files out of your cog repo.
+8. Put a license on your cog repo.
+
+  - By default, in most jurisdictions, without a license that at least offers the code for use,
+    users cannot legally use your code.
+
+9. Use botwide features when they apply. Some examples of this:
+
+  - ``ctx.embed_color``
+  - ``bot.is_automod_immune``
+
+10. Use checks to limit command use when the bot needs special permissions.
+11. Check against user input before doing things. Common things to check:
+
+  - Resulting output is safe.
+  - Values provided make sense. (eg. no negative numbers for payday)
+  - Don't unsafely use user input for things like database input.
+
+12. Don't abuse bot internals.
+
+  - If you need access to something, ask us or open an issue.
+  - If you're sure the current usage is safe, document why,
+    but we'd prefer you work with us on ensuring you have access to what you need.
+
+13. Update your cogs for breakage.
+
+  - We announce this in advance.
+  - If you need help, ask.

docs/guide_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 <http://discordpy.readthedocs.io/en/rewrite/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,86 @@
+.. 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)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- ``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 version 3.4.
+

docs/host-list.rst

@@ -0,0 +1,84 @@
+.. source: https://gist.github.com/Twentysix26/cb4401c6e507782aa6698e9e470243ed
+
+.. _host-list:
+
+=============
+VPS providers
+=============
+
+.. note::
+    This doc is written for the :ref:`hosting section <getting-started-hosting>`
+    of the :ref:`getting started <getting-started>` guide. Please take a look
+    if you don't know how to host Red on a VPS.
+
+This is a list of the recommended VPS providers.
+
+.. 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.
+
+-------------
+Linux hosting
+-------------
+
++------------------------------------+------------------------------------------------------+
+|Link                                |Description                                           |
++====================================+======================================================+
+|`Scaleway                           |Incredibly cheap but powerful VPSes, owned by         |
+|<https://www.scaleway.com/>`_       |`<https://online.net/>`_, based in Europe.            |
++------------------------------------+------------------------------------------------------+
+|`DigitalOcean                       |US-based cheap VPSes. The gold standard. Locations    |
+|<https://www.digitalocean.com/>`_   |available world wide.                                 |
++------------------------------------+------------------------------------------------------+
+|`OVH <https://www.ovh.co.uk/>`_     |Cheap VPSes, used by many people. French and Canadian |
+|                                    |locations available.                                  |
++------------------------------------+------------------------------------------------------+
+|`Time4VPS                           |Cheap VPSes, seemingly based in Lithuania.            |
+|<https://www.time4vps.eu/>`_        |                                                      |
++------------------------------------+------------------------------------------------------+
+|`Linode <https://www.linode.com/>`_ |More cheap VPSes!                                     |
++------------------------------------+------------------------------------------------------+
+|`Vultr <https://www.vultr.com/>`_   |US-based, DigitalOcean-like.                          |
++------------------------------------+------------------------------------------------------+
+
+------
+Others
+------
+
++-------------------------------------+-----------------------------------------------------+
+|Link                                 |                                                     |
++=====================================+=====================================================+
+|`AWS <https://aws.amazon.com/>`_     |Amazon Web Services. Free for a year (with certain   |
+|                                     |limits), but very pricey after that.                 |
++-------------------------------------+-----------------------------------------------------+
+|`Google Cloud                        |Same as AWS, but it's Google.                        |
+|<https://cloud.google.com/compute/>`_|                                                     |
++-------------------------------------+-----------------------------------------------------+
+|`Microsoft Azure                     |Same as AWS, but it's Microsoft.                     |
+|<https://azure.microsoft.com>`_      |                                                     |
++-------------------------------------+-----------------------------------------------------+
+|`LowEndBox <http://lowendbox.com/>`_ |A curator for lower specced servers.                 |
++-------------------------------------+-----------------------------------------------------+
+
+------------
+Self-hosting
+------------
+
+You can always self-host on your own hardware.
+A Raspberry Pi 3 will be more than sufficient for small to medium sized bots.
+
+For bigger bots, you can build your own server PC for usage, or buy a rack
+server. Any modern hardware should work 100% fine.
+
+------------
+Free hosting
+------------
+
+Google Cloud and AWS both have free tier VPS suitable for small bots.
+Additionally, new Google Cloud customers get a $300 credit which is valid
+for 12 months.
+
+Other than that... no. There is no good free VPS hoster, outside of
+persuading somebody to host for you, which is incredibly unlikely.

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!
 =============================================
 
@@ -11,17 +13,23 @@ Welcome to Red - Discord Bot's documentation!
     :caption: Installation Guides:
 
     install_windows
-    install_mac
-    install_ubuntu
-    install_debian
-    install_centos
-    install_raspbian
+    install_linux_mac
+    about_venv
+    autostart_systemd
+    autostart_pm2
 
 .. toctree::
     :maxdepth: 2
     :caption: Cog Reference:
 
-    cog_downloader
+    cog_customcom
+    cog_permissions
+
+.. toctree::
+    :maxdepth: 2
+    :caption: User guides:
+
+    getting_started
 
 .. toctree::
     :maxdepth: 2
@@ -29,16 +37,36 @@ Welcome to Red - Discord Bot's documentation!
 
     guide_migration
     guide_cog_creation
+    guide_publish_cogs
+    framework_apikeys
     framework_bank
+    framework_bot
+    framework_checks
     framework_cogmanager
-    framework_datamanager
+    framework_commands
     framework_config
-    framework_downloader
+    framework_datamanager
+    framework_events
     framework_i18n
     framework_modlog
-    framework_context
+    framework_rpc
     framework_utils
+    version_guarantees
 
+.. toctree::
+    :maxdepth: 2
+    :caption: Changelogs:
+
+    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_centos.rst

@@ -1,54 +0,0 @@
-.. centos install guide
-
-==========================
-Installing Red on CentOS 7
-==========================
-
----------------------------
-Installing pre-requirements
----------------------------
-
-.. code-block:: none
-
-    yum -y groupinstall development
-    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
-    yum -y install yum-utils wget which python35u python35u-pip python35u-devel openssl-devel libffi-devel git opus-devel
-    sh -c "$(wget https://gist.githubusercontent.com/mustafaturan/7053900/raw/27f4c8bad3ee2bb0027a1a52dc8501bf1e53b270/latest-ffmpeg-centos6.sh -O -)"
-
---------------
-Installing Red
---------------
-
-Without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot`
-
-With audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
-
-----------------------
-Setting up an instance
-----------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_debian.rst

@@ -1,55 +0,0 @@
-.. debian install guide
-
-================================
-Installing Red on Debian Stretch
-================================
-
-.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, make a new one.
-
----------------------------
-Installing pre-requirements
----------------------------
-
-.. code-block:: none
-
-    echo "deb http://httpredir.debian.org/debian stretch-backports main contrib non-free" >> /etc/apt/sources.list
-    apt-get update
-    apt-get install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git ffmpeg libopus-dev unzip -y
-
-------------------
-Installing the bot
-------------------
-
-To install without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot`
-
-To install with audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
-
-------------------------
-Setting up your instance
-------------------------
-
-Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
-store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
-for confirmation of that selection. Next, it will ask you to choose your storage backend
-(the default here is JSON). It will then ask for a name for your instance. This can be
-anything as long as it does not contain spaces; however, keep in mind that this is the
-name you will use to run your bot, and so it should be something you can remember.
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
-your token and a prefix.

docs/install_linux_mac.rst

@@ -0,0 +1,482 @@
+.. _linux-mac-install-guide:
+
+==============================
+Installing Red on Linux or Mac
+==============================
+
+.. warning::
+
+    For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
+    a new user on Linux, see `this guide by DigitalOcean
+    <https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart>`_.
+
+-------------------------------
+Installing the pre-requirements
+-------------------------------
+
+Please install the pre-requirements using the commands listed for your operating system.
+
+The pre-requirements are:
+ - Python 3.8.1 or greater
+ - Pip 18.1 or greater
+ - Git 2.11+
+ - Java Runtime Environment 11 or later (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:
+
+~~~~~~~~~~
+Arch Linux
+~~~~~~~~~~
+
+.. code-block:: none
+
+    sudo pacman -Syu python python-pip git jre-openjdk-headless base-devel
+
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-centos:
+.. _install-rhel:
+
+~~~~~~~~~~~~~~~~~
+CentOS and RHEL 7
+~~~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+    yum -y groupinstall development
+    yum -y install https://centos7.iuscommunity.org/ius-release.rpm
+    sudo yum -y install zlib-devel bzip2 bzip2-devel readline-devel sqlite sqlite-devel \
+      openssl-devel xz xz-devel libffi-devel findutils git2u java-11-openjdk
+
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-centos8:
+.. _install-rhel8:
+
+~~~~~~~~~~~~~~~~~
+CentOS and RHEL 8
+~~~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+    yum -y install epel-release
+    yum update -y
+    yum -y groupinstall development
+    yum -y install git zlib-devel bzip2 bzip2-devel readline-devel sqlite \
+     sqlite-devel openssl-devel xz xz-devel libffi-devel findutils java-11-openjdk
+     
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-debian-stretch:
+
+~~~~~~~~~~~~~~
+Debian Stretch
+~~~~~~~~~~~~~~
+
+.. note::
+
+    This guide is only for Debian Stretch users, these instructions won't work with
+    Raspbian Stretch. Raspbian Buster is the only version of Raspbian supported by Red.
+
+We recommend installing pyenv as a method of installing non-native versions of python on
+Debian Stretch. This guide will tell you how. First, run the following commands:
+
+.. code-block:: none
+
+    sudo echo "deb http://deb.debian.org/debian stretch-backports main" >> /etc/apt/sources.list.d/red-sources.list
+    sudo apt update
+    sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev \
+      libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev \
+      libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre
+    CXX=/usr/bin/g++
+
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-debian:
+.. _install-raspbian:
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Debian and Raspbian Buster
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We recommend installing pyenv as a method of installing non-native versions of python on
+Debian/Raspbian Buster. This guide will tell you how. First, run the following commands:
+
+.. code-block:: none
+
+    sudo apt update
+    sudo apt -y install make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev \
+      libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev \
+      libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev python3-openssl git openjdk-11-jre
+    CXX=/usr/bin/g++
+
+Complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-fedora:
+
+~~~~~~~~~~~~
+Fedora Linux
+~~~~~~~~~~~~
+
+Fedora Linux 30 and above has all required packages available in official repositories. Install
+them with dnf:
+
+.. code-block:: none
+
+    sudo dnf -y install python38 git java-latest-openjdk-headless @development-tools
+
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-mac:
+
+~~~
+Mac
+~~~
+
+Install Brew: in Finder or Spotlight, search for and open *Terminal*. In the terminal, paste the
+following, then press Enter:
+
+.. code-block:: none
+
+    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+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 git
+    brew tap caskroom/versions
+    brew cask install homebrew/cask-versions/adoptopenjdk11
+
+It's possible you will have network issues. If so, go in your Applications folder, inside it, go in
+the Python 3.8 folder then double click ``Install certificates.command``.
+
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-opensuse:
+
+~~~~~~~~
+openSUSE
+~~~~~~~~
+
+openSUSE Leap
+*************
+
+We recommend installing a community package to get Python 3.8 on openSUSE Leap. 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 ar -f https://download.opensuse.org/repositories/home:/Rotkraut:/Opt-Python/openSUSE_Leap_${VERSION_ID}/ Opt-Python
+
+Now install the pre-requirements with zypper:
+
+.. code-block:: none
+
+    sudo zypper install opt-python38 opt-python38-setuptools git-core java-11-openjdk-headless
+    sudo zypper 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 install python3-base python3-pip git-core java-12-openjdk-headless
+    sudo zypper install -t pattern devel_basis
+
+Continue by `creating-venv-linux`.
+
+----
+
+.. _install-ubuntu:
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Ubuntu LTS versions (18.04 and 16.04)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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
+
+We recommend adding the ``deadsnakes`` ppa to install Python 3.8.1 or greater:
+
+.. code-block:: none
+
+    sudo add-apt-repository -yu ppa:deadsnakes/ppa
+
+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 default-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
+    CXX=/usr/bin/g++
+
+And then complete the rest of the installation by `installing Python 3.8 with pyenv <install-python-pyenv>`.
+
+----
+
+.. _install-python-pyenv:
+
+****************************
+Installing Python with pyenv
+****************************
+
+.. note::
+
+    If you followed one of the sections above, and weren't linked here afterwards, you should skip
+    this section.
+
+On distributions where Python 3.8 needs to be compiled from source, we recommend the use of pyenv.
+This simplifies the compilation process and has the added bonus of simplifying setting up Red in a
+virtual environment.
+
+.. code-block:: none
+
+    curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash
+
+After this command, you may see a warning about 'pyenv' not being in the load path. Follow the
+instructions given to fix that, then close and reopen your shell.
+
+Then run the following command:
+
+.. code-block:: none
+
+    CONFIGURE_OPTS=--enable-optimizations pyenv install 3.8.1 -v
+
+This may take a long time to complete, depending on your hardware. For some machines (such as
+Raspberry Pis and micro-tier VPSes), it may take over an hour; in this case, you may wish to remove
+the ``CONFIGURE_OPTS=--enable-optimizations`` part from the front of the command, which will
+drastically reduce the install time. However, be aware that this will make Python run about 10%
+slower.
+
+After that is finished, run:
+
+.. code-block:: none
+
+    pyenv global 3.8.1
+
+Pyenv is now installed and your system should be configured to run Python 3.8.
+
+Continue by `creating-venv-linux`.
+
+.. _creating-venv-linux:
+
+------------------------------
+Creating a Virtual Environment
+------------------------------
+
+.. tip::
+
+    If you want to learn more about virtual environments, see page: `about-venvs`
+
+We require installing Red into a virtual environment. Don't be scared, it's very
+straightforward.
+
+You have 2 options:
+
+* :ref:`using-venv` (quick and easy, involves just two commands)
+* :ref:`using-pyenv-virtualenv` (only available and recommended when you installed Python with pyenv)
+
+----
+
+.. _using-venv:
+
+**************
+Using ``venv``
+**************
+This is the quickest way to get your virtual environment up and running, as `venv` is shipped with
+python.
+
+First, choose a directory where you would like to create your virtual environment. It's a good idea
+to keep it in a location which is easy to type out the path to. From now, we'll call it
+``redenv`` and it will be located in your home directory.
+
+Create your virtual environment with the following command::
+
+    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:
+
+--------------
+Installing Red
+--------------
+
+Choose one of the following commands to install Red.
+
+To install without additional config backend support:
+
+.. code-block:: none
+
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U Red-DiscordBot
+
+Or, to install with PostgreSQL support:
+
+.. code-block:: none
+
+    python -m pip install -U pip setuptools wheel
+    python -m pip install -U Red-DiscordBot[postgres]
+
+
+.. note::
+
+    These commands are also used for updating Red
+
+--------------------------
+Setting Up and Running Red
+--------------------------
+
+After installation, set up your instance with the following command:
+
+.. code-block:: none
+
+    redbot-setup
+
+This will set the location where data will be stored, as well as your
+storage backend and the name of the instance (which will be used for
+running the bot).
+
+Once done setting up the instance, run the following command to run Red:
+
+.. code-block:: none
+
+    redbot <your instance name>
+
+It will walk through the initial setup, asking for your token and a prefix.
+You can find out how to obtain a token with
+:dpy_docs:`this guide <discord.html#creating-a-bot-account>`,
+section "Creating a Bot Account".
+
+.. 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_mac.rst

@@ -1,53 +0,0 @@
-.. mac install guide
-
-=====================
-Installing Red on Mac
-=====================
-
----------------------------
-Installing pre-requirements
----------------------------
-
-* Install Brew
-    * In Finder or Spotlight, search for and open terminal. In the window that will open, paste this:
-      :code:`/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
-      and press enter.
-* After the installation, install the required packages by pasting the commands and pressing enter, one-by-one:
-    * :code:`brew install python3 --with-brewed-openssl`
-    * :code:`brew install git`
-    * :code:`brew install ffmpeg --with-ffplay`
-    * :code:`brew install opus`
-
---------------
-Installing Red
---------------
-
-Without audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot`
-
-With audio:
-
-:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
-
-To install the development version (without audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
-
-To install the development version (with audio):
-
-:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
-
-----------------------
-Setting up an instance
-----------------------
-
-To set up an instance, run :code:`redbot-setup` and follow the steps there, providing the requested information
-or accepting the defaults. Keep in mind that the instance name will be the one you use when running the bot, so
-make it something you can remember
-
------------
-Running Red
------------
-
-Run :code:`redbot <your instance name>` and go through the initial setup (it will ask for the token and a prefix).