Booster Roles
Reward your boosters with unique roles for themselves.
What are booster roles?
Booster roles are unique roles that are given to members which have boosted your server. These roles can be fully customized by the members themselves.
How to setup booster roles
First, you need to set a base role. This role will be the base, and all booster roles will go under this role in the role hierarchy.
Note:
The base role should be a role which is above any roles with a color, otherwise the color won’t be visible due to Discord’s role hierarchy.
,boostrole base (role)
You have access to more configuration for your server, to enhanced the experience for your boosters.
| Command | Description |
|---|---|
| br filter (list|word) | Toggles words in the forbidden list for booster role names. |
| br limit (number) | Sets the maximum number of custom booster roles allowed (max 250). |
| br share max (number) | Sets how many people can share a single custom role. |
| br share limit (number) | Sets how many shared roles a single user can have. |
| br status | Displays all current configuration values for the booster system. |
| br link (user) (role) | Manually maps an existing role to a user in the bot's database. |
| br cleanup | Forcefully removes custom roles from users who are no longer boosting. |
Create a booster role
You can create a booster role by using the boosterrole command itself.
,boostrole create (color) (name)
Gato also support the gradient color, at the creation of you role, add a second color after the first one.
,boostrole create (color1) (color2) (name)
Note:
Your server need to have the required boost level to use this feature.
Available customizations for roles
You can edit every aspects of the role, you can change its name, its color, icon and more.
| Command | Description |
|---|---|
| ,br color [color1] [color2] | Updates your role's color or gradient. |
| ,br rename (name) | Changes the name of your custom role. |
| ,br icon (emoji|url|remove) | Sets a custom icon or emoji for your role (requires server level 2+). |
| ,br dominant | Automatically sets your role color to the main color of your avatar. |
| ,br random | Sets your role color to a random hex value. |
| ,br delete | Permanently deletes your custom booster role. |
| ,br share (user) | Sends a request to a user to share your custom role with them. |
| ,br share remove [role] | Removes yourself from a role that someone else shared with you. |
Automatically grant a role to boosters
You can reward your boosters with a role upon boosting your server.
You can use the boosterrole award command to set this up.
,boosterrole award (role)
You can also remove or view the award roles using the following commands:
| Command | Description |
|---|---|
| boosterrole unset | Removes the award role. |
| boosterrole view | Views the award role. |
More options
There is general commands for the booster feature that you should know.
| Command | Description |
|---|---|
| br list | Shows all custom booster roles. |
| br share list [user] | Shows who a user is sharing their role with. |