Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- .gitattributes +2 -0
- testbed/Aider-AI__aider/assets/robot-flowchart.png +3 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/CODEOWNERS +30 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/FUNDING.yml +3 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/ISSUE_TEMPLATE.md +5 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE.md +17 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE/bugfix.md +15 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE/release.md +16 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/labeler.yml +326 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/crowdin_upload_strings.yml +32 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/prepare_release.yml +130 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/run_pip_compile.yaml +84 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/check_label_pattern_exhaustiveness.py +215 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/get_milestone_number_by_exact_title.js +49 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/merge_requirements.py +134 -0
- testbed/Cog-Creators__Red-DiscordBot/.github/workflows/tests.yml +107 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/Makefile +20 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/_ext/deprecated_removed.py +129 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/_html/robots.txt +6 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/_templates/layout.html +18 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/about_venv.rst +39 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/autostart_mac.rst +110 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/autostart_systemd.rst +104 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/autostart_windows.rst +48 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/bot_application_guide.rst +80 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/changelog.rst +5 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_customcom.rst +110 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/admin.rst +454 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/alias.rst +277 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/audio.rst +3764 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/cleanup.rst +333 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/cog_manager_ui.rst +251 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/core.rst +4340 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/customcommands.rst +294 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/dev.rst +254 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/downloader.rst +538 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/economy.rst +391 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/filter.rst +335 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/general.rst +218 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/image.rst +205 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/mod.rst +763 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/modlog.rst +115 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/mutes.rst +410 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/permissions.rst +440 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/reports.rst +141 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/streams.rst +533 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/trivia.rst +439 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/warnings.rst +403 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/cog_permissions.rst +98 -0
- testbed/Cog-Creators__Red-DiscordBot/docs/conf.py +281 -0
.gitattributes
CHANGED
|
@@ -124,3 +124,5 @@ testbed/huggingface__pytorch-image-models/notebooks/GeneralizationToImageNetV2.i
|
|
| 124 |
testbed/gradio-app__gradio/js/app/public/static/img/Duck.glb filter=lfs diff=lfs merge=lfs -text
|
| 125 |
testbed/gradio-app__gradio/test/test_files/playable_but_bad_container.mkv filter=lfs diff=lfs merge=lfs -text
|
| 126 |
testbed/gradio-app__gradio/demo/model3D/files/Duck.glb filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
| 124 |
testbed/gradio-app__gradio/js/app/public/static/img/Duck.glb filter=lfs diff=lfs merge=lfs -text
|
| 125 |
testbed/gradio-app__gradio/test/test_files/playable_but_bad_container.mkv filter=lfs diff=lfs merge=lfs -text
|
| 126 |
testbed/gradio-app__gradio/demo/model3D/files/Duck.glb filter=lfs diff=lfs merge=lfs -text
|
| 127 |
+
testbed/fairlearn__fairlearn/fairlearn/widget/static/index.js.map filter=lfs diff=lfs merge=lfs -text
|
| 128 |
+
testbed/fairlearn__fairlearn/fairlearn/widget/static/extension.js.map filter=lfs diff=lfs merge=lfs -text
|
testbed/Aider-AI__aider/assets/robot-flowchart.png
ADDED
|
Git LFS Details
|
testbed/Cog-Creators__Red-DiscordBot/.github/CODEOWNERS
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Cogs
|
| 2 |
+
/redbot/cogs/audio/** @aikaterna @PredaaA
|
| 3 |
+
/redbot/cogs/downloader/* @Jackenmen
|
| 4 |
+
/redbot/cogs/streams/* @palmtree5
|
| 5 |
+
/redbot/cogs/mutes/* @TrustyJAID
|
| 6 |
+
|
| 7 |
+
# Docs - Install and update guides
|
| 8 |
+
/docs/install_guides/** @Jackenmen
|
| 9 |
+
/docs/update_red.rst @Jackenmen
|
| 10 |
+
|
| 11 |
+
# Docs - Version guarantees
|
| 12 |
+
/docs/version_guarantees.rst @Jackenmen
|
| 13 |
+
|
| 14 |
+
# Trivia Lists
|
| 15 |
+
/redbot/cogs/trivia/data/lists/whosthatpokemon*.yaml @aikaterna
|
| 16 |
+
|
| 17 |
+
# Tests
|
| 18 |
+
/redbot/pytest/downloader* @Jackenmen
|
| 19 |
+
/tests/cogs/downloader/* @Jackenmen
|
| 20 |
+
|
| 21 |
+
# Schemas
|
| 22 |
+
/schema/* @Jackenmen
|
| 23 |
+
|
| 24 |
+
# CI
|
| 25 |
+
/.travis.yml @Kowlin
|
| 26 |
+
/crowdin.yml @Kowlin
|
| 27 |
+
/.github/workflows/* @Kowlin
|
| 28 |
+
|
| 29 |
+
# Excludes
|
| 30 |
+
**/locales/* @ghost
|
testbed/Cog-Creators__Red-DiscordBot/.github/FUNDING.yml
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# These are supported funding model platforms
|
| 2 |
+
|
| 3 |
+
patreon: Red_Devs
|
testbed/Cog-Creators__Red-DiscordBot/.github/ISSUE_TEMPLATE.md
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!--
|
| 2 |
+
Please be sure to use the correct template,
|
| 3 |
+
if your report doesn't have the correct template please open an issue describing your issue in detail
|
| 4 |
+
For support regarding the bot itself please visit the discord server over at https://discord.gg/red
|
| 5 |
+
-->
|
testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
### Description of the changes
|
| 2 |
+
|
| 3 |
+
|
| 4 |
+
|
| 5 |
+
### Have the changes in this PR been tested?
|
| 6 |
+
|
| 7 |
+
<!--
|
| 8 |
+
Choose one (remove the line that doesn't apply):
|
| 9 |
+
-->
|
| 10 |
+
Yes
|
| 11 |
+
No
|
| 12 |
+
<!--
|
| 13 |
+
If the question doesn't apply (for example, it's not a code change), choose Yes.
|
| 14 |
+
|
| 15 |
+
Please respond to this question truthfully. We do not delay nor reject PRs
|
| 16 |
+
based on the answer to this question but it allows to better review this PR.
|
| 17 |
+
-->
|
testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE/bugfix.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Bugfix request
|
| 2 |
+
|
| 3 |
+
<!--
|
| 4 |
+
THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
|
| 5 |
+
To be used for pull requests that fix a bug
|
| 6 |
+
-->
|
| 7 |
+
|
| 8 |
+
#### Describe the bug being fixed
|
| 9 |
+
|
| 10 |
+
<!--
|
| 11 |
+
If an issue exists for the bug, mention
|
| 12 |
+
that this PR fixes that issue
|
| 13 |
+
-->
|
| 14 |
+
|
| 15 |
+
#### Anything we need to know about this fix?
|
testbed/Cog-Creators__Red-DiscordBot/.github/PULL_REQUEST_TEMPLATE/release.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# New release
|
| 2 |
+
|
| 3 |
+
<!--
|
| 4 |
+
THIS TEMPLATE IS CURRENTLY UNUSED DUE TO GITHUB LIMITATIONS!
|
| 5 |
+
To be used by collaborators for doing releases.
|
| 6 |
+
Most contributors will not need to use this.
|
| 7 |
+
-->
|
| 8 |
+
|
| 9 |
+
#### Version
|
| 10 |
+
|
| 11 |
+
|
| 12 |
+
|
| 13 |
+
#### Has a draft release been created for this?
|
| 14 |
+
|
| 15 |
+
- [ ] Yes
|
| 16 |
+
- [ ] No
|
testbed/Cog-Creators__Red-DiscordBot/.github/labeler.yml
ADDED
|
@@ -0,0 +1,326 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"Category: CI":
|
| 2 |
+
- .github/workflows/**/*
|
| 3 |
+
|
| 4 |
+
|
| 5 |
+
"Category: Cogs - Admin":
|
| 6 |
+
# Source
|
| 7 |
+
- redbot/cogs/admin/*
|
| 8 |
+
# Docs
|
| 9 |
+
- docs/cog_guides/admin.rst
|
| 10 |
+
- docs/.resources/admin/**/*
|
| 11 |
+
"Category: Cogs - Alias":
|
| 12 |
+
# Source
|
| 13 |
+
- redbot/cogs/alias/*
|
| 14 |
+
# Docs
|
| 15 |
+
- docs/cog_guides/alias.rst
|
| 16 |
+
# Tests
|
| 17 |
+
- redbot/pytest/alias.py
|
| 18 |
+
- tests/cogs/test_alias.py
|
| 19 |
+
- docs/.resources/alias/**/*
|
| 20 |
+
"Category: Cogs - Audio":
|
| 21 |
+
# Source
|
| 22 |
+
- any:
|
| 23 |
+
- redbot/cogs/audio/**/*
|
| 24 |
+
- "!redbot/cogs/audio/**/locales/*"
|
| 25 |
+
# Docs
|
| 26 |
+
- docs/cog_guides/audio.rst
|
| 27 |
+
"Category: Cogs - Bank": [] # historical label for a removed cog
|
| 28 |
+
"Category: Cogs - Cleanup":
|
| 29 |
+
# Source
|
| 30 |
+
- redbot/cogs/cleanup/*
|
| 31 |
+
# Docs
|
| 32 |
+
- docs/cog_guides/cleanup.rst
|
| 33 |
+
"Category: Cogs - CustomCommands":
|
| 34 |
+
# Source
|
| 35 |
+
- redbot/cogs/customcom/*
|
| 36 |
+
# Docs
|
| 37 |
+
- docs/cog_customcom.rst
|
| 38 |
+
- docs/cog_guides/customcommands.rst
|
| 39 |
+
"Category: Cogs - Dev":
|
| 40 |
+
# Source
|
| 41 |
+
- redbot/core/dev_commands.py
|
| 42 |
+
# Docs
|
| 43 |
+
- docs/cog_guides/dev.rst
|
| 44 |
+
"Category: Cogs - Downloader":
|
| 45 |
+
# Source
|
| 46 |
+
- redbot/cogs/downloader/*
|
| 47 |
+
# Docs
|
| 48 |
+
- docs/cog_guides/downloader.rst
|
| 49 |
+
# Tests
|
| 50 |
+
- redbot/pytest/downloader.py
|
| 51 |
+
- redbot/pytest/downloader_testrepo.*
|
| 52 |
+
- tests/cogs/downloader/**/*
|
| 53 |
+
"Category: Cogs - Economy":
|
| 54 |
+
# Source
|
| 55 |
+
- redbot/cogs/economy/*
|
| 56 |
+
# Docs
|
| 57 |
+
- docs/cog_guides/economy.rst
|
| 58 |
+
# Tests
|
| 59 |
+
- redbot/pytest/economy.py
|
| 60 |
+
- tests/cogs/test_economy.py
|
| 61 |
+
"Category: Cogs - Filter":
|
| 62 |
+
# Source
|
| 63 |
+
- redbot/cogs/filter/*
|
| 64 |
+
# Docs
|
| 65 |
+
- docs/cog_guides/filter.rst
|
| 66 |
+
"Category: Cogs - General":
|
| 67 |
+
# Source
|
| 68 |
+
- redbot/cogs/general/*
|
| 69 |
+
# Docs
|
| 70 |
+
- docs/cog_guides/general.rst
|
| 71 |
+
"Category: Cogs - Image":
|
| 72 |
+
# Source
|
| 73 |
+
- redbot/cogs/image/*
|
| 74 |
+
# Docs
|
| 75 |
+
- docs/cog_guides/image.rst
|
| 76 |
+
"Category: Cogs - Mod":
|
| 77 |
+
# Source
|
| 78 |
+
- redbot/cogs/mod/*
|
| 79 |
+
# Docs
|
| 80 |
+
- docs/cog_guides/mod.rst
|
| 81 |
+
# Tests
|
| 82 |
+
- redbot/pytest/mod.py
|
| 83 |
+
- tests/cogs/test_mod.py
|
| 84 |
+
"Category: Cogs - Modlog":
|
| 85 |
+
# Source
|
| 86 |
+
- redbot/cogs/modlog/*
|
| 87 |
+
# Docs
|
| 88 |
+
- docs/cog_guides/modlog.rst
|
| 89 |
+
"Category: Cogs - Mutes":
|
| 90 |
+
# Source
|
| 91 |
+
- redbot/cogs/mutes/*
|
| 92 |
+
# Docs
|
| 93 |
+
- docs/cog_guides/mutes.rst
|
| 94 |
+
"Category: Cogs - Permissions":
|
| 95 |
+
# Source
|
| 96 |
+
- redbot/cogs/permissions/*
|
| 97 |
+
# Docs
|
| 98 |
+
- docs/cog_guides/permissions.rst
|
| 99 |
+
- docs/cog_permissions.rst
|
| 100 |
+
# Tests
|
| 101 |
+
- redbot/pytest/permissions.py
|
| 102 |
+
- tests/cogs/test_permissions.py
|
| 103 |
+
"Category: Cogs - Reports":
|
| 104 |
+
# Source
|
| 105 |
+
- redbot/cogs/reports/*
|
| 106 |
+
# Docs
|
| 107 |
+
- docs/cog_guides/reports.rst
|
| 108 |
+
"Category: Cogs - Streams":
|
| 109 |
+
# Source
|
| 110 |
+
- redbot/cogs/streams/*
|
| 111 |
+
# Docs
|
| 112 |
+
- docs/cog_guides/streams.rst
|
| 113 |
+
"Category: Cogs - Trivia":
|
| 114 |
+
# Source
|
| 115 |
+
- redbot/cogs/trivia/*
|
| 116 |
+
# Docs
|
| 117 |
+
- docs/cog_guides/trivia.rst
|
| 118 |
+
- docs/guide_trivia_list_creation.rst
|
| 119 |
+
- docs/.resources/trivia/**/*
|
| 120 |
+
# Tests
|
| 121 |
+
- tests/cogs/test_trivia.py
|
| 122 |
+
"Category: Cogs - Trivia - Lists":
|
| 123 |
+
- redbot/cogs/trivia/data/lists/*
|
| 124 |
+
"Category: Cogs - Warnings":
|
| 125 |
+
# Source
|
| 126 |
+
- redbot/cogs/warnings/*
|
| 127 |
+
# Docs
|
| 128 |
+
- docs/cog_guides/warnings.rst
|
| 129 |
+
|
| 130 |
+
|
| 131 |
+
"Category: Core - API - Audio": [] # potential future feature
|
| 132 |
+
"Category: Core - API - Bank":
|
| 133 |
+
# Source
|
| 134 |
+
- redbot/core/bank.py
|
| 135 |
+
# Docs
|
| 136 |
+
- docs/framework_bank.rst
|
| 137 |
+
"Category: Core - API - App Commands Package":
|
| 138 |
+
# Source
|
| 139 |
+
- redbot/core/app_commands/*
|
| 140 |
+
# Tests
|
| 141 |
+
- tests/core/test_app_commands.py
|
| 142 |
+
"Category: Core - API - Commands Package":
|
| 143 |
+
# Source
|
| 144 |
+
- any:
|
| 145 |
+
- redbot/core/commands/*
|
| 146 |
+
- "!redbot/core/commands/help.py"
|
| 147 |
+
# this isn't in commands package but it just re-exports things from it
|
| 148 |
+
- redbot/core/checks.py
|
| 149 |
+
# Docs
|
| 150 |
+
- docs/framework_checks.rst
|
| 151 |
+
- docs/framework_commands.rst
|
| 152 |
+
# Tests
|
| 153 |
+
- tests/core/test_commands.py
|
| 154 |
+
"Category: Core - API - Config":
|
| 155 |
+
# Source
|
| 156 |
+
- any:
|
| 157 |
+
- redbot/core/drivers/**/*
|
| 158 |
+
- "!redbot/core/drivers/**/locales/*"
|
| 159 |
+
- redbot/core/config.py
|
| 160 |
+
# Docs
|
| 161 |
+
- docs/framework_config.rst
|
| 162 |
+
# Tests
|
| 163 |
+
- tests/core/test_config.py
|
| 164 |
+
"Category: Core - API - Other":
|
| 165 |
+
# Source
|
| 166 |
+
- redbot/__init__.py
|
| 167 |
+
- redbot/core/__init__.py
|
| 168 |
+
- redbot/core/cog_manager.py # TODO: privatize cog manager module
|
| 169 |
+
- redbot/core/data_manager.py
|
| 170 |
+
- redbot/core/errors.py
|
| 171 |
+
- redbot/core/tree.py
|
| 172 |
+
# Docs
|
| 173 |
+
- docs/framework_cogmanager.rst # TODO: privatize cog manager module
|
| 174 |
+
- docs/framework_datamanager.rst
|
| 175 |
+
- docs/framework_tree.rst
|
| 176 |
+
# Tests
|
| 177 |
+
- redbot/pytest/cog_manager.py # TODO: privatize cog manager module
|
| 178 |
+
- redbot/pytest/data_manager.py
|
| 179 |
+
- tests/core/test_cog_manager.py
|
| 180 |
+
- tests/core/test_data_manager.py
|
| 181 |
+
- tests/core/test_version.py
|
| 182 |
+
"Category: Core - API - Utils Package":
|
| 183 |
+
# Source
|
| 184 |
+
- any:
|
| 185 |
+
- redbot/core/utils/*
|
| 186 |
+
- "!redbot/core/utils/_internal_utils.py"
|
| 187 |
+
# Docs
|
| 188 |
+
- docs/framework_utils.rst
|
| 189 |
+
# Tests
|
| 190 |
+
- tests/core/test_utils.py
|
| 191 |
+
"Category: Core - Bot Class":
|
| 192 |
+
# Source
|
| 193 |
+
- redbot/core/bot.py
|
| 194 |
+
# Docs
|
| 195 |
+
- docs/framework_apikeys.rst
|
| 196 |
+
- docs/framework_bot.rst
|
| 197 |
+
"Category: Core - Bot Commands":
|
| 198 |
+
# Source
|
| 199 |
+
- redbot/core/core_commands.py
|
| 200 |
+
- redbot/core/_diagnoser.py
|
| 201 |
+
# Docs
|
| 202 |
+
- docs/.resources/cog_manager_ui/**/*
|
| 203 |
+
- docs/cog_guides/cog_manager_ui.rst
|
| 204 |
+
- docs/cog_guides/core.rst
|
| 205 |
+
"Category: Core - Command-line Interfaces":
|
| 206 |
+
- redbot/__main__.py
|
| 207 |
+
- redbot/logging.py
|
| 208 |
+
- redbot/core/_debuginfo.py
|
| 209 |
+
- redbot/core/cli.py
|
| 210 |
+
- redbot/setup.py
|
| 211 |
+
"Category: Core - Help":
|
| 212 |
+
- redbot/core/commands/help.py
|
| 213 |
+
"Category: Core - i18n":
|
| 214 |
+
# Source
|
| 215 |
+
- redbot/core/i18n.py
|
| 216 |
+
# Locale files
|
| 217 |
+
- redbot/**/locales/*
|
| 218 |
+
# Docs
|
| 219 |
+
- docs/framework_i18n.rst
|
| 220 |
+
"Category: Core - Modlog":
|
| 221 |
+
# Source
|
| 222 |
+
- redbot/core/generic_casetypes.py
|
| 223 |
+
- redbot/core/modlog.py
|
| 224 |
+
# Docs
|
| 225 |
+
- docs/framework_modlog.rst
|
| 226 |
+
"Category: Core - Other Internals":
|
| 227 |
+
# Source
|
| 228 |
+
- redbot/core/_sharedlibdeprecation.py
|
| 229 |
+
- redbot/core/events.py
|
| 230 |
+
- redbot/core/global_checks.py
|
| 231 |
+
- redbot/core/settings_caches.py
|
| 232 |
+
- redbot/core/utils/_internal_utils.py
|
| 233 |
+
# Tests
|
| 234 |
+
- redbot/pytest/__init__.py
|
| 235 |
+
- redbot/pytest/core.py
|
| 236 |
+
- tests/core/test_installation.py
|
| 237 |
+
"Category: Core - RPC/ZMQ":
|
| 238 |
+
# Source
|
| 239 |
+
- redbot/core/rpc.py
|
| 240 |
+
# Docs
|
| 241 |
+
- docs/framework_rpc.rst
|
| 242 |
+
# Tests
|
| 243 |
+
- redbot/pytest/rpc.py
|
| 244 |
+
- tests/core/test_rpc.py
|
| 245 |
+
- tests/rpc_test.html
|
| 246 |
+
|
| 247 |
+
|
| 248 |
+
"Category: Docker": [] # potential future feature
|
| 249 |
+
|
| 250 |
+
|
| 251 |
+
"Category: Docs - Changelogs":
|
| 252 |
+
- CHANGES.rst
|
| 253 |
+
- docs/changelog.rst
|
| 254 |
+
"Category: Docs - For Developers":
|
| 255 |
+
- docs/framework_events.rst
|
| 256 |
+
- docs/guide_cog_creation.rst
|
| 257 |
+
- docs/guide_cog_creators.rst
|
| 258 |
+
- docs/guide_migration.rst
|
| 259 |
+
- docs/guide_publish_cogs.rst
|
| 260 |
+
"Category: Docs - Install Guides":
|
| 261 |
+
- docs/about_venv.rst
|
| 262 |
+
- docs/autostart_*.rst
|
| 263 |
+
- docs/.resources/bot-guide/**/*
|
| 264 |
+
- docs/bot_application_guide.rst
|
| 265 |
+
- docs/install_guides/**/*
|
| 266 |
+
- docs/update_red.rst
|
| 267 |
+
"Category: Docs - Other":
|
| 268 |
+
- docs/host-list.rst
|
| 269 |
+
- docs/index.rst
|
| 270 |
+
- docs/version_guarantees.rst
|
| 271 |
+
- README.md
|
| 272 |
+
"Category: Docs - User Guides":
|
| 273 |
+
- docs/getting_started.rst
|
| 274 |
+
- docs/intents.rst
|
| 275 |
+
- docs/red_core_data_statement.rst
|
| 276 |
+
# TODO: move these to `docs/.resources/getting_started` subfolder
|
| 277 |
+
- docs/.resources/red-console.png
|
| 278 |
+
- docs/.resources/code-grant.png
|
| 279 |
+
- docs/.resources/instances-ssh-button.png
|
| 280 |
+
- docs/.resources/ssh-output.png
|
| 281 |
+
|
| 282 |
+
|
| 283 |
+
"Category: Meta":
|
| 284 |
+
# top-level files
|
| 285 |
+
- any:
|
| 286 |
+
- '*'
|
| 287 |
+
- '!README.md'
|
| 288 |
+
- '!CHANGES.rst'
|
| 289 |
+
# .gitattributes files
|
| 290 |
+
- '**/.gitattributes'
|
| 291 |
+
# GitHub configuration files, with the exception of CI configuration
|
| 292 |
+
- .github/*
|
| 293 |
+
- .github/ISSUE_TEMPLATE/*
|
| 294 |
+
- .github/PULL_REQUEST_TEMPLATE/*
|
| 295 |
+
# documentation configuration, extensions, scripts, templates, etc.
|
| 296 |
+
- docs/conf.py
|
| 297 |
+
- docs/_ext/**/*
|
| 298 |
+
- docs/_html/**/*
|
| 299 |
+
- docs/make.bat
|
| 300 |
+
- docs/Makefile
|
| 301 |
+
- docs/prolog.txt
|
| 302 |
+
- docs/_templates/**/*
|
| 303 |
+
# empty file
|
| 304 |
+
- redbot/cogs/__init__.py
|
| 305 |
+
# can't go more meta than that :)
|
| 306 |
+
# TODO: remove this useless file
|
| 307 |
+
- redbot/meta.py
|
| 308 |
+
# py.typed file
|
| 309 |
+
- redbot/py.typed
|
| 310 |
+
# requirements files
|
| 311 |
+
- requirements/*
|
| 312 |
+
# schema files
|
| 313 |
+
- schema/*
|
| 314 |
+
# tests configuration, global fixtures, etc.
|
| 315 |
+
- tests/conftest.py
|
| 316 |
+
- tests/__init__.py
|
| 317 |
+
- tests/*/__init__.py
|
| 318 |
+
# repository tools
|
| 319 |
+
- tools/*
|
| 320 |
+
|
| 321 |
+
|
| 322 |
+
# "Category: RPC/ZMQ methods": [] # can't be matched by file patterns
|
| 323 |
+
|
| 324 |
+
|
| 325 |
+
"Category: Vendored Packages":
|
| 326 |
+
- redbot/vendored/**/*
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/crowdin_upload_strings.yml
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Crowdin - Upload strings
|
| 2 |
+
on:
|
| 3 |
+
push:
|
| 4 |
+
branches:
|
| 5 |
+
- V3/develop
|
| 6 |
+
|
| 7 |
+
jobs:
|
| 8 |
+
deploy:
|
| 9 |
+
if: github.repository == 'Cog-Creators/Red-DiscordBot'
|
| 10 |
+
runs-on: ubuntu-latest
|
| 11 |
+
steps:
|
| 12 |
+
- uses: actions/checkout@v3
|
| 13 |
+
- name: Set up Python
|
| 14 |
+
uses: actions/setup-python@v4
|
| 15 |
+
with:
|
| 16 |
+
python-version: '3.8'
|
| 17 |
+
- name: Install dependencies
|
| 18 |
+
run: |
|
| 19 |
+
curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
|
| 20 |
+
echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
|
| 21 |
+
sudo apt-get update -qq
|
| 22 |
+
sudo apt-get install -y crowdin
|
| 23 |
+
pip install redgettext==3.4.2
|
| 24 |
+
- name: Generate source files
|
| 25 |
+
run: |
|
| 26 |
+
make gettext
|
| 27 |
+
- name: Upload source files
|
| 28 |
+
run: |
|
| 29 |
+
make upload_translations
|
| 30 |
+
env:
|
| 31 |
+
CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
|
| 32 |
+
CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/prepare_release.yml
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Prepare Release
|
| 2 |
+
on:
|
| 3 |
+
workflow_dispatch:
|
| 4 |
+
inputs:
|
| 5 |
+
new_stable_version:
|
| 6 |
+
description: Version number for the new stable release (leave empty to just strip `.dev1`)
|
| 7 |
+
required: false
|
| 8 |
+
default: 'auto'
|
| 9 |
+
|
| 10 |
+
permissions:
|
| 11 |
+
contents: write
|
| 12 |
+
pull-requests: write
|
| 13 |
+
|
| 14 |
+
jobs:
|
| 15 |
+
crowdin_download_translations:
|
| 16 |
+
needs: pr_stable_bump
|
| 17 |
+
runs-on: ubuntu-latest
|
| 18 |
+
steps:
|
| 19 |
+
- uses: actions/checkout@v3
|
| 20 |
+
- name: Set up Python
|
| 21 |
+
uses: actions/setup-python@v4
|
| 22 |
+
with:
|
| 23 |
+
python-version: '3.8'
|
| 24 |
+
- name: Install dependencies
|
| 25 |
+
run: |
|
| 26 |
+
curl https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
|
| 27 |
+
echo "deb https://artifacts.crowdin.com/repo/deb/ /" | sudo tee -a /etc/apt/sources.list
|
| 28 |
+
sudo apt-get update -qq
|
| 29 |
+
sudo apt-get install -y crowdin
|
| 30 |
+
pip install redgettext==3.4.2
|
| 31 |
+
|
| 32 |
+
- name: Generate source files
|
| 33 |
+
run: |
|
| 34 |
+
make gettext
|
| 35 |
+
- name: Download translations
|
| 36 |
+
run: |
|
| 37 |
+
make download_translations
|
| 38 |
+
env:
|
| 39 |
+
CROWDIN_API_KEY: ${{ secrets.crowdin_token}}
|
| 40 |
+
CROWDIN_PROJECT_ID: ${{ secrets.crowdin_identifier }}
|
| 41 |
+
|
| 42 |
+
- name: Create Pull Request
|
| 43 |
+
id: cpr_crowdin
|
| 44 |
+
uses: peter-evans/create-pull-request@v4
|
| 45 |
+
with:
|
| 46 |
+
token: ${{ secrets.GITHUB_TOKEN }}
|
| 47 |
+
commit-message: Automated Crowdin downstream
|
| 48 |
+
title: "[i18n] Automated Crowdin downstream"
|
| 49 |
+
body: |
|
| 50 |
+
This is an automated PR that is part of Prepare Release automated workflow (2 out of 2).
|
| 51 |
+
Please ensure that there are no errors or invalid files are in the PR.
|
| 52 |
+
labels: "Automated PR, Category: i18n, Changelog Entry: Skipped"
|
| 53 |
+
branch: "automated/i18n"
|
| 54 |
+
author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
| 55 |
+
milestone: ${{ needs.pr_stable_bump.outputs.milestone_number }}
|
| 56 |
+
|
| 57 |
+
- name: Close and reopen the PR with different token to trigger CI
|
| 58 |
+
uses: actions/github-script@v6
|
| 59 |
+
env:
|
| 60 |
+
PR_NUMBER: ${{ steps.cpr_crowdin.outputs.pull-request-number }}
|
| 61 |
+
PR_OPERATION: ${{ steps.cpr_crowdin.outputs.pull-request-operation }}
|
| 62 |
+
with:
|
| 63 |
+
github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
|
| 64 |
+
script: |
|
| 65 |
+
const script = require(
|
| 66 |
+
`${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
|
| 67 |
+
);
|
| 68 |
+
console.log(script({github, context}));
|
| 69 |
+
|
| 70 |
+
pr_stable_bump:
|
| 71 |
+
runs-on: ubuntu-latest
|
| 72 |
+
outputs:
|
| 73 |
+
milestone_number: ${{ steps.get_milestone_number.outputs.result }}
|
| 74 |
+
steps:
|
| 75 |
+
# Checkout repository and install Python
|
| 76 |
+
- uses: actions/checkout@v3
|
| 77 |
+
- name: Set up Python
|
| 78 |
+
uses: actions/setup-python@v4
|
| 79 |
+
with:
|
| 80 |
+
python-version: '3.8'
|
| 81 |
+
|
| 82 |
+
# Create PR for stable version bump
|
| 83 |
+
- name: Update Red version number from input
|
| 84 |
+
id: bump_version_stable
|
| 85 |
+
run: |
|
| 86 |
+
python .github/workflows/scripts/bump_version.py
|
| 87 |
+
env:
|
| 88 |
+
PYTHONPATH: ${{ github.workspace }}:${{ env.PYTHONPATH }}
|
| 89 |
+
NEW_STABLE_VERSION: ${{ github.event.inputs.new_stable_version }}
|
| 90 |
+
|
| 91 |
+
# Get milestone number of the milestone for the new stable version
|
| 92 |
+
- name: Get milestone number
|
| 93 |
+
id: get_milestone_number
|
| 94 |
+
uses: actions/github-script@v6
|
| 95 |
+
env:
|
| 96 |
+
MILESTONE_TITLE: ${{ steps.bump_version_stable.outputs.new_version }}
|
| 97 |
+
with:
|
| 98 |
+
script: |
|
| 99 |
+
const script = require(
|
| 100 |
+
`${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/get_milestone_number_by_exact_title.js`
|
| 101 |
+
);
|
| 102 |
+
return await script({github, context});
|
| 103 |
+
|
| 104 |
+
- name: Create Pull Request
|
| 105 |
+
id: cpr_bump_stable
|
| 106 |
+
uses: peter-evans/create-pull-request@v4
|
| 107 |
+
with:
|
| 108 |
+
token: ${{ secrets.GITHUB_TOKEN }}
|
| 109 |
+
commit-message: Version bump to ${{ steps.bump_version_stable.outputs.new_version }}
|
| 110 |
+
title: Version bump to ${{ steps.bump_version_stable.outputs.new_version }}
|
| 111 |
+
body: |
|
| 112 |
+
This is an automated PR that is part of Prepare Release automated workflow (1 out of 2).
|
| 113 |
+
Please ensure that there are no errors or invalid files are in the PR.
|
| 114 |
+
labels: "Automated PR, Changelog Entry: Skipped"
|
| 115 |
+
branch: "automated/pr_bumps/${{ steps.bump_version_stable.outputs.new_version }}"
|
| 116 |
+
author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
| 117 |
+
milestone: ${{ steps.get_milestone_number.outputs.result }}
|
| 118 |
+
|
| 119 |
+
- name: Close and reopen the PR with different token to trigger CI
|
| 120 |
+
uses: actions/github-script@v6
|
| 121 |
+
env:
|
| 122 |
+
PR_NUMBER: ${{ steps.cpr_bump_stable.outputs.pull-request-number }}
|
| 123 |
+
PR_OPERATION: ${{ steps.cpr_bump_stable.outputs.pull-request-operation }}
|
| 124 |
+
with:
|
| 125 |
+
github-token: ${{ secrets.cogcreators_bot_repo_scoped }}
|
| 126 |
+
script: |
|
| 127 |
+
const script = require(
|
| 128 |
+
`${process.env.GITHUB_WORKSPACE}/.github/workflows/scripts/close_and_reopen_pr.js`
|
| 129 |
+
);
|
| 130 |
+
console.log(await script({github, context}));
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/run_pip_compile.yaml
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Generate requirements files with pip-compile.
|
| 2 |
+
|
| 3 |
+
on:
|
| 4 |
+
workflow_dispatch:
|
| 5 |
+
|
| 6 |
+
jobs:
|
| 7 |
+
generate_requirements:
|
| 8 |
+
name: Generate requirements files for ${{ matrix.os }} platform.
|
| 9 |
+
runs-on: ${{ matrix.os }}
|
| 10 |
+
strategy:
|
| 11 |
+
matrix:
|
| 12 |
+
os:
|
| 13 |
+
- ubuntu-latest
|
| 14 |
+
- windows-latest
|
| 15 |
+
- macos-latest
|
| 16 |
+
steps:
|
| 17 |
+
- name: Checkout the repository.
|
| 18 |
+
uses: actions/checkout@v3
|
| 19 |
+
|
| 20 |
+
- name: Set up Python 3.8.
|
| 21 |
+
uses: actions/setup-python@v4
|
| 22 |
+
with:
|
| 23 |
+
python-version: '3.8'
|
| 24 |
+
|
| 25 |
+
- name: Install dependencies
|
| 26 |
+
run: |
|
| 27 |
+
python -m pip install -U pip
|
| 28 |
+
python -m pip install -U pip-tools
|
| 29 |
+
|
| 30 |
+
- name: Generate requirements files.
|
| 31 |
+
id: compile_requirements
|
| 32 |
+
run: |
|
| 33 |
+
python .github/workflows/scripts/compile_requirements.py
|
| 34 |
+
|
| 35 |
+
- name: Upload requirements files.
|
| 36 |
+
uses: actions/upload-artifact@v3
|
| 37 |
+
with:
|
| 38 |
+
name: ${{ steps.compile_requirements.outputs.sys_platform }}
|
| 39 |
+
path: requirements/${{ steps.compile_requirements.outputs.sys_platform }}-*.txt
|
| 40 |
+
|
| 41 |
+
merge_requirements:
|
| 42 |
+
name: Merge requirements files.
|
| 43 |
+
needs: generate_requirements
|
| 44 |
+
runs-on: ubuntu-latest
|
| 45 |
+
steps:
|
| 46 |
+
- name: Checkout the repository.
|
| 47 |
+
uses: actions/checkout@v3
|
| 48 |
+
|
| 49 |
+
- name: Set up Python 3.8.
|
| 50 |
+
uses: actions/setup-python@v4
|
| 51 |
+
with:
|
| 52 |
+
python-version: '3.8'
|
| 53 |
+
|
| 54 |
+
- name: Install dependencies
|
| 55 |
+
run: |
|
| 56 |
+
python -m pip install -U "packaging>=22.0"
|
| 57 |
+
|
| 58 |
+
- name: Download Windows requirements.
|
| 59 |
+
uses: actions/download-artifact@v3
|
| 60 |
+
with:
|
| 61 |
+
name: win32
|
| 62 |
+
path: requirements
|
| 63 |
+
- name: Download Linux requirements.
|
| 64 |
+
uses: actions/download-artifact@v3
|
| 65 |
+
with:
|
| 66 |
+
name: linux
|
| 67 |
+
path: requirements
|
| 68 |
+
- name: Download macOS requirements.
|
| 69 |
+
uses: actions/download-artifact@v3
|
| 70 |
+
with:
|
| 71 |
+
name: darwin
|
| 72 |
+
path: requirements
|
| 73 |
+
|
| 74 |
+
- name: Merge requirements files.
|
| 75 |
+
run: |
|
| 76 |
+
python .github/workflows/scripts/merge_requirements.py
|
| 77 |
+
|
| 78 |
+
- name: Upload merged requirements files.
|
| 79 |
+
uses: actions/upload-artifact@v3
|
| 80 |
+
with:
|
| 81 |
+
name: merged
|
| 82 |
+
path: |
|
| 83 |
+
requirements/base.txt
|
| 84 |
+
requirements/extra-*.txt
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/check_label_pattern_exhaustiveness.py
ADDED
|
@@ -0,0 +1,215 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import itertools
|
| 2 |
+
import operator
|
| 3 |
+
import os
|
| 4 |
+
import subprocess
|
| 5 |
+
from pathlib import Path
|
| 6 |
+
from typing import Any, Dict, Iterable, List, Optional
|
| 7 |
+
from typing_extensions import Self
|
| 8 |
+
|
| 9 |
+
import rich
|
| 10 |
+
import yaml
|
| 11 |
+
from rich.console import Console, ConsoleOptions, RenderResult
|
| 12 |
+
from rich.tree import Tree
|
| 13 |
+
from pathspec import PathSpec
|
| 14 |
+
from pathspec.patterns.gitwildmatch import GitWildMatchPattern
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
ROOT_PATH = Path(__file__).resolve().parents[3]
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
class Matcher:
|
| 21 |
+
def __init__(self, *, any: Iterable[str] = (), all: Iterable[str] = ()) -> None:
|
| 22 |
+
self.any_patterns = tuple(any)
|
| 23 |
+
self.any_specs = self._get_pathspecs(self.any_patterns)
|
| 24 |
+
self.all_patterns = tuple(all)
|
| 25 |
+
self.all_specs = self._get_pathspecs(self.all_patterns)
|
| 26 |
+
|
| 27 |
+
def __repr__(self) -> str:
|
| 28 |
+
return f"Matcher(any={self.any_patterns!r}, all={self.all_patterns!r})"
|
| 29 |
+
|
| 30 |
+
def __eq__(self, other: Any) -> bool:
|
| 31 |
+
if isinstance(other, self.__class__):
|
| 32 |
+
return (
|
| 33 |
+
self.any_patterns == other.any_patterns and self.all_patterns == other.all_patterns
|
| 34 |
+
)
|
| 35 |
+
return NotImplemented
|
| 36 |
+
|
| 37 |
+
def __hash__(self) -> int:
|
| 38 |
+
return hash((self.any_patterns, self.all_patterns))
|
| 39 |
+
|
| 40 |
+
@classmethod
|
| 41 |
+
def _get_pathspecs(cls, patterns: Iterable[str]) -> List[PathSpec]:
|
| 42 |
+
return tuple(
|
| 43 |
+
PathSpec.from_lines(GitWildMatchPattern, cls._get_pattern_lines(pattern))
|
| 44 |
+
for pattern in patterns
|
| 45 |
+
)
|
| 46 |
+
|
| 47 |
+
@staticmethod
|
| 48 |
+
def _get_pattern_lines(pattern: str) -> List[str]:
|
| 49 |
+
# an approximation of actions/labeler's minimatch globs
|
| 50 |
+
if pattern.startswith("!"):
|
| 51 |
+
pattern_lines = ["*", f"!/{pattern[1:]}"]
|
| 52 |
+
else:
|
| 53 |
+
pattern_lines = [f"/{pattern}"]
|
| 54 |
+
if pattern.endswith("*") and "**" not in pattern:
|
| 55 |
+
pattern_lines.append(f"!/{pattern}/")
|
| 56 |
+
return pattern_lines
|
| 57 |
+
|
| 58 |
+
@classmethod
|
| 59 |
+
def get_label_matchers(cls) -> Dict[str, List[Self]]:
|
| 60 |
+
with open(ROOT_PATH / ".github/labeler.yml", encoding="utf-8") as fp:
|
| 61 |
+
label_definitions = yaml.safe_load(fp)
|
| 62 |
+
label_matchers: Dict[str, List[Matcher]] = {}
|
| 63 |
+
for label_name, matcher_definitions in label_definitions.items():
|
| 64 |
+
matchers = label_matchers[label_name] = []
|
| 65 |
+
for idx, matcher_data in enumerate(matcher_definitions):
|
| 66 |
+
if isinstance(matcher_data, str):
|
| 67 |
+
matchers.append(cls(any=[matcher_data]))
|
| 68 |
+
elif isinstance(matcher_data, dict):
|
| 69 |
+
matchers.append(
|
| 70 |
+
cls(any=matcher_data.pop("any", []), all=matcher_data.pop("all", []))
|
| 71 |
+
)
|
| 72 |
+
if matcher_data:
|
| 73 |
+
raise RuntimeError(
|
| 74 |
+
f"Unexpected keys at index {idx} for label {label_name!r}: "
|
| 75 |
+
+ ", ".join(map(repr, matcher_data))
|
| 76 |
+
)
|
| 77 |
+
elif matcher_data is not None:
|
| 78 |
+
raise RuntimeError(f"Unexpected type at index {idx} for label {label_name!r}")
|
| 79 |
+
|
| 80 |
+
return label_matchers
|
| 81 |
+
|
| 82 |
+
|
| 83 |
+
class PathNode:
|
| 84 |
+
def __init__(self, parent_tree: Tree, path: Path, *, label: Optional[str] = None) -> None:
|
| 85 |
+
self.parent_tree = parent_tree
|
| 86 |
+
self.path = path
|
| 87 |
+
self.label = label
|
| 88 |
+
|
| 89 |
+
def __rich__(self) -> str:
|
| 90 |
+
if self.label is not None:
|
| 91 |
+
return self.label
|
| 92 |
+
return self.path.name
|
| 93 |
+
|
| 94 |
+
|
| 95 |
+
class DirectoryTree:
|
| 96 |
+
def __init__(self, label: str) -> None:
|
| 97 |
+
self.root = Tree(PathNode(Tree(""), Path(), label=label))
|
| 98 |
+
self._previous = self.root
|
| 99 |
+
|
| 100 |
+
def __bool__(self) -> bool:
|
| 101 |
+
return bool(self.root.children)
|
| 102 |
+
|
| 103 |
+
def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
|
| 104 |
+
yield from self.root.__rich_console__(console, options)
|
| 105 |
+
|
| 106 |
+
def add(self, file: Path) -> Tree:
|
| 107 |
+
common_path = Path(os.path.commonpath([file.parent, self._previous.label.path]))
|
| 108 |
+
|
| 109 |
+
parent_tree = self._previous
|
| 110 |
+
while parent_tree != self.root and parent_tree.label.path != common_path:
|
| 111 |
+
parent_tree = parent_tree.label.parent_tree
|
| 112 |
+
|
| 113 |
+
for part in file.relative_to(common_path).parts:
|
| 114 |
+
if parent_tree.label.path.name == "locales":
|
| 115 |
+
if not parent_tree.children:
|
| 116 |
+
parent_tree.add(PathNode(parent_tree, parent_tree.label.path / "*.po"))
|
| 117 |
+
continue
|
| 118 |
+
parent_tree = parent_tree.add(PathNode(parent_tree, parent_tree.label.path / part))
|
| 119 |
+
|
| 120 |
+
self._previous = parent_tree
|
| 121 |
+
return parent_tree
|
| 122 |
+
|
| 123 |
+
|
| 124 |
+
class App:
|
| 125 |
+
def __init__(self) -> None:
|
| 126 |
+
self.exit_code = 0
|
| 127 |
+
self.label_matchers = Matcher.get_label_matchers()
|
| 128 |
+
self.tracked_files = [
|
| 129 |
+
Path(filename)
|
| 130 |
+
for filename in subprocess.check_output(
|
| 131 |
+
("git", "ls-tree", "-r", "HEAD", "--name-only"), encoding="utf-8", cwd=ROOT_PATH
|
| 132 |
+
).splitlines()
|
| 133 |
+
]
|
| 134 |
+
self.matches_per_label = {label_name: set() for label_name in self.label_matchers}
|
| 135 |
+
self.matches_per_file = []
|
| 136 |
+
self.used_matchers = set()
|
| 137 |
+
|
| 138 |
+
def run(self) -> int:
|
| 139 |
+
old_cwd = os.getcwd()
|
| 140 |
+
try:
|
| 141 |
+
os.chdir(ROOT_PATH)
|
| 142 |
+
self._run()
|
| 143 |
+
finally:
|
| 144 |
+
os.chdir(old_cwd)
|
| 145 |
+
return self.exit_code
|
| 146 |
+
|
| 147 |
+
def _run(self) -> None:
|
| 148 |
+
self._collect_match_information()
|
| 149 |
+
self._show_matches_per_label()
|
| 150 |
+
self._show_files_without_labels()
|
| 151 |
+
self._show_files_with_multiple_labels()
|
| 152 |
+
self._show_unused_matchers()
|
| 153 |
+
|
| 154 |
+
def _collect_match_information(self) -> None:
|
| 155 |
+
tmp_matches_per_file = {file: [] for file in self.tracked_files}
|
| 156 |
+
|
| 157 |
+
for file in self.tracked_files:
|
| 158 |
+
for label_name, matchers in self.label_matchers.items():
|
| 159 |
+
matched = False
|
| 160 |
+
for matcher in matchers:
|
| 161 |
+
if all(
|
| 162 |
+
path_spec.match_file(file)
|
| 163 |
+
for path_spec in itertools.chain(matcher.all_specs, matcher.any_specs)
|
| 164 |
+
):
|
| 165 |
+
self.matches_per_label[label_name].add(file)
|
| 166 |
+
matched = True
|
| 167 |
+
self.used_matchers.add(matcher)
|
| 168 |
+
if matched:
|
| 169 |
+
tmp_matches_per_file[file].append(label_name)
|
| 170 |
+
|
| 171 |
+
self.matches_per_file = sorted(tmp_matches_per_file.items(), key=operator.itemgetter(0))
|
| 172 |
+
|
| 173 |
+
def _show_matches_per_label(self) -> None:
|
| 174 |
+
for label_name, files in self.matches_per_label.items():
|
| 175 |
+
top_tree = DirectoryTree(f"{label_name}:")
|
| 176 |
+
for file in sorted(files):
|
| 177 |
+
top_tree.add(file)
|
| 178 |
+
rich.print(top_tree)
|
| 179 |
+
print()
|
| 180 |
+
|
| 181 |
+
def _show_files_without_labels(self) -> None:
|
| 182 |
+
top_tree = DirectoryTree("\n--- Not matched ---")
|
| 183 |
+
for file, labels in self.matches_per_file:
|
| 184 |
+
if not labels:
|
| 185 |
+
top_tree.add(file)
|
| 186 |
+
if top_tree:
|
| 187 |
+
self.exit_code = 1
|
| 188 |
+
rich.print(top_tree)
|
| 189 |
+
else:
|
| 190 |
+
print("--- All files match at least one label's patterns ---")
|
| 191 |
+
|
| 192 |
+
def _show_files_with_multiple_labels(self) -> None:
|
| 193 |
+
top_tree = DirectoryTree("\n--- Matched by more than one label ---")
|
| 194 |
+
for file, labels in self.matches_per_file:
|
| 195 |
+
if len(labels) > 1:
|
| 196 |
+
tree = top_tree.add(file)
|
| 197 |
+
for label_name in labels:
|
| 198 |
+
tree.add(label_name)
|
| 199 |
+
if top_tree:
|
| 200 |
+
rich.print(top_tree)
|
| 201 |
+
else:
|
| 202 |
+
print("--- None of the files are matched by more than one label's patterns ---")
|
| 203 |
+
|
| 204 |
+
def _show_unused_matchers(self) -> None:
|
| 205 |
+
for label_name, matchers in self.label_matchers.items():
|
| 206 |
+
for idx, matcher in enumerate(matchers):
|
| 207 |
+
if matcher not in self.used_matchers:
|
| 208 |
+
print(
|
| 209 |
+
f"--- Matcher {idx} for label {label_name!r} does not match any files! ---"
|
| 210 |
+
)
|
| 211 |
+
self.exit_code = 1
|
| 212 |
+
|
| 213 |
+
|
| 214 |
+
if __name__ == "__main__":
|
| 215 |
+
raise SystemExit(App().run())
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/get_milestone_number_by_exact_title.js
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
module.exports = (async function ({github, context}) {
|
| 2 |
+
const milestone_title = process.env.MILESTONE_TITLE;
|
| 3 |
+
const [repo_owner, repo_name] = process.env.GITHUB_REPOSITORY.split('/');
|
| 4 |
+
|
| 5 |
+
const {
|
| 6 |
+
repository: {
|
| 7 |
+
milestones: {
|
| 8 |
+
nodes: milestones,
|
| 9 |
+
pageInfo: {hasNextPage}
|
| 10 |
+
}
|
| 11 |
+
}
|
| 12 |
+
} = await github.graphql({
|
| 13 |
+
query: `
|
| 14 |
+
query getMilestoneNumberByTitle(
|
| 15 |
+
$repo_owner: String!
|
| 16 |
+
$repo_name: String!
|
| 17 |
+
$milestone_title: String!
|
| 18 |
+
) {
|
| 19 |
+
repository(owner:$repo_owner name:$repo_name) {
|
| 20 |
+
milestones(query:$milestone_title states:OPEN first:100) {
|
| 21 |
+
nodes {
|
| 22 |
+
number
|
| 23 |
+
title
|
| 24 |
+
}
|
| 25 |
+
pageInfo {
|
| 26 |
+
hasNextPage
|
| 27 |
+
}
|
| 28 |
+
}
|
| 29 |
+
}
|
| 30 |
+
}`,
|
| 31 |
+
repo_owner: repo_owner,
|
| 32 |
+
repo_name: repo_name,
|
| 33 |
+
milestone_title: milestone_title,
|
| 34 |
+
});
|
| 35 |
+
|
| 36 |
+
if (hasNextPage) {
|
| 37 |
+
// this should realistically never happen so let's just error
|
| 38 |
+
core.setFailed('Impossible happened! :)');
|
| 39 |
+
return;
|
| 40 |
+
}
|
| 41 |
+
|
| 42 |
+
for (const milestone of milestones)
|
| 43 |
+
if (milestone.title === milestone_title)
|
| 44 |
+
return milestone.number;
|
| 45 |
+
|
| 46 |
+
// if no exact match is found, assume the milestone doesn't exist
|
| 47 |
+
console.log('The milestone was not found. API returned the array: %o', milestones);
|
| 48 |
+
return null;
|
| 49 |
+
})
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/scripts/merge_requirements.py
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import os
|
| 2 |
+
from pathlib import Path
|
| 3 |
+
from typing import List, TextIO
|
| 4 |
+
|
| 5 |
+
from packaging.markers import Marker
|
| 6 |
+
from packaging.requirements import Requirement
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
REQUIREMENTS_FOLDER = Path(__file__).parents[3].absolute() / "requirements"
|
| 10 |
+
os.chdir(REQUIREMENTS_FOLDER)
|
| 11 |
+
|
| 12 |
+
|
| 13 |
+
class RequirementData:
|
| 14 |
+
def __init__(self, requirement_string: str) -> None:
|
| 15 |
+
self.req = Requirement(requirement_string)
|
| 16 |
+
self.comments = set()
|
| 17 |
+
|
| 18 |
+
@property
|
| 19 |
+
def name(self) -> str:
|
| 20 |
+
return self.req.name
|
| 21 |
+
|
| 22 |
+
@property
|
| 23 |
+
def marker(self) -> Marker:
|
| 24 |
+
return self.req.marker
|
| 25 |
+
|
| 26 |
+
@marker.setter
|
| 27 |
+
def marker(self, value: Marker) -> None:
|
| 28 |
+
self.req.marker = value
|
| 29 |
+
|
| 30 |
+
|
| 31 |
+
def get_requirements(fp: TextIO) -> List[RequirementData]:
|
| 32 |
+
requirements = []
|
| 33 |
+
|
| 34 |
+
current = None
|
| 35 |
+
for line in fp.read().splitlines():
|
| 36 |
+
annotation_prefix = " # "
|
| 37 |
+
if line.startswith(annotation_prefix) and current is not None:
|
| 38 |
+
source = line[len(annotation_prefix) :].strip()
|
| 39 |
+
if source == "via":
|
| 40 |
+
continue
|
| 41 |
+
via_prefix = "via "
|
| 42 |
+
if source.startswith(via_prefix):
|
| 43 |
+
source = source[len(via_prefix) :]
|
| 44 |
+
current.comments.add(source)
|
| 45 |
+
elif line and not line.startswith(("#", " ")):
|
| 46 |
+
current = RequirementData(line)
|
| 47 |
+
requirements.append(current)
|
| 48 |
+
|
| 49 |
+
return requirements
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
names = ["base"]
|
| 53 |
+
names.extend(file.stem for file in REQUIREMENTS_FOLDER.glob("extra-*.in"))
|
| 54 |
+
base_requirements = []
|
| 55 |
+
|
| 56 |
+
for name in names:
|
| 57 |
+
# {req_name: {sys_platform: RequirementData}
|
| 58 |
+
input_data = {}
|
| 59 |
+
all_platforms = set()
|
| 60 |
+
for file in REQUIREMENTS_FOLDER.glob(f"*-{name}.txt"):
|
| 61 |
+
platform_name = file.stem.split("-", maxsplit=1)[0]
|
| 62 |
+
all_platforms.add(platform_name)
|
| 63 |
+
with file.open(encoding="utf-8") as fp:
|
| 64 |
+
requirements = get_requirements(fp)
|
| 65 |
+
|
| 66 |
+
for req in requirements:
|
| 67 |
+
platforms = input_data.setdefault(req.name, {})
|
| 68 |
+
platforms[platform_name] = req
|
| 69 |
+
|
| 70 |
+
output = base_requirements if name == "base" else []
|
| 71 |
+
for req_name, platforms in input_data.items():
|
| 72 |
+
req = next(iter(platforms.values()))
|
| 73 |
+
for other_req in platforms.values():
|
| 74 |
+
if req.req != other_req.req:
|
| 75 |
+
raise RuntimeError(f"Incompatible requirements for {req_name}.")
|
| 76 |
+
|
| 77 |
+
req.comments.update(other_req.comments)
|
| 78 |
+
|
| 79 |
+
base_req = next(
|
| 80 |
+
(base_req for base_req in base_requirements if base_req.name == req.name), None
|
| 81 |
+
)
|
| 82 |
+
if base_req is not None:
|
| 83 |
+
old_base_marker = base_req.marker
|
| 84 |
+
old_req_marker = req.marker
|
| 85 |
+
req.marker = base_req.marker = None
|
| 86 |
+
if base_req.req != req.req:
|
| 87 |
+
raise RuntimeError(f"Incompatible requirements for {req_name}.")
|
| 88 |
+
|
| 89 |
+
base_req.marker = old_base_marker
|
| 90 |
+
req.marker = old_req_marker
|
| 91 |
+
if base_req.marker is None or base_req.marker == req.marker:
|
| 92 |
+
continue
|
| 93 |
+
|
| 94 |
+
if len(platforms) == len(all_platforms):
|
| 95 |
+
output.append(req)
|
| 96 |
+
continue
|
| 97 |
+
elif len(platforms) < len(all_platforms - platforms.keys()):
|
| 98 |
+
platform_marker = " or ".join(
|
| 99 |
+
f"sys_platform == '{platform}'" for platform in platforms
|
| 100 |
+
)
|
| 101 |
+
else:
|
| 102 |
+
platform_marker = " and ".join(
|
| 103 |
+
f"sys_platform != '{platform}'" for platform in all_platforms - platforms.keys()
|
| 104 |
+
)
|
| 105 |
+
|
| 106 |
+
new_marker = (
|
| 107 |
+
f"({req.marker}) and ({platform_marker})"
|
| 108 |
+
if req.marker is not None
|
| 109 |
+
else platform_marker
|
| 110 |
+
)
|
| 111 |
+
req.marker = Marker(new_marker)
|
| 112 |
+
if base_req is not None and base_req.marker == req.marker:
|
| 113 |
+
continue
|
| 114 |
+
|
| 115 |
+
output.append(req)
|
| 116 |
+
|
| 117 |
+
output.sort(key=lambda req: (req.marker is not None, req.name))
|
| 118 |
+
with open(f"{name}.txt", "w+", encoding="utf-8") as fp:
|
| 119 |
+
for req in output:
|
| 120 |
+
fp.write(str(req.req))
|
| 121 |
+
fp.write("\n")
|
| 122 |
+
comments = sorted(req.comments)
|
| 123 |
+
|
| 124 |
+
if len(comments) == 1:
|
| 125 |
+
source = comments[0]
|
| 126 |
+
fp.write(" # via ")
|
| 127 |
+
fp.write(source)
|
| 128 |
+
fp.write("\n")
|
| 129 |
+
else:
|
| 130 |
+
fp.write(" # via\n")
|
| 131 |
+
for source in comments:
|
| 132 |
+
fp.write(" # ")
|
| 133 |
+
fp.write(source)
|
| 134 |
+
fp.write("\n")
|
testbed/Cog-Creators__Red-DiscordBot/.github/workflows/tests.yml
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
name: Tests
|
| 2 |
+
on:
|
| 3 |
+
pull_request:
|
| 4 |
+
push:
|
| 5 |
+
repository_dispatch:
|
| 6 |
+
types:
|
| 7 |
+
- dispatched_test
|
| 8 |
+
|
| 9 |
+
env:
|
| 10 |
+
ref: ${{ github.event.client_payload.ref || '' }}
|
| 11 |
+
|
| 12 |
+
jobs:
|
| 13 |
+
tox:
|
| 14 |
+
runs-on: ubuntu-latest
|
| 15 |
+
strategy:
|
| 16 |
+
matrix:
|
| 17 |
+
python_version:
|
| 18 |
+
- "3.8"
|
| 19 |
+
tox_env:
|
| 20 |
+
- style
|
| 21 |
+
- docs
|
| 22 |
+
include:
|
| 23 |
+
- tox_env: py38
|
| 24 |
+
python_version: "3.8"
|
| 25 |
+
friendly_name: Python 3.8 - Tests
|
| 26 |
+
- tox_env: py39
|
| 27 |
+
python_version: "3.9"
|
| 28 |
+
friendly_name: Python 3.9 - Tests
|
| 29 |
+
- tox_env: py310
|
| 30 |
+
python_version: "3.10"
|
| 31 |
+
friendly_name: Python 3.10 - Tests
|
| 32 |
+
- tox_env: py311
|
| 33 |
+
python_version: "3.11"
|
| 34 |
+
friendly_name: Python 3.11 - Tests
|
| 35 |
+
- tox_env: style
|
| 36 |
+
friendly_name: Style
|
| 37 |
+
- tox_env: docs
|
| 38 |
+
friendly_name: Docs
|
| 39 |
+
fail-fast: false
|
| 40 |
+
name: Tox - ${{ matrix.friendly_name }}
|
| 41 |
+
steps:
|
| 42 |
+
- uses: actions/checkout@v3
|
| 43 |
+
with:
|
| 44 |
+
ref: ${{ env.ref }}
|
| 45 |
+
- name: Set up Python
|
| 46 |
+
uses: actions/setup-python@v4
|
| 47 |
+
with:
|
| 48 |
+
python-version: ${{ matrix.python_version }}
|
| 49 |
+
- name: Install tox
|
| 50 |
+
run: |
|
| 51 |
+
python -m pip install --upgrade pip
|
| 52 |
+
pip install tox
|
| 53 |
+
- name: Tox test
|
| 54 |
+
env:
|
| 55 |
+
TOXENV: ${{ matrix.tox_env }}
|
| 56 |
+
run: tox
|
| 57 |
+
|
| 58 |
+
tox-postgres:
|
| 59 |
+
runs-on: ubuntu-latest
|
| 60 |
+
strategy:
|
| 61 |
+
matrix:
|
| 62 |
+
python_version:
|
| 63 |
+
- "3.8"
|
| 64 |
+
- "3.9"
|
| 65 |
+
- "3.10"
|
| 66 |
+
- "3.11"
|
| 67 |
+
fail-fast: false
|
| 68 |
+
name: Tox - Postgres
|
| 69 |
+
services:
|
| 70 |
+
postgresql:
|
| 71 |
+
image: postgres:10
|
| 72 |
+
ports:
|
| 73 |
+
- 5432:5432
|
| 74 |
+
env:
|
| 75 |
+
POSTGRES_DB: red_db
|
| 76 |
+
POSTGRES_PASSWORD: postgres
|
| 77 |
+
POSTGRES_USER: postgres
|
| 78 |
+
steps:
|
| 79 |
+
- uses: actions/checkout@v3
|
| 80 |
+
with:
|
| 81 |
+
ref: ${{ env.ref }}
|
| 82 |
+
- name: Set up Python
|
| 83 |
+
uses: actions/setup-python@v4
|
| 84 |
+
with:
|
| 85 |
+
python-version: ${{ matrix.python_version }}
|
| 86 |
+
- name: Install tox
|
| 87 |
+
run: |
|
| 88 |
+
python -m pip install --upgrade pip
|
| 89 |
+
pip install tox
|
| 90 |
+
- name: Tox test
|
| 91 |
+
env:
|
| 92 |
+
TOXENV: postgres
|
| 93 |
+
PGDATABASE: red_db
|
| 94 |
+
PGUSER: postgres
|
| 95 |
+
PGPASSWORD: postgres
|
| 96 |
+
PGPORT: 5432
|
| 97 |
+
run: tox
|
| 98 |
+
- name: Verify no errors in PostgreSQL logs.
|
| 99 |
+
run: |
|
| 100 |
+
logs="$(docker logs "${{ job.services.postgresql.id }}" 2>&1)"
|
| 101 |
+
echo "---- PostgreSQL logs ----"
|
| 102 |
+
echo "$logs"
|
| 103 |
+
echo "---- PostgreSQL logs ----"
|
| 104 |
+
error_count="$(echo "$logs" | { grep -c 'ERROR: ' || true; })"
|
| 105 |
+
if [[ $error_count -gt 0 ]]; then
|
| 106 |
+
exit 1
|
| 107 |
+
fi
|
testbed/Cog-Creators__Red-DiscordBot/docs/Makefile
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Minimal makefile for Sphinx documentation
|
| 2 |
+
#
|
| 3 |
+
|
| 4 |
+
# You can set these variables from the command line.
|
| 5 |
+
SPHINXOPTS =
|
| 6 |
+
SPHINXBUILD = python3 -msphinx
|
| 7 |
+
SPHINXPROJ = Red-DiscordBot
|
| 8 |
+
SOURCEDIR = .
|
| 9 |
+
BUILDDIR = _build
|
| 10 |
+
|
| 11 |
+
# Put it first so that "make" without argument is like "make help".
|
| 12 |
+
help:
|
| 13 |
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
| 14 |
+
|
| 15 |
+
.PHONY: help Makefile
|
| 16 |
+
|
| 17 |
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
| 18 |
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
| 19 |
+
%: Makefile
|
| 20 |
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
testbed/Cog-Creators__Red-DiscordBot/docs/_ext/deprecated_removed.py
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"""
|
| 2 |
+
A Sphinx extension adding a ``deprecated-removed`` directive that works
|
| 3 |
+
similarly to CPython's directive with the same name.
|
| 4 |
+
|
| 5 |
+
The key difference is that instead of passing the version of planned removal,
|
| 6 |
+
the writer must provide the minimum amount of days that must pass
|
| 7 |
+
since the date of the release it was deprecated in.
|
| 8 |
+
|
| 9 |
+
Due to lack of a concrete release schedule for Red, this ensures that
|
| 10 |
+
we give enough time to people affected by the changes no matter
|
| 11 |
+
when the releases actually happen.
|
| 12 |
+
|
| 13 |
+
`DeprecatedRemoved` class is heavily based on
|
| 14 |
+
`sphinx.domains.changeset.VersionChange` class that is available at:
|
| 15 |
+
https://github.com/sphinx-doc/sphinx/blob/0949735210abaa05b6448e531984f159403053f4/sphinx/domains/changeset.py
|
| 16 |
+
|
| 17 |
+
Copyright 2007-2020 by the Sphinx team, see AUTHORS:
|
| 18 |
+
https://github.com/sphinx-doc/sphinx/blob/82f495fed386c798735adf675f867b95d61ee0e1/AUTHORS
|
| 19 |
+
|
| 20 |
+
The original copy was distributed under BSD License and this derivative work
|
| 21 |
+
is distributed under GNU GPL Version 3.
|
| 22 |
+
"""
|
| 23 |
+
|
| 24 |
+
import datetime
|
| 25 |
+
import multiprocessing
|
| 26 |
+
import subprocess
|
| 27 |
+
from typing import Any, Dict, List, Optional
|
| 28 |
+
|
| 29 |
+
from docutils import nodes
|
| 30 |
+
from sphinx import addnodes
|
| 31 |
+
from sphinx.application import Sphinx
|
| 32 |
+
from sphinx.util.docutils import SphinxDirective
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
class TagDateCache:
|
| 36 |
+
def __init__(self) -> None:
|
| 37 |
+
self._tags: Dict[str, datetime.date] = {}
|
| 38 |
+
|
| 39 |
+
def _populate_tags(self) -> None:
|
| 40 |
+
with _LOCK:
|
| 41 |
+
if self._tags:
|
| 42 |
+
return
|
| 43 |
+
out = subprocess.check_output(
|
| 44 |
+
("git", "tag", "-l", "--format", "%(creatordate:raw)\t%(refname:short)"),
|
| 45 |
+
text=True,
|
| 46 |
+
)
|
| 47 |
+
lines = out.splitlines(False)
|
| 48 |
+
for line in lines:
|
| 49 |
+
creator_date, tag_name = line.split("\t", maxsplit=1)
|
| 50 |
+
timestamp = int(creator_date.split(" ", maxsplit=1)[0])
|
| 51 |
+
self._tags[tag_name] = datetime.datetime.fromtimestamp(
|
| 52 |
+
timestamp, tz=datetime.timezone.utc
|
| 53 |
+
).date()
|
| 54 |
+
|
| 55 |
+
def get_tag_date(self, tag_name: str) -> Optional[datetime.date]:
|
| 56 |
+
self._populate_tags()
|
| 57 |
+
return self._tags.get(tag_name)
|
| 58 |
+
|
| 59 |
+
|
| 60 |
+
_LOCK = multiprocessing.Manager().Lock()
|
| 61 |
+
_TAGS = TagDateCache()
|
| 62 |
+
|
| 63 |
+
|
| 64 |
+
class DeprecatedRemoved(SphinxDirective):
|
| 65 |
+
has_content = True
|
| 66 |
+
required_arguments = 2
|
| 67 |
+
optional_arguments = 1
|
| 68 |
+
final_argument_whitespace = True
|
| 69 |
+
|
| 70 |
+
def run(self) -> List[nodes.Node]:
|
| 71 |
+
# Some Sphinx stuff
|
| 72 |
+
node = addnodes.versionmodified()
|
| 73 |
+
node.document = self.state.document
|
| 74 |
+
self.set_source_info(node)
|
| 75 |
+
node["type"] = self.name
|
| 76 |
+
node["version"] = tuple(self.arguments)
|
| 77 |
+
if len(self.arguments) == 3:
|
| 78 |
+
inodes, messages = self.state.inline_text(self.arguments[2], self.lineno + 1)
|
| 79 |
+
para = nodes.paragraph(self.arguments[2], "", *inodes, translatable=False)
|
| 80 |
+
self.set_source_info(para)
|
| 81 |
+
node.append(para)
|
| 82 |
+
else:
|
| 83 |
+
messages = []
|
| 84 |
+
|
| 85 |
+
# Text generation
|
| 86 |
+
deprecation_version = self.arguments[0]
|
| 87 |
+
minimum_days = int(self.arguments[1])
|
| 88 |
+
tag_date = _TAGS.get_tag_date(deprecation_version)
|
| 89 |
+
text = (
|
| 90 |
+
f"Will be deprecated in version {deprecation_version},"
|
| 91 |
+
" and removed in the first minor version that gets released"
|
| 92 |
+
f" after {minimum_days} days since deprecation"
|
| 93 |
+
if tag_date is None
|
| 94 |
+
else f"Deprecated since version {deprecation_version},"
|
| 95 |
+
" will be removed in the first minor version that gets released"
|
| 96 |
+
f" after {tag_date + datetime.timedelta(days=minimum_days)}"
|
| 97 |
+
)
|
| 98 |
+
|
| 99 |
+
# More Sphinx stuff
|
| 100 |
+
if self.content:
|
| 101 |
+
self.state.nested_parse(self.content, self.content_offset, node)
|
| 102 |
+
classes = ["versionmodified"]
|
| 103 |
+
if len(node):
|
| 104 |
+
if isinstance(node[0], nodes.paragraph) and node[0].rawsource:
|
| 105 |
+
content = nodes.inline(node[0].rawsource, translatable=True)
|
| 106 |
+
content.source = node[0].source
|
| 107 |
+
content.line = node[0].line
|
| 108 |
+
content += node[0].children
|
| 109 |
+
node[0].replace_self(nodes.paragraph("", "", content, translatable=False))
|
| 110 |
+
|
| 111 |
+
node[0].insert(0, nodes.inline("", f"{text}: ", classes=classes))
|
| 112 |
+
else:
|
| 113 |
+
para = nodes.paragraph(
|
| 114 |
+
"", "", nodes.inline("", f"{text}.", classes=classes), translatable=False
|
| 115 |
+
)
|
| 116 |
+
node.append(para)
|
| 117 |
+
|
| 118 |
+
ret = [node]
|
| 119 |
+
ret += messages
|
| 120 |
+
|
| 121 |
+
return ret
|
| 122 |
+
|
| 123 |
+
|
| 124 |
+
def setup(app: Sphinx) -> Dict[str, Any]:
|
| 125 |
+
app.add_directive("deprecated-removed", DeprecatedRemoved)
|
| 126 |
+
return {
|
| 127 |
+
"version": "1.0",
|
| 128 |
+
"parallel_read_safe": True,
|
| 129 |
+
}
|
testbed/Cog-Creators__Red-DiscordBot/docs/_html/robots.txt
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
User-agent: *
|
| 2 |
+
Disallow: /
|
| 3 |
+
Allow: /en/stable
|
| 4 |
+
Allow: /en/latest
|
| 5 |
+
|
| 6 |
+
Sitemap: https://docs.discord.red/sitemap.xml
|
testbed/Cog-Creators__Red-DiscordBot/docs/_templates/layout.html
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{% extends '!layout.html' %}
|
| 2 |
+
{% block document %}
|
| 3 |
+
{% if version_slug == 'latest' %}
|
| 4 |
+
<div class="admonition warning">
|
| 5 |
+
<p class="first admonition-title">Warning</p>
|
| 6 |
+
<p class="last">
|
| 7 |
+
This document is for Red's development version, which can be significantly different from previous releases.
|
| 8 |
+
If you're a regular user, you should read the <a href="{{ dict(versions)['stable'] }}">Red documentation for the current stable release</a>.
|
| 9 |
+
</p>
|
| 10 |
+
</div>
|
| 11 |
+
{% endif %}
|
| 12 |
+
{{ super() }}
|
| 13 |
+
<a href="https://github.com/Cog-Creators/Red-DiscordBot">
|
| 14 |
+
<img style="position: absolute; top: 0; right: 0; border: 0;"
|
| 15 |
+
src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png?resize=149%2C149"
|
| 16 |
+
class="attachment-full size-full" alt="Fork me on GitHub">
|
| 17 |
+
</a>
|
| 18 |
+
{% endblock %}
|
testbed/Cog-Creators__Red-DiscordBot/docs/about_venv.rst
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _about-venvs:
|
| 2 |
+
|
| 3 |
+
==========================
|
| 4 |
+
About Virtual Environments
|
| 5 |
+
==========================
|
| 6 |
+
Creating a virtual environment is really easy and usually prevents many common installation
|
| 7 |
+
problems.
|
| 8 |
+
|
| 9 |
+
**What Are Virtual Environments For?**
|
| 10 |
+
|
| 11 |
+
Virtual environments allow you to isolate Red's library dependencies, cog dependencies and python
|
| 12 |
+
binaries from the rest of your system. There is no performance overhead to using virtual environment
|
| 13 |
+
and it saves you from a lot of troubles during setup. It also makes sure Red and its dependencies
|
| 14 |
+
are installed to a predictable location which makes uninstalling Red as simple as removing a single folder,
|
| 15 |
+
without worrying about losing your data or other things on your system becoming broken.
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
--------------------------------------------
|
| 19 |
+
Virtual Environments with Multiple Instances
|
| 20 |
+
--------------------------------------------
|
| 21 |
+
If you are running multiple instances of Red on the same machine, you have the option of either
|
| 22 |
+
using the same virtual environment for all of them, or creating separate ones.
|
| 23 |
+
|
| 24 |
+
.. note::
|
| 25 |
+
|
| 26 |
+
This only applies for multiple instances of V3. If you are running a V2 instance as well,
|
| 27 |
+
you **must** use separate virtual environments.
|
| 28 |
+
|
| 29 |
+
The advantages of using a *single* virtual environment for all of your V3 instances are:
|
| 30 |
+
|
| 31 |
+
- 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)
|
| 32 |
+
- It will save space on your hard drive
|
| 33 |
+
|
| 34 |
+
On the other hand, you may wish to update each of your instances individually.
|
| 35 |
+
|
| 36 |
+
.. important::
|
| 37 |
+
|
| 38 |
+
Windows users with multiple instances should create *separate* virtual environments, as
|
| 39 |
+
updating multiple running instances at once is likely to cause errors.
|
testbed/Cog-Creators__Red-DiscordBot/docs/autostart_mac.rst
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. launchd guide
|
| 2 |
+
|
| 3 |
+
==============================
|
| 4 |
+
Setting up auto-restart on Mac
|
| 5 |
+
==============================
|
| 6 |
+
|
| 7 |
+
-----------------------
|
| 8 |
+
Creating the plist file
|
| 9 |
+
-----------------------
|
| 10 |
+
|
| 11 |
+
Start by activating your venv. Then run the following command:
|
| 12 |
+
|
| 13 |
+
.. code-block:: none
|
| 14 |
+
|
| 15 |
+
which python
|
| 16 |
+
|
| 17 |
+
Copy the output of that command.
|
| 18 |
+
|
| 19 |
+
Now run :code:`sudo nano /Library/LaunchDaemons/red.plist`
|
| 20 |
+
|
| 21 |
+
Paste the following and replace the following:
|
| 22 |
+
|
| 23 |
+
- :code:`username` (but not :code:`UserName`) with your Mac username
|
| 24 |
+
- :code:`path` with the path you copied earlier
|
| 25 |
+
- :code:`instance-name` with your instance name:
|
| 26 |
+
|
| 27 |
+
.. code-block:: none
|
| 28 |
+
:emphasize-lines: 9, 13, 28
|
| 29 |
+
|
| 30 |
+
<?xml version="1.0" encoding="UTF-8"?>
|
| 31 |
+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
| 32 |
+
<plist version="1.0">
|
| 33 |
+
<dict>
|
| 34 |
+
<key>Label</key>
|
| 35 |
+
<string>red</string>
|
| 36 |
+
<key>ProgramArguments</key>
|
| 37 |
+
<array>
|
| 38 |
+
<string>path</string>
|
| 39 |
+
<string>-O</string>
|
| 40 |
+
<string>-m</string>
|
| 41 |
+
<string>redbot</string>
|
| 42 |
+
<string>instance-name</string>
|
| 43 |
+
<string>--no-prompt</string>
|
| 44 |
+
</array>
|
| 45 |
+
<key>RunAtLoad</key>
|
| 46 |
+
<true/>
|
| 47 |
+
<key>KeepAlive</key>
|
| 48 |
+
<dict>
|
| 49 |
+
<key>SuccessfulExit</key>
|
| 50 |
+
<false/>
|
| 51 |
+
</dict>
|
| 52 |
+
<key>StandardOutPath</key>
|
| 53 |
+
<string>/tmp/red_out.log</string>
|
| 54 |
+
<key>StandardErrorPath</key>
|
| 55 |
+
<string>/tmp/red_err.log</string>
|
| 56 |
+
<key>UserName</key>
|
| 57 |
+
<string>username</string>
|
| 58 |
+
<key>InitGroups</key>
|
| 59 |
+
<true/>
|
| 60 |
+
</dict>
|
| 61 |
+
</plist>
|
| 62 |
+
|
| 63 |
+
.. note::
|
| 64 |
+
|
| 65 |
+
You may add any additional arguments you need to add to the :code:`redbot` command by
|
| 66 |
+
adding them to the end of the array under :code:`ProgramArguments`
|
| 67 |
+
|
| 68 |
+
.. note::
|
| 69 |
+
|
| 70 |
+
Should you need to set up auto-restart for additional bots, create a :code:`.plist` file for
|
| 71 |
+
each bot under a different file name, and use the respective file names for the commands below.
|
| 72 |
+
|
| 73 |
+
Save and exit :code:`ctrl + O; enter; ctrl + x`
|
| 74 |
+
|
| 75 |
+
-------------------------------
|
| 76 |
+
Starting and loading the plist
|
| 77 |
+
-------------------------------
|
| 78 |
+
|
| 79 |
+
To start the bot and set it to start on boot, you must run the following command:
|
| 80 |
+
|
| 81 |
+
.. prompt:: bash
|
| 82 |
+
|
| 83 |
+
sudo launchctl load -w /Library/LaunchDaemons/red.plist
|
| 84 |
+
|
| 85 |
+
If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
|
| 86 |
+
type the following command in the terminal:
|
| 87 |
+
|
| 88 |
+
.. prompt:: bash
|
| 89 |
+
|
| 90 |
+
sudo launchctl stop red
|
| 91 |
+
|
| 92 |
+
To start the bot again after a shutdown, run the following:
|
| 93 |
+
|
| 94 |
+
.. prompt:: bash
|
| 95 |
+
|
| 96 |
+
sudo launchctl start red
|
| 97 |
+
|
| 98 |
+
To stop the bot and set it to not start on boot anymore, run the following:
|
| 99 |
+
|
| 100 |
+
.. prompt:: bash
|
| 101 |
+
|
| 102 |
+
sudo launchctl unload -w /Library/LaunchDaemons/red.plist
|
| 103 |
+
|
| 104 |
+
To view Red's log, run the following (:code:`red_out.log` is for the console output, and
|
| 105 |
+
:code:`red_err.log` for the error logs):
|
| 106 |
+
|
| 107 |
+
.. prompt:: bash
|
| 108 |
+
|
| 109 |
+
nano /tmp/red_out.log
|
| 110 |
+
nano /tmp/red_err.log
|
testbed/Cog-Creators__Red-DiscordBot/docs/autostart_systemd.rst
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _systemd-service-guide:
|
| 2 |
+
|
| 3 |
+
==============================================
|
| 4 |
+
Setting up auto-restart using systemd on Linux
|
| 5 |
+
==============================================
|
| 6 |
+
|
| 7 |
+
.. note:: This guide is for setting up systemd on a Linux environment. This guide assumes that you already have a working Red instance.
|
| 8 |
+
|
| 9 |
+
-------------------------
|
| 10 |
+
Creating the service file
|
| 11 |
+
-------------------------
|
| 12 |
+
|
| 13 |
+
In order to create the service file, you will first need to know two things, your Linux :code:`username` and your Python :code:`path`
|
| 14 |
+
|
| 15 |
+
First, your Linux :code:`username` can be fetched with the following command:
|
| 16 |
+
|
| 17 |
+
.. prompt:: bash
|
| 18 |
+
|
| 19 |
+
whoami
|
| 20 |
+
|
| 21 |
+
Next, your python :code:`path` can be fetched with the following commands:
|
| 22 |
+
|
| 23 |
+
.. prompt:: bash
|
| 24 |
+
:prompts: $,(redenv) $
|
| 25 |
+
:modifiers: auto
|
| 26 |
+
|
| 27 |
+
# If redbot is installed in a venv
|
| 28 |
+
$ source ~/redenv/bin/activate
|
| 29 |
+
(redenv) $ /usr/bin/which python
|
| 30 |
+
|
| 31 |
+
# If redbot is installed in a pyenv virtualenv
|
| 32 |
+
$ pyenv shell <virtualenv_name>
|
| 33 |
+
(redenv) $ pyenv which python
|
| 34 |
+
|
| 35 |
+
Then create the new service file:
|
| 36 |
+
|
| 37 |
+
:code:`sudo nano /etc/systemd/system/red@.service`
|
| 38 |
+
|
| 39 |
+
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.
|
| 40 |
+
|
| 41 |
+
.. code-block:: none
|
| 42 |
+
:emphasize-lines: 8-10
|
| 43 |
+
|
| 44 |
+
[Unit]
|
| 45 |
+
Description=%I redbot
|
| 46 |
+
After=multi-user.target
|
| 47 |
+
After=network-online.target
|
| 48 |
+
Wants=network-online.target
|
| 49 |
+
|
| 50 |
+
[Service]
|
| 51 |
+
ExecStart=path -O -m redbot %I --no-prompt
|
| 52 |
+
User=username
|
| 53 |
+
Group=username
|
| 54 |
+
Type=idle
|
| 55 |
+
Restart=on-abnormal
|
| 56 |
+
RestartSec=15
|
| 57 |
+
RestartForceExitStatus=1
|
| 58 |
+
RestartForceExitStatus=26
|
| 59 |
+
TimeoutStopSec=10
|
| 60 |
+
|
| 61 |
+
[Install]
|
| 62 |
+
WantedBy=multi-user.target
|
| 63 |
+
|
| 64 |
+
Save and exit :code:`ctrl + O; enter; ctrl + x`
|
| 65 |
+
|
| 66 |
+
---------------------------------
|
| 67 |
+
Starting and enabling the service
|
| 68 |
+
---------------------------------
|
| 69 |
+
|
| 70 |
+
.. 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 **@**
|
| 71 |
+
|
| 72 |
+
To start the bot, run the service and add the instance name after the **@**:
|
| 73 |
+
|
| 74 |
+
.. prompt:: bash
|
| 75 |
+
|
| 76 |
+
sudo systemctl start red@instancename
|
| 77 |
+
|
| 78 |
+
To set the bot to start on boot, you must enable the service, again adding the instance name after the **@**:
|
| 79 |
+
|
| 80 |
+
.. prompt:: bash
|
| 81 |
+
|
| 82 |
+
sudo systemctl enable red@instancename
|
| 83 |
+
|
| 84 |
+
If you need to shutdown the bot, you can use the ``[p]shutdown`` command or
|
| 85 |
+
type the following command in the terminal, still by adding the instance name after the **@**:
|
| 86 |
+
|
| 87 |
+
.. prompt:: bash
|
| 88 |
+
|
| 89 |
+
sudo systemctl stop red@instancename
|
| 90 |
+
|
| 91 |
+
.. warning:: If the service doesn't stop in the next 10 seconds, the process is killed.
|
| 92 |
+
Check your logs to know the cause of the error that prevents the shutdown.
|
| 93 |
+
|
| 94 |
+
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 **@**:
|
| 95 |
+
|
| 96 |
+
.. prompt:: bash
|
| 97 |
+
|
| 98 |
+
sudo systemctl disable red@instancename
|
| 99 |
+
|
| 100 |
+
You can access Red's log through journalctl:
|
| 101 |
+
|
| 102 |
+
.. prompt:: bash
|
| 103 |
+
|
| 104 |
+
sudo journalctl -eu red@instancename
|
testbed/Cog-Creators__Red-DiscordBot/docs/autostart_windows.rst
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _autostart_windows:
|
| 2 |
+
|
| 3 |
+
==============================================
|
| 4 |
+
Setting up auto-restart using batch on Windows
|
| 5 |
+
==============================================
|
| 6 |
+
|
| 7 |
+
.. note:: This guide assumes that you already have a working Red instance.
|
| 8 |
+
|
| 9 |
+
-----------------------
|
| 10 |
+
Creating the batch file
|
| 11 |
+
-----------------------
|
| 12 |
+
|
| 13 |
+
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.
|
| 14 |
+
|
| 15 |
+
Open that document in Notepad, and paste the following text in it:
|
| 16 |
+
|
| 17 |
+
.. code-block:: batch
|
| 18 |
+
|
| 19 |
+
@ECHO OFF
|
| 20 |
+
:RED
|
| 21 |
+
CALL "%userprofile%\redenv\Scripts\activate.bat"
|
| 22 |
+
python -O -m redbot <your instance name>
|
| 23 |
+
|
| 24 |
+
IF %ERRORLEVEL% NEQ 0 (
|
| 25 |
+
ECHO Restarting Red...
|
| 26 |
+
GOTO RED
|
| 27 |
+
)
|
| 28 |
+
|
| 29 |
+
Replace ``<your instance name>`` with the instance name of your bot.
|
| 30 |
+
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.
|
| 31 |
+
|
| 32 |
+
Click "File", "Save as". Change the dropdown "Save as type" to "All Files (*.*)". Set the filename to ``start_redbot.bat``, and click save.
|
| 33 |
+
|
| 34 |
+
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.
|
| 35 |
+
You can now use the ``start_redbot.bat`` batch file to launch Red by double clicking it.
|
| 36 |
+
This script will automatically restart red when the ``[p]restart`` command is used or when the bot shuts down abnormally.
|
| 37 |
+
|
| 38 |
+
-------------------------
|
| 39 |
+
Launch the bot on startup
|
| 40 |
+
-------------------------
|
| 41 |
+
|
| 42 |
+
Create a shortcut of your ``start_redbot.bat`` file.
|
| 43 |
+
|
| 44 |
+
Open the "Run" dialogue box using Windows Key + R.
|
| 45 |
+
|
| 46 |
+
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.
|
| 47 |
+
|
| 48 |
+
Drag the shortcut into the folder that is opened. The bot will now launch on startup.
|
testbed/Cog-Creators__Red-DiscordBot/docs/bot_application_guide.rst
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
===========================================
|
| 2 |
+
Creating a bot account
|
| 3 |
+
===========================================
|
| 4 |
+
|
| 5 |
+
To use Red you will require a bot account and to enable privileged intents. Both these steps will be covered below.
|
| 6 |
+
|
| 7 |
+
.. _creating-a-bot-account:
|
| 8 |
+
|
| 9 |
+
-------------------------------
|
| 10 |
+
Creating the bot application
|
| 11 |
+
-------------------------------
|
| 12 |
+
|
| 13 |
+
In order to use Red, we must first create a Discord Bot account.
|
| 14 |
+
|
| 15 |
+
Creating a Bot account is a pretty straightforward process.
|
| 16 |
+
|
| 17 |
+
1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
|
| 18 |
+
2. Navigate to the `application page <https://discord.com/developers/applications>`_
|
| 19 |
+
3. Click on the "New Application" button.
|
| 20 |
+
|
| 21 |
+
.. image:: /.resources/bot-guide/discord_create_app_button.png
|
| 22 |
+
:alt: The new application button.
|
| 23 |
+
|
| 24 |
+
4. Give the application a name and click "Create".
|
| 25 |
+
|
| 26 |
+
.. image:: /.resources/bot-guide/discord_create_app_form.png
|
| 27 |
+
:alt: The new application form filled in.
|
| 28 |
+
|
| 29 |
+
5. Create a Bot User by navigating to the "Bot" tab and clicking "Add Bot".
|
| 30 |
+
|
| 31 |
+
- Click "Yes, do it!" to continue.
|
| 32 |
+
|
| 33 |
+
.. image:: /.resources/bot-guide/discord_create_bot_user.png
|
| 34 |
+
:alt: The Add Bot button.
|
| 35 |
+
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).
|
| 36 |
+
|
| 37 |
+
- Make sure **Require OAuth2 Code Grant** is unchecked.
|
| 38 |
+
|
| 39 |
+
.. image:: /.resources/bot-guide/discord_bot_user_options.png
|
| 40 |
+
:alt: How the Bot User options should look like for most people.
|
| 41 |
+
|
| 42 |
+
7. Copy the token using the "Copy" button.
|
| 43 |
+
|
| 44 |
+
- **This is not the Client Secret at the General Information page**
|
| 45 |
+
|
| 46 |
+
.. warning::
|
| 47 |
+
|
| 48 |
+
Do not share your token as it is like your password.
|
| 49 |
+
If you shared your token you can regenerate it.
|
| 50 |
+
|
| 51 |
+
Continue to the next section to enable privileged intents.
|
| 52 |
+
|
| 53 |
+
.. _enabling-privileged-intents:
|
| 54 |
+
|
| 55 |
+
-------------------------------
|
| 56 |
+
Enabling Privileged Intents
|
| 57 |
+
-------------------------------
|
| 58 |
+
.. warning::
|
| 59 |
+
:ref:`Red Bot requires all intents. <intents>`
|
| 60 |
+
\This section is required.
|
| 61 |
+
|
| 62 |
+
1. Make sure you're logged on to the `Discord website <https://discord.com>`_.
|
| 63 |
+
2. Navigate to the `application page <https://discord.com/developers/applications>`_
|
| 64 |
+
3. Click on the bot you want to enable privileged intents for.
|
| 65 |
+
4. Navigate to the bot tab on the left side of the screen.
|
| 66 |
+
|
| 67 |
+
.. image:: /.resources/bot-guide/discord_bot_tab.png
|
| 68 |
+
:alt: The bot tab in the application page.
|
| 69 |
+
|
| 70 |
+
5. Scroll down to the "Privileged Gateway Intents" section, enable all three privileged intents and save your changes.
|
| 71 |
+
|
| 72 |
+
.. image:: /.resources/bot-guide/discord_privileged_intents.png
|
| 73 |
+
:alt: The privileged gateway intents selector.
|
| 74 |
+
|
| 75 |
+
.. warning::
|
| 76 |
+
|
| 77 |
+
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.
|
| 78 |
+
Remember that :ref:`we do not support public bots <intents>`. We encourage you to read that page before scaling up your bot.
|
| 79 |
+
|
| 80 |
+
*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>`_.
|
testbed/Cog-Creators__Red-DiscordBot/docs/changelog.rst
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
=========
|
| 2 |
+
Changelog
|
| 3 |
+
=========
|
| 4 |
+
|
| 5 |
+
.. include:: ../CHANGES.rst
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_customcom.rst
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. CustomCommands Cog Reference
|
| 2 |
+
.. _cog_customcom:
|
| 3 |
+
|
| 4 |
+
============================
|
| 5 |
+
CustomCommands Cog Reference
|
| 6 |
+
============================
|
| 7 |
+
|
| 8 |
+
------------
|
| 9 |
+
How it works
|
| 10 |
+
------------
|
| 11 |
+
|
| 12 |
+
CustomCommands allows you to create simple commands for your bot without requiring you to code your own cog for Red.
|
| 13 |
+
|
| 14 |
+
If the command you attempt to create shares a name with an already loaded command, you cannot overwrite it with this cog.
|
| 15 |
+
|
| 16 |
+
---------
|
| 17 |
+
Cooldowns
|
| 18 |
+
---------
|
| 19 |
+
|
| 20 |
+
You can set cooldowns for your custom commands. If a command is on cooldown, it will not be triggered.
|
| 21 |
+
|
| 22 |
+
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.
|
| 23 |
+
|
| 24 |
+
------------------
|
| 25 |
+
Context Parameters
|
| 26 |
+
------------------
|
| 27 |
+
|
| 28 |
+
You can enhance your custom command's response by leaving spaces for the bot to substitute.
|
| 29 |
+
|
| 30 |
+
+-----------+--------------------------------------------------+
|
| 31 |
+
| Argument | Substitute |
|
| 32 |
+
+===========+==================================================+
|
| 33 |
+
| {message} | The message the bot is responding to. |
|
| 34 |
+
+-----------+--------------------------------------------------+
|
| 35 |
+
| {author} | The user who called the command. |
|
| 36 |
+
+-----------+--------------------------------------------------+
|
| 37 |
+
| {channel} | The channel or thread the command was called in. |
|
| 38 |
+
+-----------+--------------------------------------------------+
|
| 39 |
+
| {server} | The server the command was called in. |
|
| 40 |
+
+-----------+--------------------------------------------------+
|
| 41 |
+
| {guild} | Same as with {server}. |
|
| 42 |
+
+-----------+--------------------------------------------------+
|
| 43 |
+
|
| 44 |
+
You can further refine the response with dot notation. For example, {author.mention} will mention the user who called the command.
|
| 45 |
+
|
| 46 |
+
------------------
|
| 47 |
+
Command Parameters
|
| 48 |
+
------------------
|
| 49 |
+
|
| 50 |
+
You can further enhance your custom command's response by leaving spaces for the user to substitute.
|
| 51 |
+
|
| 52 |
+
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.
|
| 53 |
+
|
| 54 |
+
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.
|
| 55 |
+
|
| 56 |
+
+-----------------+--------------------------------+
|
| 57 |
+
| Argument | Substitute |
|
| 58 |
+
+=================+================================+
|
| 59 |
+
| {#:Member} | A member of your server. |
|
| 60 |
+
+-----------------+--------------------------------+
|
| 61 |
+
| {#:TextChannel} | A text channel in your server. |
|
| 62 |
+
+-----------------+--------------------------------+
|
| 63 |
+
| {#:Role} | A role in your server. |
|
| 64 |
+
+-----------------+--------------------------------+
|
| 65 |
+
| {#:int} | A whole number. |
|
| 66 |
+
+-----------------+--------------------------------+
|
| 67 |
+
| {#:float} | A decimal number. |
|
| 68 |
+
+-----------------+--------------------------------+
|
| 69 |
+
| {#:bool} | True or False. |
|
| 70 |
+
+-----------------+--------------------------------+
|
| 71 |
+
|
| 72 |
+
You can specify more than the above with colon notation, but those are the most common.
|
| 73 |
+
|
| 74 |
+
As with context parameters, you can use dot notation to further refine the response. For example, {0.mention:Member} will mention the Member specified.
|
| 75 |
+
|
| 76 |
+
----------------
|
| 77 |
+
Example commands
|
| 78 |
+
----------------
|
| 79 |
+
|
| 80 |
+
Showing your own avatar
|
| 81 |
+
|
| 82 |
+
.. code-block:: none
|
| 83 |
+
|
| 84 |
+
[p]customcom add simple avatar {author.display_avatar}
|
| 85 |
+
[p]avatar
|
| 86 |
+
https://cdn.discordapp.com/avatars/133801473317404673/be4c4a4fe47cb3e74c31a0504e7a295e.webp?size=1024
|
| 87 |
+
|
| 88 |
+
Repeating the user
|
| 89 |
+
|
| 90 |
+
.. code-block:: none
|
| 91 |
+
|
| 92 |
+
[p]customcom add simple say {0}
|
| 93 |
+
[p]say Pete and Repeat
|
| 94 |
+
Pete and Repeat
|
| 95 |
+
|
| 96 |
+
Greeting the specified member
|
| 97 |
+
|
| 98 |
+
.. code-block:: none
|
| 99 |
+
|
| 100 |
+
[p]customcom add simple greet Hello, {0.mention:Member}!
|
| 101 |
+
[p]greet Twentysix
|
| 102 |
+
Hello, @Twentysix!
|
| 103 |
+
|
| 104 |
+
Comparing two text channel's categories
|
| 105 |
+
|
| 106 |
+
.. code-block:: none
|
| 107 |
+
|
| 108 |
+
[p]customcom add simple comparecategory {0.category:TextChannel} | {1.category:TextChannel}
|
| 109 |
+
[p]comparecategory #support #general
|
| 110 |
+
Red | Community
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/admin.rst
ADDED
|
@@ -0,0 +1,454 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _admin:
|
| 2 |
+
|
| 3 |
+
=====
|
| 4 |
+
Admin
|
| 5 |
+
=====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the admin cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load admin
|
| 15 |
+
|
| 16 |
+
.. _admin-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog will provide tools for server admins and bot owners.
|
| 23 |
+
|
| 24 |
+
It can add or remove a role to a member, edit one or make some available
|
| 25 |
+
for members so they can self-assign them as they wish.
|
| 26 |
+
|
| 27 |
+
It also provides tools for the bot owner such as server locking (once enabled,
|
| 28 |
+
the bot will instantly leave new servers it joins) and announcements, which
|
| 29 |
+
can send something in all the servers of the bot.
|
| 30 |
+
|
| 31 |
+
.. _admin-commands:
|
| 32 |
+
|
| 33 |
+
--------
|
| 34 |
+
Commands
|
| 35 |
+
--------
|
| 36 |
+
|
| 37 |
+
Here's a list of all commands available for this cog.
|
| 38 |
+
|
| 39 |
+
.. _admin-command-selfrole:
|
| 40 |
+
|
| 41 |
+
^^^^^^^^
|
| 42 |
+
selfrole
|
| 43 |
+
^^^^^^^^
|
| 44 |
+
|
| 45 |
+
**Syntax**
|
| 46 |
+
|
| 47 |
+
.. code-block:: none
|
| 48 |
+
|
| 49 |
+
[p]selfrole <selfrole>
|
| 50 |
+
|
| 51 |
+
**Description**
|
| 52 |
+
|
| 53 |
+
Add or remove a role from yourself. It must have been configured as user settable
|
| 54 |
+
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
| 55 |
+
|
| 56 |
+
**Arguments**
|
| 57 |
+
|
| 58 |
+
* ``<selfrole>``: The role you want to attribute or remove from yourself. |role-input|
|
| 59 |
+
|
| 60 |
+
.. _admin-command-selfrole-add:
|
| 61 |
+
|
| 62 |
+
""""""""""""
|
| 63 |
+
selfrole add
|
| 64 |
+
""""""""""""
|
| 65 |
+
|
| 66 |
+
**Syntax**
|
| 67 |
+
|
| 68 |
+
.. code-block:: none
|
| 69 |
+
|
| 70 |
+
[p]selfrole add <selfrole>
|
| 71 |
+
|
| 72 |
+
**Description**
|
| 73 |
+
|
| 74 |
+
Add a role to yourself. It must have been configured as user settable
|
| 75 |
+
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
| 76 |
+
|
| 77 |
+
**Arguments**
|
| 78 |
+
|
| 79 |
+
* ``<selfrole>``: The role you want to attribute to yourself. |role-input|
|
| 80 |
+
|
| 81 |
+
.. _admin-command-selfrole-remove:
|
| 82 |
+
|
| 83 |
+
"""""""""""""""
|
| 84 |
+
selfrole remove
|
| 85 |
+
"""""""""""""""
|
| 86 |
+
|
| 87 |
+
**Syntax**
|
| 88 |
+
|
| 89 |
+
.. code-block:: none
|
| 90 |
+
|
| 91 |
+
[p]selfrole remove <selfrole>
|
| 92 |
+
|
| 93 |
+
**Description**
|
| 94 |
+
|
| 95 |
+
Remove a role from yourself. It must have been configured as user settable
|
| 96 |
+
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
| 97 |
+
|
| 98 |
+
**Arguments**
|
| 99 |
+
|
| 100 |
+
* ``<selfrole>``: The role you want to remove from yourself. |role-input|
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
.. _admin-command-selfrole-list:
|
| 104 |
+
|
| 105 |
+
"""""""""""""
|
| 106 |
+
selfrole list
|
| 107 |
+
"""""""""""""
|
| 108 |
+
|
| 109 |
+
**Syntax**
|
| 110 |
+
|
| 111 |
+
.. code-block:: none
|
| 112 |
+
|
| 113 |
+
[p]selfrole list
|
| 114 |
+
|
| 115 |
+
**Description**
|
| 116 |
+
|
| 117 |
+
List all of the available roles you can assign to yourself.
|
| 118 |
+
|
| 119 |
+
.. _admin-command-selfroleset:
|
| 120 |
+
|
| 121 |
+
^^^^^^^^^^^
|
| 122 |
+
selfroleset
|
| 123 |
+
^^^^^^^^^^^
|
| 124 |
+
|
| 125 |
+
.. note:: |admin-lock| This is also usable by the members with the
|
| 126 |
+
``Manage roles`` permission.
|
| 127 |
+
|
| 128 |
+
**Syntax**
|
| 129 |
+
|
| 130 |
+
.. code-block:: none
|
| 131 |
+
|
| 132 |
+
[p]selfroleset
|
| 133 |
+
|
| 134 |
+
**Description**
|
| 135 |
+
|
| 136 |
+
Define the list of user settable roles. Those roles will be available to any
|
| 137 |
+
member using the :ref:`selfrole command <admin-command-selfrole>`.
|
| 138 |
+
|
| 139 |
+
.. _admin-command-selfroleset-add:
|
| 140 |
+
|
| 141 |
+
"""""""""""""""
|
| 142 |
+
selfroleset add
|
| 143 |
+
"""""""""""""""
|
| 144 |
+
|
| 145 |
+
**Syntax**
|
| 146 |
+
|
| 147 |
+
.. code-block:: none
|
| 148 |
+
|
| 149 |
+
[p]selfroleset add <role>
|
| 150 |
+
|
| 151 |
+
**Description**
|
| 152 |
+
|
| 153 |
+
Add a role, or a selection of roles, to the list of available selfroles.
|
| 154 |
+
|
| 155 |
+
.. warning:: Members will be able to assign themselves the role.
|
| 156 |
+
Make sure it doesn't give extra perms or anything that can break
|
| 157 |
+
your server's security.
|
| 158 |
+
|
| 159 |
+
**Arguments**
|
| 160 |
+
|
| 161 |
+
* ``<role>``: The role to add to the list. |role-input|
|
| 162 |
+
|
| 163 |
+
.. _admin-command-selfroleset-clear:
|
| 164 |
+
|
| 165 |
+
"""""""""""""""""
|
| 166 |
+
selfroleset clear
|
| 167 |
+
"""""""""""""""""
|
| 168 |
+
|
| 169 |
+
**Syntax**
|
| 170 |
+
|
| 171 |
+
.. code-block:: none
|
| 172 |
+
|
| 173 |
+
[p]selfroleset clear
|
| 174 |
+
|
| 175 |
+
**Description**
|
| 176 |
+
|
| 177 |
+
Clear the list of available selfroles for this server.
|
| 178 |
+
|
| 179 |
+
.. _admin-command-selfroleset-remove:
|
| 180 |
+
|
| 181 |
+
""""""""""""""""""
|
| 182 |
+
selfroleset remove
|
| 183 |
+
""""""""""""""""""
|
| 184 |
+
|
| 185 |
+
**Syntax**
|
| 186 |
+
|
| 187 |
+
.. code-block:: none
|
| 188 |
+
|
| 189 |
+
[p]selfroleset remove <role>
|
| 190 |
+
|
| 191 |
+
**Description**
|
| 192 |
+
|
| 193 |
+
Remove a role, or a selection of roles, from the list of available selfroles.
|
| 194 |
+
|
| 195 |
+
**Arguments**
|
| 196 |
+
|
| 197 |
+
* ``<role>``: The role to remove from the list. |role-input|
|
| 198 |
+
|
| 199 |
+
.. _admin-command-addrole:
|
| 200 |
+
|
| 201 |
+
^^^^^^^
|
| 202 |
+
addrole
|
| 203 |
+
^^^^^^^
|
| 204 |
+
|
| 205 |
+
.. note:: |admin-lock| This is also usable by the members with the ``Manage
|
| 206 |
+
roles`` permission.
|
| 207 |
+
|
| 208 |
+
**Syntax**
|
| 209 |
+
|
| 210 |
+
.. code-block:: none
|
| 211 |
+
|
| 212 |
+
[p]addrole <rolename> [user]
|
| 213 |
+
|
| 214 |
+
**Description**
|
| 215 |
+
|
| 216 |
+
Adds a role to a member. If ``user`` is not given, it will be considered
|
| 217 |
+
as yourself, the command author.
|
| 218 |
+
|
| 219 |
+
**Arguments**
|
| 220 |
+
|
| 221 |
+
* ``<role>``: The role to add to the member. |role-input-quotes|
|
| 222 |
+
|
| 223 |
+
* ``[user]``: The member you want to add the role to. Defaults to the
|
| 224 |
+
command author. |member-input|
|
| 225 |
+
|
| 226 |
+
.. _admin-command-removerole:
|
| 227 |
+
|
| 228 |
+
^^^^^^^^^^
|
| 229 |
+
removerole
|
| 230 |
+
^^^^^^^^^^
|
| 231 |
+
|
| 232 |
+
.. note:: |admin-lock| This is also usable by the members with the
|
| 233 |
+
``Manage roles`` permission.
|
| 234 |
+
|
| 235 |
+
**Syntax**
|
| 236 |
+
|
| 237 |
+
.. code-block:: none
|
| 238 |
+
|
| 239 |
+
[p]removerole <rolename> [user]
|
| 240 |
+
|
| 241 |
+
**Description**
|
| 242 |
+
|
| 243 |
+
Removes a role from a member. If ``user`` is not given, it will be considered
|
| 244 |
+
as yourself, the command author.
|
| 245 |
+
|
| 246 |
+
**Arguments**
|
| 247 |
+
|
| 248 |
+
* ``<role>``: The role to remove. |role-input-quotes|
|
| 249 |
+
|
| 250 |
+
* ``[user]``: The member to remove the role from. |member-input| Defaults
|
| 251 |
+
to the command author.
|
| 252 |
+
|
| 253 |
+
.. _admin-command-editrole:
|
| 254 |
+
|
| 255 |
+
^^^^^^^^
|
| 256 |
+
editrole
|
| 257 |
+
^^^^^^^^
|
| 258 |
+
|
| 259 |
+
.. note:: |admin-lock|
|
| 260 |
+
|
| 261 |
+
**Syntax**
|
| 262 |
+
|
| 263 |
+
.. code-block:: none
|
| 264 |
+
|
| 265 |
+
[p]editrole
|
| 266 |
+
|
| 267 |
+
**Description**
|
| 268 |
+
|
| 269 |
+
Edits the settings of a role.
|
| 270 |
+
|
| 271 |
+
.. _admin-command-editrole-name:
|
| 272 |
+
|
| 273 |
+
"""""""""""""
|
| 274 |
+
editrole name
|
| 275 |
+
"""""""""""""
|
| 276 |
+
|
| 277 |
+
**Syntax**
|
| 278 |
+
|
| 279 |
+
.. code-block:: none
|
| 280 |
+
|
| 281 |
+
[p]editrole name <role> <name>
|
| 282 |
+
|
| 283 |
+
**Description**
|
| 284 |
+
|
| 285 |
+
Edits the name of a role.
|
| 286 |
+
|
| 287 |
+
**Arguments**
|
| 288 |
+
|
| 289 |
+
* ``<role>``: The role name to edit. |role-input-quotes|
|
| 290 |
+
|
| 291 |
+
* ``<name>``: The new role name. If it has spaces, you must use quotes.
|
| 292 |
+
|
| 293 |
+
.. _admin-command-editrole-color:
|
| 294 |
+
|
| 295 |
+
""""""""""""""
|
| 296 |
+
editrole color
|
| 297 |
+
""""""""""""""
|
| 298 |
+
|
| 299 |
+
**Syntax**
|
| 300 |
+
|
| 301 |
+
.. code-block:: none
|
| 302 |
+
|
| 303 |
+
[p]editrole color <role> <color>
|
| 304 |
+
|
| 305 |
+
**Description**
|
| 306 |
+
|
| 307 |
+
Edits the color of a role.
|
| 308 |
+
|
| 309 |
+
**Arguments**
|
| 310 |
+
|
| 311 |
+
* ``<role>``: The role name to edit. |role-input-quotes|
|
| 312 |
+
|
| 313 |
+
* ``<color>``: The new color to assign. |color-input|
|
| 314 |
+
|
| 315 |
+
**Examples**
|
| 316 |
+
|
| 317 |
+
* ``[p]editrole color "My role" #ff0000``
|
| 318 |
+
|
| 319 |
+
* ``[p]editrole color "My role" dark_blue``
|
| 320 |
+
|
| 321 |
+
.. _admin-command-announce:
|
| 322 |
+
|
| 323 |
+
^^^^^^^^
|
| 324 |
+
announce
|
| 325 |
+
^^^^^^^^
|
| 326 |
+
|
| 327 |
+
.. note:: |owner-lock|
|
| 328 |
+
|
| 329 |
+
**Syntax**
|
| 330 |
+
|
| 331 |
+
.. code-block:: none
|
| 332 |
+
|
| 333 |
+
[p]announce <message>
|
| 334 |
+
|
| 335 |
+
**Description**
|
| 336 |
+
|
| 337 |
+
Announce your message to all of the servers the bot is in.
|
| 338 |
+
|
| 339 |
+
The bot will announce the message in the guild's announcements channel.
|
| 340 |
+
If this channel is not set, the message won't be announced.
|
| 341 |
+
|
| 342 |
+
**Arguments**
|
| 343 |
+
|
| 344 |
+
* ``<message>``: The message to send.
|
| 345 |
+
|
| 346 |
+
.. _admin-command-announce-cancel:
|
| 347 |
+
|
| 348 |
+
"""""""""""""""
|
| 349 |
+
announce cancel
|
| 350 |
+
"""""""""""""""
|
| 351 |
+
|
| 352 |
+
.. note:: |owner-lock|
|
| 353 |
+
|
| 354 |
+
**Syntax**
|
| 355 |
+
|
| 356 |
+
.. code-block:: none
|
| 357 |
+
|
| 358 |
+
[p]announce cancel
|
| 359 |
+
|
| 360 |
+
**Description**
|
| 361 |
+
|
| 362 |
+
Cancels an active announcement.
|
| 363 |
+
|
| 364 |
+
.. _admin-command-announceset:
|
| 365 |
+
|
| 366 |
+
^^^^^^^^^^^
|
| 367 |
+
announceset
|
| 368 |
+
^^^^^^^^^^^
|
| 369 |
+
|
| 370 |
+
.. note:: |guildowner-lock|
|
| 371 |
+
|
| 372 |
+
**Syntax**
|
| 373 |
+
|
| 374 |
+
.. code-block:: none
|
| 375 |
+
|
| 376 |
+
[p]announceset
|
| 377 |
+
|
| 378 |
+
**Description**
|
| 379 |
+
|
| 380 |
+
Change how announcements are received in this guild.
|
| 381 |
+
|
| 382 |
+
.. _admin-command-announceset-channel:
|
| 383 |
+
|
| 384 |
+
"""""""""""""""""""
|
| 385 |
+
announceset channel
|
| 386 |
+
"""""""""""""""""""
|
| 387 |
+
|
| 388 |
+
**Syntax**
|
| 389 |
+
|
| 390 |
+
.. code-block:: none
|
| 391 |
+
|
| 392 |
+
[p]announceset channel <channel>
|
| 393 |
+
|
| 394 |
+
**Description**
|
| 395 |
+
|
| 396 |
+
Sets the channel where the bot owner announcements will be sent.
|
| 397 |
+
|
| 398 |
+
**Arguments**
|
| 399 |
+
|
| 400 |
+
* ``<channel>``: The channel that will be used for bot announcements.
|
| 401 |
+
|channel-input|
|
| 402 |
+
|
| 403 |
+
.. _admin-command-announceset-clearchannel:
|
| 404 |
+
|
| 405 |
+
""""""""""""""""""""""""
|
| 406 |
+
announceset clearchannel
|
| 407 |
+
""""""""""""""""""""""""
|
| 408 |
+
|
| 409 |
+
**Syntax**
|
| 410 |
+
|
| 411 |
+
.. code-block:: none
|
| 412 |
+
|
| 413 |
+
[p]announceset clearchannel
|
| 414 |
+
|
| 415 |
+
**Description**
|
| 416 |
+
|
| 417 |
+
Disables announcements on your server. To enable them again, you will have to
|
| 418 |
+
re-enter your announcements channel with the :ref:`announceset channel
|
| 419 |
+
<admin-command-announceset-channel>` command.
|
| 420 |
+
|
| 421 |
+
.. _admin-command-serverlock:
|
| 422 |
+
|
| 423 |
+
^^^^^^^^^^
|
| 424 |
+
serverlock
|
| 425 |
+
^^^^^^^^^^
|
| 426 |
+
|
| 427 |
+
.. note:: |owner-lock| This is also usable by the members with the
|
| 428 |
+
``Administrator`` permission.
|
| 429 |
+
|
| 430 |
+
**Syntax**
|
| 431 |
+
|
| 432 |
+
.. code-block:: none
|
| 433 |
+
|
| 434 |
+
[p]serverlock
|
| 435 |
+
|
| 436 |
+
**Description**
|
| 437 |
+
|
| 438 |
+
Lock a bot to its current servers only.
|
| 439 |
+
|
| 440 |
+
This means that, once you enable this, if someone invites the bot to a new
|
| 441 |
+
server, the bot will automatically leave the server.
|
| 442 |
+
|
| 443 |
+
.. tip:: Another way to prevent your bot from being invited on more servers is
|
| 444 |
+
making it private directly from the developer portal.
|
| 445 |
+
|
| 446 |
+
Once a bot is private, it can only be invited by its owner (or team
|
| 447 |
+
owners). Other users will get an error on Discord's webpage explaining that
|
| 448 |
+
the bot is private.
|
| 449 |
+
|
| 450 |
+
To do this, go to the `Discord developer portal
|
| 451 |
+
<https://discord.com/developers>`_, select your application, click "Bot" in
|
| 452 |
+
the sidebar, then untick "Public bot".
|
| 453 |
+
|
| 454 |
+
.. image:: ../.resources/admin/public_bot.png
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/alias.rst
ADDED
|
@@ -0,0 +1,277 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _alias:
|
| 2 |
+
|
| 3 |
+
=====
|
| 4 |
+
Alias
|
| 5 |
+
=====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the alias cog. You will
|
| 8 |
+
find detailed docs about the usage and the commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load alias
|
| 15 |
+
|
| 16 |
+
.. _alias-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog is used to create shortcuts for commands.
|
| 23 |
+
|
| 24 |
+
Here's an example:
|
| 25 |
+
|
| 26 |
+
.. code-block:: python
|
| 27 |
+
|
| 28 |
+
[p]play
|
| 29 |
+
# with an alias, you can call the command above with a shortcut like this:
|
| 30 |
+
[p]p
|
| 31 |
+
# "p" is now a shortcut for "play"
|
| 32 |
+
|
| 33 |
+
In this example, we made an alias named ``p`` that will
|
| 34 |
+
invoke the ``play`` command. If you use ``[p]play`` or ``[p]p``, the result will
|
| 35 |
+
be the same.
|
| 36 |
+
|
| 37 |
+
----
|
| 38 |
+
|
| 39 |
+
Here's another example
|
| 40 |
+
|
| 41 |
+
.. code-block:: python
|
| 42 |
+
|
| 43 |
+
[p]cleanup messages
|
| 44 |
+
# now we're creating another alias that will group both the command and the subcommand into this:
|
| 45 |
+
[p]clear
|
| 46 |
+
# "clear" is now a shortcut for "cleanup messages"
|
| 47 |
+
|
| 48 |
+
In this second example, we made an alias called ``clear`` that will
|
| 49 |
+
invoke the ``cleanup messages`` subcommand. Now if you use ``[p]cleanup
|
| 50 |
+
message`` or ``[p]clear``, the result will be the same.
|
| 51 |
+
|
| 52 |
+
----
|
| 53 |
+
|
| 54 |
+
This is the basic usage, where you can define an alias for the first part of
|
| 55 |
+
the command and give the second part when invoking the command. A more advanced
|
| 56 |
+
usage of aliases is the usage of arguments.
|
| 57 |
+
|
| 58 |
+
Let's suppose you want to make an alias to ban someone, delete 7 days of
|
| 59 |
+
messages and set the reason to "Spam bot.", that cannot be done with a classic
|
| 60 |
+
alias since the required member argument is the first one. If you create the
|
| 61 |
+
alias "spamban" using arguments like this ``ban {0} 7 Spam bot.``, ``{0}`` will
|
| 62 |
+
be replaced by the first argument of your alias:
|
| 63 |
+
|
| 64 |
+
.. code-block:: none
|
| 65 |
+
|
| 66 |
+
# we created the following alias named "spamban"
|
| 67 |
+
[p]spamban Slime#3160
|
| 68 |
+
# this alias will execute the following command:
|
| 69 |
+
[p]ban Slime#3160 7 Spam bot.
|
| 70 |
+
|
| 71 |
+
For a more detailed explanation, read :ref:`this <alias-command-alias-add>`.
|
| 72 |
+
|
| 73 |
+
.. _alias-commands:
|
| 74 |
+
|
| 75 |
+
--------
|
| 76 |
+
Commands
|
| 77 |
+
--------
|
| 78 |
+
|
| 79 |
+
.. _alias-command-alias:
|
| 80 |
+
|
| 81 |
+
^^^^^
|
| 82 |
+
alias
|
| 83 |
+
^^^^^
|
| 84 |
+
|
| 85 |
+
**Syntax**
|
| 86 |
+
|
| 87 |
+
.. code-block:: none
|
| 88 |
+
|
| 89 |
+
[p]alias
|
| 90 |
+
|
| 91 |
+
**Description**
|
| 92 |
+
|
| 93 |
+
This is the main command used for setting up the cog.
|
| 94 |
+
It will be used for all other commands.
|
| 95 |
+
|
| 96 |
+
.. _alias-command-alias-add:
|
| 97 |
+
|
| 98 |
+
"""""""""
|
| 99 |
+
alias add
|
| 100 |
+
"""""""""
|
| 101 |
+
|
| 102 |
+
.. note:: |mod-lock|
|
| 103 |
+
|
| 104 |
+
**Syntax**
|
| 105 |
+
|
| 106 |
+
.. code-block:: none
|
| 107 |
+
|
| 108 |
+
[p]alias add <alias_name> <command>
|
| 109 |
+
|
| 110 |
+
**Description**
|
| 111 |
+
|
| 112 |
+
Creates an alias. It will be used like this ``[p]alias_name <arguments>``
|
| 113 |
+
and will be equal to this ``[p]command <arguments>``.
|
| 114 |
+
|
| 115 |
+
Let's develop the examples given :ref:`earlier <alias-usage>` a bit more,
|
| 116 |
+
the left part of the command is the alias (blue), and the right part is the
|
| 117 |
+
parameters members have to give for the command (orange).
|
| 118 |
+
|
| 119 |
+
.. image:: ../.resources/alias/example-1.png
|
| 120 |
+
|
| 121 |
+
One more thing you can do with aliases is using arguments, a bit like
|
| 122 |
+
CustomCommands. Let's suppose you want an alias that bans x member and deletes
|
| 123 |
+
7 days of messages. Without aliases, the command would look like this:
|
| 124 |
+
|
| 125 |
+
``[p]ban NotSoTrustyJAID#0001 7 My random reason``
|
| 126 |
+
|
| 127 |
+
A classic alias wouldn't work because the member argument is the first one,
|
| 128 |
+
and you can only shorten the left part before the required argument.
|
| 129 |
+
|
| 130 |
+
An alias with arguments can fix that, you can define the alias on the whole
|
| 131 |
+
command and replace the required argument by ``{0}``, which will be replaced
|
| 132 |
+
by the first parameter given when invoking the alias.
|
| 133 |
+
|
| 134 |
+
Back to our example, let's make an alias named ``bigban`` which will be
|
| 135 |
+
assigned to this expression: ``ban {0} 7``
|
| 136 |
+
|
| 137 |
+
.. image:: ../.resources/alias/example-2.png
|
| 138 |
+
|
| 139 |
+
You can see in blue the "static" part of the alias, what is contained and
|
| 140 |
+
doesn't need to be given, the orange part is the arguments given at the end of
|
| 141 |
+
the command, just like a classic alias, and the green part is the positional
|
| 142 |
+
argument we defined: the first argument of the alias will be the green part.
|
| 143 |
+
|
| 144 |
+
You can add as many arguments as you want, they can start at ``{0}`` or ``{1}``
|
| 145 |
+
and must be in order: ``{1}`` will be the first argument, ``{2}`` will be the
|
| 146 |
+
second one...
|
| 147 |
+
|
| 148 |
+
.. attention:: The numbers must be in order, you cannot use ``{0}`` and ``{2}``
|
| 149 |
+
without using ``{1}``.
|
| 150 |
+
|
| 151 |
+
Here are more examples:
|
| 152 |
+
|
| 153 |
+
* * Full command: ``[p]cleanup messages 75 True``
|
| 154 |
+
* Alias: ``[p]alias add fullclear cleanup messages {0} True``
|
| 155 |
+
* Invoked alias: ``[p]fullclear 75``
|
| 156 |
+
|
| 157 |
+
*The* ``True`` *at the end tells the bot to also clear pinned messages.*
|
| 158 |
+
|
| 159 |
+
* * Full command: ``[p]repo add SinbadCogs
|
| 160 |
+
https://github.com/mikeshardmind/SinbadCogs v3``
|
| 161 |
+
|
| 162 |
+
* Alias: ``[p]alias add newrepo repo add {2} https://github.com/{1}/{2}``
|
| 163 |
+
* Invoked with alias: ``[p]newrepo mikeshardmind SinbadCogs v3``
|
| 164 |
+
|
| 165 |
+
**Arguments**
|
| 166 |
+
|
| 167 |
+
* ``<alias_name>``: The new command name.
|
| 168 |
+
|
| 169 |
+
* ``<command>``: The command to execute when ``[p]alias_name`` is invoked.
|
| 170 |
+
|
| 171 |
+
.. _alias-command-alias-delete:
|
| 172 |
+
|
| 173 |
+
""""""""""""
|
| 174 |
+
alias delete
|
| 175 |
+
""""""""""""
|
| 176 |
+
|
| 177 |
+
.. note:: |mod-lock|
|
| 178 |
+
|
| 179 |
+
**Syntax**
|
| 180 |
+
|
| 181 |
+
.. code-block:: none
|
| 182 |
+
|
| 183 |
+
[p]alias [delete|remove|del] <alias_name>
|
| 184 |
+
|
| 185 |
+
**Description**
|
| 186 |
+
|
| 187 |
+
Removes an alias from the list. Check the list with
|
| 188 |
+
the :ref:`alias list <alias-command-alias-list>` command.
|
| 189 |
+
|
| 190 |
+
**Arguments**
|
| 191 |
+
|
| 192 |
+
* ``<alias_name>``: The alias' name to delete.
|
| 193 |
+
|
| 194 |
+
.. _alias-command-alias-list:
|
| 195 |
+
|
| 196 |
+
""""""""""
|
| 197 |
+
alias list
|
| 198 |
+
""""""""""
|
| 199 |
+
|
| 200 |
+
**Syntax**
|
| 201 |
+
|
| 202 |
+
.. code-block:: none
|
| 203 |
+
|
| 204 |
+
[p]alias list
|
| 205 |
+
|
| 206 |
+
**Description**
|
| 207 |
+
|
| 208 |
+
Shows all of the existing aliases on the current server.
|
| 209 |
+
|
| 210 |
+
.. _alias-command-alias-show:
|
| 211 |
+
|
| 212 |
+
""""""""""
|
| 213 |
+
alias show
|
| 214 |
+
""""""""""
|
| 215 |
+
|
| 216 |
+
**Syntax**
|
| 217 |
+
|
| 218 |
+
.. code-block:: none
|
| 219 |
+
|
| 220 |
+
[p]alias show <alias_name>
|
| 221 |
+
|
| 222 |
+
**Description**
|
| 223 |
+
|
| 224 |
+
Shows the command associated to the alias.
|
| 225 |
+
|
| 226 |
+
**Arguments**
|
| 227 |
+
|
| 228 |
+
* ``<alias_name>``: The alias you want information from.
|
| 229 |
+
|
| 230 |
+
.. _alias-command-alias-help:
|
| 231 |
+
|
| 232 |
+
""""""""""
|
| 233 |
+
alias help
|
| 234 |
+
""""""""""
|
| 235 |
+
|
| 236 |
+
**Syntax**
|
| 237 |
+
|
| 238 |
+
.. code-block:: none
|
| 239 |
+
|
| 240 |
+
[p]alias help <alias_name>
|
| 241 |
+
|
| 242 |
+
**Description**
|
| 243 |
+
|
| 244 |
+
Shows help message for an alias.
|
| 245 |
+
|
| 246 |
+
**Arguments**
|
| 247 |
+
|
| 248 |
+
* ``<alias_name>``: Alias you want to get help from.
|
| 249 |
+
|
| 250 |
+
.. _alias-command-alias-global:
|
| 251 |
+
|
| 252 |
+
""""""""""""
|
| 253 |
+
alias global
|
| 254 |
+
""""""""""""
|
| 255 |
+
|
| 256 |
+
.. note:: |owner-lock|
|
| 257 |
+
|
| 258 |
+
**Syntax**
|
| 259 |
+
|
| 260 |
+
.. code-block:: none
|
| 261 |
+
|
| 262 |
+
[p]alias global
|
| 263 |
+
|
| 264 |
+
**Description**
|
| 265 |
+
|
| 266 |
+
Another group command which contains the :ref:`add
|
| 267 |
+
<alias-command-alias-add>`, :ref:`del
|
| 268 |
+
<alias-command-alias-delete>` and :ref:`list
|
| 269 |
+
<alias-command-alias-list>` commands.
|
| 270 |
+
|
| 271 |
+
They work the same, except the created aliases will be
|
| 272 |
+
global instead of being only server-wide.
|
| 273 |
+
|
| 274 |
+
Please refer to these docs for the commands, they work with the
|
| 275 |
+
same arguments. For example, if you want to add a global alias,
|
| 276 |
+
instead of doing ``[p]alias add <arguments>``, do ``[p]alias
|
| 277 |
+
global add <arguments>``.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/audio.rst
ADDED
|
@@ -0,0 +1,3764 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _audio:
|
| 2 |
+
|
| 3 |
+
=====
|
| 4 |
+
Audio
|
| 5 |
+
=====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the audio cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load audio
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
You can see additional help for any command in this guide by using ``[p]help`` with the
|
| 18 |
+
command name, like ``[p]help playlist append``.
|
| 19 |
+
|
| 20 |
+
In this guide, you will see references to "Lavalink" or the "Lavalink.jar". `Lavalink <https://github.com/freyacodes/Lavalink/>`_ is the
|
| 21 |
+
Java-based audio backend we use to be able to play music through the bot. Most users will
|
| 22 |
+
not have to worry much about Lavalink or what it is, as Audio manages this process for you
|
| 23 |
+
by default. Advanced users can read more about Lavalink and special cases under the
|
| 24 |
+
:ref:`Lavalink - Red Community-Supported Advanced Usage<advanced-usage>` section below.
|
| 25 |
+
|
| 26 |
+
You will also see references to ``managed`` or ``unmanaged`` in regards to the Lavalink.jar.
|
| 27 |
+
The default is ``managed``, as Audio manages the Lavalink.jar in this state. If it is run as an
|
| 28 |
+
``unmanaged`` process, this means you as the bot owner will be managing the Lavalink process yourself.
|
| 29 |
+
|
| 30 |
+
When the Audio cog is first loaded, it will contact GitHub and download the newest Lavalink.jar file
|
| 31 |
+
for your bot to use. Any time Red is updated and you update your bot, it will probably download a new,
|
| 32 |
+
updated Lavalink.jar for your bot. It is important to keep your bot updated as fixes are provided for Lavalink frequently.
|
| 33 |
+
|
| 34 |
+
.. warning::
|
| 35 |
+
|
| 36 |
+
All commands should be used in a Discord server, and not in Direct Messages as Audio is not available there.
|
| 37 |
+
|
| 38 |
+
.. _basic-audio-use:
|
| 39 |
+
|
| 40 |
+
----------------
|
| 41 |
+
Basic Audio Use
|
| 42 |
+
----------------
|
| 43 |
+
|
| 44 |
+
The following commands are used for controlling the audio being played, such as starting, stopping, and altering volume.
|
| 45 |
+
|
| 46 |
+
* ``[p]play`` - Play a single song or a playlist URL or use this command with words to search for a song.
|
| 47 |
+
* ``[p]search`` - Search for a track on YouTube. Searching on Soundcloud can be done with ``[p]search sc`` and the keywords to search for.
|
| 48 |
+
* ``[p]stop`` - Stops playback and clears the queue.
|
| 49 |
+
* ``[p]pause`` - This is a toggle. Use ``[p]pause`` again to resume the music.
|
| 50 |
+
* ``[p]prev`` - Stops playback of the current song and returns to the start of the previous song played.
|
| 51 |
+
* ``[p]skip`` - Skip to the next song in the queue, if there is one.
|
| 52 |
+
* ``[p]seek`` - Seek ahead to a specific track time, or seek ahead by seconds.
|
| 53 |
+
* ``[p]now`` - Show what song is currently playing.
|
| 54 |
+
* ``[p]volume`` - Set the volume from 0% to 150%. 100% is the default. Discord server owners can set a limit to the volume with ``[p]audioset maxvolume``.
|
| 55 |
+
|
| 56 |
+
.. note::
|
| 57 |
+
|
| 58 |
+
The following services are currently supported through ``[p]play``:
|
| 59 |
+
|
| 60 |
+
* Bandcamp
|
| 61 |
+
* HTTPS Icecast Streams
|
| 62 |
+
* HTTPS Shoutcast Streams
|
| 63 |
+
* Local file playback (:ref:`see here<local-tracks>`)
|
| 64 |
+
* SoundCloud
|
| 65 |
+
* Spotify links via YouTube (:ref:`see here<spotify-playback-and-api-keys>`)
|
| 66 |
+
* Twitch
|
| 67 |
+
* Vimeo
|
| 68 |
+
* YouTube
|
| 69 |
+
* Other AAC, MP3, or OGG-encoded streams
|
| 70 |
+
|
| 71 |
+
.. note::
|
| 72 |
+
|
| 73 |
+
``[p]audioset restrict`` is a toggle that only allows commercial site (YouTube, Soundcloud, etc) playback by default.
|
| 74 |
+
When toggled off, users will be able to play songs from HTTPS streams or arbitrary sites, but this could be a
|
| 75 |
+
security issue as your bot's IP address will be sent to any site it's connecting to, per standard internet protocol.
|
| 76 |
+
|
| 77 |
+
.. _faq:
|
| 78 |
+
|
| 79 |
+
--------------------------
|
| 80 |
+
Frequently Asked Questions
|
| 81 |
+
--------------------------
|
| 82 |
+
|
| 83 |
+
**Q: I used a playlist link with some of the playlist related commands and it tells me that it can't find it.
|
| 84 |
+
How can I use this playlist link with playlist commands in audio?**
|
| 85 |
+
|
| 86 |
+
Audio uses Red playlists in its commands that take playlist arguments.
|
| 87 |
+
These playlists can be created and modified using the ``[p]playlist`` group command.
|
| 88 |
+
When a playlist or song(s) are saved as a Red playlist, it is assigned an ID automatically,
|
| 89 |
+
and it is also assigned the one-word name you provided it when creating the playlist.
|
| 90 |
+
Either one of these identifiers can be used with playlist-related commands.
|
| 91 |
+
|
| 92 |
+
.. tip::
|
| 93 |
+
|
| 94 |
+
If you have a playlist URL, use ``[p]playlist save <url>`` to save it as a Playlist
|
| 95 |
+
with Audio.
|
| 96 |
+
|
| 97 |
+
**Q: How do I turn off autoplay?**
|
| 98 |
+
|
| 99 |
+
Use the ``[p]audioset autoplay toggle`` command.
|
| 100 |
+
|
| 101 |
+
**Q: How do I get the bot to disconnect from the channel when it's done playing?**
|
| 102 |
+
|
| 103 |
+
``[p]audioset dc`` will make the bot auto-disconnect when playback completes and the
|
| 104 |
+
queue is empty.
|
| 105 |
+
``[p]audioset emptydisconnect`` with a seconds argument greater than 0 will make the bot
|
| 106 |
+
auto-disconnect once it's alone in the channel, after the amount of seconds given to the
|
| 107 |
+
command. This setting takes precedence over ``[p]audioset dc`` if both settings are active.
|
| 108 |
+
|
| 109 |
+
**Q: How do I use localtracks?**
|
| 110 |
+
|
| 111 |
+
See the :ref:`local tracks section<local-tracks>`.
|
| 112 |
+
|
| 113 |
+
**Q: My console is saying that "Port 2333 is already in use". How can I fix this?**
|
| 114 |
+
|
| 115 |
+
If you are trying to run multiple bots with Audio, you should follow our guide on
|
| 116 |
+
:ref:`setting up Audio for multiple bots<multibots>`. Otherwise, another process is using the
|
| 117 |
+
port, so you need to figure out what is using port 2333 and terminate/disconnect it yourself.
|
| 118 |
+
|
| 119 |
+
**Q: My terminal is saying that I "must install Java 11 for Lavalink to run". How can I fix this?**
|
| 120 |
+
|
| 121 |
+
You are getting this error because you have a different version of Java installed, or you don't have
|
| 122 |
+
Java installed at all. As the error states, Java 11 is required, and can be installed from
|
| 123 |
+
`here <https://adoptium.net/temurin/releases/?version=11>`__.
|
| 124 |
+
|
| 125 |
+
If you have Java 11 installed, and are still getting this error, you will have to manually tell Audio where your Java install is located.
|
| 126 |
+
Use ``[p]llset java <path_to_java_11_executable>``, to make Audio launch Lavalink with a
|
| 127 |
+
specific Java binary. To do this, you will need to locate your ``java.exe``/``java`` file
|
| 128 |
+
in your **Java 11 install**.
|
| 129 |
+
|
| 130 |
+
Alternatively, update your PATH settings so that Java 11 is the one used by ``java``. However,
|
| 131 |
+
you should confirm that nothing other than Red is running on the machine that requires Java.
|
| 132 |
+
|
| 133 |
+
.. _queue_commands:
|
| 134 |
+
|
| 135 |
+
----------------------
|
| 136 |
+
Queue Related Commands
|
| 137 |
+
----------------------
|
| 138 |
+
|
| 139 |
+
* ``[p]queue`` - Shows the queue of playing songs and current settings for the server for shuffle and repeat.
|
| 140 |
+
* ``[p]remove`` - Remove a song from the queue. This command uses the track position in the queue for identification, e.g. ``[p]remove 10`` will remove
|
| 141 |
+
the 10th song in the queue.
|
| 142 |
+
* ``[p]shuffle`` - Toggle random song playback from the queue.
|
| 143 |
+
* ``[p]queue shuffle`` - Shuffles the queue.
|
| 144 |
+
* ``[p]repeat`` - Toggle adding songs back into the queue when they are finished playing.
|
| 145 |
+
* ``[p]playlist queue`` - Save the current queue to a Red playlist.
|
| 146 |
+
* ``[p]audioset persistqueue`` - Can be used to reinstate existing queues when the bot is restarted. This is an owner-only command.
|
| 147 |
+
* ``[p]audioset globaldailyqueue`` - Will toggle saving the day's worth of tracks to a Global-level Red playlist, for every day. This is an owner-only command.
|
| 148 |
+
|
| 149 |
+
.. _playlist_commands:
|
| 150 |
+
|
| 151 |
+
-----------------
|
| 152 |
+
Playlist Commands
|
| 153 |
+
-----------------
|
| 154 |
+
|
| 155 |
+
Playlists can be saved locally on the bot in a variety of different scopes:
|
| 156 |
+
|
| 157 |
+
* Global - The playlist will be available on all servers.
|
| 158 |
+
* Guild (default scope) - The playlist will be available only in a specified guild.
|
| 159 |
+
* User - The playlist will be available in any guild that the user shares with the bot.
|
| 160 |
+
|
| 161 |
+
Some of the most relevant playlist commands include:
|
| 162 |
+
|
| 163 |
+
* ``[p]playlist append`` - Add a track URL, playlist link, or quick search to a playlist.
|
| 164 |
+
* ``[p]playlist create`` - Creates an empty playlist.
|
| 165 |
+
* ``[p]playlist delete`` - Delete a saved playlist.
|
| 166 |
+
* ``[p]playlist info`` - Retrieve information about a saved playlist.
|
| 167 |
+
* ``[p]playlist list`` - List saved playlists.
|
| 168 |
+
* ``[p]playlist queue`` - Save the currently playing queue to a playlist.
|
| 169 |
+
* ``[p]playlist remove`` - Remove a track from a playlist by URL.
|
| 170 |
+
|
| 171 |
+
As always, you can run ``[p]help playlist <command>`` for more information.
|
| 172 |
+
|
| 173 |
+
.. _owner-audioset-commands:
|
| 174 |
+
|
| 175 |
+
----------------------------
|
| 176 |
+
Owner-Only Audioset Commands
|
| 177 |
+
----------------------------
|
| 178 |
+
|
| 179 |
+
* ``[p]audioset cache`` - This sets the local metadata caching level for Audio. By default, this is set to on as it helps
|
| 180 |
+
reduce 429 Forbidden errors from song services, and also caches Spotify song lookups. Most users will not need to touch this option.
|
| 181 |
+
* ``[p]audioset cacheage`` - How long the entries in the cache last. By default, song metadata is cached for 365 days (1 year).
|
| 182 |
+
* ``[p]audioset status`` - Show the now playing song in the bot's status, or show how many servers the bot is playing music on, if more than one.
|
| 183 |
+
* ``[p]audioset restrictions global`` - Manage the keyword blocklist/allowlist for the whole bot.
|
| 184 |
+
|
| 185 |
+
.. _guild-audioset-commands:
|
| 186 |
+
|
| 187 |
+
-----------------------------
|
| 188 |
+
Guild-based Audioset Commands
|
| 189 |
+
-----------------------------
|
| 190 |
+
|
| 191 |
+
* ``[p]audioset notify`` - Toggle extra messages: Audio will display a notification message when a track starts,
|
| 192 |
+
showing the song title, artist, and the thumbnail (if enabled and present). This notify message follows the last
|
| 193 |
+
invoking Audio command - if an Audio command is used in one channel and this setting is on, the notify messages
|
| 194 |
+
will start to appear in the channel where the command was used. If another Audio command is used in another
|
| 195 |
+
channel, notify messages will start appearing in the second channel instead of the first command channel.
|
| 196 |
+
* ``[p]audioset maxvolume`` - Set the max volume for the guild.
|
| 197 |
+
* ``[p]audioset autodeafen`` - Toggle the bot being auto-deafened upon voice channel join.
|
| 198 |
+
* ``[p]audioset restrictions`` - Manage the keyword blocklist/allowlist for the guild.
|
| 199 |
+
* ``[p]audioset lyrics`` - Searching for tracks will prefer songs with 'lyrics' in the name, to avoid videos with long story intros or outros.
|
| 200 |
+
|
| 201 |
+
.. _spotify-playback-and-api-keys:
|
| 202 |
+
|
| 203 |
+
------------------------------
|
| 204 |
+
Spotify Playback and API Keys
|
| 205 |
+
------------------------------
|
| 206 |
+
|
| 207 |
+
We will never be able to play directly from Spotify itself as it is against their Terms of Service. Audio can play
|
| 208 |
+
single tracks or playlists from Spotify by looking up the song(s) on YouTube and playing those tracks instead.
|
| 209 |
+
This is possible by providing your bot with a YouTube API key and a Spotify API key. Instructions for setting both
|
| 210 |
+
can be found under ``[p]audioset youtubeapi`` and ``[p]audioset spotifyapi``.
|
| 211 |
+
|
| 212 |
+
The YouTube API keys that are being given out currently only have 10000 units of quota per day, which is equivalent to
|
| 213 |
+
100 Spotify song lookups. There is a local metadata cache that Audio uses to be able to retain information about song
|
| 214 |
+
lookups. For example, with a 500 song Spotify playlist, the bot will be able to fetch the first 100 songs the
|
| 215 |
+
first day the Spotify playlist URL is used with Audio, then the next day it will be able to use the first 100 lookups
|
| 216 |
+
from the local cache, and use the API credits to look up the next 100 songs. After 5 days of playing the Spotify playlist
|
| 217 |
+
through Audio, that playlist will be fully cached locally until the cached entries are set to expire and will not require
|
| 218 |
+
any API credits to play songs.
|
| 219 |
+
|
| 220 |
+
The following commands are relevant:
|
| 221 |
+
|
| 222 |
+
* ``[p]genre`` - Lets users pick a Spotify music genre to queue music from.
|
| 223 |
+
* ``[p]audioset countrycode`` - Lets guild owners specify what country code to prefer for Spotify searches, for the guild.
|
| 224 |
+
* ``[p]audioset mycountrycode`` - Lets individual users pick what country code to prefer for Spotify searches of their own.
|
| 225 |
+
|
| 226 |
+
.. _local-tracks:
|
| 227 |
+
|
| 228 |
+
------------
|
| 229 |
+
Local Tracks
|
| 230 |
+
------------
|
| 231 |
+
|
| 232 |
+
Audio can play music from a ``localtracks`` folder on the device where the bot is hosted. This feature is only available
|
| 233 |
+
if your bot and your Lavalink.jar are on the same host, which is the default setup.
|
| 234 |
+
|
| 235 |
+
To use this feature:
|
| 236 |
+
|
| 237 |
+
1. Create a "localtracks" folder anywhere where Lavalink/your bot user has permissions to access, on the system.
|
| 238 |
+
2. Use ``[p]audioset localpath <localtracks path>`` to set the folder created above as the localtracks folder.
|
| 239 |
+
3. Create/move/copy/symlink your album folders (Subfolders containing your tracks) to the folder created in Step 1.
|
| 240 |
+
4. Put any of Audio's supported files in the following folders:
|
| 241 |
+
|
| 242 |
+
* ``localtracks/<parent folder>/song.mp3``
|
| 243 |
+
* ``localtracks/<parent folder>/<child folder>/song.mp3``
|
| 244 |
+
|
| 245 |
+
When using this localtracks feature, use ``[p]local`` commands. Use ``[p]play <parent folder>/song.mp3`` to play
|
| 246 |
+
single songs. Use ``[p]local folder <parent folder>/<child folder>`` to play the entire folder.
|
| 247 |
+
|
| 248 |
+
The following formats are supported:
|
| 249 |
+
|
| 250 |
+
* MP3
|
| 251 |
+
* FLAC
|
| 252 |
+
* Matroska/WebM (AAC, Opus or Vorbis codecs)
|
| 253 |
+
* MP4/M4A (AAC codec)
|
| 254 |
+
* OGG streams (Opus, Vorbis and FLAC codecs)
|
| 255 |
+
* AAC streams
|
| 256 |
+
|
| 257 |
+
The following files are partially supported:
|
| 258 |
+
|
| 259 |
+
* .ra
|
| 260 |
+
* .wav
|
| 261 |
+
* .opus
|
| 262 |
+
* .wma
|
| 263 |
+
* .ts
|
| 264 |
+
* .au
|
| 265 |
+
* .mov
|
| 266 |
+
* .flv
|
| 267 |
+
* .mkv
|
| 268 |
+
* .wmv
|
| 269 |
+
* .3gp
|
| 270 |
+
* .m4v
|
| 271 |
+
* .mk3d
|
| 272 |
+
* .mka
|
| 273 |
+
* .mks
|
| 274 |
+
|
| 275 |
+
The following files are **NOT** supported:
|
| 276 |
+
|
| 277 |
+
* .mid
|
| 278 |
+
* .mka
|
| 279 |
+
* .amr
|
| 280 |
+
* .aiff
|
| 281 |
+
* .ac3
|
| 282 |
+
* .voc
|
| 283 |
+
* .dsf
|
| 284 |
+
* .vob
|
| 285 |
+
* .mts
|
| 286 |
+
* .avi
|
| 287 |
+
* .mpg
|
| 288 |
+
* .mpeg
|
| 289 |
+
* .swf
|
| 290 |
+
|
| 291 |
+
.. _dj-role-and-voteskip:
|
| 292 |
+
|
| 293 |
+
--------------------
|
| 294 |
+
DJ Role and Voteskip
|
| 295 |
+
--------------------
|
| 296 |
+
|
| 297 |
+
Audio has an internal permissions system for restrictions to audio commands while other people are listening to
|
| 298 |
+
music with the bot. Bot owners, server admins and mods bypass these restrictions when they are in use.
|
| 299 |
+
|
| 300 |
+
``[p]audioset dj`` will turn on the DJ role restriction system, ``[p]audioset role`` will let you choose or
|
| 301 |
+
reassign the DJ role, and if you wish to make non-privileged users vote to skip songs, voteskip can be enabled
|
| 302 |
+
with ``[p]audioset vote``.
|
| 303 |
+
|
| 304 |
+
If a non-privileged user is listening to music alone in the channel, they can use commands without restrictions,
|
| 305 |
+
even if DJ role or voteskip settings are active.
|
| 306 |
+
|
| 307 |
+
.. _sound-quality-issues:
|
| 308 |
+
|
| 309 |
+
--------------------
|
| 310 |
+
Sound Quality Issues
|
| 311 |
+
--------------------
|
| 312 |
+
|
| 313 |
+
Laggy audio is most likely caused by:
|
| 314 |
+
|
| 315 |
+
* A problem with the connection between the machine that is hosting Lavalink and the Discord voice server.
|
| 316 |
+
* Issues with Discord.
|
| 317 |
+
|
| 318 |
+
You can try the following to resolve poor sound quality:
|
| 319 |
+
|
| 320 |
+
* Don't host on home internet, especially over a WiFi connection. Try hosting your bot elsewhere.
|
| 321 |
+
* Try the web browser instead of the desktop client for listening.
|
| 322 |
+
* Simply wait, as audio quality may improve in due course.
|
| 323 |
+
* Restart your bot.
|
| 324 |
+
* Check to make sure it's not just a bad quality song (try a different song).
|
| 325 |
+
* Try to listen on a different Discord server or server region.
|
| 326 |
+
* If not everyone is experiencing the issue, it's a Discord client issue.
|
| 327 |
+
|
| 328 |
+
.. _no-sound:
|
| 329 |
+
|
| 330 |
+
^^^^^^^^
|
| 331 |
+
No Sound
|
| 332 |
+
^^^^^^^^
|
| 333 |
+
|
| 334 |
+
If the bot's speaking light is active, but there is no sound, troubleshoot the following:
|
| 335 |
+
|
| 336 |
+
1. Is the bot's user volume turned up? (right click on the bot in Discord, see the slider).
|
| 337 |
+
2. Is the bot muted or deafened? Are you deafened? Are you deaf?
|
| 338 |
+
3. Check Discord audio device settings and volume (cog icon next to your username in the bottom left, click "Voice and Video").
|
| 339 |
+
4. Try dragging and dropping the bot back to the voice channel.
|
| 340 |
+
5. Check system audio device settings and volume.
|
| 341 |
+
6. Ask another member to come into the voice channel to confirm that it's not just you.
|
| 342 |
+
|
| 343 |
+
If the track progress is stuck on 00:00 when you run ``[p]now``:
|
| 344 |
+
|
| 345 |
+
1. Try to run ``[p]disconnect`` and replay the song.
|
| 346 |
+
2. Try to reload the audio cog with ``[p]audioset restart``.
|
| 347 |
+
3. Make sure the firewall on the host is configured properly.
|
| 348 |
+
|
| 349 |
+
.. _advanced-usage:
|
| 350 |
+
|
| 351 |
+
-------------------------------------------------
|
| 352 |
+
Lavalink - Red Community-Supported Advanced Usage
|
| 353 |
+
-------------------------------------------------
|
| 354 |
+
|
| 355 |
+
.. _multibots:
|
| 356 |
+
|
| 357 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 358 |
+
Setting up Multiple Red Instances with Audio on the Same Host
|
| 359 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 360 |
+
|
| 361 |
+
.. warning::
|
| 362 |
+
|
| 363 |
+
This section provides instructions for setting up an unmanaged Lavalink node that is on the same machine
|
| 364 |
+
as the Red bot(s) that need to connect to it. This configuration is supported by the Red community, so
|
| 365 |
+
if you need additional help, feel free to join the `Red Support Server <https://discord.gg/red>`__ and ask in the #support channel.
|
| 366 |
+
|
| 367 |
+
If you are looking to set up a remote, unmanaged Lavalink node on a different vps or host than the Red
|
| 368 |
+
bot(s) that will connect to it, we provide basic instructions in this guide :ref:`here<remote-lavalink>`, but that
|
| 369 |
+
configuration is partially unsupported as we do not provide help with network configuration or system
|
| 370 |
+
administration. You will be responsible for configuring your network, firewall, and other system
|
| 371 |
+
properties to enable playback and for the bot to connect to the remote unmanaged Lavalink server.
|
| 372 |
+
|
| 373 |
+
If you are wanting to use multiple bots with Audio on the same machine, you'll need to make a few
|
| 374 |
+
necessary modifications.
|
| 375 |
+
|
| 376 |
+
Firstly, stop all Red bots. For each bot using Audio:
|
| 377 |
+
|
| 378 |
+
1. Start the bot.
|
| 379 |
+
2. Run the command ``[p]llset unmanaged``.
|
| 380 |
+
3. Stop the bot.
|
| 381 |
+
|
| 382 |
+
Next, open a command prompt/terminal window. Navigate to ``<datapath>/cogs/Audio`` for any of your bot
|
| 383 |
+
instances - it doesn't matter which bot as all your bots will now use this single instance of Lavalink.
|
| 384 |
+
You can find your ``<datapath>`` with the ``[p]datapath`` command.
|
| 385 |
+
|
| 386 |
+
Now you need to determine your RAM needs. If your bot has 1GB RAM available, Lavalink should be restricted
|
| 387 |
+
to perhaps 384MB -> 768MB, depending on the cogs you have installed. If your bot has 2GB of RAM available,
|
| 388 |
+
a good amount may be 512MB -> 1GB.
|
| 389 |
+
|
| 390 |
+
Run the following command, where ``Xmx`` specifies the RAM value you have just determined. The MB suffix
|
| 391 |
+
is M and the GB suffix is G.
|
| 392 |
+
|
| 393 |
+
.. code-block:: ini
|
| 394 |
+
|
| 395 |
+
java -jar -Xmx768M Lavalink.jar -Djdk.tls.client.protocols=TLSv1.2
|
| 396 |
+
|
| 397 |
+
Leave this command prompt/terminal window open (you will need to do this every time you want to start Lavalink
|
| 398 |
+
for your bots). Once Lavalink says it has fully started, you can start your bots back up.
|
| 399 |
+
|
| 400 |
+
.. note::
|
| 401 |
+
|
| 402 |
+
If you are on Linux, this process can be automated using systemd, for unmanaged
|
| 403 |
+
Lavalink backends **only**. See :ref:`here<linux-audio-autorestart>` for details.
|
| 404 |
+
|
| 405 |
+
.. warning::
|
| 406 |
+
|
| 407 |
+
By running multiple bots that use Audio, the responsibility for keeping the Lavalink.jar updated will now be
|
| 408 |
+
in your hands, as Red will no longer manage it through the Audio cog. See :ref:`here<obtaining-the-latest-lavalink>` for guidance.
|
| 409 |
+
|
| 410 |
+
.. _linux-audio-autorestart:
|
| 411 |
+
|
| 412 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 413 |
+
Linux Lavalink Auto-Restart
|
| 414 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 415 |
+
|
| 416 |
+
Auto-restarting Lavalink is possible on Linux with systemd, for unmanaged Lavalink backends.
|
| 417 |
+
|
| 418 |
+
Firstly, find out what your datapath is with the ``[p]datapath`` command. Your Lavalink path is
|
| 419 |
+
``<datapath>/cogs/Audio``. Create a file named ``auto_update.sh`` in your Lavalink path.
|
| 420 |
+
|
| 421 |
+
Inside this newly created file, paste the following text:
|
| 422 |
+
|
| 423 |
+
.. code-block:: sh
|
| 424 |
+
|
| 425 |
+
curl -LOz Lavalink.jar https://github.com/Cog-Creators/Lavalink-Jars/releases/latest/download/Lavalink.jar
|
| 426 |
+
|
| 427 |
+
Run the following, replacing ``<Lavalink path>`` with the Lavalink path you generated earlier (``<datapath>/cogs/Audio``).
|
| 428 |
+
|
| 429 |
+
.. code-block:: sh
|
| 430 |
+
|
| 431 |
+
chmod a+rx <Lavalink path>/auto_update.sh
|
| 432 |
+
|
| 433 |
+
Now we need to create a service file so that systemd can do its magic. Run the following command:
|
| 434 |
+
|
| 435 |
+
.. code-block:: sh
|
| 436 |
+
|
| 437 |
+
sudo -e /etc/systemd/system/lavalink.service
|
| 438 |
+
|
| 439 |
+
Next, paste in the example below, but replacing the following:
|
| 440 |
+
|
| 441 |
+
* ``<Jar executable path>`` - You can find your Java path by running ``which java``.
|
| 442 |
+
* ``<Lavalink path>`` - The parent folder where your Lavalink executable can be located (usually in ``<datapath>/cogs/Audio``).
|
| 443 |
+
* ``<username>`` - Your username on the host machine (run ``echo $USER``).
|
| 444 |
+
|
| 445 |
+
.. code-block:: ini
|
| 446 |
+
|
| 447 |
+
[Unit]
|
| 448 |
+
Description=lavalink
|
| 449 |
+
After=multi-user.target
|
| 450 |
+
|
| 451 |
+
[Service]
|
| 452 |
+
ExecStart=<Java executable path> -Djdk.tls.client.protocols=TLSv1.2 -jar < Lavalink path >/Lavalink.jar
|
| 453 |
+
WorkingDirectory=<Lavalink path>
|
| 454 |
+
User=<username>
|
| 455 |
+
Group=<username>
|
| 456 |
+
ExecStartPre=/bin/bash <Lavalink path>/auto_update.sh # Comment this line out if you did not create the auto_update.sh
|
| 457 |
+
Type=idle
|
| 458 |
+
Restart=always
|
| 459 |
+
RestartSec=15
|
| 460 |
+
|
| 461 |
+
[Install]
|
| 462 |
+
WantedBy=multi-user.target
|
| 463 |
+
|
| 464 |
+
Finally, we need to start and enable the service. Run the following commands, separately.
|
| 465 |
+
|
| 466 |
+
.. code-block:: sh
|
| 467 |
+
|
| 468 |
+
sudo systemctl start lavalink
|
| 469 |
+
sudo systemctl enable lavalink
|
| 470 |
+
|
| 471 |
+
These commands always need to be ran when starting the lavalink service to ensure that the
|
| 472 |
+
service runs in the background.
|
| 473 |
+
|
| 474 |
+
Finally, you can run the following to retrieve logs for the service, when you need them:
|
| 475 |
+
|
| 476 |
+
.. code-block:: sh
|
| 477 |
+
|
| 478 |
+
sudo journalctl -u lavalink
|
| 479 |
+
|
| 480 |
+
.. _obtaining-the-latest-lavalink:
|
| 481 |
+
|
| 482 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 483 |
+
Obtaining the latest Lavalink.jar on a Red update
|
| 484 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 485 |
+
|
| 486 |
+
**To manually download the jar**
|
| 487 |
+
|
| 488 |
+
Stop your bot. Download the Lavalink.jar file from `here <https://github.com/Cog-Creators/Lavalink-Jars/releases/latest>`__,
|
| 489 |
+
which could alternatively be downloaded by running the following command:
|
| 490 |
+
|
| 491 |
+
.. code-block:: sh
|
| 492 |
+
|
| 493 |
+
curl -LOz Lavalink.jar https://github.com/Cog-Creators/Lavalink-Jars/releases/latest/download/Lavalink.jar
|
| 494 |
+
|
| 495 |
+
Next, stop all instances of Red running on the host, and stop the Lavalink process. Move the new Lavalink.jar
|
| 496 |
+
to where your old Lavalink.jar is located, overwriting the old file.
|
| 497 |
+
|
| 498 |
+
Finally, start up the new Lavalink.jar process via a process manager like systemd, or by running the following command:
|
| 499 |
+
|
| 500 |
+
.. code-block:: sh
|
| 501 |
+
|
| 502 |
+
java -jar Lavalink.jar -Djdk.tls.client.protocols=TLSv1.2
|
| 503 |
+
|
| 504 |
+
Start up your bots, and now they will use the latest Lavalink.jar!
|
| 505 |
+
|
| 506 |
+
.. _remote-lavalink:
|
| 507 |
+
|
| 508 |
+
---------------------------------------------------------------
|
| 509 |
+
Setting up an unmanaged Lavalink node on a remote VPS or server
|
| 510 |
+
---------------------------------------------------------------
|
| 511 |
+
|
| 512 |
+
.. attention::
|
| 513 |
+
|
| 514 |
+
We'd like to thank BreezeQS, as this guide is a supersession of their unofficial bare-bones guide.
|
| 515 |
+
|
| 516 |
+
This guide explains how to set up an unmanaged Lavalink node on a separate server running Ubuntu 20.04 LTS.
|
| 517 |
+
It is assumed your bot currently uses a managed Lavalink server (Red's default).
|
| 518 |
+
|
| 519 |
+
.. warning::
|
| 520 |
+
|
| 521 |
+
This guide is provided for advice on this topic and this is generally not a supported configuration for
|
| 522 |
+
Red's usage of Lavalink, as it involves system administration and network configuration. However, if you
|
| 523 |
+
run into any issues, feel free to ask for help in the `Red Support Server <https://discord.gg/red>`__, in the #general channel.
|
| 524 |
+
|
| 525 |
+
.. warning::
|
| 526 |
+
|
| 527 |
+
For security purposes DO NOT follow this guide while logged in as the root user. You should create
|
| 528 |
+
a separate non-root user instead. You can follow
|
| 529 |
+
`this guide <https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart>`__
|
| 530 |
+
from DigitalOcean if you need help about how this is done.
|
| 531 |
+
|
| 532 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 533 |
+
Prerequisite Installation
|
| 534 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 535 |
+
|
| 536 |
+
We will first install Lavalink and lay the foundation for our finished server. There are some prerequisites
|
| 537 |
+
that must be installed on the server you aim to use for running Lavalink. To set those up, run each of the
|
| 538 |
+
following commands one by one.
|
| 539 |
+
|
| 540 |
+
.. code-block:: sh
|
| 541 |
+
|
| 542 |
+
sudo apt update
|
| 543 |
+
sudo apt upgrade -y
|
| 544 |
+
sudo apt install curl nano -y
|
| 545 |
+
|
| 546 |
+
If you have no preference in which Java version you install on your target system, Red
|
| 547 |
+
uses OpenJDK 11 in the managed Lavalink configuration. It can be installed by running:
|
| 548 |
+
|
| 549 |
+
.. code-block:: sh
|
| 550 |
+
|
| 551 |
+
sudo apt install openjdk-11-jre-headless -y
|
| 552 |
+
|
| 553 |
+
Otherwise, Lavalink works well with most versions of Java 11, 13, 15, 16, 17, and 18. Azul
|
| 554 |
+
Zulu builds are suggested, see `here <https://github.com/freyacodes/Lavalink/#requirements>`__ for more information.
|
| 555 |
+
|
| 556 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 557 |
+
Setting Up The Lavalink Folder
|
| 558 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 559 |
+
|
| 560 |
+
Lavalink itself, its configuration, and its logs will all be kept in a single directory. In this guide,
|
| 561 |
+
we will simply call this directory lavalink and it will be located in the home directory of the user you
|
| 562 |
+
are logged in as.
|
| 563 |
+
|
| 564 |
+
We need to create a new directory called **lavalink**, and then switch to it as the upcoming sections of
|
| 565 |
+
this guide require your current directory to be the **lavalink** folder. We can achieve this by running
|
| 566 |
+
the following commands one by one:
|
| 567 |
+
|
| 568 |
+
.. code-block:: sh
|
| 569 |
+
|
| 570 |
+
cd
|
| 571 |
+
mkdir lavalink
|
| 572 |
+
cd lavalink
|
| 573 |
+
|
| 574 |
+
^^^^^^^^^^^^^^^^^^^
|
| 575 |
+
Installing Lavalink
|
| 576 |
+
^^^^^^^^^^^^^^^^^^^
|
| 577 |
+
|
| 578 |
+
The Lavalink executable used in Red-Discordbot is slightly modified and is not the same as stock Lavalink,
|
| 579 |
+
it ensures proper operation when used with Red-Discordbot and compatibility with systems and libraries that
|
| 580 |
+
Red uses to operate. It's required to use this Lavalink.jar when running unmanaged Lavalink servers to not
|
| 581 |
+
void your privilege to receive support. Assuming your current directory is the lavalink folder as you ran
|
| 582 |
+
the ``cd lavalink`` command in the previous section, you can run the following commands one by one to install it:
|
| 583 |
+
|
| 584 |
+
.. code-block:: sh
|
| 585 |
+
|
| 586 |
+
curl https://raw.githubusercontent.com/freyacodes/Lavalink/master/LavalinkServer/application.yml.example > application.yml
|
| 587 |
+
curl -LOz Lavalink.jar https://github.com/Cog-Creators/Lavalink-Jars/releases/latest/download/Lavalink.jar
|
| 588 |
+
|
| 589 |
+
If you did it properly, the files ``Lavalink.jar`` and ``application.yml`` will show up when we run ``ls``, the Linux command
|
| 590 |
+
to list the contents of the current directory.
|
| 591 |
+
|
| 592 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 593 |
+
Configuring Lavalink
|
| 594 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 595 |
+
|
| 596 |
+
Lavalink stores its settings inside the ``application.yml`` file located in the same directory as the executable jar itself.
|
| 597 |
+
You have to edit this file and change some settings for security purposes.
|
| 598 |
+
|
| 599 |
+
First, let's open the file. You can use any text editor you want, but in this guide we will use nano.
|
| 600 |
+
Run the following command:
|
| 601 |
+
|
| 602 |
+
.. code-block:: sh
|
| 603 |
+
|
| 604 |
+
nano application.yml
|
| 605 |
+
|
| 606 |
+
You will be dropped into the nano text editor with ``application.yml`` opened. The two important fields that we will modify
|
| 607 |
+
are the ``port`` and ``password`` fields.
|
| 608 |
+
|
| 609 |
+
The ``port`` field is the TCP port your Lavalink server will be accessible at. The default value is 2333, and you can set this
|
| 610 |
+
to any positive integer smaller than 65535 and greater than 1000. It is advised to change it to aid in security.
|
| 611 |
+
|
| 612 |
+
The ``password`` field is the password that will be required for accessing your Lavalink server and by default the password is
|
| 613 |
+
``youshallnotpass``. You should absolutely change this to a secure password.
|
| 614 |
+
|
| 615 |
+
Those two fields are important and you should take note of the new values you entered, as
|
| 616 |
+
they will be later required to connect your bot to the Lavalink server.
|
| 617 |
+
|
| 618 |
+
At the bottom of the screen, the nano text editor displays some keys that can be used to carry out various tasks.
|
| 619 |
+
In this case, we want to save and exit. Keys prefixed with the caret (^) sign means they are used in conjunction
|
| 620 |
+
with the ctrl key. So we press Ctrl+X to exit.
|
| 621 |
+
|
| 622 |
+
Nano will ask if you want to save the changes that were made. Answer with ``y`` and hit enter to exit.
|
| 623 |
+
|
| 624 |
+
^^^^^^^^^^^^^^^^^
|
| 625 |
+
Starting Lavalink
|
| 626 |
+
^^^^^^^^^^^^^^^^^
|
| 627 |
+
|
| 628 |
+
Now that Lavalink has been installed and configured, we can start it up. To do so, run the following command, making sure
|
| 629 |
+
that you are inside the lavalink folder, of course:
|
| 630 |
+
|
| 631 |
+
.. code-block:: sh
|
| 632 |
+
|
| 633 |
+
java -Djdk.tls.client.protocols=TLSv1.2 -jar Lavalink.jar
|
| 634 |
+
|
| 635 |
+
On successful start, Lavalink will greet you with a line mentioning that it is ready to accept connections and you can now
|
| 636 |
+
try connecting to it with your bot.
|
| 637 |
+
|
| 638 |
+
Since we did not configure autostart for Lavalink, you will have to keep the console window open or it will be shut down
|
| 639 |
+
and all connections will be dropped. This is similar to how it happens in Red-Discordbot itself.
|
| 640 |
+
|
| 641 |
+
This also means that you will have to restart Lavalink manually each time you log on. This is often done in testing environments.
|
| 642 |
+
You can restart Lavalink manually by running the following commands one by one:
|
| 643 |
+
|
| 644 |
+
.. code-block:: sh
|
| 645 |
+
|
| 646 |
+
cd
|
| 647 |
+
cd lavalink
|
| 648 |
+
java -Djdk.tls.client.protocols=TLSv1.2 -jar Lavalink.jar
|
| 649 |
+
|
| 650 |
+
You can stop Lavalink and reclaim the console by hitting ``CTRL+C``.
|
| 651 |
+
|
| 652 |
+
^^^^^^^^^^^^^^^^^
|
| 653 |
+
Updating Lavalink
|
| 654 |
+
^^^^^^^^^^^^^^^^^
|
| 655 |
+
|
| 656 |
+
With new releases of Red-Discordbot, sometimes new Lavalink jars are also released. Using an obsolete version of Lavalink
|
| 657 |
+
with newer versions of Red-Discordbot can cause all sorts of problems.
|
| 658 |
+
|
| 659 |
+
Normally, users do not have to worry about this as when Red-Discordbot is configured to use a managed Lavalink server
|
| 660 |
+
(the default setting) Lavalink is automatically updated when a new release comes out.
|
| 661 |
+
|
| 662 |
+
However, since you are running a Lavalink instance yourself you are responsible for keeping it up to date.
|
| 663 |
+
When a new release of Red-Discordbot also requires a update to the Lavalink jar, you will be informed in the changelogs
|
| 664 |
+
posted in our documentation.
|
| 665 |
+
|
| 666 |
+
When a new Lavalink.jar comes out, you can easily update the existing one. First, you should stop Lavalink if it's currently
|
| 667 |
+
running. Once you have done this, you can follow the instructions on how to :ref:`obtain the latest Lavalink.jar on a Red update<obtaining-the-latest-lavalink>`.
|
| 668 |
+
|
| 669 |
+
In the next section we will see how you can configure Lavalink to automatically update, automatically start, and run as
|
| 670 |
+
a background process which is much more convenient for non-testing deployments.
|
| 671 |
+
|
| 672 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 673 |
+
Setting up Auto Update
|
| 674 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 675 |
+
|
| 676 |
+
As previously covered, running Lavalink in a simple terminal session is fragile. Not only does it need you to manually
|
| 677 |
+
intervene each time you login, reboot, or just have to restart Lavalink for any reason you also have to update it manually
|
| 678 |
+
when a new Lavalink jar comes out.
|
| 679 |
+
|
| 680 |
+
First of all, we will configure a script for updating Lavalink that runs before each time Lavalink starts. This step is
|
| 681 |
+
highly recommended. But if you know what you are doing, you can skip it if you want to update Lavalink manually.
|
| 682 |
+
|
| 683 |
+
First, run the following commands:
|
| 684 |
+
|
| 685 |
+
.. code-block:: sh
|
| 686 |
+
|
| 687 |
+
cd
|
| 688 |
+
cd lavalink
|
| 689 |
+
nano auto_update.sh
|
| 690 |
+
|
| 691 |
+
You'll see that running nano has opened a file. Paste the following code into the file:
|
| 692 |
+
|
| 693 |
+
.. code-block:: sh
|
| 694 |
+
|
| 695 |
+
#!/bin/sh
|
| 696 |
+
curl -LOz Lavalink.jar https://github.com/Cog-Creators/Lavalink-Jars/releases/latest/download/Lavalink.jar
|
| 697 |
+
|
| 698 |
+
Now save the file and exit (``CTRL+X``, then ``y``).
|
| 699 |
+
|
| 700 |
+
Now, run the following command, which will make the script possible to run:
|
| 701 |
+
|
| 702 |
+
.. code-block:: sh
|
| 703 |
+
|
| 704 |
+
chmod a+rx auto_update.sh
|
| 705 |
+
|
| 706 |
+
If you did it right, the command itself will not output anything. And when running ``ls``, the script will show up in green.
|
| 707 |
+
|
| 708 |
+
""""""""""""""""""""""""""""""
|
| 709 |
+
Setting Up the Systemd Service
|
| 710 |
+
""""""""""""""""""""""""""""""
|
| 711 |
+
|
| 712 |
+
We will now register Lavalink as a system service, allowing it to run in the background without user intervention.
|
| 713 |
+
But before that, we need to gather some information. While in the lavalink folder, run the following commands one by one
|
| 714 |
+
and note their output somewhere, because we will need them:
|
| 715 |
+
|
| 716 |
+
.. code-block:: sh
|
| 717 |
+
|
| 718 |
+
pwd
|
| 719 |
+
which java
|
| 720 |
+
echo "$USER"
|
| 721 |
+
|
| 722 |
+
Now run the following command:
|
| 723 |
+
|
| 724 |
+
.. code-block:: sh
|
| 725 |
+
|
| 726 |
+
sudo -e /etc/systemd/system/lavalink.service
|
| 727 |
+
|
| 728 |
+
On new systems it may ask for a choice of editor. Nano is the best choice. To select it, press 1 and hit enter.
|
| 729 |
+
The nano text editor will now open. Now copy and paste the following text into it:
|
| 730 |
+
|
| 731 |
+
.. code-block:: ini
|
| 732 |
+
|
| 733 |
+
[Unit]
|
| 734 |
+
Description=lavalink
|
| 735 |
+
After=multi-user.target
|
| 736 |
+
|
| 737 |
+
[Service]
|
| 738 |
+
ExecStart=< Java executable path > -Djdk.tls.client.protocols=TLSv1.2 -jar < Lavalink path >/Lavalink.jar
|
| 739 |
+
WorkingDirectory=< Lavalink path >
|
| 740 |
+
User=< username >
|
| 741 |
+
Group=< username >
|
| 742 |
+
ExecStartPre=/bin/bash < Lavalink path >/auto_update.sh # Comment this line out if you did not create the auto_update.sh
|
| 743 |
+
Type=idle
|
| 744 |
+
Restart=always
|
| 745 |
+
RestartSec=15
|
| 746 |
+
|
| 747 |
+
[Install]
|
| 748 |
+
WantedBy=multi-user.target
|
| 749 |
+
|
| 750 |
+
* Replace all occurrences of ``< Lavalink path >`` with the output of ``pwd`` you noted earlier.
|
| 751 |
+
* Replace all occurrences of ``< Java executable path >`` with the output of ``which java`` you noted earlier.
|
| 752 |
+
* Replace all occurrences of ``< username >`` with the output of echo ``"$USER"`` you noted earlier.
|
| 753 |
+
|
| 754 |
+
Hit ``CTRL+X``, ``y`` and then ENTER to save and exit. We have now registered Lavalink as a service.
|
| 755 |
+
|
| 756 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 757 |
+
Starting and Enabling the Lavalink Service
|
| 758 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 759 |
+
|
| 760 |
+
Now run the following command to start the Lavalink service and wait for 10-15 seconds:
|
| 761 |
+
|
| 762 |
+
.. code-block:: sh
|
| 763 |
+
|
| 764 |
+
sudo systemctl start lavalink
|
| 765 |
+
|
| 766 |
+
You can check the service status with the following command:
|
| 767 |
+
|
| 768 |
+
.. code-block:: sh
|
| 769 |
+
|
| 770 |
+
sudo journalctl -u lavalink
|
| 771 |
+
|
| 772 |
+
Keep in mind this will occupy your terminal and you have to hit CTRL+C to stop it before doing something else.
|
| 773 |
+
This will only close the log viewer, Lavalink itself will continue to run in the background.
|
| 774 |
+
|
| 775 |
+
You may now run the following to make Lavalink auto-restart each boot:
|
| 776 |
+
|
| 777 |
+
.. code-block:: sh
|
| 778 |
+
|
| 779 |
+
sudo systemctl enable lavalink
|
| 780 |
+
|
| 781 |
+
.. tip::
|
| 782 |
+
|
| 783 |
+
You can stop the Lavalink service with the following when you need to e.g. for troubleshooting:
|
| 784 |
+
|
| 785 |
+
.. code-block:: sh
|
| 786 |
+
|
| 787 |
+
sudo systemctl stop lavalink
|
| 788 |
+
|
| 789 |
+
You can also check the logs Lavalink persists by checking the ``spring.log`` file in the ``lavalink/logs/`` folder.
|
| 790 |
+
|
| 791 |
+
Congratulations, you are almost ready.
|
| 792 |
+
|
| 793 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 794 |
+
Connecting to Your New Lavalink Server
|
| 795 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 796 |
+
|
| 797 |
+
If your Red instance and Lavalink server will communicate over the Internet, make sure the Lavalink port is accessible
|
| 798 |
+
from the internet. Click `here <https://www.yougetsignal.com/tools/open-ports/>`__ and test if the port you set in the ``application.yml``
|
| 799 |
+
is accessible on the public ip address of your Lavalink server. This step isn't necessary if your Lavalink server and Red
|
| 800 |
+
instance will communicate over LAN. If you get connectivity errors, make sure there are no firewalls blocking the port and
|
| 801 |
+
you are using the correct port.
|
| 802 |
+
|
| 803 |
+
If successful, run each of the following commands one by one on your bot. Replace ``"yourlavalinkip"`` with the ip of your Lavalink server.
|
| 804 |
+
Change ``"port"`` with the port you set up in the application.yml. Change ``"password"`` with the password you set up in the application.yml.
|
| 805 |
+
Do not use quotes in these commands. For example, ``[p]llset host 192.168.10.101`` or ``[p]llset password ahyesverysecure``.
|
| 806 |
+
|
| 807 |
+
.. code-block:: none
|
| 808 |
+
|
| 809 |
+
[p]llset unmanaged
|
| 810 |
+
[p]llset host "yourlavalinkip"
|
| 811 |
+
[p]llset port "port"
|
| 812 |
+
[p]llset password "password"
|
| 813 |
+
|
| 814 |
+
Reload audio with ``[p]reload audio`` and give it a few seconds to connect.
|
| 815 |
+
|
| 816 |
+
You now (hopefully) have a functioning Lavalink server on a machine separate to the one running your Red instance. Good luck!
|
| 817 |
+
|
| 818 |
+
.. _audio-commands:
|
| 819 |
+
|
| 820 |
+
--------
|
| 821 |
+
Commands
|
| 822 |
+
--------
|
| 823 |
+
|
| 824 |
+
.. _audio-command-audioset:
|
| 825 |
+
|
| 826 |
+
^^^^^^^^
|
| 827 |
+
audioset
|
| 828 |
+
^^^^^^^^
|
| 829 |
+
|
| 830 |
+
**Syntax**
|
| 831 |
+
|
| 832 |
+
.. code-block:: none
|
| 833 |
+
|
| 834 |
+
[p]audioset
|
| 835 |
+
|
| 836 |
+
**Description**
|
| 837 |
+
|
| 838 |
+
Music configuration options.
|
| 839 |
+
|
| 840 |
+
.. _audio-command-audioset-autodeafen:
|
| 841 |
+
|
| 842 |
+
"""""""""""""""""""
|
| 843 |
+
audioset autodeafen
|
| 844 |
+
"""""""""""""""""""
|
| 845 |
+
|
| 846 |
+
.. note:: |mod-lock|
|
| 847 |
+
|
| 848 |
+
**Syntax**
|
| 849 |
+
|
| 850 |
+
.. code-block:: none
|
| 851 |
+
|
| 852 |
+
[p]audioset autodeafen
|
| 853 |
+
|
| 854 |
+
**Description**
|
| 855 |
+
|
| 856 |
+
Toggle whether the bot will be auto deafened upon joining the voice channel.
|
| 857 |
+
|
| 858 |
+
.. _audio-command-audioset-autoplay:
|
| 859 |
+
|
| 860 |
+
"""""""""""""""""
|
| 861 |
+
audioset autoplay
|
| 862 |
+
"""""""""""""""""
|
| 863 |
+
|
| 864 |
+
.. note:: |mod-lock|
|
| 865 |
+
|
| 866 |
+
**Syntax**
|
| 867 |
+
|
| 868 |
+
.. code-block:: none
|
| 869 |
+
|
| 870 |
+
[p]audioset autoplay
|
| 871 |
+
|
| 872 |
+
**Description**
|
| 873 |
+
|
| 874 |
+
Change auto-play setting.
|
| 875 |
+
|
| 876 |
+
.. _audio-command-audioset-autoplay-playlist:
|
| 877 |
+
|
| 878 |
+
""""""""""""""""""""""""""
|
| 879 |
+
audioset autoplay playlist
|
| 880 |
+
""""""""""""""""""""""""""
|
| 881 |
+
|
| 882 |
+
**Syntax**
|
| 883 |
+
|
| 884 |
+
.. code-block:: none
|
| 885 |
+
|
| 886 |
+
[p]audioset autoplay playlist <playlist_name_OR_id> [args]
|
| 887 |
+
|
| 888 |
+
**Description**
|
| 889 |
+
|
| 890 |
+
Set a playlist to auto-play songs from.
|
| 891 |
+
|
| 892 |
+
**Args**
|
| 893 |
+
|
| 894 |
+
The following are all optional:
|
| 895 |
+
|
| 896 |
+
* --scope <scope>
|
| 897 |
+
* --author [user]
|
| 898 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 899 |
+
|
| 900 |
+
**Scope** is one of the following:
|
| 901 |
+
|
| 902 |
+
* Global
|
| 903 |
+
* Guild
|
| 904 |
+
* User
|
| 905 |
+
|
| 906 |
+
**Author** can be one of the following:
|
| 907 |
+
|
| 908 |
+
* User ID
|
| 909 |
+
* User Mention
|
| 910 |
+
* User Name#123
|
| 911 |
+
|
| 912 |
+
**Guild** can be one of the following:
|
| 913 |
+
|
| 914 |
+
* Guild ID
|
| 915 |
+
* Exact guild name
|
| 916 |
+
|
| 917 |
+
**Example Usage**
|
| 918 |
+
|
| 919 |
+
* ``[p]audioset autoplay playlist MyGuildPlaylist``
|
| 920 |
+
* ``[p]audioset autoplay playlist MyGlobalPlaylist --scope Global``
|
| 921 |
+
* ``[p]audioset autoplay playlist PersonalPlaylist --scope User --author Draper``
|
| 922 |
+
|
| 923 |
+
.. _audio-command-audioset-autoplay-reset:
|
| 924 |
+
|
| 925 |
+
"""""""""""""""""""""""
|
| 926 |
+
audioset autoplay reset
|
| 927 |
+
"""""""""""""""""""""""
|
| 928 |
+
|
| 929 |
+
**Syntax**
|
| 930 |
+
|
| 931 |
+
.. code-block:: none
|
| 932 |
+
|
| 933 |
+
[p]audioset autoplay reset
|
| 934 |
+
|
| 935 |
+
**Description**
|
| 936 |
+
|
| 937 |
+
Resets auto-play to the default playlist.
|
| 938 |
+
|
| 939 |
+
.. _audio-command-audioset-autoplay-toggle:
|
| 940 |
+
|
| 941 |
+
""""""""""""""""""""""""
|
| 942 |
+
audioset autoplay toggle
|
| 943 |
+
""""""""""""""""""""""""
|
| 944 |
+
|
| 945 |
+
**Syntax**
|
| 946 |
+
|
| 947 |
+
.. code-block:: none
|
| 948 |
+
|
| 949 |
+
[p]audioset autoplay toggle
|
| 950 |
+
|
| 951 |
+
**Description**
|
| 952 |
+
|
| 953 |
+
Toggle auto-play when there are no songs in the queue.
|
| 954 |
+
|
| 955 |
+
.. _audio-command-audioset-cache:
|
| 956 |
+
|
| 957 |
+
""""""""""""""
|
| 958 |
+
audioset cache
|
| 959 |
+
""""""""""""""
|
| 960 |
+
|
| 961 |
+
.. note:: |owner-lock|
|
| 962 |
+
|
| 963 |
+
**Syntax**
|
| 964 |
+
|
| 965 |
+
.. code-block:: none
|
| 966 |
+
|
| 967 |
+
[p]audioset cache [level]
|
| 968 |
+
|
| 969 |
+
**Description**
|
| 970 |
+
|
| 971 |
+
Sets the caching level.
|
| 972 |
+
|
| 973 |
+
Level can be one of the following:
|
| 974 |
+
|
| 975 |
+
* ``0``: Disables all caching
|
| 976 |
+
* ``1``: Enables Spotify Cache
|
| 977 |
+
* ``2``: Enables YouTube Cache
|
| 978 |
+
* ``3``: Enables Lavalink Cache
|
| 979 |
+
* ``5``: Enables all Caches
|
| 980 |
+
|
| 981 |
+
If you wish to disable a specific cache use a negative number.
|
| 982 |
+
|
| 983 |
+
.. _audio-command-audioset-cacheage:
|
| 984 |
+
|
| 985 |
+
"""""""""""""""""
|
| 986 |
+
audioset cacheage
|
| 987 |
+
"""""""""""""""""
|
| 988 |
+
|
| 989 |
+
.. note:: |owner-lock|
|
| 990 |
+
|
| 991 |
+
**Syntax**
|
| 992 |
+
|
| 993 |
+
.. code-block:: none
|
| 994 |
+
|
| 995 |
+
[p]audioset cacheage <age>
|
| 996 |
+
|
| 997 |
+
**Description**
|
| 998 |
+
|
| 999 |
+
Sets the cache max age. This commands allows you to set the max number of
|
| 1000 |
+
days before an entry in the cache becomes invalid.
|
| 1001 |
+
|
| 1002 |
+
.. _audio-command-audioset-countrycode:
|
| 1003 |
+
|
| 1004 |
+
""""""""""""""""""""
|
| 1005 |
+
audioset countrycode
|
| 1006 |
+
""""""""""""""""""""
|
| 1007 |
+
|
| 1008 |
+
.. note:: |mod-lock|
|
| 1009 |
+
|
| 1010 |
+
**Syntax**
|
| 1011 |
+
|
| 1012 |
+
.. code-block:: none
|
| 1013 |
+
|
| 1014 |
+
[p]audioset countrycode <country>
|
| 1015 |
+
|
| 1016 |
+
**Description**
|
| 1017 |
+
|
| 1018 |
+
Set the country code for Spotify searches.
|
| 1019 |
+
|
| 1020 |
+
.. _audio-command-audioset-dailyqueue:
|
| 1021 |
+
|
| 1022 |
+
"""""""""""""""""""
|
| 1023 |
+
audioset dailyqueue
|
| 1024 |
+
"""""""""""""""""""
|
| 1025 |
+
|
| 1026 |
+
.. note:: |admin-lock|
|
| 1027 |
+
|
| 1028 |
+
**Syntax**
|
| 1029 |
+
|
| 1030 |
+
.. code-block:: none
|
| 1031 |
+
|
| 1032 |
+
[p]audioset dailyqueue
|
| 1033 |
+
|
| 1034 |
+
**Description**
|
| 1035 |
+
|
| 1036 |
+
Toggle daily queues. Daily queues creates a playlist for all tracks played today.
|
| 1037 |
+
|
| 1038 |
+
.. _audio-command-audioset-dc:
|
| 1039 |
+
|
| 1040 |
+
"""""""""""
|
| 1041 |
+
audioset dc
|
| 1042 |
+
"""""""""""
|
| 1043 |
+
|
| 1044 |
+
.. note:: |mod-lock|
|
| 1045 |
+
|
| 1046 |
+
**Syntax**
|
| 1047 |
+
|
| 1048 |
+
.. code-block:: none
|
| 1049 |
+
|
| 1050 |
+
[p]audioset dc
|
| 1051 |
+
|
| 1052 |
+
**Description**
|
| 1053 |
+
|
| 1054 |
+
Toggle the bot auto-disconnecting when done playing. This setting takes precedence
|
| 1055 |
+
over ``[p]audioset emptydisconnect``.
|
| 1056 |
+
|
| 1057 |
+
.. _audio-command-audioset-dj:
|
| 1058 |
+
|
| 1059 |
+
"""""""""""
|
| 1060 |
+
audioset dj
|
| 1061 |
+
"""""""""""
|
| 1062 |
+
|
| 1063 |
+
.. note:: |admin-lock|
|
| 1064 |
+
|
| 1065 |
+
**Syntax**
|
| 1066 |
+
|
| 1067 |
+
.. code-block:: none
|
| 1068 |
+
|
| 1069 |
+
[p]audioset dj
|
| 1070 |
+
|
| 1071 |
+
**Description**
|
| 1072 |
+
|
| 1073 |
+
Toggle DJ mode. DJ mode allows users with the DJ role to use audio commands.
|
| 1074 |
+
|
| 1075 |
+
.. _audio-command-audioset-emptydisconnect:
|
| 1076 |
+
|
| 1077 |
+
""""""""""""""""""""""""
|
| 1078 |
+
audioset emptydisconnect
|
| 1079 |
+
""""""""""""""""""""""""
|
| 1080 |
+
|
| 1081 |
+
.. note:: |mod-lock|
|
| 1082 |
+
|
| 1083 |
+
**Syntax**
|
| 1084 |
+
|
| 1085 |
+
.. code-block:: none
|
| 1086 |
+
|
| 1087 |
+
[p]audioset emptydisconnect <seconds>
|
| 1088 |
+
|
| 1089 |
+
**Description**
|
| 1090 |
+
|
| 1091 |
+
Auto-disconnect from channel when bot is alone in it for x seconds, 0 to disable.
|
| 1092 |
+
``[p]audioset dc`` takes precedence over this setting.
|
| 1093 |
+
|
| 1094 |
+
.. _audio-command-audioset-emptypause:
|
| 1095 |
+
|
| 1096 |
+
"""""""""""""""""""
|
| 1097 |
+
audioset emptypause
|
| 1098 |
+
"""""""""""""""""""
|
| 1099 |
+
|
| 1100 |
+
.. note:: |mod-lock|
|
| 1101 |
+
|
| 1102 |
+
**Syntax**
|
| 1103 |
+
|
| 1104 |
+
.. code-block:: none
|
| 1105 |
+
|
| 1106 |
+
[p]audioset emptypause <seconds>
|
| 1107 |
+
|
| 1108 |
+
**Description**
|
| 1109 |
+
|
| 1110 |
+
Auto-pause after x seconds when the channel is empty, 0 to disable.
|
| 1111 |
+
|
| 1112 |
+
.. _audio-command-audioset-globaldailyqueue:
|
| 1113 |
+
|
| 1114 |
+
"""""""""""""""""""""""""
|
| 1115 |
+
audioset globaldailyqueue
|
| 1116 |
+
"""""""""""""""""""""""""
|
| 1117 |
+
|
| 1118 |
+
.. note:: |owner-lock|
|
| 1119 |
+
|
| 1120 |
+
**Syntax**
|
| 1121 |
+
|
| 1122 |
+
.. code-block:: none
|
| 1123 |
+
|
| 1124 |
+
[p]audioset globaldailyqueue
|
| 1125 |
+
|
| 1126 |
+
**Description**
|
| 1127 |
+
|
| 1128 |
+
Toggle global daily queues. Global daily queues creates a playlist
|
| 1129 |
+
for all tracks played today.
|
| 1130 |
+
|
| 1131 |
+
.. _audio-command-audioset-jukebox:
|
| 1132 |
+
|
| 1133 |
+
""""""""""""""""
|
| 1134 |
+
audioset jukebox
|
| 1135 |
+
""""""""""""""""
|
| 1136 |
+
|
| 1137 |
+
.. note:: |mod-lock|
|
| 1138 |
+
|
| 1139 |
+
**Syntax**
|
| 1140 |
+
|
| 1141 |
+
.. code-block:: none
|
| 1142 |
+
|
| 1143 |
+
[p]audioset jukebox <price>
|
| 1144 |
+
|
| 1145 |
+
**Description**
|
| 1146 |
+
|
| 1147 |
+
Set a price for queueing tracks for non-mods, 0 to disable.
|
| 1148 |
+
|
| 1149 |
+
.. _audio-command-audioset-localpath:
|
| 1150 |
+
|
| 1151 |
+
""""""""""""""""""
|
| 1152 |
+
audioset localpath
|
| 1153 |
+
""""""""""""""""""
|
| 1154 |
+
|
| 1155 |
+
.. note:: |owner-lock|
|
| 1156 |
+
|
| 1157 |
+
**Syntax**
|
| 1158 |
+
|
| 1159 |
+
.. code-block:: none
|
| 1160 |
+
|
| 1161 |
+
[p]audioset localpath [local_path]
|
| 1162 |
+
|
| 1163 |
+
**Description**
|
| 1164 |
+
|
| 1165 |
+
Set the localtracks path if the Lavalink.jar is not run from the Audio data folder.
|
| 1166 |
+
Leave the path blank to reset the path to the default, the Audio data directory.
|
| 1167 |
+
|
| 1168 |
+
.. _audio-command-audioset-logs:
|
| 1169 |
+
|
| 1170 |
+
"""""""""""""
|
| 1171 |
+
audioset logs
|
| 1172 |
+
"""""""""""""
|
| 1173 |
+
|
| 1174 |
+
.. note:: |owner-lock|
|
| 1175 |
+
|
| 1176 |
+
.. note::
|
| 1177 |
+
|
| 1178 |
+
This command is only available for managed Lavalink servers.
|
| 1179 |
+
|
| 1180 |
+
**Syntax**
|
| 1181 |
+
|
| 1182 |
+
.. code-block:: none
|
| 1183 |
+
|
| 1184 |
+
[p]audioset logs
|
| 1185 |
+
|
| 1186 |
+
**Description**
|
| 1187 |
+
|
| 1188 |
+
Sends the Lavalink server logs to your DMs.
|
| 1189 |
+
|
| 1190 |
+
.. _audio-command-audioset-lyrics:
|
| 1191 |
+
|
| 1192 |
+
"""""""""""""""
|
| 1193 |
+
audioset lyrics
|
| 1194 |
+
"""""""""""""""
|
| 1195 |
+
|
| 1196 |
+
.. note:: |mod-lock|
|
| 1197 |
+
|
| 1198 |
+
**Syntax**
|
| 1199 |
+
|
| 1200 |
+
.. code-block:: none
|
| 1201 |
+
|
| 1202 |
+
[p]audioset lyrics
|
| 1203 |
+
|
| 1204 |
+
**Description**
|
| 1205 |
+
|
| 1206 |
+
Prioritise tracks with lyrics.
|
| 1207 |
+
|
| 1208 |
+
.. _audio-command-audioset-maxlength:
|
| 1209 |
+
|
| 1210 |
+
""""""""""""""""""
|
| 1211 |
+
audioset maxlength
|
| 1212 |
+
""""""""""""""""""
|
| 1213 |
+
|
| 1214 |
+
.. note:: |mod-lock|
|
| 1215 |
+
|
| 1216 |
+
**Syntax**
|
| 1217 |
+
|
| 1218 |
+
.. code-block:: none
|
| 1219 |
+
|
| 1220 |
+
[p]audioset maxlength <seconds>
|
| 1221 |
+
|
| 1222 |
+
**Description**
|
| 1223 |
+
|
| 1224 |
+
Max length of a track to queue in seconds, 0 to disable. Accepts seconds or a value
|
| 1225 |
+
formatted like 00:00:00 (``hh:mm:ss``) or 00:00 (``mm:ss``). Invalid input will turn
|
| 1226 |
+
the max length setting off.
|
| 1227 |
+
|
| 1228 |
+
.. _audio-command-audioset-maxvolume:
|
| 1229 |
+
|
| 1230 |
+
""""""""""""""""""
|
| 1231 |
+
audioset maxvolume
|
| 1232 |
+
""""""""""""""""""
|
| 1233 |
+
|
| 1234 |
+
.. note:: |admin-lock|
|
| 1235 |
+
|
| 1236 |
+
**Syntax**
|
| 1237 |
+
|
| 1238 |
+
.. code-block:: none
|
| 1239 |
+
|
| 1240 |
+
[p]audioset maxvolume <maximum volume>
|
| 1241 |
+
|
| 1242 |
+
**Description**
|
| 1243 |
+
|
| 1244 |
+
Set the maximum volume allowed in this server.
|
| 1245 |
+
|
| 1246 |
+
.. _audio-command-audioset-mycountrycode:
|
| 1247 |
+
|
| 1248 |
+
""""""""""""""""""""""
|
| 1249 |
+
audioset mycountrycode
|
| 1250 |
+
""""""""""""""""""""""
|
| 1251 |
+
|
| 1252 |
+
**Syntax**
|
| 1253 |
+
|
| 1254 |
+
.. code-block:: none
|
| 1255 |
+
|
| 1256 |
+
[p]audioset mycountrycode <country>
|
| 1257 |
+
|
| 1258 |
+
**Description**
|
| 1259 |
+
|
| 1260 |
+
Set the country code for Spotify searches.
|
| 1261 |
+
|
| 1262 |
+
.. _audio-command-audioset-notify:
|
| 1263 |
+
|
| 1264 |
+
"""""""""""""""
|
| 1265 |
+
audioset notify
|
| 1266 |
+
"""""""""""""""
|
| 1267 |
+
|
| 1268 |
+
.. note:: |mod-lock|
|
| 1269 |
+
|
| 1270 |
+
**Syntax**
|
| 1271 |
+
|
| 1272 |
+
.. code-block:: none
|
| 1273 |
+
|
| 1274 |
+
[p]audioset notify
|
| 1275 |
+
|
| 1276 |
+
**Description**
|
| 1277 |
+
|
| 1278 |
+
Toggle track announcement and other bot messages.
|
| 1279 |
+
|
| 1280 |
+
.. _audio-command-audioset-persistqueue:
|
| 1281 |
+
|
| 1282 |
+
"""""""""""""""""""""
|
| 1283 |
+
audioset persistqueue
|
| 1284 |
+
"""""""""""""""""""""
|
| 1285 |
+
|
| 1286 |
+
.. note:: |admin-lock|
|
| 1287 |
+
|
| 1288 |
+
**Syntax**
|
| 1289 |
+
|
| 1290 |
+
.. code-block:: none
|
| 1291 |
+
|
| 1292 |
+
[p]audioset persistqueue
|
| 1293 |
+
|
| 1294 |
+
**Description**
|
| 1295 |
+
|
| 1296 |
+
Toggle persistent queues. Persistent queues allows the current queue
|
| 1297 |
+
to be restored when the queue closes.
|
| 1298 |
+
|
| 1299 |
+
.. _audio-command-audioset-restart:
|
| 1300 |
+
|
| 1301 |
+
""""""""""""""""
|
| 1302 |
+
audioset restart
|
| 1303 |
+
""""""""""""""""
|
| 1304 |
+
|
| 1305 |
+
.. note:: |owner-lock|
|
| 1306 |
+
|
| 1307 |
+
**Syntax**
|
| 1308 |
+
|
| 1309 |
+
.. code-block:: none
|
| 1310 |
+
|
| 1311 |
+
[p]audioset restart
|
| 1312 |
+
|
| 1313 |
+
**Description**
|
| 1314 |
+
|
| 1315 |
+
Restarts the lavalink connection.
|
| 1316 |
+
|
| 1317 |
+
.. _audio-command-audioset-restrict:
|
| 1318 |
+
|
| 1319 |
+
"""""""""""""""""
|
| 1320 |
+
audioset restrict
|
| 1321 |
+
"""""""""""""""""
|
| 1322 |
+
|
| 1323 |
+
.. note:: |owner-lock|
|
| 1324 |
+
|
| 1325 |
+
**Syntax**
|
| 1326 |
+
|
| 1327 |
+
.. code-block:: none
|
| 1328 |
+
|
| 1329 |
+
[p]audioset restrict
|
| 1330 |
+
|
| 1331 |
+
**Description**
|
| 1332 |
+
|
| 1333 |
+
Toggle the domain restriction on Audio.
|
| 1334 |
+
|
| 1335 |
+
When toggled off, users will be able to play songs from non-commercial websites and links.
|
| 1336 |
+
When toggled on, users are restricted to YouTube, SoundCloud, Vimeo, Twitch, and
|
| 1337 |
+
Bandcamp links.
|
| 1338 |
+
|
| 1339 |
+
.. _audio-command-audioset-restrictions:
|
| 1340 |
+
|
| 1341 |
+
"""""""""""""""""""""
|
| 1342 |
+
audioset restrictions
|
| 1343 |
+
"""""""""""""""""""""
|
| 1344 |
+
|
| 1345 |
+
.. note:: |mod-lock|
|
| 1346 |
+
|
| 1347 |
+
**Syntax**
|
| 1348 |
+
|
| 1349 |
+
.. code-block:: none
|
| 1350 |
+
|
| 1351 |
+
[p]audioset restrictions
|
| 1352 |
+
|
| 1353 |
+
**Description**
|
| 1354 |
+
|
| 1355 |
+
Manages the keyword whitelist and blacklist.
|
| 1356 |
+
|
| 1357 |
+
.. _audio-command-audioset-restrictions-blacklist:
|
| 1358 |
+
|
| 1359 |
+
"""""""""""""""""""""""""""""""
|
| 1360 |
+
audioset restrictions blacklist
|
| 1361 |
+
"""""""""""""""""""""""""""""""
|
| 1362 |
+
|
| 1363 |
+
**Syntax**
|
| 1364 |
+
|
| 1365 |
+
.. code-block:: none
|
| 1366 |
+
|
| 1367 |
+
[p]audioset restrictions blacklist
|
| 1368 |
+
|
| 1369 |
+
**Description**
|
| 1370 |
+
|
| 1371 |
+
Manages the keyword blacklist.
|
| 1372 |
+
|
| 1373 |
+
.. _audio-command-audioset-restrictions-blacklist-add:
|
| 1374 |
+
|
| 1375 |
+
"""""""""""""""""""""""""""""""""""
|
| 1376 |
+
audioset restrictions blacklist add
|
| 1377 |
+
"""""""""""""""""""""""""""""""""""
|
| 1378 |
+
|
| 1379 |
+
**Syntax**
|
| 1380 |
+
|
| 1381 |
+
.. code-block:: none
|
| 1382 |
+
|
| 1383 |
+
[p]audioset restrictions blacklist add <keyword>
|
| 1384 |
+
|
| 1385 |
+
**Description**
|
| 1386 |
+
|
| 1387 |
+
Adds a keyword to the blacklist.
|
| 1388 |
+
|
| 1389 |
+
.. _audio-command-audioset-restrictions-blacklist-clear:
|
| 1390 |
+
|
| 1391 |
+
"""""""""""""""""""""""""""""""""""""
|
| 1392 |
+
audioset restrictions blacklist clear
|
| 1393 |
+
"""""""""""""""""""""""""""""""""""""
|
| 1394 |
+
|
| 1395 |
+
**Syntax**
|
| 1396 |
+
|
| 1397 |
+
.. code-block:: none
|
| 1398 |
+
|
| 1399 |
+
[p]audioset restrictions blacklist clear
|
| 1400 |
+
|
| 1401 |
+
**Description**
|
| 1402 |
+
|
| 1403 |
+
Clear all keywords added to the blacklist.
|
| 1404 |
+
|
| 1405 |
+
.. _audio-command-audioset-restrictions-blacklist-delete:
|
| 1406 |
+
|
| 1407 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1408 |
+
audioset restrictions blacklist delete
|
| 1409 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1410 |
+
|
| 1411 |
+
**Syntax**
|
| 1412 |
+
|
| 1413 |
+
.. code-block:: none
|
| 1414 |
+
|
| 1415 |
+
[p]audioset restrictions blacklist delete <keyword>
|
| 1416 |
+
|
| 1417 |
+
**Description**
|
| 1418 |
+
|
| 1419 |
+
Removes a keyword from the blacklist.
|
| 1420 |
+
|
| 1421 |
+
.. _audio-command-audioset-restrictions-blacklist-list:
|
| 1422 |
+
|
| 1423 |
+
""""""""""""""""""""""""""""""""""""
|
| 1424 |
+
audioset restrictions blacklist list
|
| 1425 |
+
""""""""""""""""""""""""""""""""""""
|
| 1426 |
+
|
| 1427 |
+
**Syntax**
|
| 1428 |
+
|
| 1429 |
+
.. code-block:: none
|
| 1430 |
+
|
| 1431 |
+
[p]audioset restrictions blacklist list
|
| 1432 |
+
|
| 1433 |
+
**Description**
|
| 1434 |
+
|
| 1435 |
+
List all keywords added to the blacklist.
|
| 1436 |
+
|
| 1437 |
+
.. _audio-command-audioset-restrictions-global:
|
| 1438 |
+
|
| 1439 |
+
""""""""""""""""""""""""""""
|
| 1440 |
+
audioset restrictions global
|
| 1441 |
+
""""""""""""""""""""""""""""
|
| 1442 |
+
|
| 1443 |
+
.. note:: |owner-lock|
|
| 1444 |
+
|
| 1445 |
+
**Syntax**
|
| 1446 |
+
|
| 1447 |
+
.. code-block:: none
|
| 1448 |
+
|
| 1449 |
+
[p]audioset restrictions global
|
| 1450 |
+
|
| 1451 |
+
**Description**
|
| 1452 |
+
|
| 1453 |
+
Manages the global keyword whitelist/blacklist.
|
| 1454 |
+
|
| 1455 |
+
.. _audio-command-audioset-restrictions-global-blacklist:
|
| 1456 |
+
|
| 1457 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1458 |
+
audioset restrictions global blacklist
|
| 1459 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1460 |
+
|
| 1461 |
+
**Syntax**
|
| 1462 |
+
|
| 1463 |
+
.. code-block:: none
|
| 1464 |
+
|
| 1465 |
+
[p]audioset restrictions global blacklist
|
| 1466 |
+
|
| 1467 |
+
**Description**
|
| 1468 |
+
|
| 1469 |
+
Manages the global keyword blacklist.
|
| 1470 |
+
|
| 1471 |
+
.. _audio-command-audioset-restrictions-global-blacklist-add:
|
| 1472 |
+
|
| 1473 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 1474 |
+
audioset restrictions global blacklist add
|
| 1475 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 1476 |
+
|
| 1477 |
+
**Syntax**
|
| 1478 |
+
|
| 1479 |
+
.. code-block:: none
|
| 1480 |
+
|
| 1481 |
+
[p]audioset restrictions global blacklist add <keyword>
|
| 1482 |
+
|
| 1483 |
+
**Description**
|
| 1484 |
+
|
| 1485 |
+
Adds a keyword to the blacklist.
|
| 1486 |
+
|
| 1487 |
+
.. _audio-command-audioset-restrictions-global-blacklist-clear:
|
| 1488 |
+
|
| 1489 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 1490 |
+
audioset restrictions global blacklist clear
|
| 1491 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 1492 |
+
|
| 1493 |
+
**Syntax**
|
| 1494 |
+
|
| 1495 |
+
.. code-block:: none
|
| 1496 |
+
|
| 1497 |
+
[p]audioset restrictions global blacklist clear
|
| 1498 |
+
|
| 1499 |
+
**Description**
|
| 1500 |
+
|
| 1501 |
+
Clear all keywords added to the blacklist.
|
| 1502 |
+
|
| 1503 |
+
.. _audio-command-audioset-restrictions-global-blacklist-delete:
|
| 1504 |
+
|
| 1505 |
+
"""""""""""""""""""""""""""""""""""""""""""""
|
| 1506 |
+
audioset restrictions global blacklist delete
|
| 1507 |
+
"""""""""""""""""""""""""""""""""""""""""""""
|
| 1508 |
+
|
| 1509 |
+
**Syntax**
|
| 1510 |
+
|
| 1511 |
+
.. code-block:: none
|
| 1512 |
+
|
| 1513 |
+
[p]audioset restrictions global blacklist delete <keyword>
|
| 1514 |
+
|
| 1515 |
+
**Description**
|
| 1516 |
+
|
| 1517 |
+
Removes a keyword from the blacklist.
|
| 1518 |
+
|
| 1519 |
+
.. _audio-command-audioset-restrictions-global-blacklist-list:
|
| 1520 |
+
|
| 1521 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 1522 |
+
audioset restrictions global blacklist list
|
| 1523 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 1524 |
+
|
| 1525 |
+
**Syntax**
|
| 1526 |
+
|
| 1527 |
+
.. code-block:: none
|
| 1528 |
+
|
| 1529 |
+
[p]audioset restrictions global blacklist list
|
| 1530 |
+
|
| 1531 |
+
**Description**
|
| 1532 |
+
|
| 1533 |
+
List all keywords added to the blacklist.
|
| 1534 |
+
|
| 1535 |
+
.. _audio-command-audioset-restrictions-global-whitelist:
|
| 1536 |
+
|
| 1537 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1538 |
+
audioset restrictions global whitelist
|
| 1539 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1540 |
+
|
| 1541 |
+
**Syntax**
|
| 1542 |
+
|
| 1543 |
+
.. code-block:: none
|
| 1544 |
+
|
| 1545 |
+
[p]audioset restrictions global whitelist
|
| 1546 |
+
|
| 1547 |
+
**Description**
|
| 1548 |
+
|
| 1549 |
+
Manages the global keyword whitelist.
|
| 1550 |
+
|
| 1551 |
+
.. _audio-command-audioset-restrictions-global-whitelist-add:
|
| 1552 |
+
|
| 1553 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 1554 |
+
audioset restrictions global whitelist add
|
| 1555 |
+
""""""""""""""""""""""""""""""""""""""""""
|
| 1556 |
+
|
| 1557 |
+
**Syntax**
|
| 1558 |
+
|
| 1559 |
+
.. code-block:: none
|
| 1560 |
+
|
| 1561 |
+
[p]audioset restrictions global whitelist add <keyword>
|
| 1562 |
+
|
| 1563 |
+
**Description**
|
| 1564 |
+
|
| 1565 |
+
Adds a keyword to the whitelist. If anything is added to whitelist,
|
| 1566 |
+
it will blacklist everything else.
|
| 1567 |
+
|
| 1568 |
+
.. _audio-command-audioset-restrictions-global-whitelist-clear:
|
| 1569 |
+
|
| 1570 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 1571 |
+
audioset restrictions global whitelist clear
|
| 1572 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 1573 |
+
|
| 1574 |
+
**Syntax**
|
| 1575 |
+
|
| 1576 |
+
.. code-block:: none
|
| 1577 |
+
|
| 1578 |
+
[p]audioset restrictions global whitelist clear
|
| 1579 |
+
|
| 1580 |
+
**Description**
|
| 1581 |
+
|
| 1582 |
+
Clear all keywords from the whitelist.
|
| 1583 |
+
|
| 1584 |
+
.. _audio-command-audioset-restrictions-global-whitelist-delete:
|
| 1585 |
+
|
| 1586 |
+
"""""""""""""""""""""""""""""""""""""""""""""
|
| 1587 |
+
audioset restrictions global whitelist delete
|
| 1588 |
+
"""""""""""""""""""""""""""""""""""""""""""""
|
| 1589 |
+
|
| 1590 |
+
**Syntax**
|
| 1591 |
+
|
| 1592 |
+
.. code-block:: none
|
| 1593 |
+
|
| 1594 |
+
[p]audioset restrictions global whitelist delete <keyword>
|
| 1595 |
+
|
| 1596 |
+
**Description**
|
| 1597 |
+
|
| 1598 |
+
Removes a keyword from the whitelist.
|
| 1599 |
+
|
| 1600 |
+
.. _audio-command-audioset-restrictions-global-whitelist-list:
|
| 1601 |
+
|
| 1602 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 1603 |
+
audioset restrictions global whitelist list
|
| 1604 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 1605 |
+
|
| 1606 |
+
**Syntax**
|
| 1607 |
+
|
| 1608 |
+
.. code-block:: none
|
| 1609 |
+
|
| 1610 |
+
[p]audioset restrictions global whitelist list
|
| 1611 |
+
|
| 1612 |
+
**Description**
|
| 1613 |
+
|
| 1614 |
+
List all keywords added to the whitelist.
|
| 1615 |
+
|
| 1616 |
+
.. _audio-command-audioset-restrictions-whitelist:
|
| 1617 |
+
|
| 1618 |
+
"""""""""""""""""""""""""""""""
|
| 1619 |
+
audioset restrictions whitelist
|
| 1620 |
+
"""""""""""""""""""""""""""""""
|
| 1621 |
+
|
| 1622 |
+
**Syntax**
|
| 1623 |
+
|
| 1624 |
+
.. code-block:: none
|
| 1625 |
+
|
| 1626 |
+
[p]audioset restrictions whitelist
|
| 1627 |
+
|
| 1628 |
+
**Description**
|
| 1629 |
+
|
| 1630 |
+
Manages the keyword whitelist.
|
| 1631 |
+
|
| 1632 |
+
.. _audio-command-audioset-restrictions-whitelist-add:
|
| 1633 |
+
|
| 1634 |
+
"""""""""""""""""""""""""""""""""""
|
| 1635 |
+
audioset restrictions whitelist add
|
| 1636 |
+
"""""""""""""""""""""""""""""""""""
|
| 1637 |
+
|
| 1638 |
+
**Syntax**
|
| 1639 |
+
|
| 1640 |
+
.. code-block:: none
|
| 1641 |
+
|
| 1642 |
+
[p]audioset restrictions whitelist add <keyword>
|
| 1643 |
+
|
| 1644 |
+
**Description**
|
| 1645 |
+
|
| 1646 |
+
Adds a keyword to the whitelist. If anything is added to whitelist,
|
| 1647 |
+
it will blacklist everything else.
|
| 1648 |
+
|
| 1649 |
+
.. _audio-command-audioset-restrictions-whitelist-clear:
|
| 1650 |
+
|
| 1651 |
+
"""""""""""""""""""""""""""""""""""""
|
| 1652 |
+
audioset restrictions whitelist clear
|
| 1653 |
+
"""""""""""""""""""""""""""""""""""""
|
| 1654 |
+
|
| 1655 |
+
**Syntax**
|
| 1656 |
+
|
| 1657 |
+
.. code-block:: none
|
| 1658 |
+
|
| 1659 |
+
[p]audioset restrictions whitelist clear
|
| 1660 |
+
|
| 1661 |
+
**Description**
|
| 1662 |
+
|
| 1663 |
+
Clear all keywords from the whitelist.
|
| 1664 |
+
|
| 1665 |
+
.. _audio-command-audioset-restrictions-whitelist-delete:
|
| 1666 |
+
|
| 1667 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1668 |
+
audioset restrictions whitelist delete
|
| 1669 |
+
""""""""""""""""""""""""""""""""""""""
|
| 1670 |
+
|
| 1671 |
+
**Syntax**
|
| 1672 |
+
|
| 1673 |
+
.. code-block:: none
|
| 1674 |
+
|
| 1675 |
+
[p]audioset restrictions whitelist delete <keyword>
|
| 1676 |
+
|
| 1677 |
+
**Description**
|
| 1678 |
+
|
| 1679 |
+
Removes a keyword from the whitelist.
|
| 1680 |
+
|
| 1681 |
+
.. _audio-command-audioset-restrictions-whitelist-list:
|
| 1682 |
+
|
| 1683 |
+
""""""""""""""""""""""""""""""""""""
|
| 1684 |
+
audioset restrictions whitelist list
|
| 1685 |
+
""""""""""""""""""""""""""""""""""""
|
| 1686 |
+
|
| 1687 |
+
**Syntax**
|
| 1688 |
+
|
| 1689 |
+
.. code-block:: none
|
| 1690 |
+
|
| 1691 |
+
[p]audioset restrictions whitelist list
|
| 1692 |
+
|
| 1693 |
+
**Description**
|
| 1694 |
+
|
| 1695 |
+
List all keywords added to the whitelist.
|
| 1696 |
+
|
| 1697 |
+
.. _audio-command-audioset-role:
|
| 1698 |
+
|
| 1699 |
+
"""""""""""""
|
| 1700 |
+
audioset role
|
| 1701 |
+
"""""""""""""
|
| 1702 |
+
|
| 1703 |
+
.. note:: |admin-lock|
|
| 1704 |
+
|
| 1705 |
+
**Syntax**
|
| 1706 |
+
|
| 1707 |
+
.. code-block:: none
|
| 1708 |
+
|
| 1709 |
+
[p]audioset role <role_name>
|
| 1710 |
+
|
| 1711 |
+
**Description**
|
| 1712 |
+
|
| 1713 |
+
Set the role to use for DJ mode.
|
| 1714 |
+
|
| 1715 |
+
.. _audio-command-audioset-settings:
|
| 1716 |
+
|
| 1717 |
+
"""""""""""""""""
|
| 1718 |
+
audioset settings
|
| 1719 |
+
"""""""""""""""""
|
| 1720 |
+
|
| 1721 |
+
**Syntax**
|
| 1722 |
+
|
| 1723 |
+
.. code-block:: none
|
| 1724 |
+
|
| 1725 |
+
[p]audioset settings
|
| 1726 |
+
|
| 1727 |
+
**Description**
|
| 1728 |
+
|
| 1729 |
+
Show the current settings.
|
| 1730 |
+
|
| 1731 |
+
.. _audio-command-audioset-spotifyapi:
|
| 1732 |
+
|
| 1733 |
+
"""""""""""""""""""
|
| 1734 |
+
audioset spotifyapi
|
| 1735 |
+
"""""""""""""""""""
|
| 1736 |
+
|
| 1737 |
+
.. note:: |owner-lock|
|
| 1738 |
+
|
| 1739 |
+
**Syntax**
|
| 1740 |
+
|
| 1741 |
+
.. code-block:: none
|
| 1742 |
+
|
| 1743 |
+
[p]audioset spotifyapi
|
| 1744 |
+
|
| 1745 |
+
**Description**
|
| 1746 |
+
|
| 1747 |
+
Instructions to set the Spotify API tokens.
|
| 1748 |
+
|
| 1749 |
+
.. _audio-command-audioset-status:
|
| 1750 |
+
|
| 1751 |
+
"""""""""""""""
|
| 1752 |
+
audioset status
|
| 1753 |
+
"""""""""""""""
|
| 1754 |
+
|
| 1755 |
+
.. note:: |owner-lock|
|
| 1756 |
+
|
| 1757 |
+
**Syntax**
|
| 1758 |
+
|
| 1759 |
+
.. code-block:: none
|
| 1760 |
+
|
| 1761 |
+
[p]audioset status
|
| 1762 |
+
|
| 1763 |
+
**Description**
|
| 1764 |
+
|
| 1765 |
+
Enable/disable tracks' titles as status.
|
| 1766 |
+
|
| 1767 |
+
.. _audio-command-audioset-thumbnail:
|
| 1768 |
+
|
| 1769 |
+
""""""""""""""""""
|
| 1770 |
+
audioset thumbnail
|
| 1771 |
+
""""""""""""""""""
|
| 1772 |
+
|
| 1773 |
+
.. note:: |mod-lock|
|
| 1774 |
+
|
| 1775 |
+
**Syntax**
|
| 1776 |
+
|
| 1777 |
+
.. code-block:: none
|
| 1778 |
+
|
| 1779 |
+
[p]audioset thumbnail
|
| 1780 |
+
|
| 1781 |
+
**Description**
|
| 1782 |
+
|
| 1783 |
+
Toggle displaying a thumbnail on audio messages.
|
| 1784 |
+
|
| 1785 |
+
.. _audio-command-audioset-vote:
|
| 1786 |
+
|
| 1787 |
+
"""""""""""""
|
| 1788 |
+
audioset vote
|
| 1789 |
+
"""""""""""""
|
| 1790 |
+
|
| 1791 |
+
.. note:: |mod-lock|
|
| 1792 |
+
|
| 1793 |
+
**Syntax**
|
| 1794 |
+
|
| 1795 |
+
.. code-block:: none
|
| 1796 |
+
|
| 1797 |
+
[p]audioset vote <percent>
|
| 1798 |
+
|
| 1799 |
+
**Description**
|
| 1800 |
+
|
| 1801 |
+
Percentage needed for non-mods to skip tracks, 0 to disable.
|
| 1802 |
+
|
| 1803 |
+
.. _audio-command-audioset-youtubeapi:
|
| 1804 |
+
|
| 1805 |
+
"""""""""""""""""""
|
| 1806 |
+
audioset youtubeapi
|
| 1807 |
+
"""""""""""""""""""
|
| 1808 |
+
|
| 1809 |
+
.. note:: |owner-lock|
|
| 1810 |
+
|
| 1811 |
+
**Syntax**
|
| 1812 |
+
|
| 1813 |
+
.. code-block:: none
|
| 1814 |
+
|
| 1815 |
+
[p]audioset youtubeapi
|
| 1816 |
+
|
| 1817 |
+
**Description**
|
| 1818 |
+
|
| 1819 |
+
Instructions to set the YouTube API key.
|
| 1820 |
+
|
| 1821 |
+
.. _audio-command-audiostats:
|
| 1822 |
+
|
| 1823 |
+
^^^^^^^^^^
|
| 1824 |
+
audiostats
|
| 1825 |
+
^^^^^^^^^^
|
| 1826 |
+
|
| 1827 |
+
.. note:: |owner-lock|
|
| 1828 |
+
|
| 1829 |
+
**Syntax**
|
| 1830 |
+
|
| 1831 |
+
.. code-block:: none
|
| 1832 |
+
|
| 1833 |
+
[p]audiostats
|
| 1834 |
+
|
| 1835 |
+
**Description**
|
| 1836 |
+
|
| 1837 |
+
Audio stats.
|
| 1838 |
+
|
| 1839 |
+
.. _audio-command-autoplay:
|
| 1840 |
+
|
| 1841 |
+
^^^^^^^^
|
| 1842 |
+
autoplay
|
| 1843 |
+
^^^^^^^^
|
| 1844 |
+
|
| 1845 |
+
.. note:: |mod-lock|
|
| 1846 |
+
|
| 1847 |
+
**Syntax**
|
| 1848 |
+
|
| 1849 |
+
.. code-block:: none
|
| 1850 |
+
|
| 1851 |
+
[p]autoplay
|
| 1852 |
+
|
| 1853 |
+
**Description**
|
| 1854 |
+
|
| 1855 |
+
Starts auto play.
|
| 1856 |
+
|
| 1857 |
+
.. _audio-command-bump:
|
| 1858 |
+
|
| 1859 |
+
^^^^
|
| 1860 |
+
bump
|
| 1861 |
+
^^^^
|
| 1862 |
+
|
| 1863 |
+
**Syntax**
|
| 1864 |
+
|
| 1865 |
+
.. code-block:: none
|
| 1866 |
+
|
| 1867 |
+
[p]bump <index>
|
| 1868 |
+
|
| 1869 |
+
**Description**
|
| 1870 |
+
|
| 1871 |
+
Bump a track number to the top of the queue.
|
| 1872 |
+
|
| 1873 |
+
.. _audio-command-bumpplay:
|
| 1874 |
+
|
| 1875 |
+
^^^^^^^^
|
| 1876 |
+
bumpplay
|
| 1877 |
+
^^^^^^^^
|
| 1878 |
+
|
| 1879 |
+
**Syntax**
|
| 1880 |
+
|
| 1881 |
+
.. code-block:: none
|
| 1882 |
+
|
| 1883 |
+
[p]bumpplay [play_now=False] <query>
|
| 1884 |
+
|
| 1885 |
+
**Description**
|
| 1886 |
+
|
| 1887 |
+
Force play a URL or search for a track.
|
| 1888 |
+
|
| 1889 |
+
.. _audio-command-disconnect:
|
| 1890 |
+
|
| 1891 |
+
^^^^^^^^^^
|
| 1892 |
+
disconnect
|
| 1893 |
+
^^^^^^^^^^
|
| 1894 |
+
|
| 1895 |
+
**Syntax**
|
| 1896 |
+
|
| 1897 |
+
.. code-block:: none
|
| 1898 |
+
|
| 1899 |
+
[p]disconnect
|
| 1900 |
+
|
| 1901 |
+
**Description**
|
| 1902 |
+
|
| 1903 |
+
Disconnect from the voice channel.
|
| 1904 |
+
|
| 1905 |
+
.. _audio-command-eq:
|
| 1906 |
+
|
| 1907 |
+
^^
|
| 1908 |
+
eq
|
| 1909 |
+
^^
|
| 1910 |
+
|
| 1911 |
+
**Syntax**
|
| 1912 |
+
|
| 1913 |
+
.. code-block:: none
|
| 1914 |
+
|
| 1915 |
+
[p]eq
|
| 1916 |
+
|
| 1917 |
+
**Description**
|
| 1918 |
+
|
| 1919 |
+
Equalizer management.
|
| 1920 |
+
|
| 1921 |
+
Band positions are 1-15 and values have a range of -0.25 to 1.0.
|
| 1922 |
+
Band names are 25, 40, 63, 100, 160, 250, 400, 630, 1k, 1.6k, 2.5k, 4k,
|
| 1923 |
+
6.3k, 10k, and 16k Hz.
|
| 1924 |
+
Setting a band value to -0.25 nullifies it while +0.25 is double.
|
| 1925 |
+
|
| 1926 |
+
.. _audio-command-eq-delete:
|
| 1927 |
+
|
| 1928 |
+
"""""""""
|
| 1929 |
+
eq delete
|
| 1930 |
+
"""""""""
|
| 1931 |
+
|
| 1932 |
+
**Syntax**
|
| 1933 |
+
|
| 1934 |
+
.. code-block:: none
|
| 1935 |
+
|
| 1936 |
+
[p]eq delete <eq_preset>
|
| 1937 |
+
|
| 1938 |
+
**Description**
|
| 1939 |
+
|
| 1940 |
+
Delete a saved eq preset.
|
| 1941 |
+
|
| 1942 |
+
.. _audio-command-eq-list:
|
| 1943 |
+
|
| 1944 |
+
"""""""
|
| 1945 |
+
eq list
|
| 1946 |
+
"""""""
|
| 1947 |
+
|
| 1948 |
+
**Syntax**
|
| 1949 |
+
|
| 1950 |
+
.. code-block:: none
|
| 1951 |
+
|
| 1952 |
+
[p]eq list
|
| 1953 |
+
|
| 1954 |
+
**Description**
|
| 1955 |
+
|
| 1956 |
+
List saved eq presets.
|
| 1957 |
+
|
| 1958 |
+
.. _audio-command-eq-load:
|
| 1959 |
+
|
| 1960 |
+
"""""""
|
| 1961 |
+
eq load
|
| 1962 |
+
"""""""
|
| 1963 |
+
|
| 1964 |
+
**Syntax**
|
| 1965 |
+
|
| 1966 |
+
.. code-block:: none
|
| 1967 |
+
|
| 1968 |
+
[p]eq load <eq_preset>
|
| 1969 |
+
|
| 1970 |
+
**Description**
|
| 1971 |
+
|
| 1972 |
+
Load a saved eq preset.
|
| 1973 |
+
|
| 1974 |
+
.. _audio-command-eq-reset:
|
| 1975 |
+
|
| 1976 |
+
""""""""
|
| 1977 |
+
eq reset
|
| 1978 |
+
""""""""
|
| 1979 |
+
|
| 1980 |
+
**Syntax**
|
| 1981 |
+
|
| 1982 |
+
.. code-block:: none
|
| 1983 |
+
|
| 1984 |
+
[p]eq reset
|
| 1985 |
+
|
| 1986 |
+
**Description**
|
| 1987 |
+
|
| 1988 |
+
Reset the eq to 0 across all bands.
|
| 1989 |
+
|
| 1990 |
+
.. _audio-command-eq-save:
|
| 1991 |
+
|
| 1992 |
+
"""""""
|
| 1993 |
+
eq save
|
| 1994 |
+
"""""""
|
| 1995 |
+
|
| 1996 |
+
**Syntax**
|
| 1997 |
+
|
| 1998 |
+
.. code-block:: none
|
| 1999 |
+
|
| 2000 |
+
[p]eq save [eq_preset]
|
| 2001 |
+
|
| 2002 |
+
**Description**
|
| 2003 |
+
|
| 2004 |
+
Save the current eq settings to a preset.
|
| 2005 |
+
|
| 2006 |
+
.. _audio-command-eq-set:
|
| 2007 |
+
|
| 2008 |
+
""""""
|
| 2009 |
+
eq set
|
| 2010 |
+
""""""
|
| 2011 |
+
|
| 2012 |
+
**Syntax**
|
| 2013 |
+
|
| 2014 |
+
.. code-block:: none
|
| 2015 |
+
|
| 2016 |
+
[p]eq set <band_name_or_position> <band_value>
|
| 2017 |
+
|
| 2018 |
+
**Description**
|
| 2019 |
+
|
| 2020 |
+
Set an eq band with a band number or name and value.
|
| 2021 |
+
|
| 2022 |
+
Band positions are 1-15 and values have a range of -0.25 to 1.0.
|
| 2023 |
+
Band names are 25, 40, 63, 100, 160, 250, 400, 630, 1k, 1.6k, 2.5k, 4k,
|
| 2024 |
+
6.3k, 10k, and 16k Hz.
|
| 2025 |
+
Setting a band value to -0.25 nullifies it while +0.25 is double.
|
| 2026 |
+
|
| 2027 |
+
.. _audio-command-genre:
|
| 2028 |
+
|
| 2029 |
+
^^^^^
|
| 2030 |
+
genre
|
| 2031 |
+
^^^^^
|
| 2032 |
+
|
| 2033 |
+
**Syntax**
|
| 2034 |
+
|
| 2035 |
+
.. code-block:: none
|
| 2036 |
+
|
| 2037 |
+
[p]genre
|
| 2038 |
+
|
| 2039 |
+
**Description**
|
| 2040 |
+
|
| 2041 |
+
Pick a Spotify playlist from a list of categories to start playing.
|
| 2042 |
+
|
| 2043 |
+
.. _audio-command-local:
|
| 2044 |
+
|
| 2045 |
+
^^^^^
|
| 2046 |
+
local
|
| 2047 |
+
^^^^^
|
| 2048 |
+
|
| 2049 |
+
**Syntax**
|
| 2050 |
+
|
| 2051 |
+
.. code-block:: none
|
| 2052 |
+
|
| 2053 |
+
[p]local
|
| 2054 |
+
|
| 2055 |
+
**Description**
|
| 2056 |
+
|
| 2057 |
+
Local playback commands.
|
| 2058 |
+
|
| 2059 |
+
.. _audio-command-local-folder:
|
| 2060 |
+
|
| 2061 |
+
""""""""""""
|
| 2062 |
+
local folder
|
| 2063 |
+
""""""""""""
|
| 2064 |
+
|
| 2065 |
+
**Syntax**
|
| 2066 |
+
|
| 2067 |
+
.. code-block:: none
|
| 2068 |
+
|
| 2069 |
+
[p]local folder [folder]
|
| 2070 |
+
|
| 2071 |
+
**Description**
|
| 2072 |
+
|
| 2073 |
+
Play all songs in a localtracks folder.
|
| 2074 |
+
|
| 2075 |
+
**Example usage**
|
| 2076 |
+
|
| 2077 |
+
* ``[p]local folder`` - Open a menu to pick a folder to queue.
|
| 2078 |
+
* ``[p]local folder folder_name`` - Queues all of the tracks inside the folder_name folder.
|
| 2079 |
+
|
| 2080 |
+
.. _audio-command-local-play:
|
| 2081 |
+
|
| 2082 |
+
""""""""""
|
| 2083 |
+
local play
|
| 2084 |
+
""""""""""
|
| 2085 |
+
|
| 2086 |
+
**Syntax**
|
| 2087 |
+
|
| 2088 |
+
.. code-block:: none
|
| 2089 |
+
|
| 2090 |
+
[p]local play
|
| 2091 |
+
|
| 2092 |
+
**Description**
|
| 2093 |
+
|
| 2094 |
+
Play a local track.
|
| 2095 |
+
|
| 2096 |
+
To play a local track, either use the menu to choose a track or enter in the track path directly
|
| 2097 |
+
with the play command. To play an entire folder, use ``[p]help local folder`` for instructions.
|
| 2098 |
+
|
| 2099 |
+
**Example usage**
|
| 2100 |
+
|
| 2101 |
+
* ``[p]local play`` - Open a menu to pick a track.
|
| 2102 |
+
* ``[p]play localtracks\album_folder\song_name.mp3``
|
| 2103 |
+
* ``[p]play album_folder\song_name.mp3`` - Use a direct link relative to the localtracks folder.
|
| 2104 |
+
|
| 2105 |
+
.. _audio-command-local-search:
|
| 2106 |
+
|
| 2107 |
+
""""""""""""
|
| 2108 |
+
local search
|
| 2109 |
+
""""""""""""
|
| 2110 |
+
|
| 2111 |
+
**Syntax**
|
| 2112 |
+
|
| 2113 |
+
.. code-block:: none
|
| 2114 |
+
|
| 2115 |
+
[p]local search <search_words>
|
| 2116 |
+
|
| 2117 |
+
**Description**
|
| 2118 |
+
|
| 2119 |
+
Search for songs across all localtracks folders.
|
| 2120 |
+
|
| 2121 |
+
.. _audio-command-now:
|
| 2122 |
+
|
| 2123 |
+
^^^
|
| 2124 |
+
now
|
| 2125 |
+
^^^
|
| 2126 |
+
|
| 2127 |
+
**Syntax**
|
| 2128 |
+
|
| 2129 |
+
.. code-block:: none
|
| 2130 |
+
|
| 2131 |
+
[p]now
|
| 2132 |
+
|
| 2133 |
+
**Description**
|
| 2134 |
+
|
| 2135 |
+
Now playing.
|
| 2136 |
+
|
| 2137 |
+
.. _audio-command-pause:
|
| 2138 |
+
|
| 2139 |
+
^^^^^
|
| 2140 |
+
pause
|
| 2141 |
+
^^^^^
|
| 2142 |
+
|
| 2143 |
+
**Syntax**
|
| 2144 |
+
|
| 2145 |
+
.. code-block:: none
|
| 2146 |
+
|
| 2147 |
+
[p]pause
|
| 2148 |
+
|
| 2149 |
+
**Description**
|
| 2150 |
+
|
| 2151 |
+
Pause or resume a playing track.
|
| 2152 |
+
|
| 2153 |
+
.. _audio-command-percent:
|
| 2154 |
+
|
| 2155 |
+
^^^^^^^
|
| 2156 |
+
percent
|
| 2157 |
+
^^^^^^^
|
| 2158 |
+
|
| 2159 |
+
**Syntax**
|
| 2160 |
+
|
| 2161 |
+
.. code-block:: none
|
| 2162 |
+
|
| 2163 |
+
[p]percent
|
| 2164 |
+
|
| 2165 |
+
**Description**
|
| 2166 |
+
|
| 2167 |
+
Queue percentage.
|
| 2168 |
+
|
| 2169 |
+
.. _audio-command-play:
|
| 2170 |
+
|
| 2171 |
+
^^^^
|
| 2172 |
+
play
|
| 2173 |
+
^^^^
|
| 2174 |
+
|
| 2175 |
+
**Syntax**
|
| 2176 |
+
|
| 2177 |
+
.. code-block:: none
|
| 2178 |
+
|
| 2179 |
+
[p]play <query>
|
| 2180 |
+
|
| 2181 |
+
**Description**
|
| 2182 |
+
|
| 2183 |
+
Play the specified track or search for a close match.
|
| 2184 |
+
|
| 2185 |
+
To play a local track, the query should be ``<parentfolder>\<filename>``.
|
| 2186 |
+
If you are the bot owner, use ``[p]audioset info`` to display your localtracks path.
|
| 2187 |
+
|
| 2188 |
+
.. _audio-command-playlist:
|
| 2189 |
+
|
| 2190 |
+
^^^^^^^^
|
| 2191 |
+
playlist
|
| 2192 |
+
^^^^^^^^
|
| 2193 |
+
|
| 2194 |
+
**Syntax**
|
| 2195 |
+
|
| 2196 |
+
.. code-block:: none
|
| 2197 |
+
|
| 2198 |
+
[p]playlist
|
| 2199 |
+
|
| 2200 |
+
**Description**
|
| 2201 |
+
|
| 2202 |
+
Playlist configuration options.
|
| 2203 |
+
|
| 2204 |
+
**Scope information**
|
| 2205 |
+
|
| 2206 |
+
* Global: Visible to all users of this bot. Only editable by bot owner.
|
| 2207 |
+
* Guild: Visible to all users in this guild. Editable by bot owner, guild owner,
|
| 2208 |
+
guild admins, guild mods, DJ role and playlist creator.
|
| 2209 |
+
* User: Visible to all bot users, if ``--author`` is passed. Editable by bot owner and playlist creator.
|
| 2210 |
+
|
| 2211 |
+
.. _audio-command-playlist-append:
|
| 2212 |
+
|
| 2213 |
+
"""""""""""""""
|
| 2214 |
+
playlist append
|
| 2215 |
+
"""""""""""""""
|
| 2216 |
+
|
| 2217 |
+
**Syntax**
|
| 2218 |
+
|
| 2219 |
+
.. code-block:: none
|
| 2220 |
+
|
| 2221 |
+
[p]playlist append <playlist_name_OR_id> <track_name_OR_url> [args]
|
| 2222 |
+
|
| 2223 |
+
**Description**
|
| 2224 |
+
|
| 2225 |
+
Add a track URL, playlist link, or quick search to a playlist. The track(s) will be
|
| 2226 |
+
appended to the end of the playlist.
|
| 2227 |
+
|
| 2228 |
+
**Args**
|
| 2229 |
+
|
| 2230 |
+
The following are all optional:
|
| 2231 |
+
|
| 2232 |
+
* --scope <scope>
|
| 2233 |
+
* --author [user]
|
| 2234 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2235 |
+
|
| 2236 |
+
**Scope** is one of the following:
|
| 2237 |
+
|
| 2238 |
+
* Global
|
| 2239 |
+
* Guild
|
| 2240 |
+
* User
|
| 2241 |
+
|
| 2242 |
+
**Author** can be one of the following:
|
| 2243 |
+
|
| 2244 |
+
* User ID
|
| 2245 |
+
* User Mention
|
| 2246 |
+
* User Name#123
|
| 2247 |
+
|
| 2248 |
+
**Guild** can be one of the following:
|
| 2249 |
+
|
| 2250 |
+
* Guild ID
|
| 2251 |
+
* Exact guild name
|
| 2252 |
+
|
| 2253 |
+
**Example usage**
|
| 2254 |
+
|
| 2255 |
+
* ``[p]playlist append MyGuildPlaylist Hello by Adele``
|
| 2256 |
+
* ``[p]playlist append MyGlobalPlaylist Hello by Adele --scope Global``
|
| 2257 |
+
* ``[p]playlist append MyGlobalPlaylist Hello by Adele --scope Global --Author Draper#6666``
|
| 2258 |
+
|
| 2259 |
+
.. _audio-command-playlist-copy:
|
| 2260 |
+
|
| 2261 |
+
"""""""""""""
|
| 2262 |
+
playlist copy
|
| 2263 |
+
"""""""""""""
|
| 2264 |
+
|
| 2265 |
+
**Syntax**
|
| 2266 |
+
|
| 2267 |
+
.. code-block:: none
|
| 2268 |
+
|
| 2269 |
+
[p]playlist copy <id_or_name> [args]
|
| 2270 |
+
|
| 2271 |
+
**Description**
|
| 2272 |
+
|
| 2273 |
+
Copy a playlist from one scope to another.
|
| 2274 |
+
|
| 2275 |
+
**Args**
|
| 2276 |
+
|
| 2277 |
+
The following are all optional:
|
| 2278 |
+
|
| 2279 |
+
* --from-scope <scope>
|
| 2280 |
+
* --from-author [user]
|
| 2281 |
+
* --from-guild [guild] (**only the bot owner can use this**)
|
| 2282 |
+
* --to-scope <scope>
|
| 2283 |
+
* --to-author [user]
|
| 2284 |
+
* --to-guild [guild] (**only the bot owner can use this**)
|
| 2285 |
+
|
| 2286 |
+
**Scope** is one of the following:
|
| 2287 |
+
|
| 2288 |
+
* Global
|
| 2289 |
+
* Guild
|
| 2290 |
+
* User
|
| 2291 |
+
|
| 2292 |
+
**Author** can be one of the following:
|
| 2293 |
+
|
| 2294 |
+
* User ID
|
| 2295 |
+
* User Mention
|
| 2296 |
+
* User Name#123
|
| 2297 |
+
|
| 2298 |
+
**Guild** can be one of the following:
|
| 2299 |
+
|
| 2300 |
+
* Guild ID
|
| 2301 |
+
* Exact guild name
|
| 2302 |
+
|
| 2303 |
+
**Example usage**
|
| 2304 |
+
|
| 2305 |
+
* ``[p]playlist copy MyGuildPlaylist --from-scope Guild --to-scope Global``
|
| 2306 |
+
* ``[p]playlist copy MyGlobalPlaylist --from-scope Global --to-author Draper#6666 --to-scope User``
|
| 2307 |
+
* ``[p]playlist copy MyPersonalPlaylist --from-scope user --to-author Draper#6666 --to-scope Guild --to-guild Red - Discord Bot``
|
| 2308 |
+
|
| 2309 |
+
.. _audio-command-playlist-create:
|
| 2310 |
+
|
| 2311 |
+
"""""""""""""""
|
| 2312 |
+
playlist create
|
| 2313 |
+
"""""""""""""""
|
| 2314 |
+
|
| 2315 |
+
**Syntax**
|
| 2316 |
+
|
| 2317 |
+
.. code-block:: none
|
| 2318 |
+
|
| 2319 |
+
[p]playlist create <name> [args]
|
| 2320 |
+
|
| 2321 |
+
**Description**
|
| 2322 |
+
|
| 2323 |
+
Create an empty playlist.
|
| 2324 |
+
|
| 2325 |
+
**Args**
|
| 2326 |
+
|
| 2327 |
+
The following are all optional:
|
| 2328 |
+
|
| 2329 |
+
* --scope <scope>
|
| 2330 |
+
* --author [user]
|
| 2331 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2332 |
+
|
| 2333 |
+
**Scope** is one of the following:
|
| 2334 |
+
|
| 2335 |
+
* Global
|
| 2336 |
+
* Guild
|
| 2337 |
+
* User
|
| 2338 |
+
|
| 2339 |
+
**Author** can be one of the following:
|
| 2340 |
+
|
| 2341 |
+
* User ID
|
| 2342 |
+
* User Mention
|
| 2343 |
+
* User Name#123
|
| 2344 |
+
|
| 2345 |
+
**Guild** can be one of the following:
|
| 2346 |
+
|
| 2347 |
+
* Guild ID
|
| 2348 |
+
* Exact guild name
|
| 2349 |
+
|
| 2350 |
+
**Example usage**
|
| 2351 |
+
|
| 2352 |
+
* ``[p]playlist create MyGuildPlaylist``
|
| 2353 |
+
* ``[p]playlist create MyGlobalPlaylist --scope Global``
|
| 2354 |
+
* ``[p]playlist create MyPersonalPlaylist --scope User``
|
| 2355 |
+
|
| 2356 |
+
.. _audio-command-playlist-dedupe:
|
| 2357 |
+
|
| 2358 |
+
"""""""""""""""
|
| 2359 |
+
playlist dedupe
|
| 2360 |
+
"""""""""""""""
|
| 2361 |
+
|
| 2362 |
+
**Syntax**
|
| 2363 |
+
|
| 2364 |
+
.. code-block:: none
|
| 2365 |
+
|
| 2366 |
+
[p]playlist dedupe <playlist_name_OR_id> [args]
|
| 2367 |
+
|
| 2368 |
+
**Description**
|
| 2369 |
+
|
| 2370 |
+
Remove duplicate tracks from a saved playlist.
|
| 2371 |
+
|
| 2372 |
+
**Args**
|
| 2373 |
+
|
| 2374 |
+
The following are all optional:
|
| 2375 |
+
|
| 2376 |
+
* --scope <scope>
|
| 2377 |
+
* --author [user]
|
| 2378 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2379 |
+
|
| 2380 |
+
**Scope** is one of the following:
|
| 2381 |
+
|
| 2382 |
+
* Global
|
| 2383 |
+
* Guild
|
| 2384 |
+
* User
|
| 2385 |
+
|
| 2386 |
+
**Author** can be one of the following:
|
| 2387 |
+
|
| 2388 |
+
* User ID
|
| 2389 |
+
* User Mention
|
| 2390 |
+
* User Name#123
|
| 2391 |
+
|
| 2392 |
+
**Guild** can be one of the following:
|
| 2393 |
+
|
| 2394 |
+
* Guild ID
|
| 2395 |
+
* Exact guild name
|
| 2396 |
+
|
| 2397 |
+
**Example usage**
|
| 2398 |
+
|
| 2399 |
+
* ``[p]playlist dedupe MyGuildPlaylist``
|
| 2400 |
+
* ``[p]playlist dedupe MyGlobalPlaylist --scope Global``
|
| 2401 |
+
* ``[p]playlist dedupe MyPersonalPlaylist --scope User``
|
| 2402 |
+
|
| 2403 |
+
.. _audio-command-playlist-delete:
|
| 2404 |
+
|
| 2405 |
+
"""""""""""""""
|
| 2406 |
+
playlist delete
|
| 2407 |
+
"""""""""""""""
|
| 2408 |
+
|
| 2409 |
+
**Syntax**
|
| 2410 |
+
|
| 2411 |
+
.. code-block:: none
|
| 2412 |
+
|
| 2413 |
+
[p]playlist delete <playlist_name_OR_id> [args]
|
| 2414 |
+
|
| 2415 |
+
**Description**
|
| 2416 |
+
|
| 2417 |
+
Delete a saved playlist.
|
| 2418 |
+
|
| 2419 |
+
**Args**
|
| 2420 |
+
|
| 2421 |
+
The following are all optional:
|
| 2422 |
+
|
| 2423 |
+
* --scope <scope>
|
| 2424 |
+
* --author [user]
|
| 2425 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2426 |
+
|
| 2427 |
+
**Scope** is one of the following:
|
| 2428 |
+
|
| 2429 |
+
* Global
|
| 2430 |
+
* Guild
|
| 2431 |
+
* User
|
| 2432 |
+
|
| 2433 |
+
**Author** can be one of the following:
|
| 2434 |
+
|
| 2435 |
+
* User ID
|
| 2436 |
+
* User Mention
|
| 2437 |
+
* User Name#123
|
| 2438 |
+
|
| 2439 |
+
**Guild** can be one of the following:
|
| 2440 |
+
|
| 2441 |
+
* Guild ID
|
| 2442 |
+
* Exact guild name
|
| 2443 |
+
|
| 2444 |
+
**Example usage**
|
| 2445 |
+
|
| 2446 |
+
* ``[p]playlist delete MyGuildPlaylist``
|
| 2447 |
+
* ``[p]playlist delete MyGlobalPlaylist --scope Global``
|
| 2448 |
+
* ``[p]playlist delete MyPersonalPlaylist --scope User``
|
| 2449 |
+
|
| 2450 |
+
.. _audio-command-playlist-download:
|
| 2451 |
+
|
| 2452 |
+
"""""""""""""""""
|
| 2453 |
+
playlist download
|
| 2454 |
+
"""""""""""""""""
|
| 2455 |
+
|
| 2456 |
+
.. note:: |owner-lock|
|
| 2457 |
+
|
| 2458 |
+
**Syntax**
|
| 2459 |
+
|
| 2460 |
+
.. code-block:: none
|
| 2461 |
+
|
| 2462 |
+
[p]playlist download <playlist_name_OR_id> [v2=False] [args]
|
| 2463 |
+
|
| 2464 |
+
**Description**
|
| 2465 |
+
|
| 2466 |
+
Download a copy of a playlist.
|
| 2467 |
+
|
| 2468 |
+
These files can be used with the ``[p]playlist upload`` command.
|
| 2469 |
+
Red v2-compatible playlists can be generated by passing True
|
| 2470 |
+
for the v2 variable.
|
| 2471 |
+
|
| 2472 |
+
**Args**
|
| 2473 |
+
|
| 2474 |
+
The following are all optional:
|
| 2475 |
+
|
| 2476 |
+
* --scope <scope>
|
| 2477 |
+
* --author [user]
|
| 2478 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2479 |
+
|
| 2480 |
+
**Scope** is one of the following:
|
| 2481 |
+
|
| 2482 |
+
* Global
|
| 2483 |
+
* Guild
|
| 2484 |
+
* User
|
| 2485 |
+
|
| 2486 |
+
**Author** can be one of the following:
|
| 2487 |
+
|
| 2488 |
+
* User ID
|
| 2489 |
+
* User Mention
|
| 2490 |
+
* User Name#123
|
| 2491 |
+
|
| 2492 |
+
**Guild** can be one of the following:
|
| 2493 |
+
|
| 2494 |
+
* Guild ID
|
| 2495 |
+
* Exact guild name
|
| 2496 |
+
|
| 2497 |
+
**Example usage**
|
| 2498 |
+
|
| 2499 |
+
* ``[p]playlist download MyGuildPlaylist True``
|
| 2500 |
+
* ``[p]playlist download MyGlobalPlaylist False --scope Global``
|
| 2501 |
+
* ``[p]playlist download MyPersonalPlaylist --scope User``
|
| 2502 |
+
|
| 2503 |
+
.. _audio-command-playlist-info:
|
| 2504 |
+
|
| 2505 |
+
"""""""""""""
|
| 2506 |
+
playlist info
|
| 2507 |
+
"""""""""""""
|
| 2508 |
+
|
| 2509 |
+
**Syntax**
|
| 2510 |
+
|
| 2511 |
+
.. code-block:: none
|
| 2512 |
+
|
| 2513 |
+
[p]playlist info <playlist_name_OR_id> [args]
|
| 2514 |
+
|
| 2515 |
+
**Description**
|
| 2516 |
+
|
| 2517 |
+
Retrieve information from a saved playlist.
|
| 2518 |
+
|
| 2519 |
+
**Args**
|
| 2520 |
+
|
| 2521 |
+
The following are all optional:
|
| 2522 |
+
|
| 2523 |
+
* --scope <scope>
|
| 2524 |
+
* --author [user]
|
| 2525 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2526 |
+
|
| 2527 |
+
**Scope** is one of the following:
|
| 2528 |
+
|
| 2529 |
+
* Global
|
| 2530 |
+
* Guild
|
| 2531 |
+
* User
|
| 2532 |
+
|
| 2533 |
+
**Author** can be one of the following:
|
| 2534 |
+
|
| 2535 |
+
* User ID
|
| 2536 |
+
* User Mention
|
| 2537 |
+
* User Name#123
|
| 2538 |
+
|
| 2539 |
+
**Guild** can be one of the following:
|
| 2540 |
+
|
| 2541 |
+
* Guild ID
|
| 2542 |
+
* Exact guild name
|
| 2543 |
+
|
| 2544 |
+
**Example usage**
|
| 2545 |
+
|
| 2546 |
+
* ``[p]playlist info MyGuildPlaylist``
|
| 2547 |
+
* ``[p]playlist info MyGlobalPlaylist --scope Global``
|
| 2548 |
+
* ``[p]playlist info MyPersonalPlaylist --scope User``
|
| 2549 |
+
|
| 2550 |
+
.. _audio-command-playlist-list:
|
| 2551 |
+
|
| 2552 |
+
"""""""""""""
|
| 2553 |
+
playlist list
|
| 2554 |
+
"""""""""""""
|
| 2555 |
+
|
| 2556 |
+
**Syntax**
|
| 2557 |
+
|
| 2558 |
+
.. code-block:: none
|
| 2559 |
+
|
| 2560 |
+
[p]playlist list [args]
|
| 2561 |
+
|
| 2562 |
+
**Description**
|
| 2563 |
+
|
| 2564 |
+
List saved playlists.
|
| 2565 |
+
|
| 2566 |
+
**Args**
|
| 2567 |
+
|
| 2568 |
+
The following are all optional:
|
| 2569 |
+
|
| 2570 |
+
* --scope <scope>
|
| 2571 |
+
* --author [user]
|
| 2572 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2573 |
+
|
| 2574 |
+
**Scope** is one of the following:
|
| 2575 |
+
|
| 2576 |
+
* Global
|
| 2577 |
+
* Guild
|
| 2578 |
+
* User
|
| 2579 |
+
|
| 2580 |
+
**Author** can be one of the following:
|
| 2581 |
+
|
| 2582 |
+
* User ID
|
| 2583 |
+
* User Mention
|
| 2584 |
+
* User Name#123
|
| 2585 |
+
|
| 2586 |
+
**Guild** can be one of the following:
|
| 2587 |
+
|
| 2588 |
+
* Guild ID
|
| 2589 |
+
* Exact guild name
|
| 2590 |
+
|
| 2591 |
+
**Example usage**
|
| 2592 |
+
|
| 2593 |
+
* ``[p]playlist list``
|
| 2594 |
+
* ``[p]playlist list --scope Global``
|
| 2595 |
+
* ``[p]playlist list --scope User``
|
| 2596 |
+
|
| 2597 |
+
.. _audio-command-playlist-queue:
|
| 2598 |
+
|
| 2599 |
+
""""""""""""""
|
| 2600 |
+
playlist queue
|
| 2601 |
+
""""""""""""""
|
| 2602 |
+
|
| 2603 |
+
**Syntax**
|
| 2604 |
+
|
| 2605 |
+
.. code-block:: none
|
| 2606 |
+
|
| 2607 |
+
[p]playlist queue <name> [args]
|
| 2608 |
+
|
| 2609 |
+
**Description**
|
| 2610 |
+
|
| 2611 |
+
Save the queue to a playlist.
|
| 2612 |
+
|
| 2613 |
+
**Args**
|
| 2614 |
+
|
| 2615 |
+
The following are all optional:
|
| 2616 |
+
|
| 2617 |
+
* --scope <scope>
|
| 2618 |
+
* --author [user]
|
| 2619 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2620 |
+
|
| 2621 |
+
**Scope** is one of the following:
|
| 2622 |
+
|
| 2623 |
+
* Global
|
| 2624 |
+
* Guild
|
| 2625 |
+
* User
|
| 2626 |
+
|
| 2627 |
+
**Author** can be one of the following:
|
| 2628 |
+
|
| 2629 |
+
* User ID
|
| 2630 |
+
* User Mention
|
| 2631 |
+
* User Name#123
|
| 2632 |
+
|
| 2633 |
+
**Guild** can be one of the following:
|
| 2634 |
+
|
| 2635 |
+
* Guild ID
|
| 2636 |
+
* Exact guild name
|
| 2637 |
+
|
| 2638 |
+
**Example usage**
|
| 2639 |
+
|
| 2640 |
+
* ``[p]playlist queue MyGuildPlaylist``
|
| 2641 |
+
* ``[p]playlist queue MyGlobalPlaylist --scope Global``
|
| 2642 |
+
* ``[p]playlist queue MyPersonalPlaylist --scope User``
|
| 2643 |
+
|
| 2644 |
+
.. _audio-command-playlist-remove:
|
| 2645 |
+
|
| 2646 |
+
"""""""""""""""
|
| 2647 |
+
playlist remove
|
| 2648 |
+
"""""""""""""""
|
| 2649 |
+
|
| 2650 |
+
**Syntax**
|
| 2651 |
+
|
| 2652 |
+
.. code-block:: none
|
| 2653 |
+
|
| 2654 |
+
[p]playlist remove <playlist_name_OR_id> <url> [args]
|
| 2655 |
+
|
| 2656 |
+
**Description**
|
| 2657 |
+
|
| 2658 |
+
Remove a track from a playlist by URL.
|
| 2659 |
+
|
| 2660 |
+
**Args**
|
| 2661 |
+
|
| 2662 |
+
The following are all optional:
|
| 2663 |
+
|
| 2664 |
+
* --scope <scope>
|
| 2665 |
+
* --author [user]
|
| 2666 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2667 |
+
|
| 2668 |
+
**Scope** is one of the following:
|
| 2669 |
+
|
| 2670 |
+
* Global
|
| 2671 |
+
* Guild
|
| 2672 |
+
* User
|
| 2673 |
+
|
| 2674 |
+
**Author** can be one of the following:
|
| 2675 |
+
|
| 2676 |
+
* User ID
|
| 2677 |
+
* User Mention
|
| 2678 |
+
* User Name#123
|
| 2679 |
+
|
| 2680 |
+
**Guild** can be one of the following:
|
| 2681 |
+
|
| 2682 |
+
* Guild ID
|
| 2683 |
+
* Exact guild name
|
| 2684 |
+
|
| 2685 |
+
**Example usage**
|
| 2686 |
+
|
| 2687 |
+
* ``[p]playlist remove MyGuildPlaylist https://www.youtube.com/watch?v=MN3x-kAbgFU``
|
| 2688 |
+
* ``[p]playlist remove MyGlobalPlaylist https://www.youtube.com/watch?v=MN3x-kAbgFU --scope Global``
|
| 2689 |
+
* ``[p]playlist remove MyPersonalPlaylist https://www.youtube.com/watch?v=MN3x-kAbgFU --scope User``
|
| 2690 |
+
|
| 2691 |
+
.. _audio-command-playlist-rename:
|
| 2692 |
+
|
| 2693 |
+
"""""""""""""""
|
| 2694 |
+
playlist rename
|
| 2695 |
+
"""""""""""""""
|
| 2696 |
+
|
| 2697 |
+
**Syntax**
|
| 2698 |
+
|
| 2699 |
+
.. code-block:: none
|
| 2700 |
+
|
| 2701 |
+
[p]playlist rename <playlist_name_OR_id> <new_name> [args]
|
| 2702 |
+
|
| 2703 |
+
**Description**
|
| 2704 |
+
|
| 2705 |
+
Rename an existing playlist.
|
| 2706 |
+
|
| 2707 |
+
**Args**
|
| 2708 |
+
|
| 2709 |
+
The following are all optional:
|
| 2710 |
+
|
| 2711 |
+
* --scope <scope>
|
| 2712 |
+
* --author [user]
|
| 2713 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2714 |
+
|
| 2715 |
+
**Scope** is one of the following:
|
| 2716 |
+
|
| 2717 |
+
* Global
|
| 2718 |
+
* Guild
|
| 2719 |
+
* User
|
| 2720 |
+
|
| 2721 |
+
**Author** can be one of the following:
|
| 2722 |
+
|
| 2723 |
+
* User ID
|
| 2724 |
+
* User Mention
|
| 2725 |
+
* User Name#123
|
| 2726 |
+
|
| 2727 |
+
**Guild** can be one of the following:
|
| 2728 |
+
|
| 2729 |
+
* Guild ID
|
| 2730 |
+
* Exact guild name
|
| 2731 |
+
|
| 2732 |
+
**Example usage**
|
| 2733 |
+
|
| 2734 |
+
* ``[p]playlist rename MyGuildPlaylist RenamedGuildPlaylist``
|
| 2735 |
+
* ``[p]playlist rename MyGlobalPlaylist RenamedGlobalPlaylist --scope Global``
|
| 2736 |
+
* ``[p]playlist rename MyPersonalPlaylist RenamedPersonalPlaylist --scope User``
|
| 2737 |
+
|
| 2738 |
+
.. _audio-command-playlist-save:
|
| 2739 |
+
|
| 2740 |
+
"""""""""""""
|
| 2741 |
+
playlist save
|
| 2742 |
+
"""""""""""""
|
| 2743 |
+
|
| 2744 |
+
**Syntax**
|
| 2745 |
+
|
| 2746 |
+
.. code-block:: none
|
| 2747 |
+
|
| 2748 |
+
[p]playlist save <name> <url> [args]
|
| 2749 |
+
|
| 2750 |
+
**Description**
|
| 2751 |
+
|
| 2752 |
+
Save a playlist from a URL.
|
| 2753 |
+
|
| 2754 |
+
The following are all optional:
|
| 2755 |
+
|
| 2756 |
+
* --scope <scope>
|
| 2757 |
+
* --author [user]
|
| 2758 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2759 |
+
|
| 2760 |
+
**Scope** is one of the following:
|
| 2761 |
+
|
| 2762 |
+
* Global
|
| 2763 |
+
* Guild
|
| 2764 |
+
* User
|
| 2765 |
+
|
| 2766 |
+
**Author** can be one of the following:
|
| 2767 |
+
|
| 2768 |
+
* User ID
|
| 2769 |
+
* User Mention
|
| 2770 |
+
* User Name#123
|
| 2771 |
+
|
| 2772 |
+
**Guild** can be one of the following:
|
| 2773 |
+
|
| 2774 |
+
* Guild ID
|
| 2775 |
+
* Exact guild name
|
| 2776 |
+
|
| 2777 |
+
**Example usage**
|
| 2778 |
+
|
| 2779 |
+
* ``[p]playlist save MyGuildPlaylist https://www.youtube.com/playlist?list=PLx0sYbCqOb8Q_CLZC2BdBSKEEB59BOPUM``
|
| 2780 |
+
* ``[p]playlist save MyGlobalPlaylist https://www.youtube.com/playlist?list=PLx0sYbCqOb8Q_CLZC2BdBSKEEB59BOPUM --scope Global``
|
| 2781 |
+
* ``[p]playlist save MyPersonalPlaylist https://open.spotify.com/playlist/1RyeIbyFeIJVnNzlGr5KkR --scope User``
|
| 2782 |
+
|
| 2783 |
+
.. _audio-command-playlist-start:
|
| 2784 |
+
|
| 2785 |
+
""""""""""""""
|
| 2786 |
+
playlist start
|
| 2787 |
+
""""""""""""""
|
| 2788 |
+
|
| 2789 |
+
**Syntax**
|
| 2790 |
+
|
| 2791 |
+
.. code-block:: none
|
| 2792 |
+
|
| 2793 |
+
[p]playlist start <playlist_name_OR_id> [args]
|
| 2794 |
+
|
| 2795 |
+
**Description**
|
| 2796 |
+
|
| 2797 |
+
Load a playlist into the queue.
|
| 2798 |
+
|
| 2799 |
+
**Args**
|
| 2800 |
+
|
| 2801 |
+
The following are all optional:
|
| 2802 |
+
|
| 2803 |
+
* --scope <scope>
|
| 2804 |
+
* --author [user]
|
| 2805 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2806 |
+
|
| 2807 |
+
**Scope** is one of the following:
|
| 2808 |
+
|
| 2809 |
+
* Global
|
| 2810 |
+
* Guild
|
| 2811 |
+
* User
|
| 2812 |
+
|
| 2813 |
+
**Author** can be one of the following:
|
| 2814 |
+
|
| 2815 |
+
* User ID
|
| 2816 |
+
* User Mention
|
| 2817 |
+
* User Name#123
|
| 2818 |
+
|
| 2819 |
+
**Guild** can be one of the following:
|
| 2820 |
+
|
| 2821 |
+
* Guild ID
|
| 2822 |
+
* Exact guild name
|
| 2823 |
+
|
| 2824 |
+
**Example usage**
|
| 2825 |
+
|
| 2826 |
+
* ``[p]playlist start MyGuildPlaylist``
|
| 2827 |
+
* ``[p]playlist start MyGlobalPlaylist --scope Global``
|
| 2828 |
+
* ``[p]playlist start MyPersonalPlaylist --scope User``
|
| 2829 |
+
|
| 2830 |
+
.. _audio-command-playlist-update:
|
| 2831 |
+
|
| 2832 |
+
"""""""""""""""
|
| 2833 |
+
playlist update
|
| 2834 |
+
"""""""""""""""
|
| 2835 |
+
|
| 2836 |
+
**Syntax**
|
| 2837 |
+
|
| 2838 |
+
.. code-block:: none
|
| 2839 |
+
|
| 2840 |
+
[p]playlist update <playlist_name_OR_id> [args]
|
| 2841 |
+
|
| 2842 |
+
**Description**
|
| 2843 |
+
|
| 2844 |
+
Updates all tracks in a playlist.
|
| 2845 |
+
|
| 2846 |
+
**Args**
|
| 2847 |
+
|
| 2848 |
+
The following are all optional:
|
| 2849 |
+
|
| 2850 |
+
* --scope <scope>
|
| 2851 |
+
* --author [user]
|
| 2852 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2853 |
+
|
| 2854 |
+
**Scope** is one of the following:
|
| 2855 |
+
|
| 2856 |
+
* Global
|
| 2857 |
+
* Guild
|
| 2858 |
+
* User
|
| 2859 |
+
|
| 2860 |
+
**Author** can be one of the following:
|
| 2861 |
+
|
| 2862 |
+
* User ID
|
| 2863 |
+
* User Mention
|
| 2864 |
+
* User Name#123
|
| 2865 |
+
|
| 2866 |
+
**Guild** can be one of the following:
|
| 2867 |
+
|
| 2868 |
+
* Guild ID
|
| 2869 |
+
* Exact guild name
|
| 2870 |
+
|
| 2871 |
+
**Example usage**
|
| 2872 |
+
|
| 2873 |
+
* ``[p]playlist update MyGuildPlaylist``
|
| 2874 |
+
* ``[p]playlist update MyGlobalPlaylist --scope Global``
|
| 2875 |
+
* ``[p]playlist update MyPersonalPlaylist --scope User``
|
| 2876 |
+
|
| 2877 |
+
.. _audio-command-playlist-upload:
|
| 2878 |
+
|
| 2879 |
+
"""""""""""""""
|
| 2880 |
+
playlist upload
|
| 2881 |
+
"""""""""""""""
|
| 2882 |
+
|
| 2883 |
+
.. note:: |owner-lock|
|
| 2884 |
+
|
| 2885 |
+
**Syntax**
|
| 2886 |
+
|
| 2887 |
+
.. code-block:: none
|
| 2888 |
+
|
| 2889 |
+
[p]playlist upload [args]
|
| 2890 |
+
|
| 2891 |
+
**Description**
|
| 2892 |
+
|
| 2893 |
+
Uploads a playlist file as a playlist for the bot.
|
| 2894 |
+
|
| 2895 |
+
V2 and old V3 playlist will be slow.
|
| 2896 |
+
V3 Playlist made with ``[p]playlist download`` will load a lot faster.
|
| 2897 |
+
|
| 2898 |
+
**Args**
|
| 2899 |
+
|
| 2900 |
+
The following are all optional:
|
| 2901 |
+
|
| 2902 |
+
* --scope <scope>
|
| 2903 |
+
* --author [user]
|
| 2904 |
+
* --guild [guild] (**only the bot owner can use this**)
|
| 2905 |
+
|
| 2906 |
+
**Scope** is one of the following:
|
| 2907 |
+
|
| 2908 |
+
* Global
|
| 2909 |
+
* Guild
|
| 2910 |
+
* User
|
| 2911 |
+
|
| 2912 |
+
**Author** can be one of the following:
|
| 2913 |
+
|
| 2914 |
+
* User ID
|
| 2915 |
+
* User Mention
|
| 2916 |
+
* User Name#123
|
| 2917 |
+
|
| 2918 |
+
**Guild** can be one of the following:
|
| 2919 |
+
|
| 2920 |
+
* Guild ID
|
| 2921 |
+
* Exact guild name
|
| 2922 |
+
|
| 2923 |
+
**Example usage**
|
| 2924 |
+
|
| 2925 |
+
* ``[p]playlist upload``
|
| 2926 |
+
* ``[p]playlist upload --scope Global``
|
| 2927 |
+
* ``[p]playlist upload --scope User``
|
| 2928 |
+
|
| 2929 |
+
.. _audio-command-prev:
|
| 2930 |
+
|
| 2931 |
+
^^^^
|
| 2932 |
+
prev
|
| 2933 |
+
^^^^
|
| 2934 |
+
|
| 2935 |
+
**Syntax**
|
| 2936 |
+
|
| 2937 |
+
.. code-block:: none
|
| 2938 |
+
|
| 2939 |
+
[p]prev
|
| 2940 |
+
|
| 2941 |
+
**Description**
|
| 2942 |
+
|
| 2943 |
+
Skip to the start of the previously played track.
|
| 2944 |
+
|
| 2945 |
+
.. _audio-command-queue:
|
| 2946 |
+
|
| 2947 |
+
^^^^^
|
| 2948 |
+
queue
|
| 2949 |
+
^^^^^
|
| 2950 |
+
|
| 2951 |
+
**Syntax**
|
| 2952 |
+
|
| 2953 |
+
.. code-block:: none
|
| 2954 |
+
|
| 2955 |
+
[p]queue [page=1]
|
| 2956 |
+
|
| 2957 |
+
**Description**
|
| 2958 |
+
|
| 2959 |
+
List the songs in the queue.
|
| 2960 |
+
|
| 2961 |
+
.. _audio-command-queue-clean:
|
| 2962 |
+
|
| 2963 |
+
"""""""""""
|
| 2964 |
+
queue clean
|
| 2965 |
+
"""""""""""
|
| 2966 |
+
|
| 2967 |
+
**Syntax**
|
| 2968 |
+
|
| 2969 |
+
.. code-block:: none
|
| 2970 |
+
|
| 2971 |
+
[p]queue clean
|
| 2972 |
+
|
| 2973 |
+
**Description**
|
| 2974 |
+
|
| 2975 |
+
Removes songs from the queue if the requester is not in the voice channel.
|
| 2976 |
+
|
| 2977 |
+
.. _audio-command-queue-cleanself:
|
| 2978 |
+
|
| 2979 |
+
"""""""""""""""
|
| 2980 |
+
queue cleanself
|
| 2981 |
+
"""""""""""""""
|
| 2982 |
+
|
| 2983 |
+
**Syntax**
|
| 2984 |
+
|
| 2985 |
+
.. code-block:: none
|
| 2986 |
+
|
| 2987 |
+
[p]queue cleanself
|
| 2988 |
+
|
| 2989 |
+
**Description**
|
| 2990 |
+
|
| 2991 |
+
Removes all tracks you requested from the queue.
|
| 2992 |
+
|
| 2993 |
+
.. _audio-command-queue-clear:
|
| 2994 |
+
|
| 2995 |
+
"""""""""""
|
| 2996 |
+
queue clear
|
| 2997 |
+
"""""""""""
|
| 2998 |
+
|
| 2999 |
+
**Syntax**
|
| 3000 |
+
|
| 3001 |
+
.. code-block:: none
|
| 3002 |
+
|
| 3003 |
+
[p]queue clear
|
| 3004 |
+
|
| 3005 |
+
**Description**
|
| 3006 |
+
|
| 3007 |
+
Clears the queue.
|
| 3008 |
+
|
| 3009 |
+
.. _audio-command-queue-search:
|
| 3010 |
+
|
| 3011 |
+
""""""""""""
|
| 3012 |
+
queue search
|
| 3013 |
+
""""""""""""
|
| 3014 |
+
|
| 3015 |
+
**Syntax**
|
| 3016 |
+
|
| 3017 |
+
.. code-block:: none
|
| 3018 |
+
|
| 3019 |
+
[p]queue search <search_words>
|
| 3020 |
+
|
| 3021 |
+
**Description**
|
| 3022 |
+
|
| 3023 |
+
Search the queue.
|
| 3024 |
+
|
| 3025 |
+
.. _audio-command-queue-shuffle:
|
| 3026 |
+
|
| 3027 |
+
"""""""""""""
|
| 3028 |
+
queue shuffle
|
| 3029 |
+
"""""""""""""
|
| 3030 |
+
|
| 3031 |
+
**Syntax**
|
| 3032 |
+
|
| 3033 |
+
.. code-block:: none
|
| 3034 |
+
|
| 3035 |
+
[p]queue shuffle
|
| 3036 |
+
|
| 3037 |
+
**Description**
|
| 3038 |
+
|
| 3039 |
+
Shuffles the queue.
|
| 3040 |
+
|
| 3041 |
+
.. _audio-command-remove:
|
| 3042 |
+
|
| 3043 |
+
^^^^^^
|
| 3044 |
+
remove
|
| 3045 |
+
^^^^^^
|
| 3046 |
+
|
| 3047 |
+
**Syntax**
|
| 3048 |
+
|
| 3049 |
+
.. code-block:: none
|
| 3050 |
+
|
| 3051 |
+
[p]remove <index_or_url>
|
| 3052 |
+
|
| 3053 |
+
**Description**
|
| 3054 |
+
|
| 3055 |
+
Remove a specific track number from the queue.
|
| 3056 |
+
|
| 3057 |
+
.. _audio-command-repeat:
|
| 3058 |
+
|
| 3059 |
+
^^^^^^
|
| 3060 |
+
repeat
|
| 3061 |
+
^^^^^^
|
| 3062 |
+
|
| 3063 |
+
**Syntax**
|
| 3064 |
+
|
| 3065 |
+
.. code-block:: none
|
| 3066 |
+
|
| 3067 |
+
[p]repeat
|
| 3068 |
+
|
| 3069 |
+
**Description**
|
| 3070 |
+
|
| 3071 |
+
Toggle repeat.
|
| 3072 |
+
|
| 3073 |
+
.. _audio-command-search:
|
| 3074 |
+
|
| 3075 |
+
^^^^^^
|
| 3076 |
+
search
|
| 3077 |
+
^^^^^^
|
| 3078 |
+
|
| 3079 |
+
**Syntax**
|
| 3080 |
+
|
| 3081 |
+
.. code-block:: none
|
| 3082 |
+
|
| 3083 |
+
[p]search <query>
|
| 3084 |
+
|
| 3085 |
+
**Description**
|
| 3086 |
+
|
| 3087 |
+
Pick a track with a search.
|
| 3088 |
+
|
| 3089 |
+
Use ``[p]search list <search term>`` to queue all tracks found on YouTube. Use ``[p]search sc
|
| 3090 |
+
<search term>`` to search on SoundCloud instead of YouTube.
|
| 3091 |
+
|
| 3092 |
+
.. _audio-command-seek:
|
| 3093 |
+
|
| 3094 |
+
^^^^
|
| 3095 |
+
seek
|
| 3096 |
+
^^^^
|
| 3097 |
+
|
| 3098 |
+
**Syntax**
|
| 3099 |
+
|
| 3100 |
+
.. code-block:: none
|
| 3101 |
+
|
| 3102 |
+
[p]seek <seconds>
|
| 3103 |
+
|
| 3104 |
+
**Description**
|
| 3105 |
+
|
| 3106 |
+
Seek ahead or behind on a track by seconds or to a specific time. Accepts seconds or
|
| 3107 |
+
a value formatted like 00:00:00 (``hh:mm:ss``) or 00:00 (``mm:ss``).
|
| 3108 |
+
|
| 3109 |
+
.. _audio-command-shuffle:
|
| 3110 |
+
|
| 3111 |
+
^^^^^^^
|
| 3112 |
+
shuffle
|
| 3113 |
+
^^^^^^^
|
| 3114 |
+
|
| 3115 |
+
**Syntax**
|
| 3116 |
+
|
| 3117 |
+
.. code-block:: none
|
| 3118 |
+
|
| 3119 |
+
[p]shuffle
|
| 3120 |
+
|
| 3121 |
+
**Description**
|
| 3122 |
+
|
| 3123 |
+
Toggle shuffle.
|
| 3124 |
+
|
| 3125 |
+
.. _audio-command-shuffle-bumped:
|
| 3126 |
+
|
| 3127 |
+
""""""""""""""
|
| 3128 |
+
shuffle bumped
|
| 3129 |
+
""""""""""""""
|
| 3130 |
+
|
| 3131 |
+
**Syntax**
|
| 3132 |
+
|
| 3133 |
+
.. code-block:: none
|
| 3134 |
+
|
| 3135 |
+
[p]shuffle bumped
|
| 3136 |
+
|
| 3137 |
+
**Description**
|
| 3138 |
+
|
| 3139 |
+
Toggle bumped track shuffle.
|
| 3140 |
+
|
| 3141 |
+
Set this to disabled if you wish to avoid bumped songs being shuffled. This takes priority
|
| 3142 |
+
over ``[p]shuffle``.
|
| 3143 |
+
|
| 3144 |
+
.. _audio-command-sing:
|
| 3145 |
+
|
| 3146 |
+
^^^^
|
| 3147 |
+
sing
|
| 3148 |
+
^^^^
|
| 3149 |
+
|
| 3150 |
+
**Syntax**
|
| 3151 |
+
|
| 3152 |
+
.. code-block:: none
|
| 3153 |
+
|
| 3154 |
+
[p]sing
|
| 3155 |
+
|
| 3156 |
+
**Description**
|
| 3157 |
+
|
| 3158 |
+
Make Red sing one of her songs.
|
| 3159 |
+
|
| 3160 |
+
.. _audio-command-skip:
|
| 3161 |
+
|
| 3162 |
+
^^^^
|
| 3163 |
+
skip
|
| 3164 |
+
^^^^
|
| 3165 |
+
|
| 3166 |
+
**Syntax**
|
| 3167 |
+
|
| 3168 |
+
.. code-block:: none
|
| 3169 |
+
|
| 3170 |
+
[p]skip [skip_to_track]
|
| 3171 |
+
|
| 3172 |
+
**Description**
|
| 3173 |
+
|
| 3174 |
+
Skip to the next track, or to a given track number.
|
| 3175 |
+
|
| 3176 |
+
.. _audio-command-stop:
|
| 3177 |
+
|
| 3178 |
+
^^^^
|
| 3179 |
+
stop
|
| 3180 |
+
^^^^
|
| 3181 |
+
|
| 3182 |
+
**Syntax**
|
| 3183 |
+
|
| 3184 |
+
.. code-block:: none
|
| 3185 |
+
|
| 3186 |
+
[p]stop
|
| 3187 |
+
|
| 3188 |
+
**Description**
|
| 3189 |
+
|
| 3190 |
+
Stop playback and clear the queue.
|
| 3191 |
+
|
| 3192 |
+
.. _audio-command-summon:
|
| 3193 |
+
|
| 3194 |
+
^^^^^^
|
| 3195 |
+
summon
|
| 3196 |
+
^^^^^^
|
| 3197 |
+
|
| 3198 |
+
**Syntax**
|
| 3199 |
+
|
| 3200 |
+
.. code-block:: none
|
| 3201 |
+
|
| 3202 |
+
[p]summon
|
| 3203 |
+
|
| 3204 |
+
**Description**
|
| 3205 |
+
|
| 3206 |
+
Summon the bot to a voice channel.
|
| 3207 |
+
|
| 3208 |
+
.. _audio-command-volume:
|
| 3209 |
+
|
| 3210 |
+
^^^^^^
|
| 3211 |
+
volume
|
| 3212 |
+
^^^^^^
|
| 3213 |
+
|
| 3214 |
+
**Syntax**
|
| 3215 |
+
|
| 3216 |
+
.. code-block:: none
|
| 3217 |
+
|
| 3218 |
+
[p]volume [vol]
|
| 3219 |
+
|
| 3220 |
+
**Description**
|
| 3221 |
+
|
| 3222 |
+
Set the volume, 1% - 150%.
|
| 3223 |
+
|
| 3224 |
+
.. _llset-commands:
|
| 3225 |
+
|
| 3226 |
+
-----------------------
|
| 3227 |
+
Lavalink Setup Commands
|
| 3228 |
+
-----------------------
|
| 3229 |
+
|
| 3230 |
+
``[p]llset`` group commands are used for advanced management of the connection to the Lavalink
|
| 3231 |
+
server. The subcommands are dynamically available depending on whether Red is managing your
|
| 3232 |
+
Lavalink node or if you are connecting to one you manage yourself, or a service that offers Lavalink
|
| 3233 |
+
nodes.
|
| 3234 |
+
|
| 3235 |
+
Commands specifically for managed Lavalink nodes can be found in :ref:`this section<managed-node-management-commands>`,
|
| 3236 |
+
whilst commands for unmanaged Lavalink nodes can be found :ref:`here<unmanaged-node-management-commands>`.
|
| 3237 |
+
|
| 3238 |
+
.. _audio-command-llset:
|
| 3239 |
+
|
| 3240 |
+
^^^^^
|
| 3241 |
+
llset
|
| 3242 |
+
^^^^^
|
| 3243 |
+
|
| 3244 |
+
.. note:: |owner-lock|
|
| 3245 |
+
|
| 3246 |
+
**Syntax**
|
| 3247 |
+
|
| 3248 |
+
.. code-block:: none
|
| 3249 |
+
|
| 3250 |
+
[p]llset
|
| 3251 |
+
|
| 3252 |
+
**Description**
|
| 3253 |
+
|
| 3254 |
+
Manage Lavalink node configuration settings. This command holds all commands to
|
| 3255 |
+
manage an unmanaged (user-managed) or managed (bot-managed) Lavalink node.
|
| 3256 |
+
|
| 3257 |
+
.. warning::
|
| 3258 |
+
|
| 3259 |
+
You should not change any command settings in this group command unless you
|
| 3260 |
+
have a valid reason to, e.g. been told by someone in the Red-Discord Bot support
|
| 3261 |
+
server to do so. Changing llset command settings have the potential to break
|
| 3262 |
+
Audio cog connection and playback if the wrong settings are used.
|
| 3263 |
+
|
| 3264 |
+
"""""""""""""""
|
| 3265 |
+
llset unmanaged
|
| 3266 |
+
"""""""""""""""
|
| 3267 |
+
|
| 3268 |
+
**Syntax**
|
| 3269 |
+
|
| 3270 |
+
.. code-block:: none
|
| 3271 |
+
|
| 3272 |
+
[p]llset unmanaged
|
| 3273 |
+
|
| 3274 |
+
or
|
| 3275 |
+
|
| 3276 |
+
.. code-block:: none
|
| 3277 |
+
|
| 3278 |
+
[p]llsetup unmanaged
|
| 3279 |
+
|
| 3280 |
+
**Description**
|
| 3281 |
+
|
| 3282 |
+
Toggle using unmanaged (user-managed) Lavalink nodes - requires an existing Lavalink
|
| 3283 |
+
node for Audio to work, if enabled. This command disables the managed (bot-managed)
|
| 3284 |
+
Lavalink server: if you do not have an unmanaged Lavalink node set up, you will be
|
| 3285 |
+
unable to use Audio while this is enabled.
|
| 3286 |
+
|
| 3287 |
+
""""""""""
|
| 3288 |
+
llset info
|
| 3289 |
+
""""""""""
|
| 3290 |
+
|
| 3291 |
+
**Syntax**
|
| 3292 |
+
|
| 3293 |
+
.. code-block:: none
|
| 3294 |
+
|
| 3295 |
+
[p]llset info
|
| 3296 |
+
|
| 3297 |
+
**Description**
|
| 3298 |
+
|
| 3299 |
+
Display Lavalink connection settings.
|
| 3300 |
+
|
| 3301 |
+
"""""""""""
|
| 3302 |
+
llset reset
|
| 3303 |
+
"""""""""""
|
| 3304 |
+
|
| 3305 |
+
**Syntax**
|
| 3306 |
+
|
| 3307 |
+
.. code-block:: none
|
| 3308 |
+
|
| 3309 |
+
[p]llset reset
|
| 3310 |
+
|
| 3311 |
+
**Description**
|
| 3312 |
+
|
| 3313 |
+
Reset all ``[p]llset`` changes back to their default values.
|
| 3314 |
+
|
| 3315 |
+
.. _managed-node-management-commands:
|
| 3316 |
+
|
| 3317 |
+
--------------------------------
|
| 3318 |
+
Managed Node Management Commands
|
| 3319 |
+
--------------------------------
|
| 3320 |
+
|
| 3321 |
+
.. _audio-command-llset-config:
|
| 3322 |
+
|
| 3323 |
+
^^^^^^^^^^^^
|
| 3324 |
+
llset config
|
| 3325 |
+
^^^^^^^^^^^^
|
| 3326 |
+
|
| 3327 |
+
**Syntax**
|
| 3328 |
+
|
| 3329 |
+
.. code-block:: none
|
| 3330 |
+
|
| 3331 |
+
[p]llset config
|
| 3332 |
+
|
| 3333 |
+
**Description**
|
| 3334 |
+
|
| 3335 |
+
Configure the managed Lavalink node runtime options.
|
| 3336 |
+
|
| 3337 |
+
All settings under this group will likely cause Audio to malfunction if changed
|
| 3338 |
+
from their defaults, only change settings here if you have been advised to by #support.
|
| 3339 |
+
|
| 3340 |
+
.. _audio-command-llset-config-bind:
|
| 3341 |
+
|
| 3342 |
+
^^^^^^^^^^^^^^^^^
|
| 3343 |
+
llset config bind
|
| 3344 |
+
^^^^^^^^^^^^^^^^^
|
| 3345 |
+
|
| 3346 |
+
**Syntax**
|
| 3347 |
+
|
| 3348 |
+
.. code-block:: none
|
| 3349 |
+
|
| 3350 |
+
[p]llset config bind [host=localhost]
|
| 3351 |
+
|
| 3352 |
+
**Description**
|
| 3353 |
+
|
| 3354 |
+
Set the managed Lavalink node's binding IP address.
|
| 3355 |
+
|
| 3356 |
+
**Arguments**
|
| 3357 |
+
|
| 3358 |
+
* ``[host]``: The node's binding IP address, defaulting to "localhost".
|
| 3359 |
+
|
| 3360 |
+
.. _audio-command-llset-config-port:
|
| 3361 |
+
|
| 3362 |
+
^^^^^^^^^^^^^^^^^
|
| 3363 |
+
llset config port
|
| 3364 |
+
^^^^^^^^^^^^^^^^^
|
| 3365 |
+
|
| 3366 |
+
**Syntax**
|
| 3367 |
+
|
| 3368 |
+
.. code-block:: none
|
| 3369 |
+
|
| 3370 |
+
[p]llset config port [port=2333]
|
| 3371 |
+
|
| 3372 |
+
**Description**
|
| 3373 |
+
|
| 3374 |
+
Set the managed Lavalink node's connection port.
|
| 3375 |
+
|
| 3376 |
+
This port is the port the managed Lavalink node binds to, you should
|
| 3377 |
+
only change this if there is a conflict with the default port because
|
| 3378 |
+
you already have an application using port 2333 on this device.
|
| 3379 |
+
|
| 3380 |
+
**Arguments**
|
| 3381 |
+
|
| 3382 |
+
* ``[port]``: The node's connection port, defaulting to 2333.
|
| 3383 |
+
|
| 3384 |
+
.. _audio-command-llset-config-server:
|
| 3385 |
+
|
| 3386 |
+
^^^^^^^^^^^^^^^^^^^
|
| 3387 |
+
llset config server
|
| 3388 |
+
^^^^^^^^^^^^^^^^^^^
|
| 3389 |
+
|
| 3390 |
+
**Syntax**
|
| 3391 |
+
|
| 3392 |
+
.. code-block:: none
|
| 3393 |
+
|
| 3394 |
+
[p]llset config server
|
| 3395 |
+
|
| 3396 |
+
**Description**
|
| 3397 |
+
|
| 3398 |
+
Configure the managed node authorization and connection settings.
|
| 3399 |
+
|
| 3400 |
+
.. _audio-command-llset-config-server-buffer:
|
| 3401 |
+
|
| 3402 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3403 |
+
llset config server buffer
|
| 3404 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3405 |
+
|
| 3406 |
+
**Syntax**
|
| 3407 |
+
|
| 3408 |
+
.. code-block:: none
|
| 3409 |
+
|
| 3410 |
+
[p]llset config server buffer [milliseconds=400]
|
| 3411 |
+
|
| 3412 |
+
**Description**
|
| 3413 |
+
|
| 3414 |
+
Set the managed Lavalink node JDA-NAS buffer size. Only
|
| 3415 |
+
change this if you have been directly advised to,
|
| 3416 |
+
changing it can cause significant playback issues.
|
| 3417 |
+
|
| 3418 |
+
**Arguments**
|
| 3419 |
+
|
| 3420 |
+
* ``[milliseconds]`` - The buffer size, defaults to 400.
|
| 3421 |
+
|
| 3422 |
+
.. _audio-command-llset-config-server-framebuffer:
|
| 3423 |
+
|
| 3424 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3425 |
+
llset config server framebuffer
|
| 3426 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3427 |
+
|
| 3428 |
+
**Syntax**
|
| 3429 |
+
|
| 3430 |
+
.. code-block:: none
|
| 3431 |
+
|
| 3432 |
+
[p]llset config server framebuffer [milliseconds=1000]
|
| 3433 |
+
|
| 3434 |
+
**Description**
|
| 3435 |
+
|
| 3436 |
+
Set the managed Lavalink node framebuffer size. Only
|
| 3437 |
+
change this if you have been directly advised to,
|
| 3438 |
+
changing it can cause significant playback issues.
|
| 3439 |
+
|
| 3440 |
+
**Arguments**
|
| 3441 |
+
|
| 3442 |
+
* ``[milliseconds]`` - The framebuffer size, defaults to 1000.
|
| 3443 |
+
|
| 3444 |
+
.. _audio-command-llset-config-source:
|
| 3445 |
+
|
| 3446 |
+
^^^^^^^^^^^^^^^^^^^
|
| 3447 |
+
llset config source
|
| 3448 |
+
^^^^^^^^^^^^^^^^^^^
|
| 3449 |
+
|
| 3450 |
+
**Syntax**
|
| 3451 |
+
|
| 3452 |
+
.. code-block:: none
|
| 3453 |
+
|
| 3454 |
+
[p]llset config source
|
| 3455 |
+
|
| 3456 |
+
**Description**
|
| 3457 |
+
|
| 3458 |
+
Toggle audio sources on/off.
|
| 3459 |
+
|
| 3460 |
+
By default, all sources are enabled, you should only use commands here to
|
| 3461 |
+
disable a specific source if you have been advised to, disabling sources
|
| 3462 |
+
without background knowledge can cause Audio to break.
|
| 3463 |
+
|
| 3464 |
+
.. _audio-command-llset-config-source-bandcamp:
|
| 3465 |
+
|
| 3466 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3467 |
+
llset config source bandcamp
|
| 3468 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3469 |
+
|
| 3470 |
+
**Syntax**
|
| 3471 |
+
|
| 3472 |
+
.. code-block:: none
|
| 3473 |
+
|
| 3474 |
+
[p]llset config source bandcamp
|
| 3475 |
+
|
| 3476 |
+
**Description**
|
| 3477 |
+
|
| 3478 |
+
Toggle Bandcamp source on or off. This toggle controls the playback
|
| 3479 |
+
of all Bandcamp related content.
|
| 3480 |
+
|
| 3481 |
+
.. _audio-command-llset-config-source-http:
|
| 3482 |
+
|
| 3483 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3484 |
+
llset config source http
|
| 3485 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3486 |
+
|
| 3487 |
+
**Syntax**
|
| 3488 |
+
|
| 3489 |
+
.. code-block:: none
|
| 3490 |
+
|
| 3491 |
+
[p]llset config source http
|
| 3492 |
+
|
| 3493 |
+
**Description**
|
| 3494 |
+
|
| 3495 |
+
Toggle HTTP direct URL usage on or off. This source is used to
|
| 3496 |
+
allow playback from direct HTTP streams (this does not affect direct URL
|
| 3497 |
+
playback for the other sources).
|
| 3498 |
+
|
| 3499 |
+
.. _audio-command-llset-config-source-local:
|
| 3500 |
+
|
| 3501 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3502 |
+
llset config source local
|
| 3503 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3504 |
+
|
| 3505 |
+
**Syntax**
|
| 3506 |
+
|
| 3507 |
+
.. code-block:: none
|
| 3508 |
+
|
| 3509 |
+
[p]llset config source local
|
| 3510 |
+
|
| 3511 |
+
**Description**
|
| 3512 |
+
|
| 3513 |
+
Toggle local file usage on or off.
|
| 3514 |
+
This toggle controls the playback of all local track content,
|
| 3515 |
+
usually found inside the ``localtracks`` folder.
|
| 3516 |
+
|
| 3517 |
+
.. _audio-command-llset-config-source-soundcloud:
|
| 3518 |
+
|
| 3519 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3520 |
+
llset config source soundcloud
|
| 3521 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3522 |
+
|
| 3523 |
+
**Syntax**
|
| 3524 |
+
|
| 3525 |
+
.. code-block:: none
|
| 3526 |
+
|
| 3527 |
+
[p]llset config source soundcloud
|
| 3528 |
+
|
| 3529 |
+
**Description**
|
| 3530 |
+
|
| 3531 |
+
Toggle SoundCloud source on or off.
|
| 3532 |
+
This toggle controls the playback of all SoundCloud related content.
|
| 3533 |
+
|
| 3534 |
+
.. _audio-command-llset-config-source-twitch:
|
| 3535 |
+
|
| 3536 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3537 |
+
llset config source twitch
|
| 3538 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3539 |
+
|
| 3540 |
+
**Syntax**
|
| 3541 |
+
|
| 3542 |
+
.. code-block:: none
|
| 3543 |
+
|
| 3544 |
+
[p]llset config source twitch
|
| 3545 |
+
|
| 3546 |
+
**Description**
|
| 3547 |
+
|
| 3548 |
+
Toggle Twitch source on or off.
|
| 3549 |
+
This toggle controls the playback of all Twitch related content.
|
| 3550 |
+
|
| 3551 |
+
.. _audio-command-llset-config-source-vimeo:
|
| 3552 |
+
|
| 3553 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3554 |
+
llset config source vimeo
|
| 3555 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3556 |
+
|
| 3557 |
+
**Syntax**
|
| 3558 |
+
|
| 3559 |
+
.. code-block:: none
|
| 3560 |
+
|
| 3561 |
+
[p]llset config source vimeo
|
| 3562 |
+
|
| 3563 |
+
**Description**
|
| 3564 |
+
|
| 3565 |
+
Toggle Vimeo source on or off.
|
| 3566 |
+
This toggle controls the playback of all Vimeo related content.
|
| 3567 |
+
|
| 3568 |
+
.. _audio-command-llset-config-source-youtube:
|
| 3569 |
+
|
| 3570 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3571 |
+
llset config source youtube
|
| 3572 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 3573 |
+
|
| 3574 |
+
**Syntax**
|
| 3575 |
+
|
| 3576 |
+
.. code-block:: none
|
| 3577 |
+
|
| 3578 |
+
[p]llset config source youtube
|
| 3579 |
+
|
| 3580 |
+
**Description**
|
| 3581 |
+
|
| 3582 |
+
Toggle YouTube source on or off (**this includes Spotify**).
|
| 3583 |
+
This toggle controls the playback of all YouTube and Spotify related content.
|
| 3584 |
+
|
| 3585 |
+
.. _audio-command-llset-config-token:
|
| 3586 |
+
|
| 3587 |
+
^^^^^^^^^^^^^^^^^^
|
| 3588 |
+
llset config token
|
| 3589 |
+
^^^^^^^^^^^^^^^^^^
|
| 3590 |
+
|
| 3591 |
+
**Syntax**
|
| 3592 |
+
|
| 3593 |
+
.. code-block:: none
|
| 3594 |
+
|
| 3595 |
+
[p]llset config token [password=youshallnotpass]
|
| 3596 |
+
|
| 3597 |
+
**Description**
|
| 3598 |
+
|
| 3599 |
+
Set the managed Lavalink node's connection password.
|
| 3600 |
+
This is the password required for Audio to connect to the managed Lavalink node.
|
| 3601 |
+
The value by default is ``youshallnotpass``.
|
| 3602 |
+
|
| 3603 |
+
**Arguments**
|
| 3604 |
+
|
| 3605 |
+
* ``[password]`` - The node's connection password, defaulting to ``youshallnotpass``.
|
| 3606 |
+
|
| 3607 |
+
.. _audio-command-llset-heapsize:
|
| 3608 |
+
|
| 3609 |
+
^^^^^^^^^^^^^^
|
| 3610 |
+
llset heapsize
|
| 3611 |
+
^^^^^^^^^^^^^^
|
| 3612 |
+
|
| 3613 |
+
**Syntax**
|
| 3614 |
+
|
| 3615 |
+
.. code-block:: none
|
| 3616 |
+
|
| 3617 |
+
[p]llset heapsize [size=3G]
|
| 3618 |
+
|
| 3619 |
+
**Description**
|
| 3620 |
+
|
| 3621 |
+
Set the managed Lavalink node maximum heap-size.
|
| 3622 |
+
|
| 3623 |
+
By default, this value is 50% of available RAM in the host machine
|
| 3624 |
+
represented by [1-1024][M|G] (256M, 256G for example).
|
| 3625 |
+
|
| 3626 |
+
This value only represents the maximum amount of RAM allowed to be
|
| 3627 |
+
used at any given point, and does not mean that the managed Lavalink
|
| 3628 |
+
node will always use this amount of RAM.
|
| 3629 |
+
|
| 3630 |
+
**Arguments**
|
| 3631 |
+
|
| 3632 |
+
* ``[size]`` - The node's maximum heap-size, defaulting to ``3G``.
|
| 3633 |
+
|
| 3634 |
+
.. _audio-command-llset-java:
|
| 3635 |
+
|
| 3636 |
+
^^^^^^^^^^
|
| 3637 |
+
llset java
|
| 3638 |
+
^^^^^^^^^^
|
| 3639 |
+
|
| 3640 |
+
**Syntax**
|
| 3641 |
+
|
| 3642 |
+
.. code-block:: none
|
| 3643 |
+
|
| 3644 |
+
[p]llset java [javapath]
|
| 3645 |
+
|
| 3646 |
+
**Description**
|
| 3647 |
+
|
| 3648 |
+
Change your Java executable path.
|
| 3649 |
+
|
| 3650 |
+
This command shouldn't need to be used most of the time,
|
| 3651 |
+
and is only useful if the host machine has conflicting Java versions.
|
| 3652 |
+
|
| 3653 |
+
If changing this make sure that the Java executable you set is supported by Audio.
|
| 3654 |
+
The current supported version is Java 11.
|
| 3655 |
+
|
| 3656 |
+
**Arguments**
|
| 3657 |
+
|
| 3658 |
+
* ``[java]`` - The java executable path, leave blank to reset it back to default.
|
| 3659 |
+
|
| 3660 |
+
.. _audio-command-llset-yaml:
|
| 3661 |
+
|
| 3662 |
+
^^^^^^^^^^
|
| 3663 |
+
llset yaml
|
| 3664 |
+
^^^^^^^^^^
|
| 3665 |
+
|
| 3666 |
+
**Syntax**
|
| 3667 |
+
|
| 3668 |
+
.. code-block:: none
|
| 3669 |
+
|
| 3670 |
+
[p]llset yaml
|
| 3671 |
+
|
| 3672 |
+
**Description**
|
| 3673 |
+
|
| 3674 |
+
Uploads a copy of the application.yml file used by the managed Lavalink node.
|
| 3675 |
+
|
| 3676 |
+
.. _unmanaged-node-management-commands:
|
| 3677 |
+
|
| 3678 |
+
----------------------------------
|
| 3679 |
+
Unmanaged Node Management Commands
|
| 3680 |
+
----------------------------------
|
| 3681 |
+
|
| 3682 |
+
.. note::
|
| 3683 |
+
|
| 3684 |
+
A normal Red user should never have to use these commands unless they are :ref:`managing multiple Red bots with Audio<multibots>`.
|
| 3685 |
+
|
| 3686 |
+
.. _audio-command-llset-host:
|
| 3687 |
+
|
| 3688 |
+
^^^^^^^^^^
|
| 3689 |
+
llset host
|
| 3690 |
+
^^^^^^^^^^
|
| 3691 |
+
|
| 3692 |
+
**Syntax**
|
| 3693 |
+
|
| 3694 |
+
.. code-block:: none
|
| 3695 |
+
|
| 3696 |
+
[p]llset host [host=localhost]
|
| 3697 |
+
|
| 3698 |
+
**Description**
|
| 3699 |
+
|
| 3700 |
+
Set the Lavalink node host. This command sets the connection host which
|
| 3701 |
+
Audio will use to connect to an unmanaged Lavalink node.
|
| 3702 |
+
|
| 3703 |
+
**Arguments**
|
| 3704 |
+
|
| 3705 |
+
* ``[host]`` - The connection host, defaulting to "localhost".
|
| 3706 |
+
|
| 3707 |
+
.. _audio-command-llset-password:
|
| 3708 |
+
|
| 3709 |
+
^^^^^^^^^^^^^^
|
| 3710 |
+
llset password
|
| 3711 |
+
^^^^^^^^^^^^^^
|
| 3712 |
+
|
| 3713 |
+
**Syntax**
|
| 3714 |
+
|
| 3715 |
+
.. code-block:: none
|
| 3716 |
+
|
| 3717 |
+
[p]llset password [password=youshallnotpass]
|
| 3718 |
+
|
| 3719 |
+
**Description**
|
| 3720 |
+
|
| 3721 |
+
Set the Lavalink node password. This command sets the connection password which
|
| 3722 |
+
Audio will use to connect to an unmanaged Lavalink node.
|
| 3723 |
+
|
| 3724 |
+
**Arguments**
|
| 3725 |
+
|
| 3726 |
+
* ``[password]`` - The connection password, defaulting to "youshallnotpass".
|
| 3727 |
+
|
| 3728 |
+
.. _audio-command-llset-port:
|
| 3729 |
+
|
| 3730 |
+
^^^^^^^^^^
|
| 3731 |
+
llset port
|
| 3732 |
+
^^^^^^^^^^
|
| 3733 |
+
|
| 3734 |
+
**Syntax**
|
| 3735 |
+
|
| 3736 |
+
.. code-block:: none
|
| 3737 |
+
|
| 3738 |
+
[p]llset port [port=2333]
|
| 3739 |
+
|
| 3740 |
+
**Description**
|
| 3741 |
+
|
| 3742 |
+
Set the Lavalink node port. This command sets the connection port which
|
| 3743 |
+
Audio will use to connect to an unmanaged Lavalink node.
|
| 3744 |
+
|
| 3745 |
+
**Arguments**
|
| 3746 |
+
|
| 3747 |
+
* ``[password]`` - The connection password, defaulting to 2333.
|
| 3748 |
+
|
| 3749 |
+
.. _audio-command-llset-secured:
|
| 3750 |
+
|
| 3751 |
+
^^^^^^^^^^^^^
|
| 3752 |
+
llset secured
|
| 3753 |
+
^^^^^^^^^^^^^
|
| 3754 |
+
|
| 3755 |
+
**Syntax**
|
| 3756 |
+
|
| 3757 |
+
.. code-block:: none
|
| 3758 |
+
|
| 3759 |
+
[p]llset secured
|
| 3760 |
+
|
| 3761 |
+
**Description**
|
| 3762 |
+
|
| 3763 |
+
Set the Lavalink node connection to secured. This toggle sets the connection type
|
| 3764 |
+
to secured or unsecured when connecting to an unmanaged Lavalink node.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/cleanup.rst
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _cleanup:
|
| 2 |
+
|
| 3 |
+
=======
|
| 4 |
+
Cleanup
|
| 5 |
+
=======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the cleanup cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load cleanup
|
| 15 |
+
|
| 16 |
+
.. _cleanup-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog contains commands used for "cleaning up" (deleting) messages.
|
| 23 |
+
|
| 24 |
+
This is designed as a moderator tool and offers many convenient use cases.
|
| 25 |
+
All cleanup commands only apply to the channel the command is executed in.
|
| 26 |
+
|
| 27 |
+
Messages older than two weeks cannot be mass deleted.
|
| 28 |
+
This is a limitation of the API.
|
| 29 |
+
|
| 30 |
+
|
| 31 |
+
.. _cleanup-commands:
|
| 32 |
+
|
| 33 |
+
--------
|
| 34 |
+
Commands
|
| 35 |
+
--------
|
| 36 |
+
|
| 37 |
+
.. _cleanup-command-cleanup:
|
| 38 |
+
|
| 39 |
+
^^^^^^^
|
| 40 |
+
cleanup
|
| 41 |
+
^^^^^^^
|
| 42 |
+
|
| 43 |
+
**Syntax**
|
| 44 |
+
|
| 45 |
+
.. code-block:: none
|
| 46 |
+
|
| 47 |
+
[p]cleanup
|
| 48 |
+
|
| 49 |
+
**Description**
|
| 50 |
+
|
| 51 |
+
Base command for deleting messages.
|
| 52 |
+
|
| 53 |
+
.. _cleanup-command-cleanup-after:
|
| 54 |
+
|
| 55 |
+
"""""""""""""
|
| 56 |
+
cleanup after
|
| 57 |
+
"""""""""""""
|
| 58 |
+
|
| 59 |
+
.. note:: |mod-lock|
|
| 60 |
+
|
| 61 |
+
**Syntax**
|
| 62 |
+
|
| 63 |
+
.. code-block:: none
|
| 64 |
+
|
| 65 |
+
[p]cleanup after <message_id> [delete_pinned=False]
|
| 66 |
+
|
| 67 |
+
**Description**
|
| 68 |
+
|
| 69 |
+
Delete all messages after a specified message.
|
| 70 |
+
|
| 71 |
+
To get a message id, enable developer mode in Discord's
|
| 72 |
+
settings, 'appearance' tab. Then right click a message
|
| 73 |
+
and copy its id.
|
| 74 |
+
|
| 75 |
+
**Arguments:**
|
| 76 |
+
|
| 77 |
+
- ``<message_id>`` The id of the message to cleanup after. This message won't be deleted.
|
| 78 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 79 |
+
|
| 80 |
+
.. _cleanup-command-cleanup-before:
|
| 81 |
+
|
| 82 |
+
""""""""""""""
|
| 83 |
+
cleanup before
|
| 84 |
+
""""""""""""""
|
| 85 |
+
|
| 86 |
+
.. note:: |mod-lock|
|
| 87 |
+
|
| 88 |
+
**Syntax**
|
| 89 |
+
|
| 90 |
+
.. code-block:: none
|
| 91 |
+
|
| 92 |
+
[p]cleanup before <message_id> <number> [delete_pinned=False]
|
| 93 |
+
|
| 94 |
+
**Description**
|
| 95 |
+
|
| 96 |
+
Deletes X messages before the specified message.
|
| 97 |
+
|
| 98 |
+
To get a message id, enable developer mode in Discord's
|
| 99 |
+
settings, 'appearance' tab. Then right click a message
|
| 100 |
+
and copy its id.
|
| 101 |
+
|
| 102 |
+
**Arguments:**
|
| 103 |
+
|
| 104 |
+
- ``<message_id>`` The id of the message to cleanup before. This message won't be deleted.
|
| 105 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 106 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 107 |
+
|
| 108 |
+
.. _cleanup-command-cleanup-between:
|
| 109 |
+
|
| 110 |
+
"""""""""""""""
|
| 111 |
+
cleanup between
|
| 112 |
+
"""""""""""""""
|
| 113 |
+
|
| 114 |
+
.. note:: |mod-lock|
|
| 115 |
+
|
| 116 |
+
**Syntax**
|
| 117 |
+
|
| 118 |
+
.. code-block:: none
|
| 119 |
+
|
| 120 |
+
[p]cleanup between <one> <two> [delete_pinned=False]
|
| 121 |
+
|
| 122 |
+
**Description**
|
| 123 |
+
|
| 124 |
+
Delete the messages between Message One and Message Two, providing the messages IDs.
|
| 125 |
+
|
| 126 |
+
The first message ID should be the older message and the second one the newer.
|
| 127 |
+
|
| 128 |
+
Example:
|
| 129 |
+
- ``[p]cleanup between 123456789123456789 987654321987654321``
|
| 130 |
+
|
| 131 |
+
**Arguments:**
|
| 132 |
+
|
| 133 |
+
- ``<one>`` The id of the message to cleanup after. This message won't be deleted.
|
| 134 |
+
- ``<two>`` The id of the message to cleanup before. This message won't be deleted.
|
| 135 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 136 |
+
|
| 137 |
+
.. _cleanup-command-cleanup-bot:
|
| 138 |
+
|
| 139 |
+
"""""""""""
|
| 140 |
+
cleanup bot
|
| 141 |
+
"""""""""""
|
| 142 |
+
|
| 143 |
+
.. note:: |mod-lock|
|
| 144 |
+
|
| 145 |
+
**Syntax**
|
| 146 |
+
|
| 147 |
+
.. code-block:: none
|
| 148 |
+
|
| 149 |
+
[p]cleanup bot <number> [delete_pinned=False]
|
| 150 |
+
|
| 151 |
+
**Description**
|
| 152 |
+
|
| 153 |
+
Clean up command messages and messages from the bot in the current channel.
|
| 154 |
+
|
| 155 |
+
Can only cleanup custom commands and alias commands if those cogs are loaded.
|
| 156 |
+
|
| 157 |
+
**Arguments:**
|
| 158 |
+
|
| 159 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 160 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 161 |
+
|
| 162 |
+
.. _cleanup-command-cleanup-messages:
|
| 163 |
+
|
| 164 |
+
""""""""""""""""
|
| 165 |
+
cleanup messages
|
| 166 |
+
""""""""""""""""
|
| 167 |
+
|
| 168 |
+
.. note:: |mod-lock|
|
| 169 |
+
|
| 170 |
+
**Syntax**
|
| 171 |
+
|
| 172 |
+
.. code-block:: none
|
| 173 |
+
|
| 174 |
+
[p]cleanup messages <number> [delete_pinned=False]
|
| 175 |
+
|
| 176 |
+
**Description**
|
| 177 |
+
|
| 178 |
+
Delete the last X messages in the current channel.
|
| 179 |
+
|
| 180 |
+
Example:
|
| 181 |
+
- ``[p]cleanup messages 26``
|
| 182 |
+
|
| 183 |
+
**Arguments:**
|
| 184 |
+
|
| 185 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 186 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 187 |
+
|
| 188 |
+
.. _cleanup-command-cleanup-self:
|
| 189 |
+
|
| 190 |
+
""""""""""""
|
| 191 |
+
cleanup self
|
| 192 |
+
""""""""""""
|
| 193 |
+
|
| 194 |
+
**Syntax**
|
| 195 |
+
|
| 196 |
+
.. code-block:: none
|
| 197 |
+
|
| 198 |
+
[p]cleanup self <number> [match_pattern] [delete_pinned=False]
|
| 199 |
+
|
| 200 |
+
**Description**
|
| 201 |
+
|
| 202 |
+
Clean up messages owned by the bot in the current channel.
|
| 203 |
+
|
| 204 |
+
By default, all messages are cleaned. If a second argument is specified,
|
| 205 |
+
it is used for pattern matching - only messages containing the given text will be deleted.
|
| 206 |
+
|
| 207 |
+
Examples:
|
| 208 |
+
- ``[p]cleanup self 6``
|
| 209 |
+
- ``[p]cleanup self 10 Pong``
|
| 210 |
+
- ``[p]cleanup self 7 "" True``
|
| 211 |
+
|
| 212 |
+
**Arguments:**
|
| 213 |
+
|
| 214 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 215 |
+
- ``<match_pattern>`` The text that messages must contain to be deleted. Use "" to skip this.
|
| 216 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 217 |
+
|
| 218 |
+
.. _cleanup-command-cleanup-spam:
|
| 219 |
+
|
| 220 |
+
""""""""""""
|
| 221 |
+
cleanup spam
|
| 222 |
+
""""""""""""
|
| 223 |
+
|
| 224 |
+
.. note:: |mod-lock|
|
| 225 |
+
|
| 226 |
+
**Syntax**
|
| 227 |
+
|
| 228 |
+
.. code-block:: none
|
| 229 |
+
|
| 230 |
+
[p]cleanup spam [number=50]
|
| 231 |
+
|
| 232 |
+
**Description**
|
| 233 |
+
|
| 234 |
+
Deletes duplicate messages in the channel from the last X messages and keeps only one copy.
|
| 235 |
+
|
| 236 |
+
Defaults to 50.
|
| 237 |
+
|
| 238 |
+
**Arguments:**
|
| 239 |
+
|
| 240 |
+
- ``<number>`` The number of messages to check for duplicates. Must be a positive integer.
|
| 241 |
+
|
| 242 |
+
.. _cleanup-command-cleanup-text:
|
| 243 |
+
|
| 244 |
+
""""""""""""
|
| 245 |
+
cleanup text
|
| 246 |
+
""""""""""""
|
| 247 |
+
|
| 248 |
+
.. note:: |mod-lock|
|
| 249 |
+
|
| 250 |
+
**Syntax**
|
| 251 |
+
|
| 252 |
+
.. code-block:: none
|
| 253 |
+
|
| 254 |
+
[p]cleanup text <text> <number> [delete_pinned=False]
|
| 255 |
+
|
| 256 |
+
**Description**
|
| 257 |
+
|
| 258 |
+
Delete the last X messages matching the specified text in the current channel.
|
| 259 |
+
|
| 260 |
+
Example:
|
| 261 |
+
- ``[p]cleanup text "test" 5``
|
| 262 |
+
|
| 263 |
+
Remember to use double quotes.
|
| 264 |
+
|
| 265 |
+
**Arguments:**
|
| 266 |
+
|
| 267 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 268 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 269 |
+
|
| 270 |
+
.. _cleanup-command-cleanup-user:
|
| 271 |
+
|
| 272 |
+
""""""""""""
|
| 273 |
+
cleanup user
|
| 274 |
+
""""""""""""
|
| 275 |
+
|
| 276 |
+
.. note:: |mod-lock|
|
| 277 |
+
|
| 278 |
+
**Syntax**
|
| 279 |
+
|
| 280 |
+
.. code-block:: none
|
| 281 |
+
|
| 282 |
+
[p]cleanup user <user> <number> [delete_pinned=False]
|
| 283 |
+
|
| 284 |
+
**Description**
|
| 285 |
+
|
| 286 |
+
Delete the last X messages from a specified user in the current channel.
|
| 287 |
+
|
| 288 |
+
Examples:
|
| 289 |
+
- ``[p]cleanup user @Twentysix 2``
|
| 290 |
+
- ``[p]cleanup user Red 6``
|
| 291 |
+
|
| 292 |
+
**Arguments:**
|
| 293 |
+
|
| 294 |
+
- ``<user>`` The user whose messages are to be cleaned up.
|
| 295 |
+
- ``<number>`` The max number of messages to cleanup. Must be a positive integer.
|
| 296 |
+
- ``<delete_pinned>`` Whether to delete pinned messages or not. Defaults to False
|
| 297 |
+
|
| 298 |
+
.. _cleanup-command-cleanupset:
|
| 299 |
+
|
| 300 |
+
^^^^^^^^^^
|
| 301 |
+
cleanupset
|
| 302 |
+
^^^^^^^^^^
|
| 303 |
+
|
| 304 |
+
.. note:: |admin-lock|
|
| 305 |
+
|
| 306 |
+
**Syntax**
|
| 307 |
+
|
| 308 |
+
.. code-block:: none
|
| 309 |
+
|
| 310 |
+
[p]cleanupset
|
| 311 |
+
|
| 312 |
+
**Description**
|
| 313 |
+
|
| 314 |
+
Manage the settings for the cleanup command.
|
| 315 |
+
|
| 316 |
+
.. _cleanup-command-cleanupset-notify:
|
| 317 |
+
|
| 318 |
+
"""""""""""""""""
|
| 319 |
+
cleanupset notify
|
| 320 |
+
"""""""""""""""""
|
| 321 |
+
|
| 322 |
+
**Syntax**
|
| 323 |
+
|
| 324 |
+
.. code-block:: none
|
| 325 |
+
|
| 326 |
+
[p]cleanupset notify
|
| 327 |
+
|
| 328 |
+
**Description**
|
| 329 |
+
|
| 330 |
+
Toggle clean up notification settings.
|
| 331 |
+
|
| 332 |
+
When enabled, a message will be sent per cleanup, showing how many messages were deleted.
|
| 333 |
+
This message will be deleted after 5 seconds.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/cog_manager_ui.rst
ADDED
|
@@ -0,0 +1,251 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _cogmanagerui:
|
| 2 |
+
|
| 3 |
+
==============
|
| 4 |
+
Cog Manager UI
|
| 5 |
+
==============
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the core cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: This cog is not like the other cogs. It is loaded by default, not
|
| 13 |
+
included in the cogs paths and it cannot be unloaded. It contains needed
|
| 14 |
+
commands for cog management.
|
| 15 |
+
|
| 16 |
+
.. _cogmanagerui-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog allows you to manage your cogs and where you can install them. Unlike
|
| 23 |
+
V2, which had a ``cogs`` folder where everything was installed, you can
|
| 24 |
+
install V3 cogs everywhere, and also make them cross-compatible with other
|
| 25 |
+
instances!
|
| 26 |
+
|
| 27 |
+
If you want to install your cogs using a Github repo (usually what you will
|
| 28 |
+
always be looking for), you need to use the downloader cog. However, if you
|
| 29 |
+
have the files of a cog or want to code one, this cog is what you should be
|
| 30 |
+
looking for.
|
| 31 |
+
|
| 32 |
+
The most basic command is :ref:`paths <cogmanagerui-command-paths>`, which
|
| 33 |
+
will list you all of the currently set paths.
|
| 34 |
+
|
| 35 |
+
You can add a path by using the :ref:`addpath <cogmanagerui-command-addpath>`
|
| 36 |
+
command. All cogs in that path will be available for the bot and listed in
|
| 37 |
+
the :ref:`cogs <cogmanagerui-command-cogs>`. You can then load
|
| 38 |
+
or unload them.
|
| 39 |
+
|
| 40 |
+
.. TODO add ref to load and unload commands
|
| 41 |
+
|
| 42 |
+
.. _cogmanagerui-usage-installation:
|
| 43 |
+
|
| 44 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 45 |
+
How to install a local package without using downloader
|
| 46 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 47 |
+
|
| 48 |
+
Let's suppose you made a cog request on the `cog board <https://cogboard.discord.red>`_
|
| 49 |
+
and now you want to add your own cog to Red. You should have a folder that
|
| 50 |
+
looks like this:
|
| 51 |
+
|
| 52 |
+
.. image:: ../.resources/cog_manager_ui/custom-cog-example.png
|
| 53 |
+
|
| 54 |
+
You will first need to add a cog path to your instance. For that, use the
|
| 55 |
+
:ref:`addpath <cogmanagerui-command-addpath>` command with a new directory.
|
| 56 |
+
|
| 57 |
+
Create a folder somewhere (should stay accessible) and copy its path. A path
|
| 58 |
+
looks like this:
|
| 59 |
+
|
| 60 |
+
* Windows: ``C:\Users\username\Documents\MyCogs``
|
| 61 |
+
* macOS: ``/Users/username/Documents/MyCogs``
|
| 62 |
+
* Linux: ``/home/username/Documents/MyCogs``
|
| 63 |
+
|
| 64 |
+
You can now use the command we talked about before: type ``[p]addpath
|
| 65 |
+
<your_path>``.
|
| 66 |
+
|
| 67 |
+
.. attention:: A path shouldn't have spaces in it. If it does, add quotation
|
| 68 |
+
marks around the path, or a backslash before the space.
|
| 69 |
+
|
| 70 |
+
In that ``MyCogs`` folder, you can drop your cog folder. You should now have
|
| 71 |
+
something that looks like this:
|
| 72 |
+
|
| 73 |
+
.. image:: ../.resources/cog_manager_ui/cog-path.png
|
| 74 |
+
|
| 75 |
+
Now if you type ``[p]cogs``, your new cog should be listed, and you will be
|
| 76 |
+
able to load it!
|
| 77 |
+
|
| 78 |
+
.. _cogmanagerui-commands:
|
| 79 |
+
|
| 80 |
+
--------
|
| 81 |
+
Commands
|
| 82 |
+
--------
|
| 83 |
+
|
| 84 |
+
.. note:: The whole cog is locked to the
|
| 85 |
+
:ref:`bot owner <getting-started-permissions>`. If you are not the owner
|
| 86 |
+
of the instance, you can ignore this.
|
| 87 |
+
|
| 88 |
+
.. _cogmanagerui-command-cogs:
|
| 89 |
+
|
| 90 |
+
^^^^
|
| 91 |
+
cogs
|
| 92 |
+
^^^^
|
| 93 |
+
|
| 94 |
+
**Syntax**
|
| 95 |
+
|
| 96 |
+
.. code-block:: none
|
| 97 |
+
|
| 98 |
+
[p]cogs
|
| 99 |
+
|
| 100 |
+
**Description**
|
| 101 |
+
|
| 102 |
+
Returns a list of loaded and unloaded cogs on the bot.
|
| 103 |
+
|
| 104 |
+
Cogs are unloaded by default. This is where you can find your cogs if you
|
| 105 |
+
installed some recently.
|
| 106 |
+
|
| 107 |
+
All of the cogs located inside a cog path will be listed here. You can see a
|
| 108 |
+
list of the paths with the :ref:`paths <cogmanagerui-command-paths>` command.
|
| 109 |
+
|
| 110 |
+
.. _cogmanagerui-command-paths:
|
| 111 |
+
|
| 112 |
+
^^^^^
|
| 113 |
+
paths
|
| 114 |
+
^^^^^
|
| 115 |
+
|
| 116 |
+
**Syntax**
|
| 117 |
+
|
| 118 |
+
.. code-block:: none
|
| 119 |
+
|
| 120 |
+
[p]paths
|
| 121 |
+
|
| 122 |
+
**Description**
|
| 123 |
+
|
| 124 |
+
Lists the registered cog paths, with the install path for the downloader and
|
| 125 |
+
the core path for the core cogs.
|
| 126 |
+
|
| 127 |
+
.. TODO add ref to downloader
|
| 128 |
+
|
| 129 |
+
You can use the :ref:`reorderpath <cogmanagerui-command-reorderpath>` command
|
| 130 |
+
to reorder the listed paths.
|
| 131 |
+
|
| 132 |
+
.. tip:: The number before a cog path can be used for the
|
| 133 |
+
:ref:`removepath <cogmanagerui-command-removepath>` command.
|
| 134 |
+
|
| 135 |
+
.. _cogmanagerui-command-addpath:
|
| 136 |
+
|
| 137 |
+
^^^^^^^
|
| 138 |
+
addpath
|
| 139 |
+
^^^^^^^
|
| 140 |
+
|
| 141 |
+
**Syntax**
|
| 142 |
+
|
| 143 |
+
.. code-block:: none
|
| 144 |
+
|
| 145 |
+
[p]addpath <path>
|
| 146 |
+
|
| 147 |
+
**Description**
|
| 148 |
+
|
| 149 |
+
Adds a path to the list of available cog paths. This means that all valid cogs
|
| 150 |
+
under the path will be added to the list of available cogs, listed in
|
| 151 |
+
:ref:`cogs <cogmanagerui-command-cogs>`.
|
| 152 |
+
|
| 153 |
+
**Arguments**
|
| 154 |
+
|
| 155 |
+
* ``<path>``: A path that should look like this and point to a folder:
|
| 156 |
+
|
| 157 |
+
* Windows: ``C:\Users\username\Documents\MyCogs``
|
| 158 |
+
* macOS: ``/Users/username/Documents/MyCogs``
|
| 159 |
+
* Linux: ``/home/username/Documents/MyCogs``
|
| 160 |
+
|
| 161 |
+
Try to avoid paths with spaces. If there are spaces, add a backslash before
|
| 162 |
+
the space on Linux. Add quotation marks around the path if needed.
|
| 163 |
+
|
| 164 |
+
.. _cogmanagerui-command-removepath:
|
| 165 |
+
|
| 166 |
+
^^^^^^^^^^
|
| 167 |
+
removepath
|
| 168 |
+
^^^^^^^^^^
|
| 169 |
+
|
| 170 |
+
**Syntax**
|
| 171 |
+
|
| 172 |
+
.. code-block:: none
|
| 173 |
+
|
| 174 |
+
[p]removepath <path_numbers...>
|
| 175 |
+
|
| 176 |
+
**Description**
|
| 177 |
+
|
| 178 |
+
Removes one or more paths from the list of available paths. Its cogs won't be
|
| 179 |
+
accessible anymore.
|
| 180 |
+
|
| 181 |
+
**Arguments**
|
| 182 |
+
|
| 183 |
+
* ``<path_numbers>``: The number of the path(s) to remove. You can get it with
|
| 184 |
+
the :ref:`paths <cogmanagerui-command-paths>` command.
|
| 185 |
+
|
| 186 |
+
.. _cogmanagerui-command-reorderpath:
|
| 187 |
+
|
| 188 |
+
^^^^^^^^^^^
|
| 189 |
+
reorderpath
|
| 190 |
+
^^^^^^^^^^^
|
| 191 |
+
|
| 192 |
+
**Syntax**
|
| 193 |
+
|
| 194 |
+
.. code-block:: none
|
| 195 |
+
|
| 196 |
+
[p]reorderpath <from> <to>
|
| 197 |
+
|
| 198 |
+
**Description**
|
| 199 |
+
|
| 200 |
+
Reorders the paths listed with the :ref:`paths <cogmanagerui-command-paths>`
|
| 201 |
+
command. The goal of this command is to allow the discovery of different cogs.
|
| 202 |
+
If there are multiple packages with the same names, the one that is inside the
|
| 203 |
+
highest folder in the list will be kept and the other ones will be ignored.
|
| 204 |
+
|
| 205 |
+
For example, let's suppose this is the output of
|
| 206 |
+
:ref:`paths <cogmanagerui-command-paths>`:
|
| 207 |
+
|
| 208 |
+
1. ``/usr/local/lib/python3.7/site-packages/redbot/cogs``
|
| 209 |
+
2. ``/home/laggron/custom_cogs``
|
| 210 |
+
3. ``/mnt/not_suspicious_usb_drive/not_suspicious_cogs``
|
| 211 |
+
|
| 212 |
+
The folders 2 and 3 both have a package named ``leveler`` while being different
|
| 213 |
+
cogs, and you want to load the one located in the 3rd folder. To do that, you
|
| 214 |
+
have to put the 3rd path higher than the 2nd path, let's swap them! Type
|
| 215 |
+
``[p]reorderpath 2 3`` and the output of
|
| 216 |
+
:ref:`paths <cogmanagerui-command-paths>` will then be the following:
|
| 217 |
+
|
| 218 |
+
1. ``/usr/local/lib/python3.7/site-packages/redbot/cogs``
|
| 219 |
+
2. ``/mnt/not_suspicious_usb_drive/not_suspicious_cogs``
|
| 220 |
+
3. ``/home/laggron/custom_cogs``
|
| 221 |
+
|
| 222 |
+
**Arguments**
|
| 223 |
+
|
| 224 |
+
* ``<from>``: The index of the path you want to move.
|
| 225 |
+
* ``<to>``: The location where you want to insert the path.
|
| 226 |
+
|
| 227 |
+
.. _cogmanagerui-command-installpath:
|
| 228 |
+
|
| 229 |
+
^^^^^^^^^^^
|
| 230 |
+
installpath
|
| 231 |
+
^^^^^^^^^^^
|
| 232 |
+
|
| 233 |
+
**Syntax**
|
| 234 |
+
|
| 235 |
+
.. code-block:: none
|
| 236 |
+
|
| 237 |
+
[p]installpath [path]
|
| 238 |
+
|
| 239 |
+
**Description**
|
| 240 |
+
|
| 241 |
+
Shows the install path, or sets a new one.
|
| 242 |
+
|
| 243 |
+
If you want to set a new path, the same rules as for
|
| 244 |
+
:ref:`addpath <cogmanagerui-command-addpath>` apply
|
| 245 |
+
|
| 246 |
+
.. warning:: If you edit the install path, the cogs won't be transferred.
|
| 247 |
+
|
| 248 |
+
**Arguments**
|
| 249 |
+
|
| 250 |
+
* ``[path]``: The absolute path to set. If omitted, the current path will
|
| 251 |
+
be returned instead.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/core.rst
ADDED
|
@@ -0,0 +1,4340 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _core:
|
| 2 |
+
|
| 3 |
+
====
|
| 4 |
+
Core
|
| 5 |
+
====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the core cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. _core-usage:
|
| 13 |
+
|
| 14 |
+
-----
|
| 15 |
+
Usage
|
| 16 |
+
-----
|
| 17 |
+
|
| 18 |
+
The Core cog has many commands related to core functions.
|
| 19 |
+
|
| 20 |
+
These commands come loaded with every Red bot, and cover some of the most basic usage of the bot.
|
| 21 |
+
|
| 22 |
+
|
| 23 |
+
.. _core-commands:
|
| 24 |
+
|
| 25 |
+
--------
|
| 26 |
+
Commands
|
| 27 |
+
--------
|
| 28 |
+
|
| 29 |
+
.. _core-command-allowlist:
|
| 30 |
+
|
| 31 |
+
^^^^^^^^^
|
| 32 |
+
allowlist
|
| 33 |
+
^^^^^^^^^
|
| 34 |
+
|
| 35 |
+
.. note:: |owner-lock|
|
| 36 |
+
|
| 37 |
+
**Syntax**
|
| 38 |
+
|
| 39 |
+
.. code-block:: none
|
| 40 |
+
|
| 41 |
+
[p]allowlist
|
| 42 |
+
|
| 43 |
+
.. tip:: Alias: ``whitelist``
|
| 44 |
+
|
| 45 |
+
**Description**
|
| 46 |
+
|
| 47 |
+
Commands to manage the allowlist.
|
| 48 |
+
|
| 49 |
+
.. Warning:: When the allowlist is in use, the bot will ignore commands from everyone not on the list.
|
| 50 |
+
|
| 51 |
+
|
| 52 |
+
Use ``[p]allowlist clear`` to disable the allowlist
|
| 53 |
+
|
| 54 |
+
.. _core-command-allowlist-add:
|
| 55 |
+
|
| 56 |
+
"""""""""""""
|
| 57 |
+
allowlist add
|
| 58 |
+
"""""""""""""
|
| 59 |
+
|
| 60 |
+
**Syntax**
|
| 61 |
+
|
| 62 |
+
.. code-block:: none
|
| 63 |
+
|
| 64 |
+
[p]allowlist add <users...>
|
| 65 |
+
|
| 66 |
+
**Description**
|
| 67 |
+
|
| 68 |
+
Adds users to the allowlist.
|
| 69 |
+
|
| 70 |
+
**Examples:**
|
| 71 |
+
- ``[p]allowlist add @26 @Will`` - Adds two users to the allowlist.
|
| 72 |
+
- ``[p]allowlist add 262626262626262626`` - Adds a user by ID.
|
| 73 |
+
|
| 74 |
+
**Arguments:**
|
| 75 |
+
- ``<users...>`` - The user or users to add to the allowlist.
|
| 76 |
+
|
| 77 |
+
.. _core-command-allowlist-clear:
|
| 78 |
+
|
| 79 |
+
"""""""""""""""
|
| 80 |
+
allowlist clear
|
| 81 |
+
"""""""""""""""
|
| 82 |
+
|
| 83 |
+
**Syntax**
|
| 84 |
+
|
| 85 |
+
.. code-block:: none
|
| 86 |
+
|
| 87 |
+
[p]allowlist clear
|
| 88 |
+
|
| 89 |
+
**Description**
|
| 90 |
+
|
| 91 |
+
Clears the allowlist.
|
| 92 |
+
|
| 93 |
+
This disables the allowlist.
|
| 94 |
+
|
| 95 |
+
**Example:**
|
| 96 |
+
- ``[p]allowlist clear``
|
| 97 |
+
|
| 98 |
+
.. _core-command-allowlist-list:
|
| 99 |
+
|
| 100 |
+
""""""""""""""
|
| 101 |
+
allowlist list
|
| 102 |
+
""""""""""""""
|
| 103 |
+
|
| 104 |
+
**Syntax**
|
| 105 |
+
|
| 106 |
+
.. code-block:: none
|
| 107 |
+
|
| 108 |
+
[p]allowlist list
|
| 109 |
+
|
| 110 |
+
**Description**
|
| 111 |
+
|
| 112 |
+
Lists users on the allowlist.
|
| 113 |
+
|
| 114 |
+
**Example:**
|
| 115 |
+
- ``[p]allowlist list``
|
| 116 |
+
|
| 117 |
+
.. _core-command-allowlist-remove:
|
| 118 |
+
|
| 119 |
+
""""""""""""""""
|
| 120 |
+
allowlist remove
|
| 121 |
+
""""""""""""""""
|
| 122 |
+
|
| 123 |
+
**Syntax**
|
| 124 |
+
|
| 125 |
+
.. code-block:: none
|
| 126 |
+
|
| 127 |
+
[p]allowlist remove <users...>
|
| 128 |
+
|
| 129 |
+
**Description**
|
| 130 |
+
|
| 131 |
+
Removes users from the allowlist.
|
| 132 |
+
|
| 133 |
+
The allowlist will be disabled if all users are removed.
|
| 134 |
+
|
| 135 |
+
**Examples:**
|
| 136 |
+
- ``[p]allowlist remove @26 @Will`` - Removes two users from the allowlist.
|
| 137 |
+
- ``[p]allowlist remove 262626262626262626`` - Removes a user by ID.
|
| 138 |
+
|
| 139 |
+
**Arguments:**
|
| 140 |
+
- ``<users...>`` - The user or users to remove from the allowlist.
|
| 141 |
+
|
| 142 |
+
.. _core-command-autoimmune:
|
| 143 |
+
|
| 144 |
+
^^^^^^^^^^
|
| 145 |
+
autoimmune
|
| 146 |
+
^^^^^^^^^^
|
| 147 |
+
|
| 148 |
+
.. note:: |guildowner-lock|
|
| 149 |
+
|
| 150 |
+
**Syntax**
|
| 151 |
+
|
| 152 |
+
.. code-block:: none
|
| 153 |
+
|
| 154 |
+
[p]autoimmune
|
| 155 |
+
|
| 156 |
+
**Description**
|
| 157 |
+
|
| 158 |
+
Commands to manage server settings for immunity from automated actions.
|
| 159 |
+
|
| 160 |
+
This includes duplicate message deletion and mention spam from the Mod cog, and filters from the Filter cog.
|
| 161 |
+
|
| 162 |
+
.. _core-command-autoimmune-add:
|
| 163 |
+
|
| 164 |
+
""""""""""""""
|
| 165 |
+
autoimmune add
|
| 166 |
+
""""""""""""""
|
| 167 |
+
|
| 168 |
+
**Syntax**
|
| 169 |
+
|
| 170 |
+
.. code-block:: none
|
| 171 |
+
|
| 172 |
+
[p]autoimmune add <user_or_role>
|
| 173 |
+
|
| 174 |
+
**Description**
|
| 175 |
+
|
| 176 |
+
Makes a user or role immune from automated moderation actions.
|
| 177 |
+
|
| 178 |
+
**Examples:**
|
| 179 |
+
- ``[p]autoimmune add @Twentysix`` - Adds a user.
|
| 180 |
+
- ``[p]autoimmune add @Mods`` - Adds a role.
|
| 181 |
+
|
| 182 |
+
**Arguments:**
|
| 183 |
+
- ``<user_or_role>`` - The user or role to add immunity to.
|
| 184 |
+
|
| 185 |
+
.. _core-command-autoimmune-isimmune:
|
| 186 |
+
|
| 187 |
+
"""""""""""""""""""
|
| 188 |
+
autoimmune isimmune
|
| 189 |
+
"""""""""""""""""""
|
| 190 |
+
|
| 191 |
+
**Syntax**
|
| 192 |
+
|
| 193 |
+
.. code-block:: none
|
| 194 |
+
|
| 195 |
+
[p]autoimmune isimmune <user_or_role>
|
| 196 |
+
|
| 197 |
+
**Description**
|
| 198 |
+
|
| 199 |
+
Checks if a user or role would be considered immune from automated actions.
|
| 200 |
+
|
| 201 |
+
**Examples:**
|
| 202 |
+
- ``[p]autoimmune isimmune @Twentysix``
|
| 203 |
+
- ``[p]autoimmune isimmune @Mods``
|
| 204 |
+
|
| 205 |
+
**Arguments:**
|
| 206 |
+
- ``<user_or_role>`` - The user or role to check the immunity of.
|
| 207 |
+
|
| 208 |
+
.. _core-command-autoimmune-list:
|
| 209 |
+
|
| 210 |
+
"""""""""""""""
|
| 211 |
+
autoimmune list
|
| 212 |
+
"""""""""""""""
|
| 213 |
+
|
| 214 |
+
**Syntax**
|
| 215 |
+
|
| 216 |
+
.. code-block:: none
|
| 217 |
+
|
| 218 |
+
[p]autoimmune list
|
| 219 |
+
|
| 220 |
+
**Description**
|
| 221 |
+
|
| 222 |
+
Gets the current members and roles configured for automatic moderation action immunity.
|
| 223 |
+
|
| 224 |
+
**Example:**
|
| 225 |
+
- ``[p]autoimmune list``
|
| 226 |
+
|
| 227 |
+
.. _core-command-autoimmune-remove:
|
| 228 |
+
|
| 229 |
+
"""""""""""""""""
|
| 230 |
+
autoimmune remove
|
| 231 |
+
"""""""""""""""""
|
| 232 |
+
|
| 233 |
+
**Syntax**
|
| 234 |
+
|
| 235 |
+
.. code-block:: none
|
| 236 |
+
|
| 237 |
+
[p]autoimmune remove <user_or_role>
|
| 238 |
+
|
| 239 |
+
**Description**
|
| 240 |
+
|
| 241 |
+
Remove a user or role from being immune to automated moderation actions.
|
| 242 |
+
|
| 243 |
+
**Examples:**
|
| 244 |
+
- ``[p]autoimmune remove @Twentysix`` - Removes a user.
|
| 245 |
+
- ``[p]autoimmune remove @Mods`` - Removes a role.
|
| 246 |
+
|
| 247 |
+
**Arguments:**
|
| 248 |
+
- ``<user_or_role>`` - The user or role to remove immunity from.
|
| 249 |
+
|
| 250 |
+
.. _core-command-bankset:
|
| 251 |
+
|
| 252 |
+
^^^^^^^
|
| 253 |
+
bankset
|
| 254 |
+
^^^^^^^
|
| 255 |
+
|
| 256 |
+
.. note:: |guildowner-lock|
|
| 257 |
+
|
| 258 |
+
**Syntax**
|
| 259 |
+
|
| 260 |
+
.. code-block:: none
|
| 261 |
+
|
| 262 |
+
[p]bankset
|
| 263 |
+
|
| 264 |
+
**Description**
|
| 265 |
+
|
| 266 |
+
Base command for configuring bank settings.
|
| 267 |
+
|
| 268 |
+
.. _core-command-bankset-bankname:
|
| 269 |
+
|
| 270 |
+
""""""""""""""""
|
| 271 |
+
bankset bankname
|
| 272 |
+
""""""""""""""""
|
| 273 |
+
|
| 274 |
+
.. note:: |owner-lock| However, if the bank is server-wide, the
|
| 275 |
+
server owner or an administrator can use this command.
|
| 276 |
+
|
| 277 |
+
**Syntax**
|
| 278 |
+
|
| 279 |
+
.. code-block:: none
|
| 280 |
+
|
| 281 |
+
[p]bankset bankname <name>
|
| 282 |
+
|
| 283 |
+
**Description**
|
| 284 |
+
|
| 285 |
+
Set bank's name.
|
| 286 |
+
|
| 287 |
+
**Arguments**
|
| 288 |
+
|
| 289 |
+
* ``<name>``: The new bank's name.
|
| 290 |
+
|
| 291 |
+
.. _core-command-bankset-creditsname:
|
| 292 |
+
|
| 293 |
+
"""""""""""""""""""
|
| 294 |
+
bankset creditsname
|
| 295 |
+
"""""""""""""""""""
|
| 296 |
+
|
| 297 |
+
.. note:: |owner-lock| However, if the bank is server-wide, the
|
| 298 |
+
server owner or an administrator can use this command.
|
| 299 |
+
|
| 300 |
+
**Syntax**
|
| 301 |
+
|
| 302 |
+
.. code-block:: none
|
| 303 |
+
|
| 304 |
+
[p]bankset creditsname <name>
|
| 305 |
+
|
| 306 |
+
**Description**
|
| 307 |
+
|
| 308 |
+
Change the credits name of the bank. It is ``credits`` by default.
|
| 309 |
+
|
| 310 |
+
For example, if you switch it to ``dollars``, the payday
|
| 311 |
+
command will show this:
|
| 312 |
+
|
| 313 |
+
.. TODO reference the payday command
|
| 314 |
+
|
| 315 |
+
.. code-block:: none
|
| 316 |
+
|
| 317 |
+
Here, take some dollars. Enjoy! (+120 dollars!)
|
| 318 |
+
|
| 319 |
+
You currently have 220 dollars.
|
| 320 |
+
|
| 321 |
+
**Arguments**
|
| 322 |
+
|
| 323 |
+
* ``<name>``: The new credits name.
|
| 324 |
+
|
| 325 |
+
.. _core-command-bankset-maxbal:
|
| 326 |
+
|
| 327 |
+
""""""""""""""
|
| 328 |
+
bankset maxbal
|
| 329 |
+
""""""""""""""
|
| 330 |
+
|
| 331 |
+
.. note:: |owner-lock| However, if the bank is server-wide, the
|
| 332 |
+
server owner or an administrator can use this command.
|
| 333 |
+
|
| 334 |
+
**Syntax**
|
| 335 |
+
|
| 336 |
+
.. code-block:: none
|
| 337 |
+
|
| 338 |
+
[p]bankset maxbal <amount>
|
| 339 |
+
|
| 340 |
+
**Description**
|
| 341 |
+
|
| 342 |
+
Defines the maximum amount of money a user can have with the bot.
|
| 343 |
+
|
| 344 |
+
If a user reaches this limit, they will be unable to gain more money.
|
| 345 |
+
|
| 346 |
+
**Arguments**
|
| 347 |
+
|
| 348 |
+
* ``<amount>``: The maximum amount of money for users.
|
| 349 |
+
|
| 350 |
+
.. _core-command-bankset-prune:
|
| 351 |
+
|
| 352 |
+
"""""""""""""
|
| 353 |
+
bankset prune
|
| 354 |
+
"""""""""""""
|
| 355 |
+
|
| 356 |
+
.. note:: |admin-lock|
|
| 357 |
+
|
| 358 |
+
**Syntax**
|
| 359 |
+
|
| 360 |
+
.. code-block:: none
|
| 361 |
+
|
| 362 |
+
[p]bankset prune
|
| 363 |
+
|
| 364 |
+
**Description**
|
| 365 |
+
|
| 366 |
+
Base command for pruning bank accounts.
|
| 367 |
+
|
| 368 |
+
.. _core-command-bankset-prune-global:
|
| 369 |
+
|
| 370 |
+
""""""""""""""""""""
|
| 371 |
+
bankset prune global
|
| 372 |
+
""""""""""""""""""""
|
| 373 |
+
|
| 374 |
+
.. note:: |owner-lock|
|
| 375 |
+
|
| 376 |
+
**Syntax**
|
| 377 |
+
|
| 378 |
+
.. code-block:: none
|
| 379 |
+
|
| 380 |
+
[p]bankset prune global [confirmation=False]
|
| 381 |
+
|
| 382 |
+
**Description**
|
| 383 |
+
|
| 384 |
+
Prune bank accounts for users who no longer share a server with the bot.
|
| 385 |
+
|
| 386 |
+
Cannot be used without a global bank. See ``[p]bankset prune server``.
|
| 387 |
+
|
| 388 |
+
Examples:
|
| 389 |
+
- ``[p]bankset prune global`` - Did not confirm. Shows the help message.
|
| 390 |
+
- ``[p]bankset prune global yes``
|
| 391 |
+
|
| 392 |
+
**Arguments**
|
| 393 |
+
|
| 394 |
+
- ``<confirmation>`` This will default to false unless specified.
|
| 395 |
+
|
| 396 |
+
.. _core-command-bankset-prune-server:
|
| 397 |
+
|
| 398 |
+
""""""""""""""""""""
|
| 399 |
+
bankset prune server
|
| 400 |
+
""""""""""""""""""""
|
| 401 |
+
|
| 402 |
+
.. note:: |guildowner-lock|
|
| 403 |
+
|
| 404 |
+
**Syntax**
|
| 405 |
+
|
| 406 |
+
.. code-block:: none
|
| 407 |
+
|
| 408 |
+
[p]bankset prune server [confirmation=False]
|
| 409 |
+
|
| 410 |
+
.. tip:: Aliases: ``bankset prune guild``, ``bankset prune local``
|
| 411 |
+
|
| 412 |
+
**Description**
|
| 413 |
+
|
| 414 |
+
Prune bank accounts for users no longer in the server.
|
| 415 |
+
|
| 416 |
+
Cannot be used with a global bank. See ``[p]bankset prune global``.
|
| 417 |
+
|
| 418 |
+
Examples:
|
| 419 |
+
- ``[p]bankset prune server`` - Did not confirm. Shows the help message.
|
| 420 |
+
- ``[p]bankset prune server yes``
|
| 421 |
+
|
| 422 |
+
**Arguments**
|
| 423 |
+
|
| 424 |
+
- ``<confirmation>`` This will default to false unless specified.
|
| 425 |
+
|
| 426 |
+
.. _core-command-bankset-prune-user:
|
| 427 |
+
|
| 428 |
+
""""""""""""""""""
|
| 429 |
+
bankset prune user
|
| 430 |
+
""""""""""""""""""
|
| 431 |
+
|
| 432 |
+
**Syntax**
|
| 433 |
+
|
| 434 |
+
.. code-block:: none
|
| 435 |
+
|
| 436 |
+
[p]bankset prune user <user> [confirmation=False]
|
| 437 |
+
|
| 438 |
+
**Description**
|
| 439 |
+
|
| 440 |
+
Delete the bank account of a specified user.
|
| 441 |
+
|
| 442 |
+
Examples:
|
| 443 |
+
- ``[p]bankset prune user @Twentysix`` - Did not confirm. Shows the help message.
|
| 444 |
+
- ``[p]bankset prune user @Twentysix yes``
|
| 445 |
+
|
| 446 |
+
**Arguments**
|
| 447 |
+
|
| 448 |
+
- ``<user>`` The user to delete the bank of. Takes mentions, names, and user ids.
|
| 449 |
+
- ``<confirmation>`` This will default to false unless specified.
|
| 450 |
+
|
| 451 |
+
.. _core-command-bankset-registeramount:
|
| 452 |
+
|
| 453 |
+
""""""""""""""""""""""
|
| 454 |
+
bankset registeramount
|
| 455 |
+
""""""""""""""""""""""
|
| 456 |
+
|
| 457 |
+
**Syntax**
|
| 458 |
+
|
| 459 |
+
.. code-block:: none
|
| 460 |
+
|
| 461 |
+
[p]bankset registeramount <creds>
|
| 462 |
+
|
| 463 |
+
**Description**
|
| 464 |
+
|
| 465 |
+
Set the initial balance for new bank accounts.
|
| 466 |
+
|
| 467 |
+
Example:
|
| 468 |
+
- ``[p]bankset registeramount 5000``
|
| 469 |
+
|
| 470 |
+
**Arguments**
|
| 471 |
+
|
| 472 |
+
- ``<creds>`` The new initial balance amount. Default is 0.
|
| 473 |
+
|
| 474 |
+
.. _core-command-bankset-reset:
|
| 475 |
+
|
| 476 |
+
"""""""""""""
|
| 477 |
+
bankset reset
|
| 478 |
+
"""""""""""""
|
| 479 |
+
|
| 480 |
+
.. note:: |guildowner-lock|
|
| 481 |
+
|
| 482 |
+
**Syntax**
|
| 483 |
+
|
| 484 |
+
.. code-block:: none
|
| 485 |
+
|
| 486 |
+
[p]bankset reset [confirmation=False]
|
| 487 |
+
|
| 488 |
+
**Description**
|
| 489 |
+
|
| 490 |
+
Delete all bank accounts.
|
| 491 |
+
|
| 492 |
+
Examples:
|
| 493 |
+
- ``[p]bankset reset`` - Did not confirm. Shows the help message.
|
| 494 |
+
- ``[p]bankset reset yes``
|
| 495 |
+
|
| 496 |
+
**Arguments**
|
| 497 |
+
|
| 498 |
+
- ``<confirmation>`` This will default to false unless specified.
|
| 499 |
+
|
| 500 |
+
.. _core-command-bankset-showsettings:
|
| 501 |
+
|
| 502 |
+
""""""""""""""""""""
|
| 503 |
+
bankset showsettings
|
| 504 |
+
""""""""""""""""""""
|
| 505 |
+
|
| 506 |
+
.. note:: |owner-lock| However, if the bank is server-wide, the
|
| 507 |
+
server owner or an administrator can use this command.
|
| 508 |
+
|
| 509 |
+
**Syntax**
|
| 510 |
+
|
| 511 |
+
.. code-block:: none
|
| 512 |
+
|
| 513 |
+
[p]bankset showsettings
|
| 514 |
+
|
| 515 |
+
**Description**
|
| 516 |
+
|
| 517 |
+
Shows the current settings of your bank.
|
| 518 |
+
|
| 519 |
+
This will display the following information:
|
| 520 |
+
|
| 521 |
+
* Name of the bank
|
| 522 |
+
* Scope of the bank (global or per server)
|
| 523 |
+
* Currency name
|
| 524 |
+
* Default balance
|
| 525 |
+
* Maximum allowed balance
|
| 526 |
+
|
| 527 |
+
.. _core-command-bankset-toggleglobal:
|
| 528 |
+
|
| 529 |
+
""""""""""""""""""""
|
| 530 |
+
bankset toggleglobal
|
| 531 |
+
""""""""""""""""""""
|
| 532 |
+
|
| 533 |
+
.. note:: |owner-lock|
|
| 534 |
+
|
| 535 |
+
**Syntax**
|
| 536 |
+
|
| 537 |
+
.. code-block:: none
|
| 538 |
+
|
| 539 |
+
[p]bankset toggleglobal [confirm=False]
|
| 540 |
+
|
| 541 |
+
**Description**
|
| 542 |
+
|
| 543 |
+
Makes the bank global instead of server-wide. If it
|
| 544 |
+
is already global, the command will switch it back
|
| 545 |
+
to the server-wide bank.
|
| 546 |
+
|
| 547 |
+
.. warning:: Using this command will reset **all** accounts.
|
| 548 |
+
|
| 549 |
+
**Arguments**
|
| 550 |
+
|
| 551 |
+
* ``[confirm=False]``: Put ``yes`` to confirm.
|
| 552 |
+
|
| 553 |
+
.. _core-command-blocklist:
|
| 554 |
+
|
| 555 |
+
^^^^^^^^^
|
| 556 |
+
blocklist
|
| 557 |
+
^^^^^^^^^
|
| 558 |
+
|
| 559 |
+
.. note:: |owner-lock|
|
| 560 |
+
|
| 561 |
+
**Syntax**
|
| 562 |
+
|
| 563 |
+
.. code-block:: none
|
| 564 |
+
|
| 565 |
+
[p]blocklist
|
| 566 |
+
|
| 567 |
+
.. tip:: Aliases: ``blacklist``, ``denylist``
|
| 568 |
+
|
| 569 |
+
**Description**
|
| 570 |
+
|
| 571 |
+
Commands to manage the blocklist.
|
| 572 |
+
|
| 573 |
+
Use ``[p]blocklist clear`` to disable the blocklist
|
| 574 |
+
|
| 575 |
+
.. _core-command-blocklist-add:
|
| 576 |
+
|
| 577 |
+
"""""""""""""
|
| 578 |
+
blocklist add
|
| 579 |
+
"""""""""""""
|
| 580 |
+
|
| 581 |
+
**Syntax**
|
| 582 |
+
|
| 583 |
+
.. code-block:: none
|
| 584 |
+
|
| 585 |
+
[p]blocklist add <users...>
|
| 586 |
+
|
| 587 |
+
**Description**
|
| 588 |
+
|
| 589 |
+
Adds users to the blocklist.
|
| 590 |
+
|
| 591 |
+
**Examples:**
|
| 592 |
+
- ``[p]blocklist add @26 @Will`` - Adds two users to the blocklist.
|
| 593 |
+
- ``[p]blocklist add 262626262626262626`` - Blocks a user by ID.
|
| 594 |
+
|
| 595 |
+
**Arguments:**
|
| 596 |
+
- ``<users...>`` - The user or users to add to the blocklist.
|
| 597 |
+
|
| 598 |
+
.. _core-command-blocklist-clear:
|
| 599 |
+
|
| 600 |
+
"""""""""""""""
|
| 601 |
+
blocklist clear
|
| 602 |
+
"""""""""""""""
|
| 603 |
+
|
| 604 |
+
**Syntax**
|
| 605 |
+
|
| 606 |
+
.. code-block:: none
|
| 607 |
+
|
| 608 |
+
[p]blocklist clear
|
| 609 |
+
|
| 610 |
+
**Description**
|
| 611 |
+
|
| 612 |
+
Clears the blocklist.
|
| 613 |
+
|
| 614 |
+
**Example:**
|
| 615 |
+
- ``[p]blocklist clear``
|
| 616 |
+
|
| 617 |
+
.. _core-command-blocklist-list:
|
| 618 |
+
|
| 619 |
+
""""""""""""""
|
| 620 |
+
blocklist list
|
| 621 |
+
""""""""""""""
|
| 622 |
+
|
| 623 |
+
**Syntax**
|
| 624 |
+
|
| 625 |
+
.. code-block:: none
|
| 626 |
+
|
| 627 |
+
[p]blocklist list
|
| 628 |
+
|
| 629 |
+
**Description**
|
| 630 |
+
|
| 631 |
+
Lists users on the blocklist.
|
| 632 |
+
|
| 633 |
+
**Example:**
|
| 634 |
+
- ``[p]blocklist list``
|
| 635 |
+
|
| 636 |
+
.. _core-command-blocklist-remove:
|
| 637 |
+
|
| 638 |
+
""""""""""""""""
|
| 639 |
+
blocklist remove
|
| 640 |
+
""""""""""""""""
|
| 641 |
+
|
| 642 |
+
**Syntax**
|
| 643 |
+
|
| 644 |
+
.. code-block:: none
|
| 645 |
+
|
| 646 |
+
[p]blocklist remove <users...>
|
| 647 |
+
|
| 648 |
+
**Description**
|
| 649 |
+
|
| 650 |
+
Removes users from the blocklist.
|
| 651 |
+
|
| 652 |
+
**Examples:**
|
| 653 |
+
- ``[p]blocklist remove @26 @Will`` - Removes two users from the blocklist.
|
| 654 |
+
- ``[p]blocklist remove 262626262626262626`` - Removes a user by ID.
|
| 655 |
+
|
| 656 |
+
**Arguments:**
|
| 657 |
+
- ``<users...>`` - The user or users to remove from the blocklist.
|
| 658 |
+
|
| 659 |
+
.. _core-command-command:
|
| 660 |
+
|
| 661 |
+
^^^^^^^
|
| 662 |
+
command
|
| 663 |
+
^^^^^^^
|
| 664 |
+
|
| 665 |
+
.. note:: |guildowner-lock|
|
| 666 |
+
|
| 667 |
+
**Syntax**
|
| 668 |
+
|
| 669 |
+
.. code-block:: none
|
| 670 |
+
|
| 671 |
+
[p]command
|
| 672 |
+
|
| 673 |
+
**Description**
|
| 674 |
+
|
| 675 |
+
Commands to enable and disable commands and cogs.
|
| 676 |
+
|
| 677 |
+
.. _core-command-command-defaultdisablecog:
|
| 678 |
+
|
| 679 |
+
"""""""""""""""""""""""""
|
| 680 |
+
command defaultdisablecog
|
| 681 |
+
"""""""""""""""""""""""""
|
| 682 |
+
|
| 683 |
+
.. note:: |owner-lock|
|
| 684 |
+
|
| 685 |
+
**Syntax**
|
| 686 |
+
|
| 687 |
+
.. code-block:: none
|
| 688 |
+
|
| 689 |
+
[p]command defaultdisablecog <cog>
|
| 690 |
+
|
| 691 |
+
**Description**
|
| 692 |
+
|
| 693 |
+
Set the default state for a cog as disabled.
|
| 694 |
+
|
| 695 |
+
This will disable the cog for all servers by default.
|
| 696 |
+
To override it, use ``[p]command enablecog`` on the servers you want to allow usage.
|
| 697 |
+
|
| 698 |
+
.. Note:: This will only work on loaded cogs, and must reference the title-case cog name.
|
| 699 |
+
|
| 700 |
+
|
| 701 |
+
**Examples:**
|
| 702 |
+
- ``[p]command defaultdisablecog Economy``
|
| 703 |
+
- ``[p]command defaultdisablecog ModLog``
|
| 704 |
+
|
| 705 |
+
**Arguments:**
|
| 706 |
+
- ``<cog>`` - The name of the cog to make disabled by default. Must be title-case.
|
| 707 |
+
|
| 708 |
+
.. _core-command-command-defaultenablecog:
|
| 709 |
+
|
| 710 |
+
""""""""""""""""""""""""
|
| 711 |
+
command defaultenablecog
|
| 712 |
+
""""""""""""""""""""""""
|
| 713 |
+
|
| 714 |
+
.. note:: |owner-lock|
|
| 715 |
+
|
| 716 |
+
**Syntax**
|
| 717 |
+
|
| 718 |
+
.. code-block:: none
|
| 719 |
+
|
| 720 |
+
[p]command defaultenablecog <cog>
|
| 721 |
+
|
| 722 |
+
**Description**
|
| 723 |
+
|
| 724 |
+
Set the default state for a cog as enabled.
|
| 725 |
+
|
| 726 |
+
This will re-enable the cog for all servers by default.
|
| 727 |
+
To override it, use ``[p]command disablecog`` on the servers you want to disallow usage.
|
| 728 |
+
|
| 729 |
+
.. Note:: This will only work on loaded cogs, and must reference the title-case cog name.
|
| 730 |
+
|
| 731 |
+
|
| 732 |
+
**Examples:**
|
| 733 |
+
- ``[p]command defaultenablecog Economy``
|
| 734 |
+
- ``[p]command defaultenablecog ModLog``
|
| 735 |
+
|
| 736 |
+
**Arguments:**
|
| 737 |
+
- ``<cog>`` - The name of the cog to make enabled by default. Must be title-case.
|
| 738 |
+
|
| 739 |
+
.. _core-command-command-disable:
|
| 740 |
+
|
| 741 |
+
"""""""""""""""
|
| 742 |
+
command disable
|
| 743 |
+
"""""""""""""""
|
| 744 |
+
|
| 745 |
+
**Syntax**
|
| 746 |
+
|
| 747 |
+
.. code-block:: none
|
| 748 |
+
|
| 749 |
+
[p]command disable <command>
|
| 750 |
+
|
| 751 |
+
**Description**
|
| 752 |
+
|
| 753 |
+
Disable a command.
|
| 754 |
+
|
| 755 |
+
If you're the bot owner, this will disable commands globally by default.
|
| 756 |
+
Otherwise, this will disable commands on the current server.
|
| 757 |
+
|
| 758 |
+
**Examples:**
|
| 759 |
+
- ``[p]command disable userinfo`` - Disables the ``userinfo`` command in the Mod cog.
|
| 760 |
+
- ``[p]command disable urban`` - Disables the ``urban`` command in the General cog.
|
| 761 |
+
|
| 762 |
+
**Arguments:**
|
| 763 |
+
- ``<command>`` - The command to disable.
|
| 764 |
+
|
| 765 |
+
.. _core-command-command-disable-global:
|
| 766 |
+
|
| 767 |
+
""""""""""""""""""""""
|
| 768 |
+
command disable global
|
| 769 |
+
""""""""""""""""""""""
|
| 770 |
+
|
| 771 |
+
.. note:: |owner-lock|
|
| 772 |
+
|
| 773 |
+
**Syntax**
|
| 774 |
+
|
| 775 |
+
.. code-block:: none
|
| 776 |
+
|
| 777 |
+
[p]command disable global <command>
|
| 778 |
+
|
| 779 |
+
**Description**
|
| 780 |
+
|
| 781 |
+
Disable a command globally.
|
| 782 |
+
|
| 783 |
+
**Examples:**
|
| 784 |
+
- ``[p]command disable global userinfo`` - Disables the ``userinfo`` command in the Mod cog.
|
| 785 |
+
- ``[p]command disable global urban`` - Disables the ``urban`` command in the General cog.
|
| 786 |
+
|
| 787 |
+
**Arguments:**
|
| 788 |
+
- ``<command>`` - The command to disable globally.
|
| 789 |
+
|
| 790 |
+
.. _core-command-command-disable-server:
|
| 791 |
+
|
| 792 |
+
""""""""""""""""""""""
|
| 793 |
+
command disable server
|
| 794 |
+
""""""""""""""""""""""
|
| 795 |
+
|
| 796 |
+
**Syntax**
|
| 797 |
+
|
| 798 |
+
.. code-block:: none
|
| 799 |
+
|
| 800 |
+
[p]command disable server <command>
|
| 801 |
+
|
| 802 |
+
.. tip:: Alias: ``command disable guild``
|
| 803 |
+
|
| 804 |
+
**Description**
|
| 805 |
+
|
| 806 |
+
Disable a command in this server only.
|
| 807 |
+
|
| 808 |
+
**Examples:**
|
| 809 |
+
- ``[p]command disable server userinfo`` - Disables the ``userinfo`` command in the Mod cog.
|
| 810 |
+
- ``[p]command disable server urban`` - Disables the ``urban`` command in the General cog.
|
| 811 |
+
|
| 812 |
+
**Arguments:**
|
| 813 |
+
- ``<command>`` - The command to disable for the current server.
|
| 814 |
+
|
| 815 |
+
.. _core-command-command-disablecog:
|
| 816 |
+
|
| 817 |
+
""""""""""""""""""
|
| 818 |
+
command disablecog
|
| 819 |
+
""""""""""""""""""
|
| 820 |
+
|
| 821 |
+
**Syntax**
|
| 822 |
+
|
| 823 |
+
.. code-block:: none
|
| 824 |
+
|
| 825 |
+
[p]command disablecog <cog>
|
| 826 |
+
|
| 827 |
+
**Description**
|
| 828 |
+
|
| 829 |
+
Disable a cog in this server.
|
| 830 |
+
|
| 831 |
+
.. Note:: This will only work on loaded cogs, and must reference the title-case cog name.
|
| 832 |
+
|
| 833 |
+
|
| 834 |
+
**Examples:**
|
| 835 |
+
- ``[p]command disablecog Economy``
|
| 836 |
+
- ``[p]command disablecog ModLog``
|
| 837 |
+
|
| 838 |
+
**Arguments:**
|
| 839 |
+
- ``<cog>`` - The name of the cog to disable on this server. Must be title-case.
|
| 840 |
+
|
| 841 |
+
.. _core-command-command-disabledmsg:
|
| 842 |
+
|
| 843 |
+
"""""""""""""""""""
|
| 844 |
+
command disabledmsg
|
| 845 |
+
"""""""""""""""""""
|
| 846 |
+
|
| 847 |
+
.. note:: |owner-lock|
|
| 848 |
+
|
| 849 |
+
**Syntax**
|
| 850 |
+
|
| 851 |
+
.. code-block:: none
|
| 852 |
+
|
| 853 |
+
[p]command disabledmsg [message]
|
| 854 |
+
|
| 855 |
+
**Description**
|
| 856 |
+
|
| 857 |
+
Set the bot's response to disabled commands.
|
| 858 |
+
|
| 859 |
+
Leave blank to send nothing.
|
| 860 |
+
|
| 861 |
+
To include the command name in the message, include the ``{command}`` placeholder.
|
| 862 |
+
|
| 863 |
+
**Examples:**
|
| 864 |
+
- ``[p]command disabledmsg This command is disabled``
|
| 865 |
+
- ``[p]command disabledmsg {command} is disabled``
|
| 866 |
+
- ``[p]command disabledmsg`` - Sends nothing when a disabled command is attempted.
|
| 867 |
+
|
| 868 |
+
**Arguments:**
|
| 869 |
+
- ``[message]`` - The message to send when a disabled command is attempted.
|
| 870 |
+
|
| 871 |
+
.. _core-command-command-enable:
|
| 872 |
+
|
| 873 |
+
""""""""""""""
|
| 874 |
+
command enable
|
| 875 |
+
""""""""""""""
|
| 876 |
+
|
| 877 |
+
**Syntax**
|
| 878 |
+
|
| 879 |
+
.. code-block:: none
|
| 880 |
+
|
| 881 |
+
[p]command enable <command>
|
| 882 |
+
|
| 883 |
+
**Description**
|
| 884 |
+
|
| 885 |
+
Enable a command.
|
| 886 |
+
|
| 887 |
+
If you're the bot owner, this will try to enable a globally disabled command by default.
|
| 888 |
+
Otherwise, this will try to enable a command disabled on the current server.
|
| 889 |
+
|
| 890 |
+
**Examples:**
|
| 891 |
+
- ``[p]command enable userinfo`` - Enables the ``userinfo`` command in the Mod cog.
|
| 892 |
+
- ``[p]command enable urban`` - Enables the ``urban`` command in the General cog.
|
| 893 |
+
|
| 894 |
+
**Arguments:**
|
| 895 |
+
- ``<command>`` - The command to enable.
|
| 896 |
+
|
| 897 |
+
.. _core-command-command-enable-global:
|
| 898 |
+
|
| 899 |
+
"""""""""""""""""""""
|
| 900 |
+
command enable global
|
| 901 |
+
"""""""""""""""""""""
|
| 902 |
+
|
| 903 |
+
.. note:: |owner-lock|
|
| 904 |
+
|
| 905 |
+
**Syntax**
|
| 906 |
+
|
| 907 |
+
.. code-block:: none
|
| 908 |
+
|
| 909 |
+
[p]command enable global <command>
|
| 910 |
+
|
| 911 |
+
**Description**
|
| 912 |
+
|
| 913 |
+
Enable a command globally.
|
| 914 |
+
|
| 915 |
+
**Examples:**
|
| 916 |
+
- ``[p]command enable global userinfo`` - Enables the ``userinfo`` command in the Mod cog.
|
| 917 |
+
- ``[p]command enable global urban`` - Enables the ``urban`` command in the General cog.
|
| 918 |
+
|
| 919 |
+
**Arguments:**
|
| 920 |
+
- ``<command>`` - The command to enable globally.
|
| 921 |
+
|
| 922 |
+
.. _core-command-command-enable-server:
|
| 923 |
+
|
| 924 |
+
"""""""""""""""""""""
|
| 925 |
+
command enable server
|
| 926 |
+
"""""""""""""""""""""
|
| 927 |
+
|
| 928 |
+
**Syntax**
|
| 929 |
+
|
| 930 |
+
.. code-block:: none
|
| 931 |
+
|
| 932 |
+
[p]command enable server <command>
|
| 933 |
+
|
| 934 |
+
.. tip:: Alias: ``command enable guild``
|
| 935 |
+
|
| 936 |
+
**Description**
|
| 937 |
+
|
| 938 |
+
Enable a command in this server.
|
| 939 |
+
|
| 940 |
+
**Examples:**
|
| 941 |
+
- ``[p]command enable server userinfo`` - Enables the ``userinfo`` command in the Mod cog.
|
| 942 |
+
- ``[p]command enable server urban`` - Enables the ``urban`` command in the General cog.
|
| 943 |
+
|
| 944 |
+
**Arguments:**
|
| 945 |
+
- ``<command>`` - The command to enable for the current server.
|
| 946 |
+
|
| 947 |
+
.. _core-command-command-enablecog:
|
| 948 |
+
|
| 949 |
+
"""""""""""""""""
|
| 950 |
+
command enablecog
|
| 951 |
+
"""""""""""""""""
|
| 952 |
+
|
| 953 |
+
**Syntax**
|
| 954 |
+
|
| 955 |
+
.. code-block:: none
|
| 956 |
+
|
| 957 |
+
[p]command enablecog <cog>
|
| 958 |
+
|
| 959 |
+
**Description**
|
| 960 |
+
|
| 961 |
+
Enable a cog in this server.
|
| 962 |
+
|
| 963 |
+
.. Note:: This will only work on loaded cogs, and must reference the title-case cog name.
|
| 964 |
+
|
| 965 |
+
|
| 966 |
+
**Examples:**
|
| 967 |
+
- ``[p]command enablecog Economy``
|
| 968 |
+
- ``[p]command enablecog ModLog``
|
| 969 |
+
|
| 970 |
+
**Arguments:**
|
| 971 |
+
- ``<cog>`` - The name of the cog to enable on this server. Must be title-case.
|
| 972 |
+
|
| 973 |
+
.. _core-command-command-listdisabled:
|
| 974 |
+
|
| 975 |
+
""""""""""""""""""""
|
| 976 |
+
command listdisabled
|
| 977 |
+
""""""""""""""""""""
|
| 978 |
+
|
| 979 |
+
**Syntax**
|
| 980 |
+
|
| 981 |
+
.. code-block:: none
|
| 982 |
+
|
| 983 |
+
[p]command listdisabled
|
| 984 |
+
|
| 985 |
+
**Description**
|
| 986 |
+
|
| 987 |
+
List disabled commands.
|
| 988 |
+
|
| 989 |
+
If you're the bot owner, this will show global disabled commands by default.
|
| 990 |
+
Otherwise, this will show disabled commands on the current server.
|
| 991 |
+
|
| 992 |
+
**Example:**
|
| 993 |
+
- ``[p]command listdisabled``
|
| 994 |
+
|
| 995 |
+
.. _core-command-command-listdisabled-global:
|
| 996 |
+
|
| 997 |
+
"""""""""""""""""""""""""""
|
| 998 |
+
command listdisabled global
|
| 999 |
+
"""""""""""""""""""""""""""
|
| 1000 |
+
|
| 1001 |
+
**Syntax**
|
| 1002 |
+
|
| 1003 |
+
.. code-block:: none
|
| 1004 |
+
|
| 1005 |
+
[p]command listdisabled global
|
| 1006 |
+
|
| 1007 |
+
**Description**
|
| 1008 |
+
|
| 1009 |
+
List disabled commands globally.
|
| 1010 |
+
|
| 1011 |
+
**Example:**
|
| 1012 |
+
- ``[p]command listdisabled global``
|
| 1013 |
+
|
| 1014 |
+
.. _core-command-command-listdisabled-guild:
|
| 1015 |
+
|
| 1016 |
+
""""""""""""""""""""""""""
|
| 1017 |
+
command listdisabled guild
|
| 1018 |
+
""""""""""""""""""""""""""
|
| 1019 |
+
|
| 1020 |
+
**Syntax**
|
| 1021 |
+
|
| 1022 |
+
.. code-block:: none
|
| 1023 |
+
|
| 1024 |
+
[p]command listdisabled guild
|
| 1025 |
+
|
| 1026 |
+
**Description**
|
| 1027 |
+
|
| 1028 |
+
List disabled commands in this server.
|
| 1029 |
+
|
| 1030 |
+
**Example:**
|
| 1031 |
+
- ``[p]command listdisabled guild``
|
| 1032 |
+
|
| 1033 |
+
.. _core-command-command-listdisabledcogs:
|
| 1034 |
+
|
| 1035 |
+
""""""""""""""""""""""""
|
| 1036 |
+
command listdisabledcogs
|
| 1037 |
+
""""""""""""""""""""""""
|
| 1038 |
+
|
| 1039 |
+
**Syntax**
|
| 1040 |
+
|
| 1041 |
+
.. code-block:: none
|
| 1042 |
+
|
| 1043 |
+
[p]command listdisabledcogs
|
| 1044 |
+
|
| 1045 |
+
**Description**
|
| 1046 |
+
|
| 1047 |
+
List the cogs which are disabled in this server.
|
| 1048 |
+
|
| 1049 |
+
**Example:**
|
| 1050 |
+
- ``[p]command listdisabledcogs``
|
| 1051 |
+
|
| 1052 |
+
.. _core-command-contact:
|
| 1053 |
+
|
| 1054 |
+
^^^^^^^
|
| 1055 |
+
contact
|
| 1056 |
+
^^^^^^^
|
| 1057 |
+
|
| 1058 |
+
**Syntax**
|
| 1059 |
+
|
| 1060 |
+
.. code-block:: none
|
| 1061 |
+
|
| 1062 |
+
[p]contact <message>
|
| 1063 |
+
|
| 1064 |
+
**Description**
|
| 1065 |
+
|
| 1066 |
+
Sends a message to the owner.
|
| 1067 |
+
|
| 1068 |
+
This is limited to one message every 60 seconds per person.
|
| 1069 |
+
|
| 1070 |
+
**Example:**
|
| 1071 |
+
- ``[p]contact Help! The bot has become sentient!``
|
| 1072 |
+
|
| 1073 |
+
**Arguments:**
|
| 1074 |
+
- ``[message]`` - The message to send to the owner.
|
| 1075 |
+
|
| 1076 |
+
.. _core-command-diagnoseissues:
|
| 1077 |
+
|
| 1078 |
+
^^^^^^^^^^^^^^
|
| 1079 |
+
diagnoseissues
|
| 1080 |
+
^^^^^^^^^^^^^^
|
| 1081 |
+
|
| 1082 |
+
**Syntax**
|
| 1083 |
+
|
| 1084 |
+
.. code-block:: none
|
| 1085 |
+
|
| 1086 |
+
[p]diagnoseissues [channel] <member> <command_name>
|
| 1087 |
+
|
| 1088 |
+
**Description**
|
| 1089 |
+
|
| 1090 |
+
Diagnose issues with the command checks with ease!
|
| 1091 |
+
|
| 1092 |
+
If you want to diagnose the command from a text channel in a different server,
|
| 1093 |
+
you can do so by using the command in DMs.
|
| 1094 |
+
|
| 1095 |
+
**Example:**
|
| 1096 |
+
- ``[p]diagnoseissues #general @Slime ban`` - Diagnose why @Slime can't use ``[p]ban`` in #general channel.
|
| 1097 |
+
|
| 1098 |
+
**Arguments:**
|
| 1099 |
+
- ``[channel]`` - The text channel that the command should be tested for. Defaults to the current channel.
|
| 1100 |
+
- ``<member>`` - The member that should be considered as the command caller.
|
| 1101 |
+
- ``<command_name>`` - The name of the command to test.
|
| 1102 |
+
|
| 1103 |
+
.. _core-command-dm:
|
| 1104 |
+
|
| 1105 |
+
^^
|
| 1106 |
+
dm
|
| 1107 |
+
^^
|
| 1108 |
+
|
| 1109 |
+
.. note:: |owner-lock|
|
| 1110 |
+
|
| 1111 |
+
**Syntax**
|
| 1112 |
+
|
| 1113 |
+
.. code-block:: none
|
| 1114 |
+
|
| 1115 |
+
[p]dm <user_id> <message>
|
| 1116 |
+
|
| 1117 |
+
**Description**
|
| 1118 |
+
|
| 1119 |
+
Sends a DM to a user.
|
| 1120 |
+
|
| 1121 |
+
This command needs a user ID to work.
|
| 1122 |
+
|
| 1123 |
+
To get a user ID, go to Discord's settings and open the 'Appearance' tab.
|
| 1124 |
+
Enable 'Developer Mode', then right click a user and click on 'Copy ID'.
|
| 1125 |
+
|
| 1126 |
+
**Example:**
|
| 1127 |
+
- ``[p]dm 262626262626262626 Do you like me? Yes / No``
|
| 1128 |
+
|
| 1129 |
+
**Arguments:**
|
| 1130 |
+
- ``[message]`` - The message to dm to the user.
|
| 1131 |
+
|
| 1132 |
+
.. _core-command-embedset:
|
| 1133 |
+
|
| 1134 |
+
^^^^^^^^
|
| 1135 |
+
embedset
|
| 1136 |
+
^^^^^^^^
|
| 1137 |
+
|
| 1138 |
+
**Syntax**
|
| 1139 |
+
|
| 1140 |
+
.. code-block:: none
|
| 1141 |
+
|
| 1142 |
+
[p]embedset
|
| 1143 |
+
|
| 1144 |
+
**Description**
|
| 1145 |
+
|
| 1146 |
+
Commands for toggling embeds on or off.
|
| 1147 |
+
|
| 1148 |
+
This setting determines whether or not to use embeds as a response to a command (for commands that support it).
|
| 1149 |
+
The default is to use embeds.
|
| 1150 |
+
|
| 1151 |
+
The embed settings are checked until the first True/False in this order:
|
| 1152 |
+
- In guild context:
|
| 1153 |
+
1. Channel override - ``[p]embedset channel``
|
| 1154 |
+
2. Server command override - ``[p]embedset command server``
|
| 1155 |
+
3. Server override - ``[p]embedset server``
|
| 1156 |
+
4. Global command override - ``[p]embedset command global``
|
| 1157 |
+
5. Global setting -``[p]embedset global``
|
| 1158 |
+
|
| 1159 |
+
- In DM context:
|
| 1160 |
+
1. User override - ``[p]embedset user``
|
| 1161 |
+
2. Global command override - ``[p]embedset command global``
|
| 1162 |
+
3. Global setting - ``[p]embedset global``
|
| 1163 |
+
|
| 1164 |
+
.. _core-command-embedset-channel:
|
| 1165 |
+
|
| 1166 |
+
""""""""""""""""
|
| 1167 |
+
embedset channel
|
| 1168 |
+
""""""""""""""""
|
| 1169 |
+
|
| 1170 |
+
.. note:: |guildowner-lock|
|
| 1171 |
+
|
| 1172 |
+
**Syntax**
|
| 1173 |
+
|
| 1174 |
+
.. code-block:: none
|
| 1175 |
+
|
| 1176 |
+
[p]embedset channel [enabled]
|
| 1177 |
+
|
| 1178 |
+
**Description**
|
| 1179 |
+
|
| 1180 |
+
Set's a channel's embed setting.
|
| 1181 |
+
|
| 1182 |
+
If set, this is used instead of the guild and command defaults to determine whether or not to use embeds.
|
| 1183 |
+
This is used for all commands done in a channel.
|
| 1184 |
+
|
| 1185 |
+
If enabled is left blank, the setting will be unset and the guild default will be used instead.
|
| 1186 |
+
|
| 1187 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1188 |
+
|
| 1189 |
+
**Examples:**
|
| 1190 |
+
- ``[p]embedset channel False`` - Disables embeds in this channel.
|
| 1191 |
+
- ``[p]embedset channel`` - Resets value to use guild default.
|
| 1192 |
+
|
| 1193 |
+
**Arguments:**
|
| 1194 |
+
- ``[enabled]`` - Whether to use embeds in this channel. Leave blank to reset to default.
|
| 1195 |
+
|
| 1196 |
+
.. _core-command-embedset-command:
|
| 1197 |
+
|
| 1198 |
+
""""""""""""""""
|
| 1199 |
+
embedset command
|
| 1200 |
+
""""""""""""""""
|
| 1201 |
+
|
| 1202 |
+
.. note:: |guildowner-lock|
|
| 1203 |
+
|
| 1204 |
+
**Syntax**
|
| 1205 |
+
|
| 1206 |
+
.. code-block:: none
|
| 1207 |
+
|
| 1208 |
+
[p]embedset command <command> [enabled]
|
| 1209 |
+
|
| 1210 |
+
**Description**
|
| 1211 |
+
|
| 1212 |
+
Sets a command's embed setting.
|
| 1213 |
+
|
| 1214 |
+
If you're the bot owner, this will try to change the command's embed setting globally by default.
|
| 1215 |
+
Otherwise, this will try to change embed settings on the current server.
|
| 1216 |
+
|
| 1217 |
+
If enabled is left blank, the setting will be unset.
|
| 1218 |
+
|
| 1219 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1220 |
+
|
| 1221 |
+
**Examples:**
|
| 1222 |
+
- ``[p]embedset command info`` - Clears command specific embed settings for 'info'.
|
| 1223 |
+
- ``[p]embedset command info False`` - Disables embeds for 'info'.
|
| 1224 |
+
- ``[p]embedset command "ignore list" True`` - Quotes are needed for subcommands.
|
| 1225 |
+
|
| 1226 |
+
**Arguments:**
|
| 1227 |
+
- ``[enabled]`` - Whether to use embeds for this command. Leave blank to reset to default.
|
| 1228 |
+
|
| 1229 |
+
.. _core-command-embedset-command-global:
|
| 1230 |
+
|
| 1231 |
+
"""""""""""""""""""""""
|
| 1232 |
+
embedset command global
|
| 1233 |
+
"""""""""""""""""""""""
|
| 1234 |
+
|
| 1235 |
+
.. note:: |owner-lock|
|
| 1236 |
+
|
| 1237 |
+
**Syntax**
|
| 1238 |
+
|
| 1239 |
+
.. code-block:: none
|
| 1240 |
+
|
| 1241 |
+
[p]embedset command global <command> [enabled]
|
| 1242 |
+
|
| 1243 |
+
**Description**
|
| 1244 |
+
|
| 1245 |
+
Sets a command's embed setting globally.
|
| 1246 |
+
|
| 1247 |
+
If set, this is used instead of the global default to determine whether or not to use embeds.
|
| 1248 |
+
|
| 1249 |
+
If enabled is left blank, the setting will be unset.
|
| 1250 |
+
|
| 1251 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1252 |
+
|
| 1253 |
+
**Examples:**
|
| 1254 |
+
- ``[p]embedset command global info`` - Clears command specific embed settings for 'info'.
|
| 1255 |
+
- ``[p]embedset command global info False`` - Disables embeds for 'info'.
|
| 1256 |
+
- ``[p]embedset command global "ignore list" True`` - Quotes are needed for subcommands.
|
| 1257 |
+
|
| 1258 |
+
**Arguments:**
|
| 1259 |
+
- ``[enabled]`` - Whether to use embeds for this command. Leave blank to reset to default.
|
| 1260 |
+
|
| 1261 |
+
.. _core-command-embedset-command-server:
|
| 1262 |
+
|
| 1263 |
+
"""""""""""""""""""""""
|
| 1264 |
+
embedset command server
|
| 1265 |
+
"""""""""""""""""""""""
|
| 1266 |
+
|
| 1267 |
+
**Syntax**
|
| 1268 |
+
|
| 1269 |
+
.. code-block:: none
|
| 1270 |
+
|
| 1271 |
+
[p]embedset command server <command> [enabled]
|
| 1272 |
+
|
| 1273 |
+
.. tip:: Alias: ``embedset command guild``
|
| 1274 |
+
|
| 1275 |
+
**Description**
|
| 1276 |
+
|
| 1277 |
+
Sets a command's embed setting for the current server.
|
| 1278 |
+
|
| 1279 |
+
If set, this is used instead of the server default to determine whether or not to use embeds.
|
| 1280 |
+
|
| 1281 |
+
If enabled is left blank, the setting will be unset and the server default will be used instead.
|
| 1282 |
+
|
| 1283 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1284 |
+
|
| 1285 |
+
**Examples:**
|
| 1286 |
+
- ``[p]embedset command server info`` - Clears command specific embed settings for 'info'.
|
| 1287 |
+
- ``[p]embedset command server info False`` - Disables embeds for 'info'.
|
| 1288 |
+
- ``[p]embedset command server "ignore list" True`` - Quotes are needed for subcommands.
|
| 1289 |
+
|
| 1290 |
+
**Arguments:**
|
| 1291 |
+
- ``[enabled]`` - Whether to use embeds for this command. Leave blank to reset to default.
|
| 1292 |
+
|
| 1293 |
+
.. _core-command-embedset-global:
|
| 1294 |
+
|
| 1295 |
+
"""""""""""""""
|
| 1296 |
+
embedset global
|
| 1297 |
+
"""""""""""""""
|
| 1298 |
+
|
| 1299 |
+
.. note:: |owner-lock|
|
| 1300 |
+
|
| 1301 |
+
**Syntax**
|
| 1302 |
+
|
| 1303 |
+
.. code-block:: none
|
| 1304 |
+
|
| 1305 |
+
[p]embedset global
|
| 1306 |
+
|
| 1307 |
+
**Description**
|
| 1308 |
+
|
| 1309 |
+
Toggle the global embed setting.
|
| 1310 |
+
|
| 1311 |
+
This is used as a fallback if the user or guild hasn't set a preference.
|
| 1312 |
+
The default is to use embeds.
|
| 1313 |
+
|
| 1314 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1315 |
+
|
| 1316 |
+
**Example:**
|
| 1317 |
+
- ``[p]embedset global``
|
| 1318 |
+
|
| 1319 |
+
.. _core-command-embedset-server:
|
| 1320 |
+
|
| 1321 |
+
"""""""""""""""
|
| 1322 |
+
embedset server
|
| 1323 |
+
"""""""""""""""
|
| 1324 |
+
|
| 1325 |
+
.. note:: |guildowner-lock|
|
| 1326 |
+
|
| 1327 |
+
**Syntax**
|
| 1328 |
+
|
| 1329 |
+
.. code-block:: none
|
| 1330 |
+
|
| 1331 |
+
[p]embedset server [enabled]
|
| 1332 |
+
|
| 1333 |
+
.. tip:: Alias: ``embedset guild``
|
| 1334 |
+
|
| 1335 |
+
**Description**
|
| 1336 |
+
|
| 1337 |
+
Set the server's embed setting.
|
| 1338 |
+
|
| 1339 |
+
If set, this is used instead of the global default to determine whether or not to use embeds.
|
| 1340 |
+
This is used for all commands done in a server.
|
| 1341 |
+
|
| 1342 |
+
If enabled is left blank, the setting will be unset and the global default will be used instead.
|
| 1343 |
+
|
| 1344 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1345 |
+
|
| 1346 |
+
**Examples:**
|
| 1347 |
+
- ``[p]embedset server False`` - Disables embeds on this server.
|
| 1348 |
+
- ``[p]embedset server`` - Resets value to use global default.
|
| 1349 |
+
|
| 1350 |
+
**Arguments:**
|
| 1351 |
+
- ``[enabled]`` - Whether to use embeds on this server. Leave blank to reset to default.
|
| 1352 |
+
|
| 1353 |
+
.. _core-command-embedset-showsettings:
|
| 1354 |
+
|
| 1355 |
+
"""""""""""""""""""""
|
| 1356 |
+
embedset showsettings
|
| 1357 |
+
"""""""""""""""""""""
|
| 1358 |
+
|
| 1359 |
+
**Syntax**
|
| 1360 |
+
|
| 1361 |
+
.. code-block:: none
|
| 1362 |
+
|
| 1363 |
+
[p]embedset showsettings [command]
|
| 1364 |
+
|
| 1365 |
+
**Description**
|
| 1366 |
+
|
| 1367 |
+
Show the current embed settings.
|
| 1368 |
+
|
| 1369 |
+
Provide a command name to check for command specific embed settings.
|
| 1370 |
+
|
| 1371 |
+
**Examples:**
|
| 1372 |
+
- ``[p]embedset showsettings`` - Shows embed settings.
|
| 1373 |
+
- ``[p]embedset showsettings info`` - Also shows embed settings for the 'info' command.
|
| 1374 |
+
- ``[p]embedset showsettings "ignore list"`` - Checking subcommands requires quotes.
|
| 1375 |
+
|
| 1376 |
+
**Arguments:**
|
| 1377 |
+
- ``[command]`` - Checks this command for command specific embed settings.
|
| 1378 |
+
|
| 1379 |
+
.. _core-command-embedset-user:
|
| 1380 |
+
|
| 1381 |
+
"""""""""""""
|
| 1382 |
+
embedset user
|
| 1383 |
+
"""""""""""""
|
| 1384 |
+
|
| 1385 |
+
**Syntax**
|
| 1386 |
+
|
| 1387 |
+
.. code-block:: none
|
| 1388 |
+
|
| 1389 |
+
[p]embedset user [enabled]
|
| 1390 |
+
|
| 1391 |
+
**Description**
|
| 1392 |
+
|
| 1393 |
+
Sets personal embed setting for DMs.
|
| 1394 |
+
|
| 1395 |
+
If set, this is used instead of the global default to determine whether or not to use embeds.
|
| 1396 |
+
This is used for all commands executed in a DM with the bot.
|
| 1397 |
+
|
| 1398 |
+
If enabled is left blank, the setting will be unset and the global default will be used instead.
|
| 1399 |
+
|
| 1400 |
+
To see full evaluation order of embed settings, run ``[p]help embedset``.
|
| 1401 |
+
|
| 1402 |
+
**Examples:**
|
| 1403 |
+
- ``[p]embedset user False`` - Disables embeds in your DMs.
|
| 1404 |
+
- ``[p]embedset user`` - Resets value to use global default.
|
| 1405 |
+
|
| 1406 |
+
**Arguments:**
|
| 1407 |
+
- ``[enabled]`` - Whether to use embeds in your DMs. Leave blank to reset to default.
|
| 1408 |
+
|
| 1409 |
+
.. _core-command-helpset:
|
| 1410 |
+
|
| 1411 |
+
^^^^^^^
|
| 1412 |
+
helpset
|
| 1413 |
+
^^^^^^^
|
| 1414 |
+
|
| 1415 |
+
.. note:: |owner-lock|
|
| 1416 |
+
|
| 1417 |
+
**Syntax**
|
| 1418 |
+
|
| 1419 |
+
.. code-block:: none
|
| 1420 |
+
|
| 1421 |
+
[p]helpset
|
| 1422 |
+
|
| 1423 |
+
**Description**
|
| 1424 |
+
|
| 1425 |
+
Commands to manage settings for the help command.
|
| 1426 |
+
|
| 1427 |
+
All help settings are applied globally.
|
| 1428 |
+
|
| 1429 |
+
.. _core-command-helpset-deletedelay:
|
| 1430 |
+
|
| 1431 |
+
"""""""""""""""""""
|
| 1432 |
+
helpset deletedelay
|
| 1433 |
+
"""""""""""""""""""
|
| 1434 |
+
|
| 1435 |
+
**Syntax**
|
| 1436 |
+
|
| 1437 |
+
.. code-block:: none
|
| 1438 |
+
|
| 1439 |
+
[p]helpset deletedelay <seconds>
|
| 1440 |
+
|
| 1441 |
+
**Description**
|
| 1442 |
+
|
| 1443 |
+
Set the delay after which help pages will be deleted.
|
| 1444 |
+
|
| 1445 |
+
The setting is disabled by default, and only applies to non-menu help,
|
| 1446 |
+
sent in server text channels.
|
| 1447 |
+
Setting the delay to 0 disables this feature.
|
| 1448 |
+
|
| 1449 |
+
The bot has to have MANAGE_MESSAGES permission for this to work.
|
| 1450 |
+
|
| 1451 |
+
**Examples:**
|
| 1452 |
+
- ``[p]helpset deletedelay 60`` - Delete the help pages after a minute.
|
| 1453 |
+
- ``[p]helpset deletedelay 1`` - Delete the help pages as quickly as possible.
|
| 1454 |
+
- ``[p]helpset deletedelay 1209600`` - Max time to wait before deleting (14 days).
|
| 1455 |
+
- ``[p]helpset deletedelay 0`` - Disable deleting help pages.
|
| 1456 |
+
|
| 1457 |
+
**Arguments:**
|
| 1458 |
+
- ``<seconds>`` - The seconds to wait before deleting help pages.
|
| 1459 |
+
|
| 1460 |
+
.. _core-command-helpset-maxpages:
|
| 1461 |
+
|
| 1462 |
+
""""""""""""""""
|
| 1463 |
+
helpset maxpages
|
| 1464 |
+
""""""""""""""""
|
| 1465 |
+
|
| 1466 |
+
**Syntax**
|
| 1467 |
+
|
| 1468 |
+
.. code-block:: none
|
| 1469 |
+
|
| 1470 |
+
[p]helpset maxpages <pages>
|
| 1471 |
+
|
| 1472 |
+
**Description**
|
| 1473 |
+
|
| 1474 |
+
Set the maximum number of help pages sent in a server channel.
|
| 1475 |
+
|
| 1476 |
+
.. Note:: This setting does not apply to menu help.
|
| 1477 |
+
|
| 1478 |
+
|
| 1479 |
+
If a help message contains more pages than this value, the help message will
|
| 1480 |
+
be sent to the command author via DM. This is to help reduce spam in server
|
| 1481 |
+
text channels.
|
| 1482 |
+
|
| 1483 |
+
The default value is 2 pages.
|
| 1484 |
+
|
| 1485 |
+
**Examples:**
|
| 1486 |
+
- ``[p]helpset maxpages 50`` - Basically never send help to DMs.
|
| 1487 |
+
- ``[p]helpset maxpages 0`` - Always send help to DMs.
|
| 1488 |
+
|
| 1489 |
+
**Arguments:**
|
| 1490 |
+
- ``<limit>`` - The max pages allowed to send per help in a server.
|
| 1491 |
+
|
| 1492 |
+
.. _core-command-helpset-pagecharlimit:
|
| 1493 |
+
|
| 1494 |
+
"""""""""""""""""""""
|
| 1495 |
+
helpset pagecharlimit
|
| 1496 |
+
"""""""""""""""""""""
|
| 1497 |
+
|
| 1498 |
+
**Syntax**
|
| 1499 |
+
|
| 1500 |
+
.. code-block:: none
|
| 1501 |
+
|
| 1502 |
+
[p]helpset pagecharlimit <limit>
|
| 1503 |
+
|
| 1504 |
+
**Description**
|
| 1505 |
+
|
| 1506 |
+
Set the character limit for each page in the help message.
|
| 1507 |
+
|
| 1508 |
+
.. Note:: This setting only applies to embedded help.
|
| 1509 |
+
|
| 1510 |
+
|
| 1511 |
+
The default value is 1000 characters. The minimum value is 500.
|
| 1512 |
+
The maximum is based on the lower of what you provide and what discord allows.
|
| 1513 |
+
|
| 1514 |
+
Please note that setting a relatively small character limit may
|
| 1515 |
+
mean some pages will exceed this limit.
|
| 1516 |
+
|
| 1517 |
+
**Example:**
|
| 1518 |
+
- ``[p]helpset pagecharlimit 1500``
|
| 1519 |
+
|
| 1520 |
+
**Arguments:**
|
| 1521 |
+
- ``<limit>`` - The max amount of characters to show per page in the help message.
|
| 1522 |
+
|
| 1523 |
+
.. _core-command-helpset-reacttimeout:
|
| 1524 |
+
|
| 1525 |
+
""""""""""""""""""""
|
| 1526 |
+
helpset reacttimeout
|
| 1527 |
+
""""""""""""""""""""
|
| 1528 |
+
|
| 1529 |
+
**Syntax**
|
| 1530 |
+
|
| 1531 |
+
.. code-block:: none
|
| 1532 |
+
|
| 1533 |
+
[p]helpset reacttimeout <seconds>
|
| 1534 |
+
|
| 1535 |
+
**Description**
|
| 1536 |
+
|
| 1537 |
+
Set the timeout for reactions, if menus are enabled.
|
| 1538 |
+
|
| 1539 |
+
The default is 30 seconds.
|
| 1540 |
+
The timeout has to be between 15 and 300 seconds.
|
| 1541 |
+
|
| 1542 |
+
**Examples:**
|
| 1543 |
+
- ``[p]helpset reacttimeout 30`` - The default timeout.
|
| 1544 |
+
- ``[p]helpset reacttimeout 60`` - Timeout of 1 minute.
|
| 1545 |
+
- ``[p]helpset reacttimeout 15`` - Minimum allowed timeout.
|
| 1546 |
+
- ``[p]helpset reacttimeout 300`` - Max allowed timeout (5 mins).
|
| 1547 |
+
|
| 1548 |
+
**Arguments:**
|
| 1549 |
+
- ``<seconds>`` - The timeout, in seconds, of the reactions.
|
| 1550 |
+
|
| 1551 |
+
.. _core-command-helpset-resetformatter:
|
| 1552 |
+
|
| 1553 |
+
""""""""""""""""""""""
|
| 1554 |
+
helpset resetformatter
|
| 1555 |
+
""""""""""""""""""""""
|
| 1556 |
+
|
| 1557 |
+
**Syntax**
|
| 1558 |
+
|
| 1559 |
+
.. code-block:: none
|
| 1560 |
+
|
| 1561 |
+
[p]helpset resetformatter
|
| 1562 |
+
|
| 1563 |
+
**Description**
|
| 1564 |
+
|
| 1565 |
+
This resets Red's help formatter to the default formatter.
|
| 1566 |
+
|
| 1567 |
+
**Example:**
|
| 1568 |
+
- ``[p]helpset resetformatter``
|
| 1569 |
+
|
| 1570 |
+
.. _core-command-helpset-resetsettings:
|
| 1571 |
+
|
| 1572 |
+
"""""""""""""""""""""
|
| 1573 |
+
helpset resetsettings
|
| 1574 |
+
"""""""""""""""""""""
|
| 1575 |
+
|
| 1576 |
+
**Syntax**
|
| 1577 |
+
|
| 1578 |
+
.. code-block:: none
|
| 1579 |
+
|
| 1580 |
+
[p]helpset resetsettings
|
| 1581 |
+
|
| 1582 |
+
**Description**
|
| 1583 |
+
|
| 1584 |
+
This resets Red's help settings to their defaults.
|
| 1585 |
+
|
| 1586 |
+
This may not have an impact when using custom formatters from 3rd party cogs
|
| 1587 |
+
|
| 1588 |
+
**Example:**
|
| 1589 |
+
- ``[p]helpset resetsettings``
|
| 1590 |
+
|
| 1591 |
+
.. _core-command-helpset-showaliases:
|
| 1592 |
+
|
| 1593 |
+
"""""""""""""""""""
|
| 1594 |
+
helpset showaliases
|
| 1595 |
+
"""""""""""""""""""
|
| 1596 |
+
|
| 1597 |
+
**Syntax**
|
| 1598 |
+
|
| 1599 |
+
.. code-block:: none
|
| 1600 |
+
|
| 1601 |
+
[p]helpset showaliases [show_aliases]
|
| 1602 |
+
|
| 1603 |
+
**Description**
|
| 1604 |
+
|
| 1605 |
+
This allows the help command to show existing commands aliases if there is any.
|
| 1606 |
+
|
| 1607 |
+
This defaults to True.
|
| 1608 |
+
Using this without a setting will toggle.
|
| 1609 |
+
|
| 1610 |
+
**Examples:**
|
| 1611 |
+
- ``[p]helpset showaliases False`` - Disables showing aliases on this server.
|
| 1612 |
+
- ``[p]helpset showaliases`` - Toggles the value.
|
| 1613 |
+
|
| 1614 |
+
**Arguments:**
|
| 1615 |
+
- ``[show_aliases]`` - Whether to include aliases in help. Leave blank to toggle.
|
| 1616 |
+
|
| 1617 |
+
.. _core-command-helpset-showhidden:
|
| 1618 |
+
|
| 1619 |
+
""""""""""""""""""
|
| 1620 |
+
helpset showhidden
|
| 1621 |
+
""""""""""""""""""
|
| 1622 |
+
|
| 1623 |
+
**Syntax**
|
| 1624 |
+
|
| 1625 |
+
.. code-block:: none
|
| 1626 |
+
|
| 1627 |
+
[p]helpset showhidden [show_hidden]
|
| 1628 |
+
|
| 1629 |
+
**Description**
|
| 1630 |
+
|
| 1631 |
+
This allows the help command to show hidden commands.
|
| 1632 |
+
|
| 1633 |
+
This defaults to False.
|
| 1634 |
+
Using this without a setting will toggle.
|
| 1635 |
+
|
| 1636 |
+
**Examples:**
|
| 1637 |
+
- ``[p]helpset showhidden True`` - Enables showing hidden commands.
|
| 1638 |
+
- ``[p]helpset showhidden`` - Toggles the value.
|
| 1639 |
+
|
| 1640 |
+
**Arguments:**
|
| 1641 |
+
- ``[show_hidden]`` - Whether to use show hidden commands in help. Leave blank to toggle.
|
| 1642 |
+
|
| 1643 |
+
.. _core-command-helpset-showsettings:
|
| 1644 |
+
|
| 1645 |
+
""""""""""""""""""""
|
| 1646 |
+
helpset showsettings
|
| 1647 |
+
""""""""""""""""""""
|
| 1648 |
+
|
| 1649 |
+
**Syntax**
|
| 1650 |
+
|
| 1651 |
+
.. code-block:: none
|
| 1652 |
+
|
| 1653 |
+
[p]helpset showsettings
|
| 1654 |
+
|
| 1655 |
+
**Description**
|
| 1656 |
+
|
| 1657 |
+
Show the current help settings.
|
| 1658 |
+
|
| 1659 |
+
.. Warning:: These settings may not be accurate if the default formatter is not in use.
|
| 1660 |
+
|
| 1661 |
+
|
| 1662 |
+
**Example:**
|
| 1663 |
+
- ``[p]helpset showsettings``
|
| 1664 |
+
|
| 1665 |
+
.. _core-command-helpset-tagline:
|
| 1666 |
+
|
| 1667 |
+
"""""""""""""""
|
| 1668 |
+
helpset tagline
|
| 1669 |
+
"""""""""""""""
|
| 1670 |
+
|
| 1671 |
+
**Syntax**
|
| 1672 |
+
|
| 1673 |
+
.. code-block:: none
|
| 1674 |
+
|
| 1675 |
+
[p]helpset tagline [tagline]
|
| 1676 |
+
|
| 1677 |
+
**Description**
|
| 1678 |
+
|
| 1679 |
+
Set the tagline to be used.
|
| 1680 |
+
|
| 1681 |
+
The maximum tagline length is 2048 characters.
|
| 1682 |
+
This setting only applies to embedded help. If no tagline is specified, the default will be used instead.
|
| 1683 |
+
|
| 1684 |
+
**Examples:**
|
| 1685 |
+
- ``[p]helpset tagline Thanks for using the bot!``
|
| 1686 |
+
- ``[p]helpset tagline`` - Resets the tagline to the default.
|
| 1687 |
+
|
| 1688 |
+
**Arguments:**
|
| 1689 |
+
- ``[tagline]`` - The tagline to appear at the bottom of help embeds. Leave blank to reset.
|
| 1690 |
+
|
| 1691 |
+
.. _core-command-helpset-usemenus:
|
| 1692 |
+
|
| 1693 |
+
""""""""""""""""
|
| 1694 |
+
helpset usemenus
|
| 1695 |
+
""""""""""""""""
|
| 1696 |
+
|
| 1697 |
+
**Syntax**
|
| 1698 |
+
|
| 1699 |
+
.. code-block:: none
|
| 1700 |
+
|
| 1701 |
+
[p]helpset usemenus <"buttons"|"reactions"|"select"|"selectonly"|"disable">
|
| 1702 |
+
|
| 1703 |
+
**Description**
|
| 1704 |
+
|
| 1705 |
+
Allows the help command to be sent as a paginated menu instead of separate
|
| 1706 |
+
messages.
|
| 1707 |
+
|
| 1708 |
+
When "reactions", "buttons", "select", or "selectonly" is passed, ``[p]help`` will
|
| 1709 |
+
only show one page at a time and will use the associated control scheme to navigate between pages.
|
| 1710 |
+
|
| 1711 |
+
**Examples:**
|
| 1712 |
+
- ``[p]helpset usemenus reactions`` - Enables using reaction menus.
|
| 1713 |
+
- ``[p]helpset usemenus buttons`` - Enables using button menus.
|
| 1714 |
+
- ``[p]helpset usemenus select`` - Enables buttons with a select menu.
|
| 1715 |
+
- ``[p]helpset usemenus selectonly`` - Enables a select menu only on help.
|
| 1716 |
+
- ``[p]helpset usemenus disable`` - Disables help menus.
|
| 1717 |
+
|
| 1718 |
+
**Arguments:**
|
| 1719 |
+
- ``<"buttons"|"reactions"|"select"|"selectonly"|"disable">`` - Whether to use ``buttons``,
|
| 1720 |
+
``reactions``, ``select``, ``selectonly``, or no menus.
|
| 1721 |
+
|
| 1722 |
+
.. _core-command-helpset-usetick:
|
| 1723 |
+
|
| 1724 |
+
"""""""""""""""
|
| 1725 |
+
helpset usetick
|
| 1726 |
+
"""""""""""""""
|
| 1727 |
+
|
| 1728 |
+
**Syntax**
|
| 1729 |
+
|
| 1730 |
+
.. code-block:: none
|
| 1731 |
+
|
| 1732 |
+
[p]helpset usetick [use_tick]
|
| 1733 |
+
|
| 1734 |
+
**Description**
|
| 1735 |
+
|
| 1736 |
+
This allows the help command message to be ticked if help is sent to a DM.
|
| 1737 |
+
|
| 1738 |
+
Ticking is reacting to the help message with a ✅.
|
| 1739 |
+
|
| 1740 |
+
Defaults to False.
|
| 1741 |
+
Using this without a setting will toggle.
|
| 1742 |
+
|
| 1743 |
+
.. Note:: This is only used when the bot is not using menus.
|
| 1744 |
+
|
| 1745 |
+
|
| 1746 |
+
**Examples:**
|
| 1747 |
+
- ``[p]helpset usetick False`` - Disables ticking when help is sent to DMs.
|
| 1748 |
+
- ``[p]helpset usetick`` - Toggles the value.
|
| 1749 |
+
|
| 1750 |
+
**Arguments:**
|
| 1751 |
+
- ``[use_tick]`` - Whether to tick the help command when help is sent to DMs. Leave blank to toggle.
|
| 1752 |
+
|
| 1753 |
+
.. _core-command-helpset-verifychecks:
|
| 1754 |
+
|
| 1755 |
+
""""""""""""""""""""
|
| 1756 |
+
helpset verifychecks
|
| 1757 |
+
""""""""""""""""""""
|
| 1758 |
+
|
| 1759 |
+
**Syntax**
|
| 1760 |
+
|
| 1761 |
+
.. code-block:: none
|
| 1762 |
+
|
| 1763 |
+
[p]helpset verifychecks [verify]
|
| 1764 |
+
|
| 1765 |
+
**Description**
|
| 1766 |
+
|
| 1767 |
+
Sets if commands which can't be run in the current context should be filtered from help.
|
| 1768 |
+
|
| 1769 |
+
Defaults to True.
|
| 1770 |
+
Using this without a setting will toggle.
|
| 1771 |
+
|
| 1772 |
+
**Examples:**
|
| 1773 |
+
- ``[p]helpset verifychecks False`` - Enables showing unusable commands in help.
|
| 1774 |
+
- ``[p]helpset verifychecks`` - Toggles the value.
|
| 1775 |
+
|
| 1776 |
+
**Arguments:**
|
| 1777 |
+
- ``[verify]`` - Whether to hide unusable commands in help. Leave blank to toggle.
|
| 1778 |
+
|
| 1779 |
+
.. _core-command-helpset-verifyexists:
|
| 1780 |
+
|
| 1781 |
+
""""""""""""""""""""
|
| 1782 |
+
helpset verifyexists
|
| 1783 |
+
""""""""""""""""""""
|
| 1784 |
+
|
| 1785 |
+
**Syntax**
|
| 1786 |
+
|
| 1787 |
+
.. code-block:: none
|
| 1788 |
+
|
| 1789 |
+
[p]helpset verifyexists [verify]
|
| 1790 |
+
|
| 1791 |
+
**Description**
|
| 1792 |
+
|
| 1793 |
+
Sets whether the bot should respond to help commands for nonexistent topics.
|
| 1794 |
+
|
| 1795 |
+
When enabled, this will indicate the existence of help topics, even if the user can't use it.
|
| 1796 |
+
|
| 1797 |
+
.. Note:: This setting on its own does not fully prevent command enumeration.
|
| 1798 |
+
|
| 1799 |
+
|
| 1800 |
+
Defaults to False.
|
| 1801 |
+
Using this without a setting will toggle.
|
| 1802 |
+
|
| 1803 |
+
**Examples:**
|
| 1804 |
+
- ``[p]helpset verifyexists True`` - Enables sending help for nonexistent topics.
|
| 1805 |
+
- ``[p]helpset verifyexists`` - Toggles the value.
|
| 1806 |
+
|
| 1807 |
+
**Arguments:**
|
| 1808 |
+
- ``[verify]`` - Whether to respond to help for nonexistent topics. Leave blank to toggle.
|
| 1809 |
+
|
| 1810 |
+
.. _core-command-ignore:
|
| 1811 |
+
|
| 1812 |
+
^^^^^^
|
| 1813 |
+
ignore
|
| 1814 |
+
^^^^^^
|
| 1815 |
+
|
| 1816 |
+
.. note:: |admin-lock|
|
| 1817 |
+
|
| 1818 |
+
**Syntax**
|
| 1819 |
+
|
| 1820 |
+
.. code-block:: none
|
| 1821 |
+
|
| 1822 |
+
[p]ignore
|
| 1823 |
+
|
| 1824 |
+
**Description**
|
| 1825 |
+
|
| 1826 |
+
Commands to add servers or channels to the ignore list.
|
| 1827 |
+
|
| 1828 |
+
The ignore list will prevent the bot from responding to commands in the configured locations.
|
| 1829 |
+
|
| 1830 |
+
.. Note:: Owners and Admins override the ignore list.
|
| 1831 |
+
|
| 1832 |
+
|
| 1833 |
+
.. _core-command-ignore-channel:
|
| 1834 |
+
|
| 1835 |
+
""""""""""""""
|
| 1836 |
+
ignore channel
|
| 1837 |
+
""""""""""""""
|
| 1838 |
+
|
| 1839 |
+
**Syntax**
|
| 1840 |
+
|
| 1841 |
+
.. code-block:: none
|
| 1842 |
+
|
| 1843 |
+
[p]ignore channel [channel]
|
| 1844 |
+
|
| 1845 |
+
**Description**
|
| 1846 |
+
|
| 1847 |
+
Ignore commands in the channel, thread, or category.
|
| 1848 |
+
|
| 1849 |
+
Defaults to the current thread or channel.
|
| 1850 |
+
|
| 1851 |
+
.. Note:: Owners, Admins, and those with Manage Channel permissions override ignored channels.
|
| 1852 |
+
|
| 1853 |
+
|
| 1854 |
+
**Examples:**
|
| 1855 |
+
- ``[p]ignore channel #general`` - Ignores commands in the #general channel.
|
| 1856 |
+
- ``[p]ignore channel`` - Ignores commands in the current channel.
|
| 1857 |
+
- ``[p]ignore channel "General Channels"`` - Use quotes for categories with spaces.
|
| 1858 |
+
- ``[p]ignore channel 356236713347252226`` - Also accepts IDs.
|
| 1859 |
+
|
| 1860 |
+
**Arguments:**
|
| 1861 |
+
- ``<channel>`` - The channel to ignore. This can also be a thread or category channel.
|
| 1862 |
+
|
| 1863 |
+
.. _core-command-ignore-list:
|
| 1864 |
+
|
| 1865 |
+
"""""""""""
|
| 1866 |
+
ignore list
|
| 1867 |
+
"""""""""""
|
| 1868 |
+
|
| 1869 |
+
**Syntax**
|
| 1870 |
+
|
| 1871 |
+
.. code-block:: none
|
| 1872 |
+
|
| 1873 |
+
[p]ignore list
|
| 1874 |
+
|
| 1875 |
+
**Description**
|
| 1876 |
+
|
| 1877 |
+
List the currently ignored servers and channels.
|
| 1878 |
+
|
| 1879 |
+
**Example:**
|
| 1880 |
+
- ``[p]ignore list``
|
| 1881 |
+
|
| 1882 |
+
.. _core-command-ignore-server:
|
| 1883 |
+
|
| 1884 |
+
"""""""""""""
|
| 1885 |
+
ignore server
|
| 1886 |
+
"""""""""""""
|
| 1887 |
+
|
| 1888 |
+
.. note:: |admin-lock|
|
| 1889 |
+
|
| 1890 |
+
**Syntax**
|
| 1891 |
+
|
| 1892 |
+
.. code-block:: none
|
| 1893 |
+
|
| 1894 |
+
[p]ignore server
|
| 1895 |
+
|
| 1896 |
+
.. tip:: Alias: ``ignore guild``
|
| 1897 |
+
|
| 1898 |
+
**Description**
|
| 1899 |
+
|
| 1900 |
+
Ignore commands in this server.
|
| 1901 |
+
|
| 1902 |
+
.. Note:: Owners, Admins, and those with Manage Server permissions override ignored servers.
|
| 1903 |
+
|
| 1904 |
+
|
| 1905 |
+
**Example:**
|
| 1906 |
+
- ``[p]ignore server`` - Ignores the current server
|
| 1907 |
+
|
| 1908 |
+
.. _core-command-info:
|
| 1909 |
+
|
| 1910 |
+
^^^^
|
| 1911 |
+
info
|
| 1912 |
+
^^^^
|
| 1913 |
+
|
| 1914 |
+
**Syntax**
|
| 1915 |
+
|
| 1916 |
+
.. code-block:: none
|
| 1917 |
+
|
| 1918 |
+
[p]info
|
| 1919 |
+
|
| 1920 |
+
**Description**
|
| 1921 |
+
|
| 1922 |
+
Shows info about Red.
|
| 1923 |
+
|
| 1924 |
+
.. _core-command-invite:
|
| 1925 |
+
|
| 1926 |
+
^^^^^^
|
| 1927 |
+
invite
|
| 1928 |
+
^^^^^^
|
| 1929 |
+
|
| 1930 |
+
**Syntax**
|
| 1931 |
+
|
| 1932 |
+
.. code-block:: none
|
| 1933 |
+
|
| 1934 |
+
[p]invite
|
| 1935 |
+
|
| 1936 |
+
**Description**
|
| 1937 |
+
|
| 1938 |
+
Shows Red's invite url.
|
| 1939 |
+
|
| 1940 |
+
This will always send the invite to DMs to keep it private.
|
| 1941 |
+
|
| 1942 |
+
This command is locked to the owner unless ``[p]inviteset public`` is set to True.
|
| 1943 |
+
|
| 1944 |
+
**Example:**
|
| 1945 |
+
- ``[p]invite``
|
| 1946 |
+
|
| 1947 |
+
.. _core-command-inviteset:
|
| 1948 |
+
|
| 1949 |
+
^^^^^^^^^
|
| 1950 |
+
inviteset
|
| 1951 |
+
^^^^^^^^^
|
| 1952 |
+
|
| 1953 |
+
.. note:: |owner-lock|
|
| 1954 |
+
|
| 1955 |
+
**Syntax**
|
| 1956 |
+
|
| 1957 |
+
.. code-block:: none
|
| 1958 |
+
|
| 1959 |
+
[p]inviteset
|
| 1960 |
+
|
| 1961 |
+
**Description**
|
| 1962 |
+
|
| 1963 |
+
Commands to setup Red's invite settings.
|
| 1964 |
+
|
| 1965 |
+
.. _core-command-inviteset-perms:
|
| 1966 |
+
|
| 1967 |
+
"""""""""""""""
|
| 1968 |
+
inviteset perms
|
| 1969 |
+
"""""""""""""""
|
| 1970 |
+
|
| 1971 |
+
**Syntax**
|
| 1972 |
+
|
| 1973 |
+
.. code-block:: none
|
| 1974 |
+
|
| 1975 |
+
[p]inviteset perms <level>
|
| 1976 |
+
|
| 1977 |
+
**Description**
|
| 1978 |
+
|
| 1979 |
+
Make the bot create its own role with permissions on join.
|
| 1980 |
+
|
| 1981 |
+
The bot will create its own role with the desired permissions when it joins a new server. This is a special role that can't be deleted or removed from the bot.
|
| 1982 |
+
|
| 1983 |
+
For that, you need to provide a valid permissions level.
|
| 1984 |
+
You can generate one here: https://discordapi.com/permissions.html
|
| 1985 |
+
|
| 1986 |
+
Please note that you might need two factor authentication for some permissions.
|
| 1987 |
+
|
| 1988 |
+
**Example:**
|
| 1989 |
+
- ``[p]inviteset perms 134217728`` - Adds a "Manage Nicknames" permission requirement to the invite.
|
| 1990 |
+
|
| 1991 |
+
**Arguments:**
|
| 1992 |
+
- ``<level>`` - The permission level to require for the bot in the generated invite.
|
| 1993 |
+
|
| 1994 |
+
.. _core-command-inviteset-public:
|
| 1995 |
+
|
| 1996 |
+
""""""""""""""""
|
| 1997 |
+
inviteset public
|
| 1998 |
+
""""""""""""""""
|
| 1999 |
+
|
| 2000 |
+
**Syntax**
|
| 2001 |
+
|
| 2002 |
+
.. code-block:: none
|
| 2003 |
+
|
| 2004 |
+
[p]inviteset public [confirm=False]
|
| 2005 |
+
|
| 2006 |
+
**Description**
|
| 2007 |
+
|
| 2008 |
+
Toggles if ``[p]invite`` should be accessible for the average user.
|
| 2009 |
+
|
| 2010 |
+
The bot must be made into a ``Public bot`` in the developer dashboard for public invites to work.
|
| 2011 |
+
|
| 2012 |
+
**Example:**
|
| 2013 |
+
- ``[p]inviteset public yes`` - Toggles the public invite setting.
|
| 2014 |
+
|
| 2015 |
+
**Arguments:**
|
| 2016 |
+
- ``[confirm]`` - Required to set to public. Not required to toggle back to private.
|
| 2017 |
+
|
| 2018 |
+
.. _core-command-leave:
|
| 2019 |
+
|
| 2020 |
+
^^^^^
|
| 2021 |
+
leave
|
| 2022 |
+
^^^^^
|
| 2023 |
+
|
| 2024 |
+
.. note:: |owner-lock|
|
| 2025 |
+
|
| 2026 |
+
**Syntax**
|
| 2027 |
+
|
| 2028 |
+
.. code-block:: none
|
| 2029 |
+
|
| 2030 |
+
[p]leave [servers...]
|
| 2031 |
+
|
| 2032 |
+
**Description**
|
| 2033 |
+
|
| 2034 |
+
Leaves servers.
|
| 2035 |
+
|
| 2036 |
+
If no server IDs are passed the local server will be left instead.
|
| 2037 |
+
|
| 2038 |
+
.. Note:: This command is interactive.
|
| 2039 |
+
|
| 2040 |
+
|
| 2041 |
+
**Examples:**
|
| 2042 |
+
- ``[p]leave`` - Leave the current server.
|
| 2043 |
+
- ``[p]leave "Red - Discord Bot"`` - Quotes are necessary when there are spaces in the name.
|
| 2044 |
+
- ``[p]leave 133049272517001216 240154543684321280`` - Leaves multiple servers, using IDs.
|
| 2045 |
+
|
| 2046 |
+
**Arguments:**
|
| 2047 |
+
- ``[servers...]`` - The servers to leave. When blank, attempts to leave the current server.
|
| 2048 |
+
|
| 2049 |
+
.. _core-command-licenseinfo:
|
| 2050 |
+
|
| 2051 |
+
^^^^^^^^^^^
|
| 2052 |
+
licenseinfo
|
| 2053 |
+
^^^^^^^^^^^
|
| 2054 |
+
|
| 2055 |
+
**Syntax**
|
| 2056 |
+
|
| 2057 |
+
.. code-block:: none
|
| 2058 |
+
|
| 2059 |
+
[p]licenseinfo
|
| 2060 |
+
|
| 2061 |
+
.. tip:: Alias: ``licenceinfo``
|
| 2062 |
+
|
| 2063 |
+
**Description**
|
| 2064 |
+
|
| 2065 |
+
Get info about Red's licenses.
|
| 2066 |
+
|
| 2067 |
+
.. _core-command-load:
|
| 2068 |
+
|
| 2069 |
+
^^^^
|
| 2070 |
+
load
|
| 2071 |
+
^^^^
|
| 2072 |
+
|
| 2073 |
+
.. note:: |owner-lock|
|
| 2074 |
+
|
| 2075 |
+
**Syntax**
|
| 2076 |
+
|
| 2077 |
+
.. code-block:: none
|
| 2078 |
+
|
| 2079 |
+
[p]load <cogs...>
|
| 2080 |
+
|
| 2081 |
+
**Description**
|
| 2082 |
+
|
| 2083 |
+
Loads cog packages from the local paths and installed cogs.
|
| 2084 |
+
|
| 2085 |
+
See packages available to load with ``[p]cogs``.
|
| 2086 |
+
|
| 2087 |
+
Additional cogs can be added using Downloader, or from local paths using ``[p]addpath``.
|
| 2088 |
+
|
| 2089 |
+
**Examples:**
|
| 2090 |
+
- ``[p]load general`` - Loads the ``general`` cog.
|
| 2091 |
+
- ``[p]load admin mod mutes`` - Loads multiple cogs.
|
| 2092 |
+
|
| 2093 |
+
**Arguments:**
|
| 2094 |
+
- ``<cogs...>`` - The cog packages to load.
|
| 2095 |
+
|
| 2096 |
+
.. _core-command-localallowlist:
|
| 2097 |
+
|
| 2098 |
+
^^^^^^^^^^^^^^
|
| 2099 |
+
localallowlist
|
| 2100 |
+
^^^^^^^^^^^^^^
|
| 2101 |
+
|
| 2102 |
+
.. note:: |admin-lock|
|
| 2103 |
+
|
| 2104 |
+
**Syntax**
|
| 2105 |
+
|
| 2106 |
+
.. code-block:: none
|
| 2107 |
+
|
| 2108 |
+
[p]localallowlist
|
| 2109 |
+
|
| 2110 |
+
.. tip:: Alias: ``localwhitelist``
|
| 2111 |
+
|
| 2112 |
+
**Description**
|
| 2113 |
+
|
| 2114 |
+
Commands to manage the server specific allowlist.
|
| 2115 |
+
|
| 2116 |
+
.. Warning:: When the allowlist is in use, the bot will ignore commands from everyone not on the list in the server.
|
| 2117 |
+
|
| 2118 |
+
|
| 2119 |
+
Use ``[p]localallowlist clear`` to disable the allowlist
|
| 2120 |
+
|
| 2121 |
+
.. _core-command-localallowlist-add:
|
| 2122 |
+
|
| 2123 |
+
""""""""""""""""""
|
| 2124 |
+
localallowlist add
|
| 2125 |
+
""""""""""""""""""
|
| 2126 |
+
|
| 2127 |
+
**Syntax**
|
| 2128 |
+
|
| 2129 |
+
.. code-block:: none
|
| 2130 |
+
|
| 2131 |
+
[p]localallowlist add <users_or_roles...>
|
| 2132 |
+
|
| 2133 |
+
**Description**
|
| 2134 |
+
|
| 2135 |
+
Adds a user or role to the server allowlist.
|
| 2136 |
+
|
| 2137 |
+
**Examples:**
|
| 2138 |
+
- ``[p]localallowlist add @26 @Will`` - Adds two users to the local allowlist.
|
| 2139 |
+
- ``[p]localallowlist add 262626262626262626`` - Allows a user by ID.
|
| 2140 |
+
- ``[p]localallowlist add "Super Admins"`` - Allows a role with a space in the name without mentioning.
|
| 2141 |
+
|
| 2142 |
+
**Arguments:**
|
| 2143 |
+
- ``<users_or_roles...>`` - The users or roles to remove from the local allowlist.
|
| 2144 |
+
|
| 2145 |
+
.. _core-command-localallowlist-clear:
|
| 2146 |
+
|
| 2147 |
+
""""""""""""""""""""
|
| 2148 |
+
localallowlist clear
|
| 2149 |
+
""""""""""""""""""""
|
| 2150 |
+
|
| 2151 |
+
**Syntax**
|
| 2152 |
+
|
| 2153 |
+
.. code-block:: none
|
| 2154 |
+
|
| 2155 |
+
[p]localallowlist clear
|
| 2156 |
+
|
| 2157 |
+
**Description**
|
| 2158 |
+
|
| 2159 |
+
Clears the allowlist.
|
| 2160 |
+
|
| 2161 |
+
This disables the local allowlist and clears all entires.
|
| 2162 |
+
|
| 2163 |
+
**Example:**
|
| 2164 |
+
- ``[p]localallowlist clear``
|
| 2165 |
+
|
| 2166 |
+
.. _core-command-localallowlist-list:
|
| 2167 |
+
|
| 2168 |
+
"""""""""""""""""""
|
| 2169 |
+
localallowlist list
|
| 2170 |
+
"""""""""""""""""""
|
| 2171 |
+
|
| 2172 |
+
**Syntax**
|
| 2173 |
+
|
| 2174 |
+
.. code-block:: none
|
| 2175 |
+
|
| 2176 |
+
[p]localallowlist list
|
| 2177 |
+
|
| 2178 |
+
**Description**
|
| 2179 |
+
|
| 2180 |
+
Lists users and roles on the server allowlist.
|
| 2181 |
+
|
| 2182 |
+
**Example:**
|
| 2183 |
+
- ``[p]localallowlist list``
|
| 2184 |
+
|
| 2185 |
+
.. _core-command-localallowlist-remove:
|
| 2186 |
+
|
| 2187 |
+
"""""""""""""""""""""
|
| 2188 |
+
localallowlist remove
|
| 2189 |
+
"""""""""""""""""""""
|
| 2190 |
+
|
| 2191 |
+
**Syntax**
|
| 2192 |
+
|
| 2193 |
+
.. code-block:: none
|
| 2194 |
+
|
| 2195 |
+
[p]localallowlist remove <users_or_roles...>
|
| 2196 |
+
|
| 2197 |
+
**Description**
|
| 2198 |
+
|
| 2199 |
+
Removes user or role from the allowlist.
|
| 2200 |
+
|
| 2201 |
+
The local allowlist will be disabled if all users are removed.
|
| 2202 |
+
|
| 2203 |
+
**Examples:**
|
| 2204 |
+
- ``[p]localallowlist remove @26 @Will`` - Removes two users from the local allowlist.
|
| 2205 |
+
- ``[p]localallowlist remove 262626262626262626`` - Removes a user by ID.
|
| 2206 |
+
- ``[p]localallowlist remove "Super Admins"`` - Removes a role with a space in the name without mentioning.
|
| 2207 |
+
|
| 2208 |
+
**Arguments:**
|
| 2209 |
+
- ``<users_or_roles...>`` - The users or roles to remove from the local allowlist.
|
| 2210 |
+
|
| 2211 |
+
.. _core-command-localblocklist:
|
| 2212 |
+
|
| 2213 |
+
^^^^^^^^^^^^^^
|
| 2214 |
+
localblocklist
|
| 2215 |
+
^^^^^^^^^^^^^^
|
| 2216 |
+
|
| 2217 |
+
.. note:: |admin-lock|
|
| 2218 |
+
|
| 2219 |
+
**Syntax**
|
| 2220 |
+
|
| 2221 |
+
.. code-block:: none
|
| 2222 |
+
|
| 2223 |
+
[p]localblocklist
|
| 2224 |
+
|
| 2225 |
+
.. tip:: Alias: ``localblacklist``
|
| 2226 |
+
|
| 2227 |
+
**Description**
|
| 2228 |
+
|
| 2229 |
+
Commands to manage the server specific blocklist.
|
| 2230 |
+
|
| 2231 |
+
Use ``[p]localblocklist clear`` to disable the blocklist
|
| 2232 |
+
|
| 2233 |
+
.. _core-command-localblocklist-add:
|
| 2234 |
+
|
| 2235 |
+
""""""""""""""""""
|
| 2236 |
+
localblocklist add
|
| 2237 |
+
""""""""""""""""""
|
| 2238 |
+
|
| 2239 |
+
**Syntax**
|
| 2240 |
+
|
| 2241 |
+
.. code-block:: none
|
| 2242 |
+
|
| 2243 |
+
[p]localblocklist add <users_or_roles...>
|
| 2244 |
+
|
| 2245 |
+
**Description**
|
| 2246 |
+
|
| 2247 |
+
Adds a user or role to the local blocklist.
|
| 2248 |
+
|
| 2249 |
+
**Examples:**
|
| 2250 |
+
- ``[p]localblocklist add @26 @Will`` - Adds two users to the local blocklist.
|
| 2251 |
+
- ``[p]localblocklist add 262626262626262626`` - Blocks a user by ID.
|
| 2252 |
+
- ``[p]localblocklist add "Bad Apples"`` - Blocks a role with a space in the name without mentioning.
|
| 2253 |
+
|
| 2254 |
+
**Arguments:**
|
| 2255 |
+
- ``<users_or_roles...>`` - The users or roles to add to the local blocklist.
|
| 2256 |
+
|
| 2257 |
+
.. _core-command-localblocklist-clear:
|
| 2258 |
+
|
| 2259 |
+
""""""""""""""""""""
|
| 2260 |
+
localblocklist clear
|
| 2261 |
+
""""""""""""""""""""
|
| 2262 |
+
|
| 2263 |
+
**Syntax**
|
| 2264 |
+
|
| 2265 |
+
.. code-block:: none
|
| 2266 |
+
|
| 2267 |
+
[p]localblocklist clear
|
| 2268 |
+
|
| 2269 |
+
**Description**
|
| 2270 |
+
|
| 2271 |
+
Clears the server blocklist.
|
| 2272 |
+
|
| 2273 |
+
This disabled the server blocklist and clears all entries.
|
| 2274 |
+
|
| 2275 |
+
**Example:**
|
| 2276 |
+
- ``[p]blocklist clear``
|
| 2277 |
+
|
| 2278 |
+
.. _core-command-localblocklist-list:
|
| 2279 |
+
|
| 2280 |
+
"""""""""""""""""""
|
| 2281 |
+
localblocklist list
|
| 2282 |
+
"""""""""""""""""""
|
| 2283 |
+
|
| 2284 |
+
**Syntax**
|
| 2285 |
+
|
| 2286 |
+
.. code-block:: none
|
| 2287 |
+
|
| 2288 |
+
[p]localblocklist list
|
| 2289 |
+
|
| 2290 |
+
**Description**
|
| 2291 |
+
|
| 2292 |
+
Lists users and roles on the server blocklist.
|
| 2293 |
+
|
| 2294 |
+
**Example:**
|
| 2295 |
+
- ``[p]localblocklist list``
|
| 2296 |
+
|
| 2297 |
+
.. _core-command-localblocklist-remove:
|
| 2298 |
+
|
| 2299 |
+
"""""""""""""""""""""
|
| 2300 |
+
localblocklist remove
|
| 2301 |
+
"""""""""""""""""""""
|
| 2302 |
+
|
| 2303 |
+
**Syntax**
|
| 2304 |
+
|
| 2305 |
+
.. code-block:: none
|
| 2306 |
+
|
| 2307 |
+
[p]localblocklist remove <users_or_roles...>
|
| 2308 |
+
|
| 2309 |
+
**Description**
|
| 2310 |
+
|
| 2311 |
+
Removes user or role from blocklist.
|
| 2312 |
+
|
| 2313 |
+
**Examples:**
|
| 2314 |
+
- ``[p]localblocklist remove @26 @Will`` - Removes two users from the local blocklist.
|
| 2315 |
+
- ``[p]localblocklist remove 262626262626262626`` - Unblocks a user by ID.
|
| 2316 |
+
- ``[p]localblocklist remove "Bad Apples"`` - Unblocks a role with a space in the name without mentioning.
|
| 2317 |
+
|
| 2318 |
+
**Arguments:**
|
| 2319 |
+
- ``<users_or_roles...>`` - The users or roles to remove from the local blocklist.
|
| 2320 |
+
|
| 2321 |
+
.. _core-command-modlogset:
|
| 2322 |
+
|
| 2323 |
+
^^^^^^^^^
|
| 2324 |
+
modlogset
|
| 2325 |
+
^^^^^^^^^
|
| 2326 |
+
|
| 2327 |
+
.. note:: |guildowner-lock|
|
| 2328 |
+
|
| 2329 |
+
**Syntax**
|
| 2330 |
+
|
| 2331 |
+
.. code-block:: none
|
| 2332 |
+
|
| 2333 |
+
[p]modlogset
|
| 2334 |
+
|
| 2335 |
+
**Description**
|
| 2336 |
+
|
| 2337 |
+
Manage modlog settings.
|
| 2338 |
+
|
| 2339 |
+
.. _core-command-modlogset-cases:
|
| 2340 |
+
|
| 2341 |
+
"""""""""""""""
|
| 2342 |
+
modlogset cases
|
| 2343 |
+
"""""""""""""""
|
| 2344 |
+
|
| 2345 |
+
**Syntax**
|
| 2346 |
+
|
| 2347 |
+
.. code-block:: none
|
| 2348 |
+
|
| 2349 |
+
[p]modlogset cases [action]
|
| 2350 |
+
|
| 2351 |
+
**Description**
|
| 2352 |
+
|
| 2353 |
+
Enable or disable case creation for a mod action, like disabling warnings, enabling bans, etc.
|
| 2354 |
+
|
| 2355 |
+
**Examples:**
|
| 2356 |
+
- ``[p]modlogset cases kick`` - Enables/disables modlog messages for kicks.
|
| 2357 |
+
- ``[p]modlogset cases ban`` - Enables/disables modlog messages for bans.
|
| 2358 |
+
|
| 2359 |
+
**Arguments:**
|
| 2360 |
+
- ``[action]`` - The type of mod action to be enabled/disabled for case creation.
|
| 2361 |
+
|
| 2362 |
+
|
| 2363 |
+
.. _core-command-modlogset-modlog:
|
| 2364 |
+
|
| 2365 |
+
""""""""""""""""
|
| 2366 |
+
modlogset modlog
|
| 2367 |
+
""""""""""""""""
|
| 2368 |
+
|
| 2369 |
+
**Syntax**
|
| 2370 |
+
|
| 2371 |
+
.. code-block:: none
|
| 2372 |
+
|
| 2373 |
+
[p]modlogset modlog [channel]
|
| 2374 |
+
|
| 2375 |
+
.. tip:: Alias: ``modlogset channel``
|
| 2376 |
+
|
| 2377 |
+
**Description**
|
| 2378 |
+
|
| 2379 |
+
Set a channel as the modlog.
|
| 2380 |
+
|
| 2381 |
+
**Arguments**
|
| 2382 |
+
|
| 2383 |
+
* ``[channel]``: The channel to set as the modlog. If omitted, the modlog will be disabled.
|
| 2384 |
+
|
| 2385 |
+
.. _core-command-modlogset-resetcases:
|
| 2386 |
+
|
| 2387 |
+
""""""""""""""""""""
|
| 2388 |
+
modlogset resetcases
|
| 2389 |
+
""""""""""""""""""""
|
| 2390 |
+
|
| 2391 |
+
**Syntax**
|
| 2392 |
+
|
| 2393 |
+
.. code-block:: none
|
| 2394 |
+
|
| 2395 |
+
[p]modlogset resetcases
|
| 2396 |
+
|
| 2397 |
+
**Description**
|
| 2398 |
+
|
| 2399 |
+
Reset all modlog cases in this server.
|
| 2400 |
+
|
| 2401 |
+
.. _core-command-mydata:
|
| 2402 |
+
|
| 2403 |
+
^^^^^^
|
| 2404 |
+
mydata
|
| 2405 |
+
^^^^^^
|
| 2406 |
+
|
| 2407 |
+
**Syntax**
|
| 2408 |
+
|
| 2409 |
+
.. code-block:: none
|
| 2410 |
+
|
| 2411 |
+
[p]mydata
|
| 2412 |
+
|
| 2413 |
+
**Description**
|
| 2414 |
+
|
| 2415 |
+
Commands which interact with the data Red has about you.
|
| 2416 |
+
|
| 2417 |
+
More information can be found in the :doc:`End User Data Documentation.<../red_core_data_statement>`
|
| 2418 |
+
|
| 2419 |
+
.. _core-command-mydata-3rdparty:
|
| 2420 |
+
|
| 2421 |
+
"""""""""""""""
|
| 2422 |
+
mydata 3rdparty
|
| 2423 |
+
"""""""""""""""
|
| 2424 |
+
|
| 2425 |
+
**Syntax**
|
| 2426 |
+
|
| 2427 |
+
.. code-block:: none
|
| 2428 |
+
|
| 2429 |
+
[p]mydata 3rdparty
|
| 2430 |
+
|
| 2431 |
+
**Description**
|
| 2432 |
+
|
| 2433 |
+
View the End User Data statements of each 3rd-party module.
|
| 2434 |
+
|
| 2435 |
+
This will send an attachment with the End User Data statements of all loaded 3rd party cogs.
|
| 2436 |
+
|
| 2437 |
+
**Example:**
|
| 2438 |
+
- ``[p]mydata 3rdparty``
|
| 2439 |
+
|
| 2440 |
+
.. _core-command-mydata-forgetme:
|
| 2441 |
+
|
| 2442 |
+
"""""""""""""""
|
| 2443 |
+
mydata forgetme
|
| 2444 |
+
"""""""""""""""
|
| 2445 |
+
|
| 2446 |
+
**Syntax**
|
| 2447 |
+
|
| 2448 |
+
.. code-block:: none
|
| 2449 |
+
|
| 2450 |
+
[p]mydata forgetme
|
| 2451 |
+
|
| 2452 |
+
**Description**
|
| 2453 |
+
|
| 2454 |
+
Have Red forget what it knows about you.
|
| 2455 |
+
|
| 2456 |
+
This may not remove all data about you, data needed for operation,
|
| 2457 |
+
such as command cooldowns will be kept until no longer necessary.
|
| 2458 |
+
|
| 2459 |
+
Further interactions with Red may cause it to learn about you again.
|
| 2460 |
+
|
| 2461 |
+
**Example:**
|
| 2462 |
+
- ``[p]mydata forgetme``
|
| 2463 |
+
|
| 2464 |
+
.. _core-command-mydata-getmydata:
|
| 2465 |
+
|
| 2466 |
+
""""""""""""""""
|
| 2467 |
+
mydata getmydata
|
| 2468 |
+
""""""""""""""""
|
| 2469 |
+
|
| 2470 |
+
**Syntax**
|
| 2471 |
+
|
| 2472 |
+
.. code-block:: none
|
| 2473 |
+
|
| 2474 |
+
[p]mydata getmydata
|
| 2475 |
+
|
| 2476 |
+
**Description**
|
| 2477 |
+
|
| 2478 |
+
[Coming Soon] Get what data Red has about you.
|
| 2479 |
+
|
| 2480 |
+
.. _core-command-mydata-ownermanagement:
|
| 2481 |
+
|
| 2482 |
+
""""""""""""""""""""""
|
| 2483 |
+
mydata ownermanagement
|
| 2484 |
+
""""""""""""""""""""""
|
| 2485 |
+
|
| 2486 |
+
.. note:: |owner-lock|
|
| 2487 |
+
|
| 2488 |
+
**Syntax**
|
| 2489 |
+
|
| 2490 |
+
.. code-block:: none
|
| 2491 |
+
|
| 2492 |
+
[p]mydata ownermanagement
|
| 2493 |
+
|
| 2494 |
+
**Description**
|
| 2495 |
+
|
| 2496 |
+
Commands for more complete data handling.
|
| 2497 |
+
|
| 2498 |
+
.. _core-command-mydata-ownermanagement-allowuserdeletions:
|
| 2499 |
+
|
| 2500 |
+
"""""""""""""""""""""""""""""""""""""""""
|
| 2501 |
+
mydata ownermanagement allowuserdeletions
|
| 2502 |
+
"""""""""""""""""""""""""""""""""""""""""
|
| 2503 |
+
|
| 2504 |
+
**Syntax**
|
| 2505 |
+
|
| 2506 |
+
.. code-block:: none
|
| 2507 |
+
|
| 2508 |
+
[p]mydata ownermanagement allowuserdeletions
|
| 2509 |
+
|
| 2510 |
+
**Description**
|
| 2511 |
+
|
| 2512 |
+
Set the bot to allow users to request a data deletion.
|
| 2513 |
+
|
| 2514 |
+
This is on by default.
|
| 2515 |
+
Opposite of ``[p]mydata ownermanagement disallowuserdeletions``
|
| 2516 |
+
|
| 2517 |
+
**Example:**
|
| 2518 |
+
- ``[p]mydata ownermanagement allowuserdeletions``
|
| 2519 |
+
|
| 2520 |
+
.. _core-command-mydata-ownermanagement-deleteforuser:
|
| 2521 |
+
|
| 2522 |
+
""""""""""""""""""""""""""""""""""""
|
| 2523 |
+
mydata ownermanagement deleteforuser
|
| 2524 |
+
""""""""""""""""""""""""""""""""""""
|
| 2525 |
+
|
| 2526 |
+
**Syntax**
|
| 2527 |
+
|
| 2528 |
+
.. code-block:: none
|
| 2529 |
+
|
| 2530 |
+
[p]mydata ownermanagement deleteforuser <user_id>
|
| 2531 |
+
|
| 2532 |
+
**Description**
|
| 2533 |
+
|
| 2534 |
+
Delete data Red has about a user for a user.
|
| 2535 |
+
|
| 2536 |
+
This will cause the bot to get rid of or disassociate a lot of non-operational data from the specified user.
|
| 2537 |
+
Users have access to a different command for this unless they can't interact with the bot at all.
|
| 2538 |
+
This is a mostly safe operation, but you should not use it unless processing a request from this user as it may impact their usage of the bot.
|
| 2539 |
+
|
| 2540 |
+
**Arguments:**
|
| 2541 |
+
- ``<user_id>`` - The id of the user whose data would be deleted.
|
| 2542 |
+
|
| 2543 |
+
.. _core-command-mydata-ownermanagement-deleteuserasowner:
|
| 2544 |
+
|
| 2545 |
+
""""""""""""""""""""""""""""""""""""""""
|
| 2546 |
+
mydata ownermanagement deleteuserasowner
|
| 2547 |
+
""""""""""""""""""""""""""""""""""""""""
|
| 2548 |
+
|
| 2549 |
+
**Syntax**
|
| 2550 |
+
|
| 2551 |
+
.. code-block:: none
|
| 2552 |
+
|
| 2553 |
+
[p]mydata ownermanagement deleteuserasowner <user_id>
|
| 2554 |
+
|
| 2555 |
+
**Description**
|
| 2556 |
+
|
| 2557 |
+
Delete data Red has about a user.
|
| 2558 |
+
|
| 2559 |
+
This will cause the bot to get rid of or disassociate a lot of data about the specified user.
|
| 2560 |
+
This may include more than just end user data, including anti abuse records.
|
| 2561 |
+
|
| 2562 |
+
**Arguments:**
|
| 2563 |
+
- ``<user_id>`` - The id of the user whose data would be deleted.
|
| 2564 |
+
|
| 2565 |
+
.. _core-command-mydata-ownermanagement-disallowuserdeletions:
|
| 2566 |
+
|
| 2567 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 2568 |
+
mydata ownermanagement disallowuserdeletions
|
| 2569 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 2570 |
+
|
| 2571 |
+
**Syntax**
|
| 2572 |
+
|
| 2573 |
+
.. code-block:: none
|
| 2574 |
+
|
| 2575 |
+
[p]mydata ownermanagement disallowuserdeletions
|
| 2576 |
+
|
| 2577 |
+
**Description**
|
| 2578 |
+
|
| 2579 |
+
Set the bot to not allow users to request a data deletion.
|
| 2580 |
+
|
| 2581 |
+
Opposite of ``[p]mydata ownermanagement allowuserdeletions``
|
| 2582 |
+
|
| 2583 |
+
**Example:**
|
| 2584 |
+
- ``[p]mydata ownermanagement disallowuserdeletions``
|
| 2585 |
+
|
| 2586 |
+
.. _core-command-mydata-ownermanagement-processdiscordrequest:
|
| 2587 |
+
|
| 2588 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 2589 |
+
mydata ownermanagement processdiscordrequest
|
| 2590 |
+
""""""""""""""""""""""""""""""""""""""""""""
|
| 2591 |
+
|
| 2592 |
+
**Syntax**
|
| 2593 |
+
|
| 2594 |
+
.. code-block:: none
|
| 2595 |
+
|
| 2596 |
+
[p]mydata ownermanagement processdiscordrequest <user_id>
|
| 2597 |
+
|
| 2598 |
+
**Description**
|
| 2599 |
+
|
| 2600 |
+
Handle a deletion request from Discord.
|
| 2601 |
+
|
| 2602 |
+
This will cause the bot to get rid of or disassociate all data from the specified user ID.
|
| 2603 |
+
You should not use this unless Discord has specifically requested this with regard to a deleted user.
|
| 2604 |
+
This will remove the user from various anti-abuse measures.
|
| 2605 |
+
If you are processing a manual request from a user, you may want ``[p]mydata ownermanagement deleteforuser`` instead.
|
| 2606 |
+
|
| 2607 |
+
**Arguments:**
|
| 2608 |
+
- ``<user_id>`` - The id of the user whose data would be deleted.
|
| 2609 |
+
|
| 2610 |
+
.. _core-command-mydata-ownermanagement-setuserdeletionlevel:
|
| 2611 |
+
|
| 2612 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 2613 |
+
mydata ownermanagement setuserdeletionlevel
|
| 2614 |
+
"""""""""""""""""""""""""""""""""""""""""""
|
| 2615 |
+
|
| 2616 |
+
**Syntax**
|
| 2617 |
+
|
| 2618 |
+
.. code-block:: none
|
| 2619 |
+
|
| 2620 |
+
[p]mydata ownermanagement setuserdeletionlevel <level>
|
| 2621 |
+
|
| 2622 |
+
**Description**
|
| 2623 |
+
|
| 2624 |
+
Sets how user deletions are treated.
|
| 2625 |
+
|
| 2626 |
+
**Example:**
|
| 2627 |
+
- ``[p]mydata ownermanagement setuserdeletionlevel 1``
|
| 2628 |
+
|
| 2629 |
+
**Arguments:**
|
| 2630 |
+
- ``<level>`` - The strictness level for user deletion. See Level guide below.
|
| 2631 |
+
|
| 2632 |
+
Level:
|
| 2633 |
+
- ``0``: What users can delete is left entirely up to each cog.
|
| 2634 |
+
- ``1``: Cogs should delete anything the cog doesn't need about the user.
|
| 2635 |
+
|
| 2636 |
+
.. _core-command-mydata-whatdata:
|
| 2637 |
+
|
| 2638 |
+
"""""""""""""""
|
| 2639 |
+
mydata whatdata
|
| 2640 |
+
"""""""""""""""
|
| 2641 |
+
|
| 2642 |
+
**Syntax**
|
| 2643 |
+
|
| 2644 |
+
.. code-block:: none
|
| 2645 |
+
|
| 2646 |
+
[p]mydata whatdata
|
| 2647 |
+
|
| 2648 |
+
**Description**
|
| 2649 |
+
|
| 2650 |
+
Find out what type of data Red stores and why.
|
| 2651 |
+
|
| 2652 |
+
**Example:**
|
| 2653 |
+
- ``[p]mydata whatdata``
|
| 2654 |
+
|
| 2655 |
+
.. _core-command-reload:
|
| 2656 |
+
|
| 2657 |
+
^^^^^^
|
| 2658 |
+
reload
|
| 2659 |
+
^^^^^^
|
| 2660 |
+
|
| 2661 |
+
.. note:: |owner-lock|
|
| 2662 |
+
|
| 2663 |
+
**Syntax**
|
| 2664 |
+
|
| 2665 |
+
.. code-block:: none
|
| 2666 |
+
|
| 2667 |
+
[p]reload <cogs...>
|
| 2668 |
+
|
| 2669 |
+
**Description**
|
| 2670 |
+
|
| 2671 |
+
Reloads cog packages.
|
| 2672 |
+
|
| 2673 |
+
This will unload and then load the specified cogs.
|
| 2674 |
+
|
| 2675 |
+
Cogs that were not loaded will only be loaded.
|
| 2676 |
+
|
| 2677 |
+
**Examples:**
|
| 2678 |
+
- ``[p]reload general`` - Unloads then loads the ``general`` cog.
|
| 2679 |
+
- ``[p]reload admin mod mutes`` - Unloads then loads multiple cogs.
|
| 2680 |
+
|
| 2681 |
+
**Arguments:**
|
| 2682 |
+
- ``<cogs...>`` - The cog packages to reload.
|
| 2683 |
+
|
| 2684 |
+
.. _core-command-restart:
|
| 2685 |
+
|
| 2686 |
+
^^^^^^^
|
| 2687 |
+
restart
|
| 2688 |
+
^^^^^^^
|
| 2689 |
+
|
| 2690 |
+
.. note:: |owner-lock|
|
| 2691 |
+
|
| 2692 |
+
**Syntax**
|
| 2693 |
+
|
| 2694 |
+
.. code-block:: none
|
| 2695 |
+
|
| 2696 |
+
[p]restart [silently=False]
|
| 2697 |
+
|
| 2698 |
+
**Description**
|
| 2699 |
+
|
| 2700 |
+
Attempts to restart Red.
|
| 2701 |
+
|
| 2702 |
+
Makes Red quit with exit code 26.
|
| 2703 |
+
The restart is not guaranteed: it must be dealt with by the process manager in use.
|
| 2704 |
+
|
| 2705 |
+
**Examples:**
|
| 2706 |
+
- ``[p]restart``
|
| 2707 |
+
- ``[p]restart True`` - Restarts silently.
|
| 2708 |
+
|
| 2709 |
+
**Arguments:**
|
| 2710 |
+
- ``[silently]`` - Whether to skip sending the restart message. Defaults to False.
|
| 2711 |
+
|
| 2712 |
+
.. _core-command-servers:
|
| 2713 |
+
|
| 2714 |
+
^^^^^^^
|
| 2715 |
+
servers
|
| 2716 |
+
^^^^^^^
|
| 2717 |
+
|
| 2718 |
+
.. note:: |owner-lock|
|
| 2719 |
+
|
| 2720 |
+
**Syntax**
|
| 2721 |
+
|
| 2722 |
+
.. code-block:: none
|
| 2723 |
+
|
| 2724 |
+
[p]servers
|
| 2725 |
+
|
| 2726 |
+
**Description**
|
| 2727 |
+
|
| 2728 |
+
Lists the servers Red is currently in.
|
| 2729 |
+
|
| 2730 |
+
.. Note:: This command is interactive.
|
| 2731 |
+
|
| 2732 |
+
|
| 2733 |
+
.. _core-command-set:
|
| 2734 |
+
|
| 2735 |
+
^^^
|
| 2736 |
+
set
|
| 2737 |
+
^^^
|
| 2738 |
+
|
| 2739 |
+
**Syntax**
|
| 2740 |
+
|
| 2741 |
+
.. code-block:: none
|
| 2742 |
+
|
| 2743 |
+
[p]set
|
| 2744 |
+
|
| 2745 |
+
**Description**
|
| 2746 |
+
|
| 2747 |
+
Commands for changing Red's settings.
|
| 2748 |
+
|
| 2749 |
+
.. _core-command-set-api:
|
| 2750 |
+
|
| 2751 |
+
"""""""
|
| 2752 |
+
set api
|
| 2753 |
+
"""""""
|
| 2754 |
+
|
| 2755 |
+
.. note:: |owner-lock|
|
| 2756 |
+
|
| 2757 |
+
**Syntax**
|
| 2758 |
+
|
| 2759 |
+
.. code-block:: none
|
| 2760 |
+
|
| 2761 |
+
[p]set api <service> <tokens>
|
| 2762 |
+
|
| 2763 |
+
**Description**
|
| 2764 |
+
|
| 2765 |
+
Commands to set, list or remove various external API tokens.
|
| 2766 |
+
|
| 2767 |
+
This setting will be asked for by some 3rd party cogs and some core cogs.
|
| 2768 |
+
|
| 2769 |
+
To add the keys provide the service name and the tokens as a comma separated
|
| 2770 |
+
list of key,values as described by the cog requesting this command.
|
| 2771 |
+
|
| 2772 |
+
.. Note:: API tokens are sensitive, so this command should only be used in a private channel or in DM with the bot.
|
| 2773 |
+
|
| 2774 |
+
|
| 2775 |
+
**Examples:**
|
| 2776 |
+
- ``[p]set api spotify redirect_uri localhost``
|
| 2777 |
+
- ``[p]set api github client_id,whoops client_secret,whoops``
|
| 2778 |
+
|
| 2779 |
+
**Arguments:**
|
| 2780 |
+
- ``<service>`` - The service you're adding tokens to.
|
| 2781 |
+
- ``<tokens>`` - Pairs of token keys and values. The key and value should be separated by one of `` ``, ``,``, or ``;``.
|
| 2782 |
+
|
| 2783 |
+
.. _core-command-set-api-list:
|
| 2784 |
+
|
| 2785 |
+
""""""""""""
|
| 2786 |
+
set api list
|
| 2787 |
+
""""""""""""
|
| 2788 |
+
|
| 2789 |
+
**Syntax**
|
| 2790 |
+
|
| 2791 |
+
.. code-block:: none
|
| 2792 |
+
|
| 2793 |
+
[p]set api list
|
| 2794 |
+
|
| 2795 |
+
**Description**
|
| 2796 |
+
|
| 2797 |
+
Show all external API services along with their keys that have been set.
|
| 2798 |
+
|
| 2799 |
+
Secrets are not shown.
|
| 2800 |
+
|
| 2801 |
+
**Example:**
|
| 2802 |
+
- ``[p]set api list``
|
| 2803 |
+
|
| 2804 |
+
.. _core-command-set-api-remove:
|
| 2805 |
+
|
| 2806 |
+
""""""""""""""
|
| 2807 |
+
set api remove
|
| 2808 |
+
""""""""""""""
|
| 2809 |
+
|
| 2810 |
+
**Syntax**
|
| 2811 |
+
|
| 2812 |
+
.. code-block:: none
|
| 2813 |
+
|
| 2814 |
+
[p]set api remove <services...>
|
| 2815 |
+
|
| 2816 |
+
**Description**
|
| 2817 |
+
|
| 2818 |
+
Remove the given services with all their keys and tokens.
|
| 2819 |
+
|
| 2820 |
+
**Examples:**
|
| 2821 |
+
- ``[p]set api remove spotify``
|
| 2822 |
+
- ``[p]set api remove github youtube``
|
| 2823 |
+
|
| 2824 |
+
**Arguments:**
|
| 2825 |
+
- ``<services...>`` - The services to remove.
|
| 2826 |
+
|
| 2827 |
+
.. _core-command-set-bot:
|
| 2828 |
+
|
| 2829 |
+
"""""""
|
| 2830 |
+
set bot
|
| 2831 |
+
"""""""
|
| 2832 |
+
|
| 2833 |
+
.. note:: |admin-lock|
|
| 2834 |
+
|
| 2835 |
+
**Syntax**
|
| 2836 |
+
|
| 2837 |
+
.. code-block:: none
|
| 2838 |
+
|
| 2839 |
+
[p]set bot
|
| 2840 |
+
|
| 2841 |
+
**Description**
|
| 2842 |
+
|
| 2843 |
+
Commands for changing Red's metadata.
|
| 2844 |
+
|
| 2845 |
+
.. _core-command-set-bot-avatar:
|
| 2846 |
+
|
| 2847 |
+
""""""""""""""
|
| 2848 |
+
set bot avatar
|
| 2849 |
+
""""""""""""""
|
| 2850 |
+
|
| 2851 |
+
.. note:: |owner-lock|
|
| 2852 |
+
|
| 2853 |
+
**Syntax**
|
| 2854 |
+
|
| 2855 |
+
.. code-block:: none
|
| 2856 |
+
|
| 2857 |
+
[p]set bot avatar [url]
|
| 2858 |
+
|
| 2859 |
+
**Description**
|
| 2860 |
+
|
| 2861 |
+
Sets Red's avatar
|
| 2862 |
+
|
| 2863 |
+
Supports either an attachment or an image URL.
|
| 2864 |
+
|
| 2865 |
+
**Examples:**
|
| 2866 |
+
- ``[p]set bot avatar`` - With an image attachment, this will set the avatar.
|
| 2867 |
+
- ``[p]set bot avatar`` - Without an attachment, this will show the command help.
|
| 2868 |
+
- ``[p]set bot avatar https://links.flaree.xyz/k95`` - Sets the avatar to the provided url.
|
| 2869 |
+
|
| 2870 |
+
**Arguments:**
|
| 2871 |
+
- ``[url]`` - An image url to be used as an avatar. Leave blank when uploading an attachment.
|
| 2872 |
+
|
| 2873 |
+
.. _core-command-set-bot-avatar-remove:
|
| 2874 |
+
|
| 2875 |
+
"""""""""""""""""""""
|
| 2876 |
+
set bot avatar remove
|
| 2877 |
+
"""""""""""""""""""""
|
| 2878 |
+
|
| 2879 |
+
.. note:: |owner-lock|
|
| 2880 |
+
|
| 2881 |
+
**Syntax**
|
| 2882 |
+
|
| 2883 |
+
.. code-block:: none
|
| 2884 |
+
|
| 2885 |
+
[p]set bot avatar remove
|
| 2886 |
+
|
| 2887 |
+
.. tip:: Alias: ``set bot avatar clear``
|
| 2888 |
+
|
| 2889 |
+
**Description**
|
| 2890 |
+
|
| 2891 |
+
Removes Red's avatar.
|
| 2892 |
+
|
| 2893 |
+
**Example:**
|
| 2894 |
+
- ``[p]set bot avatar remove``
|
| 2895 |
+
|
| 2896 |
+
.. _core-command-set-bot-custominfo:
|
| 2897 |
+
|
| 2898 |
+
""""""""""""""""""
|
| 2899 |
+
set bot custominfo
|
| 2900 |
+
""""""""""""""""""
|
| 2901 |
+
|
| 2902 |
+
.. note:: |owner-lock|
|
| 2903 |
+
|
| 2904 |
+
**Syntax**
|
| 2905 |
+
|
| 2906 |
+
.. code-block:: none
|
| 2907 |
+
|
| 2908 |
+
[p]set bot custominfo [text]
|
| 2909 |
+
|
| 2910 |
+
**Description**
|
| 2911 |
+
|
| 2912 |
+
Customizes a section of ``[p]info``.
|
| 2913 |
+
|
| 2914 |
+
The maximum amount of allowed characters is 1024.
|
| 2915 |
+
Supports markdown, links and "mentions".
|
| 2916 |
+
|
| 2917 |
+
Link example: ``[My link](https://example.com)``
|
| 2918 |
+
|
| 2919 |
+
**Examples:**
|
| 2920 |
+
- ``[p]set bot custominfo >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.``
|
| 2921 |
+
- ``[p]set bot custominfo Join my [support server](discord.gg/discord)!``
|
| 2922 |
+
- ``[p]set bot custominfo`` - Removes custom info text.
|
| 2923 |
+
|
| 2924 |
+
**Arguments:**
|
| 2925 |
+
- ``[text]`` - The custom info text.
|
| 2926 |
+
|
| 2927 |
+
.. _core-command-set-bot-description:
|
| 2928 |
+
|
| 2929 |
+
"""""""""""""""""""
|
| 2930 |
+
set bot description
|
| 2931 |
+
"""""""""""""""""""
|
| 2932 |
+
|
| 2933 |
+
.. note:: |owner-lock|
|
| 2934 |
+
|
| 2935 |
+
**Syntax**
|
| 2936 |
+
|
| 2937 |
+
.. code-block:: none
|
| 2938 |
+
|
| 2939 |
+
[p]set bot description [description]
|
| 2940 |
+
|
| 2941 |
+
**Description**
|
| 2942 |
+
|
| 2943 |
+
Sets the bot's description.
|
| 2944 |
+
|
| 2945 |
+
Use without a description to reset.
|
| 2946 |
+
This is shown in a few locations, including the help menu.
|
| 2947 |
+
|
| 2948 |
+
The maximum description length is 250 characters to ensure it displays properly.
|
| 2949 |
+
|
| 2950 |
+
The default is "Red V3".
|
| 2951 |
+
|
| 2952 |
+
**Examples:**
|
| 2953 |
+
- ``[p]set bot description`` - Resets the description to the default setting.
|
| 2954 |
+
- ``[p]set bot description MyBot: A Red V3 Bot``
|
| 2955 |
+
|
| 2956 |
+
**Arguments:**
|
| 2957 |
+
- ``[description]`` - The description to use for this bot. Leave blank to reset to the default.
|
| 2958 |
+
|
| 2959 |
+
.. _core-command-set-bot-nickname:
|
| 2960 |
+
|
| 2961 |
+
""""""""""""""""
|
| 2962 |
+
set bot nickname
|
| 2963 |
+
""""""""""""""""
|
| 2964 |
+
|
| 2965 |
+
.. note:: |admin-lock|
|
| 2966 |
+
|
| 2967 |
+
**Syntax**
|
| 2968 |
+
|
| 2969 |
+
.. code-block:: none
|
| 2970 |
+
|
| 2971 |
+
[p]set bot nickname [nickname]
|
| 2972 |
+
|
| 2973 |
+
**Description**
|
| 2974 |
+
|
| 2975 |
+
Sets Red's nickname for the current server.
|
| 2976 |
+
|
| 2977 |
+
Maximum length for a nickname is 32 characters.
|
| 2978 |
+
|
| 2979 |
+
**Example:**
|
| 2980 |
+
- ``[p]set bot nickname 🎃 SpookyBot 🎃``
|
| 2981 |
+
|
| 2982 |
+
**Arguments:**
|
| 2983 |
+
- ``[nickname]`` - The nickname to give the bot. Leave blank to clear the current nickname.
|
| 2984 |
+
|
| 2985 |
+
.. _core-command-set-bot-username:
|
| 2986 |
+
|
| 2987 |
+
""""""""""""""""
|
| 2988 |
+
set bot username
|
| 2989 |
+
""""""""""""""""
|
| 2990 |
+
|
| 2991 |
+
.. note:: |owner-lock|
|
| 2992 |
+
|
| 2993 |
+
**Syntax**
|
| 2994 |
+
|
| 2995 |
+
.. code-block:: none
|
| 2996 |
+
|
| 2997 |
+
[p]set bot username <username>
|
| 2998 |
+
|
| 2999 |
+
.. tip:: Alias: ``set bot name``
|
| 3000 |
+
|
| 3001 |
+
**Description**
|
| 3002 |
+
|
| 3003 |
+
Sets Red's username.
|
| 3004 |
+
|
| 3005 |
+
Maximum length for a username is 32 characters.
|
| 3006 |
+
|
| 3007 |
+
.. Note:: The username of a verified bot cannot be manually changed.
|
| 3008 |
+
|
| 3009 |
+
Please contact Discord support to change it.
|
| 3010 |
+
|
| 3011 |
+
**Example:**
|
| 3012 |
+
- ``[p]set bot username BaguetteBot``
|
| 3013 |
+
|
| 3014 |
+
**Arguments:**
|
| 3015 |
+
- ``<username>`` - The username to give the bot.
|
| 3016 |
+
|
| 3017 |
+
.. _core-command-set-colour:
|
| 3018 |
+
|
| 3019 |
+
""""""""""
|
| 3020 |
+
set colour
|
| 3021 |
+
""""""""""
|
| 3022 |
+
|
| 3023 |
+
.. note:: |owner-lock|
|
| 3024 |
+
|
| 3025 |
+
**Syntax**
|
| 3026 |
+
|
| 3027 |
+
.. code-block:: none
|
| 3028 |
+
|
| 3029 |
+
[p]set colour [colour]
|
| 3030 |
+
|
| 3031 |
+
.. tip:: Alias: ``set color``
|
| 3032 |
+
|
| 3033 |
+
**Description**
|
| 3034 |
+
|
| 3035 |
+
Sets a default colour to be used for the bot's embeds.
|
| 3036 |
+
|
| 3037 |
+
Acceptable values for the colour parameter can be found at:
|
| 3038 |
+
|
| 3039 |
+
https://discordpy.readthedocs.io/en/stable/ext/commands/api.html#discord.ext.commands.ColourConverter
|
| 3040 |
+
|
| 3041 |
+
**Examples:**
|
| 3042 |
+
- ``[p]set colour dark red``
|
| 3043 |
+
- ``[p]set colour blurple``
|
| 3044 |
+
- ``[p]set colour 0x5DADE2``
|
| 3045 |
+
- ``[p]set color 0x#FDFEFE``
|
| 3046 |
+
- ``[p]set color #7F8C8D``
|
| 3047 |
+
|
| 3048 |
+
**Arguments:**
|
| 3049 |
+
- ``[colour]`` - The colour to use for embeds. Leave blank to set to the default value (red).
|
| 3050 |
+
|
| 3051 |
+
.. _core-command-set-deletedelay:
|
| 3052 |
+
|
| 3053 |
+
"""""""""""""""
|
| 3054 |
+
set deletedelay
|
| 3055 |
+
"""""""""""""""
|
| 3056 |
+
|
| 3057 |
+
.. note:: |guildowner-lock|
|
| 3058 |
+
|
| 3059 |
+
**Syntax**
|
| 3060 |
+
|
| 3061 |
+
.. code-block:: none
|
| 3062 |
+
|
| 3063 |
+
[p]set deletedelay [time]
|
| 3064 |
+
|
| 3065 |
+
**Description**
|
| 3066 |
+
|
| 3067 |
+
Set the delay until the bot removes the command message.
|
| 3068 |
+
|
| 3069 |
+
Must be between -1 and 60.
|
| 3070 |
+
|
| 3071 |
+
Set to -1 to disable this feature.
|
| 3072 |
+
|
| 3073 |
+
This is only applied to the current server and not globally.
|
| 3074 |
+
|
| 3075 |
+
**Examples:**
|
| 3076 |
+
- ``[p]set deletedelay`` - Shows the current delete delay setting.
|
| 3077 |
+
- ``[p]set deletedelay 60`` - Sets the delete delay to the max of 60 seconds.
|
| 3078 |
+
- ``[p]set deletedelay -1`` - Disables deleting command messages.
|
| 3079 |
+
|
| 3080 |
+
**Arguments:**
|
| 3081 |
+
- ``[time]`` - The seconds to wait before deleting the command message. Use -1 to disable.
|
| 3082 |
+
|
| 3083 |
+
.. _core-command-set-errormsg:
|
| 3084 |
+
|
| 3085 |
+
""""""""""""
|
| 3086 |
+
set errormsg
|
| 3087 |
+
""""""""""""
|
| 3088 |
+
|
| 3089 |
+
.. note:: |owner-lock|
|
| 3090 |
+
|
| 3091 |
+
**Syntax**
|
| 3092 |
+
|
| 3093 |
+
.. code-block:: none
|
| 3094 |
+
|
| 3095 |
+
[p]set errormsg [msg]
|
| 3096 |
+
|
| 3097 |
+
**Description**
|
| 3098 |
+
|
| 3099 |
+
Set the message that will be sent on uncaught bot errors.
|
| 3100 |
+
|
| 3101 |
+
To include the command name in the message, use the ``{command}`` placeholder.
|
| 3102 |
+
|
| 3103 |
+
If you omit the ``msg`` argument, the message will be reset to the default one.
|
| 3104 |
+
|
| 3105 |
+
**Examples:**
|
| 3106 |
+
- ``[p]set errormsg`` - Resets the error message back to the default: "Error in command '{command}'.". If the command invoker is one of the bot owners, the message will also include "Check your console or logs for details.".
|
| 3107 |
+
- ``[p]set errormsg Oops, the command {command} has failed! Please try again later.`` - Sets the error message to a custom one.
|
| 3108 |
+
|
| 3109 |
+
**Arguments:**
|
| 3110 |
+
- ``[msg]`` - The custom error message. Must be less than 1000 characters. Omit to reset to the default one.
|
| 3111 |
+
|
| 3112 |
+
.. _core-command-set-fuzzy:
|
| 3113 |
+
|
| 3114 |
+
"""""""""
|
| 3115 |
+
set fuzzy
|
| 3116 |
+
"""""""""
|
| 3117 |
+
|
| 3118 |
+
.. note:: |owner-lock|
|
| 3119 |
+
|
| 3120 |
+
**Syntax**
|
| 3121 |
+
|
| 3122 |
+
.. code-block:: none
|
| 3123 |
+
|
| 3124 |
+
[p]set fuzzy
|
| 3125 |
+
|
| 3126 |
+
**Description**
|
| 3127 |
+
|
| 3128 |
+
Toggle whether to enable fuzzy command search in DMs.
|
| 3129 |
+
|
| 3130 |
+
This allows the bot to identify potential misspelled commands and offer corrections.
|
| 3131 |
+
|
| 3132 |
+
Default is for fuzzy command search to be disabled.
|
| 3133 |
+
|
| 3134 |
+
**Example:**
|
| 3135 |
+
- ``[p]set fuzzy``
|
| 3136 |
+
|
| 3137 |
+
.. _core-command-set-locale:
|
| 3138 |
+
|
| 3139 |
+
""""""""""
|
| 3140 |
+
set locale
|
| 3141 |
+
""""""""""
|
| 3142 |
+
|
| 3143 |
+
.. note:: |guildowner-lock|
|
| 3144 |
+
|
| 3145 |
+
**Syntax**
|
| 3146 |
+
|
| 3147 |
+
.. code-block:: none
|
| 3148 |
+
|
| 3149 |
+
[p]set locale <language_code>
|
| 3150 |
+
|
| 3151 |
+
**Description**
|
| 3152 |
+
|
| 3153 |
+
Changes the bot's locale in this server.
|
| 3154 |
+
|
| 3155 |
+
Go to `Red's Crowdin page <https://translate.discord.red>`_ to see locales that are available with translations.
|
| 3156 |
+
|
| 3157 |
+
Use "default" to return to the bot's default set language.
|
| 3158 |
+
|
| 3159 |
+
If you want to change bot's global locale, see ``[p]set locale global`` command.
|
| 3160 |
+
|
| 3161 |
+
**Examples:**
|
| 3162 |
+
- ``[p]set locale en-US``
|
| 3163 |
+
- ``[p]set locale de-DE``
|
| 3164 |
+
- ``[p]set locale fr-FR``
|
| 3165 |
+
- ``[p]set locale pl-PL``
|
| 3166 |
+
- ``[p]set locale default`` - Resets to the global default locale.
|
| 3167 |
+
|
| 3168 |
+
**Arguments:**
|
| 3169 |
+
- ``<language_code>`` - The default locale to use for the bot. This can be any language code with country code included.
|
| 3170 |
+
|
| 3171 |
+
.. _core-command-set-locale-global:
|
| 3172 |
+
|
| 3173 |
+
"""""""""""""""""
|
| 3174 |
+
set locale global
|
| 3175 |
+
"""""""""""""""""
|
| 3176 |
+
|
| 3177 |
+
.. note:: |owner-lock|
|
| 3178 |
+
|
| 3179 |
+
**Syntax**
|
| 3180 |
+
|
| 3181 |
+
.. code-block:: none
|
| 3182 |
+
|
| 3183 |
+
[p]set locale global <language_code>
|
| 3184 |
+
|
| 3185 |
+
**Description**
|
| 3186 |
+
|
| 3187 |
+
Changes the bot's default locale.
|
| 3188 |
+
|
| 3189 |
+
This will be used when a server has not set a locale, or in DMs.
|
| 3190 |
+
|
| 3191 |
+
Go to `Red's Crowdin page <https://translate.discord.red>`_ to see locales that are available with translations.
|
| 3192 |
+
|
| 3193 |
+
To reset to English, use "en-US".
|
| 3194 |
+
|
| 3195 |
+
**Examples:**
|
| 3196 |
+
- ``[p]set locale global en-US``
|
| 3197 |
+
- ``[p]set locale global de-DE``
|
| 3198 |
+
- ``[p]set locale global fr-FR``
|
| 3199 |
+
- ``[p]set locale global pl-PL``
|
| 3200 |
+
|
| 3201 |
+
**Arguments:**
|
| 3202 |
+
- ``<language_code>`` - The default locale to use for the bot. This can be any language code with country code included.
|
| 3203 |
+
|
| 3204 |
+
.. _core-command-set-locale-server:
|
| 3205 |
+
|
| 3206 |
+
"""""""""""""""""
|
| 3207 |
+
set locale server
|
| 3208 |
+
"""""""""""""""""
|
| 3209 |
+
|
| 3210 |
+
.. note:: |guildowner-lock|
|
| 3211 |
+
|
| 3212 |
+
**Syntax**
|
| 3213 |
+
|
| 3214 |
+
.. code-block:: none
|
| 3215 |
+
|
| 3216 |
+
[p]set locale server <language_code>
|
| 3217 |
+
|
| 3218 |
+
.. tip:: Aliases: ``set locale local``, ``set locale guild``
|
| 3219 |
+
|
| 3220 |
+
**Description**
|
| 3221 |
+
|
| 3222 |
+
Changes the bot's locale in this server.
|
| 3223 |
+
|
| 3224 |
+
Go to `Red's Crowdin page <https://translate.discord.red>`_ to see locales that are available with translations.
|
| 3225 |
+
|
| 3226 |
+
Use "default" to return to the bot's default set language.
|
| 3227 |
+
|
| 3228 |
+
**Examples:**
|
| 3229 |
+
- ``[p]set locale server en-US``
|
| 3230 |
+
- ``[p]set locale server de-DE``
|
| 3231 |
+
- ``[p]set locale server fr-FR``
|
| 3232 |
+
- ``[p]set locale server pl-PL``
|
| 3233 |
+
- ``[p]set locale server default`` - Resets to the global default locale.
|
| 3234 |
+
|
| 3235 |
+
**Arguments:**
|
| 3236 |
+
- ``<language_code>`` - The default locale to use for the bot. This can be any language code with country code included.
|
| 3237 |
+
|
| 3238 |
+
.. _core-command-set-ownernotifications:
|
| 3239 |
+
|
| 3240 |
+
""""""""""""""""""""""
|
| 3241 |
+
set ownernotifications
|
| 3242 |
+
""""""""""""""""""""""
|
| 3243 |
+
|
| 3244 |
+
.. note:: |owner-lock|
|
| 3245 |
+
|
| 3246 |
+
**Syntax**
|
| 3247 |
+
|
| 3248 |
+
.. code-block:: none
|
| 3249 |
+
|
| 3250 |
+
[p]set ownernotifications
|
| 3251 |
+
|
| 3252 |
+
**Description**
|
| 3253 |
+
|
| 3254 |
+
Commands for configuring owner notifications.
|
| 3255 |
+
|
| 3256 |
+
Owner notifications include usage of ``[p]contact`` and available Red updates.
|
| 3257 |
+
|
| 3258 |
+
.. _core-command-set-ownernotifications-adddestination:
|
| 3259 |
+
|
| 3260 |
+
"""""""""""""""""""""""""""""""""""""
|
| 3261 |
+
set ownernotifications adddestination
|
| 3262 |
+
"""""""""""""""""""""""""""""""""""""
|
| 3263 |
+
|
| 3264 |
+
**Syntax**
|
| 3265 |
+
|
| 3266 |
+
.. code-block:: none
|
| 3267 |
+
|
| 3268 |
+
[p]set ownernotifications adddestination <channel>
|
| 3269 |
+
|
| 3270 |
+
**Description**
|
| 3271 |
+
|
| 3272 |
+
Adds a destination text channel to receive owner notifications.
|
| 3273 |
+
|
| 3274 |
+
**Examples:**
|
| 3275 |
+
- ``[p]set ownernotifications adddestination #owner-notifications``
|
| 3276 |
+
- ``[p]set ownernotifications adddestination 168091848718417920`` - Accepts channel IDs.
|
| 3277 |
+
|
| 3278 |
+
**Arguments:**
|
| 3279 |
+
- ``<channel>`` - The channel to send owner notifications to.
|
| 3280 |
+
|
| 3281 |
+
.. _core-command-set-ownernotifications-listdestinations:
|
| 3282 |
+
|
| 3283 |
+
"""""""""""""""""""""""""""""""""""""""
|
| 3284 |
+
set ownernotifications listdestinations
|
| 3285 |
+
"""""""""""""""""""""""""""""""""""""""
|
| 3286 |
+
|
| 3287 |
+
**Syntax**
|
| 3288 |
+
|
| 3289 |
+
.. code-block:: none
|
| 3290 |
+
|
| 3291 |
+
[p]set ownernotifications listdestinations
|
| 3292 |
+
|
| 3293 |
+
**Description**
|
| 3294 |
+
|
| 3295 |
+
Lists the configured extra destinations for owner notifications.
|
| 3296 |
+
|
| 3297 |
+
**Example:**
|
| 3298 |
+
- ``[p]set ownernotifications listdestinations``
|
| 3299 |
+
|
| 3300 |
+
.. _core-command-set-ownernotifications-optin:
|
| 3301 |
+
|
| 3302 |
+
""""""""""""""""""""""""""""
|
| 3303 |
+
set ownernotifications optin
|
| 3304 |
+
""""""""""""""""""""""""""""
|
| 3305 |
+
|
| 3306 |
+
**Syntax**
|
| 3307 |
+
|
| 3308 |
+
.. code-block:: none
|
| 3309 |
+
|
| 3310 |
+
[p]set ownernotifications optin
|
| 3311 |
+
|
| 3312 |
+
**Description**
|
| 3313 |
+
|
| 3314 |
+
Opt-in on receiving owner notifications.
|
| 3315 |
+
|
| 3316 |
+
This is the default state.
|
| 3317 |
+
|
| 3318 |
+
.. Note:: This will only resume sending owner notifications to your DMs.
|
| 3319 |
+
|
| 3320 |
+
Additional owners and destinations will not be affected.
|
| 3321 |
+
|
| 3322 |
+
**Example:**
|
| 3323 |
+
- ``[p]set ownernotifications optin``
|
| 3324 |
+
|
| 3325 |
+
.. _core-command-set-ownernotifications-optout:
|
| 3326 |
+
|
| 3327 |
+
"""""""""""""""""""""""""""""
|
| 3328 |
+
set ownernotifications optout
|
| 3329 |
+
"""""""""""""""""""""""""""""
|
| 3330 |
+
|
| 3331 |
+
**Syntax**
|
| 3332 |
+
|
| 3333 |
+
.. code-block:: none
|
| 3334 |
+
|
| 3335 |
+
[p]set ownernotifications optout
|
| 3336 |
+
|
| 3337 |
+
**Description**
|
| 3338 |
+
|
| 3339 |
+
Opt-out of receiving owner notifications.
|
| 3340 |
+
|
| 3341 |
+
.. Note:: This will only stop sending owner notifications to your DMs.
|
| 3342 |
+
|
| 3343 |
+
Additional owners and destinations will still receive notifications.
|
| 3344 |
+
|
| 3345 |
+
**Example:**
|
| 3346 |
+
- ``[p]set ownernotifications optout``
|
| 3347 |
+
|
| 3348 |
+
.. _core-command-set-ownernotifications-removedestination:
|
| 3349 |
+
|
| 3350 |
+
""""""""""""""""""""""""""""""""""""""""
|
| 3351 |
+
set ownernotifications removedestination
|
| 3352 |
+
""""""""""""""""""""""""""""""""""""""""
|
| 3353 |
+
|
| 3354 |
+
**Syntax**
|
| 3355 |
+
|
| 3356 |
+
.. code-block:: none
|
| 3357 |
+
|
| 3358 |
+
[p]set ownernotifications removedestination <channel>
|
| 3359 |
+
|
| 3360 |
+
.. tip:: Aliases: ``set ownernotifications remdestination``, ``set ownernotifications deletedestination``, ``set ownernotifications deldestination``
|
| 3361 |
+
|
| 3362 |
+
**Description**
|
| 3363 |
+
|
| 3364 |
+
Removes a destination text channel from receiving owner notifications.
|
| 3365 |
+
|
| 3366 |
+
**Examples:**
|
| 3367 |
+
- ``[p]set ownernotifications removedestination #owner-notifications``
|
| 3368 |
+
- ``[p]set ownernotifications deletedestination 168091848718417920`` - Accepts channel IDs.
|
| 3369 |
+
|
| 3370 |
+
**Arguments:**
|
| 3371 |
+
- ``<channel>`` - The channel to stop sending owner notifications to.
|
| 3372 |
+
|
| 3373 |
+
.. _core-command-set-prefix:
|
| 3374 |
+
|
| 3375 |
+
""""""""""
|
| 3376 |
+
set prefix
|
| 3377 |
+
""""""""""
|
| 3378 |
+
|
| 3379 |
+
.. note:: |owner-lock|
|
| 3380 |
+
|
| 3381 |
+
**Syntax**
|
| 3382 |
+
|
| 3383 |
+
.. code-block:: none
|
| 3384 |
+
|
| 3385 |
+
[p]set prefix <prefixes...>
|
| 3386 |
+
|
| 3387 |
+
.. tip:: Alias: ``set prefixes``
|
| 3388 |
+
|
| 3389 |
+
**Description**
|
| 3390 |
+
|
| 3391 |
+
Sets Red's global prefix(es).
|
| 3392 |
+
|
| 3393 |
+
.. Warning:: This is not additive. It will replace all current prefixes.
|
| 3394 |
+
|
| 3395 |
+
|
| 3396 |
+
See also the ``--mentionable`` flag to enable mentioning the bot as the prefix.
|
| 3397 |
+
|
| 3398 |
+
**Examples:**
|
| 3399 |
+
- ``[p]set prefix !``
|
| 3400 |
+
- ``[p]set prefix "! "`` - Quotes are needed to use spaces in prefixes.
|
| 3401 |
+
- ``[p]set prefix "@Red "`` - This uses a mention as the prefix. See also the ``--mentionable`` flag.
|
| 3402 |
+
- ``[p]set prefix ! ? .`` - Sets multiple prefixes.
|
| 3403 |
+
|
| 3404 |
+
**Arguments:**
|
| 3405 |
+
- ``<prefixes...>`` - The prefixes the bot will respond to globally.
|
| 3406 |
+
|
| 3407 |
+
.. _core-command-set-regionalformat:
|
| 3408 |
+
|
| 3409 |
+
""""""""""""""""""
|
| 3410 |
+
set regionalformat
|
| 3411 |
+
""""""""""""""""""
|
| 3412 |
+
|
| 3413 |
+
.. note:: |guildowner-lock|
|
| 3414 |
+
|
| 3415 |
+
**Syntax**
|
| 3416 |
+
|
| 3417 |
+
.. code-block:: none
|
| 3418 |
+
|
| 3419 |
+
[p]set regionalformat <language_code>
|
| 3420 |
+
|
| 3421 |
+
.. tip:: Alias: ``set region``
|
| 3422 |
+
|
| 3423 |
+
**Description**
|
| 3424 |
+
|
| 3425 |
+
Changes the bot's regional format in this server. This is used for formatting date, time and numbers.
|
| 3426 |
+
|
| 3427 |
+
``language_code`` can be any language code with country code included, e.g. ``en-US``, ``de-DE``, ``fr-FR``, ``pl-PL``, etc.
|
| 3428 |
+
Pass "reset" to ``language_code`` to base regional formatting on bot's locale in this server.
|
| 3429 |
+
|
| 3430 |
+
If you want to change bot's global regional format, see ``[p]set regionalformat global`` command.
|
| 3431 |
+
|
| 3432 |
+
**Examples:**
|
| 3433 |
+
- ``[p]set regionalformat en-US``
|
| 3434 |
+
- ``[p]set region de-DE``
|
| 3435 |
+
- ``[p]set regionalformat reset`` - Resets to the locale.
|
| 3436 |
+
|
| 3437 |
+
**Arguments:**
|
| 3438 |
+
- ``[language_code]`` - The region format to use for the bot in this server.
|
| 3439 |
+
|
| 3440 |
+
.. _core-command-set-regionalformat-global:
|
| 3441 |
+
|
| 3442 |
+
"""""""""""""""""""""""""
|
| 3443 |
+
set regionalformat global
|
| 3444 |
+
"""""""""""""""""""""""""
|
| 3445 |
+
|
| 3446 |
+
.. note:: |owner-lock|
|
| 3447 |
+
|
| 3448 |
+
**Syntax**
|
| 3449 |
+
|
| 3450 |
+
.. code-block:: none
|
| 3451 |
+
|
| 3452 |
+
[p]set regionalformat global <language_code>
|
| 3453 |
+
|
| 3454 |
+
**Description**
|
| 3455 |
+
|
| 3456 |
+
Changes the bot's regional format. This is used for formatting date, time and numbers.
|
| 3457 |
+
|
| 3458 |
+
``language_code`` can be any language code with country code included, e.g. ``en-US``, ``de-DE``, ``fr-FR``, ``pl-PL``, etc.
|
| 3459 |
+
Pass "reset" to ``language_code`` to base regional formatting on bot's locale.
|
| 3460 |
+
|
| 3461 |
+
**Examples:**
|
| 3462 |
+
- ``[p]set regionalformat global en-US``
|
| 3463 |
+
- ``[p]set region global de-DE``
|
| 3464 |
+
- ``[p]set regionalformat global reset`` - Resets to the locale.
|
| 3465 |
+
|
| 3466 |
+
**Arguments:**
|
| 3467 |
+
- ``[language_code]`` - The default region format to use for the bot.
|
| 3468 |
+
|
| 3469 |
+
.. _core-command-set-regionalformat-server:
|
| 3470 |
+
|
| 3471 |
+
"""""""""""""""""""""""""
|
| 3472 |
+
set regionalformat server
|
| 3473 |
+
"""""""""""""""""""""""""
|
| 3474 |
+
|
| 3475 |
+
.. note:: |guildowner-lock|
|
| 3476 |
+
|
| 3477 |
+
**Syntax**
|
| 3478 |
+
|
| 3479 |
+
.. code-block:: none
|
| 3480 |
+
|
| 3481 |
+
[p]set regionalformat server <language_code>
|
| 3482 |
+
|
| 3483 |
+
.. tip:: Aliases: ``set regionalformat local``, ``set regionalformat guild``
|
| 3484 |
+
|
| 3485 |
+
**Description**
|
| 3486 |
+
|
| 3487 |
+
Changes the bot's regional format in this server. This is used for formatting date, time and numbers.
|
| 3488 |
+
|
| 3489 |
+
``language_code`` can be any language code with country code included, e.g. ``en-US``, ``de-DE``, ``fr-FR``, ``pl-PL``, etc.
|
| 3490 |
+
Pass "reset" to ``language_code`` to base regional formatting on bot's locale in this server.
|
| 3491 |
+
|
| 3492 |
+
**Examples:**
|
| 3493 |
+
- ``[p]set regionalformat server en-US``
|
| 3494 |
+
- ``[p]set region local de-DE``
|
| 3495 |
+
- ``[p]set regionalformat server reset`` - Resets to the locale.
|
| 3496 |
+
|
| 3497 |
+
**Arguments:**
|
| 3498 |
+
- ``[language_code]`` - The region format to use for the bot in this server.
|
| 3499 |
+
|
| 3500 |
+
.. _core-command-set-roles:
|
| 3501 |
+
|
| 3502 |
+
"""""""""
|
| 3503 |
+
set roles
|
| 3504 |
+
"""""""""
|
| 3505 |
+
|
| 3506 |
+
.. note:: |guildowner-lock|
|
| 3507 |
+
|
| 3508 |
+
**Syntax**
|
| 3509 |
+
|
| 3510 |
+
.. code-block:: none
|
| 3511 |
+
|
| 3512 |
+
[p]set roles
|
| 3513 |
+
|
| 3514 |
+
**Description**
|
| 3515 |
+
|
| 3516 |
+
Set server's admin and mod roles for Red.
|
| 3517 |
+
|
| 3518 |
+
.. _core-command-set-roles-addadminrole:
|
| 3519 |
+
|
| 3520 |
+
""""""""""""""""""""""
|
| 3521 |
+
set roles addadminrole
|
| 3522 |
+
""""""""""""""""""""""
|
| 3523 |
+
|
| 3524 |
+
.. note:: |guildowner-lock|
|
| 3525 |
+
|
| 3526 |
+
**Syntax**
|
| 3527 |
+
|
| 3528 |
+
.. code-block:: none
|
| 3529 |
+
|
| 3530 |
+
[p]set roles addadminrole <role>
|
| 3531 |
+
|
| 3532 |
+
**Description**
|
| 3533 |
+
|
| 3534 |
+
Adds an admin role for this guild.
|
| 3535 |
+
|
| 3536 |
+
Admins have the same access as Mods, plus additional admin level commands like:
|
| 3537 |
+
- ``[p]set serverprefix``
|
| 3538 |
+
- ``[p]addrole``
|
| 3539 |
+
- ``[p]ban``
|
| 3540 |
+
- ``[p]ignore guild``
|
| 3541 |
+
|
| 3542 |
+
And more.
|
| 3543 |
+
|
| 3544 |
+
**Examples:**
|
| 3545 |
+
- ``[p]set roles addadminrole @Admins``
|
| 3546 |
+
- ``[p]set roles addadminrole Super Admins``
|
| 3547 |
+
|
| 3548 |
+
**Arguments:**
|
| 3549 |
+
- ``<role>`` - The role to add as an admin.
|
| 3550 |
+
|
| 3551 |
+
.. _core-command-set-roles-addmodrole:
|
| 3552 |
+
|
| 3553 |
+
""""""""""""""""""""
|
| 3554 |
+
set roles addmodrole
|
| 3555 |
+
""""""""""""""""""""
|
| 3556 |
+
|
| 3557 |
+
.. note:: |guildowner-lock|
|
| 3558 |
+
|
| 3559 |
+
**Syntax**
|
| 3560 |
+
|
| 3561 |
+
.. code-block:: none
|
| 3562 |
+
|
| 3563 |
+
[p]set roles addmodrole <role>
|
| 3564 |
+
|
| 3565 |
+
**Description**
|
| 3566 |
+
|
| 3567 |
+
Adds a moderator role for this guild.
|
| 3568 |
+
|
| 3569 |
+
This grants access to moderator level commands like:
|
| 3570 |
+
- ``[p]mute``
|
| 3571 |
+
- ``[p]cleanup``
|
| 3572 |
+
- ``[p]customcommand create``
|
| 3573 |
+
|
| 3574 |
+
And more.
|
| 3575 |
+
|
| 3576 |
+
**Examples:**
|
| 3577 |
+
- ``[p]set roles addmodrole @Mods``
|
| 3578 |
+
- ``[p]set roles addmodrole Loyal Helpers``
|
| 3579 |
+
|
| 3580 |
+
**Arguments:**
|
| 3581 |
+
- ``<role>`` - The role to add as a moderator.
|
| 3582 |
+
|
| 3583 |
+
.. _core-command-set-roles-removeadminrole:
|
| 3584 |
+
|
| 3585 |
+
"""""""""""""""""""""""""
|
| 3586 |
+
set roles removeadminrole
|
| 3587 |
+
"""""""""""""""""""""""""
|
| 3588 |
+
|
| 3589 |
+
.. note:: |guildowner-lock|
|
| 3590 |
+
|
| 3591 |
+
**Syntax**
|
| 3592 |
+
|
| 3593 |
+
.. code-block:: none
|
| 3594 |
+
|
| 3595 |
+
[p]set roles removeadminrole <role>
|
| 3596 |
+
|
| 3597 |
+
.. tip:: Aliases: ``set roles remadmindrole``, ``set roles deladminrole``, ``set roles deleteadminrole``
|
| 3598 |
+
|
| 3599 |
+
**Description**
|
| 3600 |
+
|
| 3601 |
+
Removes an admin role for this guild.
|
| 3602 |
+
|
| 3603 |
+
**Examples:**
|
| 3604 |
+
- ``[p]set roles removeadminrole @Admins``
|
| 3605 |
+
- ``[p]set roles removeadminrole Super Admins``
|
| 3606 |
+
|
| 3607 |
+
**Arguments:**
|
| 3608 |
+
- ``<role>`` - The role to remove from being an admin.
|
| 3609 |
+
|
| 3610 |
+
.. _core-command-set-roles-removemodrole:
|
| 3611 |
+
|
| 3612 |
+
"""""""""""""""""""""""
|
| 3613 |
+
set roles removemodrole
|
| 3614 |
+
"""""""""""""""""""""""
|
| 3615 |
+
|
| 3616 |
+
.. note:: |guildowner-lock|
|
| 3617 |
+
|
| 3618 |
+
**Syntax**
|
| 3619 |
+
|
| 3620 |
+
.. code-block:: none
|
| 3621 |
+
|
| 3622 |
+
[p]set roles removemodrole <role>
|
| 3623 |
+
|
| 3624 |
+
.. tip:: Aliases: ``set roles remmodrole``, ``set roles delmodrole``, ``set roles deletemodrole``
|
| 3625 |
+
|
| 3626 |
+
**Description**
|
| 3627 |
+
|
| 3628 |
+
Removes a mod role for this guild.
|
| 3629 |
+
|
| 3630 |
+
**Examples:**
|
| 3631 |
+
- ``[p]set roles removemodrole @Mods``
|
| 3632 |
+
- ``[p]set roles removemodrole Loyal Helpers``
|
| 3633 |
+
|
| 3634 |
+
**Arguments:**
|
| 3635 |
+
- ``<role>`` - The role to remove from being a moderator.
|
| 3636 |
+
|
| 3637 |
+
.. _core-command-set-serverfuzzy:
|
| 3638 |
+
|
| 3639 |
+
"""""""""""""""
|
| 3640 |
+
set serverfuzzy
|
| 3641 |
+
"""""""""""""""
|
| 3642 |
+
|
| 3643 |
+
.. note:: |guildowner-lock|
|
| 3644 |
+
|
| 3645 |
+
**Syntax**
|
| 3646 |
+
|
| 3647 |
+
.. code-block:: none
|
| 3648 |
+
|
| 3649 |
+
[p]set serverfuzzy
|
| 3650 |
+
|
| 3651 |
+
**Description**
|
| 3652 |
+
|
| 3653 |
+
Toggle whether to enable fuzzy command search for the server.
|
| 3654 |
+
|
| 3655 |
+
This allows the bot to identify potential misspelled commands and offer corrections.
|
| 3656 |
+
|
| 3657 |
+
.. Note:: This can be processor intensive and may be unsuitable for larger servers.
|
| 3658 |
+
|
| 3659 |
+
|
| 3660 |
+
Default is for fuzzy command search to be disabled.
|
| 3661 |
+
|
| 3662 |
+
**Example:**
|
| 3663 |
+
- ``[p]set serverfuzzy``
|
| 3664 |
+
|
| 3665 |
+
.. _core-command-set-serverprefix:
|
| 3666 |
+
|
| 3667 |
+
""""""""""""""""
|
| 3668 |
+
set serverprefix
|
| 3669 |
+
""""""""""""""""
|
| 3670 |
+
|
| 3671 |
+
.. note:: |admin-lock|
|
| 3672 |
+
|
| 3673 |
+
**Syntax**
|
| 3674 |
+
|
| 3675 |
+
.. code-block:: none
|
| 3676 |
+
|
| 3677 |
+
[p]set serverprefix [prefixes...]
|
| 3678 |
+
|
| 3679 |
+
.. tip:: Alias: ``set serverprefixes``
|
| 3680 |
+
|
| 3681 |
+
**Description**
|
| 3682 |
+
|
| 3683 |
+
Sets Red's server prefix(es).
|
| 3684 |
+
|
| 3685 |
+
.. Warning:: This will override global prefixes, the bot will not respond to any global prefixes in this server.
|
| 3686 |
+
|
| 3687 |
+
This is not additive. It will replace all current server prefixes.
|
| 3688 |
+
|
| 3689 |
+
You cannot have a prefix with more than 25 characters.
|
| 3690 |
+
|
| 3691 |
+
**Examples:**
|
| 3692 |
+
- ``[p]set serverprefix !``
|
| 3693 |
+
- ``[p]set serverprefix "! "`` - Quotes are needed to use spaces in prefixes.
|
| 3694 |
+
- ``[p]set serverprefix "@Red "`` - This uses a mention as the prefix.
|
| 3695 |
+
- ``[p]set serverprefix ! ? .`` - Sets multiple prefixes.
|
| 3696 |
+
|
| 3697 |
+
**Arguments:**
|
| 3698 |
+
- ``[prefixes...]`` - The prefixes the bot will respond to on this server. Leave blank to clear server prefixes.
|
| 3699 |
+
|
| 3700 |
+
.. _core-command-set-showsettings:
|
| 3701 |
+
|
| 3702 |
+
""""""""""""""""
|
| 3703 |
+
set showsettings
|
| 3704 |
+
""""""""""""""""
|
| 3705 |
+
|
| 3706 |
+
**Syntax**
|
| 3707 |
+
|
| 3708 |
+
.. code-block:: none
|
| 3709 |
+
|
| 3710 |
+
[p]set showsettings
|
| 3711 |
+
|
| 3712 |
+
**Description**
|
| 3713 |
+
|
| 3714 |
+
Show the current settings for Red.
|
| 3715 |
+
|
| 3716 |
+
.. _core-command-set-status:
|
| 3717 |
+
|
| 3718 |
+
""""""""""
|
| 3719 |
+
set status
|
| 3720 |
+
""""""""""
|
| 3721 |
+
|
| 3722 |
+
.. note:: |owner-lock|
|
| 3723 |
+
|
| 3724 |
+
**Syntax**
|
| 3725 |
+
|
| 3726 |
+
.. code-block:: none
|
| 3727 |
+
|
| 3728 |
+
[p]set status
|
| 3729 |
+
|
| 3730 |
+
**Description**
|
| 3731 |
+
|
| 3732 |
+
Commands for setting Red's status.
|
| 3733 |
+
|
| 3734 |
+
.. _core-command-set-status-competing:
|
| 3735 |
+
|
| 3736 |
+
""""""""""""""""""""
|
| 3737 |
+
set status competing
|
| 3738 |
+
""""""""""""""""""""
|
| 3739 |
+
|
| 3740 |
+
.. note:: |owner-lock|
|
| 3741 |
+
|
| 3742 |
+
**Syntax**
|
| 3743 |
+
|
| 3744 |
+
.. code-block:: none
|
| 3745 |
+
|
| 3746 |
+
[p]set status competing [competing]
|
| 3747 |
+
|
| 3748 |
+
**Description**
|
| 3749 |
+
|
| 3750 |
+
Sets Red's competing status.
|
| 3751 |
+
|
| 3752 |
+
This will appear as ``Competing in <competing>``.
|
| 3753 |
+
|
| 3754 |
+
Maximum length for a competing status is 128 characters.
|
| 3755 |
+
|
| 3756 |
+
**Examples:**
|
| 3757 |
+
- ``[p]set status competing`` - Clears the activity status.
|
| 3758 |
+
- ``[p]set status competing London 2012 Olympic Games``
|
| 3759 |
+
|
| 3760 |
+
**Arguments:**
|
| 3761 |
+
- ``[competing]`` - The text to follow ``Competing in``. Leave blank to clear the current activity status.
|
| 3762 |
+
|
| 3763 |
+
.. _core-command-set-status-dnd:
|
| 3764 |
+
|
| 3765 |
+
""""""""""""""
|
| 3766 |
+
set status dnd
|
| 3767 |
+
""""""""""""""
|
| 3768 |
+
|
| 3769 |
+
.. note:: |owner-lock|
|
| 3770 |
+
|
| 3771 |
+
**Syntax**
|
| 3772 |
+
|
| 3773 |
+
.. code-block:: none
|
| 3774 |
+
|
| 3775 |
+
[p]set status dnd
|
| 3776 |
+
|
| 3777 |
+
.. tip:: Aliases: ``set status donotdisturb``, ``set status busy``
|
| 3778 |
+
|
| 3779 |
+
**Description**
|
| 3780 |
+
|
| 3781 |
+
Sets Red's status to do not disturb.
|
| 3782 |
+
|
| 3783 |
+
.. _core-command-set-status-idle:
|
| 3784 |
+
|
| 3785 |
+
"""""""""""""""
|
| 3786 |
+
set status idle
|
| 3787 |
+
"""""""""""""""
|
| 3788 |
+
|
| 3789 |
+
.. note:: |owner-lock|
|
| 3790 |
+
|
| 3791 |
+
**Syntax**
|
| 3792 |
+
|
| 3793 |
+
.. code-block:: none
|
| 3794 |
+
|
| 3795 |
+
[p]set status idle
|
| 3796 |
+
|
| 3797 |
+
.. tip:: Aliases: ``set status away``, ``set status afk``
|
| 3798 |
+
|
| 3799 |
+
**Description**
|
| 3800 |
+
|
| 3801 |
+
Sets Red's status to idle.
|
| 3802 |
+
|
| 3803 |
+
.. _core-command-set-status-invisible:
|
| 3804 |
+
|
| 3805 |
+
""""""""""""""""""""
|
| 3806 |
+
set status invisible
|
| 3807 |
+
""""""""""""""""""""
|
| 3808 |
+
|
| 3809 |
+
.. note:: |owner-lock|
|
| 3810 |
+
|
| 3811 |
+
**Syntax**
|
| 3812 |
+
|
| 3813 |
+
.. code-block:: none
|
| 3814 |
+
|
| 3815 |
+
[p]set status invisible
|
| 3816 |
+
|
| 3817 |
+
.. tip:: Alias: ``set status offline``
|
| 3818 |
+
|
| 3819 |
+
**Description**
|
| 3820 |
+
|
| 3821 |
+
Sets Red's status to invisible.
|
| 3822 |
+
|
| 3823 |
+
.. _core-command-set-status-listening:
|
| 3824 |
+
|
| 3825 |
+
""""""""""""""""""""
|
| 3826 |
+
set status listening
|
| 3827 |
+
""""""""""""""""""""
|
| 3828 |
+
|
| 3829 |
+
.. note:: |owner-lock|
|
| 3830 |
+
|
| 3831 |
+
**Syntax**
|
| 3832 |
+
|
| 3833 |
+
.. code-block:: none
|
| 3834 |
+
|
| 3835 |
+
[p]set status listening [listening]
|
| 3836 |
+
|
| 3837 |
+
**Description**
|
| 3838 |
+
|
| 3839 |
+
Sets Red's listening status.
|
| 3840 |
+
|
| 3841 |
+
This will appear as ``Listening to <listening>``.
|
| 3842 |
+
|
| 3843 |
+
Maximum length for a listening status is 128 characters.
|
| 3844 |
+
|
| 3845 |
+
**Examples:**
|
| 3846 |
+
- ``[p]set status listening`` - Clears the activity status.
|
| 3847 |
+
- ``[p]set status listening jams``
|
| 3848 |
+
|
| 3849 |
+
**Arguments:**
|
| 3850 |
+
- ``[listening]`` - The text to follow ``Listening to``. Leave blank to clear the current activity status.
|
| 3851 |
+
|
| 3852 |
+
.. _core-command-set-status-online:
|
| 3853 |
+
|
| 3854 |
+
"""""""""""""""""
|
| 3855 |
+
set status online
|
| 3856 |
+
"""""""""""""""""
|
| 3857 |
+
|
| 3858 |
+
.. note:: |owner-lock|
|
| 3859 |
+
|
| 3860 |
+
**Syntax**
|
| 3861 |
+
|
| 3862 |
+
.. code-block:: none
|
| 3863 |
+
|
| 3864 |
+
[p]set status online
|
| 3865 |
+
|
| 3866 |
+
**Description**
|
| 3867 |
+
|
| 3868 |
+
Sets Red's status to online.
|
| 3869 |
+
|
| 3870 |
+
.. _core-command-set-status-playing:
|
| 3871 |
+
|
| 3872 |
+
""""""""""""""""""
|
| 3873 |
+
set status playing
|
| 3874 |
+
""""""""""""""""""
|
| 3875 |
+
|
| 3876 |
+
.. note:: |owner-lock|
|
| 3877 |
+
|
| 3878 |
+
**Syntax**
|
| 3879 |
+
|
| 3880 |
+
.. code-block:: none
|
| 3881 |
+
|
| 3882 |
+
[p]set status playing [game]
|
| 3883 |
+
|
| 3884 |
+
.. tip:: Alias: ``set status game``
|
| 3885 |
+
|
| 3886 |
+
**Description**
|
| 3887 |
+
|
| 3888 |
+
Sets Red's playing status.
|
| 3889 |
+
|
| 3890 |
+
This will appear as ``Playing <game>`` or ``PLAYING A GAME: <game>`` depending on the context.
|
| 3891 |
+
|
| 3892 |
+
Maximum length for a playing status is 128 characters.
|
| 3893 |
+
|
| 3894 |
+
**Examples:**
|
| 3895 |
+
- ``[p]set status playing`` - Clears the activity status.
|
| 3896 |
+
- ``[p]set status playing the keyboard``
|
| 3897 |
+
|
| 3898 |
+
**Arguments:**
|
| 3899 |
+
- ``[game]`` - The text to follow ``Playing``. Leave blank to clear the current activity status.
|
| 3900 |
+
|
| 3901 |
+
.. _core-command-set-status-streaming:
|
| 3902 |
+
|
| 3903 |
+
""""""""""""""""""""
|
| 3904 |
+
set status streaming
|
| 3905 |
+
""""""""""""""""""""
|
| 3906 |
+
|
| 3907 |
+
.. note:: |owner-lock|
|
| 3908 |
+
|
| 3909 |
+
**Syntax**
|
| 3910 |
+
|
| 3911 |
+
.. code-block:: none
|
| 3912 |
+
|
| 3913 |
+
[p]set status streaming [(<streamer> <stream_title>)]
|
| 3914 |
+
|
| 3915 |
+
.. tip:: Aliases: ``set status stream``, ``set status twitch``
|
| 3916 |
+
|
| 3917 |
+
**Description**
|
| 3918 |
+
|
| 3919 |
+
Sets Red's streaming status to a twitch stream.
|
| 3920 |
+
|
| 3921 |
+
This will appear as ``Streaming <stream_title>`` or ``LIVE ON TWITCH`` depending on the context.
|
| 3922 |
+
It will also include a ``Watch`` button with a twitch.tv url for the provided streamer.
|
| 3923 |
+
|
| 3924 |
+
Maximum length for a stream title is 128 characters.
|
| 3925 |
+
|
| 3926 |
+
Leaving both streamer and stream_title empty will clear it.
|
| 3927 |
+
|
| 3928 |
+
**Examples:**
|
| 3929 |
+
- ``[p]set status stream`` - Clears the activity status.
|
| 3930 |
+
- ``[p]set status stream 26 Twentysix is streaming`` - Sets the stream to ``https://www.twitch.tv/26``.
|
| 3931 |
+
- ``[p]set status stream https://twitch.tv/26 Twentysix is streaming`` - Sets the URL manually.
|
| 3932 |
+
|
| 3933 |
+
**Arguments:**
|
| 3934 |
+
- ``<streamer>`` - The twitch streamer to provide a link to. This can be their twitch name or the entire URL.
|
| 3935 |
+
- ``<stream_title>`` - The text to follow ``Streaming`` in the status.
|
| 3936 |
+
|
| 3937 |
+
.. _core-command-set-status-watching:
|
| 3938 |
+
|
| 3939 |
+
"""""""""""""""""""
|
| 3940 |
+
set status watching
|
| 3941 |
+
"""""""""""""""""""
|
| 3942 |
+
|
| 3943 |
+
.. note:: |owner-lock|
|
| 3944 |
+
|
| 3945 |
+
**Syntax**
|
| 3946 |
+
|
| 3947 |
+
.. code-block:: none
|
| 3948 |
+
|
| 3949 |
+
[p]set status watching [watching]
|
| 3950 |
+
|
| 3951 |
+
**Description**
|
| 3952 |
+
|
| 3953 |
+
Sets Red's watching status.
|
| 3954 |
+
|
| 3955 |
+
This will appear as ``Watching <watching>``.
|
| 3956 |
+
|
| 3957 |
+
Maximum length for a watching status is 128 characters.
|
| 3958 |
+
|
| 3959 |
+
**Examples:**
|
| 3960 |
+
- ``[p]set status watching`` - Clears the activity status.
|
| 3961 |
+
- ``[p]set status watching [p]help``
|
| 3962 |
+
|
| 3963 |
+
**Arguments:**
|
| 3964 |
+
- ``[watching]`` - The text to follow ``Watching``. Leave blank to clear the current activity status.
|
| 3965 |
+
|
| 3966 |
+
.. _core-command-set-usebotcolour:
|
| 3967 |
+
|
| 3968 |
+
""""""""""""""""
|
| 3969 |
+
set usebotcolour
|
| 3970 |
+
""""""""""""""""
|
| 3971 |
+
|
| 3972 |
+
.. note:: |guildowner-lock|
|
| 3973 |
+
|
| 3974 |
+
**Syntax**
|
| 3975 |
+
|
| 3976 |
+
.. code-block:: none
|
| 3977 |
+
|
| 3978 |
+
[p]set usebotcolour
|
| 3979 |
+
|
| 3980 |
+
.. tip:: Alias: ``set usebotcolor``
|
| 3981 |
+
|
| 3982 |
+
**Description**
|
| 3983 |
+
|
| 3984 |
+
Toggle whether to use the bot owner-configured colour for embeds.
|
| 3985 |
+
|
| 3986 |
+
Default is to use the bot's configured colour.
|
| 3987 |
+
Otherwise, the colour used will be the colour of the bot's top role.
|
| 3988 |
+
|
| 3989 |
+
**Example:**
|
| 3990 |
+
- ``[p]set usebotcolour``
|
| 3991 |
+
|
| 3992 |
+
.. _core-command-set-usebuttons:
|
| 3993 |
+
|
| 3994 |
+
""""""""""""""
|
| 3995 |
+
set usebuttons
|
| 3996 |
+
""""""""""""""
|
| 3997 |
+
|
| 3998 |
+
.. note:: |owner-lock|
|
| 3999 |
+
|
| 4000 |
+
**Syntax**
|
| 4001 |
+
|
| 4002 |
+
.. code-block:: none
|
| 4003 |
+
|
| 4004 |
+
[p]set usebuttons [use_buttons]
|
| 4005 |
+
|
| 4006 |
+
**Description**
|
| 4007 |
+
|
| 4008 |
+
Set a global bot variable for using buttons in menus. When enabled, all usage of
|
| 4009 |
+
cores menus API will use buttons instead of reactions. This defaults to False.
|
| 4010 |
+
Using this without a setting will toggle.
|
| 4011 |
+
|
| 4012 |
+
**Examples:**
|
| 4013 |
+
- ``[p]set usebuttons True`` - Enables using buttons.
|
| 4014 |
+
- ``[p]helpset usebuttons`` - Toggles the value.
|
| 4015 |
+
|
| 4016 |
+
**Arguments:**
|
| 4017 |
+
- ``[use_buttons]`` - Whether to use buttons. Leave blank to toggle.
|
| 4018 |
+
|
| 4019 |
+
.. _core-command-shutdown:
|
| 4020 |
+
|
| 4021 |
+
^^^^^^^^
|
| 4022 |
+
shutdown
|
| 4023 |
+
^^^^^^^^
|
| 4024 |
+
|
| 4025 |
+
.. note:: |owner-lock|
|
| 4026 |
+
|
| 4027 |
+
**Syntax**
|
| 4028 |
+
|
| 4029 |
+
.. code-block:: none
|
| 4030 |
+
|
| 4031 |
+
[p]shutdown [silently=False]
|
| 4032 |
+
|
| 4033 |
+
**Description**
|
| 4034 |
+
|
| 4035 |
+
Shuts down the bot.
|
| 4036 |
+
|
| 4037 |
+
Allows Red to shut down gracefully.
|
| 4038 |
+
|
| 4039 |
+
This is the recommended method for shutting down the bot.
|
| 4040 |
+
|
| 4041 |
+
**Examples:**
|
| 4042 |
+
- ``[p]shutdown``
|
| 4043 |
+
- ``[p]shutdown True`` - Shutdowns silently.
|
| 4044 |
+
|
| 4045 |
+
**Arguments:**
|
| 4046 |
+
- ``[silently]`` - Whether to skip sending the shutdown message. Defaults to False.
|
| 4047 |
+
|
| 4048 |
+
.. _core-command-slash:
|
| 4049 |
+
|
| 4050 |
+
^^^^^
|
| 4051 |
+
slash
|
| 4052 |
+
^^^^^
|
| 4053 |
+
|
| 4054 |
+
.. note:: |owner-lock|
|
| 4055 |
+
|
| 4056 |
+
**Syntax**
|
| 4057 |
+
|
| 4058 |
+
.. code-block:: none
|
| 4059 |
+
|
| 4060 |
+
[p]slash
|
| 4061 |
+
|
| 4062 |
+
**Description**
|
| 4063 |
+
|
| 4064 |
+
Base command for managing what application commands are able to be used on Red.
|
| 4065 |
+
|
| 4066 |
+
.. _core-command-slash-disable:
|
| 4067 |
+
|
| 4068 |
+
"""""""""""""
|
| 4069 |
+
slash disable
|
| 4070 |
+
"""""""""""""
|
| 4071 |
+
|
| 4072 |
+
**Syntax**
|
| 4073 |
+
|
| 4074 |
+
.. code-block:: none
|
| 4075 |
+
|
| 4076 |
+
[p]slash disable <command_name> [command_type]
|
| 4077 |
+
|
| 4078 |
+
**Description**
|
| 4079 |
+
|
| 4080 |
+
Marks an application command as being disabled, preventing it from being added to the bot.
|
| 4081 |
+
See commands available to disable with ``[p]slash list``. This command does NOT sync the
|
| 4082 |
+
enabled commands with Discord, that must be done manually with ``[p]slash sync`` for
|
| 4083 |
+
commands to appear in users' clients.
|
| 4084 |
+
|
| 4085 |
+
**Arguments:**
|
| 4086 |
+
- ``<command_name>`` - The command name to disable. Only the top level name of a group command should be used.
|
| 4087 |
+
- ``[command_type]`` - What type of application command to disable. Must be one of ``slash``, ``message``, or ``user``. Defaults to ``slash``.
|
| 4088 |
+
|
| 4089 |
+
.. _core-command-slash-disablecog:
|
| 4090 |
+
|
| 4091 |
+
""""""""""""""""
|
| 4092 |
+
slash disablecog
|
| 4093 |
+
""""""""""""""""
|
| 4094 |
+
|
| 4095 |
+
**Syntax**
|
| 4096 |
+
|
| 4097 |
+
.. code-block:: none
|
| 4098 |
+
|
| 4099 |
+
[p]slash disablecog <cog_name>
|
| 4100 |
+
|
| 4101 |
+
**Description**
|
| 4102 |
+
|
| 4103 |
+
Marks all application commands in a cog as being disabled, preventing them from being
|
| 4104 |
+
added to the bot. See a list of cogs with application commands with ``[p]slash list``.
|
| 4105 |
+
This command does NOT sync the enabled commands with Discord, that must be done manually
|
| 4106 |
+
with ``[p]slash sync`` for commands to appear in users' clients.
|
| 4107 |
+
|
| 4108 |
+
**Arguments:**
|
| 4109 |
+
- ``<cog_name>`` - The cog to disable commands from. This argument is case sensitive.
|
| 4110 |
+
|
| 4111 |
+
.. _core-command-slash-enable:
|
| 4112 |
+
|
| 4113 |
+
""""""""""""
|
| 4114 |
+
slash enable
|
| 4115 |
+
""""""""""""
|
| 4116 |
+
|
| 4117 |
+
**Syntax**
|
| 4118 |
+
|
| 4119 |
+
.. code-block:: none
|
| 4120 |
+
|
| 4121 |
+
[p]slash enable <command_name> [command_type]
|
| 4122 |
+
|
| 4123 |
+
**Description**
|
| 4124 |
+
|
| 4125 |
+
Marks an application command as being enabled, allowing it to be added to the bot.
|
| 4126 |
+
See commands available to enable with ``[p]slash list``. This command does NOT sync the
|
| 4127 |
+
enabled commands with Discord, that must be done manually with ``[p]slash sync`` for
|
| 4128 |
+
commands to appear in users' clients.
|
| 4129 |
+
|
| 4130 |
+
**Arguments:**
|
| 4131 |
+
- ``<command_name>`` - The command name to enable. Only the top level name of a group command should be used.
|
| 4132 |
+
- ``[command_type]`` - What type of application command to enable. Must be one of ``slash``, ``message``, or ``user``. Defaults to ``slash``.
|
| 4133 |
+
|
| 4134 |
+
.. _core-command-slash-enablecog:
|
| 4135 |
+
|
| 4136 |
+
"""""""""""""""
|
| 4137 |
+
slash enablecog
|
| 4138 |
+
"""""""""""""""
|
| 4139 |
+
|
| 4140 |
+
**Syntax**
|
| 4141 |
+
|
| 4142 |
+
.. code-block:: none
|
| 4143 |
+
|
| 4144 |
+
[p]slash enablecog <cog_name>
|
| 4145 |
+
|
| 4146 |
+
**Description**
|
| 4147 |
+
|
| 4148 |
+
Marks all application commands in a cog as being enabled, allowing them to be
|
| 4149 |
+
added to the bot. See a list of cogs with application commands with ``[p]slash list``.
|
| 4150 |
+
This command does NOT sync the enabled commands with Discord, that must be done manually
|
| 4151 |
+
with ``[p]slash sync`` for commands to appear in users' clients.
|
| 4152 |
+
|
| 4153 |
+
**Arguments:**
|
| 4154 |
+
- ``<cog_name>`` - The cog to enable commands from. This argument is case sensitive.
|
| 4155 |
+
|
| 4156 |
+
.. _core-command-slash-list:
|
| 4157 |
+
|
| 4158 |
+
""""""""""
|
| 4159 |
+
slash list
|
| 4160 |
+
""""""""""
|
| 4161 |
+
|
| 4162 |
+
**Syntax**
|
| 4163 |
+
|
| 4164 |
+
.. code-block:: none
|
| 4165 |
+
|
| 4166 |
+
[p]slash list
|
| 4167 |
+
|
| 4168 |
+
**Description**
|
| 4169 |
+
|
| 4170 |
+
List the slash commands the bot can see, and whether or not they are enabled.
|
| 4171 |
+
|
| 4172 |
+
This command shows the state that will be changed to when ``[p]slash sync`` is run.
|
| 4173 |
+
Commands from the same cog are grouped, with the cog name as the header.
|
| 4174 |
+
|
| 4175 |
+
The prefix denotes the state of the command:
|
| 4176 |
+
- Commands starting with ``- `` have not yet been enabled.
|
| 4177 |
+
- Commands starting with ``+ `` have been manually enabled.
|
| 4178 |
+
- Commands starting with ``++`` have been enabled by the cog author, and cannot be disabled.
|
| 4179 |
+
|
| 4180 |
+
.. _core-command-slash-sync:
|
| 4181 |
+
|
| 4182 |
+
""""""""""
|
| 4183 |
+
slash sync
|
| 4184 |
+
""""""""""
|
| 4185 |
+
|
| 4186 |
+
**Syntax**
|
| 4187 |
+
|
| 4188 |
+
.. code-block:: none
|
| 4189 |
+
|
| 4190 |
+
[p]slash sync [guild]
|
| 4191 |
+
|
| 4192 |
+
**Description**
|
| 4193 |
+
|
| 4194 |
+
Syncs the slash settings to discord.
|
| 4195 |
+
Settings from ``[p]slash list`` will be synced with discord, changing what commands appear for users.
|
| 4196 |
+
This should be run sparingly, make all necessary changes before running this command.
|
| 4197 |
+
|
| 4198 |
+
**Arguments:**
|
| 4199 |
+
- ``[guild]`` - If provided, syncs commands for that guild. Otherwise, syncs global commands.
|
| 4200 |
+
|
| 4201 |
+
.. _core-command-traceback:
|
| 4202 |
+
|
| 4203 |
+
^^^^^^^^^
|
| 4204 |
+
traceback
|
| 4205 |
+
^^^^^^^^^
|
| 4206 |
+
|
| 4207 |
+
.. note:: |owner-lock|
|
| 4208 |
+
|
| 4209 |
+
**Syntax**
|
| 4210 |
+
|
| 4211 |
+
.. code-block:: none
|
| 4212 |
+
|
| 4213 |
+
[p]traceback [public=False]
|
| 4214 |
+
|
| 4215 |
+
**Description**
|
| 4216 |
+
|
| 4217 |
+
Sends to the owner the last command exception that has occurred.
|
| 4218 |
+
|
| 4219 |
+
If public (yes is specified), it will be sent to the chat instead.
|
| 4220 |
+
|
| 4221 |
+
.. Warning:: Sending the traceback publicly can accidentally reveal sensitive information about your computer or configuration.
|
| 4222 |
+
|
| 4223 |
+
|
| 4224 |
+
**Examples:**
|
| 4225 |
+
- ``[p]traceback`` - Sends the traceback to your DMs.
|
| 4226 |
+
- ``[p]traceback True`` - Sends the last traceback in the current context.
|
| 4227 |
+
|
| 4228 |
+
**Arguments:**
|
| 4229 |
+
- ``[public]`` - Whether to send the traceback to the current context. Leave blank to send to your DMs.
|
| 4230 |
+
|
| 4231 |
+
.. _core-command-unignore:
|
| 4232 |
+
|
| 4233 |
+
^^^^^^^^
|
| 4234 |
+
unignore
|
| 4235 |
+
^^^^^^^^
|
| 4236 |
+
|
| 4237 |
+
.. note:: |admin-lock|
|
| 4238 |
+
|
| 4239 |
+
**Syntax**
|
| 4240 |
+
|
| 4241 |
+
.. code-block:: none
|
| 4242 |
+
|
| 4243 |
+
[p]unignore
|
| 4244 |
+
|
| 4245 |
+
**Description**
|
| 4246 |
+
|
| 4247 |
+
Commands to remove servers or channels from the ignore list.
|
| 4248 |
+
|
| 4249 |
+
.. _core-command-unignore-channel:
|
| 4250 |
+
|
| 4251 |
+
""""""""""""""""
|
| 4252 |
+
unignore channel
|
| 4253 |
+
""""""""""""""""
|
| 4254 |
+
|
| 4255 |
+
**Syntax**
|
| 4256 |
+
|
| 4257 |
+
.. code-block:: none
|
| 4258 |
+
|
| 4259 |
+
[p]unignore channel [channel]
|
| 4260 |
+
|
| 4261 |
+
**Description**
|
| 4262 |
+
|
| 4263 |
+
Remove a channel, thread, or category from the ignore list.
|
| 4264 |
+
|
| 4265 |
+
Defaults to the current thread or channel.
|
| 4266 |
+
|
| 4267 |
+
**Examples:**
|
| 4268 |
+
- ``[p]unignore channel #general`` - Unignores commands in the #general channel.
|
| 4269 |
+
- ``[p]unignore channel`` - Unignores commands in the current channel.
|
| 4270 |
+
- ``[p]unignore channel "General Channels"`` - Use quotes for categories with spaces.
|
| 4271 |
+
- ``[p]unignore channel 356236713347252226`` - Also accepts IDs. Use this method to unignore categories.
|
| 4272 |
+
|
| 4273 |
+
**Arguments:**
|
| 4274 |
+
- ``<channel>`` - The channel to unignore. This can also be a thread or category channel.
|
| 4275 |
+
|
| 4276 |
+
.. _core-command-unignore-server:
|
| 4277 |
+
|
| 4278 |
+
"""""""""""""""
|
| 4279 |
+
unignore server
|
| 4280 |
+
"""""""""""""""
|
| 4281 |
+
|
| 4282 |
+
.. note:: |admin-lock|
|
| 4283 |
+
|
| 4284 |
+
**Syntax**
|
| 4285 |
+
|
| 4286 |
+
.. code-block:: none
|
| 4287 |
+
|
| 4288 |
+
[p]unignore server
|
| 4289 |
+
|
| 4290 |
+
.. tip:: Alias: ``unignore guild``
|
| 4291 |
+
|
| 4292 |
+
**Description**
|
| 4293 |
+
|
| 4294 |
+
Remove this server from the ignore list.
|
| 4295 |
+
|
| 4296 |
+
**Example:**
|
| 4297 |
+
- ``[p]unignore server`` - Stops ignoring the current server
|
| 4298 |
+
|
| 4299 |
+
.. _core-command-unload:
|
| 4300 |
+
|
| 4301 |
+
^^^^^^
|
| 4302 |
+
unload
|
| 4303 |
+
^^^^^^
|
| 4304 |
+
|
| 4305 |
+
.. note:: |owner-lock|
|
| 4306 |
+
|
| 4307 |
+
**Syntax**
|
| 4308 |
+
|
| 4309 |
+
.. code-block:: none
|
| 4310 |
+
|
| 4311 |
+
[p]unload <cogs...>
|
| 4312 |
+
|
| 4313 |
+
**Description**
|
| 4314 |
+
|
| 4315 |
+
Unloads previously loaded cog packages.
|
| 4316 |
+
|
| 4317 |
+
See packages available to unload with ``[p]cogs``.
|
| 4318 |
+
|
| 4319 |
+
**Examples:**
|
| 4320 |
+
- ``[p]unload general`` - Unloads the ``general`` cog.
|
| 4321 |
+
- ``[p]unload admin mod mutes`` - Unloads multiple cogs.
|
| 4322 |
+
|
| 4323 |
+
**Arguments:**
|
| 4324 |
+
- ``<cogs...>`` - The cog packages to unload.
|
| 4325 |
+
|
| 4326 |
+
.. _core-command-uptime:
|
| 4327 |
+
|
| 4328 |
+
^^^^^^
|
| 4329 |
+
uptime
|
| 4330 |
+
^^^^^^
|
| 4331 |
+
|
| 4332 |
+
**Syntax**
|
| 4333 |
+
|
| 4334 |
+
.. code-block:: none
|
| 4335 |
+
|
| 4336 |
+
[p]uptime
|
| 4337 |
+
|
| 4338 |
+
**Description**
|
| 4339 |
+
|
| 4340 |
+
Shows Red's uptime.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/customcommands.rst
ADDED
|
@@ -0,0 +1,294 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _customcommands:
|
| 2 |
+
|
| 3 |
+
==============
|
| 4 |
+
CustomCommands
|
| 5 |
+
==============
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the customcommands cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load customcom
|
| 15 |
+
|
| 16 |
+
.. _customcommands-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog contains commands for creating and managing custom commands that display text.
|
| 23 |
+
|
| 24 |
+
These are useful for storing information members might need, like FAQ answers or invite links.
|
| 25 |
+
Custom commands can be used by anyone by default, so be careful with pings.
|
| 26 |
+
Commands can only be lowercase, and will not respond to any uppercase letters.
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
.. _customcommands-commands:
|
| 30 |
+
|
| 31 |
+
--------
|
| 32 |
+
Commands
|
| 33 |
+
--------
|
| 34 |
+
|
| 35 |
+
.. _customcommands-command-customcom:
|
| 36 |
+
|
| 37 |
+
^^^^^^^^^
|
| 38 |
+
customcom
|
| 39 |
+
^^^^^^^^^
|
| 40 |
+
|
| 41 |
+
**Syntax**
|
| 42 |
+
|
| 43 |
+
.. code-block:: none
|
| 44 |
+
|
| 45 |
+
[p]customcom
|
| 46 |
+
|
| 47 |
+
.. tip:: Alias: ``cc``
|
| 48 |
+
|
| 49 |
+
**Description**
|
| 50 |
+
|
| 51 |
+
Base command for Custom Commands management.
|
| 52 |
+
|
| 53 |
+
.. _customcommands-command-customcom-cooldown:
|
| 54 |
+
|
| 55 |
+
""""""""""""""""""
|
| 56 |
+
customcom cooldown
|
| 57 |
+
""""""""""""""""""
|
| 58 |
+
|
| 59 |
+
.. note:: |mod-lock|
|
| 60 |
+
|
| 61 |
+
**Syntax**
|
| 62 |
+
|
| 63 |
+
.. code-block:: none
|
| 64 |
+
|
| 65 |
+
[p]customcom cooldown <command> [cooldown] [per=member]
|
| 66 |
+
|
| 67 |
+
**Description**
|
| 68 |
+
|
| 69 |
+
Set, edit, or view the cooldown for a custom command.
|
| 70 |
+
|
| 71 |
+
You may set cooldowns per member, thread/channel, or guild. Multiple
|
| 72 |
+
cooldowns may be set. All cooldowns must be cooled to call the
|
| 73 |
+
custom command.
|
| 74 |
+
|
| 75 |
+
Examples:
|
| 76 |
+
- ``[p]customcom cooldown pingrole``
|
| 77 |
+
- ``[p]customcom cooldown yourcommand 30``
|
| 78 |
+
- ``[p]cc cooldown mycommand 30 guild``
|
| 79 |
+
|
| 80 |
+
**Arguments:**
|
| 81 |
+
|
| 82 |
+
- ``<command>`` The custom command to check or set the cooldown.
|
| 83 |
+
- ``[cooldown]`` The number of seconds to wait before allowing the command to be invoked again. If omitted, will instead return the current cooldown settings.
|
| 84 |
+
- ``[per]`` The group to apply the cooldown on. Defaults to per member. Valid choices are server / guild, user / member, and channel.
|
| 85 |
+
|
| 86 |
+
.. _customcommands-command-customcom-create:
|
| 87 |
+
|
| 88 |
+
""""""""""""""""
|
| 89 |
+
customcom create
|
| 90 |
+
""""""""""""""""
|
| 91 |
+
|
| 92 |
+
.. note:: |mod-lock|
|
| 93 |
+
|
| 94 |
+
**Syntax**
|
| 95 |
+
|
| 96 |
+
.. code-block:: none
|
| 97 |
+
|
| 98 |
+
[p]customcom create <command> <text>
|
| 99 |
+
|
| 100 |
+
.. tip:: Alias: ``customcom add``
|
| 101 |
+
|
| 102 |
+
**Description**
|
| 103 |
+
|
| 104 |
+
Create custom commands.
|
| 105 |
+
|
| 106 |
+
If a type is not specified, a simple CC will be created.
|
| 107 |
+
CCs can be enhanced with arguments, see the guide
|
| 108 |
+
:ref:`here <cog_customcom>`.
|
| 109 |
+
|
| 110 |
+
.. _customcommands-command-customcom-create-random:
|
| 111 |
+
|
| 112 |
+
"""""""""""""""""""""""
|
| 113 |
+
customcom create random
|
| 114 |
+
"""""""""""""""""""""""
|
| 115 |
+
|
| 116 |
+
.. note:: |mod-lock|
|
| 117 |
+
|
| 118 |
+
**Syntax**
|
| 119 |
+
|
| 120 |
+
.. code-block:: none
|
| 121 |
+
|
| 122 |
+
[p]customcom create random <command>
|
| 123 |
+
|
| 124 |
+
**Description**
|
| 125 |
+
|
| 126 |
+
Create a CC where it will randomly choose a response!
|
| 127 |
+
|
| 128 |
+
Note: This command is interactive.
|
| 129 |
+
|
| 130 |
+
**Arguments:**
|
| 131 |
+
|
| 132 |
+
- ``<command>`` The command executed to return the text. Cast to lowercase.
|
| 133 |
+
|
| 134 |
+
.. _customcommands-command-customcom-create-simple:
|
| 135 |
+
|
| 136 |
+
"""""""""""""""""""""""
|
| 137 |
+
customcom create simple
|
| 138 |
+
"""""""""""""""""""""""
|
| 139 |
+
|
| 140 |
+
.. note:: |mod-lock|
|
| 141 |
+
|
| 142 |
+
**Syntax**
|
| 143 |
+
|
| 144 |
+
.. code-block:: none
|
| 145 |
+
|
| 146 |
+
[p]customcom create simple <command> <text>
|
| 147 |
+
|
| 148 |
+
**Description**
|
| 149 |
+
|
| 150 |
+
Add a simple custom command.
|
| 151 |
+
|
| 152 |
+
Example:
|
| 153 |
+
- ``[p]customcom create simple yourcommand Text you want``
|
| 154 |
+
|
| 155 |
+
**Arguments:**
|
| 156 |
+
|
| 157 |
+
- ``<command>`` The command executed to return the text. Cast to lowercase.
|
| 158 |
+
- ``<text>`` The text to return when executing the command. See guide for enhanced usage.
|
| 159 |
+
|
| 160 |
+
.. _customcommands-command-customcom-delete:
|
| 161 |
+
|
| 162 |
+
""""""""""""""""
|
| 163 |
+
customcom delete
|
| 164 |
+
""""""""""""""""
|
| 165 |
+
|
| 166 |
+
.. note:: |mod-lock|
|
| 167 |
+
|
| 168 |
+
**Syntax**
|
| 169 |
+
|
| 170 |
+
.. code-block:: none
|
| 171 |
+
|
| 172 |
+
[p]customcom delete <command>
|
| 173 |
+
|
| 174 |
+
.. tip:: Aliases: ``customcom del``, ``customcom remove``
|
| 175 |
+
|
| 176 |
+
**Description**
|
| 177 |
+
|
| 178 |
+
Delete a custom command.
|
| 179 |
+
|
| 180 |
+
Example:
|
| 181 |
+
- ``[p]customcom delete yourcommand``
|
| 182 |
+
|
| 183 |
+
**Arguments:**
|
| 184 |
+
|
| 185 |
+
- ``<command>`` The custom command to delete.
|
| 186 |
+
|
| 187 |
+
.. _customcommands-command-customcom-edit:
|
| 188 |
+
|
| 189 |
+
""""""""""""""
|
| 190 |
+
customcom edit
|
| 191 |
+
""""""""""""""
|
| 192 |
+
|
| 193 |
+
.. note:: |mod-lock|
|
| 194 |
+
|
| 195 |
+
**Syntax**
|
| 196 |
+
|
| 197 |
+
.. code-block:: none
|
| 198 |
+
|
| 199 |
+
[p]customcom edit <command> [text]
|
| 200 |
+
|
| 201 |
+
**Description**
|
| 202 |
+
|
| 203 |
+
Edit a custom command.
|
| 204 |
+
|
| 205 |
+
Example:
|
| 206 |
+
- ``[p]customcom edit yourcommand Text you want``
|
| 207 |
+
|
| 208 |
+
**Arguments:**
|
| 209 |
+
|
| 210 |
+
- ``<command>`` The custom command to edit.
|
| 211 |
+
- ``<text>`` The new text to return when executing the command.
|
| 212 |
+
|
| 213 |
+
.. _customcommands-command-customcom-list:
|
| 214 |
+
|
| 215 |
+
""""""""""""""
|
| 216 |
+
customcom list
|
| 217 |
+
""""""""""""""
|
| 218 |
+
|
| 219 |
+
**Syntax**
|
| 220 |
+
|
| 221 |
+
.. code-block:: none
|
| 222 |
+
|
| 223 |
+
[p]customcom list
|
| 224 |
+
|
| 225 |
+
**Description**
|
| 226 |
+
|
| 227 |
+
List all available custom commands.
|
| 228 |
+
|
| 229 |
+
The list displays a preview of each command's response, with
|
| 230 |
+
markdown escaped and newlines replaced with spaces.
|
| 231 |
+
|
| 232 |
+
.. _customcommands-command-customcom-raw:
|
| 233 |
+
|
| 234 |
+
"""""""""""""
|
| 235 |
+
customcom raw
|
| 236 |
+
"""""""""""""
|
| 237 |
+
|
| 238 |
+
**Syntax**
|
| 239 |
+
|
| 240 |
+
.. code-block:: none
|
| 241 |
+
|
| 242 |
+
[p]customcom raw <command>
|
| 243 |
+
|
| 244 |
+
**Description**
|
| 245 |
+
|
| 246 |
+
Get the raw response of a custom command, to get the proper markdown.
|
| 247 |
+
|
| 248 |
+
This is helpful for copy and pasting.
|
| 249 |
+
|
| 250 |
+
**Arguments:**
|
| 251 |
+
|
| 252 |
+
- ``<command>`` The custom command to get the raw response of.
|
| 253 |
+
|
| 254 |
+
.. _customcommands-command-customcom-search:
|
| 255 |
+
|
| 256 |
+
""""""""""""""""
|
| 257 |
+
customcom search
|
| 258 |
+
""""""""""""""""
|
| 259 |
+
|
| 260 |
+
**Syntax**
|
| 261 |
+
|
| 262 |
+
.. code-block:: none
|
| 263 |
+
|
| 264 |
+
[p]customcom search <query>
|
| 265 |
+
|
| 266 |
+
**Description**
|
| 267 |
+
|
| 268 |
+
Searches through custom commands, according to the query.
|
| 269 |
+
|
| 270 |
+
Uses fuzzy searching to find close matches.
|
| 271 |
+
|
| 272 |
+
**Arguments:**
|
| 273 |
+
|
| 274 |
+
- ``<query>`` The query to search for. Can be multiple words.
|
| 275 |
+
|
| 276 |
+
.. _customcommands-command-customcom-show:
|
| 277 |
+
|
| 278 |
+
""""""""""""""
|
| 279 |
+
customcom show
|
| 280 |
+
""""""""""""""
|
| 281 |
+
|
| 282 |
+
**Syntax**
|
| 283 |
+
|
| 284 |
+
.. code-block:: none
|
| 285 |
+
|
| 286 |
+
[p]customcom show <command_name>
|
| 287 |
+
|
| 288 |
+
**Description**
|
| 289 |
+
|
| 290 |
+
Shows a custom command's responses and its settings.
|
| 291 |
+
|
| 292 |
+
**Arguments:**
|
| 293 |
+
|
| 294 |
+
- ``<command_name>`` The custom command to show.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/dev.rst
ADDED
|
@@ -0,0 +1,254 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _dev:
|
| 2 |
+
|
| 3 |
+
===
|
| 4 |
+
Dev
|
| 5 |
+
===
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the dev cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load dev
|
| 15 |
+
|
| 16 |
+
.. _dev-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Various development focused utilities. All commands in this cog are
|
| 23 |
+
restricted to the bot owners.
|
| 24 |
+
|
| 25 |
+
.. note::
|
| 26 |
+
|
| 27 |
+
Unlike other cogs, the Dev cog is only loaded if the bot is
|
| 28 |
+
started with the ``--dev`` flag.
|
| 29 |
+
|
| 30 |
+
.. warning::
|
| 31 |
+
|
| 32 |
+
It is not suggested that you run Dev in production. Many
|
| 33 |
+
of these cog's commands may cause down-the-line complications if
|
| 34 |
+
not used appropriately.
|
| 35 |
+
|
| 36 |
+
.. _dev-commands:
|
| 37 |
+
|
| 38 |
+
--------
|
| 39 |
+
Commands
|
| 40 |
+
--------
|
| 41 |
+
|
| 42 |
+
.. _dev-command-bypasscooldowns:
|
| 43 |
+
|
| 44 |
+
^^^^^^^^^^^^^^^
|
| 45 |
+
bypasscooldowns
|
| 46 |
+
^^^^^^^^^^^^^^^
|
| 47 |
+
|
| 48 |
+
**Syntax**
|
| 49 |
+
|
| 50 |
+
.. code-block:: none
|
| 51 |
+
|
| 52 |
+
[p]bypasscooldowns [toggle]
|
| 53 |
+
|
| 54 |
+
**Description**
|
| 55 |
+
|
| 56 |
+
Give bot owners the ability to bypass cooldowns. Note that this bypass
|
| 57 |
+
does not persist through restarts/shutdowns.
|
| 58 |
+
|
| 59 |
+
**Arguments**
|
| 60 |
+
|
| 61 |
+
* ``[toggle]``: |bool-input| Otherwise, defaults to the inverse of the current setting.
|
| 62 |
+
|
| 63 |
+
.. _dev-command-debug:
|
| 64 |
+
|
| 65 |
+
^^^^^
|
| 66 |
+
debug
|
| 67 |
+
^^^^^
|
| 68 |
+
|
| 69 |
+
**Syntax**
|
| 70 |
+
|
| 71 |
+
.. code-block:: none
|
| 72 |
+
|
| 73 |
+
[p]debug <code>
|
| 74 |
+
|
| 75 |
+
**Description**
|
| 76 |
+
|
| 77 |
+
Evaluate a statement of python code.
|
| 78 |
+
|
| 79 |
+
The bot will always respond with the return value of the code.
|
| 80 |
+
If the return value of the code is a coroutine, it will be awaited,
|
| 81 |
+
and the result of that will be the bot's response.
|
| 82 |
+
|
| 83 |
+
Note: Only one statement may be evaluated. Using certain restricted
|
| 84 |
+
keywords, e.g. yield, will result in a syntax error. For multiple
|
| 85 |
+
lines or asynchronous code, see [p]repl or [p]eval.
|
| 86 |
+
|
| 87 |
+
**Environment Variables**
|
| 88 |
+
|
| 89 |
+
* ``ctx``: Command invocation context
|
| 90 |
+
* ``bot``: The bot object
|
| 91 |
+
* ``channel``: The current channel object
|
| 92 |
+
* ``author``: The current author's member object
|
| 93 |
+
* ``guild``: The current guild object
|
| 94 |
+
* ``message``: The command's message object
|
| 95 |
+
* ``aiohttp``: The aiohttp library
|
| 96 |
+
* ``asyncio``: The asyncio library
|
| 97 |
+
* ``discord``: The discord.py library
|
| 98 |
+
* ``commands``: The redbot.core.commands module
|
| 99 |
+
* ``cf``: The redbot.core.utils.chat_formatting module
|
| 100 |
+
* ``_``: The result from the last dev command
|
| 101 |
+
|
| 102 |
+
**Arguments**
|
| 103 |
+
|
| 104 |
+
* ``<code>``: The statement to run.
|
| 105 |
+
|
| 106 |
+
.. _dev-command-eval:
|
| 107 |
+
|
| 108 |
+
^^^^
|
| 109 |
+
eval
|
| 110 |
+
^^^^
|
| 111 |
+
|
| 112 |
+
**Syntax**
|
| 113 |
+
|
| 114 |
+
.. code-block:: none
|
| 115 |
+
|
| 116 |
+
[p]eval <body>
|
| 117 |
+
|
| 118 |
+
**Description**
|
| 119 |
+
|
| 120 |
+
Execute asynchronous code.
|
| 121 |
+
|
| 122 |
+
This command wraps code into the body of an async function and then
|
| 123 |
+
calls and awaits it. The bot will respond with anything printed to
|
| 124 |
+
stdout, as well as the return value of the function.
|
| 125 |
+
|
| 126 |
+
The code can be within a codeblock, inline code or neither, as long
|
| 127 |
+
as they are not mixed and they are formatted correctly.
|
| 128 |
+
|
| 129 |
+
**Environment Variables**
|
| 130 |
+
|
| 131 |
+
* ``ctx``: Command invocation context
|
| 132 |
+
* ``bot``: The bot object
|
| 133 |
+
* ``channel``: The current channel object
|
| 134 |
+
* ``author``: The current author's member object
|
| 135 |
+
* ``guild``: The current guild object
|
| 136 |
+
* ``message``: The command's message object
|
| 137 |
+
* ``aiohttp``: The aiohttp library
|
| 138 |
+
* ``asyncio``: The asyncio library
|
| 139 |
+
* ``discord``: The discord.py library
|
| 140 |
+
* ``commands``: The redbot.core.commands module
|
| 141 |
+
* ``cf``: The redbot.core.utils.chat_formatting module
|
| 142 |
+
* ``_``: The result from the last dev command
|
| 143 |
+
|
| 144 |
+
**Arguments**
|
| 145 |
+
|
| 146 |
+
* ``<body>``: The code to evaluate.
|
| 147 |
+
|
| 148 |
+
.. _dev-command-mock:
|
| 149 |
+
|
| 150 |
+
^^^^
|
| 151 |
+
mock
|
| 152 |
+
^^^^
|
| 153 |
+
|
| 154 |
+
**Syntax**
|
| 155 |
+
|
| 156 |
+
.. code-block:: none
|
| 157 |
+
|
| 158 |
+
[p]mock <user> <command>
|
| 159 |
+
|
| 160 |
+
**Description**
|
| 161 |
+
|
| 162 |
+
Mock another user invoking a command. The prefix must not be entered.
|
| 163 |
+
|
| 164 |
+
**Arguments**
|
| 165 |
+
|
| 166 |
+
* ``<user>``: The user to mock. |user-input-quotes|
|
| 167 |
+
* ``<command>``: The command to invoke.
|
| 168 |
+
|
| 169 |
+
.. _dev-command-mockmsg:
|
| 170 |
+
|
| 171 |
+
^^^^^^^
|
| 172 |
+
mockmsg
|
| 173 |
+
^^^^^^^
|
| 174 |
+
|
| 175 |
+
**Syntax**
|
| 176 |
+
|
| 177 |
+
.. code-block:: none
|
| 178 |
+
|
| 179 |
+
[p]mockmsg <user> <content>
|
| 180 |
+
|
| 181 |
+
**Description**
|
| 182 |
+
|
| 183 |
+
Dispatch a message event as if it were sent by a different user.
|
| 184 |
+
|
| 185 |
+
Current message is used as a base (including attachments, embeds, etc.),
|
| 186 |
+
the content and author of the message are replaced with the given arguments.
|
| 187 |
+
|
| 188 |
+
**Arguments**
|
| 189 |
+
|
| 190 |
+
* ``<user>``: The member to mock. |user-input-quotes|
|
| 191 |
+
* ``<content>``: The content used for the message.
|
| 192 |
+
|
| 193 |
+
.. note::
|
| 194 |
+
|
| 195 |
+
If ``content`` isn't passed, the message needs to contain embeds, attachments,
|
| 196 |
+
or anything else that makes the message non-empty.
|
| 197 |
+
|
| 198 |
+
.. _dev-command-repl:
|
| 199 |
+
|
| 200 |
+
^^^^
|
| 201 |
+
repl
|
| 202 |
+
^^^^
|
| 203 |
+
|
| 204 |
+
**Syntax**
|
| 205 |
+
|
| 206 |
+
.. code-block:: none
|
| 207 |
+
|
| 208 |
+
[p]repl
|
| 209 |
+
|
| 210 |
+
**Description**
|
| 211 |
+
|
| 212 |
+
Open an interactive REPL.
|
| 213 |
+
|
| 214 |
+
The REPL will only recognise code as messages which start with a
|
| 215 |
+
backtick. This includes codeblocks, and as such multiple lines can be
|
| 216 |
+
evaluated.
|
| 217 |
+
|
| 218 |
+
Use ``exit()`` or ``quit`` to exit the REPL session, prefixed with
|
| 219 |
+
a backtick so they may be interpreted.
|
| 220 |
+
|
| 221 |
+
**Environment Variables**
|
| 222 |
+
|
| 223 |
+
* ``ctx``: Command invocation context
|
| 224 |
+
* ``bot``: The bot object
|
| 225 |
+
* ``channel``: The current channel object
|
| 226 |
+
* ``author``: The current author's member object
|
| 227 |
+
* ``guild``: The current guild object
|
| 228 |
+
* ``message``: The command's message object
|
| 229 |
+
* ``aiohttp``: The aiohttp library
|
| 230 |
+
* ``asyncio``: The asyncio library
|
| 231 |
+
* ``discord``: The discord.py library
|
| 232 |
+
* ``commands``: The redbot.core.commands module
|
| 233 |
+
* ``cf``: The redbot.core.utils.chat_formatting module
|
| 234 |
+
* ``_``: The result from the last dev command
|
| 235 |
+
|
| 236 |
+
.. _dev-command-repl-pause:
|
| 237 |
+
|
| 238 |
+
""""""""""
|
| 239 |
+
repl pause
|
| 240 |
+
""""""""""
|
| 241 |
+
|
| 242 |
+
**Syntax**
|
| 243 |
+
|
| 244 |
+
.. code-block:: none
|
| 245 |
+
|
| 246 |
+
[p]repl pause [toggle]
|
| 247 |
+
|
| 248 |
+
**Description**
|
| 249 |
+
|
| 250 |
+
Pauses/resumes the REPL running in the current channel.
|
| 251 |
+
|
| 252 |
+
**Arguments**
|
| 253 |
+
|
| 254 |
+
* ``[toggle]``: |bool-input| Otherwise, defaults to the inverse of the current setting.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/downloader.rst
ADDED
|
@@ -0,0 +1,538 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _downloader:
|
| 2 |
+
|
| 3 |
+
==========
|
| 4 |
+
Downloader
|
| 5 |
+
==========
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the downloader cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load downloader
|
| 15 |
+
|
| 16 |
+
.. _downloader-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Install community cogs made by Cog Creators.
|
| 23 |
+
|
| 24 |
+
Community cogs, also called third party cogs, are not included
|
| 25 |
+
in the default Red install.
|
| 26 |
+
|
| 27 |
+
Community cogs come in repositories. Repos are a group of cogs
|
| 28 |
+
you can install. You always need to add the creator's repository
|
| 29 |
+
using the ``[p]repo`` command before you can install one or more
|
| 30 |
+
cogs from the creator.
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
.. _downloader-commands:
|
| 34 |
+
|
| 35 |
+
--------
|
| 36 |
+
Commands
|
| 37 |
+
--------
|
| 38 |
+
|
| 39 |
+
.. _downloader-command-cog:
|
| 40 |
+
|
| 41 |
+
^^^
|
| 42 |
+
cog
|
| 43 |
+
^^^
|
| 44 |
+
|
| 45 |
+
.. note:: |owner-lock|
|
| 46 |
+
|
| 47 |
+
**Syntax**
|
| 48 |
+
|
| 49 |
+
.. code-block:: none
|
| 50 |
+
|
| 51 |
+
[p]cog
|
| 52 |
+
|
| 53 |
+
**Description**
|
| 54 |
+
|
| 55 |
+
Base command for cog installation management commands.
|
| 56 |
+
|
| 57 |
+
.. _downloader-command-cog-checkforupdates:
|
| 58 |
+
|
| 59 |
+
"""""""""""""""""""
|
| 60 |
+
cog checkforupdates
|
| 61 |
+
"""""""""""""""""""
|
| 62 |
+
|
| 63 |
+
**Syntax**
|
| 64 |
+
|
| 65 |
+
.. code-block:: none
|
| 66 |
+
|
| 67 |
+
[p]cog checkforupdates
|
| 68 |
+
|
| 69 |
+
**Description**
|
| 70 |
+
|
| 71 |
+
Check for available cog updates (including pinned cogs).
|
| 72 |
+
|
| 73 |
+
This command doesn't update cogs, it only checks for updates.
|
| 74 |
+
Use ``[p]cog update`` to update cogs.
|
| 75 |
+
|
| 76 |
+
.. _downloader-command-cog-info:
|
| 77 |
+
|
| 78 |
+
""""""""
|
| 79 |
+
cog info
|
| 80 |
+
""""""""
|
| 81 |
+
|
| 82 |
+
**Syntax**
|
| 83 |
+
|
| 84 |
+
.. code-block:: none
|
| 85 |
+
|
| 86 |
+
[p]cog info <repo> <cog>
|
| 87 |
+
|
| 88 |
+
**Description**
|
| 89 |
+
|
| 90 |
+
List information about a single cog.
|
| 91 |
+
|
| 92 |
+
Example:
|
| 93 |
+
- ``[p]cog info 26-Cogs defender``
|
| 94 |
+
|
| 95 |
+
**Arguments**
|
| 96 |
+
|
| 97 |
+
- ``<repo>`` The repo to get cog info from.
|
| 98 |
+
- ``<cog>`` The cog to get info on.
|
| 99 |
+
|
| 100 |
+
.. _downloader-command-cog-install:
|
| 101 |
+
|
| 102 |
+
"""""""""""
|
| 103 |
+
cog install
|
| 104 |
+
"""""""""""
|
| 105 |
+
|
| 106 |
+
**Syntax**
|
| 107 |
+
|
| 108 |
+
.. code-block:: none
|
| 109 |
+
|
| 110 |
+
[p]cog install <repo> <cogs...>
|
| 111 |
+
|
| 112 |
+
**Description**
|
| 113 |
+
|
| 114 |
+
Install a cog from the given repo.
|
| 115 |
+
|
| 116 |
+
Examples:
|
| 117 |
+
- ``[p]cog install 26-Cogs defender``
|
| 118 |
+
- ``[p]cog install Laggrons-Dumb-Cogs say roleinvite``
|
| 119 |
+
|
| 120 |
+
**Arguments**
|
| 121 |
+
|
| 122 |
+
- ``<repo>`` The name of the repo to install cogs from.
|
| 123 |
+
- ``<cogs...>`` The cog or cogs to install.
|
| 124 |
+
|
| 125 |
+
.. _downloader-command-cog-installversion:
|
| 126 |
+
|
| 127 |
+
""""""""""""""""""
|
| 128 |
+
cog installversion
|
| 129 |
+
""""""""""""""""""
|
| 130 |
+
|
| 131 |
+
**Syntax**
|
| 132 |
+
|
| 133 |
+
.. code-block:: none
|
| 134 |
+
|
| 135 |
+
[p]cog installversion <repo> <revision> <cogs...>
|
| 136 |
+
|
| 137 |
+
**Description**
|
| 138 |
+
|
| 139 |
+
Install a cog from the specified revision of given repo.
|
| 140 |
+
|
| 141 |
+
Revisions are "commit ids" that point to the point in the code when a specific change was made.
|
| 142 |
+
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>`_.
|
| 143 |
+
|
| 144 |
+
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>`_
|
| 145 |
+
|
| 146 |
+
Example:
|
| 147 |
+
- ``[p]cog installversion Broken-Repo e798cc268e199612b1316a3d1f193da0770c7016 cog_name``
|
| 148 |
+
|
| 149 |
+
**Arguments**
|
| 150 |
+
|
| 151 |
+
- ``<repo>`` The name of the repo to install cogs from.
|
| 152 |
+
- ``<revision>`` The revision to install from.
|
| 153 |
+
- ``<cogs...>`` The cog or cogs to install.
|
| 154 |
+
|
| 155 |
+
.. _downloader-command-cog-list:
|
| 156 |
+
|
| 157 |
+
""""""""
|
| 158 |
+
cog list
|
| 159 |
+
""""""""
|
| 160 |
+
|
| 161 |
+
**Syntax**
|
| 162 |
+
|
| 163 |
+
.. code-block:: none
|
| 164 |
+
|
| 165 |
+
[p]cog list <repo>
|
| 166 |
+
|
| 167 |
+
**Description**
|
| 168 |
+
|
| 169 |
+
List all available cogs from a single repo.
|
| 170 |
+
|
| 171 |
+
Example:
|
| 172 |
+
- ``[p]cog list 26-Cogs``
|
| 173 |
+
|
| 174 |
+
**Arguments**
|
| 175 |
+
|
| 176 |
+
- ``<repo>`` The repo to list cogs from.
|
| 177 |
+
|
| 178 |
+
.. _downloader-command-cog-listpinned:
|
| 179 |
+
|
| 180 |
+
""""""""""""""
|
| 181 |
+
cog listpinned
|
| 182 |
+
""""""""""""""
|
| 183 |
+
|
| 184 |
+
**Syntax**
|
| 185 |
+
|
| 186 |
+
.. code-block:: none
|
| 187 |
+
|
| 188 |
+
[p]cog listpinned
|
| 189 |
+
|
| 190 |
+
**Description**
|
| 191 |
+
|
| 192 |
+
List currently pinned cogs.
|
| 193 |
+
|
| 194 |
+
.. _downloader-command-cog-pin:
|
| 195 |
+
|
| 196 |
+
"""""""
|
| 197 |
+
cog pin
|
| 198 |
+
"""""""
|
| 199 |
+
|
| 200 |
+
**Syntax**
|
| 201 |
+
|
| 202 |
+
.. code-block:: none
|
| 203 |
+
|
| 204 |
+
[p]cog pin <cogs...>
|
| 205 |
+
|
| 206 |
+
**Description**
|
| 207 |
+
|
| 208 |
+
Pin cogs - this will lock cogs on their current version.
|
| 209 |
+
|
| 210 |
+
Examples:
|
| 211 |
+
- ``[p]cog pin defender``
|
| 212 |
+
- ``[p]cog pin outdated_cog1 outdated_cog2``
|
| 213 |
+
|
| 214 |
+
**Arguments**
|
| 215 |
+
|
| 216 |
+
- ``<cogs...>`` The cog or cogs to pin. Must already be installed.
|
| 217 |
+
|
| 218 |
+
.. _downloader-command-cog-uninstall:
|
| 219 |
+
|
| 220 |
+
"""""""""""""
|
| 221 |
+
cog uninstall
|
| 222 |
+
"""""""""""""
|
| 223 |
+
|
| 224 |
+
**Syntax**
|
| 225 |
+
|
| 226 |
+
.. code-block:: none
|
| 227 |
+
|
| 228 |
+
[p]cog uninstall <cogs...>
|
| 229 |
+
|
| 230 |
+
**Description**
|
| 231 |
+
|
| 232 |
+
Uninstall cogs.
|
| 233 |
+
|
| 234 |
+
You may only uninstall cogs which were previously installed
|
| 235 |
+
by Downloader.
|
| 236 |
+
|
| 237 |
+
Examples:
|
| 238 |
+
- ``[p]cog uninstall defender``
|
| 239 |
+
- ``[p]cog uninstall say roleinvite``
|
| 240 |
+
|
| 241 |
+
**Arguments**
|
| 242 |
+
|
| 243 |
+
- ``<cogs...>`` The cog or cogs to uninstall.
|
| 244 |
+
|
| 245 |
+
.. _downloader-command-cog-unpin:
|
| 246 |
+
|
| 247 |
+
"""""""""
|
| 248 |
+
cog unpin
|
| 249 |
+
"""""""""
|
| 250 |
+
|
| 251 |
+
**Syntax**
|
| 252 |
+
|
| 253 |
+
.. code-block:: none
|
| 254 |
+
|
| 255 |
+
[p]cog unpin <cogs...>
|
| 256 |
+
|
| 257 |
+
**Description**
|
| 258 |
+
|
| 259 |
+
Unpin cogs - this will remove the update lock from those cogs.
|
| 260 |
+
|
| 261 |
+
Examples:
|
| 262 |
+
- ``[p]cog unpin defender``
|
| 263 |
+
- ``[p]cog unpin updated_cog1 updated_cog2``
|
| 264 |
+
|
| 265 |
+
**Arguments**
|
| 266 |
+
|
| 267 |
+
- ``<cogs...>`` The cog or cogs to unpin. Must already be installed and pinned.
|
| 268 |
+
|
| 269 |
+
.. _downloader-command-cog-update:
|
| 270 |
+
|
| 271 |
+
""""""""""
|
| 272 |
+
cog update
|
| 273 |
+
""""""""""
|
| 274 |
+
|
| 275 |
+
**Syntax**
|
| 276 |
+
|
| 277 |
+
.. code-block:: none
|
| 278 |
+
|
| 279 |
+
[p]cog update [cogs...]
|
| 280 |
+
|
| 281 |
+
**Description**
|
| 282 |
+
|
| 283 |
+
Update all cogs, or ones of your choosing.
|
| 284 |
+
|
| 285 |
+
Examples:
|
| 286 |
+
- ``[p]cog update``
|
| 287 |
+
- ``[p]cog update defender``
|
| 288 |
+
|
| 289 |
+
**Arguments**
|
| 290 |
+
|
| 291 |
+
- ``[cogs...]`` The cog or cogs to update. If omitted, all cogs are updated.
|
| 292 |
+
|
| 293 |
+
.. _downloader-command-cog-updateallfromrepos:
|
| 294 |
+
|
| 295 |
+
""""""""""""""""""""""
|
| 296 |
+
cog updateallfromrepos
|
| 297 |
+
""""""""""""""""""""""
|
| 298 |
+
|
| 299 |
+
**Syntax**
|
| 300 |
+
|
| 301 |
+
.. code-block:: none
|
| 302 |
+
|
| 303 |
+
[p]cog updateallfromrepos <repos...>
|
| 304 |
+
|
| 305 |
+
**Description**
|
| 306 |
+
|
| 307 |
+
Update all cogs from repos of your choosing.
|
| 308 |
+
|
| 309 |
+
Examples:
|
| 310 |
+
- ``[p]cog updateallfromrepos 26-Cogs``
|
| 311 |
+
- ``[p]cog updateallfromrepos Laggrons-Dumb-Cogs 26-Cogs``
|
| 312 |
+
|
| 313 |
+
**Arguments**
|
| 314 |
+
|
| 315 |
+
- ``<repos...>`` The repo or repos to update all cogs from.
|
| 316 |
+
|
| 317 |
+
.. _downloader-command-cog-updatetoversion:
|
| 318 |
+
|
| 319 |
+
"""""""""""""""""""
|
| 320 |
+
cog updatetoversion
|
| 321 |
+
"""""""""""""""""""
|
| 322 |
+
|
| 323 |
+
**Syntax**
|
| 324 |
+
|
| 325 |
+
.. code-block:: none
|
| 326 |
+
|
| 327 |
+
[p]cog updatetoversion <repo> <revision> [cogs...]
|
| 328 |
+
|
| 329 |
+
**Description**
|
| 330 |
+
|
| 331 |
+
Update all cogs, or ones of your choosing to chosen revision of one repo.
|
| 332 |
+
|
| 333 |
+
Note that update doesn't mean downgrade and therefore ``revision``
|
| 334 |
+
has to be newer than the version that cog currently has installed. If you want to
|
| 335 |
+
downgrade the cog, uninstall and install it again.
|
| 336 |
+
|
| 337 |
+
See ``[p]cog installversion`` for an explanation of ``revision``.
|
| 338 |
+
|
| 339 |
+
Example:
|
| 340 |
+
- ``[p]cog updatetoversion Broken-Repo e798cc268e199612b1316a3d1f193da0770c7016 cog_name``
|
| 341 |
+
|
| 342 |
+
**Arguments**
|
| 343 |
+
|
| 344 |
+
- ``<repo>`` The repo or repos to update all cogs from.
|
| 345 |
+
- ``<revision>`` The revision to update to.
|
| 346 |
+
- ``[cogs...]`` The cog or cogs to update.
|
| 347 |
+
|
| 348 |
+
.. _downloader-command-findcog:
|
| 349 |
+
|
| 350 |
+
^^^^^^^
|
| 351 |
+
findcog
|
| 352 |
+
^^^^^^^
|
| 353 |
+
|
| 354 |
+
**Syntax**
|
| 355 |
+
|
| 356 |
+
.. code-block:: none
|
| 357 |
+
|
| 358 |
+
[p]findcog <command_name>
|
| 359 |
+
|
| 360 |
+
**Description**
|
| 361 |
+
|
| 362 |
+
Find which cog a command comes from.
|
| 363 |
+
|
| 364 |
+
This will only work with loaded cogs.
|
| 365 |
+
|
| 366 |
+
Example:
|
| 367 |
+
- ``[p]findcog ping``
|
| 368 |
+
|
| 369 |
+
**Arguments**
|
| 370 |
+
|
| 371 |
+
- ``<command_name>`` The command to search for.
|
| 372 |
+
|
| 373 |
+
.. _downloader-command-pipinstall:
|
| 374 |
+
|
| 375 |
+
^^^^^^^^^^
|
| 376 |
+
pipinstall
|
| 377 |
+
^^^^^^^^^^
|
| 378 |
+
|
| 379 |
+
.. note:: |owner-lock|
|
| 380 |
+
|
| 381 |
+
**Syntax**
|
| 382 |
+
|
| 383 |
+
.. code-block:: none
|
| 384 |
+
|
| 385 |
+
[p]pipinstall <deps...>
|
| 386 |
+
|
| 387 |
+
**Description**
|
| 388 |
+
|
| 389 |
+
Install a group of dependencies using pip.
|
| 390 |
+
|
| 391 |
+
Examples:
|
| 392 |
+
- ``[p]pipinstall bs4``
|
| 393 |
+
- ``[p]pipinstall py-cpuinfo psutil``
|
| 394 |
+
|
| 395 |
+
Improper usage of this command can break your bot, be careful.
|
| 396 |
+
|
| 397 |
+
**Arguments**
|
| 398 |
+
|
| 399 |
+
- ``<deps...>`` The package or packages you wish to install.
|
| 400 |
+
|
| 401 |
+
.. _downloader-command-repo:
|
| 402 |
+
|
| 403 |
+
^^^^
|
| 404 |
+
repo
|
| 405 |
+
^^^^
|
| 406 |
+
|
| 407 |
+
.. note:: |owner-lock|
|
| 408 |
+
|
| 409 |
+
**Syntax**
|
| 410 |
+
|
| 411 |
+
.. code-block:: none
|
| 412 |
+
|
| 413 |
+
[p]repo
|
| 414 |
+
|
| 415 |
+
**Description**
|
| 416 |
+
|
| 417 |
+
Base command for repository management.
|
| 418 |
+
|
| 419 |
+
.. _downloader-command-repo-add:
|
| 420 |
+
|
| 421 |
+
""""""""
|
| 422 |
+
repo add
|
| 423 |
+
""""""""
|
| 424 |
+
|
| 425 |
+
**Syntax**
|
| 426 |
+
|
| 427 |
+
.. code-block:: none
|
| 428 |
+
|
| 429 |
+
[p]repo add <name> <repo_url> [branch]
|
| 430 |
+
|
| 431 |
+
**Description**
|
| 432 |
+
|
| 433 |
+
Add a new repo.
|
| 434 |
+
|
| 435 |
+
Examples:
|
| 436 |
+
- ``[p]repo add 26-Cogs https://github.com/Twentysix26/x26-Cogs``
|
| 437 |
+
- ``[p]repo add Laggrons-Dumb-Cogs https://github.com/retke/Laggrons-Dumb-Cogs v3``
|
| 438 |
+
|
| 439 |
+
Repo names can only contain characters A-z, numbers, underscores, and hyphens.
|
| 440 |
+
The branch will be the default branch if not specified.
|
| 441 |
+
|
| 442 |
+
**Arguments**
|
| 443 |
+
|
| 444 |
+
- ``<name>`` The name given to the repo.
|
| 445 |
+
- ``<repo_url>`` URL to the cog branch. Usually GitHub or GitLab.
|
| 446 |
+
- ``[branch]`` Optional branch to install cogs from.
|
| 447 |
+
|
| 448 |
+
.. _downloader-command-repo-delete:
|
| 449 |
+
|
| 450 |
+
"""""""""""
|
| 451 |
+
repo delete
|
| 452 |
+
"""""""""""
|
| 453 |
+
|
| 454 |
+
**Syntax**
|
| 455 |
+
|
| 456 |
+
.. code-block:: none
|
| 457 |
+
|
| 458 |
+
[p]repo delete <repo>
|
| 459 |
+
|
| 460 |
+
.. tip:: Aliases: ``repo remove``, ``repo del``
|
| 461 |
+
|
| 462 |
+
**Description**
|
| 463 |
+
|
| 464 |
+
Remove repos and their files.
|
| 465 |
+
|
| 466 |
+
Examples:
|
| 467 |
+
- ``[p]repo delete 26-Cogs``
|
| 468 |
+
- ``[p]repo delete 26-Cogs Laggrons-Dumb-Cogs``
|
| 469 |
+
|
| 470 |
+
**Arguments**
|
| 471 |
+
|
| 472 |
+
- ``<repos...>`` The repo or repos to remove.
|
| 473 |
+
|
| 474 |
+
.. _downloader-command-repo-info:
|
| 475 |
+
|
| 476 |
+
"""""""""
|
| 477 |
+
repo info
|
| 478 |
+
"""""""""
|
| 479 |
+
|
| 480 |
+
**Syntax**
|
| 481 |
+
|
| 482 |
+
.. code-block:: none
|
| 483 |
+
|
| 484 |
+
[p]repo info <repo>
|
| 485 |
+
|
| 486 |
+
**Description**
|
| 487 |
+
|
| 488 |
+
Show information about a repo.
|
| 489 |
+
|
| 490 |
+
Example:
|
| 491 |
+
- ``[p]repo info 26-Cogs``
|
| 492 |
+
|
| 493 |
+
**Arguments**
|
| 494 |
+
|
| 495 |
+
- ``<repo>`` The name of the repo to show info about.
|
| 496 |
+
|
| 497 |
+
.. _downloader-command-repo-list:
|
| 498 |
+
|
| 499 |
+
"""""""""
|
| 500 |
+
repo list
|
| 501 |
+
"""""""""
|
| 502 |
+
|
| 503 |
+
**Syntax**
|
| 504 |
+
|
| 505 |
+
.. code-block:: none
|
| 506 |
+
|
| 507 |
+
[p]repo list
|
| 508 |
+
|
| 509 |
+
**Description**
|
| 510 |
+
|
| 511 |
+
List all installed repos.
|
| 512 |
+
|
| 513 |
+
.. _downloader-command-repo-update:
|
| 514 |
+
|
| 515 |
+
"""""""""""
|
| 516 |
+
repo update
|
| 517 |
+
"""""""""""
|
| 518 |
+
|
| 519 |
+
**Syntax**
|
| 520 |
+
|
| 521 |
+
.. code-block:: none
|
| 522 |
+
|
| 523 |
+
[p]repo update [repos...]
|
| 524 |
+
|
| 525 |
+
**Description**
|
| 526 |
+
|
| 527 |
+
Update all repos, or ones of your choosing.
|
| 528 |
+
|
| 529 |
+
This will *not* update the cogs installed from those repos.
|
| 530 |
+
|
| 531 |
+
Examples:
|
| 532 |
+
- ``[p]repo update``
|
| 533 |
+
- ``[p]repo update 26-Cogs``
|
| 534 |
+
- ``[p]repo update 26-Cogs Laggrons-Dumb-Cogs``
|
| 535 |
+
|
| 536 |
+
**Arguments**
|
| 537 |
+
|
| 538 |
+
- ``[repos...]`` The name or names of repos to update. If omitted, all repos are updated.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/economy.rst
ADDED
|
@@ -0,0 +1,391 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _economy:
|
| 2 |
+
|
| 3 |
+
=======
|
| 4 |
+
Economy
|
| 5 |
+
=======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the economy cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load economy
|
| 15 |
+
|
| 16 |
+
.. _economy-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Get rich and have fun with imaginary currency!
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
.. _economy-commands:
|
| 26 |
+
|
| 27 |
+
--------
|
| 28 |
+
Commands
|
| 29 |
+
--------
|
| 30 |
+
|
| 31 |
+
.. _economy-command-bank:
|
| 32 |
+
|
| 33 |
+
^^^^
|
| 34 |
+
bank
|
| 35 |
+
^^^^
|
| 36 |
+
|
| 37 |
+
**Syntax**
|
| 38 |
+
|
| 39 |
+
.. code-block:: none
|
| 40 |
+
|
| 41 |
+
[p]bank
|
| 42 |
+
|
| 43 |
+
**Description**
|
| 44 |
+
|
| 45 |
+
Base command to manage the bank.
|
| 46 |
+
|
| 47 |
+
.. _economy-command-bank-balance:
|
| 48 |
+
|
| 49 |
+
""""""""""""
|
| 50 |
+
bank balance
|
| 51 |
+
""""""""""""
|
| 52 |
+
|
| 53 |
+
**Syntax**
|
| 54 |
+
|
| 55 |
+
.. code-block:: none
|
| 56 |
+
|
| 57 |
+
[p]bank balance [user]
|
| 58 |
+
|
| 59 |
+
**Description**
|
| 60 |
+
|
| 61 |
+
Show the user's account balance.
|
| 62 |
+
|
| 63 |
+
Example:
|
| 64 |
+
- ``[p]bank balance``
|
| 65 |
+
- ``[p]bank balance @Twentysix``
|
| 66 |
+
|
| 67 |
+
**Arguments**
|
| 68 |
+
|
| 69 |
+
- ``<user>`` The user to check the balance of. If omitted, defaults to your own balance.
|
| 70 |
+
|
| 71 |
+
.. _economy-command-bank-set:
|
| 72 |
+
|
| 73 |
+
""""""""
|
| 74 |
+
bank set
|
| 75 |
+
""""""""
|
| 76 |
+
|
| 77 |
+
.. note:: |admin-lock|
|
| 78 |
+
|
| 79 |
+
**Syntax**
|
| 80 |
+
|
| 81 |
+
.. code-block:: none
|
| 82 |
+
|
| 83 |
+
[p]bank set <to> <creds>
|
| 84 |
+
|
| 85 |
+
**Description**
|
| 86 |
+
|
| 87 |
+
Set the balance of a user's bank account.
|
| 88 |
+
|
| 89 |
+
Putting + or - signs before the amount will add/remove currency on the user's bank account instead.
|
| 90 |
+
|
| 91 |
+
Examples:
|
| 92 |
+
- ``[p]bank set @Twentysix 26`` - Sets balance to 26
|
| 93 |
+
- ``[p]bank set @Twentysix +2`` - Increases balance by 2
|
| 94 |
+
- ``[p]bank set @Twentysix -6`` - Decreases balance by 6
|
| 95 |
+
|
| 96 |
+
**Arguments**
|
| 97 |
+
|
| 98 |
+
- ``<to>`` The user to set the currency of.
|
| 99 |
+
- ``<creds>`` The amount of currency to set their balance to.
|
| 100 |
+
|
| 101 |
+
.. _economy-command-bank-transfer:
|
| 102 |
+
|
| 103 |
+
"""""""""""""
|
| 104 |
+
bank transfer
|
| 105 |
+
"""""""""""""
|
| 106 |
+
|
| 107 |
+
**Syntax**
|
| 108 |
+
|
| 109 |
+
.. code-block:: none
|
| 110 |
+
|
| 111 |
+
[p]bank transfer <to> <amount>
|
| 112 |
+
|
| 113 |
+
**Description**
|
| 114 |
+
|
| 115 |
+
Transfer currency to other users.
|
| 116 |
+
|
| 117 |
+
This will come out of your balance, so make sure you have enough.
|
| 118 |
+
|
| 119 |
+
Example:
|
| 120 |
+
- ``[p]bank transfer @Twentysix 500``
|
| 121 |
+
|
| 122 |
+
**Arguments**
|
| 123 |
+
|
| 124 |
+
- ``<to>`` The user to give currency to.
|
| 125 |
+
- ``<amount>`` The amount of currency to give.
|
| 126 |
+
|
| 127 |
+
.. _economy-command-economyset:
|
| 128 |
+
|
| 129 |
+
^^^^^^^^^^
|
| 130 |
+
economyset
|
| 131 |
+
^^^^^^^^^^
|
| 132 |
+
|
| 133 |
+
.. note:: |admin-lock|
|
| 134 |
+
|
| 135 |
+
**Syntax**
|
| 136 |
+
|
| 137 |
+
.. code-block:: none
|
| 138 |
+
|
| 139 |
+
[p]economyset
|
| 140 |
+
|
| 141 |
+
**Description**
|
| 142 |
+
|
| 143 |
+
Base command to manage Economy settings.
|
| 144 |
+
|
| 145 |
+
.. _economy-command-economyset-paydayamount:
|
| 146 |
+
|
| 147 |
+
"""""""""""""""""""""""
|
| 148 |
+
economyset paydayamount
|
| 149 |
+
"""""""""""""""""""""""
|
| 150 |
+
|
| 151 |
+
**Syntax**
|
| 152 |
+
|
| 153 |
+
.. code-block:: none
|
| 154 |
+
|
| 155 |
+
[p]economyset paydayamount <creds>
|
| 156 |
+
|
| 157 |
+
**Description**
|
| 158 |
+
|
| 159 |
+
Set the amount earned each payday.
|
| 160 |
+
|
| 161 |
+
Example:
|
| 162 |
+
- ``[p]economyset paydayamount 400``
|
| 163 |
+
|
| 164 |
+
**Arguments**
|
| 165 |
+
|
| 166 |
+
- ``<creds>`` The new amount to give when using the payday command. Default is 120.
|
| 167 |
+
|
| 168 |
+
.. _economy-command-economyset-paydaytime:
|
| 169 |
+
|
| 170 |
+
"""""""""""""""""""""
|
| 171 |
+
economyset paydaytime
|
| 172 |
+
"""""""""""""""""""""
|
| 173 |
+
|
| 174 |
+
**Syntax**
|
| 175 |
+
|
| 176 |
+
.. code-block:: none
|
| 177 |
+
|
| 178 |
+
[p]economyset paydaytime <duration>
|
| 179 |
+
|
| 180 |
+
**Description**
|
| 181 |
+
|
| 182 |
+
Set the cooldown for the payday command.
|
| 183 |
+
|
| 184 |
+
Examples:
|
| 185 |
+
- ``[p]economyset paydaytime 86400``
|
| 186 |
+
- ``[p]economyset paydaytime 1d``
|
| 187 |
+
|
| 188 |
+
**Arguments**
|
| 189 |
+
|
| 190 |
+
- | ``<duration>`` The new duration to wait in between uses of payday. Default is 5 minutes.
|
| 191 |
+
| Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
|
| 192 |
+
|
| 193 |
+
.. _economy-command-economyset-rolepaydayamount:
|
| 194 |
+
|
| 195 |
+
"""""""""""""""""""""""""""
|
| 196 |
+
economyset rolepaydayamount
|
| 197 |
+
"""""""""""""""""""""""""""
|
| 198 |
+
|
| 199 |
+
**Syntax**
|
| 200 |
+
|
| 201 |
+
.. code-block:: none
|
| 202 |
+
|
| 203 |
+
[p]economyset rolepaydayamount <role> <creds>
|
| 204 |
+
|
| 205 |
+
**Description**
|
| 206 |
+
|
| 207 |
+
Set the amount earned each payday for a role.
|
| 208 |
+
|
| 209 |
+
Set to 0 will remove the custom payday for that role instead.
|
| 210 |
+
|
| 211 |
+
Only available when not using a global bank.
|
| 212 |
+
|
| 213 |
+
Example:
|
| 214 |
+
- ``[p]economyset rolepaydayamount @Members 400``
|
| 215 |
+
|
| 216 |
+
**Arguments**
|
| 217 |
+
|
| 218 |
+
- ``<role>`` The role to assign a custom payday amount to.
|
| 219 |
+
- ``<creds>`` The new amount to give when using the payday command.
|
| 220 |
+
|
| 221 |
+
.. _economy-command-economyset-showsettings:
|
| 222 |
+
|
| 223 |
+
"""""""""""""""""""""""
|
| 224 |
+
economyset showsettings
|
| 225 |
+
"""""""""""""""""""""""
|
| 226 |
+
|
| 227 |
+
**Syntax**
|
| 228 |
+
|
| 229 |
+
.. code-block:: none
|
| 230 |
+
|
| 231 |
+
[p]economyset showsettings
|
| 232 |
+
|
| 233 |
+
**Description**
|
| 234 |
+
|
| 235 |
+
Shows the current economy settings
|
| 236 |
+
|
| 237 |
+
.. _economy-command-economyset-slotmax:
|
| 238 |
+
|
| 239 |
+
""""""""""""""""""
|
| 240 |
+
economyset slotmax
|
| 241 |
+
""""""""""""""""""
|
| 242 |
+
|
| 243 |
+
**Syntax**
|
| 244 |
+
|
| 245 |
+
.. code-block:: none
|
| 246 |
+
|
| 247 |
+
[p]economyset slotmax <bid>
|
| 248 |
+
|
| 249 |
+
**Description**
|
| 250 |
+
|
| 251 |
+
Set the maximum slot machine bid.
|
| 252 |
+
|
| 253 |
+
Example:
|
| 254 |
+
- ``[p]economyset slotmax 50``
|
| 255 |
+
|
| 256 |
+
**Arguments**
|
| 257 |
+
|
| 258 |
+
- ``<bid>`` The new maximum bid for using the slot machine. Default is 100.
|
| 259 |
+
|
| 260 |
+
.. _economy-command-economyset-slotmin:
|
| 261 |
+
|
| 262 |
+
""""""""""""""""""
|
| 263 |
+
economyset slotmin
|
| 264 |
+
""""""""""""""""""
|
| 265 |
+
|
| 266 |
+
**Syntax**
|
| 267 |
+
|
| 268 |
+
.. code-block:: none
|
| 269 |
+
|
| 270 |
+
[p]economyset slotmin <bid>
|
| 271 |
+
|
| 272 |
+
**Description**
|
| 273 |
+
|
| 274 |
+
Set the minimum slot machine bid.
|
| 275 |
+
|
| 276 |
+
Example:
|
| 277 |
+
- ``[p]economyset slotmin 10``
|
| 278 |
+
|
| 279 |
+
**Arguments**
|
| 280 |
+
|
| 281 |
+
- ``<bid>`` The new minimum bid for using the slot machine. Default is 5.
|
| 282 |
+
|
| 283 |
+
.. _economy-command-economyset-slottime:
|
| 284 |
+
|
| 285 |
+
"""""""""""""""""""
|
| 286 |
+
economyset slottime
|
| 287 |
+
"""""""""""""""""""
|
| 288 |
+
|
| 289 |
+
**Syntax**
|
| 290 |
+
|
| 291 |
+
.. code-block:: none
|
| 292 |
+
|
| 293 |
+
[p]economyset slottime <duration>
|
| 294 |
+
|
| 295 |
+
**Description**
|
| 296 |
+
|
| 297 |
+
Set the cooldown for the slot machine.
|
| 298 |
+
|
| 299 |
+
Examples:
|
| 300 |
+
- ``[p]economyset slottime 10``
|
| 301 |
+
- ``[p]economyset slottime 10m``
|
| 302 |
+
|
| 303 |
+
**Arguments**
|
| 304 |
+
|
| 305 |
+
- | ``<duration>`` The new duration to wait in between uses of the slot machine. Default is 5 seconds.
|
| 306 |
+
| Accepts: seconds, minutes, hours, days, weeks (if no unit is specified, the duration is assumed to be given in seconds)
|
| 307 |
+
|
| 308 |
+
.. _economy-command-leaderboard:
|
| 309 |
+
|
| 310 |
+
^^^^^^^^^^^
|
| 311 |
+
leaderboard
|
| 312 |
+
^^^^^^^^^^^
|
| 313 |
+
|
| 314 |
+
**Syntax**
|
| 315 |
+
|
| 316 |
+
.. code-block:: none
|
| 317 |
+
|
| 318 |
+
[p]leaderboard [top=10] [show_global=False]
|
| 319 |
+
|
| 320 |
+
**Description**
|
| 321 |
+
|
| 322 |
+
Print the leaderboard.
|
| 323 |
+
|
| 324 |
+
Defaults to top 10.
|
| 325 |
+
|
| 326 |
+
Examples:
|
| 327 |
+
- ``[p]leaderboard``
|
| 328 |
+
- ``[p]leaderboard 50`` - Shows the top 50 instead of top 10.
|
| 329 |
+
- ``[p]leaderboard 100 yes`` - Shows the top 100 from all servers.
|
| 330 |
+
|
| 331 |
+
**Arguments**
|
| 332 |
+
|
| 333 |
+
- ``<top>`` How many positions on the leaderboard to show. Defaults to 10 if omitted.
|
| 334 |
+
- ``<show_global>`` Whether to include results from all servers. This will default to false unless specified.
|
| 335 |
+
|
| 336 |
+
.. _economy-command-payday:
|
| 337 |
+
|
| 338 |
+
^^^^^^
|
| 339 |
+
payday
|
| 340 |
+
^^^^^^
|
| 341 |
+
|
| 342 |
+
**Syntax**
|
| 343 |
+
|
| 344 |
+
.. code-block:: none
|
| 345 |
+
|
| 346 |
+
[p]payday
|
| 347 |
+
|
| 348 |
+
**Description**
|
| 349 |
+
|
| 350 |
+
Get some free currency.
|
| 351 |
+
|
| 352 |
+
The amount awarded and frequency can be configured.
|
| 353 |
+
|
| 354 |
+
.. _economy-command-payouts:
|
| 355 |
+
|
| 356 |
+
^^^^^^^
|
| 357 |
+
payouts
|
| 358 |
+
^^^^^^^
|
| 359 |
+
|
| 360 |
+
**Syntax**
|
| 361 |
+
|
| 362 |
+
.. code-block:: none
|
| 363 |
+
|
| 364 |
+
[p]payouts
|
| 365 |
+
|
| 366 |
+
**Description**
|
| 367 |
+
|
| 368 |
+
Show the payouts for the slot machine.
|
| 369 |
+
|
| 370 |
+
.. _economy-command-slot:
|
| 371 |
+
|
| 372 |
+
^^^^
|
| 373 |
+
slot
|
| 374 |
+
^^^^
|
| 375 |
+
|
| 376 |
+
**Syntax**
|
| 377 |
+
|
| 378 |
+
.. code-block:: none
|
| 379 |
+
|
| 380 |
+
[p]slot <bid>
|
| 381 |
+
|
| 382 |
+
**Description**
|
| 383 |
+
|
| 384 |
+
Use the slot machine.
|
| 385 |
+
|
| 386 |
+
Example:
|
| 387 |
+
- ``[p]slot 50``
|
| 388 |
+
|
| 389 |
+
**Arguments**
|
| 390 |
+
|
| 391 |
+
- ``<bid>`` The amount to bet on the slot machine. Winning payouts are higher when you bet more.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/filter.rst
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _filter:
|
| 2 |
+
|
| 3 |
+
======
|
| 4 |
+
Filter
|
| 5 |
+
======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the filter cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load filter
|
| 15 |
+
|
| 16 |
+
.. _filter-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog is designed for "filtering" unwanted words and phrases from a server.
|
| 23 |
+
|
| 24 |
+
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.
|
| 25 |
+
|
| 26 |
+
This can be used to prevent inappropriate language, off-topic discussions, invite links, and more.
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
.. _filter-commands:
|
| 30 |
+
|
| 31 |
+
--------
|
| 32 |
+
Commands
|
| 33 |
+
--------
|
| 34 |
+
|
| 35 |
+
.. _filter-command-filter:
|
| 36 |
+
|
| 37 |
+
^^^^^^
|
| 38 |
+
filter
|
| 39 |
+
^^^^^^
|
| 40 |
+
|
| 41 |
+
.. note:: |mod-lock|
|
| 42 |
+
|
| 43 |
+
**Syntax**
|
| 44 |
+
|
| 45 |
+
.. code-block:: none
|
| 46 |
+
|
| 47 |
+
[p]filter
|
| 48 |
+
|
| 49 |
+
**Description**
|
| 50 |
+
|
| 51 |
+
Base command to add or remove words from the server filter.
|
| 52 |
+
|
| 53 |
+
Use double quotes to add or remove sentences.
|
| 54 |
+
|
| 55 |
+
.. _filter-command-filter-add:
|
| 56 |
+
|
| 57 |
+
""""""""""
|
| 58 |
+
filter add
|
| 59 |
+
""""""""""
|
| 60 |
+
|
| 61 |
+
**Syntax**
|
| 62 |
+
|
| 63 |
+
.. code-block:: none
|
| 64 |
+
|
| 65 |
+
[p]filter add [words...]
|
| 66 |
+
|
| 67 |
+
**Description**
|
| 68 |
+
|
| 69 |
+
Add words to the filter.
|
| 70 |
+
|
| 71 |
+
Use double quotes to add sentences.
|
| 72 |
+
|
| 73 |
+
Examples:
|
| 74 |
+
- ``[p]filter add word1 word2 word3``
|
| 75 |
+
- ``[p]filter add "This is a sentence"``
|
| 76 |
+
|
| 77 |
+
**Arguments:**
|
| 78 |
+
|
| 79 |
+
- ``[words...]`` The words or sentences to filter.
|
| 80 |
+
|
| 81 |
+
.. _filter-command-filter-channel:
|
| 82 |
+
|
| 83 |
+
""""""""""""""
|
| 84 |
+
filter channel
|
| 85 |
+
""""""""""""""
|
| 86 |
+
|
| 87 |
+
**Syntax**
|
| 88 |
+
|
| 89 |
+
.. code-block:: none
|
| 90 |
+
|
| 91 |
+
[p]filter channel
|
| 92 |
+
|
| 93 |
+
**Description**
|
| 94 |
+
|
| 95 |
+
Base command to add or remove words from the channel filter.
|
| 96 |
+
|
| 97 |
+
Use double quotes to add or remove sentences.
|
| 98 |
+
|
| 99 |
+
.. _filter-command-filter-channel-add:
|
| 100 |
+
|
| 101 |
+
""""""""""""""""""
|
| 102 |
+
filter channel add
|
| 103 |
+
""""""""""""""""""
|
| 104 |
+
|
| 105 |
+
**Syntax**
|
| 106 |
+
|
| 107 |
+
.. code-block:: none
|
| 108 |
+
|
| 109 |
+
[p]filter channel add [words...]
|
| 110 |
+
|
| 111 |
+
**Description**
|
| 112 |
+
|
| 113 |
+
Add words to the filter.
|
| 114 |
+
|
| 115 |
+
Use double quotes to add sentences.
|
| 116 |
+
|
| 117 |
+
Examples:
|
| 118 |
+
- ``[p]filter channel add word1 word2 word3``
|
| 119 |
+
- ``[p]filter channel add "This is a sentence"``
|
| 120 |
+
|
| 121 |
+
**Arguments:**
|
| 122 |
+
|
| 123 |
+
- ``[words...]`` The words or sentences to filter.
|
| 124 |
+
|
| 125 |
+
.. _filter-command-filter-channel-clear:
|
| 126 |
+
|
| 127 |
+
""""""""""""""""""""
|
| 128 |
+
filter channel clear
|
| 129 |
+
""""""""""""""""""""
|
| 130 |
+
|
| 131 |
+
**Syntax**
|
| 132 |
+
|
| 133 |
+
.. code-block:: none
|
| 134 |
+
|
| 135 |
+
[p]filter channel clear
|
| 136 |
+
|
| 137 |
+
**Description**
|
| 138 |
+
|
| 139 |
+
Clears this channel's filter list.
|
| 140 |
+
|
| 141 |
+
.. _filter-command-filter-channel-list:
|
| 142 |
+
|
| 143 |
+
"""""""""""""""""""
|
| 144 |
+
filter channel list
|
| 145 |
+
"""""""""""""""""""
|
| 146 |
+
|
| 147 |
+
**Syntax**
|
| 148 |
+
|
| 149 |
+
.. code-block:: none
|
| 150 |
+
|
| 151 |
+
[p]filter channel list
|
| 152 |
+
|
| 153 |
+
**Description**
|
| 154 |
+
|
| 155 |
+
Send a list of the channel's filtered words.
|
| 156 |
+
|
| 157 |
+
.. _filter-command-filter-channel-remove:
|
| 158 |
+
|
| 159 |
+
"""""""""""""""""""""
|
| 160 |
+
filter channel remove
|
| 161 |
+
"""""""""""""""""""""
|
| 162 |
+
|
| 163 |
+
**Syntax**
|
| 164 |
+
|
| 165 |
+
.. code-block:: none
|
| 166 |
+
|
| 167 |
+
[p]filter channel remove [words...]
|
| 168 |
+
|
| 169 |
+
**Description**
|
| 170 |
+
|
| 171 |
+
Remove words from the filter.
|
| 172 |
+
|
| 173 |
+
Use double quotes to remove sentences.
|
| 174 |
+
|
| 175 |
+
Examples:
|
| 176 |
+
- ``[p]filter channel remove word1 word2 word3``
|
| 177 |
+
- ``[p]filter channel remove "This is a sentence"``
|
| 178 |
+
|
| 179 |
+
**Arguments:**
|
| 180 |
+
|
| 181 |
+
- ``[words...]`` The words or sentences to no longer filter.
|
| 182 |
+
|
| 183 |
+
.. _filter-command-filter-clear:
|
| 184 |
+
|
| 185 |
+
""""""""""""
|
| 186 |
+
filter clear
|
| 187 |
+
""""""""""""
|
| 188 |
+
|
| 189 |
+
**Syntax**
|
| 190 |
+
|
| 191 |
+
.. code-block:: none
|
| 192 |
+
|
| 193 |
+
[p]filter clear
|
| 194 |
+
|
| 195 |
+
**Description**
|
| 196 |
+
|
| 197 |
+
Clears this server's filter list.
|
| 198 |
+
|
| 199 |
+
.. _filter-command-filter-delete:
|
| 200 |
+
|
| 201 |
+
"""""""""""""
|
| 202 |
+
filter delete
|
| 203 |
+
"""""""""""""
|
| 204 |
+
|
| 205 |
+
**Syntax**
|
| 206 |
+
|
| 207 |
+
.. code-block:: none
|
| 208 |
+
|
| 209 |
+
[p]filter delete [words...]
|
| 210 |
+
|
| 211 |
+
.. tip:: Aliases: ``filter remove``, ``filter del``
|
| 212 |
+
|
| 213 |
+
**Description**
|
| 214 |
+
|
| 215 |
+
Remove words from the filter.
|
| 216 |
+
|
| 217 |
+
Use double quotes to remove sentences.
|
| 218 |
+
|
| 219 |
+
Examples:
|
| 220 |
+
- ``[p]filter remove word1 word2 word3``
|
| 221 |
+
- ``[p]filter remove "This is a sentence"``
|
| 222 |
+
|
| 223 |
+
**Arguments:**
|
| 224 |
+
|
| 225 |
+
- ``[words...]`` The words or sentences to no longer filter.
|
| 226 |
+
|
| 227 |
+
.. _filter-command-filter-list:
|
| 228 |
+
|
| 229 |
+
"""""""""""
|
| 230 |
+
filter list
|
| 231 |
+
"""""""""""
|
| 232 |
+
|
| 233 |
+
**Syntax**
|
| 234 |
+
|
| 235 |
+
.. code-block:: none
|
| 236 |
+
|
| 237 |
+
[p]filter list
|
| 238 |
+
|
| 239 |
+
**Description**
|
| 240 |
+
|
| 241 |
+
Send a list of this server's filtered words.
|
| 242 |
+
|
| 243 |
+
.. _filter-command-filter-names:
|
| 244 |
+
|
| 245 |
+
""""""""""""
|
| 246 |
+
filter names
|
| 247 |
+
""""""""""""
|
| 248 |
+
|
| 249 |
+
**Syntax**
|
| 250 |
+
|
| 251 |
+
.. code-block:: none
|
| 252 |
+
|
| 253 |
+
[p]filter names
|
| 254 |
+
|
| 255 |
+
**Description**
|
| 256 |
+
|
| 257 |
+
Toggle name and nickname filtering.
|
| 258 |
+
|
| 259 |
+
This is disabled by default.
|
| 260 |
+
|
| 261 |
+
.. _filter-command-filterset:
|
| 262 |
+
|
| 263 |
+
^^^^^^^^^
|
| 264 |
+
filterset
|
| 265 |
+
^^^^^^^^^
|
| 266 |
+
|
| 267 |
+
.. note:: |admin-lock|
|
| 268 |
+
|
| 269 |
+
**Syntax**
|
| 270 |
+
|
| 271 |
+
.. code-block:: none
|
| 272 |
+
|
| 273 |
+
[p]filterset
|
| 274 |
+
|
| 275 |
+
**Description**
|
| 276 |
+
|
| 277 |
+
Base command to manage filter settings.
|
| 278 |
+
|
| 279 |
+
.. _filter-command-filterset-ban:
|
| 280 |
+
|
| 281 |
+
"""""""""""""
|
| 282 |
+
filterset ban
|
| 283 |
+
"""""""""""""
|
| 284 |
+
|
| 285 |
+
**Syntax**
|
| 286 |
+
|
| 287 |
+
.. code-block:: none
|
| 288 |
+
|
| 289 |
+
[p]filterset ban <count> <timeframe>
|
| 290 |
+
|
| 291 |
+
**Description**
|
| 292 |
+
|
| 293 |
+
Set the filter's autoban conditions.
|
| 294 |
+
|
| 295 |
+
Users will be banned if they send ``<count>`` filtered words in
|
| 296 |
+
``<timeframe>`` seconds.
|
| 297 |
+
|
| 298 |
+
Set both to zero to disable autoban.
|
| 299 |
+
|
| 300 |
+
Examples:
|
| 301 |
+
- ``[p]filterset ban 5 5`` - Ban users who say 5 filtered words in 5 seconds.
|
| 302 |
+
- ``[p]filterset ban 2 20`` - Ban users who say 2 filtered words in 20 seconds.
|
| 303 |
+
|
| 304 |
+
**Arguments:**
|
| 305 |
+
|
| 306 |
+
- ``<count>`` The amount of filtered words required to trigger a ban.
|
| 307 |
+
- ``<timeframe>`` The period of time in which too many filtered words will trigger a ban.
|
| 308 |
+
|
| 309 |
+
.. _filter-command-filterset-defaultname:
|
| 310 |
+
|
| 311 |
+
"""""""""""""""""""""
|
| 312 |
+
filterset defaultname
|
| 313 |
+
"""""""""""""""""""""
|
| 314 |
+
|
| 315 |
+
**Syntax**
|
| 316 |
+
|
| 317 |
+
.. code-block:: none
|
| 318 |
+
|
| 319 |
+
[p]filterset defaultname <name>
|
| 320 |
+
|
| 321 |
+
**Description**
|
| 322 |
+
|
| 323 |
+
Set the nickname for users with a filtered name.
|
| 324 |
+
|
| 325 |
+
Note that this has no effect if filtering names is disabled
|
| 326 |
+
(to toggle, run ``[p]filter names``).
|
| 327 |
+
|
| 328 |
+
The default name used is *John Doe*.
|
| 329 |
+
|
| 330 |
+
Example:
|
| 331 |
+
- ``[p]filterset defaultname Missingno``
|
| 332 |
+
|
| 333 |
+
**Arguments:**
|
| 334 |
+
|
| 335 |
+
- ``<name>`` The new nickname to assign.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/general.rst
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _general:
|
| 2 |
+
|
| 3 |
+
=======
|
| 4 |
+
General
|
| 5 |
+
=======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the general cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load general
|
| 15 |
+
|
| 16 |
+
.. _general-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog includes a miscellaneous group of games, useful
|
| 23 |
+
tools, and informative commands such as ``serverinfo`` or ``urban``.
|
| 24 |
+
|
| 25 |
+
.. _general-commands:
|
| 26 |
+
|
| 27 |
+
--------
|
| 28 |
+
Commands
|
| 29 |
+
--------
|
| 30 |
+
|
| 31 |
+
Here's a list of all commands available for this cog.
|
| 32 |
+
|
| 33 |
+
.. _general-command-8:
|
| 34 |
+
|
| 35 |
+
^^^^^^^^^
|
| 36 |
+
8 (8ball)
|
| 37 |
+
^^^^^^^^^
|
| 38 |
+
|
| 39 |
+
**Syntax**
|
| 40 |
+
|
| 41 |
+
.. code-block:: none
|
| 42 |
+
|
| 43 |
+
[p]8 <question>
|
| 44 |
+
|
| 45 |
+
**Description**
|
| 46 |
+
|
| 47 |
+
Ask 8 ball a question.
|
| 48 |
+
|
| 49 |
+
.. note:: Your question must end with a question mark.
|
| 50 |
+
|
| 51 |
+
**Arguments**
|
| 52 |
+
|
| 53 |
+
* ``<question>``: The question you would like to ask 8 ball.
|
| 54 |
+
|
| 55 |
+
.. _general-command-choose:
|
| 56 |
+
|
| 57 |
+
^^^^^^
|
| 58 |
+
choose
|
| 59 |
+
^^^^^^
|
| 60 |
+
|
| 61 |
+
**Syntax**
|
| 62 |
+
|
| 63 |
+
.. code-block:: none
|
| 64 |
+
|
| 65 |
+
[p]choose <first> <second> [others...]
|
| 66 |
+
|
| 67 |
+
**Description**
|
| 68 |
+
|
| 69 |
+
Choose between multiple options.
|
| 70 |
+
Options are separated by spaces.
|
| 71 |
+
|
| 72 |
+
.. note:: There must be at least 2 options to pick from.
|
| 73 |
+
.. note:: To denote options which include whitespace, you should enclose the option in double quotes.
|
| 74 |
+
|
| 75 |
+
**Arguments**
|
| 76 |
+
|
| 77 |
+
* ``<first>``: The first mandatory option.
|
| 78 |
+
* ``<second>``: The second mandatory option.
|
| 79 |
+
* ``[others...]``: Any remaining optional options.
|
| 80 |
+
|
| 81 |
+
|
| 82 |
+
.. _general-command-flip:
|
| 83 |
+
|
| 84 |
+
^^^^
|
| 85 |
+
flip
|
| 86 |
+
^^^^
|
| 87 |
+
|
| 88 |
+
**Syntax**
|
| 89 |
+
|
| 90 |
+
.. code-block:: none
|
| 91 |
+
|
| 92 |
+
[p]flip [user]
|
| 93 |
+
|
| 94 |
+
**Description**
|
| 95 |
+
|
| 96 |
+
Flip a coin... or a user.
|
| 97 |
+
|
| 98 |
+
**Arguments**
|
| 99 |
+
|
| 100 |
+
* ``[user]``: The user to flip. Defaults to flipping a coin if no user is provided.
|
| 101 |
+
|
| 102 |
+
.. _general-command-lmgtfy:
|
| 103 |
+
|
| 104 |
+
^^^^^^
|
| 105 |
+
lmgtfy
|
| 106 |
+
^^^^^^
|
| 107 |
+
|
| 108 |
+
**Syntax**
|
| 109 |
+
|
| 110 |
+
.. code-block:: none
|
| 111 |
+
|
| 112 |
+
[p]lmgtfy <search_terms>
|
| 113 |
+
|
| 114 |
+
**Description**
|
| 115 |
+
|
| 116 |
+
Create a lmgtfy link.
|
| 117 |
+
|
| 118 |
+
**Arguments**
|
| 119 |
+
|
| 120 |
+
* ``<search_terms>``: The terms used to generate the lmgtfy link.
|
| 121 |
+
|
| 122 |
+
.. _general-command-roll:
|
| 123 |
+
|
| 124 |
+
^^^^
|
| 125 |
+
roll
|
| 126 |
+
^^^^
|
| 127 |
+
|
| 128 |
+
**Syntax**
|
| 129 |
+
|
| 130 |
+
.. code-block:: none
|
| 131 |
+
|
| 132 |
+
[p]roll [number=100]
|
| 133 |
+
|
| 134 |
+
**Description**
|
| 135 |
+
|
| 136 |
+
Roll a random number. The result will be between 1 and ``<number>``.
|
| 137 |
+
|
| 138 |
+
**Arguments**
|
| 139 |
+
|
| 140 |
+
* ``[number]``: The maximum number that can be rolled. Defaults to 100.
|
| 141 |
+
|
| 142 |
+
.. _general-command-rps:
|
| 143 |
+
|
| 144 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 145 |
+
rps (Rock Paper Scissors)
|
| 146 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 147 |
+
|
| 148 |
+
**Syntax**
|
| 149 |
+
|
| 150 |
+
.. code-block:: none
|
| 151 |
+
|
| 152 |
+
[p]rps <your_choice>
|
| 153 |
+
|
| 154 |
+
**Description**
|
| 155 |
+
|
| 156 |
+
Play Rock Paper Scissors.
|
| 157 |
+
|
| 158 |
+
**Arguments**
|
| 159 |
+
|
| 160 |
+
* ``<your_choice>``: The choice that you choose.
|
| 161 |
+
|
| 162 |
+
.. note:: Choices **must** be between ``rock``, ``paper``, or ``scissors``.
|
| 163 |
+
|
| 164 |
+
.. _general-commands-serverinfo:
|
| 165 |
+
|
| 166 |
+
^^^^^^^^^^
|
| 167 |
+
serverinfo
|
| 168 |
+
^^^^^^^^^^
|
| 169 |
+
|
| 170 |
+
**Syntax**
|
| 171 |
+
|
| 172 |
+
.. code-block:: none
|
| 173 |
+
|
| 174 |
+
[p]serverinfo [details=False]
|
| 175 |
+
|
| 176 |
+
**Description**
|
| 177 |
+
|
| 178 |
+
Show server information.
|
| 179 |
+
|
| 180 |
+
**Arguments**
|
| 181 |
+
|
| 182 |
+
* ``[details]``: Show extra details about the server when set to True. Defaults to False.
|
| 183 |
+
|
| 184 |
+
.. _general-commands-stopwatch:
|
| 185 |
+
|
| 186 |
+
^^^^^^^^^
|
| 187 |
+
stopwatch
|
| 188 |
+
^^^^^^^^^
|
| 189 |
+
|
| 190 |
+
**Syntax**
|
| 191 |
+
|
| 192 |
+
.. code-block:: none
|
| 193 |
+
|
| 194 |
+
[p]stopwatch
|
| 195 |
+
|
| 196 |
+
**Description**
|
| 197 |
+
|
| 198 |
+
Start or stop the stopwatch.
|
| 199 |
+
|
| 200 |
+
.. _general-commands-urban:
|
| 201 |
+
|
| 202 |
+
^^^^^
|
| 203 |
+
urban
|
| 204 |
+
^^^^^
|
| 205 |
+
|
| 206 |
+
**Syntax**
|
| 207 |
+
|
| 208 |
+
.. code-block:: none
|
| 209 |
+
|
| 210 |
+
[p]urban <word>
|
| 211 |
+
|
| 212 |
+
**Description**
|
| 213 |
+
|
| 214 |
+
Search the Urban Dictionary.
|
| 215 |
+
|
| 216 |
+
**Arguments**
|
| 217 |
+
|
| 218 |
+
* ``<word>``: The term to search for.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/image.rst
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _image:
|
| 2 |
+
|
| 3 |
+
=====
|
| 4 |
+
Image
|
| 5 |
+
=====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the image cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load image
|
| 15 |
+
|
| 16 |
+
.. _image-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog provides commands for retrieving pictures from
|
| 23 |
+
websites such as Giphy and Imgur.
|
| 24 |
+
|
| 25 |
+
.. _image-commands:
|
| 26 |
+
|
| 27 |
+
--------
|
| 28 |
+
Commands
|
| 29 |
+
--------
|
| 30 |
+
|
| 31 |
+
Here's a list of all commands available for this cog.
|
| 32 |
+
|
| 33 |
+
.. _image-command-gif:
|
| 34 |
+
|
| 35 |
+
^^^
|
| 36 |
+
gif
|
| 37 |
+
^^^
|
| 38 |
+
|
| 39 |
+
**Syntax**
|
| 40 |
+
|
| 41 |
+
.. code-block:: none
|
| 42 |
+
|
| 43 |
+
[p]gif <keywords...>
|
| 44 |
+
|
| 45 |
+
**Description**
|
| 46 |
+
|
| 47 |
+
Retrieve the first search result from Giphy. This command requires API tokens
|
| 48 |
+
to be set via the :ref:`giphycreds <image-command-giphycreds>` command.
|
| 49 |
+
|
| 50 |
+
**Arguments**
|
| 51 |
+
|
| 52 |
+
* ``<keywords...>``: The keywords used to search Giphy.
|
| 53 |
+
|
| 54 |
+
.. _image-command-gifr:
|
| 55 |
+
|
| 56 |
+
^^^^
|
| 57 |
+
gifr
|
| 58 |
+
^^^^
|
| 59 |
+
|
| 60 |
+
**Syntax**
|
| 61 |
+
|
| 62 |
+
.. code-block:: none
|
| 63 |
+
|
| 64 |
+
[p]gifr <keywords...>
|
| 65 |
+
|
| 66 |
+
**Description**
|
| 67 |
+
|
| 68 |
+
Retrieve a random GIF from a Giphy search. This command requires API tokens
|
| 69 |
+
to be set via the :ref:`giphycreds <image-command-giphycreds>` command.
|
| 70 |
+
|
| 71 |
+
**Arguments**
|
| 72 |
+
|
| 73 |
+
* ``<keywords...>``: The keywords used to generate a random GIF.
|
| 74 |
+
|
| 75 |
+
.. _image-command-imgur:
|
| 76 |
+
|
| 77 |
+
^^^^^
|
| 78 |
+
imgur
|
| 79 |
+
^^^^^
|
| 80 |
+
|
| 81 |
+
**Syntax**
|
| 82 |
+
|
| 83 |
+
.. code-block:: none
|
| 84 |
+
|
| 85 |
+
[p]imgur
|
| 86 |
+
|
| 87 |
+
**Description**
|
| 88 |
+
|
| 89 |
+
Retrieves pictures from Imgur. This command requires API tokens to be set
|
| 90 |
+
via the :ref:`imgurcreds <image-command-imgurcreds>` command.
|
| 91 |
+
|
| 92 |
+
.. _image-command-imgur-search:
|
| 93 |
+
|
| 94 |
+
""""""""""""
|
| 95 |
+
imgur search
|
| 96 |
+
""""""""""""
|
| 97 |
+
|
| 98 |
+
**Syntax**
|
| 99 |
+
|
| 100 |
+
.. code-block:: none
|
| 101 |
+
|
| 102 |
+
[p]imgur search [count=1] <terms...>
|
| 103 |
+
|
| 104 |
+
**Description**
|
| 105 |
+
|
| 106 |
+
Search for pictures on Imgur. This command requires API tokens to be set
|
| 107 |
+
via the :ref:`imgurcreds <image-command-imgurcreds>` command.
|
| 108 |
+
|
| 109 |
+
**Arguments**
|
| 110 |
+
|
| 111 |
+
* ``[count]``: How many images should be returned (maximum 5). Defaults to 1.
|
| 112 |
+
|
| 113 |
+
* ``<terms...>``: The terms used to search Imgur.
|
| 114 |
+
|
| 115 |
+
.. _image-command-imgur-subreddit:
|
| 116 |
+
|
| 117 |
+
"""""""""""""""
|
| 118 |
+
imgur subreddit
|
| 119 |
+
"""""""""""""""
|
| 120 |
+
|
| 121 |
+
**Syntax**
|
| 122 |
+
|
| 123 |
+
.. code-block:: none
|
| 124 |
+
|
| 125 |
+
[p]imgur subreddit <subreddit> [count=1] [sort_type=top] [window=day]
|
| 126 |
+
|
| 127 |
+
**Description**
|
| 128 |
+
|
| 129 |
+
Get images from a subreddit. This command requires API tokens to be set
|
| 130 |
+
via the :ref:`imgurcreds <image-command-imgurcreds>` command.
|
| 131 |
+
|
| 132 |
+
**Arguments**
|
| 133 |
+
|
| 134 |
+
* ``<subreddit>``: The subreddit to get images from.
|
| 135 |
+
|
| 136 |
+
* ``[count]``: The number of images to return (maximum 5). Defaults to 1.
|
| 137 |
+
|
| 138 |
+
* ``[sort_type]``: New, or top results. Defaults to top.
|
| 139 |
+
|
| 140 |
+
* ``[window]``: The timeframe, can be the past day, week, month, year or all. Defaults to day.
|
| 141 |
+
|
| 142 |
+
.. _image-command-giphycreds:
|
| 143 |
+
|
| 144 |
+
^^^^^^^^^^
|
| 145 |
+
giphycreds
|
| 146 |
+
^^^^^^^^^^
|
| 147 |
+
|
| 148 |
+
.. note:: |owner-lock|
|
| 149 |
+
|
| 150 |
+
**Syntax**
|
| 151 |
+
|
| 152 |
+
.. code-block:: none
|
| 153 |
+
|
| 154 |
+
[p]giphycreds
|
| 155 |
+
|
| 156 |
+
**Description**
|
| 157 |
+
|
| 158 |
+
Explains how to set GIPHY API tokens.
|
| 159 |
+
|
| 160 |
+
**Getting your API key**
|
| 161 |
+
|
| 162 |
+
1. Login (or create) a GIPHY account.
|
| 163 |
+
2. Visit `this page <https://developers.giphy.com/dashboard>`__.
|
| 164 |
+
3. Press 'Create an App'.
|
| 165 |
+
4. Click 'Select API', and then 'Next Step'.
|
| 166 |
+
5. Add an app name, for example 'Red'.
|
| 167 |
+
6. Add an app description, for example 'Used for Red's image cog'.
|
| 168 |
+
7. Click 'Create App'. You'll need to agree to the GIPHY API terms.
|
| 169 |
+
8. Copy the API Key.
|
| 170 |
+
9. In Discord, run the following command::
|
| 171 |
+
|
| 172 |
+
[p]set api GIPHY api_key <your_api_key_here>
|
| 173 |
+
|
| 174 |
+
.. _image-command-imgurcreds:
|
| 175 |
+
|
| 176 |
+
^^^^^^^^^^
|
| 177 |
+
imgurcreds
|
| 178 |
+
^^^^^^^^^^
|
| 179 |
+
|
| 180 |
+
.. note:: |owner-lock|
|
| 181 |
+
|
| 182 |
+
**Syntax**
|
| 183 |
+
|
| 184 |
+
.. code-block:: none
|
| 185 |
+
|
| 186 |
+
[p]imgurcreds
|
| 187 |
+
|
| 188 |
+
**Description**
|
| 189 |
+
|
| 190 |
+
Explains how to set Imgur API tokens.
|
| 191 |
+
|
| 192 |
+
**Getting your API key**
|
| 193 |
+
|
| 194 |
+
1. Login to (or create) an Imgur account.
|
| 195 |
+
2. Visit `this page <https://api.imgur.com/oauth2/addclient>`__.
|
| 196 |
+
3. Add an app name for your application, for example 'Red'.
|
| 197 |
+
4. Select 'Anonymous usage without user authorization' for the auth type.
|
| 198 |
+
5. Set the authorization callback URL to ``https://localhost``
|
| 199 |
+
6. Leave the app website blank.
|
| 200 |
+
7. Enter a valid email address and a description.
|
| 201 |
+
8. Check the captcha box and click next.
|
| 202 |
+
9. Your Client ID will be on the next page.
|
| 203 |
+
10. In Discord, run the following command::
|
| 204 |
+
|
| 205 |
+
[p]set api imgur client_id <your_client_id_here>
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/mod.rst
ADDED
|
@@ -0,0 +1,763 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _mod:
|
| 2 |
+
|
| 3 |
+
===
|
| 4 |
+
Mod
|
| 5 |
+
===
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the mod cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load mod
|
| 15 |
+
|
| 16 |
+
.. _mod-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
A range of highly customizable moderation tools used to protect your
|
| 23 |
+
guild from users who cannot follow the rules.
|
| 24 |
+
|
| 25 |
+
|
| 26 |
+
.. _mod-commands:
|
| 27 |
+
|
| 28 |
+
--------
|
| 29 |
+
Commands
|
| 30 |
+
--------
|
| 31 |
+
|
| 32 |
+
.. _mod-command-ban:
|
| 33 |
+
|
| 34 |
+
^^^
|
| 35 |
+
ban
|
| 36 |
+
^^^
|
| 37 |
+
|
| 38 |
+
.. note:: |admin-lock|
|
| 39 |
+
|
| 40 |
+
**Syntax**
|
| 41 |
+
|
| 42 |
+
.. code-block:: none
|
| 43 |
+
|
| 44 |
+
[p]ban <user> [days] [reason]
|
| 45 |
+
|
| 46 |
+
**Description**
|
| 47 |
+
|
| 48 |
+
Ban a user from this server and optionally delete days of messages.
|
| 49 |
+
|
| 50 |
+
``days`` is the amount of days of messages to cleanup on ban.
|
| 51 |
+
|
| 52 |
+
**Arguments**
|
| 53 |
+
|
| 54 |
+
* ``<user>``: The user to ban. |user-input|
|
| 55 |
+
* ``[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.
|
| 56 |
+
* ``[reason]``: The reason why the user was banned (optional).
|
| 57 |
+
|
| 58 |
+
**Example Usage**
|
| 59 |
+
|
| 60 |
+
* ``[p]ban 428675506947227648 7 Continued to spam after told to stop.``
|
| 61 |
+
This will ban the user with ID 428675506947227648 and it will delete 7 days worth of messages.
|
| 62 |
+
* ``[p]ban @Twentysix 7 Continued to spam after told to stop.``
|
| 63 |
+
This will ban Twentysix and it will delete 7 days worth of messages.
|
| 64 |
+
|
| 65 |
+
A user ID should be provided if the user is not a member of this server.
|
| 66 |
+
If days is not a number, it's treated as the first word of the reason.
|
| 67 |
+
Minimum 0 days, maximum 7. If not specified, the defaultdays setting will be used instead.
|
| 68 |
+
|
| 69 |
+
.. _mod-command-kick:
|
| 70 |
+
|
| 71 |
+
^^^^
|
| 72 |
+
kick
|
| 73 |
+
^^^^
|
| 74 |
+
|
| 75 |
+
.. note:: |admin-lock|
|
| 76 |
+
|
| 77 |
+
**Syntax**
|
| 78 |
+
|
| 79 |
+
.. code-block:: none
|
| 80 |
+
|
| 81 |
+
[p]kick <member> [reason]
|
| 82 |
+
|
| 83 |
+
**Description**
|
| 84 |
+
|
| 85 |
+
Kick a user.
|
| 86 |
+
|
| 87 |
+
**Arguments**
|
| 88 |
+
|
| 89 |
+
* ``<member>``: The member to kick. |member-input|
|
| 90 |
+
* ``[reason]``: The reason why the user was kicked (optional).
|
| 91 |
+
|
| 92 |
+
**Example Usage**
|
| 93 |
+
|
| 94 |
+
* ``[p]kick 428675506947227648 wanted to be kicked.``
|
| 95 |
+
This will kick the user with ID 428675506947227648 from the server.
|
| 96 |
+
* ``[p]kick @Twentysix wanted to be kicked.``
|
| 97 |
+
This will kick Twentysix from the server.
|
| 98 |
+
|
| 99 |
+
If a reason is specified, it will be the reason that shows up
|
| 100 |
+
in the audit log.
|
| 101 |
+
|
| 102 |
+
.. _mod-command-massban:
|
| 103 |
+
|
| 104 |
+
^^^^^^^
|
| 105 |
+
massban
|
| 106 |
+
^^^^^^^
|
| 107 |
+
|
| 108 |
+
.. note:: |admin-lock|
|
| 109 |
+
|
| 110 |
+
**Syntax**
|
| 111 |
+
|
| 112 |
+
.. code-block:: none
|
| 113 |
+
|
| 114 |
+
[p]massban <user_ids...> [days] [reason]
|
| 115 |
+
|
| 116 |
+
.. tip:: Alias: ``hackban``
|
| 117 |
+
|
| 118 |
+
**Description**
|
| 119 |
+
|
| 120 |
+
Mass bans user(s) from the server.
|
| 121 |
+
|
| 122 |
+
**Arguments**
|
| 123 |
+
|
| 124 |
+
* ``<user_ids...>``: The users to ban. This must be a list of user IDs separated by spaces.
|
| 125 |
+
* ``[days]``: The amount of days of messages to cleanup on massban.
|
| 126 |
+
* ``[reason]``: The reason why these users were banned.
|
| 127 |
+
|
| 128 |
+
**Example Usage**
|
| 129 |
+
|
| 130 |
+
* ``[p]massban 345628097929936898 57287406247743488 7 they broke all rules.``
|
| 131 |
+
This will ban all the added userids and delete 7 days worth of their messages.
|
| 132 |
+
|
| 133 |
+
.. _mod-command-modset:
|
| 134 |
+
|
| 135 |
+
^^^^^^
|
| 136 |
+
modset
|
| 137 |
+
^^^^^^
|
| 138 |
+
|
| 139 |
+
.. note:: |guildowner-lock|
|
| 140 |
+
|
| 141 |
+
**Syntax**
|
| 142 |
+
|
| 143 |
+
.. code-block:: none
|
| 144 |
+
|
| 145 |
+
[p]modset
|
| 146 |
+
|
| 147 |
+
**Description**
|
| 148 |
+
|
| 149 |
+
Manage server administration settings.
|
| 150 |
+
|
| 151 |
+
.. _mod-command-modset-defaultdays:
|
| 152 |
+
|
| 153 |
+
""""""""""""""""""
|
| 154 |
+
modset defaultdays
|
| 155 |
+
""""""""""""""""""
|
| 156 |
+
|
| 157 |
+
**Syntax**
|
| 158 |
+
|
| 159 |
+
.. code-block:: none
|
| 160 |
+
|
| 161 |
+
[p]modset defaultdays [days=0]
|
| 162 |
+
|
| 163 |
+
**Description**
|
| 164 |
+
|
| 165 |
+
Set the default number of days worth of messages to be deleted when a user is banned.
|
| 166 |
+
|
| 167 |
+
The number of days must be between 0 and 7.
|
| 168 |
+
|
| 169 |
+
**Arguments**
|
| 170 |
+
|
| 171 |
+
* ``[days=0]``: The default number of days of messages to be deleted when a user is banned.
|
| 172 |
+
|
| 173 |
+
.. note:: This value must be between 0 and 7.
|
| 174 |
+
|
| 175 |
+
.. _mod-command-modset-defaultduration:
|
| 176 |
+
|
| 177 |
+
""""""""""""""""""""""
|
| 178 |
+
modset defaultduration
|
| 179 |
+
""""""""""""""""""""""
|
| 180 |
+
|
| 181 |
+
**Syntax**
|
| 182 |
+
|
| 183 |
+
.. code-block:: none
|
| 184 |
+
|
| 185 |
+
[p]modset defaultduration <duration>
|
| 186 |
+
|
| 187 |
+
**Description**
|
| 188 |
+
|
| 189 |
+
Set the default time to be used when a user is tempbanned.
|
| 190 |
+
|
| 191 |
+
Accepts: seconds, minutes, hours, days, weeks
|
| 192 |
+
|
| 193 |
+
**Arguments**
|
| 194 |
+
|
| 195 |
+
* ``<duration>``: The default duration for when a user is temporarily banned. Accepts seconds, minutes, hours, days or weeks.
|
| 196 |
+
|
| 197 |
+
**Example Usage**
|
| 198 |
+
|
| 199 |
+
* ``[p]modset defaultduration 7d12h10m``
|
| 200 |
+
* ``[p]modset defaultduration 7 days 12 hours 10 minutes``
|
| 201 |
+
|
| 202 |
+
.. _mod-command-modset-deletenames:
|
| 203 |
+
|
| 204 |
+
""""""""""""""""""
|
| 205 |
+
modset deletenames
|
| 206 |
+
""""""""""""""""""
|
| 207 |
+
|
| 208 |
+
.. note:: |owner-lock|
|
| 209 |
+
|
| 210 |
+
**Syntax**
|
| 211 |
+
|
| 212 |
+
.. code-block:: none
|
| 213 |
+
|
| 214 |
+
[p]modset deletenames [confirmation=False]
|
| 215 |
+
|
| 216 |
+
**Description**
|
| 217 |
+
|
| 218 |
+
Delete all stored usernames and nicknames.
|
| 219 |
+
|
| 220 |
+
**Arguments**
|
| 221 |
+
|
| 222 |
+
- ``<confirmation>``: Whether to delete all stored usernames and nicknames. |bool-input|
|
| 223 |
+
|
| 224 |
+
.. _mod-command-modset-deleterepeats:
|
| 225 |
+
|
| 226 |
+
""""""""""""""""""""
|
| 227 |
+
modset deleterepeats
|
| 228 |
+
""""""""""""""""""""
|
| 229 |
+
|
| 230 |
+
**Syntax**
|
| 231 |
+
|
| 232 |
+
.. code-block:: none
|
| 233 |
+
|
| 234 |
+
[p]modset deleterepeats [repeats]
|
| 235 |
+
|
| 236 |
+
**Description**
|
| 237 |
+
|
| 238 |
+
Enable auto-deletion of repeated messages.
|
| 239 |
+
|
| 240 |
+
**Arguments**
|
| 241 |
+
|
| 242 |
+
* ``[repeats]``: The number of repeated messages needed before further messages are deleted.
|
| 243 |
+
|
| 244 |
+
.. note:: Must be between 2 and 20. Set to -1 to disable this feature.
|
| 245 |
+
|
| 246 |
+
.. _mod-command-modset-dm:
|
| 247 |
+
|
| 248 |
+
"""""""""
|
| 249 |
+
modset dm
|
| 250 |
+
"""""""""
|
| 251 |
+
|
| 252 |
+
**Syntax**
|
| 253 |
+
|
| 254 |
+
.. code-block:: none
|
| 255 |
+
|
| 256 |
+
[p]modset dm [enabled]
|
| 257 |
+
|
| 258 |
+
**Description**
|
| 259 |
+
|
| 260 |
+
Toggle whether a message should be sent to a user when they are kicked/banned.
|
| 261 |
+
|
| 262 |
+
If this option is enabled, the bot will attempt to DM the user with the guild name
|
| 263 |
+
and reason as to why they were kicked/banned.
|
| 264 |
+
|
| 265 |
+
**Arguments**
|
| 266 |
+
|
| 267 |
+
* ``[enabled]``: Whether a message should be sent to a user when they are kicked/banned. |bool-input|
|
| 268 |
+
|
| 269 |
+
.. _mod-command-modset-hierarchy:
|
| 270 |
+
|
| 271 |
+
""""""""""""""""
|
| 272 |
+
modset hierarchy
|
| 273 |
+
""""""""""""""""
|
| 274 |
+
|
| 275 |
+
**Syntax**
|
| 276 |
+
|
| 277 |
+
.. code-block:: none
|
| 278 |
+
|
| 279 |
+
[p]modset hierarchy
|
| 280 |
+
|
| 281 |
+
**Description**
|
| 282 |
+
|
| 283 |
+
Toggle role hierarchy check for mods and admins.
|
| 284 |
+
|
| 285 |
+
.. warning:: Disabling this setting will allow mods to take actions on users above them in the role hierarchy!
|
| 286 |
+
|
| 287 |
+
This is enabled by default.
|
| 288 |
+
|
| 289 |
+
.. _mod-command-modset-mentionspam:
|
| 290 |
+
|
| 291 |
+
""""""""""""""""""
|
| 292 |
+
modset mentionspam
|
| 293 |
+
""""""""""""""""""
|
| 294 |
+
|
| 295 |
+
**Syntax**
|
| 296 |
+
|
| 297 |
+
.. code-block:: none
|
| 298 |
+
|
| 299 |
+
[p]modset mentionspam
|
| 300 |
+
|
| 301 |
+
**Description**
|
| 302 |
+
|
| 303 |
+
Manage the automoderation settings for mentionspam.
|
| 304 |
+
|
| 305 |
+
.. _mod-command-modset-mentionspam-ban:
|
| 306 |
+
|
| 307 |
+
""""""""""""""""""""""
|
| 308 |
+
modset mentionspam ban
|
| 309 |
+
""""""""""""""""""""""
|
| 310 |
+
|
| 311 |
+
**Syntax**
|
| 312 |
+
|
| 313 |
+
.. code-block:: none
|
| 314 |
+
|
| 315 |
+
[p]modset mentionspam ban <max_mentions>
|
| 316 |
+
|
| 317 |
+
**Description**
|
| 318 |
+
|
| 319 |
+
Set the autoban conditions for mention spam.
|
| 320 |
+
|
| 321 |
+
Users will be banned if they send any message which contains more than
|
| 322 |
+
``<max_mentions>`` mentions.
|
| 323 |
+
|
| 324 |
+
**Arguments**
|
| 325 |
+
|
| 326 |
+
* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
|
| 327 |
+
|
| 328 |
+
.. _mod-command-modset-mentionspam-kick:
|
| 329 |
+
|
| 330 |
+
"""""""""""""""""""""""
|
| 331 |
+
modset mentionspam kick
|
| 332 |
+
"""""""""""""""""""""""
|
| 333 |
+
|
| 334 |
+
**Syntax**
|
| 335 |
+
|
| 336 |
+
.. code-block:: none
|
| 337 |
+
|
| 338 |
+
[p]modset mentionspam kick <max_mentions>
|
| 339 |
+
|
| 340 |
+
**Description**
|
| 341 |
+
|
| 342 |
+
Set the autokick conditions for mention spam.
|
| 343 |
+
|
| 344 |
+
Users will be kicked if they send any message which contains more than
|
| 345 |
+
``<max_mentions>`` mentions.
|
| 346 |
+
|
| 347 |
+
**Arguments**
|
| 348 |
+
|
| 349 |
+
* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
|
| 350 |
+
|
| 351 |
+
.. _mod-command-modset-mentionspam-strict:
|
| 352 |
+
|
| 353 |
+
"""""""""""""""""""""""""
|
| 354 |
+
modset mentionspam strict
|
| 355 |
+
"""""""""""""""""""""""""
|
| 356 |
+
|
| 357 |
+
**Syntax**
|
| 358 |
+
|
| 359 |
+
.. code-block:: none
|
| 360 |
+
|
| 361 |
+
[p]modset mentionspam strict [enabled]
|
| 362 |
+
|
| 363 |
+
**Description**
|
| 364 |
+
|
| 365 |
+
Setting to account for duplicate mentions.
|
| 366 |
+
|
| 367 |
+
If enabled all mentions will count including duplicated mentions.
|
| 368 |
+
If disabled only unique mentions will count.
|
| 369 |
+
|
| 370 |
+
Use this command without any parameter to see the current setting.
|
| 371 |
+
|
| 372 |
+
**Arguments**
|
| 373 |
+
|
| 374 |
+
* ``[enabled]``: Whether all mentions will count, including duplicated mentions. |bool-input|
|
| 375 |
+
|
| 376 |
+
.. _mod-command-modset-mentionspam-warn:
|
| 377 |
+
|
| 378 |
+
"""""""""""""""""""""""
|
| 379 |
+
modset mentionspam warn
|
| 380 |
+
"""""""""""""""""""""""
|
| 381 |
+
|
| 382 |
+
**Syntax**
|
| 383 |
+
|
| 384 |
+
.. code-block:: none
|
| 385 |
+
|
| 386 |
+
[p]modset mentionspam warn <max_mentions>
|
| 387 |
+
|
| 388 |
+
**Description**
|
| 389 |
+
|
| 390 |
+
Sets the autowarn conditions for mention spam.
|
| 391 |
+
|
| 392 |
+
Users will be warned if they send any messages which contain more than
|
| 393 |
+
``<max_mentions>`` mentions.
|
| 394 |
+
|
| 395 |
+
**Arguments**
|
| 396 |
+
|
| 397 |
+
* ``<max_mentions>``: Must be 0 or greater. Set to 0 to disable this feature.
|
| 398 |
+
|
| 399 |
+
.. _mod-command-modset-reinvite:
|
| 400 |
+
|
| 401 |
+
"""""""""""""""
|
| 402 |
+
modset reinvite
|
| 403 |
+
"""""""""""""""
|
| 404 |
+
|
| 405 |
+
**Syntax**
|
| 406 |
+
|
| 407 |
+
.. code-block:: none
|
| 408 |
+
|
| 409 |
+
[p]modset reinvite
|
| 410 |
+
|
| 411 |
+
**Description**
|
| 412 |
+
|
| 413 |
+
Toggle whether an invite will be sent to a user when unbanned.
|
| 414 |
+
|
| 415 |
+
If this is True, the bot will attempt to create and send a single-use invite
|
| 416 |
+
to the newly-unbanned user.
|
| 417 |
+
|
| 418 |
+
.. _mod-command-modset-showsettings:
|
| 419 |
+
|
| 420 |
+
"""""""""""""""""""
|
| 421 |
+
modset showsettings
|
| 422 |
+
"""""""""""""""""""
|
| 423 |
+
|
| 424 |
+
**Syntax**
|
| 425 |
+
|
| 426 |
+
.. code-block:: none
|
| 427 |
+
|
| 428 |
+
[p]modset showsettings
|
| 429 |
+
|
| 430 |
+
**Description**
|
| 431 |
+
|
| 432 |
+
Show the current server administration settings.
|
| 433 |
+
|
| 434 |
+
.. _mod-command-modset-trackallnames:
|
| 435 |
+
|
| 436 |
+
""""""""""""""""""""
|
| 437 |
+
modset trackallnames
|
| 438 |
+
""""""""""""""""""""
|
| 439 |
+
|
| 440 |
+
.. note:: |owner-lock|
|
| 441 |
+
|
| 442 |
+
**Syntax**
|
| 443 |
+
|
| 444 |
+
.. code-block:: none
|
| 445 |
+
|
| 446 |
+
[p]modset trackallnames [enabled]
|
| 447 |
+
|
| 448 |
+
**Description**
|
| 449 |
+
|
| 450 |
+
Toggle whether all name changes should be tracked.
|
| 451 |
+
|
| 452 |
+
Toggling this off also overrides the tracknicknames setting.
|
| 453 |
+
|
| 454 |
+
**Arguments**
|
| 455 |
+
|
| 456 |
+
* ``[enabled]``: Whether all name changes should be tracked. |bool-input|
|
| 457 |
+
|
| 458 |
+
.. _mod-command-modset-tracknicknames:
|
| 459 |
+
|
| 460 |
+
"""""""""""""""""""""
|
| 461 |
+
modset tracknicknames
|
| 462 |
+
"""""""""""""""""""""
|
| 463 |
+
|
| 464 |
+
**Syntax**
|
| 465 |
+
|
| 466 |
+
.. code-block:: none
|
| 467 |
+
|
| 468 |
+
[p]modset tracknicknames [enabled]
|
| 469 |
+
|
| 470 |
+
**Description**
|
| 471 |
+
|
| 472 |
+
Toggle whether nickname changes should be tracked.
|
| 473 |
+
|
| 474 |
+
This setting will be overridden if trackallnames is disabled.
|
| 475 |
+
|
| 476 |
+
**Arguments**
|
| 477 |
+
|
| 478 |
+
* ``[enabled]``: Whether all nickname changes should be tracked. |bool-input|
|
| 479 |
+
|
| 480 |
+
.. _mod-command-movedeletedelay:
|
| 481 |
+
|
| 482 |
+
^^^^^^^^^^^^^^^
|
| 483 |
+
movedeletedelay
|
| 484 |
+
^^^^^^^^^^^^^^^
|
| 485 |
+
|
| 486 |
+
.. note:: |owner-lock|
|
| 487 |
+
|
| 488 |
+
**Syntax**
|
| 489 |
+
|
| 490 |
+
.. code-block:: none
|
| 491 |
+
|
| 492 |
+
[p]movedeletedelay
|
| 493 |
+
|
| 494 |
+
**Description**
|
| 495 |
+
|
| 496 |
+
Move deletedelay settings to core
|
| 497 |
+
|
| 498 |
+
.. _mod-command-moveignoredchannels:
|
| 499 |
+
|
| 500 |
+
^^^^^^^^^^^^^^^^^^^
|
| 501 |
+
moveignoredchannels
|
| 502 |
+
^^^^^^^^^^^^^^^^^^^
|
| 503 |
+
|
| 504 |
+
.. note:: |owner-lock|
|
| 505 |
+
|
| 506 |
+
**Syntax**
|
| 507 |
+
|
| 508 |
+
.. code-block:: none
|
| 509 |
+
|
| 510 |
+
[p]moveignoredchannels
|
| 511 |
+
|
| 512 |
+
**Description**
|
| 513 |
+
|
| 514 |
+
Move ignored channels and servers to core
|
| 515 |
+
|
| 516 |
+
.. _mod-command-names:
|
| 517 |
+
|
| 518 |
+
^^^^^
|
| 519 |
+
names
|
| 520 |
+
^^^^^
|
| 521 |
+
|
| 522 |
+
**Syntax**
|
| 523 |
+
|
| 524 |
+
.. code-block:: none
|
| 525 |
+
|
| 526 |
+
[p]names <member>
|
| 527 |
+
|
| 528 |
+
**Description**
|
| 529 |
+
|
| 530 |
+
Show previous names and nicknames of a member.
|
| 531 |
+
|
| 532 |
+
**Arguments**
|
| 533 |
+
|
| 534 |
+
* ``<member>``: |member-input|
|
| 535 |
+
|
| 536 |
+
.. _mod-command-rename:
|
| 537 |
+
|
| 538 |
+
^^^^^^
|
| 539 |
+
rename
|
| 540 |
+
^^^^^^
|
| 541 |
+
|
| 542 |
+
.. note:: |admin-lock|
|
| 543 |
+
|
| 544 |
+
**Syntax**
|
| 545 |
+
|
| 546 |
+
.. code-block:: none
|
| 547 |
+
|
| 548 |
+
[p]rename <member> [nickname]
|
| 549 |
+
|
| 550 |
+
**Description**
|
| 551 |
+
|
| 552 |
+
Change a member's nickname.
|
| 553 |
+
|
| 554 |
+
Leaving the nickname empty will remove it.
|
| 555 |
+
|
| 556 |
+
**Arguments**
|
| 557 |
+
|
| 558 |
+
* ``<member>``: |member-input|
|
| 559 |
+
* ``[nickname]``: The new nickname for the member.
|
| 560 |
+
|
| 561 |
+
.. _mod-command-slowmode:
|
| 562 |
+
|
| 563 |
+
^^^^^^^^
|
| 564 |
+
slowmode
|
| 565 |
+
^^^^^^^^
|
| 566 |
+
|
| 567 |
+
.. note:: |admin-lock|
|
| 568 |
+
|
| 569 |
+
**Syntax**
|
| 570 |
+
|
| 571 |
+
.. code-block:: none
|
| 572 |
+
|
| 573 |
+
[p]slowmode [interval=0:00:00]
|
| 574 |
+
|
| 575 |
+
**Description**
|
| 576 |
+
|
| 577 |
+
Changes thread's or channel's slowmode setting.
|
| 578 |
+
|
| 579 |
+
Interval can be anything from 0 seconds to 6 hours.
|
| 580 |
+
Use without parameters to disable.
|
| 581 |
+
|
| 582 |
+
**Arguments**
|
| 583 |
+
|
| 584 |
+
* ``[interval=0:00:00]``: The time for the thread's/channel's slowmode settings.
|
| 585 |
+
|
| 586 |
+
.. note::
|
| 587 |
+
Interval can be anything from 0 seconds to 6 hours.
|
| 588 |
+
Use without parameters to disable.
|
| 589 |
+
|
| 590 |
+
.. _mod-command-softban:
|
| 591 |
+
|
| 592 |
+
^^^^^^^
|
| 593 |
+
softban
|
| 594 |
+
^^^^^^^
|
| 595 |
+
|
| 596 |
+
.. note:: |admin-lock|
|
| 597 |
+
|
| 598 |
+
**Syntax**
|
| 599 |
+
|
| 600 |
+
.. code-block:: none
|
| 601 |
+
|
| 602 |
+
[p]softban <member> [reason]
|
| 603 |
+
|
| 604 |
+
**Description**
|
| 605 |
+
|
| 606 |
+
Kick a member and delete 1 day's worth of their messages.
|
| 607 |
+
|
| 608 |
+
**Arguments**
|
| 609 |
+
|
| 610 |
+
* ``<member>``: The member to softban. |member-input-quotes|
|
| 611 |
+
* ``[reason]``: Reason for the kick (optional).
|
| 612 |
+
|
| 613 |
+
.. _mod-command-tempban:
|
| 614 |
+
|
| 615 |
+
^^^^^^^
|
| 616 |
+
tempban
|
| 617 |
+
^^^^^^^
|
| 618 |
+
|
| 619 |
+
.. note:: |admin-lock|
|
| 620 |
+
|
| 621 |
+
**Syntax**
|
| 622 |
+
|
| 623 |
+
.. code-block:: none
|
| 624 |
+
|
| 625 |
+
[p]tempban <member> [duration] [days] [reason]
|
| 626 |
+
|
| 627 |
+
**Description**
|
| 628 |
+
|
| 629 |
+
Temporarily ban a user from this server.
|
| 630 |
+
|
| 631 |
+
**Arguments**
|
| 632 |
+
|
| 633 |
+
* ``<member>``: The member to temporarily ban. |member-input-quotes|
|
| 634 |
+
* ``[duration]``: The amount of time the user should be banned for.
|
| 635 |
+
* ``[days]``: The amount of days of messages to cleanup on tempban.
|
| 636 |
+
* ``[reason]``: The reason for the tempban (optional).
|
| 637 |
+
|
| 638 |
+
**Example Usage**
|
| 639 |
+
|
| 640 |
+
* ``[p]tempban @Twentysix Because I say so``
|
| 641 |
+
This will ban Twentysix for the default amount of time set by an administrator.
|
| 642 |
+
* ``[p]tempban @Twentysix 15m You need a timeout``
|
| 643 |
+
This will ban Twentysix for 15 minutes.
|
| 644 |
+
* ``[p]tempban 428675506947227648 1d2h15m 5 Evil person``
|
| 645 |
+
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.
|
| 646 |
+
|
| 647 |
+
.. _mod-command-unban:
|
| 648 |
+
|
| 649 |
+
^^^^^
|
| 650 |
+
unban
|
| 651 |
+
^^^^^
|
| 652 |
+
|
| 653 |
+
.. note:: |admin-lock|
|
| 654 |
+
|
| 655 |
+
**Syntax**
|
| 656 |
+
|
| 657 |
+
.. code-block:: none
|
| 658 |
+
|
| 659 |
+
[p]unban <user_id> [reason]
|
| 660 |
+
|
| 661 |
+
**Description**
|
| 662 |
+
|
| 663 |
+
Unban a user from this server.
|
| 664 |
+
|
| 665 |
+
**Arguments**
|
| 666 |
+
|
| 667 |
+
* ``<user_id>``: |user-input|
|
| 668 |
+
* ``[reason]``: The reason for the unban (optional).
|
| 669 |
+
|
| 670 |
+
.. _mod-command-userinfo:
|
| 671 |
+
|
| 672 |
+
^^^^^^^^
|
| 673 |
+
userinfo
|
| 674 |
+
^^^^^^^^
|
| 675 |
+
|
| 676 |
+
**Syntax**
|
| 677 |
+
|
| 678 |
+
.. code-block:: none
|
| 679 |
+
|
| 680 |
+
[p]userinfo [member]
|
| 681 |
+
|
| 682 |
+
**Description**
|
| 683 |
+
|
| 684 |
+
Show information about a user.
|
| 685 |
+
|
| 686 |
+
This includes fields for status, discord join date, server
|
| 687 |
+
join date, voice state and previous names/nicknames.
|
| 688 |
+
|
| 689 |
+
If the user has no roles, previous names or previous nicknames,
|
| 690 |
+
these fields will be omitted.
|
| 691 |
+
|
| 692 |
+
**Arguments**
|
| 693 |
+
|
| 694 |
+
* ``[member]``: |member-input|
|
| 695 |
+
|
| 696 |
+
.. _mod-command-voiceban:
|
| 697 |
+
|
| 698 |
+
^^^^^^^^
|
| 699 |
+
voiceban
|
| 700 |
+
^^^^^^^^
|
| 701 |
+
|
| 702 |
+
.. note:: |admin-lock|
|
| 703 |
+
|
| 704 |
+
**Syntax**
|
| 705 |
+
|
| 706 |
+
.. code-block:: none
|
| 707 |
+
|
| 708 |
+
[p]voiceban <member> [reason]
|
| 709 |
+
|
| 710 |
+
**Description**
|
| 711 |
+
|
| 712 |
+
Ban a user from speaking and listening in the server's voice channels.
|
| 713 |
+
|
| 714 |
+
**Arguments**
|
| 715 |
+
|
| 716 |
+
* ``<member>``: The member to ban from voice. |member-input|
|
| 717 |
+
* ``[reason]``: The reason for the voiceban (optional).
|
| 718 |
+
|
| 719 |
+
.. _mod-command-voicekick:
|
| 720 |
+
|
| 721 |
+
^^^^^^^^^
|
| 722 |
+
voicekick
|
| 723 |
+
^^^^^^^^^
|
| 724 |
+
|
| 725 |
+
.. note:: |mod-lock|
|
| 726 |
+
|
| 727 |
+
**Syntax**
|
| 728 |
+
|
| 729 |
+
.. code-block:: none
|
| 730 |
+
|
| 731 |
+
[p]voicekick <member> [reason]
|
| 732 |
+
|
| 733 |
+
**Description**
|
| 734 |
+
|
| 735 |
+
Kick a member from a voice channel.
|
| 736 |
+
|
| 737 |
+
**Arguments**
|
| 738 |
+
|
| 739 |
+
* ``<member>``: |member-input|
|
| 740 |
+
* ``[reason]``: The reason for the voicekick (optional).
|
| 741 |
+
|
| 742 |
+
.. _mod-command-voiceunban:
|
| 743 |
+
|
| 744 |
+
^^^^^^^^^^
|
| 745 |
+
voiceunban
|
| 746 |
+
^^^^^^^^^^
|
| 747 |
+
|
| 748 |
+
.. note:: |admin-lock|
|
| 749 |
+
|
| 750 |
+
**Syntax**
|
| 751 |
+
|
| 752 |
+
.. code-block:: none
|
| 753 |
+
|
| 754 |
+
[p]voiceunban <member> [reason]
|
| 755 |
+
|
| 756 |
+
**Description**
|
| 757 |
+
|
| 758 |
+
Unban a user from speaking and listening in the server's voice channels.
|
| 759 |
+
|
| 760 |
+
**Arguments**
|
| 761 |
+
|
| 762 |
+
* ``<member>``: The member to unban from voice. |member-input-quotes|
|
| 763 |
+
* ``[reason]``: The reason for the voiceunban (optional).
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/modlog.rst
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _modlog:
|
| 2 |
+
|
| 3 |
+
======
|
| 4 |
+
ModLog
|
| 5 |
+
======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the modlog cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load modlog
|
| 15 |
+
|
| 16 |
+
.. _modlog-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Browse and manage modlog cases.
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
.. _modlog-commands:
|
| 26 |
+
|
| 27 |
+
--------
|
| 28 |
+
Commands
|
| 29 |
+
--------
|
| 30 |
+
|
| 31 |
+
.. _modlog-command-case:
|
| 32 |
+
|
| 33 |
+
^^^^
|
| 34 |
+
case
|
| 35 |
+
^^^^
|
| 36 |
+
|
| 37 |
+
**Syntax**
|
| 38 |
+
|
| 39 |
+
.. code-block:: none
|
| 40 |
+
|
| 41 |
+
[p]case <number>
|
| 42 |
+
|
| 43 |
+
**Description**
|
| 44 |
+
|
| 45 |
+
Show the specified case.
|
| 46 |
+
|
| 47 |
+
**Arguments**
|
| 48 |
+
|
| 49 |
+
* ``<case>``: The case number to get information for.
|
| 50 |
+
|
| 51 |
+
.. _modlog-command-casesfor:
|
| 52 |
+
|
| 53 |
+
^^^^^^^^
|
| 54 |
+
casesfor
|
| 55 |
+
^^^^^^^^
|
| 56 |
+
|
| 57 |
+
**Syntax**
|
| 58 |
+
|
| 59 |
+
.. code-block:: none
|
| 60 |
+
|
| 61 |
+
[p]casesfor <member>
|
| 62 |
+
|
| 63 |
+
**Description**
|
| 64 |
+
|
| 65 |
+
Display cases for the specified member.
|
| 66 |
+
|
| 67 |
+
**Arguments**
|
| 68 |
+
|
| 69 |
+
* ``<member>``: The member to get cases for. |member-input|
|
| 70 |
+
|
| 71 |
+
.. _modlog-command-listcases:
|
| 72 |
+
|
| 73 |
+
^^^^^^^^^
|
| 74 |
+
listcases
|
| 75 |
+
^^^^^^^^^
|
| 76 |
+
|
| 77 |
+
**Syntax**
|
| 78 |
+
|
| 79 |
+
.. code-block:: none
|
| 80 |
+
|
| 81 |
+
[p]listcases <member>
|
| 82 |
+
|
| 83 |
+
**Description**
|
| 84 |
+
|
| 85 |
+
List cases for the specified member.
|
| 86 |
+
|
| 87 |
+
**Arguments**
|
| 88 |
+
|
| 89 |
+
* ``<member>``: The member to get cases for. |member-input|
|
| 90 |
+
|
| 91 |
+
.. _modlog-command-reason:
|
| 92 |
+
|
| 93 |
+
^^^^^^
|
| 94 |
+
reason
|
| 95 |
+
^^^^^^
|
| 96 |
+
|
| 97 |
+
**Syntax**
|
| 98 |
+
|
| 99 |
+
.. code-block:: none
|
| 100 |
+
|
| 101 |
+
[p]reason [case] <reason>
|
| 102 |
+
|
| 103 |
+
**Description**
|
| 104 |
+
|
| 105 |
+
Specify a reason for a modlog case.
|
| 106 |
+
|
| 107 |
+
Please note that you can only edit cases you are
|
| 108 |
+
the owner of unless you are a mod, admin or server owner.
|
| 109 |
+
|
| 110 |
+
**Arguments**
|
| 111 |
+
|
| 112 |
+
* ``[case]``: The case number to update the reason for.
|
| 113 |
+
* ``<reason>``: The new reason for the specified case.
|
| 114 |
+
|
| 115 |
+
.. note:: If no case number is specified, the latest case will be used.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/mutes.rst
ADDED
|
@@ -0,0 +1,410 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _mutes:
|
| 2 |
+
|
| 3 |
+
=====
|
| 4 |
+
Mutes
|
| 5 |
+
=====
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the mutes cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load mutes
|
| 15 |
+
|
| 16 |
+
.. _mutes-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Mute users temporarily or indefinitely.
|
| 23 |
+
|
| 24 |
+
.. _mutes-commands:
|
| 25 |
+
|
| 26 |
+
--------
|
| 27 |
+
Commands
|
| 28 |
+
--------
|
| 29 |
+
|
| 30 |
+
.. _mutes-command-activemutes:
|
| 31 |
+
|
| 32 |
+
^^^^^^^^^^^
|
| 33 |
+
activemutes
|
| 34 |
+
^^^^^^^^^^^
|
| 35 |
+
|
| 36 |
+
.. note:: |mod-lock|
|
| 37 |
+
|
| 38 |
+
**Syntax**
|
| 39 |
+
|
| 40 |
+
.. code-block:: none
|
| 41 |
+
|
| 42 |
+
[p]activemutes
|
| 43 |
+
|
| 44 |
+
**Description**
|
| 45 |
+
|
| 46 |
+
Displays active mutes on this server.
|
| 47 |
+
|
| 48 |
+
.. _mutes-command-mute:
|
| 49 |
+
|
| 50 |
+
^^^^
|
| 51 |
+
mute
|
| 52 |
+
^^^^
|
| 53 |
+
|
| 54 |
+
.. note:: |mod-lock|
|
| 55 |
+
|
| 56 |
+
**Syntax**
|
| 57 |
+
|
| 58 |
+
.. code-block:: none
|
| 59 |
+
|
| 60 |
+
[p]mute <users...> [time_and_reason]
|
| 61 |
+
|
| 62 |
+
**Description**
|
| 63 |
+
|
| 64 |
+
Mute users.
|
| 65 |
+
|
| 66 |
+
Examples:
|
| 67 |
+
|
| 68 |
+
* ``[p]mute @member1 @member2 spam 5 hours``
|
| 69 |
+
* ``[p]mute @member1 3 days``
|
| 70 |
+
|
| 71 |
+
**Arguments**
|
| 72 |
+
|
| 73 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 74 |
+
* ``[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.
|
| 75 |
+
|
| 76 |
+
.. _mutes-command-mutechannel:
|
| 77 |
+
|
| 78 |
+
^^^^^^^^^^^
|
| 79 |
+
mutechannel
|
| 80 |
+
^^^^^^^^^^^
|
| 81 |
+
|
| 82 |
+
.. note:: |mod-lock|
|
| 83 |
+
|
| 84 |
+
**Syntax**
|
| 85 |
+
|
| 86 |
+
.. code-block:: none
|
| 87 |
+
|
| 88 |
+
[p]mutechannel <users...> [time_and_reason]
|
| 89 |
+
|
| 90 |
+
.. tip:: Alias: ``channelmute``
|
| 91 |
+
|
| 92 |
+
**Description**
|
| 93 |
+
|
| 94 |
+
Mute a user in the current text channel (or in the parent of the current thread).
|
| 95 |
+
|
| 96 |
+
Examples:
|
| 97 |
+
|
| 98 |
+
* ``[p]mutechannel @member1 @member2 spam 5 hours``
|
| 99 |
+
* ``[p]mutechannel @member1 3 days``
|
| 100 |
+
|
| 101 |
+
**Arguments**
|
| 102 |
+
|
| 103 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 104 |
+
* ``[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.
|
| 105 |
+
|
| 106 |
+
.. _mutes-command-muteset:
|
| 107 |
+
|
| 108 |
+
^^^^^^^
|
| 109 |
+
muteset
|
| 110 |
+
^^^^^^^
|
| 111 |
+
|
| 112 |
+
**Syntax**
|
| 113 |
+
|
| 114 |
+
.. code-block:: none
|
| 115 |
+
|
| 116 |
+
[p]muteset
|
| 117 |
+
|
| 118 |
+
**Description**
|
| 119 |
+
|
| 120 |
+
Mute settings.
|
| 121 |
+
|
| 122 |
+
.. _mutes-command-muteset-defaulttime:
|
| 123 |
+
|
| 124 |
+
"""""""""""""""""""
|
| 125 |
+
muteset defaulttime
|
| 126 |
+
"""""""""""""""""""
|
| 127 |
+
|
| 128 |
+
.. note:: |mod-lock|
|
| 129 |
+
|
| 130 |
+
**Syntax**
|
| 131 |
+
|
| 132 |
+
.. code-block:: none
|
| 133 |
+
|
| 134 |
+
[p]muteset defaulttime [time]
|
| 135 |
+
|
| 136 |
+
.. tip:: Alias: ``muteset time``
|
| 137 |
+
|
| 138 |
+
**Description**
|
| 139 |
+
|
| 140 |
+
Set the default mute time for the mute command.
|
| 141 |
+
|
| 142 |
+
If no time interval is provided this will be cleared.
|
| 143 |
+
|
| 144 |
+
**Arguments**
|
| 145 |
+
|
| 146 |
+
* ``[time]``: The length of time for a default mute.
|
| 147 |
+
|
| 148 |
+
.. _mutes-command-muteset-forcerole:
|
| 149 |
+
|
| 150 |
+
"""""""""""""""""
|
| 151 |
+
muteset forcerole
|
| 152 |
+
"""""""""""""""""
|
| 153 |
+
|
| 154 |
+
.. note:: |owner-lock|
|
| 155 |
+
|
| 156 |
+
**Syntax**
|
| 157 |
+
|
| 158 |
+
.. code-block:: none
|
| 159 |
+
|
| 160 |
+
[p]muteset forcerole <true_or_false>
|
| 161 |
+
|
| 162 |
+
**Description**
|
| 163 |
+
|
| 164 |
+
Whether or not to force role only mutes on the bot.
|
| 165 |
+
|
| 166 |
+
**Arguments**
|
| 167 |
+
|
| 168 |
+
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
| 169 |
+
|
| 170 |
+
.. _mutes-command-muteset-makerole:
|
| 171 |
+
|
| 172 |
+
""""""""""""""""
|
| 173 |
+
muteset makerole
|
| 174 |
+
""""""""""""""""
|
| 175 |
+
|
| 176 |
+
.. note:: |admin-lock|
|
| 177 |
+
|
| 178 |
+
**Syntax**
|
| 179 |
+
|
| 180 |
+
.. code-block:: none
|
| 181 |
+
|
| 182 |
+
[p]muteset makerole <name>
|
| 183 |
+
|
| 184 |
+
**Description**
|
| 185 |
+
|
| 186 |
+
Create a Muted role.
|
| 187 |
+
|
| 188 |
+
This will create a role and apply overwrites to all available channels
|
| 189 |
+
to more easily setup muting a user.
|
| 190 |
+
|
| 191 |
+
If you already have a muted role created on the server use
|
| 192 |
+
``[p]muteset role ROLE_NAME_HERE``
|
| 193 |
+
|
| 194 |
+
**Arguments**
|
| 195 |
+
|
| 196 |
+
* ``<name>``: The name of the muted role to create.
|
| 197 |
+
|
| 198 |
+
.. _mutes-command-muteset-notification:
|
| 199 |
+
|
| 200 |
+
""""""""""""""""""""
|
| 201 |
+
muteset notification
|
| 202 |
+
""""""""""""""""""""
|
| 203 |
+
|
| 204 |
+
.. note:: |admin-lock|
|
| 205 |
+
|
| 206 |
+
**Syntax**
|
| 207 |
+
|
| 208 |
+
.. code-block:: none
|
| 209 |
+
|
| 210 |
+
[p]muteset notification [channel]
|
| 211 |
+
|
| 212 |
+
**Description**
|
| 213 |
+
|
| 214 |
+
Set the notification channel for automatic unmute issues.
|
| 215 |
+
|
| 216 |
+
If no channel is provided this will be cleared and notifications
|
| 217 |
+
about issues when unmuting users will not be sent anywhere.
|
| 218 |
+
|
| 219 |
+
**Arguments**
|
| 220 |
+
|
| 221 |
+
* ``[channel]``: The channel to receive unmute issue updates. |channel-input|
|
| 222 |
+
|
| 223 |
+
.. _mutes-command-muteset-role:
|
| 224 |
+
|
| 225 |
+
""""""""""""
|
| 226 |
+
muteset role
|
| 227 |
+
""""""""""""
|
| 228 |
+
|
| 229 |
+
.. note:: |admin-lock|
|
| 230 |
+
|
| 231 |
+
**Syntax**
|
| 232 |
+
|
| 233 |
+
.. code-block:: none
|
| 234 |
+
|
| 235 |
+
[p]muteset role [role]
|
| 236 |
+
|
| 237 |
+
**Description**
|
| 238 |
+
|
| 239 |
+
Sets the role to be applied when muting a user.
|
| 240 |
+
|
| 241 |
+
If no role is setup the bot will attempt to mute a user by setting
|
| 242 |
+
channel overwrites in all channels to prevent the user from sending messages.
|
| 243 |
+
|
| 244 |
+
.. Note::
|
| 245 |
+
|
| 246 |
+
If no role is setup a user may be able to leave the server
|
| 247 |
+
and rejoin no longer being muted.
|
| 248 |
+
|
| 249 |
+
**Arguments**
|
| 250 |
+
|
| 251 |
+
* ``[role]``: The role for muted users to receive. |role-input|
|
| 252 |
+
|
| 253 |
+
.. _mutes-command-muteset-senddm:
|
| 254 |
+
|
| 255 |
+
""""""""""""""
|
| 256 |
+
muteset senddm
|
| 257 |
+
""""""""""""""
|
| 258 |
+
|
| 259 |
+
.. note:: |mod-lock|
|
| 260 |
+
|
| 261 |
+
**Syntax**
|
| 262 |
+
|
| 263 |
+
.. code-block:: none
|
| 264 |
+
|
| 265 |
+
[p]muteset senddm <true_or_false>
|
| 266 |
+
|
| 267 |
+
**Description**
|
| 268 |
+
|
| 269 |
+
Set whether mute notifications should be sent to users in DMs.
|
| 270 |
+
|
| 271 |
+
**Arguments**
|
| 272 |
+
|
| 273 |
+
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
| 274 |
+
|
| 275 |
+
.. _mutes-command-muteset-settings:
|
| 276 |
+
|
| 277 |
+
""""""""""""""""
|
| 278 |
+
muteset settings
|
| 279 |
+
""""""""""""""""
|
| 280 |
+
|
| 281 |
+
.. note:: |mod-lock|
|
| 282 |
+
|
| 283 |
+
**Syntax**
|
| 284 |
+
|
| 285 |
+
.. code-block:: none
|
| 286 |
+
|
| 287 |
+
[p]muteset settings
|
| 288 |
+
|
| 289 |
+
.. tip:: Alias: ``muteset showsettings``
|
| 290 |
+
|
| 291 |
+
**Description**
|
| 292 |
+
|
| 293 |
+
Shows the current mute settings for this guild.
|
| 294 |
+
|
| 295 |
+
.. _mutes-command-muteset-showmoderator:
|
| 296 |
+
|
| 297 |
+
"""""""""""""""""""""
|
| 298 |
+
muteset showmoderator
|
| 299 |
+
"""""""""""""""""""""
|
| 300 |
+
|
| 301 |
+
.. note:: |mod-lock|
|
| 302 |
+
|
| 303 |
+
**Syntax**
|
| 304 |
+
|
| 305 |
+
.. code-block:: none
|
| 306 |
+
|
| 307 |
+
[p]muteset showmoderator <true_or_false>
|
| 308 |
+
|
| 309 |
+
**Description**
|
| 310 |
+
|
| 311 |
+
Decide whether the name of the moderator muting a user should be included in the DM to that user.
|
| 312 |
+
|
| 313 |
+
**Arguments**
|
| 314 |
+
|
| 315 |
+
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
| 316 |
+
|
| 317 |
+
.. _mutes-command-unmute:
|
| 318 |
+
|
| 319 |
+
^^^^^^
|
| 320 |
+
unmute
|
| 321 |
+
^^^^^^
|
| 322 |
+
|
| 323 |
+
.. note:: |mod-lock|
|
| 324 |
+
|
| 325 |
+
**Syntax**
|
| 326 |
+
|
| 327 |
+
.. code-block:: none
|
| 328 |
+
|
| 329 |
+
[p]unmute <users...> [reason]
|
| 330 |
+
|
| 331 |
+
**Description**
|
| 332 |
+
|
| 333 |
+
Unmute users.
|
| 334 |
+
|
| 335 |
+
**Arguments**
|
| 336 |
+
|
| 337 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 338 |
+
* ``[reason]``: The reason for the unmute.
|
| 339 |
+
|
| 340 |
+
.. _mutes-command-unmutechannel:
|
| 341 |
+
|
| 342 |
+
^^^^^^^^^^^^^
|
| 343 |
+
unmutechannel
|
| 344 |
+
^^^^^^^^^^^^^
|
| 345 |
+
|
| 346 |
+
.. note:: |mod-lock|
|
| 347 |
+
|
| 348 |
+
**Syntax**
|
| 349 |
+
|
| 350 |
+
.. code-block:: none
|
| 351 |
+
|
| 352 |
+
[p]unmutechannel <users...> [reason]
|
| 353 |
+
|
| 354 |
+
.. tip:: Alias: ``channelunmute``
|
| 355 |
+
|
| 356 |
+
**Description**
|
| 357 |
+
|
| 358 |
+
Unmute a user in this channel (or in the parent of this thread).
|
| 359 |
+
|
| 360 |
+
**Arguments**
|
| 361 |
+
|
| 362 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 363 |
+
* ``[reason]``: The reason for the unmute.
|
| 364 |
+
|
| 365 |
+
.. _mutes-command-voicemute:
|
| 366 |
+
|
| 367 |
+
^^^^^^^^^
|
| 368 |
+
voicemute
|
| 369 |
+
^^^^^^^^^
|
| 370 |
+
|
| 371 |
+
**Syntax**
|
| 372 |
+
|
| 373 |
+
.. code-block:: none
|
| 374 |
+
|
| 375 |
+
[p]voicemute <users...> [reason]
|
| 376 |
+
|
| 377 |
+
**Description**
|
| 378 |
+
|
| 379 |
+
Mute a user in their current voice channel.
|
| 380 |
+
|
| 381 |
+
Examples:
|
| 382 |
+
|
| 383 |
+
* ``[p]voicemute @member1 @member2 spam 5 hours``
|
| 384 |
+
* ``[p]voicemute @member1 3 days``
|
| 385 |
+
|
| 386 |
+
**Arguments**
|
| 387 |
+
|
| 388 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 389 |
+
* ``[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.
|
| 390 |
+
|
| 391 |
+
.. _mutes-command-voiceunmute:
|
| 392 |
+
|
| 393 |
+
^^^^^^^^^^^
|
| 394 |
+
voiceunmute
|
| 395 |
+
^^^^^^^^^^^
|
| 396 |
+
|
| 397 |
+
**Syntax**
|
| 398 |
+
|
| 399 |
+
.. code-block:: none
|
| 400 |
+
|
| 401 |
+
[p]voiceunmute <users...> [reason]
|
| 402 |
+
|
| 403 |
+
**Description**
|
| 404 |
+
|
| 405 |
+
Unmute a user in their current voice channel.
|
| 406 |
+
|
| 407 |
+
**Arguments**
|
| 408 |
+
|
| 409 |
+
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
| 410 |
+
* ``[reason]``: The reason for the unmute.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/permissions.rst
ADDED
|
@@ -0,0 +1,440 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _permissions:
|
| 2 |
+
|
| 3 |
+
===========
|
| 4 |
+
Permissions
|
| 5 |
+
===========
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the permissions cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load permissions
|
| 15 |
+
|
| 16 |
+
.. _permissions-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Customise permissions for commands and cogs.
|
| 23 |
+
|
| 24 |
+
This cog extends the default permission model of the bot. By default, many commands are restricted based on what the command can do.
|
| 25 |
+
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.
|
| 26 |
+
|
| 27 |
+
When additional rules are set using this cog, those rules will be checked prior to checking for the default restrictions of the command.
|
| 28 |
+
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:
|
| 29 |
+
|
| 30 |
+
1. Rules about a user.
|
| 31 |
+
2. Rules about the voice channel a user is in.
|
| 32 |
+
3. Rules about the text channel or a parent of the thread a command was issued in.
|
| 33 |
+
4. Rules about a role the user has (The highest role they have with a rule will be used).
|
| 34 |
+
5. Rules about the server a user is in (Global rules only).
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
.. _permissions-commands:
|
| 38 |
+
|
| 39 |
+
--------
|
| 40 |
+
Commands
|
| 41 |
+
--------
|
| 42 |
+
|
| 43 |
+
.. _permissions-command-permissions:
|
| 44 |
+
|
| 45 |
+
^^^^^^^^^^^
|
| 46 |
+
permissions
|
| 47 |
+
^^^^^^^^^^^
|
| 48 |
+
|
| 49 |
+
**Syntax**
|
| 50 |
+
|
| 51 |
+
.. code-block:: none
|
| 52 |
+
|
| 53 |
+
[p]permissions
|
| 54 |
+
|
| 55 |
+
**Description**
|
| 56 |
+
|
| 57 |
+
Command permission management tools.
|
| 58 |
+
|
| 59 |
+
.. _permissions-command-permissions-acl:
|
| 60 |
+
|
| 61 |
+
"""""""""""""""
|
| 62 |
+
permissions acl
|
| 63 |
+
"""""""""""""""
|
| 64 |
+
|
| 65 |
+
.. note:: |guildowner-lock|
|
| 66 |
+
|
| 67 |
+
**Syntax**
|
| 68 |
+
|
| 69 |
+
.. code-block:: none
|
| 70 |
+
|
| 71 |
+
[p]permissions acl
|
| 72 |
+
|
| 73 |
+
**Description**
|
| 74 |
+
|
| 75 |
+
Manage permissions with YAML files.
|
| 76 |
+
|
| 77 |
+
.. tip:: See :ref:`here <cog_permissions>` for more information with configuring these yaml files.
|
| 78 |
+
|
| 79 |
+
.. _permissions-command-permissions-acl-getglobal:
|
| 80 |
+
|
| 81 |
+
"""""""""""""""""""""""""
|
| 82 |
+
permissions acl getglobal
|
| 83 |
+
"""""""""""""""""""""""""
|
| 84 |
+
|
| 85 |
+
.. note:: |owner-lock|
|
| 86 |
+
|
| 87 |
+
**Syntax**
|
| 88 |
+
|
| 89 |
+
.. code-block:: none
|
| 90 |
+
|
| 91 |
+
[p]permissions acl getglobal
|
| 92 |
+
|
| 93 |
+
**Description**
|
| 94 |
+
|
| 95 |
+
Get a YAML file detailing all global rules.
|
| 96 |
+
|
| 97 |
+
.. _permissions-command-permissions-acl-getserver:
|
| 98 |
+
|
| 99 |
+
"""""""""""""""""""""""""
|
| 100 |
+
permissions acl getserver
|
| 101 |
+
"""""""""""""""""""""""""
|
| 102 |
+
|
| 103 |
+
.. note:: |guildowner-lock|
|
| 104 |
+
|
| 105 |
+
**Syntax**
|
| 106 |
+
|
| 107 |
+
.. code-block:: none
|
| 108 |
+
|
| 109 |
+
[p]permissions acl getserver
|
| 110 |
+
|
| 111 |
+
**Description**
|
| 112 |
+
|
| 113 |
+
Get a YAML file detailing all rules in this server.
|
| 114 |
+
|
| 115 |
+
.. _permissions-command-permissions-acl-setglobal:
|
| 116 |
+
|
| 117 |
+
"""""""""""""""""""""""""
|
| 118 |
+
permissions acl setglobal
|
| 119 |
+
"""""""""""""""""""""""""
|
| 120 |
+
|
| 121 |
+
.. note:: |owner-lock|
|
| 122 |
+
|
| 123 |
+
**Syntax**
|
| 124 |
+
|
| 125 |
+
.. code-block:: none
|
| 126 |
+
|
| 127 |
+
[p]permissions acl setglobal
|
| 128 |
+
|
| 129 |
+
**Description**
|
| 130 |
+
|
| 131 |
+
Set global rules with a YAML file.
|
| 132 |
+
|
| 133 |
+
.. warning::
|
| 134 |
+
This will override reset *all* global rules
|
| 135 |
+
to the rules specified in the uploaded file.
|
| 136 |
+
|
| 137 |
+
This does not validate the names of commands and cogs before
|
| 138 |
+
setting the new rules.
|
| 139 |
+
|
| 140 |
+
.. _permissions-command-permissions-acl-setserver:
|
| 141 |
+
|
| 142 |
+
"""""""""""""""""""""""""
|
| 143 |
+
permissions acl setserver
|
| 144 |
+
"""""""""""""""""""""""""
|
| 145 |
+
|
| 146 |
+
.. note:: |guildowner-lock|
|
| 147 |
+
|
| 148 |
+
**Syntax**
|
| 149 |
+
|
| 150 |
+
.. code-block:: none
|
| 151 |
+
|
| 152 |
+
[p]permissions acl setserver
|
| 153 |
+
|
| 154 |
+
**Description**
|
| 155 |
+
|
| 156 |
+
Set rules for this server with a YAML file.
|
| 157 |
+
|
| 158 |
+
.. warning::
|
| 159 |
+
This will override reset *all* rules in this
|
| 160 |
+
server to the rules specified in the uploaded file.
|
| 161 |
+
|
| 162 |
+
.. _permissions-command-permissions-acl-updateglobal:
|
| 163 |
+
|
| 164 |
+
""""""""""""""""""""""""""""
|
| 165 |
+
permissions acl updateglobal
|
| 166 |
+
""""""""""""""""""""""""""""
|
| 167 |
+
|
| 168 |
+
.. note:: |owner-lock|
|
| 169 |
+
|
| 170 |
+
**Syntax**
|
| 171 |
+
|
| 172 |
+
.. code-block:: none
|
| 173 |
+
|
| 174 |
+
[p]permissions acl updateglobal
|
| 175 |
+
|
| 176 |
+
**Description**
|
| 177 |
+
|
| 178 |
+
Update global rules with a YAML file.
|
| 179 |
+
|
| 180 |
+
This won't touch any rules not specified in the YAML
|
| 181 |
+
file.
|
| 182 |
+
|
| 183 |
+
.. _permissions-command-permissions-acl-updateserver:
|
| 184 |
+
|
| 185 |
+
""""""""""""""""""""""""""""
|
| 186 |
+
permissions acl updateserver
|
| 187 |
+
""""""""""""""""""""""""""""
|
| 188 |
+
|
| 189 |
+
.. note:: |guildowner-lock|
|
| 190 |
+
|
| 191 |
+
**Syntax**
|
| 192 |
+
|
| 193 |
+
.. code-block:: none
|
| 194 |
+
|
| 195 |
+
[p]permissions acl updateserver
|
| 196 |
+
|
| 197 |
+
**Description**
|
| 198 |
+
|
| 199 |
+
Update rules for this server with a YAML file.
|
| 200 |
+
|
| 201 |
+
This won't touch any rules not specified in the YAML
|
| 202 |
+
file.
|
| 203 |
+
|
| 204 |
+
.. _permissions-command-permissions-acl-yamlexample:
|
| 205 |
+
|
| 206 |
+
"""""""""""""""""""""""""""
|
| 207 |
+
permissions acl yamlexample
|
| 208 |
+
"""""""""""""""""""""""""""
|
| 209 |
+
|
| 210 |
+
**Syntax**
|
| 211 |
+
|
| 212 |
+
.. code-block:: none
|
| 213 |
+
|
| 214 |
+
[p]permissions acl yamlexample
|
| 215 |
+
|
| 216 |
+
**Description**
|
| 217 |
+
|
| 218 |
+
Sends an example of the yaml layout for permissions
|
| 219 |
+
|
| 220 |
+
.. _permissions-command-permissions-addglobalrule:
|
| 221 |
+
|
| 222 |
+
"""""""""""""""""""""""""
|
| 223 |
+
permissions addglobalrule
|
| 224 |
+
"""""""""""""""""""""""""
|
| 225 |
+
|
| 226 |
+
.. note:: |owner-lock|
|
| 227 |
+
|
| 228 |
+
**Syntax**
|
| 229 |
+
|
| 230 |
+
.. code-block:: none
|
| 231 |
+
|
| 232 |
+
[p]permissions addglobalrule <allow_or_deny> <cog_or_command> <who_or_what...>
|
| 233 |
+
|
| 234 |
+
**Description**
|
| 235 |
+
|
| 236 |
+
Add a global rule to a cog or command.
|
| 237 |
+
|
| 238 |
+
**Arguments**
|
| 239 |
+
|
| 240 |
+
* ``<allow_or_deny>``: This should be one of "allow" or "deny".
|
| 241 |
+
* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
|
| 242 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
| 243 |
+
|
| 244 |
+
.. _permissions-command-permissions-addserverrule:
|
| 245 |
+
|
| 246 |
+
"""""""""""""""""""""""""
|
| 247 |
+
permissions addserverrule
|
| 248 |
+
"""""""""""""""""""""""""
|
| 249 |
+
|
| 250 |
+
.. note:: |guildowner-lock|
|
| 251 |
+
|
| 252 |
+
**Syntax**
|
| 253 |
+
|
| 254 |
+
.. code-block:: none
|
| 255 |
+
|
| 256 |
+
[p]permissions addserverrule <allow_or_deny> <cog_or_command> <who_or_what...>
|
| 257 |
+
|
| 258 |
+
**Description**
|
| 259 |
+
|
| 260 |
+
Add a rule to a cog or command in this server.
|
| 261 |
+
|
| 262 |
+
**Arguments**
|
| 263 |
+
|
| 264 |
+
* ``<allow_or_deny>``: This should be one of "allow" or "deny".
|
| 265 |
+
* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
|
| 266 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
| 267 |
+
|
| 268 |
+
.. _permissions-command-permissions-canrun:
|
| 269 |
+
|
| 270 |
+
""""""""""""""""""
|
| 271 |
+
permissions canrun
|
| 272 |
+
""""""""""""""""""
|
| 273 |
+
|
| 274 |
+
**Syntax**
|
| 275 |
+
|
| 276 |
+
.. code-block:: none
|
| 277 |
+
|
| 278 |
+
[p]permissions canrun <user> <command>
|
| 279 |
+
|
| 280 |
+
**Description**
|
| 281 |
+
|
| 282 |
+
Check if a user can run a command.
|
| 283 |
+
|
| 284 |
+
This will take the current context into account, such as the
|
| 285 |
+
server and text channel.
|
| 286 |
+
|
| 287 |
+
**Arguments**
|
| 288 |
+
|
| 289 |
+
* ``<user>``: The user to check permissions for.
|
| 290 |
+
* ``<command>``: The command to check whether the user can run it or not.
|
| 291 |
+
|
| 292 |
+
.. _permissions-command-permissions-clearglobalrules:
|
| 293 |
+
|
| 294 |
+
""""""""""""""""""""""""""""
|
| 295 |
+
permissions clearglobalrules
|
| 296 |
+
""""""""""""""""""""""""""""
|
| 297 |
+
|
| 298 |
+
.. note:: |owner-lock|
|
| 299 |
+
|
| 300 |
+
**Syntax**
|
| 301 |
+
|
| 302 |
+
.. code-block:: none
|
| 303 |
+
|
| 304 |
+
[p]permissions clearglobalrules
|
| 305 |
+
|
| 306 |
+
**Description**
|
| 307 |
+
|
| 308 |
+
Reset all global rules.
|
| 309 |
+
|
| 310 |
+
.. _permissions-command-permissions-clearserverrules:
|
| 311 |
+
|
| 312 |
+
""""""""""""""""""""""""""""
|
| 313 |
+
permissions clearserverrules
|
| 314 |
+
""""""""""""""""""""""""""""
|
| 315 |
+
|
| 316 |
+
.. note:: |guildowner-lock|
|
| 317 |
+
|
| 318 |
+
**Syntax**
|
| 319 |
+
|
| 320 |
+
.. code-block:: none
|
| 321 |
+
|
| 322 |
+
[p]permissions clearserverrules
|
| 323 |
+
|
| 324 |
+
**Description**
|
| 325 |
+
|
| 326 |
+
Reset all rules in this server.
|
| 327 |
+
|
| 328 |
+
.. _permissions-command-permissions-explain:
|
| 329 |
+
|
| 330 |
+
"""""""""""""""""""
|
| 331 |
+
permissions explain
|
| 332 |
+
"""""""""""""""""""
|
| 333 |
+
|
| 334 |
+
**Syntax**
|
| 335 |
+
|
| 336 |
+
.. code-block:: none
|
| 337 |
+
|
| 338 |
+
[p]permissions explain
|
| 339 |
+
|
| 340 |
+
**Description**
|
| 341 |
+
|
| 342 |
+
Explain how permissions works.
|
| 343 |
+
|
| 344 |
+
.. _permissions-command-permissions-removeglobalrule:
|
| 345 |
+
|
| 346 |
+
""""""""""""""""""""""""""""
|
| 347 |
+
permissions removeglobalrule
|
| 348 |
+
""""""""""""""""""""""""""""
|
| 349 |
+
|
| 350 |
+
.. note:: |owner-lock|
|
| 351 |
+
|
| 352 |
+
**Syntax**
|
| 353 |
+
|
| 354 |
+
.. code-block:: none
|
| 355 |
+
|
| 356 |
+
[p]permissions removeglobalrule <cog_or_command> <who_or_what...>
|
| 357 |
+
|
| 358 |
+
**Description**
|
| 359 |
+
|
| 360 |
+
Remove a global rule from a command.
|
| 361 |
+
|
| 362 |
+
**Arguments**
|
| 363 |
+
|
| 364 |
+
* ``<cog_or_command>``: The cog or command to remove the rule from. This is case sensitive.
|
| 365 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
| 366 |
+
|
| 367 |
+
.. _permissions-command-permissions-removeserverrule:
|
| 368 |
+
|
| 369 |
+
""""""""""""""""""""""""""""
|
| 370 |
+
permissions removeserverrule
|
| 371 |
+
""""""""""""""""""""""""""""
|
| 372 |
+
|
| 373 |
+
.. note:: |guildowner-lock|
|
| 374 |
+
|
| 375 |
+
**Syntax**
|
| 376 |
+
|
| 377 |
+
.. code-block:: none
|
| 378 |
+
|
| 379 |
+
[p]permissions removeserverrule <cog_or_command> <who_or_what...>
|
| 380 |
+
|
| 381 |
+
**Description**
|
| 382 |
+
|
| 383 |
+
Remove a server rule from a command.
|
| 384 |
+
|
| 385 |
+
**Arguments**
|
| 386 |
+
|
| 387 |
+
* ``<cog_or_command>``: The cog or command to remove the rule from. This is case sensitive.
|
| 388 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
| 389 |
+
|
| 390 |
+
.. _permissions-command-permissions-setdefaultglobalrule:
|
| 391 |
+
|
| 392 |
+
""""""""""""""""""""""""""""""""
|
| 393 |
+
permissions setdefaultglobalrule
|
| 394 |
+
""""""""""""""""""""""""""""""""
|
| 395 |
+
|
| 396 |
+
.. note:: |owner-lock|
|
| 397 |
+
|
| 398 |
+
**Syntax**
|
| 399 |
+
|
| 400 |
+
.. code-block:: none
|
| 401 |
+
|
| 402 |
+
[p]permissions setdefaultglobalrule <allow_or_deny> <cog_or_command>
|
| 403 |
+
|
| 404 |
+
**Description**
|
| 405 |
+
|
| 406 |
+
Set the default global rule for a command or a cog.
|
| 407 |
+
|
| 408 |
+
This is the rule a command will default to when no other rule
|
| 409 |
+
is found.
|
| 410 |
+
|
| 411 |
+
**Arguments**
|
| 412 |
+
|
| 413 |
+
* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
|
| 414 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
| 415 |
+
|
| 416 |
+
.. _permissions-command-permissions-setdefaultserverrule:
|
| 417 |
+
|
| 418 |
+
""""""""""""""""""""""""""""""""
|
| 419 |
+
permissions setdefaultserverrule
|
| 420 |
+
""""""""""""""""""""""""""""""""
|
| 421 |
+
|
| 422 |
+
.. note:: |guildowner-lock|
|
| 423 |
+
|
| 424 |
+
**Syntax**
|
| 425 |
+
|
| 426 |
+
.. code-block:: none
|
| 427 |
+
|
| 428 |
+
[p]permissions setdefaultserverrule <allow_or_deny> <cog_or_command>
|
| 429 |
+
|
| 430 |
+
**Description**
|
| 431 |
+
|
| 432 |
+
Set the default rule for a command or a cog in this server.
|
| 433 |
+
|
| 434 |
+
This is the rule a command will default to when no other rule
|
| 435 |
+
is found.
|
| 436 |
+
|
| 437 |
+
**Arguments**
|
| 438 |
+
|
| 439 |
+
* ``<cog_or_command>``: The cog or command to add the rule to. This is case sensitive.
|
| 440 |
+
* ``<who_or_what...>``: One or more users, channels or roles the rule is for.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/reports.rst
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _reports:
|
| 2 |
+
|
| 3 |
+
=======
|
| 4 |
+
Reports
|
| 5 |
+
=======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the reports cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load reports
|
| 15 |
+
|
| 16 |
+
.. _reports-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Create user reports that server staff can respond to.
|
| 23 |
+
|
| 24 |
+
Users can open reports using ``[p]report``. These are then sent
|
| 25 |
+
to a channel in the server for staff, and the report creator
|
| 26 |
+
gets a DM. Both can be used to communicate.
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
.. _reports-commands:
|
| 30 |
+
|
| 31 |
+
--------
|
| 32 |
+
Commands
|
| 33 |
+
--------
|
| 34 |
+
|
| 35 |
+
.. _reports-command-report:
|
| 36 |
+
|
| 37 |
+
^^^^^^
|
| 38 |
+
report
|
| 39 |
+
^^^^^^
|
| 40 |
+
|
| 41 |
+
**Syntax**
|
| 42 |
+
|
| 43 |
+
.. code-block:: none
|
| 44 |
+
|
| 45 |
+
[p]report [text]
|
| 46 |
+
|
| 47 |
+
**Description**
|
| 48 |
+
|
| 49 |
+
Send a report.
|
| 50 |
+
|
| 51 |
+
Use without arguments for interactive reporting, or do
|
| 52 |
+
``[p]report [text]`` to use it non-interactively.
|
| 53 |
+
|
| 54 |
+
**Arguments**
|
| 55 |
+
|
| 56 |
+
* ``[text]``: The content included within the report.
|
| 57 |
+
|
| 58 |
+
.. _reports-command-report-interact:
|
| 59 |
+
|
| 60 |
+
"""""""""""""""
|
| 61 |
+
report interact
|
| 62 |
+
"""""""""""""""
|
| 63 |
+
|
| 64 |
+
.. note:: |mod-lock|
|
| 65 |
+
|
| 66 |
+
**Syntax**
|
| 67 |
+
|
| 68 |
+
.. code-block:: none
|
| 69 |
+
|
| 70 |
+
[p]report interact <ticket_number>
|
| 71 |
+
|
| 72 |
+
**Description**
|
| 73 |
+
|
| 74 |
+
Open a message tunnel.
|
| 75 |
+
|
| 76 |
+
This tunnel will forward things you say in this channel or thread
|
| 77 |
+
to the ticket opener's direct messages.
|
| 78 |
+
|
| 79 |
+
Tunnels do not persist across bot restarts.
|
| 80 |
+
|
| 81 |
+
**Arguments**
|
| 82 |
+
|
| 83 |
+
* ``<ticket_number>``: The ticket number to open the tunnel in.
|
| 84 |
+
|
| 85 |
+
.. _reports-command-reportset:
|
| 86 |
+
|
| 87 |
+
^^^^^^^^^
|
| 88 |
+
reportset
|
| 89 |
+
^^^^^^^^^
|
| 90 |
+
|
| 91 |
+
.. note:: |admin-lock|
|
| 92 |
+
|
| 93 |
+
**Syntax**
|
| 94 |
+
|
| 95 |
+
.. code-block:: none
|
| 96 |
+
|
| 97 |
+
[p]reportset
|
| 98 |
+
|
| 99 |
+
**Description**
|
| 100 |
+
|
| 101 |
+
Manage Reports.
|
| 102 |
+
|
| 103 |
+
.. _reports-command-reportset-output:
|
| 104 |
+
|
| 105 |
+
""""""""""""""""
|
| 106 |
+
reportset output
|
| 107 |
+
""""""""""""""""
|
| 108 |
+
|
| 109 |
+
.. note:: |admin-lock|
|
| 110 |
+
|
| 111 |
+
**Syntax**
|
| 112 |
+
|
| 113 |
+
.. code-block:: none
|
| 114 |
+
|
| 115 |
+
[p]reportset output <channel>
|
| 116 |
+
|
| 117 |
+
**Description**
|
| 118 |
+
|
| 119 |
+
Set the channel where reports will be sent.
|
| 120 |
+
|
| 121 |
+
**Arguments**
|
| 122 |
+
|
| 123 |
+
* ``<channel>``: |channel-input|
|
| 124 |
+
|
| 125 |
+
.. _reports-command-reportset-toggle:
|
| 126 |
+
|
| 127 |
+
""""""""""""""""
|
| 128 |
+
reportset toggle
|
| 129 |
+
""""""""""""""""
|
| 130 |
+
|
| 131 |
+
.. note:: |admin-lock|
|
| 132 |
+
|
| 133 |
+
**Syntax**
|
| 134 |
+
|
| 135 |
+
.. code-block:: none
|
| 136 |
+
|
| 137 |
+
[p]reportset toggle
|
| 138 |
+
|
| 139 |
+
**Description**
|
| 140 |
+
|
| 141 |
+
Enable or disable reporting for this server.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/streams.rst
ADDED
|
@@ -0,0 +1,533 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _streams:
|
| 2 |
+
|
| 3 |
+
=======
|
| 4 |
+
Streams
|
| 5 |
+
=======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the Streams cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load streams
|
| 15 |
+
|
| 16 |
+
.. _streams-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog provides commands to check if a channel
|
| 23 |
+
on a supported streaming service is live as well
|
| 24 |
+
as to create and manage alerts for channels.
|
| 25 |
+
|
| 26 |
+
Supported streaming services are:
|
| 27 |
+
|
| 28 |
+
- Twitch
|
| 29 |
+
- Youtube
|
| 30 |
+
- Picarto
|
| 31 |
+
|
| 32 |
+
Youtube and Twitch both require setting authentication
|
| 33 |
+
details for commands for those services to work. See
|
| 34 |
+
:ref:`[p]streamset twitchtoken <streams-command-streamset-twitchtoken>` and
|
| 35 |
+
:ref:`[p]streamset youtubekey <streams-command-streamset-youtubekey>`
|
| 36 |
+
for more information.
|
| 37 |
+
|
| 38 |
+
.. _streams-commands:
|
| 39 |
+
|
| 40 |
+
--------
|
| 41 |
+
Commands
|
| 42 |
+
--------
|
| 43 |
+
|
| 44 |
+
.. _streams-command-streamset:
|
| 45 |
+
|
| 46 |
+
^^^^^^^^^
|
| 47 |
+
streamset
|
| 48 |
+
^^^^^^^^^
|
| 49 |
+
|
| 50 |
+
**Syntax**
|
| 51 |
+
|
| 52 |
+
.. code-block:: none
|
| 53 |
+
|
| 54 |
+
[p]streamset
|
| 55 |
+
|
| 56 |
+
**Description**
|
| 57 |
+
|
| 58 |
+
Manage stream alert settings.
|
| 59 |
+
|
| 60 |
+
.. _streams-command-streamset-autodelete:
|
| 61 |
+
|
| 62 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 63 |
+
streamset autodelete
|
| 64 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 65 |
+
|
| 66 |
+
**Syntax**
|
| 67 |
+
|
| 68 |
+
.. code-block:: none
|
| 69 |
+
|
| 70 |
+
[p]streamset autodelete <on_off>
|
| 71 |
+
|
| 72 |
+
**Description**
|
| 73 |
+
|
| 74 |
+
Toggles automatic deletion of stream alerts when the
|
| 75 |
+
stream goes offline.
|
| 76 |
+
|
| 77 |
+
**Arguments**
|
| 78 |
+
|
| 79 |
+
* ``<on_off>``: Whether to turn on or off
|
| 80 |
+
|
| 81 |
+
.. _streams-command-streamset-ignorereruns:
|
| 82 |
+
|
| 83 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 84 |
+
streamset ignorereruns
|
| 85 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 86 |
+
|
| 87 |
+
**Syntax**
|
| 88 |
+
|
| 89 |
+
.. code-block:: none
|
| 90 |
+
|
| 91 |
+
[p]streamset ignorereruns
|
| 92 |
+
|
| 93 |
+
**Description**
|
| 94 |
+
|
| 95 |
+
Toggles excluding reruns from the alerts.
|
| 96 |
+
|
| 97 |
+
At this time, this functionality only applies to Twitch stream alerts.
|
| 98 |
+
|
| 99 |
+
.. _streams-command-streamset-mention:
|
| 100 |
+
|
| 101 |
+
^^^^^^^^^^^^^^^^^
|
| 102 |
+
streamset mention
|
| 103 |
+
^^^^^^^^^^^^^^^^^
|
| 104 |
+
|
| 105 |
+
**Syntax**
|
| 106 |
+
|
| 107 |
+
.. code-block:: none
|
| 108 |
+
|
| 109 |
+
[p]streamset mention
|
| 110 |
+
|
| 111 |
+
**Description**
|
| 112 |
+
|
| 113 |
+
Toggle mentions for stream alerts.
|
| 114 |
+
|
| 115 |
+
.. _streams-command-streamset-mention-all:
|
| 116 |
+
|
| 117 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 118 |
+
streamset mention all
|
| 119 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 120 |
+
|
| 121 |
+
**Syntax**
|
| 122 |
+
|
| 123 |
+
.. code-block:: none
|
| 124 |
+
|
| 125 |
+
[p]streamset mention all
|
| 126 |
+
|
| 127 |
+
**Description**
|
| 128 |
+
|
| 129 |
+
Toggle mentioning ``@everyone`` for stream alerts.
|
| 130 |
+
|
| 131 |
+
.. _streams-command-streamset-mention-online:
|
| 132 |
+
|
| 133 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 134 |
+
streamset mention online
|
| 135 |
+
^^^^^^^^^^^^^^^^^^^^^^^^
|
| 136 |
+
|
| 137 |
+
**Syntax**
|
| 138 |
+
|
| 139 |
+
.. code-block:: none
|
| 140 |
+
|
| 141 |
+
[p]streamset mention online
|
| 142 |
+
|
| 143 |
+
**Description**
|
| 144 |
+
|
| 145 |
+
Toggle mentioning ``@here`` for stream alerts.
|
| 146 |
+
|
| 147 |
+
.. _streams-command-streamset-mention-role:
|
| 148 |
+
|
| 149 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 150 |
+
streamset mention role
|
| 151 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 152 |
+
|
| 153 |
+
**Syntax**
|
| 154 |
+
|
| 155 |
+
.. code-block:: none
|
| 156 |
+
|
| 157 |
+
[p]streamset mention role <role>
|
| 158 |
+
|
| 159 |
+
**Description**
|
| 160 |
+
|
| 161 |
+
Toggle mentioning a role for stream alerts.
|
| 162 |
+
|
| 163 |
+
**Arguments**
|
| 164 |
+
|
| 165 |
+
* ``<role>``: The role to toggle a mention for. |role-input|
|
| 166 |
+
|
| 167 |
+
.. _streams-command-streamset-message:
|
| 168 |
+
|
| 169 |
+
^^^^^^^^^^^^^^^^^
|
| 170 |
+
streamset message
|
| 171 |
+
^^^^^^^^^^^^^^^^^
|
| 172 |
+
|
| 173 |
+
**Syntax**
|
| 174 |
+
|
| 175 |
+
.. code-block:: none
|
| 176 |
+
|
| 177 |
+
[p]streamset message
|
| 178 |
+
|
| 179 |
+
**Description**
|
| 180 |
+
|
| 181 |
+
Manage custom messages for stream alerts.
|
| 182 |
+
|
| 183 |
+
.. _streams-command-streamset-message-mention:
|
| 184 |
+
|
| 185 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 186 |
+
streamset message mention
|
| 187 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 188 |
+
|
| 189 |
+
**Syntax**
|
| 190 |
+
|
| 191 |
+
.. code-block:: none
|
| 192 |
+
|
| 193 |
+
[p]streamset message mention <message>
|
| 194 |
+
|
| 195 |
+
**Description**
|
| 196 |
+
|
| 197 |
+
Sets a stream alert message for when mentions are enabled.
|
| 198 |
+
|
| 199 |
+
Use ``{mention}`` in the message to insert the selected mentions.
|
| 200 |
+
|
| 201 |
+
Use ``{stream}`` in the message to insert the channel or user name.
|
| 202 |
+
|
| 203 |
+
Use ``{stream.display_name}`` in the message to insert the channel's display name
|
| 204 |
+
(on Twitch, this may be different from ``{stream}``).
|
| 205 |
+
|
| 206 |
+
For example: ``[p]streamset message mention {mention}, {stream.display_name} is live!``
|
| 207 |
+
|
| 208 |
+
**Arguments**
|
| 209 |
+
|
| 210 |
+
* ``<message>``: Your alert message
|
| 211 |
+
|
| 212 |
+
.. _streams-command-streamset-message-nomention:
|
| 213 |
+
|
| 214 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 215 |
+
streamset message nomention
|
| 216 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 217 |
+
|
| 218 |
+
**Syntax**
|
| 219 |
+
|
| 220 |
+
.. code-block:: none
|
| 221 |
+
|
| 222 |
+
[p]streamset message nomention <message>
|
| 223 |
+
|
| 224 |
+
**Description**
|
| 225 |
+
|
| 226 |
+
Sets a stream alert message for when mentions are disabled.
|
| 227 |
+
|
| 228 |
+
Use ``{stream}`` in the message to insert the channel or user name.
|
| 229 |
+
|
| 230 |
+
Use ``{stream.display_name}`` in the message to insert the channel's display name
|
| 231 |
+
(on Twitch, this may be different from ``{stream}``).
|
| 232 |
+
|
| 233 |
+
For example: ``[p]streamset message nomention {stream.display_name} is live!``
|
| 234 |
+
|
| 235 |
+
**Arguments**
|
| 236 |
+
|
| 237 |
+
* ``<message>``: Your alert message
|
| 238 |
+
|
| 239 |
+
.. _streams-command-streamset-message-clear:
|
| 240 |
+
|
| 241 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 242 |
+
streamset message clear
|
| 243 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 244 |
+
|
| 245 |
+
**Syntax**
|
| 246 |
+
|
| 247 |
+
.. code-block:: none
|
| 248 |
+
|
| 249 |
+
[p]streamset message clear
|
| 250 |
+
|
| 251 |
+
**Description**
|
| 252 |
+
|
| 253 |
+
Resets the stream alert messages for the server.
|
| 254 |
+
|
| 255 |
+
.. _streams-command-streamset-timer:
|
| 256 |
+
|
| 257 |
+
^^^^^^^^^^^^^^^
|
| 258 |
+
streamset timer
|
| 259 |
+
^^^^^^^^^^^^^^^
|
| 260 |
+
|
| 261 |
+
**Syntax**
|
| 262 |
+
|
| 263 |
+
.. code-block:: none
|
| 264 |
+
|
| 265 |
+
[p]streamset timer <refresh_timer>
|
| 266 |
+
|
| 267 |
+
**Description**
|
| 268 |
+
|
| 269 |
+
Sets the refresh time for stream alerts (how frequently they will be checked).
|
| 270 |
+
|
| 271 |
+
This cannot be set to anything less than 60 seconds.
|
| 272 |
+
|
| 273 |
+
**Arguments**
|
| 274 |
+
|
| 275 |
+
* ``<refresh_timer>``: The frequency with which streams should be checked, in seconds
|
| 276 |
+
|
| 277 |
+
.. _streams-command-streamset-youtubekey:
|
| 278 |
+
|
| 279 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 280 |
+
streamset youtubekey
|
| 281 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 282 |
+
|
| 283 |
+
**Syntax**
|
| 284 |
+
|
| 285 |
+
.. code-block:: none
|
| 286 |
+
|
| 287 |
+
[p]streamset youtubekey
|
| 288 |
+
|
| 289 |
+
**Description**
|
| 290 |
+
|
| 291 |
+
Explains how to set the YouTube token.
|
| 292 |
+
|
| 293 |
+
To get one, do the following:
|
| 294 |
+
|
| 295 |
+
1. Create a project
|
| 296 |
+
(see https://support.google.com/googleapi/answer/6251787 for details)
|
| 297 |
+
|
| 298 |
+
2. Enable the YouTube Data API v3
|
| 299 |
+
(see https://support.google.com/googleapi/answer/6158841 for instructions)
|
| 300 |
+
|
| 301 |
+
3. Set up your API key
|
| 302 |
+
(see https://support.google.com/googleapi/answer/6158862 for instructions)
|
| 303 |
+
|
| 304 |
+
4. Copy your API key and run the command ``[p]set api youtube api_key <your_api_key_here>``
|
| 305 |
+
|
| 306 |
+
.. attention:: These tokens are sensitive and should only be
|
| 307 |
+
used in a private channel or in DM with the bot.
|
| 308 |
+
|
| 309 |
+
.. _streams-command-streamset-twitchtoken:
|
| 310 |
+
|
| 311 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 312 |
+
streamset twitchtoken
|
| 313 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 314 |
+
|
| 315 |
+
**Syntax**
|
| 316 |
+
|
| 317 |
+
.. code-block:: none
|
| 318 |
+
|
| 319 |
+
[p]streamset twitchtoken
|
| 320 |
+
|
| 321 |
+
**Description**
|
| 322 |
+
|
| 323 |
+
Explains how to set the Twitch token.
|
| 324 |
+
|
| 325 |
+
To set the Twitch API tokens, follow these steps:
|
| 326 |
+
|
| 327 |
+
1. Go to this page: https://dev.twitch.tv/dashboard/apps.
|
| 328 |
+
|
| 329 |
+
2. Click Register Your Application.
|
| 330 |
+
|
| 331 |
+
3. Enter a name, set the OAuth Redirect URI to http://localhost, and select an Application Category of your choosing.
|
| 332 |
+
|
| 333 |
+
4. Click Register.
|
| 334 |
+
|
| 335 |
+
5. Copy your client ID and your client secret into:
|
| 336 |
+
``[p]set api twitch client_id <your_client_id_here> client_secret <your_client_secret_here>``
|
| 337 |
+
|
| 338 |
+
.. attention:: These tokens are sensitive and should only be
|
| 339 |
+
used in a private channel or in DM with the bot.
|
| 340 |
+
|
| 341 |
+
.. _streams-command-streamset-usebuttons:
|
| 342 |
+
|
| 343 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 344 |
+
streamset usebuttons
|
| 345 |
+
^^^^^^^^^^^^^^^^^^^^
|
| 346 |
+
|
| 347 |
+
**Syntax**
|
| 348 |
+
|
| 349 |
+
.. code-block:: none
|
| 350 |
+
|
| 351 |
+
[p]streamset usebuttons
|
| 352 |
+
|
| 353 |
+
**Description**
|
| 354 |
+
|
| 355 |
+
Toggle whether to use buttons for stream alerts.
|
| 356 |
+
|
| 357 |
+
.. _streams-command-picarto:
|
| 358 |
+
|
| 359 |
+
^^^^^^^
|
| 360 |
+
picarto
|
| 361 |
+
^^^^^^^
|
| 362 |
+
|
| 363 |
+
**Syntax**
|
| 364 |
+
|
| 365 |
+
.. code-block:: none
|
| 366 |
+
|
| 367 |
+
[p]picarto <channel_name>
|
| 368 |
+
|
| 369 |
+
**Description**
|
| 370 |
+
|
| 371 |
+
Check if a Picarto channel is live.
|
| 372 |
+
|
| 373 |
+
**Arguments**
|
| 374 |
+
|
| 375 |
+
* ``<channel_name>``: The Picarto channel to check.
|
| 376 |
+
|
| 377 |
+
.. _streams-command-twitchstream:
|
| 378 |
+
|
| 379 |
+
^^^^^^^^^^^^
|
| 380 |
+
twitchstream
|
| 381 |
+
^^^^^^^^^^^^
|
| 382 |
+
|
| 383 |
+
**Syntax**
|
| 384 |
+
|
| 385 |
+
.. code-block:: none
|
| 386 |
+
|
| 387 |
+
[p]twitchstream <channel_name>
|
| 388 |
+
|
| 389 |
+
**Description**
|
| 390 |
+
|
| 391 |
+
Check if a Twitch channel is live.
|
| 392 |
+
|
| 393 |
+
**Arguments**
|
| 394 |
+
|
| 395 |
+
* ``<channel_name>``: The Twitch channel to check.
|
| 396 |
+
|
| 397 |
+
.. _streams-command-youtubestream:
|
| 398 |
+
|
| 399 |
+
^^^^^^^^^^^^^
|
| 400 |
+
youtubestream
|
| 401 |
+
^^^^^^^^^^^^^
|
| 402 |
+
|
| 403 |
+
**Syntax**
|
| 404 |
+
|
| 405 |
+
.. code-block:: none
|
| 406 |
+
|
| 407 |
+
[p]youtubestream <channel_id_or_name>
|
| 408 |
+
|
| 409 |
+
**Description**
|
| 410 |
+
|
| 411 |
+
Check if a YouTube channel is live.
|
| 412 |
+
|
| 413 |
+
**Arguments**
|
| 414 |
+
|
| 415 |
+
* ``<channel_id_or_name>``: The name or id of the YouTube channel to be checked.
|
| 416 |
+
|
| 417 |
+
.. _streams-command-streamalert:
|
| 418 |
+
|
| 419 |
+
^^^^^^^^^^^
|
| 420 |
+
streamalert
|
| 421 |
+
^^^^^^^^^^^
|
| 422 |
+
|
| 423 |
+
**Syntax**
|
| 424 |
+
|
| 425 |
+
.. code-block:: none
|
| 426 |
+
|
| 427 |
+
[p]streamalert
|
| 428 |
+
|
| 429 |
+
**Description**
|
| 430 |
+
|
| 431 |
+
Manage automated stream alerts.
|
| 432 |
+
|
| 433 |
+
.. _streams-command-streamalert-list:
|
| 434 |
+
|
| 435 |
+
^^^^^^^^^^^^^^^^
|
| 436 |
+
streamalert list
|
| 437 |
+
^^^^^^^^^^^^^^^^
|
| 438 |
+
|
| 439 |
+
**Syntax**
|
| 440 |
+
|
| 441 |
+
.. code-block:: none
|
| 442 |
+
|
| 443 |
+
[p]streamalert list
|
| 444 |
+
|
| 445 |
+
**Description**
|
| 446 |
+
|
| 447 |
+
Lists all active alerts in the current server.
|
| 448 |
+
|
| 449 |
+
.. _streams-command-streamalert-picarto:
|
| 450 |
+
|
| 451 |
+
^^^^^^^^^^^^^^^^^^^
|
| 452 |
+
streamalert picarto
|
| 453 |
+
^^^^^^^^^^^^^^^^^^^
|
| 454 |
+
|
| 455 |
+
**Syntax**
|
| 456 |
+
|
| 457 |
+
.. code-block:: none
|
| 458 |
+
|
| 459 |
+
[p]streamalert picarto <channel_name>
|
| 460 |
+
|
| 461 |
+
**Description**
|
| 462 |
+
|
| 463 |
+
Toggle alerts in the current channel for the
|
| 464 |
+
specified Picarto channel.
|
| 465 |
+
|
| 466 |
+
**Arguments**
|
| 467 |
+
|
| 468 |
+
* ``<channel_name>``: The Picarto channel to toggle the alert for.
|
| 469 |
+
|
| 470 |
+
.. _streams-command-streamalert-twitch-channel:
|
| 471 |
+
|
| 472 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 473 |
+
streamalert twitch channel
|
| 474 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 475 |
+
|
| 476 |
+
**Syntax**
|
| 477 |
+
|
| 478 |
+
.. code-block:: none
|
| 479 |
+
|
| 480 |
+
[p]streamalert twitch channel <channel_name>
|
| 481 |
+
|
| 482 |
+
**Description**
|
| 483 |
+
|
| 484 |
+
Toggle alerts in the current channel for the
|
| 485 |
+
specified Twitch channel.
|
| 486 |
+
|
| 487 |
+
**Arguments**
|
| 488 |
+
|
| 489 |
+
* ``<channel_name>``: The Twitch channel to toggle the alert for.
|
| 490 |
+
|
| 491 |
+
.. _streams-command-streamalert-youtube:
|
| 492 |
+
|
| 493 |
+
^^^^^^^^^^^^^^^^^^^
|
| 494 |
+
streamalert youtube
|
| 495 |
+
^^^^^^^^^^^^^^^^^^^
|
| 496 |
+
|
| 497 |
+
**Syntax**
|
| 498 |
+
|
| 499 |
+
.. code-block:: none
|
| 500 |
+
|
| 501 |
+
[p]streamalert youtube <channel_name>
|
| 502 |
+
|
| 503 |
+
**Description**
|
| 504 |
+
|
| 505 |
+
Toggle alerts in the current channel for the
|
| 506 |
+
specified Picarto channel.
|
| 507 |
+
|
| 508 |
+
**Arguments**
|
| 509 |
+
|
| 510 |
+
* ``<channel_id_or_name>``: The name or id of the YouTube channel to be checked.
|
| 511 |
+
|
| 512 |
+
.. _streams-command-streamalert-stop:
|
| 513 |
+
|
| 514 |
+
^^^^^^^^^^^^^^^^
|
| 515 |
+
streamalert stop
|
| 516 |
+
^^^^^^^^^^^^^^^^
|
| 517 |
+
|
| 518 |
+
**Syntax**
|
| 519 |
+
|
| 520 |
+
.. code-block:: none
|
| 521 |
+
|
| 522 |
+
[p]streamalert stop [disable-all=No]
|
| 523 |
+
|
| 524 |
+
**Description**
|
| 525 |
+
|
| 526 |
+
Disable all stream alerts for this channel or server.
|
| 527 |
+
|
| 528 |
+
**Arguments**
|
| 529 |
+
|
| 530 |
+
* ``[disable-all]``: Defaults to ``no``. If this is set to ``yes``, all
|
| 531 |
+
stream alerts in the current server will be disabled.
|
| 532 |
+
If ``no`` or unspecified, all stream alerts in the
|
| 533 |
+
current channel will be stopped.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/trivia.rst
ADDED
|
@@ -0,0 +1,439 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _trivia:
|
| 2 |
+
|
| 3 |
+
======
|
| 4 |
+
Trivia
|
| 5 |
+
======
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the trivia cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load trivia
|
| 15 |
+
|
| 16 |
+
.. _trivia-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
This cog allows for playing trivia with others. You may
|
| 23 |
+
choose to play just one category at a time or choose
|
| 24 |
+
multiple to add variety to your game. You can even create
|
| 25 |
+
your own lists!
|
| 26 |
+
|
| 27 |
+
.. _trivia-commands:
|
| 28 |
+
|
| 29 |
+
--------
|
| 30 |
+
Commands
|
| 31 |
+
--------
|
| 32 |
+
|
| 33 |
+
Here is a list of all of the commands for this cog:
|
| 34 |
+
|
| 35 |
+
.. _trivia-command-triviaset:
|
| 36 |
+
|
| 37 |
+
^^^^^^^^^
|
| 38 |
+
triviaset
|
| 39 |
+
^^^^^^^^^
|
| 40 |
+
|
| 41 |
+
.. note:: |mod-lock|
|
| 42 |
+
|
| 43 |
+
**Syntax**
|
| 44 |
+
|
| 45 |
+
.. code-block:: none
|
| 46 |
+
|
| 47 |
+
[p]triviaset
|
| 48 |
+
|
| 49 |
+
**Description**
|
| 50 |
+
|
| 51 |
+
Commands for managing trivia settings.
|
| 52 |
+
|
| 53 |
+
.. _trivia-command-triviaset-botplays:
|
| 54 |
+
|
| 55 |
+
^^^^^^^^^^^^^^^^^^
|
| 56 |
+
triviaset botplays
|
| 57 |
+
^^^^^^^^^^^^^^^^^^
|
| 58 |
+
|
| 59 |
+
.. note:: |mod-lock|
|
| 60 |
+
|
| 61 |
+
**Syntax**
|
| 62 |
+
|
| 63 |
+
.. code-block:: none
|
| 64 |
+
|
| 65 |
+
[p]triviaset botplays <true_or_false>
|
| 66 |
+
|
| 67 |
+
**Description**
|
| 68 |
+
|
| 69 |
+
Sets whether the bot gains a point if nobody guesses correctly.
|
| 70 |
+
|
| 71 |
+
**Arguments**
|
| 72 |
+
|
| 73 |
+
- ``<true_or_false>`` If ``true``, the bot will gain a point if nobody
|
| 74 |
+
guesses correctly, otherwise it will not.
|
| 75 |
+
|
| 76 |
+
.. _trivia-command-triviaset-maxscore:
|
| 77 |
+
|
| 78 |
+
^^^^^^^^^^^^^^^^^^
|
| 79 |
+
triviaset maxscore
|
| 80 |
+
^^^^^^^^^^^^^^^^^^
|
| 81 |
+
|
| 82 |
+
.. note:: |mod-lock|
|
| 83 |
+
|
| 84 |
+
**Syntax**
|
| 85 |
+
|
| 86 |
+
.. code-block:: none
|
| 87 |
+
|
| 88 |
+
[p]triviaset maxscore <score>
|
| 89 |
+
|
| 90 |
+
**Description**
|
| 91 |
+
|
| 92 |
+
Sets the total points required to win.
|
| 93 |
+
|
| 94 |
+
**Arguments**
|
| 95 |
+
|
| 96 |
+
- ``<score>`` The amount of points required to win.
|
| 97 |
+
|
| 98 |
+
.. _trivia-command-triviaset-override:
|
| 99 |
+
|
| 100 |
+
^^^^^^^^^^^^^^^^^^
|
| 101 |
+
triviaset override
|
| 102 |
+
^^^^^^^^^^^^^^^^^^
|
| 103 |
+
|
| 104 |
+
.. note:: |mod-lock|
|
| 105 |
+
|
| 106 |
+
**Syntax**
|
| 107 |
+
|
| 108 |
+
.. code-block:: none
|
| 109 |
+
|
| 110 |
+
[p]triviaset override <enabled>
|
| 111 |
+
|
| 112 |
+
**Description**
|
| 113 |
+
|
| 114 |
+
Allow/disallow trivia lists to override the settings.
|
| 115 |
+
|
| 116 |
+
**Arguments**
|
| 117 |
+
|
| 118 |
+
- ``<enabled>`` Whether trivia lists should be able to override settings.
|
| 119 |
+
|
| 120 |
+
.. _trivia-command-triviaset-payout:
|
| 121 |
+
|
| 122 |
+
^^^^^^^^^^^^^^^^
|
| 123 |
+
triviaset payout
|
| 124 |
+
^^^^^^^^^^^^^^^^
|
| 125 |
+
|
| 126 |
+
.. note:: |mod-lock|
|
| 127 |
+
|
| 128 |
+
**Syntax**
|
| 129 |
+
|
| 130 |
+
.. code-block:: none
|
| 131 |
+
|
| 132 |
+
[p]triviaset payout <multiplier>
|
| 133 |
+
|
| 134 |
+
**Description**
|
| 135 |
+
|
| 136 |
+
Sets the payout multiplier.
|
| 137 |
+
|
| 138 |
+
If a user wins trivia when at least 3 users are playing, they will receive credits;
|
| 139 |
+
the amount received is determined by multiplying their total score by this multiplier.
|
| 140 |
+
|
| 141 |
+
**Arguments**
|
| 142 |
+
|
| 143 |
+
- ``<multiplier>`` The amount to multiply the winner's score by to determine payout.
|
| 144 |
+
This can be any positive decimal number. Setting this to 0 will disable.
|
| 145 |
+
|
| 146 |
+
.. _trivia-command-triviaset-revealanswer:
|
| 147 |
+
|
| 148 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 149 |
+
triviaset revealanswer
|
| 150 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 151 |
+
|
| 152 |
+
.. note:: |mod-lock|
|
| 153 |
+
|
| 154 |
+
**Syntax**
|
| 155 |
+
|
| 156 |
+
.. code-block:: none
|
| 157 |
+
|
| 158 |
+
[p]triviaset revealanswer <true_or_false>
|
| 159 |
+
|
| 160 |
+
**Description**
|
| 161 |
+
|
| 162 |
+
Sets whether or not the answer is revealed if the time limit for answering runs out.
|
| 163 |
+
|
| 164 |
+
**Arguments**
|
| 165 |
+
|
| 166 |
+
- ``<true_or_false>`` If ``true``, the bot will reveal the answer if there is no
|
| 167 |
+
correct guess within the time limit.
|
| 168 |
+
|
| 169 |
+
.. _trivia-command-triviaset-showsettings:
|
| 170 |
+
|
| 171 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 172 |
+
triviaset showsettings
|
| 173 |
+
^^^^^^^^^^^^^^^^^^^^^^
|
| 174 |
+
|
| 175 |
+
.. note:: |mod-lock|
|
| 176 |
+
|
| 177 |
+
**Syntax**
|
| 178 |
+
|
| 179 |
+
.. code-block:: none
|
| 180 |
+
|
| 181 |
+
[p]triviaset showsettings
|
| 182 |
+
|
| 183 |
+
**Description**
|
| 184 |
+
|
| 185 |
+
Shows the current trivia settings.
|
| 186 |
+
|
| 187 |
+
.. _trivia-command-triviaset-stopafter:
|
| 188 |
+
|
| 189 |
+
^^^^^^^^^^^^^^^^^^^
|
| 190 |
+
triviaset stopafter
|
| 191 |
+
^^^^^^^^^^^^^^^^^^^
|
| 192 |
+
|
| 193 |
+
.. note:: |mod-lock|
|
| 194 |
+
|
| 195 |
+
**Syntax**
|
| 196 |
+
|
| 197 |
+
.. code-block:: none
|
| 198 |
+
|
| 199 |
+
[p]triviaset stopafter <seconds>
|
| 200 |
+
|
| 201 |
+
**Description**
|
| 202 |
+
|
| 203 |
+
Sets how long the bot should wait before stopping the trivia
|
| 204 |
+
session due to lack of response.
|
| 205 |
+
|
| 206 |
+
**Arguments**
|
| 207 |
+
|
| 208 |
+
- ``<seconds>`` The number of seconds to wait before stopping the session.
|
| 209 |
+
|
| 210 |
+
.. _trivia-command-triviaset-timelimit:
|
| 211 |
+
|
| 212 |
+
^^^^^^^^^^^^^^^^^^^
|
| 213 |
+
triviaset timelimit
|
| 214 |
+
^^^^^^^^^^^^^^^^^^^
|
| 215 |
+
|
| 216 |
+
.. note:: |mod-lock|
|
| 217 |
+
|
| 218 |
+
**Syntax**
|
| 219 |
+
|
| 220 |
+
.. code-block:: none
|
| 221 |
+
|
| 222 |
+
[p]triviaset timelimit <seconds>
|
| 223 |
+
|
| 224 |
+
**Description**
|
| 225 |
+
|
| 226 |
+
Sets the maximum time permitted to answer a question.
|
| 227 |
+
|
| 228 |
+
**Arguments**
|
| 229 |
+
|
| 230 |
+
- ``<seconds>`` The number of seconds to wait for an answer.
|
| 231 |
+
|
| 232 |
+
.. _trivia-command-triviaset-custom:
|
| 233 |
+
|
| 234 |
+
^^^^^^^^^^^^^^^^
|
| 235 |
+
triviaset custom
|
| 236 |
+
^^^^^^^^^^^^^^^^
|
| 237 |
+
|
| 238 |
+
.. note:: |owner-lock|
|
| 239 |
+
|
| 240 |
+
**Syntax**
|
| 241 |
+
|
| 242 |
+
.. code-block:: none
|
| 243 |
+
|
| 244 |
+
[p]triviaset custom
|
| 245 |
+
|
| 246 |
+
**Description**
|
| 247 |
+
|
| 248 |
+
Manage custom trivia lists.
|
| 249 |
+
|
| 250 |
+
.. tip::
|
| 251 |
+
|
| 252 |
+
Looking to learn how to create your own trivia lists?
|
| 253 |
+
See :ref:`here <guide_trivia_list_creation>` for more information.
|
| 254 |
+
|
| 255 |
+
.. _trivia-command-triviaset-custom-upload:
|
| 256 |
+
|
| 257 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 258 |
+
triviaset custom upload
|
| 259 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 260 |
+
|
| 261 |
+
.. note:: |owner-lock|
|
| 262 |
+
|
| 263 |
+
**Syntax**
|
| 264 |
+
|
| 265 |
+
.. code-block:: none
|
| 266 |
+
|
| 267 |
+
[p]triviaset custom upload
|
| 268 |
+
|
| 269 |
+
**Description**
|
| 270 |
+
|
| 271 |
+
Upload a custom trivia list. The bot will prompt you to upload
|
| 272 |
+
your list as an attachment in Discord.
|
| 273 |
+
|
| 274 |
+
.. _trivia-command-triviaset-custom-list:
|
| 275 |
+
|
| 276 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 277 |
+
triviaset custom list
|
| 278 |
+
^^^^^^^^^^^^^^^^^^^^^
|
| 279 |
+
|
| 280 |
+
.. note:: |owner-lock|
|
| 281 |
+
|
| 282 |
+
**Syntax**
|
| 283 |
+
|
| 284 |
+
.. code-block:: none
|
| 285 |
+
|
| 286 |
+
[p]triviaset custom list
|
| 287 |
+
|
| 288 |
+
**Description**
|
| 289 |
+
|
| 290 |
+
List all uploaded custom trivia lists.
|
| 291 |
+
|
| 292 |
+
.. _trivia-command-triviaset-custom-delete:
|
| 293 |
+
|
| 294 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 295 |
+
triviaset custom delete
|
| 296 |
+
^^^^^^^^^^^^^^^^^^^^^^^
|
| 297 |
+
|
| 298 |
+
.. note:: |owner-lock|
|
| 299 |
+
|
| 300 |
+
**Syntax**
|
| 301 |
+
|
| 302 |
+
.. code-block:: none
|
| 303 |
+
|
| 304 |
+
[p]triviaset custom delete <name>
|
| 305 |
+
|
| 306 |
+
**Description**
|
| 307 |
+
|
| 308 |
+
Delete a custom trivia list.
|
| 309 |
+
|
| 310 |
+
**Arguments**
|
| 311 |
+
|
| 312 |
+
- ``<name>`` The name of the custom list to be deleted.
|
| 313 |
+
|
| 314 |
+
.. _trivia-command-trivia:
|
| 315 |
+
|
| 316 |
+
^^^^^^
|
| 317 |
+
trivia
|
| 318 |
+
^^^^^^
|
| 319 |
+
|
| 320 |
+
**Syntax**
|
| 321 |
+
|
| 322 |
+
.. code-block:: none
|
| 323 |
+
|
| 324 |
+
[p]trivia <categories...>
|
| 325 |
+
|
| 326 |
+
**Description**
|
| 327 |
+
|
| 328 |
+
Start a trivia session on the specified category.
|
| 329 |
+
|
| 330 |
+
Multiple categories can be listed, in which case the trivia session
|
| 331 |
+
will use all of the specified lists to select questions from.
|
| 332 |
+
|
| 333 |
+
**Arguments**
|
| 334 |
+
|
| 335 |
+
- ``<categories...>`` The category to play. Can be multiple.
|
| 336 |
+
|
| 337 |
+
.. _trivia-command-trivia-leaderboard:
|
| 338 |
+
|
| 339 |
+
^^^^^^^^^^^^^^^^^^
|
| 340 |
+
trivia leaderboard
|
| 341 |
+
^^^^^^^^^^^^^^^^^^
|
| 342 |
+
|
| 343 |
+
**Syntax**
|
| 344 |
+
|
| 345 |
+
.. code-block:: none
|
| 346 |
+
|
| 347 |
+
[p]trivia leaderboard
|
| 348 |
+
|
| 349 |
+
**Description**
|
| 350 |
+
|
| 351 |
+
Shows the trivia leaderboard. Defaults to the top ten in the
|
| 352 |
+
current server, sorted by total wins. The subcommands provide
|
| 353 |
+
more customized leaderboards.
|
| 354 |
+
|
| 355 |
+
.. _trivia-command-trivia-leaderboard-global:
|
| 356 |
+
|
| 357 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 358 |
+
trivia leaderboard global
|
| 359 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 360 |
+
|
| 361 |
+
**Syntax**
|
| 362 |
+
|
| 363 |
+
.. code-block:: none
|
| 364 |
+
|
| 365 |
+
[p]trivia leaderboard global [sort_by=wins] [top=10]
|
| 366 |
+
|
| 367 |
+
**Description**
|
| 368 |
+
|
| 369 |
+
The global trivia leaderboard.
|
| 370 |
+
|
| 371 |
+
**Arguments**
|
| 372 |
+
|
| 373 |
+
- ``[sort_by=wins]`` The method by which to sort the leaderboard (defaults to wins). Can be one of:
|
| 374 |
+
|
| 375 |
+
- ``wins`` Total wins
|
| 376 |
+
- ``avg`` Average score
|
| 377 |
+
- ``total`` Total correct answers from all sessions
|
| 378 |
+
- ``games`` Total games played.
|
| 379 |
+
|
| 380 |
+
- ``[top=10]`` The number of ranks to show on the leaderboard. Defaults to 10
|
| 381 |
+
|
| 382 |
+
.. _trivia-command-trivia-leaderboard-server:
|
| 383 |
+
|
| 384 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 385 |
+
trivia leaderboard server
|
| 386 |
+
^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 387 |
+
|
| 388 |
+
**Syntax**
|
| 389 |
+
|
| 390 |
+
.. code-block:: none
|
| 391 |
+
|
| 392 |
+
[p]trivia leaderboard server [sort_by=wins] [top=10]
|
| 393 |
+
|
| 394 |
+
**Description**
|
| 395 |
+
|
| 396 |
+
The trivia leaderboard for this server.
|
| 397 |
+
|
| 398 |
+
**Arguments**
|
| 399 |
+
|
| 400 |
+
- ``[sort_by=wins]`` The method by which to sort the leaderboard (defaults to wins). Can be one of:
|
| 401 |
+
|
| 402 |
+
- ``wins`` Total wins
|
| 403 |
+
- ``avg`` Average score
|
| 404 |
+
- ``total`` Total correct answers from all sessions
|
| 405 |
+
- ``games`` Total games played.
|
| 406 |
+
|
| 407 |
+
- ``[top=10]`` The number of ranks to show on the leaderboard. Defaults to 10
|
| 408 |
+
|
| 409 |
+
.. _trivia-command-trivia-list:
|
| 410 |
+
|
| 411 |
+
^^^^^^^^^^^
|
| 412 |
+
trivia list
|
| 413 |
+
^^^^^^^^^^^
|
| 414 |
+
|
| 415 |
+
**Syntax**
|
| 416 |
+
|
| 417 |
+
.. code-block:: none
|
| 418 |
+
|
| 419 |
+
[p]trivia list
|
| 420 |
+
|
| 421 |
+
**Description**
|
| 422 |
+
|
| 423 |
+
Lists the available trivia categories
|
| 424 |
+
|
| 425 |
+
.. _trivia-command-trivia-stop:
|
| 426 |
+
|
| 427 |
+
^^^^^^^^^^^
|
| 428 |
+
trivia stop
|
| 429 |
+
^^^^^^^^^^^
|
| 430 |
+
|
| 431 |
+
**Syntax**
|
| 432 |
+
|
| 433 |
+
.. code-block:: none
|
| 434 |
+
|
| 435 |
+
[p]trivia stop
|
| 436 |
+
|
| 437 |
+
**Description**
|
| 438 |
+
|
| 439 |
+
Stops an ongoing trivia session.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_guides/warnings.rst
ADDED
|
@@ -0,0 +1,403 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. _warnings:
|
| 2 |
+
|
| 3 |
+
========
|
| 4 |
+
Warnings
|
| 5 |
+
========
|
| 6 |
+
|
| 7 |
+
This is the cog guide for the warnings cog. You will
|
| 8 |
+
find detailed docs about usage and commands.
|
| 9 |
+
|
| 10 |
+
``[p]`` is considered as your prefix.
|
| 11 |
+
|
| 12 |
+
.. note:: To use this cog, load it by typing this::
|
| 13 |
+
|
| 14 |
+
[p]load warnings
|
| 15 |
+
|
| 16 |
+
.. _warnings-usage:
|
| 17 |
+
|
| 18 |
+
-----
|
| 19 |
+
Usage
|
| 20 |
+
-----
|
| 21 |
+
|
| 22 |
+
Warn misbehaving users and take automated actions.
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
.. _warnings-commands:
|
| 26 |
+
|
| 27 |
+
--------
|
| 28 |
+
Commands
|
| 29 |
+
--------
|
| 30 |
+
|
| 31 |
+
.. _warnings-command-actionlist:
|
| 32 |
+
|
| 33 |
+
^^^^^^^^^^
|
| 34 |
+
actionlist
|
| 35 |
+
^^^^^^^^^^
|
| 36 |
+
|
| 37 |
+
.. note:: |admin-lock|
|
| 38 |
+
|
| 39 |
+
**Syntax**
|
| 40 |
+
|
| 41 |
+
.. code-block:: none
|
| 42 |
+
|
| 43 |
+
[p]actionlist
|
| 44 |
+
|
| 45 |
+
**Description**
|
| 46 |
+
|
| 47 |
+
List all configured automated actions for Warnings.
|
| 48 |
+
|
| 49 |
+
.. _warnings-command-mywarnings:
|
| 50 |
+
|
| 51 |
+
^^^^^^^^^^
|
| 52 |
+
mywarnings
|
| 53 |
+
^^^^^^^^^^
|
| 54 |
+
|
| 55 |
+
**Syntax**
|
| 56 |
+
|
| 57 |
+
.. code-block:: none
|
| 58 |
+
|
| 59 |
+
[p]mywarnings
|
| 60 |
+
|
| 61 |
+
**Description**
|
| 62 |
+
|
| 63 |
+
List warnings for yourself.
|
| 64 |
+
|
| 65 |
+
.. _warnings-command-reasonlist:
|
| 66 |
+
|
| 67 |
+
^^^^^^^^^^
|
| 68 |
+
reasonlist
|
| 69 |
+
^^^^^^^^^^
|
| 70 |
+
|
| 71 |
+
.. note:: |admin-lock|
|
| 72 |
+
|
| 73 |
+
**Syntax**
|
| 74 |
+
|
| 75 |
+
.. code-block:: none
|
| 76 |
+
|
| 77 |
+
[p]reasonlist
|
| 78 |
+
|
| 79 |
+
**Description**
|
| 80 |
+
|
| 81 |
+
List all configured reasons for Warnings.
|
| 82 |
+
|
| 83 |
+
.. _warnings-command-unwarn:
|
| 84 |
+
|
| 85 |
+
^^^^^^
|
| 86 |
+
unwarn
|
| 87 |
+
^^^^^^
|
| 88 |
+
|
| 89 |
+
.. note:: |admin-lock|
|
| 90 |
+
|
| 91 |
+
**Syntax**
|
| 92 |
+
|
| 93 |
+
.. code-block:: none
|
| 94 |
+
|
| 95 |
+
[p]unwarn <member> <warn_id> [reason]
|
| 96 |
+
|
| 97 |
+
**Description**
|
| 98 |
+
|
| 99 |
+
Remove a warning from a member.
|
| 100 |
+
|
| 101 |
+
**Arguments**
|
| 102 |
+
|
| 103 |
+
* ``<member>``: The member to remove the warning from. |member-input-quotes|
|
| 104 |
+
* ``<warn_id>``: The warning ID to remove from the member.
|
| 105 |
+
* ``[reason]``: The reason for unwarning this member.
|
| 106 |
+
|
| 107 |
+
.. _warnings-command-warn:
|
| 108 |
+
|
| 109 |
+
^^^^
|
| 110 |
+
warn
|
| 111 |
+
^^^^
|
| 112 |
+
|
| 113 |
+
.. note:: |admin-lock|
|
| 114 |
+
|
| 115 |
+
**Syntax**
|
| 116 |
+
|
| 117 |
+
.. code-block:: none
|
| 118 |
+
|
| 119 |
+
[p]warn <member> [points=1] <reason>
|
| 120 |
+
|
| 121 |
+
**Description**
|
| 122 |
+
|
| 123 |
+
Warn the user for the specified reason.
|
| 124 |
+
|
| 125 |
+
**Arguments**
|
| 126 |
+
|
| 127 |
+
* ``<member>``: The member to warn. |member-input-quotes|
|
| 128 |
+
* ``[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.
|
| 129 |
+
* ``<reason>``: The reason for the warning. This can be a registered reason, or a custom reason if ``[p]warningset allowcustomreasons`` is set.
|
| 130 |
+
|
| 131 |
+
.. _warnings-command-warnaction:
|
| 132 |
+
|
| 133 |
+
^^^^^^^^^^
|
| 134 |
+
warnaction
|
| 135 |
+
^^^^^^^^^^
|
| 136 |
+
|
| 137 |
+
.. note:: |guildowner-lock|
|
| 138 |
+
|
| 139 |
+
**Syntax**
|
| 140 |
+
|
| 141 |
+
.. code-block:: none
|
| 142 |
+
|
| 143 |
+
[p]warnaction
|
| 144 |
+
|
| 145 |
+
**Description**
|
| 146 |
+
|
| 147 |
+
Manage automated actions for Warnings.
|
| 148 |
+
|
| 149 |
+
Actions are essentially command macros. Any command can be run
|
| 150 |
+
when the action is initially triggered, and/or when the action
|
| 151 |
+
is lifted.
|
| 152 |
+
|
| 153 |
+
Actions must be given a name and a points threshold. When a
|
| 154 |
+
user is warned enough so that their points go over this
|
| 155 |
+
threshold, the action will be executed.
|
| 156 |
+
|
| 157 |
+
.. _warnings-command-warnaction-add:
|
| 158 |
+
|
| 159 |
+
""""""""""""""
|
| 160 |
+
warnaction add
|
| 161 |
+
""""""""""""""
|
| 162 |
+
|
| 163 |
+
**Syntax**
|
| 164 |
+
|
| 165 |
+
.. code-block:: none
|
| 166 |
+
|
| 167 |
+
[p]warnaction add <name> <points>
|
| 168 |
+
|
| 169 |
+
**Description**
|
| 170 |
+
|
| 171 |
+
Create an automated action.
|
| 172 |
+
|
| 173 |
+
Duplicate action names are not allowed.
|
| 174 |
+
|
| 175 |
+
**Arguments**
|
| 176 |
+
|
| 177 |
+
* ``<name>``: The name of the action.
|
| 178 |
+
* ``<points>``: The number of points for this action.
|
| 179 |
+
|
| 180 |
+
.. _warnings-command-warnaction-delete:
|
| 181 |
+
|
| 182 |
+
"""""""""""""""""
|
| 183 |
+
warnaction delete
|
| 184 |
+
"""""""""""""""""
|
| 185 |
+
|
| 186 |
+
**Syntax**
|
| 187 |
+
|
| 188 |
+
.. code-block:: none
|
| 189 |
+
|
| 190 |
+
[p]warnaction delete <action_name>
|
| 191 |
+
|
| 192 |
+
**Description**
|
| 193 |
+
|
| 194 |
+
Delete the action with the specified name.
|
| 195 |
+
|
| 196 |
+
**Arguments**
|
| 197 |
+
|
| 198 |
+
* ``<action_name>``: The name of the action to delete.
|
| 199 |
+
|
| 200 |
+
.. _warnings-command-warnings:
|
| 201 |
+
|
| 202 |
+
^^^^^^^^
|
| 203 |
+
warnings
|
| 204 |
+
^^^^^^^^
|
| 205 |
+
|
| 206 |
+
.. note:: |admin-lock|
|
| 207 |
+
|
| 208 |
+
**Syntax**
|
| 209 |
+
|
| 210 |
+
.. code-block:: none
|
| 211 |
+
|
| 212 |
+
[p]warnings <member>
|
| 213 |
+
|
| 214 |
+
**Description**
|
| 215 |
+
|
| 216 |
+
List the warnings for the specified member.
|
| 217 |
+
|
| 218 |
+
**Arguments**
|
| 219 |
+
|
| 220 |
+
* ``<member>``: The member to get the warnings for. |member-input|
|
| 221 |
+
|
| 222 |
+
.. _warnings-command-warningset:
|
| 223 |
+
|
| 224 |
+
^^^^^^^^^^
|
| 225 |
+
warningset
|
| 226 |
+
^^^^^^^^^^
|
| 227 |
+
|
| 228 |
+
.. note:: |guildowner-lock|
|
| 229 |
+
|
| 230 |
+
**Syntax**
|
| 231 |
+
|
| 232 |
+
.. code-block:: none
|
| 233 |
+
|
| 234 |
+
[p]warningset
|
| 235 |
+
|
| 236 |
+
**Description**
|
| 237 |
+
|
| 238 |
+
Manage settings for Warnings.
|
| 239 |
+
|
| 240 |
+
.. _warnings-command-warningset-allowcustomreasons:
|
| 241 |
+
|
| 242 |
+
"""""""""""""""""""""""""""""
|
| 243 |
+
warningset allowcustomreasons
|
| 244 |
+
"""""""""""""""""""""""""""""
|
| 245 |
+
|
| 246 |
+
**Syntax**
|
| 247 |
+
|
| 248 |
+
.. code-block:: none
|
| 249 |
+
|
| 250 |
+
[p]warningset allowcustomreasons <true_or_false>
|
| 251 |
+
|
| 252 |
+
**Description**
|
| 253 |
+
|
| 254 |
+
Enable or disable custom reasons for a warning.
|
| 255 |
+
|
| 256 |
+
**Arguments**
|
| 257 |
+
|
| 258 |
+
* ``<true_or_false>``: |bool-input|
|
| 259 |
+
|
| 260 |
+
.. _warnings-command-warningset-senddm:
|
| 261 |
+
|
| 262 |
+
"""""""""""""""""
|
| 263 |
+
warningset senddm
|
| 264 |
+
"""""""""""""""""
|
| 265 |
+
|
| 266 |
+
**Syntax**
|
| 267 |
+
|
| 268 |
+
.. code-block:: none
|
| 269 |
+
|
| 270 |
+
[p]warningset senddm <true_or_false>
|
| 271 |
+
|
| 272 |
+
**Description**
|
| 273 |
+
|
| 274 |
+
Set whether warnings should be sent to users in DMs.
|
| 275 |
+
|
| 276 |
+
**Arguments**
|
| 277 |
+
|
| 278 |
+
* ``<true_or_false>``: |bool-input|
|
| 279 |
+
|
| 280 |
+
.. _warnings-command-warningset-showmoderator:
|
| 281 |
+
|
| 282 |
+
""""""""""""""""""""""""
|
| 283 |
+
warningset showmoderator
|
| 284 |
+
""""""""""""""""""""""""
|
| 285 |
+
|
| 286 |
+
**Syntax**
|
| 287 |
+
|
| 288 |
+
.. code-block:: none
|
| 289 |
+
|
| 290 |
+
[p]warningset showmoderator <true_or_false>
|
| 291 |
+
|
| 292 |
+
**Description**
|
| 293 |
+
|
| 294 |
+
Decide whether the name of the moderator warning a user should be included in the DM to that user.
|
| 295 |
+
|
| 296 |
+
**Arguments**
|
| 297 |
+
|
| 298 |
+
* ``<true_or_false>``: |bool-input|
|
| 299 |
+
|
| 300 |
+
.. _warnings-command-warningset-usewarnchannel:
|
| 301 |
+
|
| 302 |
+
"""""""""""""""""""""""""
|
| 303 |
+
warningset usewarnchannel
|
| 304 |
+
"""""""""""""""""""""""""
|
| 305 |
+
|
| 306 |
+
**Syntax**
|
| 307 |
+
|
| 308 |
+
.. code-block:: none
|
| 309 |
+
|
| 310 |
+
[p]warningset usewarnchannel <true_or_false>
|
| 311 |
+
|
| 312 |
+
**Description**
|
| 313 |
+
|
| 314 |
+
Set if warnings should be sent to a channel set with ``[p]warningset warnchannel``.
|
| 315 |
+
|
| 316 |
+
**Arguments**
|
| 317 |
+
|
| 318 |
+
* ``<true_or_false>``: |bool-input|
|
| 319 |
+
|
| 320 |
+
.. _warnings-command-warningset-warnchannel:
|
| 321 |
+
|
| 322 |
+
""""""""""""""""""""""
|
| 323 |
+
warningset warnchannel
|
| 324 |
+
""""""""""""""""""""""
|
| 325 |
+
|
| 326 |
+
**Syntax**
|
| 327 |
+
|
| 328 |
+
.. code-block:: none
|
| 329 |
+
|
| 330 |
+
[p]warningset warnchannel [channel]
|
| 331 |
+
|
| 332 |
+
**Description**
|
| 333 |
+
|
| 334 |
+
Set the channel where warnings should be sent to.
|
| 335 |
+
|
| 336 |
+
**Arguments**
|
| 337 |
+
|
| 338 |
+
* ``[channel]``: |channel-input| Leave empty to use the channel ``[p]warn`` command was called in.
|
| 339 |
+
|
| 340 |
+
.. _warnings-command-warnreason:
|
| 341 |
+
|
| 342 |
+
^^^^^^^^^^
|
| 343 |
+
warnreason
|
| 344 |
+
^^^^^^^^^^
|
| 345 |
+
|
| 346 |
+
.. note:: |guildowner-lock|
|
| 347 |
+
|
| 348 |
+
**Syntax**
|
| 349 |
+
|
| 350 |
+
.. code-block:: none
|
| 351 |
+
|
| 352 |
+
[p]warnreason
|
| 353 |
+
|
| 354 |
+
**Description**
|
| 355 |
+
|
| 356 |
+
Manage warning reasons.
|
| 357 |
+
|
| 358 |
+
Reasons must be given a name, description and points value. The
|
| 359 |
+
name of the reason must be given when a user is warned.
|
| 360 |
+
|
| 361 |
+
.. _warnings-command-warnreason-create:
|
| 362 |
+
|
| 363 |
+
"""""""""""""""""
|
| 364 |
+
warnreason create
|
| 365 |
+
"""""""""""""""""
|
| 366 |
+
|
| 367 |
+
**Syntax**
|
| 368 |
+
|
| 369 |
+
.. code-block:: none
|
| 370 |
+
|
| 371 |
+
[p]warnreason create <name> <points> <description>
|
| 372 |
+
|
| 373 |
+
.. tip:: Alias: ``warnreason add``
|
| 374 |
+
|
| 375 |
+
**Description**
|
| 376 |
+
|
| 377 |
+
Create a warning reason.
|
| 378 |
+
|
| 379 |
+
**Arguments**
|
| 380 |
+
|
| 381 |
+
* ``<name>``: The name for the new reason.
|
| 382 |
+
* ``<points>``: The number of points with the new reason.
|
| 383 |
+
* ``<description>``: The description of the new warn reason.
|
| 384 |
+
|
| 385 |
+
.. _warnings-command-warnreason-delete:
|
| 386 |
+
|
| 387 |
+
"""""""""""""""""
|
| 388 |
+
warnreason delete
|
| 389 |
+
"""""""""""""""""
|
| 390 |
+
|
| 391 |
+
**Syntax**
|
| 392 |
+
|
| 393 |
+
.. code-block:: none
|
| 394 |
+
|
| 395 |
+
[p]warnreason delete <reason_name>
|
| 396 |
+
|
| 397 |
+
**Description**
|
| 398 |
+
|
| 399 |
+
Delete a warning reason.
|
| 400 |
+
|
| 401 |
+
**Arguments**
|
| 402 |
+
|
| 403 |
+
* ``<reason_name>``: The name of the reason to delete.
|
testbed/Cog-Creators__Red-DiscordBot/docs/cog_permissions.rst
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
.. Permissions Cog Reference
|
| 2 |
+
.. _cog_permissions:
|
| 3 |
+
|
| 4 |
+
=========================
|
| 5 |
+
Permissions Cog Reference
|
| 6 |
+
=========================
|
| 7 |
+
|
| 8 |
+
------------
|
| 9 |
+
How it works
|
| 10 |
+
------------
|
| 11 |
+
|
| 12 |
+
When loaded, the permissions cog will allow you to define extra custom rules for who can use a
|
| 13 |
+
command.
|
| 14 |
+
|
| 15 |
+
If no applicable rules are found, the command will behave normally.
|
| 16 |
+
|
| 17 |
+
Rules can also be added to cogs, which will affect all commands from that cog. The cog name can be
|
| 18 |
+
found from the help menu.
|
| 19 |
+
|
| 20 |
+
-------------
|
| 21 |
+
Rule priority
|
| 22 |
+
-------------
|
| 23 |
+
|
| 24 |
+
Rules set for subcommands will take precedence over rules set for the parent commands, which
|
| 25 |
+
lastly take precedence over rules set for the cog. So for example, if a user is denied the Core
|
| 26 |
+
cog, but allowed the ``[p]set token`` command, the user will not be able to use any command in the
|
| 27 |
+
Core cog except for ``[p]set token``.
|
| 28 |
+
|
| 29 |
+
In terms of scope, global rules will be checked first, then server rules.
|
| 30 |
+
|
| 31 |
+
For each of those, the first rule pertaining to one of the following models will be used:
|
| 32 |
+
|
| 33 |
+
1. User
|
| 34 |
+
2. Voice channel a user is connected to
|
| 35 |
+
3. The channel command was issued in (parent channel in case of invocations in threads)
|
| 36 |
+
4. Channel category
|
| 37 |
+
5. Roles, highest to lowest
|
| 38 |
+
6. Server (can only be in global rules)
|
| 39 |
+
7. Default rules
|
| 40 |
+
|
| 41 |
+
In private messages, only global rules about a user will be checked.
|
| 42 |
+
|
| 43 |
+
-------------------------
|
| 44 |
+
Setting Rules From a File
|
| 45 |
+
-------------------------
|
| 46 |
+
|
| 47 |
+
The permissions cog can also set, display or update rules with a YAML file with the
|
| 48 |
+
``[p]permissions yaml`` command. Models must be represented by ID. Rules must be ``true`` for
|
| 49 |
+
allow, or ``false`` for deny. Here is an example:
|
| 50 |
+
|
| 51 |
+
.. code-block:: yaml
|
| 52 |
+
|
| 53 |
+
COG:
|
| 54 |
+
Admin:
|
| 55 |
+
78631113035100160: true
|
| 56 |
+
96733288462286848: false
|
| 57 |
+
Audio:
|
| 58 |
+
133049272517001216: true
|
| 59 |
+
default: false
|
| 60 |
+
COMMAND:
|
| 61 |
+
cleanup bot:
|
| 62 |
+
78631113035100160: true
|
| 63 |
+
default: false
|
| 64 |
+
ping:
|
| 65 |
+
96733288462286848: false
|
| 66 |
+
default: true
|
| 67 |
+
|
| 68 |
+
----------------------
|
| 69 |
+
Example configurations
|
| 70 |
+
----------------------
|
| 71 |
+
|
| 72 |
+
Locking the ``[p]play`` command to approved server(s) as a bot owner:
|
| 73 |
+
|
| 74 |
+
.. code-block:: none
|
| 75 |
+
|
| 76 |
+
[p]permissions setdefaultglobalrule deny play
|
| 77 |
+
[p]permissions addglobalrule allow play [server ID or name]
|
| 78 |
+
|
| 79 |
+
Locking the ``[p]play`` command to specific voice channel(s) as a serverowner or admin:
|
| 80 |
+
|
| 81 |
+
.. code-block:: none
|
| 82 |
+
|
| 83 |
+
[p]permissions setdefaultserverrule deny play
|
| 84 |
+
[p]permissions setdefaultserverrule deny "playlist start"
|
| 85 |
+
[p]permissions addserverrule allow play [voice channel ID or name]
|
| 86 |
+
[p]permissions addserverrule allow "playlist start" [voice channel ID or name]
|
| 87 |
+
|
| 88 |
+
Allowing extra roles to use ``[p]cleanup``:
|
| 89 |
+
|
| 90 |
+
.. code-block:: none
|
| 91 |
+
|
| 92 |
+
[p]permissions addserverrule allow cleanup [role ID]
|
| 93 |
+
|
| 94 |
+
Preventing ``[p]cleanup`` from being used in channels where message history is important:
|
| 95 |
+
|
| 96 |
+
.. code-block:: none
|
| 97 |
+
|
| 98 |
+
[p]permissions addserverrule deny cleanup [channel ID or mention]
|
testbed/Cog-Creators__Red-DiscordBot/docs/conf.py
ADDED
|
@@ -0,0 +1,281 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/usr/bin/env python3
|
| 2 |
+
# -*- coding: utf-8 -*-
|
| 3 |
+
#
|
| 4 |
+
# Red - Discord Bot documentation build configuration file, created by
|
| 5 |
+
# sphinx-quickstart on Thu Aug 10 23:18:25 2017.
|
| 6 |
+
#
|
| 7 |
+
# This file is execfile()d with the current directory set to its
|
| 8 |
+
# containing dir.
|
| 9 |
+
#
|
| 10 |
+
# Note that not all possible configuration values are present in this
|
| 11 |
+
# autogenerated file.
|
| 12 |
+
#
|
| 13 |
+
# All configuration values have a default; values that are commented out
|
| 14 |
+
# serve to show the default.
|
| 15 |
+
|
| 16 |
+
# If extensions (or modules to document with autodoc) are in another directory,
|
| 17 |
+
# add these directories to sys.path here. If the directory is relative to the
|
| 18 |
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
| 19 |
+
#
|
| 20 |
+
import os
|
| 21 |
+
import sys
|
| 22 |
+
import time
|
| 23 |
+
|
| 24 |
+
sys.path.insert(0, os.path.abspath(".."))
|
| 25 |
+
sys.path.insert(0, os.path.abspath("_ext"))
|
| 26 |
+
|
| 27 |
+
os.environ["BUILDING_DOCS"] = "1"
|
| 28 |
+
|
| 29 |
+
|
| 30 |
+
# -- General configuration ------------------------------------------------
|
| 31 |
+
|
| 32 |
+
# If your documentation needs a minimal Sphinx version, state it here.
|
| 33 |
+
#
|
| 34 |
+
# needs_sphinx = '1.0'
|
| 35 |
+
|
| 36 |
+
# Add any Sphinx extension module names here, as strings. They can be
|
| 37 |
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
| 38 |
+
# ones.
|
| 39 |
+
extensions = [
|
| 40 |
+
"sphinx.ext.autodoc",
|
| 41 |
+
"sphinx.ext.extlinks",
|
| 42 |
+
"sphinx.ext.intersphinx",
|
| 43 |
+
"sphinx.ext.viewcode",
|
| 44 |
+
"sphinx.ext.napoleon",
|
| 45 |
+
"sphinx.ext.doctest",
|
| 46 |
+
"sphinxcontrib_trio",
|
| 47 |
+
"sphinx-prompt",
|
| 48 |
+
"deprecated_removed",
|
| 49 |
+
]
|
| 50 |
+
|
| 51 |
+
# Add any paths that contain templates here, relative to this directory.
|
| 52 |
+
templates_path = ["_templates"]
|
| 53 |
+
|
| 54 |
+
# The suffix(es) of source filenames.
|
| 55 |
+
# You can specify multiple suffix as a list of string:
|
| 56 |
+
#
|
| 57 |
+
# source_suffix = ['.rst', '.md']
|
| 58 |
+
source_suffix = ".rst"
|
| 59 |
+
|
| 60 |
+
# The master toctree document.
|
| 61 |
+
master_doc = "index"
|
| 62 |
+
|
| 63 |
+
# General information about the project.
|
| 64 |
+
project = "Red - Discord Bot"
|
| 65 |
+
copyright = f"2018-{time.strftime('%Y')}, Cog Creators"
|
| 66 |
+
author = "Cog Creators"
|
| 67 |
+
|
| 68 |
+
# The version info for the project you're documenting, acts as replacement for
|
| 69 |
+
# |version| and |release|, also used in various other places throughout the
|
| 70 |
+
# built documents.
|
| 71 |
+
#
|
| 72 |
+
from redbot.core import __version__
|
| 73 |
+
from discord import __version__ as dpy_version, version_info as dpy_version_info
|
| 74 |
+
|
| 75 |
+
# The short X.Y version.
|
| 76 |
+
version = __version__
|
| 77 |
+
# The full version, including alpha/beta/rc tags.
|
| 78 |
+
release = __version__
|
| 79 |
+
|
| 80 |
+
# The language for content autogenerated by Sphinx. Refer to documentation
|
| 81 |
+
# for a list of supported languages.
|
| 82 |
+
#
|
| 83 |
+
# This is also used if you do content translation via gettext catalogs.
|
| 84 |
+
# Usually you set "language" from the command line for these cases.
|
| 85 |
+
language = "en"
|
| 86 |
+
|
| 87 |
+
# List of patterns, relative to source directory, that match files and
|
| 88 |
+
# directories to ignore when looking for source files.
|
| 89 |
+
# This patterns also effect to html_static_path and html_extra_path
|
| 90 |
+
exclude_patterns = [
|
| 91 |
+
"_build",
|
| 92 |
+
"Thumbs.db",
|
| 93 |
+
".DS_Store",
|
| 94 |
+
# to ensure that include files (partial pages) aren't built, exclude them
|
| 95 |
+
"**/_includes/**",
|
| 96 |
+
]
|
| 97 |
+
|
| 98 |
+
# The name of the Pygments (syntax highlighting) style to use.
|
| 99 |
+
pygments_style = "default"
|
| 100 |
+
|
| 101 |
+
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
| 102 |
+
todo_include_todos = False
|
| 103 |
+
|
| 104 |
+
# Role which is assigned when you make a simple reference within backticks
|
| 105 |
+
default_role = "any"
|
| 106 |
+
|
| 107 |
+
# Includes substitutions for all files
|
| 108 |
+
with open("prolog.txt", "r") as file:
|
| 109 |
+
rst_prolog = file.read()
|
| 110 |
+
|
| 111 |
+
# Adds d.py version to available substitutions in all files
|
| 112 |
+
rst_prolog += f"\n.. |DPY_VERSION| replace:: {dpy_version}"
|
| 113 |
+
|
| 114 |
+
# Add release highlight indicator to available substitutions in all files
|
| 115 |
+
rst_prolog += f"\n.. |cool| replace:: \N{HEAVY BLACK HEART}\N{VARIATION SELECTOR-16}"
|
| 116 |
+
|
| 117 |
+
# -- Options for HTML output ----------------------------------------------
|
| 118 |
+
|
| 119 |
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
| 120 |
+
# a list of builtin themes.
|
| 121 |
+
#
|
| 122 |
+
html_theme = "sphinx_rtd_theme"
|
| 123 |
+
|
| 124 |
+
# Add any extra paths that contain custom files (such as robots.txt or
|
| 125 |
+
# .htaccess) here, relative to this directory. These files are copied
|
| 126 |
+
# directly to the root of the documentation.
|
| 127 |
+
#
|
| 128 |
+
html_extra_path = ["_html"]
|
| 129 |
+
|
| 130 |
+
# Theme options are theme-specific and customize the look and feel of a theme
|
| 131 |
+
# further. For a list of options available for each theme, see the
|
| 132 |
+
# documentation.
|
| 133 |
+
#
|
| 134 |
+
# html_theme_options = {}
|
| 135 |
+
|
| 136 |
+
html_context = {
|
| 137 |
+
# Enable the "Edit in GitHub link within the header of each page.
|
| 138 |
+
"display_github": True,
|
| 139 |
+
"github_user": "Cog-Creators",
|
| 140 |
+
"github_repo": "Red-DiscordBot",
|
| 141 |
+
"github_version": "V3/develop/docs/",
|
| 142 |
+
}
|
| 143 |
+
|
| 144 |
+
# Add any paths that contain custom static files (such as style sheets) here,
|
| 145 |
+
# relative to this directory. They are copied after the builtin static files,
|
| 146 |
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
| 147 |
+
# html_static_path = ['_static']
|
| 148 |
+
|
| 149 |
+
# Custom sidebar templates, must be a dictionary that maps document names
|
| 150 |
+
# to template names.
|
| 151 |
+
#
|
| 152 |
+
# This is required for the alabaster theme
|
| 153 |
+
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
| 154 |
+
html_sidebars = {
|
| 155 |
+
"**": [
|
| 156 |
+
"about.html",
|
| 157 |
+
"navigation.html",
|
| 158 |
+
"relations.html", # needs 'show_related': True theme option to display
|
| 159 |
+
"searchbox.html",
|
| 160 |
+
"donate.html",
|
| 161 |
+
]
|
| 162 |
+
}
|
| 163 |
+
|
| 164 |
+
|
| 165 |
+
# -- Options for HTMLHelp output ------------------------------------------
|
| 166 |
+
|
| 167 |
+
# Output file base name for HTML help builder.
|
| 168 |
+
htmlhelp_basename = "Red-DiscordBotdoc"
|
| 169 |
+
|
| 170 |
+
|
| 171 |
+
# -- Options for LaTeX output ---------------------------------------------
|
| 172 |
+
|
| 173 |
+
latex_elements = {
|
| 174 |
+
# The paper size ('letterpaper' or 'a4paper').
|
| 175 |
+
#
|
| 176 |
+
# 'papersize': 'letterpaper',
|
| 177 |
+
# The font size ('10pt', '11pt' or '12pt').
|
| 178 |
+
#
|
| 179 |
+
# 'pointsize': '10pt',
|
| 180 |
+
# Additional stuff for the LaTeX preamble.
|
| 181 |
+
#
|
| 182 |
+
# 'preamble': '',
|
| 183 |
+
# Latex figure (float) alignment
|
| 184 |
+
#
|
| 185 |
+
# 'figure_align': 'htbp',
|
| 186 |
+
}
|
| 187 |
+
|
| 188 |
+
# Grouping the document tree into LaTeX files. List of tuples
|
| 189 |
+
# (source start file, target name, title,
|
| 190 |
+
# author, documentclass [howto, manual, or own class]).
|
| 191 |
+
latex_documents = [
|
| 192 |
+
(master_doc, "Red-DiscordBot.tex", "Red - Discord Bot Documentation", "Cog Creators", "manual")
|
| 193 |
+
]
|
| 194 |
+
|
| 195 |
+
|
| 196 |
+
# -- Options for manual page output ---------------------------------------
|
| 197 |
+
|
| 198 |
+
# One entry per manual page. List of tuples
|
| 199 |
+
# (source start file, name, description, authors, manual section).
|
| 200 |
+
man_pages = [(master_doc, "red-discordbot", "Red - Discord Bot Documentation", [author], 1)]
|
| 201 |
+
|
| 202 |
+
|
| 203 |
+
# -- Options for Texinfo output -------------------------------------------
|
| 204 |
+
|
| 205 |
+
# Grouping the document tree into Texinfo files. List of tuples
|
| 206 |
+
# (source start file, target name, title, author,
|
| 207 |
+
# dir menu entry, description, category)
|
| 208 |
+
texinfo_documents = [
|
| 209 |
+
(
|
| 210 |
+
master_doc,
|
| 211 |
+
"Red-DiscordBot",
|
| 212 |
+
"Red - Discord Bot Documentation",
|
| 213 |
+
author,
|
| 214 |
+
"Red-DiscordBot",
|
| 215 |
+
"One line description of project.",
|
| 216 |
+
"Miscellaneous",
|
| 217 |
+
)
|
| 218 |
+
]
|
| 219 |
+
|
| 220 |
+
|
| 221 |
+
# -- Options for linkcheck builder ----------------------------------------
|
| 222 |
+
|
| 223 |
+
# A list of regular expressions that match URIs that should not be
|
| 224 |
+
# checked when doing a linkcheck build.
|
| 225 |
+
linkcheck_ignore = [r"https://java.com*", r"https://chocolatey.org*"]
|
| 226 |
+
linkcheck_retries = 3
|
| 227 |
+
|
| 228 |
+
|
| 229 |
+
# -- Options for extensions -----------------------------------------------
|
| 230 |
+
|
| 231 |
+
if dpy_version_info.releaselevel == "final":
|
| 232 |
+
# final release - versioned docs should be available
|
| 233 |
+
dpy_docs_url = f"https://discordpy.readthedocs.io/en/v{dpy_version}/"
|
| 234 |
+
else:
|
| 235 |
+
# alpha release - `latest` version of docs should be used
|
| 236 |
+
dpy_docs_url = "https://discordpy.readthedocs.io/en/latest/"
|
| 237 |
+
|
| 238 |
+
# Intersphinx
|
| 239 |
+
intersphinx_mapping = {
|
| 240 |
+
"python": ("https://docs.python.org/3", None),
|
| 241 |
+
"dpy": (dpy_docs_url, None),
|
| 242 |
+
"motor": ("https://motor.readthedocs.io/en/stable/", None),
|
| 243 |
+
"babel": ("http://babel.pocoo.org/en/stable/", None),
|
| 244 |
+
"dateutil": ("https://dateutil.readthedocs.io/en/stable/", None),
|
| 245 |
+
}
|
| 246 |
+
|
| 247 |
+
# Extlinks
|
| 248 |
+
# This allows to create links to d.py docs with
|
| 249 |
+
# :dpy_docs:`link text <site_name.html>`
|
| 250 |
+
extlinks = {
|
| 251 |
+
"dpy_docs": (f"{dpy_docs_url}/%s", None),
|
| 252 |
+
"issue": ("https://github.com/Cog-Creators/Red-DiscordBot/issues/%s", "#%s"),
|
| 253 |
+
"ghuser": ("https://github.com/%s", "@%s"),
|
| 254 |
+
}
|
| 255 |
+
|
| 256 |
+
# Doctest
|
| 257 |
+
# If this string is non-empty, all blocks with ``>>>`` in them will be
|
| 258 |
+
# tested, not just the ones explicitly marked with ``.. doctest::``
|
| 259 |
+
doctest_test_doctest_blocks = ""
|
| 260 |
+
|
| 261 |
+
# Autodoc options
|
| 262 |
+
autodoc_default_options = {"show-inheritance": True}
|
| 263 |
+
autodoc_typehints = "none"
|
| 264 |
+
|
| 265 |
+
|
| 266 |
+
from docutils import nodes
|
| 267 |
+
from sphinx.transforms import SphinxTransform
|
| 268 |
+
|
| 269 |
+
|
| 270 |
+
# d.py's |coro| substitution leaks into our docs because we don't replace some of the docstrings
|
| 271 |
+
class IgnoreCoroSubstitution(SphinxTransform):
|
| 272 |
+
default_priority = 210
|
| 273 |
+
|
| 274 |
+
def apply(self, **kwargs) -> None:
|
| 275 |
+
for ref in self.document.traverse(nodes.substitution_reference):
|
| 276 |
+
if ref["refname"] == "coro":
|
| 277 |
+
ref.replace_self(nodes.Text("", ""))
|
| 278 |
+
|
| 279 |
+
|
| 280 |
+
def setup(app):
|
| 281 |
+
app.add_transform(IgnoreCoroSubstitution)
|