Custom Dice Pack Plugin

This unofficial TaleSpire plugin allows truely custom dice to be brought into Talespire. Includes both cosmetic custom dice and true custom dice allowing dice which don't roll numbers but symbols/keywords instead.

Video (Use): https://youtu.be/qXOtKx7vPcU Video (Config): https://youtu.be/G-PbrLz0wpA

Change Log

3.0.0: Complete rewrite
2.0.2: Bug fix for multiple compatibility issues with proximity rolling
2.0.1: Bug fix preventing dice spawn in some cases
2.0.1: Added dice icons for demo dice
2.0.0: Added GUI for spawning custom dice in session
1.3.1: Added option to always use custom format for result for message and chat
1.3.0: Custom dice result message when a true custom die is rolled 
1.3.0: Identification of custom dice while in the tray (as opposed to a weird modifier)
1.2.0: Added support for custom numeric keywords (dice with values other than the side value) 
1.1.0: Added support for multiple keywords for true custom dice
1.0.1: Corrected demo save dice file. No plugin change.
1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

Usage

GUI Menu

You can pull custom dice out of the custom dice tray.

1. Open the custom dice tray (default F11)
2. Navigate though the collections to choose the desire dice to spawn
3. Click or LSHIFT-click to spawn the custom dice

Click = Spawn a single instance of the clicked die LShift + Click = Open a dialog to ask how many instances of the clicked die to spawn

Talespire Protocol

Appending a hash tag followed by the customization name to the talespire dice protocol can be used to spawn customized dice. For example:

talespire://dice//RPS:3D6#rps-d6

Would spawn 3 dice each with 6 sides and customized using the rps-d6 entry in the file named CustomDicePacks.json which contains all configured custom dice.

Creating Custom Dice

In order to use custom dice, we first need to create them. This is not a difficult process thanks to the files provdied with this plugin. To create custom dice, we edit the CustomDicePacks.json file found in CustomData/CustomDicePacks folder of the plugin install folder. The file can be edited with any text editor.

See the follow video for configuring custom dice: https://youtu.be/G-PbrLz0wpA

CustomDicePacks.json format:

{
	"dd-d6":
	{
		"dicePack":"basedice",
		"diceBase":"d6",
		"diceCollection":"DD",
		"diceTexture":"D6_DD.png",
		"sides":
		{
			"1":"Attack",
			"2":"Shield",
			"3":"Magic",
			"4":"Magic,Magic",
			"5":"Attack,Shield",
			"6":"Shield,Magic"
		},
		"images":
		{
			"collection": "CollectionDragonDice.png",
			"icon": "Icon_DD_D6.png",
			"Attack": "D6_DD_1.png",
			"Shield": "D6_DD_2.png",
			"Magic": "D6_DD_3.png",
			"Magic,Magic": "D6_DD_4.png",
			"Attack,Shield": "D6_DD_5.png",
			"Shield,Magic": "D6_DD_6.png"
		}
	}
}

Limitations

When using the talespire protocol only the first roll is recognized by the plugin. For example, talspire://dice/Attack:1D20+5/Damage:1D8+4 is recognized by the talespire protocol but not by the plugin. Only the first part of the roll would be recognized and summarized. To roll multiple rolls at once, the Proximity Roller Plugin can be used.