Introducing Project Overlord! This is an open source Python Discord bot made by students in Rensselaer Polytechnic Institute's RCOS (Rensselaer Center for Open Source).
Our goal is to create a functional bot that may be integrated into Discord servers to encourage the use of this platform in the classroom setting as well as foster a community of students within the discord platform. By combining school and leasure, we aim to provide a fun yet impactful assistant.
The following bot modules and functionalities are in development:
- Degree/course planner
- Web crawler with many different search functions
- Chat management to help administer a Discord server
- Minigames inside of Discord
- Calendar to keep track of important events
- Polling to create surveys
- Dockerizing the application
In order to run this project and start your own instance of this Discord bot, you will need to do the following:
- Create a Discord Developer Account
- Clone the repository to your local machine
- Install Python 3.9
- Install the requirements
- Create a .env file in the root directory to store the following variables:
- Run the bot.py file
Implementation:
- Package coming soon
- Web version available
For instructions on how to use the Discord bot's commands, please see the cogs folder and click on individual modules. Most of these modules have examples on how to use the corresponding commands.
In the future, we plan on merging the individual module instuctions into an "INSTRUCTIONS.md" file.
Currently, we do not have many configuration options, but we are planning on adding this capability for the bot. We understand that most Discord bots already available have settings/configurations to customize the experience for users, and we are fully committed to making this happen.
This section will be expanded in the future when bot modules have matured more.
We welcome with open arms the aid of fellow students of all skill sets to continue to develop new features and further refine this bot.
Please review the CONTRIBUTING.md file for more details.
This project is licensed under the MIT License - see the LICENSE file for details.
We chose the MIT License because it is a permissive open-source license that allows users to use, modify, and distribute the project's code with minimal restrictions. The MIT License allows developers of all backgrounds to contribute to this project, as well as adapt this project for their own needs, without having to worry about complex problems from licensing issues. Additionally, the MIT License aligns with the Rensselaer Center for Open Source's (RCOS) philosophy of promoting collaboration and community-driven development.