Skip to content

keshon/dice-roller

Repository files navigation

Dicer Roller

Dicer Roller is a Discord bot designed for rolling dice for tabletop gaming.

Download Binary

Binaries (Windows only) are available at Release page. It is recommended to build binaries from source for the latest version.

Discord Commands

Dicer Roller supports various commands with their respective aliases for convenient dice rolling. Some commands require additional parameters:

  • Commands & Aliases:
    • roll (r)
    • about (a)
    • help (h)

Commands should be prefixed with dice by default. For instance, dice roll, dice help, and so on.

Examples

To use the roll command, provide a valid dice expression as a parameter, e.g.:

  • dice roll - roll 1d20 by default and print result
  • dice roll 2d20 - roll one 20 sided dice 2 times and print total summ
  • go roll 1d20 2d4 - roll one 20 sided dice, two 4 sided dices and print total summ

Adding the Bot to a Discord Server

To add Dicer Roller to your Discord server:

  1. Create a bot at the Discord Developer Portal and acquire the Bot's CLIENT_ID.
  2. Use the following link: discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=36727824
    • Replace YOUR_CLIENT_ID_HERE with your Bot's Client ID from step 1.
  3. The Discord authorization page will open in your browser, allowing you to select a server.
  4. Choose the server where you want to add Dicer Roller and click "Authorize".
  5. Grant Dicer Roller the necessary permissions for it to function correctly.

Once the bot is added, proceed to actual bot building.

Building from Sources

Dicer Roller is written in Go language, allowing it to run on a server or as a local program.

Local Usage Follow the provided scripts to build Dicer Roller locally:

  • bash-and-run.bat (or .sh for Linux): Build the debug version and execute.
  • build-release.bat (or .sh for Linux): Build the release version.

For local usage, run these scripts for your operating system and rename .env.example to .env, storing your Discord Bot Token in the DISCORD_BOT_TOKEN variable.

Server Usage For Docker deployment, refer to the deploy/README.md for specific instructions.

Where to get support

If you have any questions you can ask me in my Discord server to get support. Bear in mind there is no community whatsoever — just me.

License

Dicer Roller is licensed under the MIT License.

About

Dicer Roller is a Discord bot designed for rolling dice for tabletop gaming.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published