diff --git a/content/docs/fun/_index.md b/content/docs/fun/_index.md index 6ae2ade..1bc5f46 100644 --- a/content/docs/fun/_index.md +++ b/content/docs/fun/_index.md @@ -1,6 +1,6 @@ +++ title = "Fun" -weight = 800 +weight = 900 [sidebar] collapsed = true +++ diff --git a/content/docs/fun/reputation.md b/content/docs/fun/reputation.md index a95e8d6..d4baaaf 100644 --- a/content/docs/fun/reputation.md +++ b/content/docs/fun/reputation.md @@ -1,6 +1,6 @@ +++ title = "Reputation" -weight = 810 +weight = 910 description = "Track and manage reputation points for users." +++ diff --git a/content/docs/fun/soundboard.md b/content/docs/fun/soundboard.md index 23791f8..5ceed24 100644 --- a/content/docs/fun/soundboard.md +++ b/content/docs/fun/soundboard.md @@ -1,6 +1,6 @@ +++ title = "Soundboard" -weight = 820 +weight = 920 description = "Play sounds in voice channels with the soundboard system." +++ diff --git a/content/docs/reference/_index.md b/content/docs/reference/_index.md index d1b735e..86e05a4 100644 --- a/content/docs/reference/_index.md +++ b/content/docs/reference/_index.md @@ -1,4 +1,4 @@ +++ title = "Reference" -weight = 900 +weight = 1000 +++ diff --git a/content/docs/reference/custom-command-examples.md b/content/docs/reference/custom-command-examples.md index 9de1a00..e924d41 100644 --- a/content/docs/reference/custom-command-examples.md +++ b/content/docs/reference/custom-command-examples.md @@ -1,6 +1,6 @@ +++ title = "Custom Commands Examples" -weight = 920 +weight = 1020 description = "Copy-and-paste code, \"for education purposes only\"." +++ diff --git a/content/docs/reference/custom-commands-limits.md b/content/docs/reference/custom-commands-limits.md index e0c569c..ad91c70 100644 --- a/content/docs/reference/custom-commands-limits.md +++ b/content/docs/reference/custom-commands-limits.md @@ -1,6 +1,6 @@ +++ title = "Custom Commands Limits" -weight = 930 +weight = 1030 description = "Limits? I'm at my limit!" +++ diff --git a/content/docs/reference/custom-embeds.md b/content/docs/reference/custom-embeds.md index 0a98df3..f5a34ba 100644 --- a/content/docs/reference/custom-embeds.md +++ b/content/docs/reference/custom-embeds.md @@ -1,6 +1,6 @@ +++ title = "Custom Embeds" -weight = 940 +weight = 1040 description = "Be fancy, use embeds!" +++ diff --git a/content/docs/reference/custom-interactions.md b/content/docs/reference/custom-interactions.md index 04f5bd1..d09b1b0 100644 --- a/content/docs/reference/custom-interactions.md +++ b/content/docs/reference/custom-interactions.md @@ -1,6 +1,6 @@ +++ title = "Custom Interactions" -weight = 950 +weight = 1050 description = "Even better than embeds!" +++ diff --git a/content/docs/reference/how-to-get-ids.md b/content/docs/reference/how-to-get-ids.md index a7b0232..f1c2630 100644 --- a/content/docs/reference/how-to-get-ids.md +++ b/content/docs/reference/how-to-get-ids.md @@ -1,6 +1,6 @@ +++ title = "How to Get IDs" -weight = 960 +weight = 1060 description = "Snowflake? ID? I don't know, but this page does!" +++ diff --git a/content/docs/reference/regex.md b/content/docs/reference/regex.md index dd88376..274866b 100644 --- a/content/docs/reference/regex.md +++ b/content/docs/reference/regex.md @@ -1,6 +1,6 @@ +++ title = "Using RegEx" -weight = 970 +weight = 1070 description = "s/regex/dark voodoo/i" +++ diff --git a/content/docs/reference/templates/_index.md b/content/docs/reference/templates/_index.md index f1e54b9..4fc4dc8 100644 --- a/content/docs/reference/templates/_index.md +++ b/content/docs/reference/templates/_index.md @@ -1,6 +1,6 @@ +++ title = 'Templates' -weight = 910 +weight = 1010 [sidebar] collapsed = true +++ diff --git a/content/docs/reference/templates/functions.md b/content/docs/reference/templates/functions.md index 56bb141..30bc93c 100644 --- a/content/docs/reference/templates/functions.md +++ b/content/docs/reference/templates/functions.md @@ -1,6 +1,6 @@ +++ title = "Functions" -weight = 912 +weight = 1012 description = "A list of all available functions in YAGPDB's custom command templates." +++ diff --git a/content/docs/reference/templates/syntax-and-data.md b/content/docs/reference/templates/syntax-and-data.md index e67015d..4cdbe5a 100644 --- a/content/docs/reference/templates/syntax-and-data.md +++ b/content/docs/reference/templates/syntax-and-data.md @@ -1,6 +1,6 @@ +++ title = "Syntax and Data" -weight = 911 +weight = 1011 description = "Available data in custom commands and a quick syntax refresher." +++ diff --git a/content/docs/roles/_index.md b/content/docs/roles/_index.md new file mode 100644 index 0000000..01b9221 --- /dev/null +++ b/content/docs/roles/_index.md @@ -0,0 +1,4 @@ ++++ +title = 'Roles' +weight = 700 ++++ diff --git a/content/docs/tools-and-utilities/autorole.md b/content/docs/roles/autorole.md similarity index 100% rename from content/docs/tools-and-utilities/autorole.md rename to content/docs/roles/autorole.md diff --git a/content/docs/roles/bulk-role.md b/content/docs/roles/bulk-role.md new file mode 100644 index 0000000..0b833fa --- /dev/null +++ b/content/docs/roles/bulk-role.md @@ -0,0 +1,57 @@ ++++ +title = "Bulk Role" +weight = 730 +description = "Assign or remove roles to/from multiple members at once." ++++ + + +{{< callout context="caution" title="Warning: Required Bot Permissions" icon="outline/alert-triangle" >}} + +Make sure that the bot has permission to manage roles **and** that the role the bot is assigning is below the highest +role the bot has. + +{{< /callout >}} + +![Bulk Role view](bulkrole_overview.png) + +Bulk role allows you to assign---or remove---a role en masse. YAGPDB provides several filters to narrow down assignment, +which will be further explained below. You can only run one bulk role proess at any given time, so you'll have to either +wait until the current one completes or simply just cancel it. + +{{< callout context="note" title="Note: Premium Only" icon="outline/info-circle" >}} + +Due to the nature of this operation requiring a lot of API calls to Discord and the associated cost with that, we +provide this as a premium-only feature. + +{{< /callout >}} + +## Configuration + +### Target Role + +Select the role that you wish to assign or remove. Make sure that the bot's highest role is above this selected role. + +### Operation + +- **Assign role**: Assigns the selected role. +- **Remove role**: removes the selected role. + +### Filter Type + +- **All members**: Assign or remove the target role to/from all members indiscriminately. +- **Bots only**: Assign or remove the target role only to/from bots. +- **Humans only**: Assign or remove the target role only to/from humans. +- **Has specific roles**: Only care about members with at least one of these roles. Optionally you can tell the bot to + require **all** of your selected roles. +- **Missing specific roles**: Like the above, but only on members without at least one of these roles. Optionally for + **all** selected roles. +- **Joined after date**: Only care about members that joined after the selected date. +- **Joined before date**: Only care about members that joined before the selected date. + +### Notification Channel + +Optionally select a channel you wish to receive notifications about the operation status of bulk assignment. The bot +will let you know when it encountered an error during processing, otherwise after it wholly completed it. + +After you've configured everything to your liking, click the green "start" button and let the magic happen. If you +changed your mind, you can always cancel it during the processing. diff --git a/content/docs/roles/bulkrole_overview.png b/content/docs/roles/bulkrole_overview.png new file mode 100644 index 0000000..7654650 Binary files /dev/null and b/content/docs/roles/bulkrole_overview.png differ diff --git a/content/docs/tools-and-utilities/copy_message_id.png b/content/docs/roles/copy_message_id.png similarity index 100% rename from content/docs/tools-and-utilities/copy_message_id.png rename to content/docs/roles/copy_message_id.png diff --git a/content/docs/tools-and-utilities/overview_autorole.png b/content/docs/roles/overview_autorole.png similarity index 100% rename from content/docs/tools-and-utilities/overview_autorole.png rename to content/docs/roles/overview_autorole.png diff --git a/content/docs/tools-and-utilities/role_command_creation.png b/content/docs/roles/role_command_creation.png similarity index 100% rename from content/docs/tools-and-utilities/role_command_creation.png rename to content/docs/roles/role_command_creation.png diff --git a/content/docs/tools-and-utilities/role_command_group_creation.png b/content/docs/roles/role_command_group_creation.png similarity index 100% rename from content/docs/tools-and-utilities/role_command_group_creation.png rename to content/docs/roles/role_command_group_creation.png diff --git a/content/docs/tools-and-utilities/rolemenu_create.png b/content/docs/roles/rolemenu_create.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_create.png rename to content/docs/roles/rolemenu_create.png diff --git a/content/docs/tools-and-utilities/rolemenu_example.png b/content/docs/roles/rolemenu_example.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_example.png rename to content/docs/roles/rolemenu_example.png diff --git a/content/docs/tools-and-utilities/rolemenu_flags.png b/content/docs/roles/rolemenu_flags.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_flags.png rename to content/docs/roles/rolemenu_flags.png diff --git a/content/docs/tools-and-utilities/rolemenu_react.png b/content/docs/roles/rolemenu_react.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_react.png rename to content/docs/roles/rolemenu_react.png diff --git a/content/docs/tools-and-utilities/rolemenu_react_2.png b/content/docs/roles/rolemenu_react_2.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_react_2.png rename to content/docs/roles/rolemenu_react_2.png diff --git a/content/docs/tools-and-utilities/rolemenu_react_3.png b/content/docs/roles/rolemenu_react_3.png similarity index 100% rename from content/docs/tools-and-utilities/rolemenu_react_3.png rename to content/docs/roles/rolemenu_react_3.png diff --git a/content/docs/tools-and-utilities/self-assignable-roles.md b/content/docs/roles/self-assignable-roles.md similarity index 100% rename from content/docs/tools-and-utilities/self-assignable-roles.md rename to content/docs/roles/self-assignable-roles.md diff --git a/content/docs/tools-and-utilities/_index.md b/content/docs/tools-and-utilities/_index.md index 7b8286b..cc3cc2d 100644 --- a/content/docs/tools-and-utilities/_index.md +++ b/content/docs/tools-and-utilities/_index.md @@ -1,4 +1,6 @@ +++ title = "Tools and Utilities" -weight = 700 +weight = 800 +[sidebar] + collapsed = true +++ diff --git a/content/docs/welcome/premium.md b/content/docs/welcome/premium.md index 2febd00..6357f38 100644 --- a/content/docs/welcome/premium.md +++ b/content/docs/welcome/premium.md @@ -24,6 +24,10 @@ A premium server unlocks the following benefits: - Enables retroactively applying a role to all members of a server. +### Bulk Role + +- The [bulk role](/docs/roles/bulk-role) feature becomes available, allowing you to assign or remove a role in bulk. + ### Common Template Scripting - Increase max operation count from 1 million to 2.5 million (`MaxOpsPremium`). diff --git a/layouts/home.html b/layouts/home.html index 07d1a2e..f308ca4 100644 --- a/layouts/home.html +++ b/layouts/home.html @@ -50,9 +50,9 @@

Quick Links

"title" "Tools & Utilities" "icon" "outline/tools" "content" ` -- [Self-assignable roles](/docs/tools-and-utilities/self-assignable-roles/) +- [Self-assignable roles](/docs/roles/self-assignable-roles/) - [YouTube tutorial video](https://www.youtube.com/watch?v=IaTfJ4vqHhc) -- [Autoroles](/docs/tools-and-utilities/autorole) +- [Autoroles](/docs/roles/autorole) ` }} {{ partial "inline/home-card.html" $opts }}