npm package: @mateo-wallace/rpg-dice-js
Description: Npm package that allows users to roll dice with all math and various forms of response
Author: Mateo Wallace
Latest version: 2.0.2

<a name="readme-top"></a>

<!-- SHIELDS -->

[![npm Downloads Shield](https://img.shields.io/npm/dt/@mateo-wallace/rpg-dice-js?style=flat-square&logo=npm)](https://www.npmjs.com/package/@mateo-wallace/rpg-dice-js)
[![Stars Shield](https://img.shields.io/github/stars/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=blue&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/stargazers)
[![Forks Shield](https://img.shields.io/github/forks/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/network/members)
[![Contributors Shield](https://img.shields.io/github/contributors/Mateo-Wallace/rpg-dice-js.svg?style=flat-square&color=success&logo=github)](https://github.com/Mateo-Wallace/rpg-dice-js/graphs/contributors)
[![License Shield](https://img.shields.io/github/license/Mateo-Wallace/rpg-dice-js.svg?style=flat-square)](https://github.com/Mateo-Wallace/rpg-dice-js/blob/main/LICENSE)
[![LinkedIn Shield](https://img.shields.io/badge/LinkedIn-555555?style=flat-square&logo=linkedin)](https://www.linkedin.com/in/mateo-wallace/)

<!-- PROJECT LOGO & HEADER -->
<br />
<div align="center">
<img src="./img/rpg-dice-js-400-circle.png" alt="rpg dice logo" width="80" height="80">

  <h3 align="center"><strong>rpg-dice-js</strong></h3>

  <p align="center">
    <strong>A dice roller for the modern JavaScript developer</strong>
    <br />
    With many settings options and response types for full customization
    <br />
    <br />
    <a href="https://mateo-wallace.github.io/rpg-dice-js/">View Docs</a>
    ·
    <a href="https://github.com/Mateo-Wallace/rpg-dice-js">View GitHub</a>
    ·
    <a href="https://www.npmjs.com/package/@mateo-wallace/rpg-dice-js">View npm</a>
    ·
    <a href="https://github.com/Mateo-Wallace/rpg-dice-js/issues">Report Bug</a>
  </p>
</div>

<!-- NPM INSTALL -->

```
npm i @mateo-wallace/rpg-dice-js
```

<!-- TABLE OF CONTENTS -->

<details>
  <summary style="cursor: pointer;"><strong>Table of Contents</strong></summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

<div align="center">
  <br />
  <img src="./img/exRoll.png" alt="example dice roller in effect">
  <br />
  <br />
</div>

rpg-dice-js is an npm package that allows a user to send an input to a `roll()` function with no need to make random number logic. It was specifically built to comply with the dice of games such as **Dungeons and Dragons** or **Pathfinder**.

Main Features:

- [Settings](https://mateo-wallace.github.io/rpg-dice-js/diceclass/#settings) adjustment within a `Dice` model
- [User input](https://mateo-wallace.github.io/rpg-dice-js/rollfunction/#valid-inputs) of all kinds accepted
- [Dice response object](https://mateo-wallace.github.io/rpg-dice-js/rollfunction/#output) with robust information such as `input`, `result`, `total`, etc...

See the [Quick Start](https://mateo-wallace.github.io/rpg-dice-js/quickstart/) guide to see how to implement rpg-dice-js into your code!

### Built With

[![JavaScript Shield](https://img.shields.io/badge/JavaScript-F7DF1E?&style=flat-square&logo=javascript&logoColor=272727)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
[![NPM Shield](https://img.shields.io/badge/NPM-333333?&style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/)
[![Node.js Shield](https://img.shields.io/badge/Node.js-339933?&style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/en/)

<!-- DOCUMENTATION -->

## Documentation

Visit the [rpg-dice-js docs](https://mateo-wallace.github.io/rpg-dice-js/) for in depth descriptions on requiring the package, customizing the `Dice` class, calling the `roll()` function, and more.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->

## 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
1. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
1. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
1. Push to the Branch (`git push origin feature/AmazingFeature`)
1. Open a Pull Request

If all of this is new to you take a look at the [GitHub Docs](https://docs.github.com/en/get-started/quickstart/fork-a-repo).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## License

Distributed under the MIT License. See [LICENSE](https://github.com/Mateo-Wallace/rpg-dice-js/blob/main/LICENSE) for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTACT -->

## Contact

Mateo Wallace

- [GitHub - github.com/Mateo-Wallace](https://github.com/Mateo-Wallace)
- [Email - mateo.t.wallace@gmail.com](mailto:mateo.t.wallace@gmail.com)
- [LinkedIn - linkedin.com/in/mateo-wallace/](https://www.linkedin.com/in/mateo-wallace/)
- [Portfolio - mateo-wallace.github.io/](https://mateo-wallace.github.io/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS -->

## Acknowledgments

I am appreciative for the source code, ideas, and inspiration that all of these repos and creators have provided to this project. If you see anything within my code that you recognize as yours and don't see yourself listed here please feel free to open an issue and I will add you!

- [Gerard Mennella - Contributor](https://github.com/GerardMennella21)
- [mathjs - josdejong](https://github.com/josdejong/mathjs)

<p align="right">(<a href="#readme-top">back to top</a>)</p>