Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/fun/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Fun"
weight = 800
weight = 900
[sidebar]
collapsed = true
+++
2 changes: 1 addition & 1 deletion content/docs/fun/reputation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Reputation"
weight = 810
weight = 910
description = "Track and manage reputation points for users."
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/fun/soundboard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Soundboard"
weight = 820
weight = 920
description = "Play sounds in voice channels with the soundboard system."
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
+++
title = "Reference"
weight = 900
weight = 1000
+++
2 changes: 1 addition & 1 deletion content/docs/reference/custom-command-examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Custom Commands Examples"
weight = 920
weight = 1020
description = "Copy-and-paste code, \"for education purposes only\"."
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/custom-commands-limits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Custom Commands Limits"
weight = 930
weight = 1030
description = "Limits? I'm at my limit!"
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/custom-embeds.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Custom Embeds"
weight = 940
weight = 1040
description = "Be fancy, use embeds!"
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/custom-interactions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Custom Interactions"
weight = 950
weight = 1050
description = "Even better than embeds!"
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/how-to-get-ids.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "How to Get IDs"
weight = 960
weight = 1060
description = "Snowflake? ID? I don't know, but this page does!"
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/regex.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Using RegEx"
weight = 970
weight = 1070
description = "s/regex/dark voodoo/i"
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/templates/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = 'Templates'
weight = 910
weight = 1010
[sidebar]
collapsed = true
+++
2 changes: 1 addition & 1 deletion content/docs/reference/templates/functions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Functions"
weight = 912
weight = 1012
description = "A list of all available functions in YAGPDB's custom command templates."
+++

Expand Down
2 changes: 1 addition & 1 deletion content/docs/reference/templates/syntax-and-data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Syntax and Data"
weight = 911
weight = 1011
description = "Available data in custom commands and a quick syntax refresher."
+++

Expand Down
4 changes: 4 additions & 0 deletions content/docs/roles/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
+++
title = 'Roles'
weight = 700
+++
57 changes: 57 additions & 0 deletions content/docs/roles/bulk-role.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added content/docs/roles/bulkrole_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion content/docs/tools-and-utilities/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
+++
title = "Tools and Utilities"
weight = 700
weight = 800
[sidebar]
collapsed = true
+++
4 changes: 4 additions & 0 deletions content/docs/welcome/premium.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
4 changes: 2 additions & 2 deletions layouts/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ <h2 id="quick-links" class="text-center">Quick Links</h2>
"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 }}

Expand Down