Code Monkey home page Code Monkey logo

dddice-browser-extension's Introduction

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 [email protected]: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 [email protected]: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

dddice-browser-extension's People

Contributors

celestebloodreign avatar emjaytee404 avatar sweetb avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

Thomas Lackemann avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.