# Categories

## Create a Role Category <a href="#category-creating" id="category-creating"></a>

Adding categories can be done with a simple command:

```
/category create
```

## Configure a Role Category

```
/category config
```

* `type`: Type that will determine the behavior of the category.
* `component`: Allows you to set a category component to use [buttons](#buttons) or [private select menu](#category-components) instead of the default [select menu](#category-components).
* `placeholder`: Placeholder text of [select menu component](#category-components).
* `max-options`: Maximum number of selectable options / roles in the [select menu](#category-components) / [role-button row](#category-components).
* `min-options`: Minimum number of selectable options / roles in the [select menu](#category-components) / [role-button ](#category-components)row.
* `secret-code`: Custom code that users have to submit to access the category.

{% hint style="info" %}
Set `secret-code` to `Random` to generate a random 8-digit code.

Set to `DynamicRandom` to generate a random 8-digit code, that will be updated after each successful submit. You can give these codes as one-time "keys" for access.

Set to `Verification` to require 8-digit captcha from a member.

To change the number of digits, add a number from 1 to 35 after each type, for example: `Random10`, `DynamicRandom5`, `Verification3`.

<img src="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FKrRKEGg535B2r5lMp4jz%2Fverification.png?alt=media&#x26;token=c60626c0-3c89-42d8-9420-eabd2099502f" alt="" data-size="original">
{% endhint %}

<details>

<summary>Category Types</summary>

* `Toggle`: Users will be allowed to select / deselect roles from this category.
* `Set / Toggle`: Users will be allowed to select / deselect roles from this category.\
  \
  `Set`, if the category component is [Select Menu](#category-components). Removes all roles and gives the selected ones.\
  `Toggle`, if the category component is [Private Select Menu](#category-components) or [Buttons](#category-components).
* `Only Get`: Roles from this category can be added, but not removed.
* `Unique Get`: Users will only be allowed to select a single role from this category. Roles can be removed. Value `max-options` equals `1` and cannot be changed.
* `Only Remove`: Roles in this category will only be able to be removed, not added.

</details>

<details>

<summary>Category Components</summary>

#### Buttons

Supports up to 25 role options. Label, emoji, and color of each button [can be changed](https://kayfarik.gitbook.io/docs/roles#editing-roles).

![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FfTn8R64y9yC0NFpZXb3S%2F3.png?alt=media\&token=54b50f0e-689a-45fe-b5b9-1ebf61740c57)

#### Select Menu

Supports up to 25 role options. Label, emoji, and description of each option [can be changed](https://kayfarik.gitbook.io/docs/roles#editing-roles).

![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fj9207GewWDoWCP5o7bwu%2F1.png?alt=media\&token=980c6a62-82a2-4b93-8ab3-487bd43ca010)![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FyxoaPj5HgKiTmwriNVS8%2F2.png?alt=media\&token=0db4c919-77ef-4205-9a32-0aab4a06da2f)

#### Private (Ephemeral) Select Menu

Supports up to 100 role options with role paginating. Also includes a button to clear all roles of this category. Just like in the default select menu - label, emoji, and description of each option [can be changed](https://kayfarik.gitbook.io/docs/roles#editing-roles).

![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FDw6YCFP7zocwMVxICPH5%2F4.png?alt=media\&token=6826714e-3be5-4253-84a3-e187b1bbdf32)![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FsOT9cSNldk1jeE9n1rr5%2F5.png?alt=media\&token=c146e225-1bc9-4a10-8316-499b554046f7)![](https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FtunRrim9y2UaqCfnHTxW%2F6.png?alt=media\&token=020e442e-9747-4496-b3eb-7cdc6d7e4da7)

</details>

{% hint style="info" %}
You can **delete** some of the category parameters using `-` as a value.
{% endhint %}

### Edit Category's Embed

You can edit the embed of the category's message using this command:

```
/category edit-embed
```

## List Categories <a href="#category-list" id="category-list"></a>

If you need to see a list of the categories, you can do that with:

```
/category list
```

## Removing a Category <a href="#category-deleting" id="category-deleting"></a>

You can remove a category, but doing so will remove all configured roles in this category as well. Roles will stay in your server, but you will need to reassign them to a category.

```
/category delete
```

## Reorder or Sort Roles in a Category

{% hint style="warning" %}
You can't reorder a category with more than 25 roles.
{% endhint %}

```
/category-advanced rearrange
```

## Synchronizing a Category <a href="#category-syncing" id="category-syncing"></a>

Since the bot can temporarily disconnect from Discord, role deletions and name changes may not be recognized. If you delete a role or update a role's name, you can update components for that category by using this subcommand:

```
/category sync
```

or using the context-menu command:

&#x20;   Right-click or hold category message -> Apps -> `Synchronize`

### Setting a Required Role(s) <a href="#setting-required-roles" id="setting-required-roles"></a>

Members who don't have the necessary roles set in the category will not be able to select roles from the selected category.

```
/category-advanced set-required-roles
```

## Moving Categories <a href="#category-moving" id="category-moving"></a>

If you need to move a category to another channel, use following command:

```
/category move
```

## Linking Categories <a href="#category-linking" id="category-linking"></a>

Category linking allows to clear the roles of both - selected category and linked categories with that category. Useful with `Unique Get` type.

```
/category-advanced set-links
```

### Unlinking Categories <a href="#category-resetting-links" id="category-resetting-links"></a>

Removes all links of the specified category.

```
/category-advanced reset-links
```

## Supported Color Strings

You can use them to fill out some `color` options.

<table><thead><tr><th>String (case-insensitive)</th><th>Hexadecimal</th><th data-type="files">Preview</th></tr></thead><tbody><tr><td>Black</td><td><code>000000</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2F9CJVe7Q8PmUfBu4SwepI%2F1.png?alt=media&#x26;token=5469137f-cfe6-4819-acbb-78ef2702b42f"> </a></td></tr><tr><td>White</td><td><code>FFFFFF</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FgxkKbXS9sfOaNuvXZF5b%2F2.png?alt=media&#x26;token=0040a594-8f90-4d82-aa08-44e1b36948f7"> </a></td></tr><tr><td>Aqua</td><td><code>1ABC9C</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fybc7qWkTLmAHE0wHcgn5%2F3.png?alt=media&#x26;token=3fa184fe-38d1-4813-9ea4-0089a5ff5b95"> </a></td></tr><tr><td>Green</td><td><code>57F287</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FMjD1QoOsmc5GuGqnQod9%2F4.png?alt=media&#x26;token=ede02ae8-72fd-4f57-8ed0-019977094422"> </a></td></tr><tr><td>Blue</td><td><code>3498DB</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fptir5s2unRnNDXXxsyZh%2F5.png?alt=media&#x26;token=038df616-afa1-42f3-b4e8-88c48bab335d"> </a></td></tr><tr><td>Yellow</td><td><code>FEE75C</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fqov4VcJDo2BRdaHuMA1c%2F6.png?alt=media&#x26;token=731a4b7e-4ecf-4e56-ad6c-cb520ff8b877"> </a></td></tr><tr><td>Purple</td><td><code>9B59B6</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2F4f83Y5N1iVswRsSZ8E9o%2F7.png?alt=media&#x26;token=57a9fbe7-d529-4d6d-b421-2c21e4014f34"> </a></td></tr><tr><td>Luminous Vivid Pink</td><td><code>E91E63</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FYFjMBi5fv9pD9VYj6Xre%2F8.png?alt=media&#x26;token=aaaf349e-a682-47aa-8ea3-e046877e06d9"> </a></td></tr><tr><td>Fuchsia</td><td><code>EB459E</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Ff9flvRO7bQnRizT1teU5%2F9.png?alt=media&#x26;token=a9afd87e-62a0-4c21-be7b-f6d8dbe5a40b"> </a></td></tr><tr><td>Gold</td><td><code>F1C40F</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2F29tQASLIy35yzjqqvz2p%2F10.png?alt=media&#x26;token=d2359ba4-e53c-446a-affa-fb951739ee69"> </a></td></tr><tr><td>Orange</td><td><code>E67E22</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FZY8k2ZqUMaOPYVQYsgWB%2F11.png?alt=media&#x26;token=3ae118c1-cca7-4f50-972a-4c9c2884f3a2"> </a></td></tr><tr><td>Red</td><td><code>ED4245</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2F4iSWi3E5gLpmygf6PAgt%2F12.png?alt=media&#x26;token=235141ff-dd4d-449a-a1ca-015b138083f1"> </a></td></tr><tr><td>Grey</td><td><code>95A5A6</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FNrBoLTUvvd8nItpaoW0u%2F13.png?alt=media&#x26;token=50e57af2-a6b3-45f1-b35d-a7cd53604186"> </a></td></tr><tr><td>Navy</td><td><code>34495E</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FRGwJCxYssZdP4CvQaCfB%2F14.png?alt=media&#x26;token=0712adaf-a3f5-4e46-b4e0-8432850982cc"> </a></td></tr><tr><td>Dark Aqua</td><td><code>11806A</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2F2xe1K6spsh5NFIPttD5h%2F15.png?alt=media&#x26;token=32317e51-b2ba-466e-adb4-b5571061cbd4"> </a></td></tr><tr><td>Dark Green</td><td><code>1F8B4C</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FBpnrmVpU7ylRlznVGN80%2F16.png?alt=media&#x26;token=7ac1ed4a-f456-4b19-ab54-c3f41e1bb33b"> </a></td></tr><tr><td>Dark Blue</td><td><code>206694</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FrrNYxkoRTkppvG6EzSDz%2F17.png?alt=media&#x26;token=ffd27a6c-d9d5-4506-9c6c-69efeabea6d0"> </a></td></tr><tr><td>Dark Purple</td><td><code>71368A</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fdp5Tlbo1QVYfs0sPuYBR%2F18.png?alt=media&#x26;token=6b9b536c-34a2-4eb5-adbc-c067b5df3a45"> </a></td></tr><tr><td>Dark Vivid Pink</td><td><code>AD1457</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FcqAqw0Xkv2SQUNHdJe6j%2F19.png?alt=media&#x26;token=a1bea525-071c-4d07-9d9d-ea14606c2440"> </a></td></tr><tr><td>Dark Gold</td><td><code>C27C0E</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FNdGYXr4QEqX3h3uAPMdd%2F20.png?alt=media&#x26;token=742dc7ef-a184-421e-b0d2-6464cbd749d5"> </a></td></tr><tr><td>Dark Orange</td><td><code>A84300</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fu5ZsDlQCvLqLHJTchAdD%2F21.png?alt=media&#x26;token=83637958-54b7-410e-b734-dc8369c04cc4"> </a></td></tr><tr><td>Dark Red</td><td><code>992D22</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FjZNufnbjgSVGPPxWsMAw%2F22.png?alt=media&#x26;token=09a788ef-3a53-454a-9ae5-2f37ce37c28e"> </a></td></tr><tr><td>Dark Grey</td><td><code>979C9F</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FL64r9TbFuYcnw5GCXQNE%2F23.png?alt=media&#x26;token=0c737fc8-f176-4705-a350-9aa64a05ab2f"> </a></td></tr><tr><td>Darker Grey</td><td><code>7F8C8D</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fv2yhuOWmd1PV5fhAasns%2F24.png?alt=media&#x26;token=17106107-30f5-46a2-abba-8365564619ed"> </a></td></tr><tr><td>Light Grey</td><td><code>BCC0C0</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FDbqUs5lfI1twKWgvPul3%2F25.png?alt=media&#x26;token=8aa26b28-6eba-4434-aec8-3e7c4c7c5604"> </a></td></tr><tr><td>Dark Navy</td><td><code>2C3E50</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FdNaLzoTnFFgjdYTHzaHu%2F26.png?alt=media&#x26;token=a6ef242f-f7c3-43b4-a9ea-98a3591698c9"> </a></td></tr><tr><td>Blurple</td><td><code>5865F2</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FP8z4KMrgHQE4sBEBaIwM%2F27.png?alt=media&#x26;token=7e54c0d5-321f-454a-b2b2-2a940bd5d870"> </a></td></tr><tr><td>Greyple</td><td><code>99AAB5</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FDWSEnV5wKDUgcbMwwXrD%2F28.png?alt=media&#x26;token=d9f35ad4-2ba1-4d4f-ac9b-d71dc47e4113"> </a></td></tr><tr><td>Dark But Not Black</td><td><code>2C2F33</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fxsn4jhdlXUW0fP3PyQsa%2F29.png?alt=media&#x26;token=7d89b657-7eb5-4b66-9820-97f4f73b4327"> </a></td></tr><tr><td>Default</td><td><code>2C2F33</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2Fxsn4jhdlXUW0fP3PyQsa%2F29.png?alt=media&#x26;token=7d89b657-7eb5-4b66-9820-97f4f73b4327"> </a></td></tr><tr><td>Not Quite Black</td><td><code>23272A</code></td><td><a href="https://985934113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEa6g5Gb6Ew3IUZoo1T1C%2Fuploads%2FAknjONfDXBTZzksRcI0T%2F30.png?alt=media&#x26;token=987c4995-1e72-4cd6-9c23-fe8134f524fe"> </a></td></tr></tbody></table>
