# Dramatic Rolls

![GitHub release (latest by date)](https://img.shields.io/github/downloads/gsimon2/dramatic-rolls/latest/module.zip)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/gsimon2/dramatic-rolls/module.zip)
![Foundry Version](https://img.shields.io/badge/dynamic/json?color=orange&label=Foundry%20Version&query=compatibility.verified&url=https%3A%2F%2Fraw.githubusercontent.com%2Fgsimon2%2Fdramatic-rolls%2Fmain%2Fmodule.json)
[![](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-%243-blue)](https://www.buymeacoffee.com/gsimon2)

## Overview

Dramatic Rolls is an exciting module for [FoundryVTT](https://foundryvtt.com/) that adds a touch of drama and excitement to your natural 20s and natural 1s! Enhance your gaming experience with customizable sound effects, eye-catching animations, and confetti explosions that celebrate critical successes and emphasize critical failures. Whether you're landing a perfect hit or fumbling spectacularly, Dramatic Rolls ensures these pivotal moments are marked with flair, creating memorable experiences for both players and Game Masters alike.

For users of the Pathfinder 2e game system, Dramatic Rolls offers additional options to trigger effects based on critical successes and failures, even when the result isn't from a natural 20 or 1. This feature takes into account the Pathfinder 2e degree of success system, allowing for more nuanced and system-specific dramatic moments during gameplay.


### Dramatic Rolls Example

![dramatic-rolls-example](https://github.com/user-attachments/assets/3b82d375-62b7-4d05-96d0-f6a88f301789)

### With Dice So Nice

![dramatic-rolls-example-dice-so-nice](https://github.com/user-attachments/assets/7799e746-6e8b-4667-a889-c9aa4f4e7bcd)

## Features

- Sound effects for critical hits (natural 20s) and fumbles (natural 1s)
- Customizable sound library with ability to add your own sounds
- Visual effects including confetti and more for critical hits
- Compatible with Dice So Nice! module
- Configurable settings to fine-tune your experience

## Game Systems Support
- Pathfinder 2e: Trigger effects on critical successes and failures based on degree of success, not just natural 20s and 1s
- GURPS: Trigger effects on critical successes and failures based on GURPS 4e rules, only for 3d6 rolls with calculated margin of success/failure.

## Installation

1. In the Foundry VTT setup screen, go to the "Add-on Modules" tab
2. Click "Install Module"
3. Search for "Dramatic Rolls" or paste this manifest URL: 
   `https://github.com/gsimon2/dramatic-rolls/releases/latest/download/module.json`
4. Click "Install"

## Usage

Once installed and enabled, Dramatic Rolls will automatically add sound and visual effects to your natural 20s and 1s. You can customize the module's behavior in the settings.

### Configuration

1. Go to "Game Settings" > "Configure Settings"
2. Find "Dramatic Rolls" in the list
3. In this menu, you can:
   - Enable/disable sounds and animations
   - Adjust sound volumes
   - Add custom sounds
   - Curate which animations play for critical hits and fumbles
   - Configure which rolls (private, public, npc, etc) should trigger effects

## Compatibility

- Works with Foundry VTT version 11 and above
- Compatible with Dice So Nice! module

## Support

If you enjoy this module, consider buying me a coffee: [![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-%243-blue)](https://www.buymeacoffee.com/gsimon2)

## Contribution
Thanks to all the contributors who have helped improve this project:
- [Chris Maillefaud](https://github.com/chrismaille) - 1 commit

(This list is automatically generated based on git history.)
<!--  To update, run `git shortlog -sne` and update the commit counts and usernames accordingly.-->

Feel free to submit issues or pull requests on the [GitHub repository](https://github.com/gsimon2/dramatic-rolls).



## License

This project is licensed under the GNU General Public License v3.0 (GPLv3).

You can find a copy of the license in the LICENSE file in the project repository or at https://www.gnu.org/licenses/gpl-3.0.en.html

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.