https://github.com/thijsmie/rollbot

A tabletop dice rolling bot
https://github.com/thijsmie/rollbot

dice dice-roller discord discord-py game tabletop

Last synced: 3 months ago
JSON representation

A tabletop dice rolling bot

• Host: GitHub
• URL: https://github.com/thijsmie/rollbot
• Owner: thijsmie
• License: mit
• Created: 2020-05-10T12:03:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-04T15:06:49.000Z (4 months ago)
• Last Synced: 2024-09-05T20:53:56.516Z (4 months ago)
• Topics: dice, dice-roller, discord, discord-py, game, tabletop
• Language: Python
• Homepage: https://tmiedema.com/rollbot
• Size: 650 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Roll-Bot

A tabletop dice rolling bot, which can easily be deployed to Heroku. You can also use the publicly hosted version. Go to [the rollbot website](https://tmiedema.com/rollbot) for more information.

## Configuration

The config files contain four possible entries at the moment. By default local running will use the `config/local.json` file and production will use `config/production.json`. Two example json files are provided which you can rename. The local config is gitignored to avoid exposing your testing discord bot token. It is recommended you use [Heroku environment variables](https://devcenter.heroku.com/articles/config-vars) for production configuration.

Entries `discord_token` or `discord_token_env_var` are used to set your discord bot token. If the first one is set the second one is ignored. The first one is used to directly set the token, while the second one can be used to set the name of an environment variable that holds the token.

The same principle applies for `redis_url` and `redis_url_env_var`. Note that if neither is set the app will still run without variable environment saving.

## Running Locally

Make sure you have Python 3.11 installed locally, for example using [pyenv](https://github.com/pyenv/pyenv-installer) (be sure to check the [Common build problems](https://github.com/pyenv/pyenv/wiki/common-build-problems) page if you run into any issues). To push to Heroku, you'll need to install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli). Additionally, to make user variable environments you'll need to setup redis. I suggest you don't bother with this for your local testing setup. To manage the dependencies I use [poetry](https://python-poetry.org/).

```sh

$ git clone https://github.com/thijsmie/rollbot.git

$ cd rollbot

# pyenv installing python

$ pyenv install 3.11.6

$ pyenv shell 3.11.6

# installing dependencies

$ pip install poetry

$ poetry install

# running the app

$ poetry shell

$ python runlocal.py

```

Your app should now be running and announce its discord username.

## Deploying to Heroku

First create a new app on heroku, using free dynos is fine. Provision the [RedisCloud](https://elements.heroku.com/addons/rediscloud) addon, again, free tier is fine. Now set an environment variable DISCORD_TOKEN with your discord bot token and copy `production.example.json` to `production.json`.

Then in the terminal run the following commands.

```sh

$ heroku git:remote -a HerokuAppName

$ git push heroku master

```

Your app should now be live.