Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 4.27 KB

README.md

File metadata and controls

87 lines (53 loc) · 4.27 KB

AutoRoleBot

Logo
Automatically assign roles to users for ease of event management on Discord.


GitHub pull-requests GitHub issues GitHub contributors

GitHub license GitHub repo size

Code of Conduct Open Source Love svg1

Table of Contents

Motivation

Over the last few years of event management on an online medium, Discord has been our go to platform for ease of communication with the participants. However, it has become very taxing to assign roles for each member of a team for every event. Especially when the events are large, like WebHunt with over 200+ Participants.
And so, we decided to create a bot that would automate the task of providing roles to participants on the Discord sever.

Installation

For the latest stable version, head over to Releases.

Download and extract the source code.

As an alternative, you could also clone the repository using,

git clone https://github.com/Open-Source-Community-VIT-AP/AutoRoleBot

Once you have the source code, create a virtual environment using the following command, python3 -m venv venv

Enter the virtual environment using venv/Scripts/Activate on your terminal

Once you are inside the virtual environment install dependancies using pip install -r requirements.txt.

Finally, create a discord token and add it to the .env file Check .env.example for variable names. For more information, checkout this article https://www.writebots.com/discord-bot-token/.

You are all set to start using the application now.

Usage

To launch the file, use the following command, python3 main.py inside the src file.

Once the bot is online on your discord server, you can use all of it's various commands on the server.

Note: Make sure to create a role called AutoRole Admin and assign it to the people who will be using the bot.

Setup your participants.csv file in the data folder. Make sure to follow the exact same format as the example file.

Various bot commands

  • ==addrole : Adds roles to all the users present in the participants.csv file and joined the Discord Server.
  • ==usersleft : Provides you a list of users that are yet to join the Discord server.

Contributing

To contribute to AutoRoleBot, fork the repository, create a new branch and send us a pull request. Make sure you read CONTRIBUTING.md before sending us Pull requests.

Also, thanks for contributing to Open-source!

License

AutoRoleBot is under The MIT License. Read the LICENSE file for more information.