Skip to content

Self Role

Jump to bottom
Alexander Remington edited this page Jun 13, 2020 · 1 revision

Features

  • Create multiple custom embedded messages with custom reactions and roles
  • Automatically assign/remove roles to users when they select/deselect a certain reaction
  • Easy installation setup

Commands

All commands require an admin role which you can set by using rl!admin (requires administrator permissions on the server). The bot will reply with missing permissions otherwise. In the following list the default prefix rl! is used.

  • rl!help shows this set of commands along with a link to the repository.
  • rl!new starts the creation process for a new reaction role message. Check below for an example.
  • rl!abort aborts the creation process for a new reaction role message started by the command user in that channel.
  • rl!edit edits an existing reaction role message or provides instructions on how to do so if no arguments are passed.
  • rl!colour changes the colour of the embeds of new and newly edited reaction role messages.
  • rl!rm-embed suppresses the embed of an existing reaction-role message or provides instructions on how to do so if no arguments are passed.
  • rl!admin adds the mentioned role or role id to the admin list, allowing members with a certain role to use the bot commands. Requires administrator permissions on the server.
  • rl!rm-admin removes the mentioned role or role id from the admin list, preventing members with a certain role from using the bot commands. Requires administrator permissions on the server.
  • rl!adminlist lists the current admins on the server the command was run in by mentioning them and the current admins from other servers by printing out the role IDs. Requires administrator permissions on the server.

Usage Example

In this example the prefix used is rl!. Once you initiate the process, be sure only to answer to the bots questions or the bot might record unwanted messages as instructions. You can still send messages to other channels, and others can send messages to the channel you initiated the process in.

Initiate the message creation process with rl!new.

User: rl!new

Next, you will be asked to mention the channel you want to send the message in.

Bot: Please mention the #channel where to send the auto-role message.
User: #get-roles

Next, you will be asked to attach emojis to roles. Only use standard emojis or those that are hosted on your server (i.e. the Bot is not a Nitro user and cannot use emojis from other servers). Send a single message for each single combination and then type done when you have finished attaching emojis to their respective roles. Ensure that the roles are mentionable when you are doing this step. You can disable mentions after finishing this step.

Bot: Attach roles and emojis separated by a space (one combination per message).
When you are done type `done`. Example:
:smile: `@Role`
User: :rage: @AngryRole
User: :sob: @SadRole
User: :cry: @EvenSadderRole
User: :joy: @HappyRole
User: done

Next, you will be asked to customise the message that the bot is going to send with the roles attached to it. Enter a title and the content of your message by separating them with // (the space before and after // is important).

Bot: What would you like the message to say? Formatting is: `Message // Embed_title // Embed_content`. `Embed_title` and `Embed_content` are optional. You can type `none` in any of the argument fields above (e.g. `Embed_title`) to make the bot ignore it.
User: none // Select your roles // Click on the buttons below to give yourself some roles!

Finally, the bot will send the message to the channel specified in the first step, and it will react with each reactions specified so that the buttons are ready to be used. The bot will remove any new reactions to the message to avoid clutter. For example, if you added an :eggplant: reaction to the message created in this example, the bot will remove it as it is not attached to any role.

FAQ

When I click one of the reactions the bot does not give me a role!

Ensure that you moved the Groot Self-Role role to a position that is hierarchically higher than the role you are trying to assign.

The bot says I am not an admin, even though I own the server (or have admin rights for it)

Run rl!admin @Role to give all users with that role permission to manage Reaction Light. This is done to have server staff use the bot without giving them unnecessary server rights. The only server admin (not bot admin) commands are rl!admin and rl!rm-admin.

Help

If you need help with the bot or need to report bugs, post an issue here.

Clone this wiki locally