# Role Collector

Contact Dev if you find any vulns. \
I'll try to make it worth your time with exclusive features that dont exist yet :0

<details>

<summary>Things to know in general</summary>

-> Roles that were deleted from the server and previously part of Role Unboxer will be automatically removed from the database.

-> Roles aren't pinged.\
\
-> There's no unboxable role limit atm.

</details>

## <mark style="color:purple;">/role\_collector\_configure settings</mark>

Server admins can configure Role Collector settings with this command.

* You can run the command without any options to see the current configuration on file.

| Options  \| (r)equired - (o)ptional | Information                                                                    |
| ----------------------------------- | ------------------------------------------------------------------------------ |
| enabled (o)                         | Can members collect roles? \[?[^1]]                                            |
| cooldown (o)                        | The cooldown for collecting roles. \[?[^2]]                                    |
| booster\_cooldown (o)               | The booster cooldown for collecting roles. \[?[^3]]                            |
| unbox\_amount                       | How many roles will the member unbox at once? \[?[^4]]                         |
| booster\_unbox\_amount              | How many roles will the server boosting member unbox at once? \[?[^4]]         |
| separator                           | Give a specific role to the member when they collect a role. \[?[^5]]          |
| remove\_self\_unboxed\_roles        | Can members remove roles they've unboxed from themselves?                      |
| remove                              | Remove the separator, configuration, server cooldowns, or everything. \[?[^6]] |

***

## <mark style="color:purple;">/role\_collector\_configure role</mark>

Configure a role for Role Collector

* Roles above RbxSociety's highest role cannot be an unboxable role.
* Server admins cannot make roles that're higher than there own unboxable. \[?[^7]]

| Options  \| (r)equired - (o)ptional | Information |
| ----------------------------------- | ----------- |
|                                     |             |
|                                     |             |
|                                     |             |

***

## <mark style="color:purple;">/role\_collector unbox</mark>

**Unbox a role in the server.**

<table><thead><tr><th width="215">Options</th><th width="403">Info</th></tr></thead><tbody><tr><td>simulate</td><td>Tests the command a specified number of times to get an idea of the current role probabilities</td></tr></tbody></table>

***

## <mark style="color:purple;">/unboxable\_roles</mark>

**View all of the unboxable roles in a server.**

<table><thead><tr><th width="215">Options</th><th width="403">Info</th></tr></thead><tbody><tr><td>Hide_special_roles</td><td>Hides both 'server booster only' and 'unobtainable' roles so you'll only see roles you can obtain through <a href="#unbox_role">/unbox_role</a></td></tr></tbody></table>

<details>

<summary>Good2Knows</summary>

-> By default, the menu displays both unobtainable and [server booster-only](#user-content-fn-8)[^8] roles. However, their chances are not factored into the overall chance calculation.\
&#x20;"You have a {**X**} in {**OVERALL CHANCE**} chance of getting role."

</details>

[^1]: -> Server Admins will still be able to collect roles.\
    \
    -> When setting up Role Collector for the first time, this option will be set to False.

[^2]: 30/s by default.

    -> Minimum of 6 seconds.\
    -> Maximum of 604800 seconds.

[^3]: -> Defaults to non-boosters if unsupplied]

[^4]: 1 by default.

    -> Minimum of 1 role.\
    -> Maximum of 30 roles.

[^5]:

[^6]: -> When selecting 'everything', it will delete the Role Collector file in my database. Nothing on your server will be touched.\\

    -> Only the server owner can select the 'everything' and 'config' option.

[^7]: If RbxSociety's role had a higher hierarchy than the role to get that's positioned above the admin's role, they'd be able to make the role unboxable and essentially give it to themselves.

[^8]: You'll see '<img src="https://875391594-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0f0DlrxIbr7NFkCEJfw%2Fuploads%2FXYDj7T5icAVHn9HXIwUE%2F1150508063711826050.png?alt=media&#x26;token=9b3d44a2-c11e-4bb4-9eb2-4d654ae5b793" alt="" data-size="line"> Only' next to roles when you are not actively boosting the server. As a server booster, you will only be shown the Server Booster chance
