Discord-RoleReact

A bot that automatically assigns roles based on message reactions.

Built on discord.js v13 API (npm i discord.js@^13) and tested on Node v18.16.0.

Features

• Customizable messages, reactions, commands, and roles

• Auto-removes role when user removes a reaction

• Retains channel/message/reaction on restart

• Prints Roles and Role ID's in console

Installation

Clone this repository to your local machine.

Open roleReact.js, you will need to change most of the settings at the top of the file. The relevant lines look like this:

//Settings!
const yourID = ""; //Instructions on how to get this: https://redd.it/40zgse
const storageFile = './roleMessages.json';
const setupCMD = "!createrolemessage"
let initialMessage = `**React to the messages below to receive the associated role. If you would like to remove the role, simply remove your reaction!**`;
const roles = ["Hacker", "Artist", "Public Relations", "Intern"];
const reactions = ["💻", "🖌", "😃", "🆕"];
const botToken = ""; /*You'll have to set this yourself; read more
                     here https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token*/

For the bot to work properly, you must:

• Fill in the yourID variable; you can get it in any discord channel by typing "@YOUR_NAME". For me, it would be @Night.

• Adjust the setup command, if you do not like the default one

• Adjust the initial message, if you do not like the default one

• Adjust the JSON storage file location, if you do not like the default one

• Adjust the roles to ones that are actually in your server ($roles will print these in the bots console/pm2 logs); make sure the bot's role is high enough on the list in your server's settings that it can assign the them properly.

• Replace the reactions with the ones of your choosing. Note: to get the value for the reaction, do NOT simply type :my_reaction: and copy the result. You must type \:my_reaction with the backslash and copy that result after pressening enter. If done correctly, the reaction should appear smaller than usual.

• Set up the bot and get the token. This [Github Wiki Page](here https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) does a better job of expaining it than I ever could. An image of the permissions the bot needs can be found here.

Starting the bot

in the console while in the roleReact root folder run node roleReact.js

Auto Start (Optional)

This will quickly add roleReact to your PM2 processes

If you don't have PM2 installed already sudo npm install -g pm2

While in the roleReact root folder run pm2 node roleReact.js --name Roles

Then you can use the following commands to restart, stop and start the bot.

pm2 stop Roles
pm2 start Roles```

## Conclusion 

I hope you find this bot useful. If you need any help, or find any bugs, use the appropriate forums in this repository to contact me.