Kayfarik Docs
Invite the BotSupport Server
  • Introduction
  • Common Problems
  • Permissions
  • Role Menus
    • Categories
    • Roles
  • Guides
    • How to Mention or Paste Server Emojis in Modals
    • Parsing Role Options
  • API
    • Parsing Role Options on Request
  • Links
    • Crowdin Translation Project
    • For Suggestions
    • Terms of Service
    • Privacy Policy
Powered by GitBook
On this page
  • Create a Role Category
  • Configure a Role Category
  • Edit Category's Embed
  • List Categories
  • Removing a Category
  • Reorder or Sort Roles in a Category
  • Synchronizing a Category
  • Setting a Required Role(s)
  • Moving Categories
  • Linking Categories
  • Unlinking Categories
  • Supported Color Strings
  1. Role Menus

Categories

PreviousPermissionsNextRoles

Last updated 1 year ago

Create a Role Category

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 or instead of the default .

  • placeholder: Placeholder text of .

  • max-options: Maximum number of selectable options / roles in the / .

  • min-options: Minimum number of selectable options / roles in the / row.

  • secret-code: Custom code that users have to submit to access the category.

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.

Category Types
  • Toggle: Users will be allowed to select / deselect roles from this category.

  • 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.

Category Components

Buttons

Select Menu

Private (Ephemeral) Select Menu

You can delete some of the category parameters using - as a value.

Edit Category's Embed

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

/category edit-embed

List Categories

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

/category list

Removing a Category

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

You can't reorder a category with more than 25 roles.

/category-advanced rearrange

Synchronizing a Category

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:

Right-click or hold category message -> Apps -> Synchronize

Setting a Required Role(s)

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

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

/category move

Linking Categories

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

Removes all links of the specified category.

/category-advanced reset-links

Supported Color Strings

You can use them to fill out some color options.

Set / Toggle: Users will be allowed to select / deselect roles from this category. Set, if the category component is . Removes all roles and gives the selected ones. Toggle, if the category component is or .

Supports up to 25 role options. Label, emoji, and color of each button .

Supports up to 25 role options. Label, emoji, and description of each option .

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 .

String (case-insensitive)
Hexadecimal
Preview

Black

000000

White

FFFFFF

Aqua

1ABC9C

Green

57F287

Blue

3498DB

Yellow

FEE75C

Purple

9B59B6

Luminous Vivid Pink

E91E63

Fuchsia

EB459E

Gold

F1C40F

Orange

E67E22

Red

ED4245

Grey

95A5A6

Navy

34495E

Dark Aqua

11806A

Dark Green

1F8B4C

Dark Blue

206694

Dark Purple

71368A

Dark Vivid Pink

AD1457

Dark Gold

C27C0E

Dark Orange

A84300

Dark Red

992D22

Dark Grey

979C9F

Darker Grey

7F8C8D

Light Grey

BCC0C0

Dark Navy

2C3E50

Blurple

5865F2

Greyple

99AAB5

Dark But Not Black

2C2F33

Default

2C2F33

Not Quite Black

23272A

Select Menu
Private Select Menu
Buttons
buttons
private select menu
select menu
select menu component
select menu
role-button row
select menu
role-button
can be changed
can be changed
can be changed