Development stopped indefinitely due to lack of users. If someone wants to pick up this project, feel free to. Incomplete refactoring to pycord v2.x major release can be found in the the PR: #112
Discord bot for organizing PUGs (pick-up games). Built for Neotokyo, but should work for any two-team game with even number of players total.
This project supports Python 3.8 or newer.
Commands are prefixed with a character defined by the config value NTBOT_CMD_PREFIX, by default "!", so the command pug becomes !pug in the Discord chat, and so on.
clearpuggers— Empty the PUG queue. Command access can be restricted by role(s) with the config valueNTBOT_PUG_ADMIN_ROLES.ping— Bot will simply respond with "Pong". Use to test if the bot is still online and responsive.ping_puggers— Ping all the players currently in the PUG queue. Can be used to manually organize games with smaller than expected number of players. Expects a message after the command, eg:!ping_puggers Play 4v4?pug— Join the PUG queue if there is room.puggers— List players currently in the PUG queue.scramble— Suggest randomly scrambled teams for the last full PUG for balancing reasons. Can be repeated until a satisfactory scramble is reached.unpug— Leave the PUG queue.
The config values have been documented as comments in the config.yml file itself.
For running the bot, it's recommended to use the main branch.
Some common deployment options listed below, for your convenience:
Do note that Heroku will stop offering a free hosting tier by Nov 28, 2022.
The Docker image linked above (rainrainrainrain/discord-bot-ntpug:latest) is compatible for example with the fly.io tutorial, if you're looking for a place to host. Just note that you'll have to escape the string quotes for env vars inside your fly.toml as NTBOT_SECRET_TOKEN = "\"secret here\"", etc. More info on this quirk in the config.yml comments. The same applies for env variable input for other cloud providers.
Example fly.toml file, for fly.io deployments, is available here.
It's also possible to install and run the bot manually in your machine/VM. Example Bash script is available here.
Check the issues tab to see if your problem has already been reported. If not, feel free to open a new issue.
There's also a discussions tab in the repo for more freeform questions/suggestions.
Pull requests are welcome! Please target the main branch for your edits. Also consider tagging yourself in the relevant issue ticket, or creating a new issue for your feature if it doesn't exist yet, to avoid conflicting updates.
This project complies to PEP 8 and Pylint defaults; it's recommended to test your final code before submission:
python -m pip install --upgrade pip
# Consider virtualizing the dev environment
# below to keep things clean.
# Eg: https://pipenv.pypa.io/en/latest/
# Install requirements
pip install -r requirements.txt
# Test tools installation (if you're using a venv,
# you may wish to also install these tools inside
# it to ensure they can see the requirements)
pip install pylint
pip install pycodestyle
# Lint the code!
pylint bot.py
pycodestyle bot.py