Discord Voting Bot

A custom voting bot that counts the reactions to a message. The bot takes advantage of discord.js and the Discord API. There are 4 different types of voting that can be done. Voting, majority voting, conviction voting, and quadratic voting.

Authors

• @Dvent1123

Tech Stack

Bot: Discord.js

Project Title

A brief description of what this project does and who it's for

Deployment

To deploy this project run either locally or deployed. You must have node version 16.4 or higher to use discord.js

Clone this project

  $ git clone https://github.com/Dvent1123/discordBot

Change directories into the project folder

  $ cd <Folder Path>

Install all Dependencies

  $ npm install

Make a dotenv (.env) file in the main folder directory put in this file only one variable, the variable token. TOKEN=

In the main directory run

  $ node index.js

Notes: Make sure to get your token from the discord developer portal. You must also allow the bot full permissions to give it access to the users.

Commands

Voting

This is regular voting rules, limited to these reactions ['👍', '👎']. The user can either vote with a '👍' or a '👎'. After the set time limit (in seconds) goes by a message will be sent with the results. Votes will be limited to the specified role and in the server/guild that is mentioned.

  -voting #<Guild ID/Name> @<Specified Role> <Time Limit (secs)> <Question>

Majority

Majority voting has two different ways to end the voting poll, time limit as well as percentage, and limited to these reactions ['👍', '👎']. The time limit (in seconds) sets how long the poll will stay open for and the percentage is the percentage majority needed to pass and is calculated by totalRoleMembers * (percentage [user-input] / 100). Once the percentage or time limit is reached then the poll is ended.

  -majority #<Guild ID/Name> @<Specified Role> <Time Limit (secs)> <Percentage> <Question>

Conviction

Conviction voting allows the user to vote using either ['👍', '👎'] as their reaction. The user can choose to change there vote at any time before the poll hits the time limit; however, the longer a user casts a vote for the more weight is place on their vote. For example: This conviction vote is set to expire in 60secs with 4 intervals and a mulitiplier of 2, then the voter has the ability to cast a vote in 4 different time intervals (60secs/4 intervals). If they user cast their vote early, in the first interval, then their vote gets multiplied by 2 with every interval that passes so the vote that would have counted as 1 is actually 16 by the time the vote is over. If they recast their vote lets say, in the 3rd interval then the multiplier would only occur twice and their vote would count for less than if they had cast it early.

  -conviction #<Guild ID/Name> @<Specified Role> <Time Limit (secs)> <Intervals> <Multiplier> <Question>

Quadratic

Quadratic voting gives a voter a certain amount of votes to cast and how strongly a user feels about the proposal is how many votes they will cast. In this implementation it will count the total number of reactions given vs. the total amount of reactions available. The number of votes cast will tell the admin how heavily the users feel about a proposal. They are allowed to pick from this set of reactions ['👍', '😀', '🤠','😗','😉']. Then tracks the number of reactions members have given to an active proposal. The reaction limit that we have set is currently set to 5 options or less but more can be added easily.

  -quadratic #<Guild ID/Name> @<Specified Role> <Time Limit (secs)> <Reaction Limit> <Question>