Skip to content

ryandougc/dnd-dice-bot

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Discord Dice Bot

A discord bot that rolls an infinite amount of dice with an infinite amount of sides

View Demo · Report Bug · Request Feature

About The Project

A discord bot that lets you roll any amount of dice with any amount of sides. Optionally add modifiers to your roll.

(back to top)

Built With

  • Node
  • Discord

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need the following to start development on this bot:

  • Node.js
  • Npm
  • Discord Bot

You can visit the Discord.js Documentation for step-by-step instructions on how to get setup

Installation

  1. Clone the repo
    git clone https://github.com/ryandougc/dnd-dice-bot.git
  2. Install NPM packages
    npm install
  3. Duplicate the sample.env file and rename it to .env
  4. Enter your Discord bot token and client id into the .env file in the respective spots
    DISCORD_API_TOKEN=<place token here>
    DISCORD_CLIENT_ID=<place client id here>

(back to top)

Usage

In the Discord server chat where your bot has been added, use the following command:

/roll <!optional: modifier>

  • number of dice - Enter in how many rolls of a die should happen

  • number of faces - Enter the number of faces the die should have

  • modifier - (optional) Numbers to add to the sum of the roll. Can be positive or negative

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Purvit - @purvitgupta

Ryan - @ryanvoiture - hello@ryancarr.ca

Project Link: https://github.com/ryandougc/dnd-dice-bot

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •