![Logo](images/discord-join-quiz-bot.png)
A simple bot to ensure users have read your server rules
Report Bug
·
Request Feature
Table of Contents
Running a large, publically posted Discord server with an oft misunderstood topic (Infosec/Ethical Hacking), we found that many new users were joining, immediately bypassing the rules screen without reading, and then proceeding to immediately violate the rules. Our solution to this problem was to build a bot that would intercept any new joiners, and ask them a few simple questions that hit on the biggest problems we see from users ignoring our rules.
The simplest way to get started running the bot is to run it locally on your development system.To do this you will need:
- A supported version of Python installed
- A Discord bot token (Instructions here)
- A Discord server to test in
- Clone the repository (
[email protected]:loredous/discord-join-quiz-bot.git
) - Change into the newly cloned repository (
cd discord-join-quiz-bot
) - Install the required packages used by the bot (
pip install -r requirements.txt
) - Modify the
example_quiz.yaml
file to include the appropriate ID values for your test server - Set the Discord bot token in the environment variable BOT_TOKEN (
export BOT_TOKEN=mytokengoeshere
) - Run the bot (
python code/bot.py
)
- pip
pip install --update pip OR apt-get install python3-pip OR yum install python-pip
The preferred way to run the bot is by deploying the latest version of the Docker container image with your specific quiz configuration mapped to /conf/quiz.yaml
, and the Discord bot token provided in the environment variable BOT_TOKEN.
docker run -d -e BOT_TOKEN=mytokengoeshere -v ./my_quiz.yaml:/conf/quiz.yaml docker pull ghcr.io/loredous/discord-join-quiz-bot:main
!!! COMING SOON !!!
!!! COMING SOON !!!
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the GPL-3.0 license. See LICENSE.txt
for more information.
Jeremy Banker - Loredous#7762
Project Link: https://github.com/loredous/discord-join-quiz-bot