Documentation

Custom Roles

Let members create their own personal display role with a name, color, and icon.

What it does

Custom roles let each member make a personal role just for themselves with ,cr (alias ,br). It is the role they show off with, their own name and color on the member list. Custom roles are cosmetic only and carry no permissions by default.

Custom roles are configured on the Custom Roles dashboard page (Engagement section) or with ,cr config.

Commands

Each member manages their own role:

,cr create [name]          make your custom role (default name if you skip it)
,cr name <text>            rename your role
,cr color <hex>            recolor your role, e.g. ,cr color #ff8800
,cr icon <emoji|url|file>  set a role icon (needs Boost Level 2)
,cr share <@user>          let a friend wear your role (no args lists who you shared with)
,cr unshare <@user>        take your role back from a member
,cr delete                 remove your custom role

Sharing only ever hands out your own custom role, never any other role on the server. If you delete your role or lose the required role, everyone you shared it with loses it automatically.

Admin setup

Open the Custom Roles dashboard page or use ,cr config to control the feature:

  • Enable or disable custom roles for the server.
  • ,cr config required @role sets a role members must have before they can create a custom role.
  • Set a per-user limit on how many custom roles a member can hold.
  • Set a server-wide cap on the total number of custom roles.
  • Set the share limit: how many other members a person can share their custom role with using ,cr share. Set it to 0 to turn sharing off entirely.
  • ,cr config anchor @role sets an anchor role that controls how high custom roles sit in the role list. Custom roles are placed relative to it.
  • Optionally allow a set of permissions on custom roles. The default is none.

Use ,cr list to see every custom role on the server.

Auto-cleanup

Custom roles clean themselves up:

  • If a member loses the required role, their custom role is deleted.
  • If a member leaves the server, their custom role is deleted.
  • If a custom role is deleted manually, its record is removed too.

Note: exceed needs the Manage Roles permission, and it must sit above the custom roles in the role list so it can edit and place them.