break-dice-bot

A Discord.py Bot that handles check and contest mechanics for the TTRPG BREAK!!,
self-hosted by the user to enable uptime whenever they want.

How to Host

If you want to run and host it for your own server, follow the next few steps.
It is a bit technical and an in-depth explanation on setting up a Discord Bot won't be explained here.

Requirements:

• Python 3.x with the discord.py package
• Git
• A Discord Bot setup

Links:

• Python: https://www.python.org/downloads/
• Discord.py: https://pypi.org/project/discord.py/
• Git: https://git-scm.com/

Steps:

1. Run git clone https://github.com/qu-gg/break-dice-bot.git in the command line (cmd)
2. Add a file to the folder called bot_token.py
3. In that file, add the line BOT_TOKEN = "XXX" where XXX is your client secret key
4. Invite the bot with your bot link in the Discord Developer Portal.
5. Run the bot via python main.py

Example of an appropriate bot link, changing CLIENT_ID_HERE with the Client ID from the Discord Bot Portal: https://discord.com/api/oauth2/authorize?client_id=CLIENT_ID_HERE&permissions=2048&scope=bot

Command Examples

Check and Contest mechanics are provided out of the box, with parameters in Discord to set stats, edges, and bonuses.
Technically, there is code for in-Discord visualization of all the player and area conditions, however given the 3rd Party License, I cannot provide the .json files with their text. You can make your own .jsons (e.g. conditions.json and battlefield.json) and add them yourself if you'd like that functionality.

Check Mechanics:

Contest Mechanics:

Player Condition Visualization: