Button Roles

Allow your members to assign themselves roles by clicking a button.

What are button roles?

Button roles are roles that are assigned to members when they click a button on an existing message or embed. They can be useful for letting members choose unique roles or as a way to verify themselves.

Creating a button role

You can create multiple button roles for a single message.

Button Roles can only be assigned to messages or embeds created by serenity. If you don't know how you can create a message or embed, check out our Scripting Guide below.

Writing Embed Code

Syntax: ;buttonroles add [message] [name] [emoji] [color] [roles]
Example: ;buttonroles add .../channels/... Verify ✅ green, @Member

If you don't want a name or an emoji on the button, you can enter "none" as the name/emoji for either of them.

You can append more than one role on a Button, simple split them with a comma.

Removing a button role

You can remove a specific button role by using the buttonrole remove command.

You can use the buttonrole list command to see all button roles in your server.

List all buttonroles for the server

Syntax: ;buttonroles remove [message] [name]
Example ;buttonroles remove .../channels/... Verify

Removing all button roles for a message

Additionally, you can remove all button roles from a message by using the buttonrole clear command.

Syntax: ;buttonroles removeall [message]
Example: ;buttonroles removeall .../channels/...