RulesetBuilderPlugin

Ruleset Builder Plugin

The Ruleset Builder Plugin is an unofficial Talespire modding plugin that allows the user to use a

modular, build block, solution to creating and using ruleset for different systems. As opposed to

hard coding the rulsesets in the plugin, the plugin provides an bunch of action blocks which can be

string together by the user to create rulesets for different systems and then the benefits can be

be used by all players in the session.

Change Log

1.4.0: Rewrite engine to not use co-routines for faster processing

1.4.0: Added numerous action blocks

1.3.0: Added rolling with adv/dis and GUI toolbar to select the current roll mode

1.2.0: Added CritDamage library of action blocks

1.2.0: Added ChatDiceResult to Notification action blocks library

1.2.0: Added Action Block Developer notes

1.1.0: Revised Melee Attack to use ChatGeneric to showcase how the header can be customized

1.1.0: Added ChatGeneric action block which gives direct control over the chat header

1.1.0: Change GetMiniSelection to use event based solution which does not select the clicked mini

1.0.0: Initial release

Installing With R2ModMan

Install using R2ModMan or similar modding manager. The plugin packages comes with a bunch of

action blocks (described below) but additional packs can be downloaded, as they are created, to

add additional action blocks to build with.

Currently the Rulset Builder does not come with any sample Ruleset. For a demonstration of the

capabilities of this plugin download the Ruleset Builder 5E Ruleset pack.

Usage

There are 3 different users of this plugin: 1) End uses (GM and players), 2) Ruleset builders,

and 3) Action block builders.

Below is a brief description of each of the types of users.

End Users (GM/Players)

The Rulset Builder Plugin is versitile so there may be exceptions to this but generally there are

two ways to interact with Rulsets being used. The most common way to start a ruleset sequence is

to select a mini and then open the radial menu to see what sequences have been added. Typically

Rulesets are grouped in groups so one will selected a group like "Melee Attack" and then an actual

selection such as "Axe".

During ruleset sequences, some rulesets may require GUI interaction. These GUI elements may be always

present or may only be present when needed. This depends on how the ruleset was built and not on

this plugin.

Rulset Builders

The plugin comes with no ruleset sequences but the Ruleset Builder 5E Ruleset pack can be downloaed

which shows the file formats needed to make action block seqeunces and action seqeunces. However,

this plugin is designed to allow users to fairly easily make their own rulesets - either modifictions

to the provided 5E ruleset or rulesets for different game systems. The intention of this plugin is to

provide the building blocks for users to create their own rulsets without needing to know how to

program. Some very basic programming concepts may be useful but users will not be writing any code.

Initially this process may seem overwhelming with a lot of information available but once you study

the examples and/or write a few rules of your own, you will (hopefully) see that it is not so

difficult.

There are 4 types of files used by Ruleset Builder Plugin but only 2 are of these files types

are configured by the user:

Action Blocks

There are the building blocks from which ruleset will be built. These blocks are what dictates

what each rule sequence does when trying to execute a rule sequence. The plugin comes with a bunch

of action blocks but additional action blocks can be added. Unless you are a developer, you wont

be making these blocks but you will be using them.

Action Sequences

Action sequences are a list of blocks which together form a rule. For example, the plugin comes

with a sample Melee Attack and Skill Check action sequence. To create a new rule for your ruleset,

you would create a new Action Sequence file. Action Sequence files are JSON files with the following

fo