Reaction Roles
Introduction
Reaction roles are a way to allow users to assign themselves roles by reacting to a message. This can be useful for allowing users to assign themselves roles for games, pronouns, or other interests.
Typically in other Discord applications, you would have a message with reactable emojis
that users could click on to assign themselves roles. For FroggeBot, we utilize Discord
UI components to present the user with stylized buttons that they can click on to assign
themselves roles instead.
This page is intended as in-depth documentation for all elements of the Reaction Roles module. For a step-by-step guide on how to set up reaction roles, please see the Reaction Roles Tutorial.
Preparation
First off, ensure that you have FroggeBot installed in your server.
Set Post Channel
Before beginning to create a reaction role for your server, you'll need to set the posting channel for reaction roles. Run the /admin roles command in a private channel.
Click the button and the app will prompt you to select a channel to post reaction roles in.
Creating a Reaction Role
From the Reaction Roles main menu, click the button. This will begin the process of creating a new blank reaction role form.
You'll note that there are two options for creating a reaction role: Blank Message and Templated Message.
The Blank Message option will create a new message with no content.
The Templated Message option will create a message with pre-filled roles, text, and emojis.
Selecting either of these will result in a brief "thinking..." period while the app prepares the message and displays the Reaction Role's main menu.
Reaction Role Menu
The Reaction Role menu is where you can customize the message, linked roles, and emojis for your reaction role message.
Set Title
Clicking the button will prompt you to enter a title for the reaction role message. This is displayed at the top of the message, ensure you pick something descriptive. If you need additional space, consider using the Set Description button.
Set Description
The button will prompt you to enter a description for the reaction role message. This is displayed below the title and can be used to provide additional context or instructions for the reaction roles.
Set Thumbnail
The button will prompt you to enter a thumbnail image to display in the reaction role message. This is displayed to the right of the title and can be used to provide additional visual context or flair for the reaction roles.
Set Message Type
By clicking on the button, you can choose the type of reaction role message you want to create. The options are:
Normal: Hands out roles when you click on them. Does what you'd expect.Unique: Only allows a single role to be assigned at a time. Clicking on a new role will remove the old one.Verify: Roles may only be picked up, not removed. Useful for verification roles.
Add Role
Clicking the button will add a new, blank role to the message and redirect you to the new role's menu.
Edit Role
Clicking the button will open the chosen role's menu and allows you to edit the role's label, linked role, and emoji.
Remove Role
Clicking the button will remove the chosen role from the message.
Note
Removing a role will not remove the role from the server, only from the reaction role message.
Post Message
Clicking the button will post the reaction role message to the default post channel. This will allow users to assign themselves roles by clicking on the buttons attached to the message.
The Role Menu
The Role menu is where you can customize the label, linked role, and emoji for a role in your reaction role message.
Set Label
Clicking the button will prompt you to enter a label for the role. This is displayed as the text on the button that users will click to assign themselves the role.
Role Label
By default, the role label will be the same as the linked role's name. You can change this to be more descriptive or to better fit the context of the reaction role message.
Set Linked Role
The button will prompt you to enter a role to link to the reaction role message. This is the role that will be assigned to the user when they click on the button.
Set Emoji
By clicking the button, you can choose an emoji to display on the button for the role. This is purely aesthetic and can be any emoji you like that the app has access to.
Similarly, you can click the button to remove the emoji from the button.
Note
The app has access to all emojis in the current server as well as all default Unicode emojis.