# Booster Roles
## 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.
## Setting the base role
In order for the booster roles to work, you must set a base role. All booster roles will be placed under this role.
{% hint style="info" %}
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.
{% endhint %}
```
Syntax: ;boosterrole base [role]
Example: ;boosterrole base @---------
```
## Creating a booster role
You can create a booster role by using the `boosterrole` command itself.
{% hint style="info" %}
The `color` parameter can be a hex code or a color name.
{% endhint %}
```
Syntax: ;boosterrole create [color] [name]
Example: ;boosterrole create #3498DB boss
```
## Customizing your booster role
### Changing the name
You can use the `boosterrole name` command to change the name of your booster role.
```
Syntax: ;boosterrole name [name]
Example: ;boosterrole name boss
```
### Changing the color
You can use the `boosterrole color` command to change the color of your booster role.
```
Syntax: ;boosterrole color [name]
Example: ;boosterrole color #3498DB
```
### Changing the icon
You can use the `boosterrole icon` command to change the icon of your booster role.
```
Syntax: ;boosterrole icon [emoji]
Example: ;boosterrole icon :cool:
```
## Removing your booster role
If you no longer want your booster role, you can use the `boosterrole remove` command.
## Automatically grant a role to boosters
You can reward your boosters with a role upon boosting your server. You can use the `boosterrole award add` command to set this up.
```
Syntax: ;boosterrole award add [role]
Example: ;boosterrole award add gang
```
### Removing the role being awarded
You can use the `boosterrole award remove` command to remove the role being awarded.
```
Syntax: ;boosterrole award remove [role]
Example: ;boosterrole award remove gang
```
### Viewing the role being awarded
You can use the `boosterrole award list` command to view the roles being awarded.
## Share your boosterrole with other users
In order for the booster roles share to work, you must set a limit. Every user can share then there booster role with this amount of users.
{% hint style="warning" %}
Use `boosterrole share enable` to enable sharing their roles.
{% endhint %}
```
Syntax: ;boosterrole share limit [limit]
Example: ;boosterrole share limit 5
```
### Add a member to share your role
You can use the `boosterrole share add` command to share your role with a member.
```
Syntax: ;boosterrole share add [user]
Example: ;boosterrole share add @bender.py
```
### Remove a member from sharing your role
You can use the `boosterrole share remove` command to stop share your role with a member.
```
Syntax: ;boosterrole share remove [user]
Example: ;boosterrole share remove @bender.py
```
### List all members you are sharing your role with
You can use the `boosterrole share list` command to view all members your are sharing your role with.
