LordAshes-RuleSet5EPlugin icon

RuleSet5EPlugin

D&D5E Rule Set Scripts.

Last updated 3 weeks ago
Total downloads 346
Total rating 1 
Categories Tweaks Tools Integration Ruleset
Dependency string LordAshes-RuleSet5EPlugin-1.6.0
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
HolloFox_TS-RadialUIPlugin-1.6.1 icon
HolloFox_TS-RadialUIPlugin

This is a developer tool based package used to help devs easily configure UI Radial Menus.

Preferred version: 1.6.1
LordAshes-FileAccessPlugin-1.3.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.3.1

README

Rule Set 5E Plugin

This unofficial TaleSpire plugin for implementing some D&D 5E rule automation. Currently provides:

  1. Four different modes of rolling: Manual on board, manual on the side, automated dice with dice cam, randomly generated dice values. Rollying style can be set on a player by player basis using the R2ModMan configuration for this plugin.

  2. Three levels of player information in Chat using using unique messages. GM gets full information, attacker and victim get detailed infromation about their parts of the exchange and other players get minimal information.

  3. Automated attack macros which roll attacks, compare them to target AC, roll damage, apply critial hits, immunities and resistances, and adjusts the target HP by the resulting amount.

  4. Automated saves and skill roll.

  5. Roll with Advantage or Disadvantage using a toggle in the menu bar.

  6. Roll with Attack Bonus (e.g. Bless), Damage Bonus (e.g. Hex) or Skill Bonus (e.g. Guidance)

  7. Reaction pause with options to continue, cancel, forced hit and forced miss.

Video Demo: https://youtu.be/s-twNPYPtsY

Coming Soon: Saves, skills checks, group skill checks, opposed skill checks, group opposed skill checks.

Change Log

1.6.0: Reaction stop toggle (stops after attack roll when checked) 1.6.0: Added reaction option for Continue, Cancel, Forced Hit, Forced Miss 1.5.0: Added Attack Bonus toggle (e.g. Bless) and amount. Remembered for character sheet character during session. 1.5.0: Added Damage Bonus toggle (e.g. Hex) and amount. Remembered for character sheet character during session. 1.5.0: Added Skill Bonus toggle (e.g. Guidance) and amount. Remembered for character sheet character during session. 1.5.0: Added support for link roll on skills and blank roll support for skill roll messages. 1.5.0: Added fix to make added tool bar options disappear when in Cinematic Mode. 1.4.1: Added Beyond Link Server LinkData files for "teaching" Beyonf Link Server how to make dnd5e files for the collected data. These files are only used if the user is using the Beyond Link via Chrome plugin to gether character sheet data from external sources. The actualy plugin DLL has not changed (remains at version 1.4.0). 1.4.0: Added Reach and Range support including beyond range cancel and long range disadvantage. 1.4.0: Updated range attach from melee check to check all minis on the board. 1.4.0: Roll can now have a non dice roll calculation or be empty. If empty name and type will be displayed as message. 1.3.0: Added saves and skills. Updated sample character. Note: Previous versions will fail because previous versions used empty public rolls and provate sub-rolls to implemented Private mode. This plugin uses the type to determine the level of information shared with others.
1.2.0: Added support for rolls with advantage and disadvantage 1.1.0: Added R2ModMan setting for determining attack icons based on "type" or "name" 1.1.0: Added support for different attack animations. By default animation is based on roll type but the roll can included a property called info which can be the name of the animation to be used. 1.1.0: Added R2ModMan setting for miss animatation 1.1.0: Added R2ModMan setting for death animatation. If "remove", mini will be removed after death. 1.1.0: Added Melee attack distance check. Prevents melee attack if not in melee range. 1.1.0: Added Range attack distance check. Warns if in melee performing range attack. Disadvantage rolls not implemented yet. 1.1.0: Fixed display message duration bug. 1.0.1: Added dice color and highlight (to support future group rolls) 1.0.1: Buf fix for rolling system which prevented using anything but AutomaticDice 1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

Set desired rolling mode, dice side area (if applicable), and speed using R2ModMan configuration for this plugin.

Create a Dnd5e file for each character (or foe type) that is to use this plugin. See the included Jon.Dnd5e file as an example. While the format does support skills, they are currently not used.

Usage

Attacks

  1. Use the Dis, Normal and Adv selector in the top right of the screen to select the type of roll.
  2. Select the mini that is attacking.
  3. Right click the mini that is to be attacked.
  4. Select the Scripted Attacks menu and then the desired attack from the sub-menu.
  5. The attack will be processed and the results displayed in speech bubbles with additional details in the chat.

Saves And Skills

  1. Use the Dis, Normal and Adv selector in the top right of the screen to select the type of roll.
  2. Select the mini that is instigating the save or skill check.
  3. Right click the mini to open the radial menu. Select either Saves or Skills.
  4. Select the desired save or skill from the sub-selection.

Reactions

  1. Check the toggle beside the Reaction (hand) icon in the title bar
  2. Activate an attack sequence (see above)
  3. After the attack roll (and attack bonus roll if applicable) the sequence will stop with an indication of the roll total (but not any modifiers)
  4. A number of reaction button will be displayed to continue or abort the sequence
  5. If the victim uses a spell like Shield, the AC of the victim can be modified at this point prior to the hit/miss determination. Currently this is done (and undone) manually.
  6. Selecting the Continue button will continue on with the sequence.
  7. Selecting the Cancel button will cancel the sequence*.
  8. Selecting the Hit button will jump to the hit scenario regardless of the attack total and victom AC*.
  9. Selecting the Miss button will jump to the miss scenario regardless of the attack total and victom AC*.

** Note: Choosing these options generates a indication in the chat that the option was used (to avoid cheating).

File Format

	{
		"NPC": false,
		"reach": 5,
		"attacks":
		[
			{
				"name": "Shortsword",
				"type": "Melee",
				"roll": "1D20+5",
				"link":
				{
					"name": "Weapon",
					"type": "Piercing",
					"roll": "1D6+4",
				}
			},
			{
				"name": "Shortsword & Sneak",
				"type": "Melee",
				"roll": "1D20+5",
				"link":
				{
					"name": "Weapon",
					"type": "Slashing",
					"roll": "1D6+4",
					"link":
					{
						"name": "Sneak Attack",
						"type": "Slashing",
						"roll": "2D6"
					}
				}
			},
			{
				"name": "Longbow",
				"type": "Range",
				"roll": "1D20+3",
				"ranged": "120/360",
				"link":
				{
					"name": "Weapon",
					"type": "Piercing",
					"roll": "1D8+1"
				}
			},			
			{
				"name": "Longbow & Sneak",
				"type": "Range",
				"roll": "1D20+3",
				"ranged": "120/360",
				"link":
				{
					"name": "Weapon",
					"type": "Piercing",
					"roll": "1D8+1",
					"link":
					{
						"name": "Sneak Attack",
						"type": "Piercing",
						"roll": "2D6"
					}
				}
			},			
		],
		"saves":
		[
			{
				"name": "STR",
				"type": "Private",
				"roll": "1D20+3"
			},
			{
				"name": "DEX",
				"type": "Private",
				"roll": "1D20+2"
			},
			{
				"name": "CON",
				"type": "Private",
				"roll": "1D20+5"
			},
			{
				"name": "INT",
				"type": "Private",
				"roll": "1D20+2"
			},
			{
				"name": "WIS",
				"type": "Private",
				"roll": "1D20+3"
			},
			{
				"name": "CHA",
				"type": "Private",
				"roll": "1D20+1"
			}
		],
		"skills":
		[
			{
				"name": "Athletics",
				"type": "Public",
				"roll": "1D20+3",
			},
			{
				"name": "Insight",
				"type": "Private",
				"roll": "1D20+2",
			},
			{
				"name": "Stealth",
				"type": "Secret",
				"roll": "1D20+5",
			},
			{
				"name": "Perception",
				"type": "Private,GM",
				"roll": "1D20+2",
			},
			{
				"name": "Survival",
				"type": "Secret,GM",
				"roll": "1D20+3",
			}
		],
		"immunity":
		[
			"Force"
		],
		"resistance":
		[
			"Piercing"
		]
	}```

"NPC" indicates a mini is considered an ally (npc=false) or foe (npc=true). It should be noted that a better name for
      this property would have been foe but for backwards compatibility the name will not be changed. If an NPC is not
	  hostile, its NPC value should be false (not true). This will prevent it from giving allies disadvantage in combat
	  if it is adjactent and the ally is using a ranged attack.

"reach" indicated the number of feet that the character can make melee attacks and threaten locations from.

"attacks" is an array of Roll objects which define possible attacks the user can make.

"name" is a Roll object that determines the name of the attack whch will be displayed in the radial menu.
"type" is a Roll obejct that determines the type of attack typically unarmed, melee, range and magic.
       For saves and skills it determine how the results are shared using the following options:
	     Public - Everyone sees the speech bubble and chat message with results. Owner and GM sees breakdown.
		 Private - Everyone sees the speech bubble and chat message of the skill used but not the result.
		           Onwer and GM get results with breakdown. 
		 Secret - No speech bubble or chat message to everyone. Owner and GM sees breakdown.
		 Private, GM - Everyone sees the speech bubble and chat message of the skill used but not the result.
		               Only GM gets results with breakdown.
		 Secret, GM - No speech bubble or chat message to everyone. Only GM sees results with breakdown.
"roll" is a Roll object that determines the roll that is made when this attack is selected. Uses the #D#+# or #D#-# format.
       It should be noted that the number before D is not optional. For example, 1D20 cannot be abbreviated with D20.
"range" indicates the end of short range and maximum distance separated by a slash. Used for range attack. For melee
        attacks this value is ignored and the reach value is used instead.
"info" is a optional string parameter that determines extra information for the roll. For attacks, this holds the name of
       the animation that is to be played. If not specified for attack, the attack type is used to determine the animation.
"link" is a Roll object links to the Roll damage object. This follows the same rules as a Roll object except the type
       determines the damage type and the roll rolls the weapon damage. The link in a Roll damage object can be used
	   to add additional damage (of the same or different type). This is typically used for things like a sword of flame
	   (where the weapon damage type and the bonus damage type are different) or to add extra damage like sneak damage.

"skills" is a Roll object that determines the skill to be rolled and how the results are displayed. The name proeprty
         indicates the name of the skill and is used in the output results. Type is one of "public", "private" (or "owner")
		 or "secret" (or "GM"). Public rolls are displayed as speech bubbles and chat messages for everyone to see.
		 Private rolls appear on a message board that is displayed only for the owner of the mini and the GM. The contents
		 is displayed for a configurable amount of time on the message board but can be dismissed by clicking on the message
		 board. Secret rolls also show up on the message board but only for the GM. The roll property is used to determines
		 the dice and modifier used to make the skill check. If the roll is empty, the roll name will be displayed as a
		 comment. The link property can be used to link to additions rolls which are automatically processed. The link
		 property for skills is typically used to display a comment for the public but display the roll results for the
		 owner and/or GM.

"immunity" is a list of strings representing damage types from which the user takes no damage. When the damage type
           of an attack against the user matches an immunity (exactly) the damage is reduced to 0.
		   
"resistance" os a list of strings representing damage types from which the user takes 1/2 damage. When the damage type
           of an attack against the user matches a resistance (exactly) the damage is reduced to 1/2.
				
Note: Immunity and resistance is only applied to the portion of damage that matches the damage type. If an attack does
      multiple types of damage, the plugin will correctly apply immunity and resistance to only the mathcing damage type.
	  	  
## Limitations

1. While the plugin does expose the characters dictionary (so other plugins can modify it) this plugin reads the contents
   of the Dnd5E files at start up and does not provide any interactive methods to change the settings. For example, a new
   resistance gained through a spell would not be reflected.    
2. The attack sequence does not provide an option for reactions to be used to modify the attack sequence. For example,
   if the user casts a Shield spell to temporarily increase AC or uses a effects of a Warding Flare.
3. Currently does not support damage reduction such as that given by the Heavy Armor Master feat.
4. Advantage and disadvantage rolls are more likely to cause dice to roll out of dice cam view.
5. Scale of 5' is assumed.
6. Saves currently use the Skill Bonus toggle and amount as opposed to the Attack Bonus toggle and amount.

### Work-Around: Changing Specifications

Sometimes a character will frequently change its statistics which affect attacks. For example, a Barbarian gains resistance
to physical attacks when raging but not when he/she is not raging. Since the plugin does not provide an interactive way to
change a charcters specifications (inclduing resistance) while running it may seem that such a character design is not
supported. However, there are a couple work arounds to get such characters working with this plugin.

#### Damage Changes

Changes to damage such as a rogue attack with and without sneak or barbarian adding damage from rage or not can be solved
by making two (or more) attack entries and using the appropriate one. This fills up the radial menu quickly if you have
many combinations but allows such a character to be used with this plugin.

#### Immunity And Resistance Changes

To create a character that can change immunities and/or resistances, such as a barbarian, create two copies of the same
character with slightly different names. For example, "Garth" and "Garth (Rage)". Set the appropriated immunities and
resistances for version. In game, one can switch between the different modes by renaming the character. Since the plugin
looks up the character sheet associated with the mini name, it is possible to access multiple version of a character just
by renaming the character.

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  
2021-11-2 1.6.0 155 Version 1.6.0 Install
2021-10-31 1.5.0 40 Version 1.5.0 Install
2021-10-29 1.4.1 44 Version 1.4.1 Install
2021-10-25 1.4.0 47 Version 1.4.0 Install
2021-10-24 1.3.0 11 Version 1.3.0 Install
2021-10-24 1.2.0 10 Version 1.2.0 Install
2021-10-24 1.1.0 13 Version 1.1.0 Install
2021-10-24 1.0.1 16 Version 1.0.1 Install
2021-10-24 1.0.0 10 Version 1.0.0 Install