serenity
HomeCommandsStatusEmbed BuilderFAQ
  • Introduction
  • Get started
    • Welcome & Leave
      • Setting up Welcome
      • Setting up Leave
      • Setting up JoinDM
    • Moderation Setup
    • Lastfm
  • Security Setup
    • Antinuke
      • antinuke rolecreate
      • antinuke roledelete
      • antinuke editrole
      • antinuke giverole
      • antinuke channelcreate
      • antinuke channeldelete
      • antinuke kick
      • antinuke ban
      • antinuke massmention
      • antinuke newaccounts
      • antinuke spammer
      • antinuke botadd
    • Automod
      • Filter Invites
      • Filter Words
      • Filter Joins
    • Fake Permissions
  • Server Setup
    • Roles
      • Reaction Roles
      • Booster Roles
      • Button Roles
    • VoiceMaster
    • Counters
    • Tickets
    • Starboard
  • Embeds
    • Content in Embeds
      • Parameters
      • Variables
    • Writing Embed Code
    • Using Webhooks
    • Pagination
  • Miscellaneous
    • Antinuke Punishments
    • Fake Permissions
    • Donator Perks
    • Website
    • Support Server
Powered by GitBook
On this page
  • What are button roles?
  • Creating a button role
  • Removing a button role
  • Removing all button roles for a message
  1. Server Setup
  2. Roles

Button Roles

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

PreviousBooster RolesNextVoiceMaster

Last updated 1 month ago

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.

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.

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/...
Writing Embed Code
List all buttonroles for the server