dddice Browser Extension

Roll 3D dice from your favorite VTT! Integrates dddice with browser-based virtual tabletops, providing you with a seamless dice rolling experience. Use dddice to overlay dice on your stream, or simply share the fun of dice rolling in a private room.

Supports:

• D&D Beyond
• Roll20
• Dungeon Master's Vault

Installation

Install this extension for Chrome or Edge.

Development

If you would like to contribute to this extension (i.e. add support for your favorite VTT), follow the instructions below.

You will need Node.js and NPM.

Chromium Browsers

# Clone this repository
git clone git@github.com:dddice/dddice-browser-extension.git

# Install dependencies
npm i

# Start the browser extension for chromium browsers
npm run start

In Chrome, navigate to chrome://extensions/ (edge://extensions in Edge) and toggle Developer Mode in the upper-right corner (bottom-left in Edge).

Click Load unpacked and locate the manifest_v3/ directory that was built in this repository.

Firefox

# Clone this repository
git clone git@github.com:dddice/dddice-browser-extension.git

# Install dependencies
npm i

# Start the browser extension for chromium browsers
npm run start:firefox

You need the developer version of Firefox. Navigate to about:addons/ then click the cog button and select "Debug Add-ons"

Click Load temporary addon and locate the manifest_v2/ directory that was built in this repository.

Debug Logging

In order to enable debugging messages, which show in the console, you must set the localStorage key debug to *. This can be done by entering the following code in the browser's console:

localStorage.setItem('debug', '*');

If you plan on contributing your changes upstream (always appreciated!), then do the following:

• To conform to our code style, either run npx husky install to install our git hooks, or run npx prettier src --write && npx eslint src --fix before comitting.
• Rebase/squash your commits to submit one clean commit.
• Use Conventional Commits prefixes in your commit message. See examples in our git log. This helps our automation update the changelog. Here's a few examples:
  • feat: for new features.
  • fix: for general fixes.
  • fix(d&db):, fix(roll20):, fix(dmv): or fix(pb2e): for D&D Beyond, Roll20, Dungeon Master's Vault, or Pathbuilder 2e fixes, respectively.

If you have any questions at all, please join our Discord server. We'll be happy to help in any way we can.

License

MIT