The Goddess of Good Fortune, otherwise known as Lady Luck. Feeling lucky? Take a roll with her dice, they only decide fate itself!
Tymora is a Discord bot for dice rolling, aptly named after the goddess from the Forgotten Realms.
- Docker
- Docker Compose
- Setup an application in the Discord Developer Portal
- Clone the repo
# Use this command for https
git clone https://github.com/xhudaman/discord-dice-roller-bot.git
# Use this command for ssh
git clone [email protected]:xhudaman/discord-dice-roller-bot.git- Navigate into the project directory and run the following to get a terminal in the container:
docker-compose run bot sh- Inside the container's terminal run the following to install dependencies:
pnpm i- Exit the container's shell
exit- Run
docker-compose upto start the dev server.
After intial setup only step 5 is required to run the dev server.
| Command | Description |
|---|---|
/roll |
Rolls dice using standard dice rolling notation. i.e. /roll 1d20 + 2 |
/help |
Prints out the help dialog explaining what commands are available and how to use them, if necessary. |
/source |
Prints out a link to the source code (this repo) and a list of contributing authors for the project. |
To perform a basic roll use the roll command followed by the dice you want to roll.
Note: The dice rolling notation should be filled in as the
dice-stringoption of the command. So in the following example thedice-stringoptin would be 1d20.
/roll 1d20
In this scenario the number 1 in 1d20 indicates the amount of dice. The d indicates that the following number is the number of faces the desired dice have. In this case the dice to be rolled are 20 sided dice as noted d20.
Note: Both the amount of dice and the number of faces on dice can be anywhere from
1-999.
To roll with a modifier simply add whatever the modifier is onto the command, like so: !r 1d20 + 2. In this example after rolling a 20 sided die 2 would be added to the total. So if my roll was 10, the modifier would be added for a total of 12.