boost-py is a Python implementation of the Boost board game designed by Dr. Brady J. Garvin. It can be run interactively on the terminal, or as a Discord bot.
- Python 3
termcolor(optional) - for colored output on the terminaldiscord.py(optional) - for Discord bot functionality
To get boost-py, simply clone the repository and then install the dependencies with pip.
To play boost-py from the command line, cd into the repo and run python3 boost.py.
To run boost-py as a Discord bot, you have two options:
- Run
python3 bot.py [token], where[token]is your Discord bot token. - Save your Discord bot token to a file named
token.txtin repo directory. Then, run./bot.sh(or./bot.sh&to run it in the background).
After inviting the bot to a server, you can view a list of bot commands by sending /boost help in a channel the bot can read and send messages in.
boost-py is being developed by Maugrift as a fun side project, so don't expect incredible levels of polish. However, I am open to issues and pull requests!
If you want to submit a PR, make sure to run pylint (or pylint3) on all of the source files you've changed and ensure there are as few lint issues as possible. Of course, also make sure you run the game (both CLI and Discord bot if possible) to check for bugs. You can utilize any of the applicable debug rulesets in boost.py to check certain hard-to-test conditions, such as victory.
If you're not sure what to work on, you can find a temporary list of tasks in a comment in boost.py.
boost-py is licensed under the GNU Affero General Public License. Among other things, this means that if you want to fork the repo and run your own Discord bot based on boost-py, you need to disclose the source code of the bot. To do this, I recommend adding a command to the bot (similar to the /boost info for this bot) that provides a link back to your repository.