Version bump to 3.5.12 (#6426)

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

.bandit.yml

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

.cherry_picker.toml

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

.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

.git-blame-ignore-revs

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

.git_archive_info.txt

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

.gitattributes

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

.github/CODEOWNERS

@@ -1,49 +1,30 @@
-# Default
-*                                   @Twentysix26
-
-# Core
-redbot/core/bank.py                      @palmtree5
-redbot/core/checks.py                    @tekulvw
-redbot/core/cli.py                       @tekulvw
-redbot/core/config.py                    @tekulvw
-redbot/core/cog_manager.py               @tekulvw
-redbot/core/core_commands.py             @tekulvw
-redbot/core/context.py                   @Tobotimus
-redbot/core/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
-
 # Cogs
-redbot/cogs/admin/*                 @tekulvw
-redbot/cogs/alias/*                 @tekulvw
-redbot/cogs/audio/*                 @tekulvw
-redbot/cogs/bank/*                  @tekulvw
-redbot/cogs/cleanup/*               @palmtree5
-redbot/cogs/customcom/*             @palmtree5
-redbot/cogs/downloader/*            @tekulvw
-redbot/cogs/economy/*               @palmtree5
-redbot/cogs/filter/*                @palmtree5
-redbot/cogs/general/*               @palmtree5
-redbot/cogs/image/*                 @palmtree5
-redbot/cogs/mod/*                   @palmtree5
-redbot/cogs/modlog/*                @palmtree5
-redbot/cogs/streams/*               @Twentysix26 @palmtree5
-redbot/cogs/trivia/*                @Tobotimus
+/redbot/cogs/audio/** @aikaterna @PredaaA
+/redbot/cogs/downloader/* @Jackenmen
+/redbot/cogs/streams/* @palmtree5
+/redbot/cogs/mutes/* @TrustyJAID
 
-# Docs
-docs/*                              @tekulvw @palmtree5
+# Docs - Install and update guides
+/docs/install_guides/** @Jackenmen
+/docs/update_red.rst @Jackenmen
 
-# Setup, instance setup, and running the bot
-setup.py                            @tekulvw
-redbot/__init__.py                  @tekulvw
-redbot/__main__.py                  @tekulvw
-redbot/setup.py                     @tekulvw
+# Docs - Version guarantees
+/docs/version_guarantees.rst @Jackenmen
+
+# Trivia Lists
+/redbot/cogs/trivia/data/lists/whosthatpokemon*.yaml @aikaterna
+
+# Tests
+/redbot/pytest/downloader* @Jackenmen
+/tests/cogs/downloader/* @Jackenmen
+
+# Schemas
+/schema/* @Jackenmen
+
+# CI
+/.travis.yml @Kowlin
+/crowdin.yml @Kowlin
+/.github/workflows/* @Kowlin
+
+# Excludes
+**/locales/* @ghost

.github/CONTRIBUTING.md

@@ -1,75 +0,0 @@
-# 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.
-
-### 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?
-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.
-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.
-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
-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.
-* help-wanted - issues that are currently unassigned to anyone and may be a bit more involved/complex than issues tagged with beginner.
-
-**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
-
-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.
-
-### To contribute changes
-1. Create your own fork of the Red repository.
-2. Make the changes in your own fork.
-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 Pull Request on GitHub with your changes
-
-### How To Report A Bug
-Please see our **ISSUES.MD** for more information.
-
-### 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
-
-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
-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
-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:
-    * 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"
-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
-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/01_command_bug.yml

@@ -0,0 +1,86 @@
+name: Bug reports for commands
+description: For bugs that involve commands found within Red.
+labels: 'Type: Bug'
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out an issue. This template is meant for any issues related to commands.
+      If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
+- type: input
+  id: red-version
+  attributes:
+    label: "What Red version are you using?"
+    placeholder: 3.4.5
+  validations:
+    required: true
+- type: dropdown
+  id: cog-name
+  attributes:
+    label: "Cog name"
+    description: "From which cog does the command come from?"
+    options:
+      - Admin
+      - Alias
+      - Audio
+      - Bank
+      - Cleanup
+      - CogManagerUI
+      - Core
+      - Customcom
+      - Dev
+      - Downloader
+      - Economy
+      - Filter
+      - General
+      - Image
+      - Mod
+      - Modlog
+      - Mutes
+      - Permissions
+      - Reports
+      - Streams
+      - Trivia
+      - Warnings
+  validations:
+    required: true
+- type: input
+  id: command-name
+  attributes:
+    label: "Command name"
+    description: "What is the command that caused the error?"
+    placeholder: "play"
+  validations:
+    required: true
+- type: textarea
+  id: weh
+  attributes:
+    label: "What did you expect to happen?"
+  validations:
+    required: true
+- type: textarea
+  id: wah
+  attributes:
+    label: "What actually happened?"
+    description: |
+      A clear and concise description of what the bug is.
+      If the issue is visual in nature, consider posting a screenshot.
+  validations:
+    required: true
+- type: textarea
+  id: reproduction-steps
+  attributes:
+    label: "How can we reproduce this error?"
+    description: "List of steps required to reproduce this error."
+    value: |
+      1.
+      2.
+      3.
+      ...
+  validations:
+    required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.

.github/ISSUE_TEMPLATE/02_other_bugs.yml

@@ -0,0 +1,54 @@
+name: Bug report
+description: "For bugs that don't involve a command."
+labels: 'Type: Bug'
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out an issue. This template is meant for any issues not related to any existing command.
+      If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
+- type: input
+  id: red-version
+  attributes:
+    label: "What Red version are you using?"
+    placeholder: 3.4.5
+  validations:
+    required: true
+- type: textarea
+  id: what-happened
+  attributes:
+    label: "What were you trying to do?"
+  validations:
+    required: true
+- type: textarea
+  id: weh
+  attributes:
+    label: "What did you expect to happen?"
+  validations:
+    required: true
+- type: textarea
+  id: wah
+  attributes:
+    label: "What actually happened?"
+    description:  |
+      If the issue is visual in nature, consider posting a screenshot.
+  validations:
+    required: true
+- type: textarea
+  id: reproduction-steps
+  attributes:
+    label: "How can we reproduce this error?"
+    description: |
+      List of steps required to reproduce the error. If the bug is code related, a minimal code example that reproduces the problem would be a big help.
+    value: |
+      1.
+      2.
+      3.
+      ...
+  validations:
+    required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.

.github/ISSUE_TEMPLATE/03_enhancements.yml

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

.github/ISSUE_TEMPLATE/04_feature_request.yml

@@ -0,0 +1,52 @@
+name: Feature request
+description: For feature requests regarding Red itself.
+labels: 'Type: Feature'
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out an issue, this template is meant for any feature suggestions.
+      If you require help with installing Red we ask that you join our [Discord server](https://discord.gg/red)
+- type: dropdown
+  id: feature-name
+  attributes:
+    label: "Type of feature request"
+    description: "What type of feature would you like to request?"
+    multiple: true
+    options:
+      - API functionality
+      - Cog
+      - Command
+      - Other
+  validations:
+    required: true
+- type: textarea
+  id: proposal
+  attributes:
+    label: "Description of the feature you're suggesting"
+    description: |
+      Feel free to describe in as much detail as you wish.
+
+      If you are requesting API functionality:
+        - Describe what it should do
+        - Note whether it is to extend existing functionality or introduce new functionality
+
+      If you are requesting a cog to be included in core: 
+        - Describe the functionality in as much detail as possible
+        - Include the command structure, if possible
+        - Please note that unless it's something that should be core functionality,
+          we reserve the right to reject your suggestion and point you to our cog 
+          board to request it for a third-party cog
+      
+      If you are requesting a command:
+        - Include what cog it should be in and a name for the command
+        - Describe the intended functionality for the command
+        - Note any restrictions on who can use the command or where it can be used
+  validations:
+    required: true
+- type: textarea
+  id: anything-else
+  attributes:
+    label: Anything else?
+    description: Let us know if you have anything else to share.
+

.github/ISSUE_TEMPLATE/config.yml

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

.github/PULL_REQUEST_TEMPLATE.md

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

.github/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/labeler.yml

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

.github/workflows/auto_labeler_issues.yml

@@ -0,0 +1,28 @@
+name: Auto Labeler - Issues
+on:
+  issues:
+    types: [opened]
+
+permissions:
+  issues: write
+
+jobs:
+  apply_triage_label_to_issues:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply Triage Label
+        uses: actions/github-script@v6
+        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.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: ['Status: Needs Triage']
+            });

.github/workflows/auto_labeler_pr.yml

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

.github/workflows/check_label_pattern_exhaustiveness.yaml

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

.github/workflows/codeql-analysis.yml

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

.github/workflows/crowdin_upload_strings.yml

@@ -0,0 +1,32 @@
+name: Crowdin - Upload strings
+on:
+  push:
+    branches:
+      - V3/develop
+
+jobs:
+  deploy:
+    if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      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 crowdin3
+        pip install redgettext==3.4.2
+    - name: Generate source files
+      run: |
+        make gettext
+    - name: Upload source files
+      run: |
+        make upload_translations
+      env:
+        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_IDENTIFIER }}

.github/workflows/lint_python.yaml

@@ -0,0 +1,30 @@
+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@v3
+        with:
+          ref: ${{ env.ref }}
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+      - run: >
+          python -m pip install
+          'pyflakes @ https://github.com/pycqa/pyflakes/tarball/1911c20'
+          'pycodestyle @ https://github.com/pycqa/pycodestyle/tarball/d219c68'
+          'flake8 @ https://github.com/pycqa/flake8/tarball/3.7.9'
+        name: Install Flake8
+      - run: "python -m flake8 . --count --select=E9,F7,F82 --show-source"
+        name: Flake8 Linting

.github/workflows/prepare_release.yml

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

.github/workflows/publish_release.yml

@@ -0,0 +1,179 @@
+name: Publish Release
+on:
+  push:
+    tags:
+      - "3.[0-9]+.[0-9]+"
+
+jobs:
+  release_information:
+    if: github.repository == 'Cog-Creators/Red-DiscordBot'
+    name: GO HERE BEFORE APPROVING
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout repository and install Python
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+
+      # Get version to release
+      - name: Get version to release
+        id: version_to_release
+        run: |
+          python .github/workflows/scripts/bump_version.py
+        env:
+          PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
+          JUST_RETURN_VERSION: '1'
+
+      # Print release information
+      - name: REVIEW OUTPUT OF THIS STEP BEFORE APPROVING
+        env:
+          TAG_BASE_BRANCH: ${{ github.event.base_ref }}
+          TAG_REF_NAME: ${{ github.ref }}
+          RELEASE_VERSION: ${{ steps.version_to_release.outputs.version }}
+        run: |
+          echo 'Release information:'
+          echo "- Branch the tag was based off: ${TAG_BASE_BRANCH#'refs/heads/'}"
+          echo "- Tag name: ${TAG_REF_NAME#'refs/tags/'}"
+          echo "- Release version: $RELEASE_VERSION"
+
+          echo "TAG_NAME=${TAG_REF_NAME#'refs/tags/'}" >> $GITHUB_ENV
+
+      - name: Ensure the tag name corresponds to the released version
+        env:
+          RELEASE_VERSION: ${{ steps.version_to_release.outputs.version }}
+        run: |
+          if [[ "$TAG_NAME" != "$RELEASE_VERSION" ]]; then
+              echo -n "The tag name ($TAG_NAME) is not the same as"
+              echo " the release version ($RELEASE_VERSION)!"
+              exit 1
+          else
+              echo "The tag name and the release version are the same ($TAG_NAME)."
+              echo 'Continuing...'
+          fi
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade build twine
+
+      - name: Build
+        run: python -m build
+      - name: Check built distributions
+        run: python -m twine check dist/*
+
+      - name: Upload packaged distributions
+        uses: actions/upload-artifact@v3
+        with:
+          name: build-output
+          path: ./dist
+
+  release_to_pypi:
+    needs:
+      - release_information
+      - build
+    environment: Release
+    name: Release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Download packaged distributions
+        uses: actions/download-artifact@v3
+        with:
+          name: build-output
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # This is already checked during the build.
+          verify-metadata: false
+          # Allow security-minded people to verify whether the files on PyPI
+          # were automatically uploaded by a CI script.
+          print-hash: true
+
+  pr_dev_bump:
+    permissions:
+      contents: write
+      pull-requests: write
+    needs: release_to_pypi
+    name: Update Red version number to dev
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get base branch
+        env:
+          TAG_BASE_BRANCH: ${{ github.event.base_ref }}
+        run: |
+          echo "BASE_BRANCH=${TAG_BASE_BRANCH#'refs/heads/'}" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ env.BASE_BRANCH }}
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+
+      # Version bump to development version
+      - name: Update Red version number to dev
+        id: bump_version_dev
+        run: |
+          python .github/workflows/scripts/bump_version.py
+        env:
+          PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
+          DEV_BUMP: '1'
+
+      # Get milestone number of the milestone for the old version
+      - name: Get milestone number
+        id: get_milestone_number
+        uses: actions/github-script@v6
+        env:
+          MILESTONE_TITLE: ${{ steps.bump_version_dev.outputs.old_version }}
+        with:
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/get_milestone_number_by_exact_title.js`
+            );
+            return await script({github, context});
+
+      - name: Create Pull Request
+        id: cpr_bump_dev
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Version bump to ${{ steps.bump_version_dev.outputs.new_version }}
+          title: Version bump to ${{ steps.bump_version_dev.outputs.new_version }}
+          body: |
+            This is an automated PR.
+            Please ensure that there are no errors or invalid files are in the PR.
+          labels: "Automated PR, Changelog Entry: Skipped"
+          branch: "automated/pr_bumps/${{ steps.bump_version_dev.outputs.new_version }}"
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          milestone: ${{ steps.get_milestone_number.outputs.result }}
+          base: ${{ env.BASE_BRANCH }}
+
+      - name: Close and reopen the PR with different token to trigger CI
+        uses: actions/github-script@v6
+        env:
+          PR_NUMBER: ${{ steps.cpr_bump_dev.outputs.pull-request-number }}
+          PR_OPERATION: ${{ steps.cpr_bump_dev.outputs.pull-request-operation }}
+        with:
+          github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
+          script: |
+            const script = require(
+              `${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
+            );
+            console.log(await script({github, context}));

.github/workflows/run_pip_compile.yaml

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

.github/workflows/scripts/bump_version.py

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

.github/workflows/scripts/check_label_pattern_exhaustiveness.py

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

.github/workflows/scripts/close_and_reopen_pr.js

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

.github/workflows/scripts/compile_requirements.py

@@ -0,0 +1,45 @@
+import os
+import re
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+
+EXCLUDE_STEM_RE = re.compile(r".*-3\.(?!8-)(\d+)-extra-(doc|style)")
+GITHUB_OUTPUT = os.environ["GITHUB_OUTPUT"]
+REQUIREMENTS_FOLDER = Path(__file__).parents[3].absolute() / "requirements"
+os.chdir(REQUIREMENTS_FOLDER)
+
+
+def pip_compile(version: str, name: str) -> None:
+    stem = f"{sys.platform}-{version}-{name}"
+    if EXCLUDE_STEM_RE.fullmatch(stem):
+        return
+
+    executable = ("py", f"-{version}") if sys.platform == "win32" else (f"python{version}",)
+    subprocess.check_call(
+        (
+            *executable,
+            "-m",
+            "piptools",
+            "compile",
+            "--upgrade",
+            "--resolver=backtracking",
+            "--verbose",
+            f"{name}.in",
+            "--output-file",
+            f"{stem}.txt",
+        )
+    )
+
+
+for minor in range(8, 11 + 1):
+    version = f"3.{minor}"
+    pip_compile(version, "base")
+    shutil.copyfile(f"{sys.platform}-{version}-base.txt", "base.txt")
+    for file in REQUIREMENTS_FOLDER.glob("extra-*.in"):
+        pip_compile(version, file.stem)
+
+with open(GITHUB_OUTPUT, "a", encoding="utf-8") as fp:
+    fp.write(f"sys_platform={sys.platform}\n")

.github/workflows/scripts/get_milestone_number_by_exact_title.js

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

.github/workflows/scripts/merge_requirements.py

@@ -0,0 +1,203 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+from typing import Dict, Iterable, List, TextIO, Tuple
+
+from packaging.markers import Marker
+from packaging.requirements import Requirement
+
+
+REQUIREMENTS_FOLDER = Path(__file__).parents[3].absolute() / "requirements"
+os.chdir(REQUIREMENTS_FOLDER)
+
+
+class RequirementData:
+    def __init__(self, requirement_string: str) -> None:
+        self.req = Requirement(requirement_string)
+        self.comments = set()
+
+    def __hash__(self) -> int:
+        return hash(self.req)
+
+    def __eq__(self, other: RequirementData) -> bool:
+        return self.req == other.req
+
+    @property
+    def name(self) -> str:
+        return self.req.name
+
+    @property
+    def marker(self) -> Marker:
+        return self.req.marker
+
+    @marker.setter
+    def marker(self, value: Marker) -> None:
+        self.req.marker = value
+
+
+def get_requirements(fp: TextIO) -> List[RequirementData]:
+    requirements = []
+
+    current = None
+    for line in fp.read().splitlines():
+        annotation_prefix = "    # "
+        if line.startswith(annotation_prefix) and current is not None:
+            source = line[len(annotation_prefix) :].strip()
+            if source == "via":
+                continue
+            via_prefix = "via "
+            if source.startswith(via_prefix):
+                source = source[len(via_prefix) :]
+            current.comments.add(source)
+        elif line and not line.startswith(("#", " ")):
+            current = RequirementData(line)
+            requirements.append(current)
+
+    return requirements
+
+
+def iter_envs(envs: Iterable[str]) -> Iterable[Tuple[str, str]]:
+    for env_name in envs:
+        platform, python_version = env_name.split("-", maxsplit=1)
+        yield (platform, python_version)
+
+
+names = ["base"]
+names.extend(file.stem for file in REQUIREMENTS_FOLDER.glob("extra-*.in"))
+base_requirements: List[RequirementData] = []
+
+for name in names:
+    # {req_data: {sys_platform: RequirementData}
+    input_data: Dict[RequirementData, Dict[str, RequirementData]] = {}
+    all_envs = set()
+    all_platforms = set()
+    all_python_versions = set()
+    for file in REQUIREMENTS_FOLDER.glob(f"*-{name}.txt"):
+        platform_name, python_version, _ = file.stem.split("-", maxsplit=2)
+        env_name = f"{platform_name}-{python_version}"
+        all_envs.add(env_name)
+        all_platforms.add(platform_name)
+        all_python_versions.add(python_version)
+        with file.open(encoding="utf-8") as fp:
+            requirements = get_requirements(fp)
+
+        for req in requirements:
+            envs = input_data.setdefault(req, {})
+            envs[env_name] = req
+
+    output = base_requirements if name == "base" else []
+    for req, envs in input_data.items():
+        # {platform: [python_versions...]}
+        python_versions_per_platform: Dict[str, List[str]] = {}
+        # {python_version: [platforms...]}
+        platforms_per_python_version: Dict[str, List[str]] = {}
+        platforms = python_versions_per_platform.keys()
+        python_versions = platforms_per_python_version.keys()
+        for env_name, other_req in envs.items():
+            platform_name, python_version = env_name.split("-", maxsplit=1)
+            python_versions_per_platform.setdefault(platform_name, []).append(python_version)
+            platforms_per_python_version.setdefault(python_version, []).append(platform_name)
+
+            req.comments.update(other_req.comments)
+
+        base_req = next(
+            (base_req for base_req in base_requirements if base_req.name == req.name), None
+        )
+        if base_req is not None:
+            old_base_marker = base_req.marker
+            old_req_marker = req.marker
+            req.marker = base_req.marker = None
+            if base_req.req != req.req:
+                raise RuntimeError(f"Incompatible requirements for {req.name}.")
+
+            base_req.marker = old_base_marker
+            req.marker = old_req_marker
+            if base_req.marker is None or base_req.marker == req.marker:
+                continue
+
+        if len(envs) == len(all_envs):
+            output.append(req)
+            continue
+
+        # At this point I'm wondering why I didn't just go for
+        # a more generic boolean algebra simplification (sympy.simplify_logic())...
+        if (
+            len(set(map(frozenset, python_versions_per_platform.values()))) == 1
+            or len(set(map(frozenset, platforms_per_python_version.values()))) == 1
+        ):
+            # Either all platforms have the same Python version set
+            # or all Python versions have the same platform set.
+            # We can generate markers for platform (platform_marker) and Python
+            # (python_version_marker) version sets separately and then simply require
+            # that both markers are fulfilled at the same time (env_marker).
+
+            python_version_marker = (
+                # Requirement present on less Python versions than not.
+                " or ".join(
+                    f"python_version == '{python_version}'" for python_version in python_versions
+                )
+                if len(python_versions) < len(all_python_versions - python_versions)
+                # Requirement present on more Python versions than not
+                # This may generate an empty string when Python version is irrelevant.
+                else " and ".join(
+                    f"python_version != '{python_version}'"
+                    for python_version in all_python_versions - python_versions
+                )
+            )
+
+            platform_marker = (
+                # Requirement present on less platforms than not.
+                " or ".join(f"sys_platform == '{platform}'" for platform in platforms)
+                if len(platforms) < len(all_platforms - platforms)
+                # Requirement present on more platforms than not
+                # This may generate an empty string when platform is irrelevant.
+                else " and ".join(
+                    f"sys_platform != '{platform}'" for platform in all_platforms - platforms
+                )
+            )
+
+            if python_version_marker and platform_marker:
+                env_marker = f"({python_version_marker}) and ({platform_marker})"
+            else:
+                env_marker = python_version_marker or platform_marker
+        else:
+            # Fallback to generic case.
+            env_marker = (
+                # Requirement present on less envs than not.
+                " or ".join(
+                    f"(sys_platform == '{platform}' and python_version == '{python_version}')"
+                    for platform, python_version in iter_envs(envs)
+                )
+                if len(envs) < len(all_envs - envs.keys())
+                else " and ".join(
+                    f"(sys_platform != '{platform}' and python_version != '{python_version}')"
+                    for platform, python_version in iter_envs(all_envs - envs.keys())
+                )
+            )
+
+        new_marker = f"({req.marker}) and ({env_marker})" if req.marker is not None else env_marker
+        req.marker = Marker(new_marker)
+        if base_req is not None and base_req.marker == req.marker:
+            continue
+
+        output.append(req)
+
+    output.sort(key=lambda req: (req.marker is not None, req.name))
+    with open(f"{name}.txt", "w+", encoding="utf-8") as fp:
+        for req in output:
+            fp.write(str(req.req))
+            fp.write("\n")
+            comments = sorted(req.comments)
+
+            if len(comments) == 1:
+                source = comments[0]
+                fp.write("    # via ")
+                fp.write(source)
+                fp.write("\n")
+            else:
+                fp.write("    # via\n")
+                for source in comments:
+                    fp.write("    #   ")
+                    fp.write(source)
+                    fp.write("\n")

.github/workflows/tests.yml

@@ -0,0 +1,107 @@
+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:
+            - style
+            - docs
+          include:
+            - tox_env: py38
+              python_version: "3.8"
+              friendly_name: Python 3.8 - Tests
+            - tox_env: py39
+              python_version: "3.9"
+              friendly_name: Python 3.9 - Tests
+            - tox_env: py310
+              python_version: "3.10"
+              friendly_name: Python 3.10 - Tests
+            - tox_env: py311
+              python_version: "3.11"
+              friendly_name: Python 3.11 - 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@v3
+          with:
+            ref: ${{ env.ref }}
+        - name: Set up Python
+          uses: actions/setup-python@v4
+          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"
+            - "3.9"
+            - "3.10"
+            - "3.11"
+        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@v3
+          with:
+            ref: ${{ env.ref }}
+        - name: Set up Python
+          uses: actions/setup-python@v4
+          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
+        - name: Verify no errors in PostgreSQL logs.
+          run: |
+            logs="$(docker logs "${{ job.services.postgresql.id }}" 2>&1)"
+            echo "---- PostgreSQL logs ----"
+            echo "$logs"
+            echo "---- PostgreSQL logs ----"
+            error_count="$(echo "$logs" | { grep -c 'ERROR: ' || true; })"
+            if [[ $error_count -gt 0 ]]; then
+              exit 1
+            fi

.gitignore

@@ -1,41 +1,22 @@
-# Trivia list repo injection
-redbot/trivia/
-
-*.json
 *.exe
 *.dll
+*.pot
 .data
+!/tests/cogs/dataconverter/data/**/*.json
+Pipfile
+Pipfile.lock
+.directory
 
 ### 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
+.vscode/
+*.sublime-project
+*.sublime-workspace
 
 ## Plugin-specific files:
 
@@ -79,6 +60,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -156,3 +138,91 @@ ENV/
 # mypy
 .mypy_cache/
 
+# pytest
+.pytest_cache/
+
+# Pre-commit hooks
+/.pre-commit-config.yaml
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### SublimeText template
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+
+# SFTP configuration file
+sftp-config.json
+sftp-config-alt*.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+

.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,13 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

.travis.yml

@@ -1,42 +0,0 @@
-dist: trusty
-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

CONTRIBUTING.md

@@ -0,0 +1,159 @@
+# 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 How To Report A Bug](#47-how-to-report-a-bug)
+  * [4.8 How To Suggest A Feature Or Enhancement](#48-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)
+
+# 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.
+
+### 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.
+
+# 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.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/).
+
+# 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.
+* help-wanted - issues that are currently unassigned to anyone and may be a bit more involved/complex than issues tagged with beginner.
+
+**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github)
+
+At this point you're ready to start making changes. Feel free to ask for help; everyone was a beginner at some point!
+
+# 4. Getting Started
+
+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/psf/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/psf/black), actually happens to be an auto-formatter. The checking functionality simply detects whether or not it would try to reformat something in your code, should you run the formatter on it. For this reason, we recommend using this tool as a formatter, regardless of any disagreements you might have with the style it enforces.
+
+Use the command `black --help` to see how to use this tool. The full style guide is explained in detail on [black's GitHub repository](https://github.com/psf/black). **There is one exception to this**, however, which is that we set the line length to 99, instead of black's default 88. This is already set in `pyproject.toml` configuration file in the repo so you can simply format code with Black like so: `black <src>`.
+
+### 4.4 Make
+You may have noticed we have a `Makefile` and a `make.bat` in the top-level directory. For now, you can do a few things with them:
+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:
+    * Run tests with `tox` to ensure your code is up to scratch
+    * Create a Pull Request on GitHub with your changes
+      - If you are contributing a behavior change, please keep in mind that behavior changes
+        are conditional on them being appropriate for the project's current goals.
+        If you would like to reduce the risk of putting in effort for something we aren't
+        going to use, open an issue discussing it first.
+
+### 4.7 How To Report A Bug
+Please see our **ISSUES.MD** for more information.
+
+### 4.8 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.
+
+# 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.
+
+### 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.
+
+### 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 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.
+
+### 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.
+
+# 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).

LICENSE

@@ -632,7 +632,8 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     Red - A fully customizable Discord bot
-    Copyright (C) 2015-2018  Twentysix
+    Copyright (C) 2017-present  Cog Creators
+    Copyright (C) 2015-2017  Twentysix
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +653,8 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    Red-DiscordBot  Copyright (C) 2015-2018  Twentysix
+    Red-DiscordBot  Copyright (C) 2017-present  Cog Creators
+    Red-DiscordBot  Copyright (C) 2015-2017  Twentysix
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -672,3 +674,34 @@ 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 the Audio module that 
+have a separate copyright notice and license terms. Your use of the source 
+code for these subcomponents is subject to the terms and conditions of the 
+following licenses.
+
+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.
+
+This project vendors discord.ext.menus package (https://github.com/Rapptz/discord-ext-menus) made by Danny Y. (Rapptz) which is distributed under MIT License.
+Copy of this license can be found in discord-ext-menus.LICENSE file in redbot/vendored folder of this repository.

MANIFEST.in

@@ -1,4 +1,33 @@
-include README.rst
+# include license files
 include LICENSE
-include requirements.txt
-include discord/bin/*.dll
+recursive-include redbot *.LICENSE
+
+# include requirements files
+include requirements/base.in
+include requirements/base.txt
+include requirements/extra-*.in
+include requirements/extra-*.txt
+
+# include locale files
+recursive-include redbot locales/*.po
+
+# include data folders for cogs
+recursive-include redbot/**/data *
+
+# include *.export files from the test fixtures
+recursive-include redbot *.export
+
+# include the py.typed file informing about Red being typed
+recursive-include redbot py.typed
+
+# include *.sql files from postgres driver
+recursive-include redbot/core/_drivers/postgres *.sql
+
+# include tests
+graft tests
+
+# include tox configuration
+include tox.ini
+
+# exclude files containing byte-code and compiled libs
+global-exclude *.py[cod]

Makefile

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

README.md

@@ -0,0 +1,134 @@
+<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://pypi.org/project/Red-DiscordBot/">
+     <img alt="PyPI" src="https://img.shields.io/pypi/v/Red-Discordbot">
+  </a>
+  <a href="https://www.python.org/downloads/">
+    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/Red-Discordbot">
+  </a>
+  <a href="https://github.com/Rapptz/discord.py/">
+     <img src="https://img.shields.io/badge/discord-py-blue.svg" alt="discord.py">
+  </a>
+  <a href="https://www.patreon.com/Red_Devs">
+    <img src="https://img.shields.io/badge/Support-Red!-red.svg" alt="Support Red on Patreon!">
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/Cog-Creators/Red-DiscordBot/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/Cog-Creators/Red-Discordbot/tests.yml?label=tests" alt="GitHub Actions">
+  </a>
+  <a href="http://docs.discord.red/en/stable/?badge=stable">
+    <img src="https://readthedocs.org/projects/red-discordbot/badge/?version=stable" alt="Red on readthedocs.org">
+  </a>
+  <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black">
+  </a>
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg">
+  </a>
+  <a href="https://crowdin.com/project/red-discordbot">
+    <img src="https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg" alt="Localized with Crowdin">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#overview">Overview</a>
+  •
+  <a href="#installation">Installation</a>
+  •
+  <a href="http://docs.discord.red/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 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 installing and updating, every part of the bot can be controlled from within Discord.
+
+**The default set of modules includes and is not limited to:**
+
+- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)
+- Trivia (lists are included and can be easily added)
+- Music features (YouTube, SoundCloud, local files, playlists, queues)
+- Stream alerts (Twitch, Youtube, 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://docs.discord.red/en/stable/install_guides/windows.html)
+- [MacOS](https://docs.discord.red/en/stable/install_guides/mac.html)
+- [Most major linux distributions](https://docs.discord.red/en/stable/install_guides/index.html)
+
+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://index.discord.red) at a list of
+available 3rd party cogs!
+
+# Join the community!
+
+**Red** is in continuous development, and it’s supported by an active community which produces new
+content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t
+[find](https://index.discord.red) the cog you’re looking for,
+consult our [guide](https://docs.discord.red/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.
+
+This project vendors [discord.ext.menus](https://github.com/Rapptz/discord-ext-menus) package made by Danny Y. (Rapptz) which is distributed under MIT License.
+A copy of this license can be found in the [discord-ext-menus.LICENSE](redbot/vendored/discord-ext-menus.LICENSE) file in the [redbot/vendored](redbot/vendored) folder of this repository.

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

SECURITY.md

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

crowdin.yml

@@ -1,5 +1,9 @@
-api_key_env: CROWDIN_API_KEY
-project_identifier_env: CROWDIN_PROJECT_ID
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN
+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/_ext/deprecated_removed.py

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

docs/_html/robots.txt

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

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

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

docs/autostart_systemd.rst

@@ -0,0 +1,100 @@
+.. _systemd-service-guide:
+
+==============================================
+Setting up auto-restart using systemd on Linux
+==============================================
+
+.. note:: This guide is for setting up systemd on a Linux environment. This guide assumes that you already have a working Red instance.
+
+-------------------------
+Creating the service file
+-------------------------
+
+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:
+
+.. prompt:: bash
+
+    whoami
+
+Next, your python :code:`path` can be fetched with the following commands:
+
+.. prompt:: bash
+    :prompts: $,(redenv) $
+    :modifiers: auto
+
+    # If redbot is installed in a venv
+    $ source ~/redenv/bin/activate
+    (redenv) $ /usr/bin/which python
+
+Then create the new service file:
+
+:code:`sudo nano /etc/systemd/system/red@.service`
+
+Paste the following in the file, and replace all instances of :code:`username` with the Linux username you retrieved above, and :code:`path` with the python path you retrieved above.
+
+.. code-block:: none
+    :emphasize-lines: 8-10
+
+    [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=on-abnormal
+    RestartSec=15
+    RestartForceExitStatus=1
+    RestartForceExitStatus=26
+    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 **@**:
+
+.. prompt:: bash
+
+    sudo systemctl start red@instancename
+
+To set the bot to start on boot, you must enable the service, again adding the instance name after the **@**:
+
+.. prompt:: bash
+
+    sudo systemctl enable red@instancename
+
+If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
+type the following command in the terminal, still by adding the instance name after the **@**:
+
+.. prompt:: bash
+
+    sudo systemctl stop red@instancename
+
+.. warning:: If the service doesn't stop in the next 10 seconds, the process is killed.
+    Check your logs to know the cause of the error that prevents the shutdown.
+
+To set the bot to not start on boot anymore, you must disable the service by running the following command, adding the instance name after the **@**:
+
+.. prompt:: bash
+
+    sudo systemctl disable red@instancename
+
+You can access Red's log through journalctl:
+
+.. prompt:: bash
+
+    sudo journalctl -eu red@instancename

docs/autostart_windows.rst

@@ -0,0 +1,51 @@
+.. _autostart-windows:
+
+==============================================
+Setting up auto-restart using batch on Windows
+==============================================
+
+.. note:: This guide assumes that you already have a working Red instance.
+
+-----------------------
+Creating the batch file
+-----------------------
+
+Create a new text document anywhere you want to. This file will be used to launch the bot, so you may want to put it somewhere convenient, like Documents or Desktop.
+
+Open that document in Notepad, and paste the following text in it:
+
+.. code-block:: batch
+    
+    @ECHO OFF
+    :RED
+    CALL "%userprofile%\redenv\Scripts\activate.bat"
+    python -O -m redbot <your instance name>
+
+    IF %ERRORLEVEL% == 1 GOTO RESTART_RED
+    IF %ERRORLEVEL% == 26 GOTO RESTART_RED
+    EXIT /B %ERRORLEVEL%
+
+    :RESTART_RED
+    ECHO Restarting Red...
+    GOTO RED
+
+Replace ``<your instance name>`` with the instance name of your bot.
+If you created your VENV at a location other than the recommended one, replace ``%userprofile%\redenv\Scripts\activate.bat`` with the path to your VENV.
+
+Click "File", "Save as". Change the dropdown "Save as type" to "All Files (*.*)". Set the filename to ``start_redbot.bat``, and click save.
+
+There should now be a new file in the location you created the text document in. You can delete that text document as it is no longer needed.
+You can now use the ``start_redbot.bat`` batch file to launch Red by double clicking it.
+This script will automatically restart red when the ``[p]restart`` command is used or when the bot shuts down abnormally.
+
+-------------------------
+Launch the bot on startup
+-------------------------
+
+Create a shortcut of your ``start_redbot.bat`` file.
+
+Open the "Run" dialogue box using Windows Key + R.
+
+Enter ``shell:startup`` if you want the bot to launch only when the current user logs in, or ``shell:common startup`` if you want the bot to launch when any user logs in.
+
+Drag the shortcut into the folder that is opened. The bot will now launch on startup.

docs/bot_application_guide.rst

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

docs/changelog.rst

@@ -0,0 +1,5 @@
+=========
+Changelog
+=========
+
+.. include:: ../CHANGES.rst

docs/cog_customcom.rst

@@ -0,0 +1,110 @@
+.. CustomCommands Cog Reference
+.. _cog_customcom:
+
+============================
+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 thread/channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
+
+------------------
+Context Parameters
+------------------
+
+You can enhance your custom command's response by leaving spaces for the bot to substitute.
+
++-----------+--------------------------------------------------+
+| Argument  | Substitute                                       |
++===========+==================================================+
+| {message} | The message the bot is responding to.            |
++-----------+--------------------------------------------------+
+| {author}  | The user who called the command.                 |
++-----------+--------------------------------------------------+
+| {channel} | The channel or thread the command was called in. |
++-----------+--------------------------------------------------+
+| {server}  | The server the command was called in.            |
++-----------+--------------------------------------------------+
+| {guild}   | Same as with {server}.                           |
++-----------+--------------------------------------------------+
+
+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.display_avatar}
+    [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_guides/admin.rst

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

docs/cog_guides/alias.rst

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

docs/cog_guides/cleanup.rst

@@ -0,0 +1,333 @@
+.. _cleanup:
+
+=======
+Cleanup
+=======
+
+This is the cog guide for the cleanup cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load cleanup
+
+.. _cleanup-usage:
+
+-----
+Usage
+-----
+
+This cog contains commands used for "cleaning up" (deleting) messages.
+
+This is designed as a moderator tool and offers many convenient use cases.
+All cleanup commands only apply to the channel the command is executed in.
+
+Messages older than two weeks cannot be mass deleted.
+This is a limitation of the API.
+
+
+.. _cleanup-commands:
+
+--------
+Commands
+--------
+
+.. _cleanup-command-cleanup:
+
+^^^^^^^
+cleanup
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup 
+
+**Description**
+
+Base command for deleting messages.
+
+.. _cleanup-command-cleanup-after:
+
+"""""""""""""
+cleanup after
+"""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup after <message_id> [delete_pinned=False]
+
+**Description**
+
+Delete all messages after a specified message.
+
+To get a message id, enable developer mode in Discord's
+settings, 'appearance' tab. Then right click a message
+and copy its id.
+
+**Arguments:**
+
+- ``<message_id>`` The id of the message to cleanup after. This message won't be deleted.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-before:
+
+""""""""""""""
+cleanup before
+""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup before <message_id> <number> [delete_pinned=False]
+
+**Description**
+
+Deletes X messages before the specified message.
+
+To get a message id, enable developer mode in Discord's
+settings, 'appearance' tab. Then right click a message
+and copy its id.
+
+**Arguments:**
+
+- ``<message_id>`` The id of the message to cleanup before. This message won't be deleted.
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-between:
+
+"""""""""""""""
+cleanup between
+"""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup between <one> <two> [delete_pinned=False]
+
+**Description**
+
+Delete the messages between Message One and Message Two, providing the messages IDs.
+
+The first message ID should be the older message and the second one the newer.
+
+Example:
+    - ``[p]cleanup between 123456789123456789 987654321987654321``
+
+**Arguments:**
+
+- ``<one>`` The id of the message to cleanup after. This message won't be deleted.
+- ``<two>`` The id of the message to cleanup before. This message won't be deleted.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-bot:
+
+"""""""""""
+cleanup bot
+"""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup bot <number> [delete_pinned=False]
+
+**Description**
+
+Clean up command messages and messages from the bot in the current channel.
+
+Can only cleanup custom commands and alias commands if those cogs are loaded.
+
+**Arguments:**
+
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-messages:
+
+""""""""""""""""
+cleanup messages
+""""""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup messages <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages in the current channel.
+
+Example:
+    - ``[p]cleanup messages 26``
+
+**Arguments:**
+
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-self:
+
+""""""""""""
+cleanup self
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup self <number> [match_pattern] [delete_pinned=False]
+
+**Description**
+
+Clean up messages owned by the bot in the current channel.
+
+By default, all messages are cleaned. If a second argument is specified,
+it is used for pattern matching - only messages containing the given text will be deleted.
+
+Examples:
+    - ``[p]cleanup self 6``
+    - ``[p]cleanup self 10 Pong``
+    - ``[p]cleanup self 7 "" True``
+
+**Arguments:**
+
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<match_pattern>`` The text that messages must contain to be deleted. Use "" to skip this.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-spam:
+
+""""""""""""
+cleanup spam
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup spam [number=50]
+
+**Description**
+
+Deletes duplicate messages in the channel from the last X messages and keeps only one copy.
+
+Defaults to 50.
+
+**Arguments:**
+
+- ``<number>`` The number of messages to check for duplicates. Must be a positive integer.
+
+.. _cleanup-command-cleanup-text:
+
+""""""""""""
+cleanup text
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup text <text> <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages matching the specified text in the current channel.
+
+Example:
+    - ``[p]cleanup text "test" 5``
+
+Remember to use double quotes.
+
+**Arguments:**
+
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanup-user:
+
+""""""""""""
+cleanup user
+""""""""""""
+
+.. note:: |mod-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanup user <user> <number> [delete_pinned=False]
+
+**Description**
+
+Delete the last X messages from a specified user in the current channel.
+
+Examples:
+    - ``[p]cleanup user @Twentysix 2``
+    - ``[p]cleanup user Red 6``
+
+**Arguments:**
+
+- ``<user>`` The user whose messages are to be cleaned up.
+- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
+- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
+
+.. _cleanup-command-cleanupset:
+
+^^^^^^^^^^
+cleanupset
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanupset 
+
+**Description**
+
+Manage the settings for the cleanup command.
+
+.. _cleanup-command-cleanupset-notify:
+
+"""""""""""""""""
+cleanupset notify
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cleanupset notify
+
+**Description**
+
+Toggle clean up notification settings.
+
+When enabled, a message will be sent per cleanup, showing how many messages were deleted.
+This message will be deleted after 5 seconds.

docs/cog_guides/cog_manager_ui.rst

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

docs/cog_guides/customcommands.rst

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

docs/cog_guides/dev.rst

@@ -0,0 +1,254 @@
+.. _dev:
+
+===
+Dev
+===
+
+This is the cog guide for the dev cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load dev
+
+.. _dev-usage:
+
+-----
+Usage
+-----
+
+Various development focused utilities. All commands in this cog are
+restricted to the bot owners.
+
+.. note::
+
+    Unlike other cogs, the Dev cog is only loaded if the bot is
+    started with the ``--dev`` flag.
+
+    .. warning::
+
+        It is not suggested that you run Dev in production. Many
+        of these cog's commands may cause down-the-line complications if
+        not used appropriately.
+
+.. _dev-commands:
+
+--------
+Commands
+--------
+
+.. _dev-command-bypasscooldowns:
+
+^^^^^^^^^^^^^^^
+bypasscooldowns
+^^^^^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bypasscooldowns [toggle]
+
+**Description**
+
+Give bot owners the ability to bypass cooldowns. Note that this bypass
+does not persist through restarts/shutdowns.
+
+**Arguments**
+
+* ``[toggle]``: |bool-input| Otherwise, defaults to the inverse of the current setting.
+
+.. _dev-command-debug:
+
+^^^^^
+debug
+^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]debug <code>
+
+**Description**
+
+Evaluate a statement of python code.
+
+The bot will always respond with the return value of the code.
+If the return value of the code is a coroutine, it will be awaited,
+and the result of that will be the bot's response.
+
+Note: Only one statement may be evaluated. Using certain restricted
+keywords, e.g. yield, will result in a syntax error. For multiple
+lines or asynchronous code, see [p]repl or [p]eval.
+
+**Environment Variables**
+
+* ``ctx``: Command invocation context
+* ``bot``: The bot object
+* ``channel``: The current channel object
+* ``author``: The current author's member object
+* ``guild``: The current guild object
+* ``message``: The command's message object
+* ``aiohttp``: The aiohttp library
+* ``asyncio``: The asyncio library
+* ``discord``: The discord.py library
+* ``commands``: The redbot.core.commands module
+* ``cf``: The redbot.core.utils.chat_formatting module
+* ``_``: The result from the last dev command
+
+**Arguments**
+
+* ``<code>``: The statement to run.
+
+.. _dev-command-eval:
+
+^^^^
+eval
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]eval <body>
+
+**Description**
+
+Execute asynchronous code.
+
+This command wraps code into the body of an async function and then
+calls and awaits it. The bot will respond with anything printed to
+stdout, as well as the return value of the function.
+
+The code can be within a codeblock, inline code or neither, as long
+as they are not mixed and they are formatted correctly.
+
+**Environment Variables**
+
+* ``ctx``: Command invocation context
+* ``bot``: The bot object
+* ``channel``: The current channel object
+* ``author``: The current author's member object
+* ``guild``: The current guild object
+* ``message``: The command's message object
+* ``aiohttp``: The aiohttp library
+* ``asyncio``: The asyncio library
+* ``discord``: The discord.py library
+* ``commands``: The redbot.core.commands module
+* ``cf``: The redbot.core.utils.chat_formatting module
+* ``_``: The result from the last dev command
+
+**Arguments**
+
+* ``<body>``: The code to evaluate.
+
+.. _dev-command-mock:
+
+^^^^
+mock
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]mock <user> <command>
+
+**Description**
+
+Mock another user invoking a command. The prefix must not be entered.
+
+**Arguments**
+
+* ``<user>``: The user to mock. |user-input-quotes|
+* ``<command>``: The command to invoke.
+
+.. _dev-command-mockmsg:
+
+^^^^^^^
+mockmsg
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]mockmsg <user> <content>
+
+**Description**
+
+Dispatch a message event as if it were sent by a different user.
+
+Current message is used as a base (including attachments, embeds, etc.),
+the content and author of the message are replaced with the given arguments.
+
+**Arguments**
+
+* ``<user>``: The member to mock. |user-input-quotes|
+* ``<content>``: The content used for the message.
+
+.. note:: 
+
+        If ``content`` isn't passed, the message needs to contain embeds, attachments,
+        or anything else that makes the message non-empty.
+
+.. _dev-command-repl:
+
+^^^^
+repl
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repl 
+
+**Description**
+
+Open an interactive REPL.
+
+The REPL will only recognise code as messages which start with a
+backtick. This includes codeblocks, and as such multiple lines can be
+evaluated.
+
+Use ``exit()`` or ``quit`` to exit the REPL session, prefixed with
+a backtick so they may be interpreted.
+
+**Environment Variables**
+
+* ``ctx``: Command invocation context
+* ``bot``: The bot object
+* ``channel``: The current channel object
+* ``author``: The current author's member object
+* ``guild``: The current guild object
+* ``message``: The command's message object
+* ``aiohttp``: The aiohttp library
+* ``asyncio``: The asyncio library
+* ``discord``: The discord.py library
+* ``commands``: The redbot.core.commands module
+* ``cf``: The redbot.core.utils.chat_formatting module
+* ``_``: The result from the last dev command
+
+.. _dev-command-repl-pause:
+
+""""""""""
+repl pause
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]repl pause [toggle]
+
+**Description**
+
+Pauses/resumes the REPL running in the current channel.
+
+**Arguments**
+
+* ``[toggle]``: |bool-input| Otherwise, defaults to the inverse of the current setting.

docs/cog_guides/downloader.rst

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

docs/cog_guides/economy.rst

@@ -0,0 +1,391 @@
+.. _economy:
+
+=======
+Economy
+=======
+
+This is the cog guide for the economy cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load economy
+
+.. _economy-usage:
+
+-----
+Usage
+-----
+
+Get rich and have fun with imaginary currency!
+
+
+.. _economy-commands:
+
+--------
+Commands
+--------
+
+.. _economy-command-bank:
+
+^^^^
+bank
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank 
+
+**Description**
+
+Base command to manage the bank.
+
+.. _economy-command-bank-balance:
+
+""""""""""""
+bank balance
+""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank balance [user]
+
+**Description**
+
+Show the user's account balance.
+
+Example:
+    - ``[p]bank balance``
+    - ``[p]bank balance @Twentysix``
+
+**Arguments**
+
+- ``<user>`` The user to check the balance of. If omitted, defaults to your own balance.
+
+.. _economy-command-bank-set:
+
+""""""""
+bank set
+""""""""
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank set <to> <creds>
+
+**Description**
+
+Set the balance of a user's bank account.
+
+Putting + or - signs before the amount will add/remove currency on the user's bank account instead.
+
+Examples:
+    - ``[p]bank set @Twentysix 26`` - Sets balance to 26
+    - ``[p]bank set @Twentysix +2`` - Increases balance by 2
+    - ``[p]bank set @Twentysix -6`` - Decreases balance by 6
+
+**Arguments**
+
+- ``<to>`` The user to set the currency of.
+- ``<creds>`` The amount of currency to set their balance to.
+
+.. _economy-command-bank-transfer:
+
+"""""""""""""
+bank transfer
+"""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bank transfer <to> <amount>
+
+**Description**
+
+Transfer currency to other users.
+
+This will come out of your balance, so make sure you have enough.
+
+Example:
+    - ``[p]bank transfer @Twentysix 500``
+
+**Arguments**
+
+- ``<to>`` The user to give currency to.
+- ``<amount>`` The amount of currency to give.
+
+.. _economy-command-economyset:
+
+^^^^^^^^^^
+economyset
+^^^^^^^^^^
+
+.. note:: |admin-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset 
+
+**Description**
+
+Base command to manage Economy settings.
+
+.. _economy-command-economyset-paydayamount:
+
+"""""""""""""""""""""""
+economyset paydayamount
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset paydayamount <creds>
+
+**Description**
+
+Set the amount earned each payday.
+
+Example:
+    - ``[p]economyset paydayamount 400``
+
+**Arguments**
+
+- ``<creds>`` The new amount to give when using the payday command. Default is 120.
+
+.. _economy-command-economyset-paydaytime:
+
+"""""""""""""""""""""
+economyset paydaytime
+"""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset paydaytime <duration>
+
+**Description**
+
+Set the cooldown for the payday command.
+
+Examples:
+    - ``[p]economyset paydaytime 86400``
+    - ``[p]economyset paydaytime 1d``
+
+**Arguments**
+
+- | ``<duration>`` The new duration to wait in between uses of payday. Default is 5 minutes.
+  | Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
+
+.. _economy-command-economyset-rolepaydayamount:
+
+"""""""""""""""""""""""""""
+economyset rolepaydayamount
+"""""""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset rolepaydayamount <role> <creds>
+
+**Description**
+
+Set the amount earned each payday for a role.
+
+Set to 0 will remove the custom payday for that role instead.
+
+Only available when not using a global bank.
+
+Example:
+    - ``[p]economyset rolepaydayamount @Members 400``
+
+**Arguments**
+
+- ``<role>`` The role to assign a custom payday amount to.
+- ``<creds>`` The new amount to give when using the payday command.
+
+.. _economy-command-economyset-showsettings:
+
+"""""""""""""""""""""""
+economyset showsettings
+"""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset showsettings 
+
+**Description**
+
+Shows the current economy settings
+
+.. _economy-command-economyset-slotmax:
+
+""""""""""""""""""
+economyset slotmax
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slotmax <bid>
+
+**Description**
+
+Set the maximum slot machine bid.
+
+Example:
+    - ``[p]economyset slotmax 50``
+
+**Arguments**
+
+- ``<bid>`` The new maximum bid for using the slot machine. Default is 100.
+
+.. _economy-command-economyset-slotmin:
+
+""""""""""""""""""
+economyset slotmin
+""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slotmin <bid>
+
+**Description**
+
+Set the minimum slot machine bid.
+
+Example:
+    - ``[p]economyset slotmin 10``
+
+**Arguments**
+
+- ``<bid>`` The new minimum bid for using the slot machine. Default is 5.
+
+.. _economy-command-economyset-slottime:
+
+"""""""""""""""""""
+economyset slottime
+"""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]economyset slottime <duration>
+
+**Description**
+
+Set the cooldown for the slot machine.
+
+Examples:
+    - ``[p]economyset slottime 10``
+    - ``[p]economyset slottime 10m``
+
+**Arguments**
+
+- | ``<duration>`` The new duration to wait in between uses of the slot machine. Default is 5 seconds.
+  | Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
+
+.. _economy-command-leaderboard:
+
+^^^^^^^^^^^
+leaderboard
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]leaderboard [top=10] [show_global=False]
+
+**Description**
+
+Print the leaderboard.
+
+Defaults to top 10.
+
+Examples:
+    - ``[p]leaderboard``
+    - ``[p]leaderboard 50`` - Shows the top 50 instead of top 10.
+    - ``[p]leaderboard 100 yes`` - Shows the top 100 from all servers.
+
+**Arguments**
+
+- ``<top>`` How many positions on the leaderboard to show. Defaults to 10 if omitted.
+- ``<show_global>`` Whether to include results from all servers. This will default to false unless specified.
+
+.. _economy-command-payday:
+
+^^^^^^
+payday
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]payday 
+
+**Description**
+
+Get some free currency.
+
+The amount awarded and frequency can be configured.
+
+.. _economy-command-payouts:
+
+^^^^^^^
+payouts
+^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]payouts 
+
+**Description**
+
+Show the payouts for the slot machine.
+
+.. _economy-command-slot:
+
+^^^^
+slot
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]slot <bid>
+
+**Description**
+
+Use the slot machine.
+
+Example:
+    - ``[p]slot 50``
+
+**Arguments**
+
+- ``<bid>`` The amount to bet on the slot machine. Winning payouts are higher when you bet more.

docs/cog_guides/filter.rst

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

docs/cog_guides/general.rst

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

docs/cog_guides/image.rst

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

docs/cog_guides/mod.rst

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

docs/cog_guides/modlog.rst

@@ -0,0 +1,115 @@
+.. _modlog:
+
+======
+ModLog
+======
+
+This is the cog guide for the modlog cog. You will
+find detailed docs about usage and commands.
+
+``[p]`` is considered as your prefix.
+
+.. note:: To use this cog, load it by typing this::
+
+        [p]load modlog
+
+.. _modlog-usage:
+
+-----
+Usage
+-----
+
+Browse and manage modlog cases. To manage modlog settings, use ``[p]modlogset``.
+
+
+.. _modlog-commands:
+
+--------
+Commands
+--------
+
+.. _modlog-command-case:
+
+^^^^
+case
+^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]case <number>
+
+**Description**
+
+Show the specified case.
+
+**Arguments**
+
+* ``<case>``: The case number to get information for.
+
+.. _modlog-command-casesfor:
+
+^^^^^^^^
+casesfor
+^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]casesfor <member>
+
+**Description**
+
+Display cases for the specified member.
+
+**Arguments**
+
+* ``<member>``: The member to get cases for. |member-input|
+
+.. _modlog-command-listcases:
+
+^^^^^^^^^
+listcases
+^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]listcases <member>
+
+**Description**
+
+List cases for the specified member.
+
+**Arguments**
+
+* ``<member>``: The member to get cases for. |member-input|
+
+.. _modlog-command-reason:
+
+^^^^^^
+reason
+^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]reason [case] <reason>
+
+**Description**
+
+Specify a reason for a modlog case.
+
+Please note that you can only edit cases you are
+the owner of unless you are a mod, admin or server owner.
+
+**Arguments**
+
+* ``[case]``: The case number to update the reason for.
+* ``<reason>``: The new reason for the specified case.
+
+.. note:: If no case number is specified, the latest case will be used.

docs/cog_guides/mutes.rst

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

docs/cog_guides/permissions.rst

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

docs/cog_guides/reports.rst

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

docs/cog_guides/streams.rst

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

docs/cog_guides/trivia.rst

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

docs/cog_guides/warnings.rst

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