Git Product home page Git Product logo

ddb-dm-screen's Introduction

DDB DM Screen

This Tampermonkey userscript that enhances the campaign page on dndbeyond.com. It adds extra character data to the character cards to function like a DM screen.

Usage

  1. Install Tampermonkey addon for managing userscripts. Get Tampermonkey
  2. Install new script from below link: https://valeryan.github.io/DDB-DM-Screen/ddb-dm-screen.user.js
  3. Open your campaign, can be found here https://dndbeyond.com/my-campaigns
  4. When a release is published it will be automatically published to the github page and should prompt to update the installed script.

Features

  1. Uses publicly accessible API endpoints and a tool called Simplified Character Data System(SCDS) to display extra information about characters on your campaign screen.

Security

Remember to never paste unknown userscripts from some shady github repos to your tampermonkey addon as this can severely compromise your PC.

Note about other DM Screen Scripts

There are several such user scripts around and some Chrome extensions, etc. I draw inspiration from all these.

Development

The development method is based on webpack-usersript-template. Development of this script requires a Chrome base browser for file system access by Tampermonkey.

Setup

  1. Allow Tampermonkey's access to local file URIs in Chrome, follow tampermonkey/faq
  2. install deps with npm i or npm ci.
  3. use npm run dev to start your development.
  4. open webpack-userscript-template/dist/ddb-dm-screen.dev.user.js in your Chrome browser and install it with your userscript manager.

this userscript's meta contains // @require file://path/to/dist/ddb-dm-screen.debug.user.js, which take src/index.ts as entry point.

every times you edit your metadata, you'll have to install it again, because Tampermonkey does not read it from dist every times.

  1. edit src/index.ts

livereload is enabled by default, use this chrome extension

dependencies

Add dependencies to your user script metadata's require section , and exclude them in config/webpack.config.base.cjs

Deployment

github actions will deploy production userscript to this projects gh-pages.

ddb-dm-screen's People

Contributors

valeryan avatar

Watchers

 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.