ResultProtocolPlugin

Result Protocol Plugin

This unofficial TaleSpire plugin adds a result protocol to the Talespire URL Relay allowing

rolls outside of Talespire to be rolled and posted in Talespire. Contains an option to show

spinning dice in Talespire or just posting the results. Comes with a Chrome Extension to

post DnD Beyond rolls to Talespire.

Warning: This version is not backwards compatible with the previous version. The request

URL will need to be modified slightly to make previous version URLs work with this version.

This plugin, like all others, is free but if you want to donate, use:

Change Log

2.0.1: Added partial support for foreign characters

2.0.0: Rewrote after BR update

1.0.1: Added Chrome Extension for Roll20. No plugin change.

1.0.0: Initial release

Install

Install using R2ModMan or similar.

The plugin contains a configuration which determines if you want to see the spinning dice

in Talespire or not. Please note that the spinning dice are not actual dice rolls, they

show up in the center of the view and spin ending on the posted results.

Unlike most other Chrome Extension solutions, this solution does not need Beyond Link via Chrome.

With Dnd Beyond Or Roll20

Install the DnD Beyond Roller or Roll20 Roller Chrome Extension

Usage

With DnD Beyond Or Roll20

• Start Talespire with the plugin installed.
• Open up a Dnd Beyond Or Roll20 Character sheet.
• Click on any element that causes a dice roll.

(Dice rolls are limited to anything in the format #D#+# which means the plugin does not

support multiple dice rolls at once such as #D#+#+#D#+#).

• After the result is generated in Dnd Beyond or Roll20, the same result will be optionally rolled

and then disaplayed in Talspire.

• If using Dnd Beyond, before making additional rolls make sure that the previous result is clear.

Failure to do so will mean that the result will not get posted in Talespire correctly.

Note: Do not use Roll With Advantage or Roll With Disadvantage options, they are not supported.

With Other Sources

This plugin, while enabled, adds a new result protocol to the Talespire URL Relay. This means

that any application or web page that can request a URL should be able to trigger this functionality.

The format for the protocol is:

talespire://result/name:formula/die1/die2/die3...

Where `formula is in the form #D#+# or #D#-#`. Note that the modifier is not optional so

if the roll does not have a modifier a value of 0 needs to be used. For example, `1D4+0 not 1D4`.

For example, for a greatsword damage roll might look like:

talespire://result/Greatsword(Damage):2D6+4/3,6

The number of entries after the formula, separated by commas, must match the formula. If there are

extra entries they will be ignored but insufficient entries will cause an error.

It is possibe to concatinate multiple formulas with either `+ or -`. For example:

talespire://result/Greatsword(Attack):1D20+5+1D4+0/15,3

It is also possible to do complex rolls involing more than one name roll. For example:

talespire://result/Greatsword(Attack):1D20+5+1D4+0/15,3/Greatsword(Damage):2D6+4/3,6

From Javascript (such as Chrome Extension or your own web page) you can use:

let url = "talespire://result/Attack:1D20+7/15"

window.open(url, "_blank");

The plugin has also added support for:

talespire://chat/message

and

talespire://system/message

The first send a chat message to all players. The second displays a system messge on all players.

The Three Views

Currently the plugin supports three views of the results, one of which is optional.

Dice View (optional)

The dice view, which is optional and can be turned off in the configuration, displays

dice, representing each die used in the roll, in the middle of the screen and rotates

them until they stop of the posted results. This is not a real roll, just a fake

representation of a roll if an element of suspense is desired. However, using this

option can make rolling take much longer especially w