LordAshes-ResultProtocolPlugin icon

ResultProtocolPlugin

Adds support for result protocol allowing rolls outside of Talespire to be rolled and posted in Talespire.

Last updated 2 weeks ago
Total downloads 54
Total rating 0 
Categories Tweaks Networked Tools Integration Assets
Dependency string LordAshes-ResultProtocolPlugin-1.0.1
Dependants 0 other mods depend on this mod

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-AssetDataPlugin-2.0.2 icon
LordAshes-AssetDataPlugin

Dependency plugin for subscription/notification based data storage and message exchange.

Preferred version: 2.0.2
LordAshes-FileAccessPlugin-1.4.1 icon
LordAshes-FileAccessPlugin

Provides standardized methods for accessing both local file and url resources. Automatically handles searching local folders for assets.

Preferred version: 1.4.1

README

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.

This plugin, like all others, is free but if you want to donate, use: http://LordAshes.ca/TalespireDonate/Donate.php

Change Log

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

1. Start Talespire with the plugin installed.
2. Open up a Dnd Beyond Or Roll20 Character sheet.
3. 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#+#).
4. After the result is generated in Dnd Beyond or Roll20, the same result will be optionally rolled
   and then disaplayed in Talspire.
5. 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/...

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 slashes, must match the formula. If there are extra entries they will be ignored but insufficient entries will cause an error.

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");

Customization

The plugin has a configuration for the Asset Bundle Name for the dice. Normally it should not be necessary to change this. It uses the same asset bundle as Custom Dice Pack plugin but the base dice asset bundle is provided again so that you don't need the Custom Dice Pack plugin.

In addition, there is a texture suffix configuration. The plugin comes with a Black And White (BW) texture theme but the dice textures can be customized by changing the suffix configruation. The texture name is determined for each die by suffixing the configured text to the die type and placing a underscore in between. For example, if the Suffix is Lava then the expected textures would be d4_Lava.png, "d6_Lava.png, ..., d20_Lava.png``. The file type (and thus the extension) does not need to be PNG but PNG is commonly used. die uses a texture that

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2023-3-17 1.0.1 43 Version 1.0.1 Install
2023-3-16 1.0.0 11 Version 1.0.0 Install