mparker546 / foundryvtt-special-dice-roller

A FoundryVTT module for testing different dice

Special Dice Roller

Supports rolling dice in your chat window for various non regular dice systems:

• Legend of the 5 Rings 5th edition
• Vampire the Masquerade 5th edition
• Genesys
• FFG's Star Wars TTRPG

L5R, Genesys and Star Wars images are taken from SkyJedi's Discord Roller Vampire the Masquerade images are taken from and Lumi#5953's Thirst Discord bot.

Installation

Go to your setup page and click on the Add-on Modules Tab.

Hit the button Install Module at the bottom.

Insert the module URL https://github.com/BernhardPosselt/foundryvtt-special-dice-roller/raw/master/module.json and click Install.

After you've launched your game, go to the Game Settings page and click on Manage Modules. Enable the Special Dice Roller app and hit Save Module Settings.

Usage

You can roll a system by starting your message with the following string:

• Legend of the 5 Rings: /l5r
• FFG Star Wars: /sw
• FFG Genesys: /gen
• Vampire the Masquerade: /v5

Then supply a dice formula separated with a space. The formula consists of dice letters that are optionally prefixed with a number.

A full roll example would be /l5r rrs or /l5r 2rs.

Usage L5R

Roll Legend of the 5 Rings 5th edition dice in the chat window. Auto rolls exploding successes and let's you keep/re-roll selected dice.

Use the /l5r command using the following dice letters:

• r, b: ring
• s, w: skill

You can choose to either keep or re-roll certain dice. To do that, click on the dice to select them and hit either button. Re-rolled dice are removed from the roll and new rolls are attached at the end.

Usage Genesys/Star Wars

Usage is similar to L5R but re-rolls and keeping dice is unsupported. Use the /gen or /sw commands using the following dice letters:

• b: boost
• s: setback
• a: ability
• d: difficulty
• p: proficiency
• c: challenge
• f: force (sw only)

Usage Vampire the Masquerade

Usage is similar to L5R but keeping dice is unsupported. Use the /v5 command using the following dice letters:

• b, s: skill dice
• h, r: hunger dice

You can choose to re-roll certain dice. To do that, click on the dice to select them and hit the re-roll button. Re-rolled dice are highlighted with a green border.

Building the Project

Install yarn and run:

yarn install
yarn build

Tests use Jest and are run via:

yarn test

TSLint is used to lint files on build. You can run it separately via

yarn run lint

and fix simple errors automatically via:

yarn run fix

The relevant files and folders that need to be included in your (local) FoundryVTT module folder are:

• module.json
• dist/
• public/

Further development documentation is included in the docs/ folder.