Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 4.51 KB

README.md

File metadata and controls

79 lines (49 loc) · 4.51 KB
Raw

Beyond20: D&D Beyond & Roll20 Integration

Beyond20 is a chrome extension that integrates the Character Sheet from D&D Beyond into Roll20.

Install and Use

To install Beyond 20, simply head over to the Chrome Web Store and click "Add to Chrome" to get it installed.

To use it, simply open your character sheet in D&D Beyond in Chrome, and your Roll 20 game in another tab, then click on the "Beyond 20" or "Cast in Roll20" buttons that appear in the side panels.

Important: For the extension to work (for now), you need to have the game in Roll20 set up to use the "D&D 5e By Roll20" Character Sheet Template in the game settings.

To install the development version from git, read below, for more details on use, read below.

Build

This extension is written in 'python', more precisely in RapydScript and you will need RapydScript-NG installed to compile the .pyj source files into .js I don't know if it's totally compatible with rapydscript itself as I've used rapydscript-ng myself.

To install : sudo npm install rapydscript-ng -g

Install RapidScript-NG then type 'make' to compile the *.pyj into *.js

Note: The .js files are already included in the source repository... I don't usually include built files in a repo, but I guess .js files are still source code and that makes it easier for people to just try the extension without having to first install rapydscript.

Developer mode Installation

All you need is to load the extension into Chrome :

  1. Go to Chrome Extensions page (Menu->More Tools->Extensions)
  2. Enable Developer Mode (Top-right corner)
  3. Click on the 'Load Unpacked' button
  4. Select the Directory where you extracted this extension

Using it

Open Roll20 VTT in a tab of chrome then your character sheet in D&D Beyond in another tab, click on the item you want to roll, whether it's initiative, a skill, ability or saving throw check, a weapon or spell attack, a class/racial feat or trait or hit dice, death saving throw, etc...

When the D&D Beyond character sheet shows the information about the item you selected in its side panel, there should be a Beyond20 button or B20 icon that appear in the side panel to make the roll. It will automatically pick up on what was selected, and send the roll to all roll20 tabs open.

If a spell/item/action/feat description contains a dice formula (2d10 + 3 for example) or a modifier formula (+ 3 for example), that text will be underlined and a B20 dice icon will appear next to it. Click on the formula or the dice to make the roll in the Roll20 tab.

If you click on the Beyond20 button in the toolbar, it will enable/disable whispering of rolls (for now).

License

This extension is released under the GPL v3 license. Read the LICENSE file for more details.

The icon image is based on a public domain image from openclipart. I downloaded it from wikimedia and subsequently modified it.

The donation icon is a public domain contribution by Fission Strategy, US, downloaded from thenounproject

The options page was copied in part from the D&D Beyond Toolbox extension available here. The html and css files are licensed under the MIT license which is provided in the LICENSE.MIT file

FAQ

Q: Is this extension the best thing ever or what?

A: Yes. Yes, it is.

Q: All I see in Roll20 is an empty message

A: That's because the game in Roll20 is set up to use a character sheet template other than "D&D 5e By Roll20". Beyond20 uses display templates from that character sheet template to make the rolls, so if it's not the one used, it won't work. Support for other character sheet templates will be added in the future.

TODO

  • Add support for skills/items that have advantage/disadvantage notes (like disadvantage on stealth for heavy armor users)
  • Add ability to select which roll20 VTT page to send the rolls to
  • Add a way to show errors (such as "can't find a roll20 tab")
  • Add support for more character sheet templates in roll20.
  • Add Option to select which Roll20 game to roll into.
  • Add a dice roller so it can also be used to roll directly without roll20, if wanted.
  • Add support for special cases, like Toll the Dead, Toll the Dead, Elemental Bane, etc..
  • Add option to specify if initiative rolls send the result to the tracker or not
  • Test and fix bugs