Ruleset - Settings
Overview
When defining rulesets, there are a number of global settings that can be specified, using specific tags within the ruleset XML files.
Campaign Data
importinfo:: This tag defines whether modules from other rulesets can be opened within this ruleset.
characterdbroot:: This tag defines the database path that the ruleset has defined as the list of player characters. If not defined, the PC list database path defaults to "charsheet".
tokenroot:: This tag defines the file path where token files are included in the ruleset. If not defined, the ruleset token import file path defaults to "tokens/".
imageupdatefolder:: This tag defines the file path and database path within a campaign where image files should be checked for, and where database records should be added/removed within the database to match the existing image files. If not defined, then no folders will be checked.
Child Tag | Description |
|---|---|
<folder> | String defining the relative folder path within a campaign folder to check for images. Usually "images". |
<rootnode> | String defining the database path within the campaign database where image records should be created or deleted when images are added or removed from the images folder. Usually "image". |
<field> | String defining the name of the image value database node to create within the image record to store the name of the image file. Usually "image". |
<namefield> | String defining the name of the string value database node to create within the image record to store the image name, which will be set to the name of the file without the file extension. Usually "name". |
Examples
<importinfo>
<acceptfrom ruleset="d20" />
<acceptfrom ruleset="3.5E" />
</importinfo>
<characterdbroot>charsheet</characterdbroot>
<tokenroot source="tokens" />
<imageupdatefolder>
<folder>images</folder>
<rootnode>image</rootnode>
<field>image</field>
<namefield>name</namefield>
</imageupdatefolder>Desktop Interface
desktopframe:: This tag defines the frame asset to use for displaying the desktop background.
hotkeybar: This tag defines the way the hot key bar is displayed. The hot key bar is always displayed at the bottom of the tabletop.
Child Tag | Description |
|---|---|
<location> | The "offset" attribute is a number defining the margin between the hot key bar and the horizontal edges of the tabletop, while the "height" attribute is a number defining the height of the hot key bar. |
<frame> | String defining the frame asset to use for each hot key. |
<title> | This tag controls how the hot key title is displayed. (i.e. F1, C-F1, ...). |
<label> | This tag controls how the hot key body text is displayed. |
<iconmargins> | This tag controls how an icon or token associated with a hot key are displayed. The tag contains 4 numbers which define the internal padding margins to apply to the hot key before centering and scaling the icon or token graphic. |
tooltip: This tag defines the way any tooltips are displayed.
Child Tag | Description |
|---|---|
<frame> | This tag controls how standard tooltips are displayed when hovering over interface elements. |
<radial> | This tag controls how menu text within the right-click radial menus is displayed. |
| The "name" attribute defines the font asset to use when displaying any tooltip text. |
Examples
<desktopframe>desktop</desktopframe>
<hotkeybar>
<frame>hotkeybox</frame>
<location offset="0" height="33" />
<title frame="hotkeytitlebox" frameoffset="2,-2,7,5" margin="2,1" font="hotkey" />
<label margin="10,12" font="hotkey" />
<iconmargins>0,3,0,0</iconmargins>
</hotkeybar>
<tooltip>
<frame name="tooltipbox" margins="7,4,10,7" wrapwidth="300" />
<radial name="mini_name" margins="7,2,7,2" />
<font name="mini_name" />
</tooltip>Window and Control Interfaces
textsettings: This tag defines the way that string and formatted text controls are shown by default. The defaults can be overriden within each control definition.
Child Tag | Description |
|---|---|
<selectioncolor> | String defining the hexadecimal ARGB color used for text selection boxes. |
| The "simple" attribute defines the font asset to use for string controls. |
<icon> | The "link" attribute defines the icon asset to use when displaying an unshared link within a formatted text control. |
imagesettings: This tag defines the way that image controls are shown by default. The defaults can be overriden within each control definition.
Child Tag | Description |
|---|---|
<shortcut> | The "icon" attribute defines the icon asset to use when displaying an unshared link within an image control. |
<pointer> | The "defaultconeangle" attribute defines the angle applied to any cone pointers drawn on an image control. Valid values are: 180, 120, 90, 60, 45, 30 and 5E (cone width = length, ~53.2 degrees) |
distance: This tag defines the way that distances are displayed within image controls.
Child Tag | Description |
|---|---|
<base> | Number defining the base distance for a single grid square. (i.e. 1 square, 5 feet, etc.) The default base distance is 1. |
<diagmult> | Number defining the multiplier to apply to diagonal square distances when counting distances. On square grids, distances are always counted by squares, then multiplied by base units. The default multiplier is 1. |
<suffix> | String defining the suffix to display after a distance measurement, such as a apostrophe or quote character. |
| String defining the font asset to use when displaying distances in the image control. |
<pointer> | Allows multiple. The "type" attribute specifies the image pointer type to apply the distance multiplier to, and the "mult" attribute specifies the multiplier to apply to distances for that pointer type. By default, multipliers are 1 for all pointer types, except squares for which the multiplier is 2 (i.e. side distance vs. radius) |
diebox: This tag defines the way that dice results are displayed in the chat window control.
Child Tag | Description |
|---|---|
<frame> | String defining the frame asset to use for dice results. |
<margin> | The "value" attribute is a number defining the margin between the text and the dice results, while the "numbertailmargin" attribute is a number defining the margin after the dice results. |
<secreticon> | String defining the icon asset to display with dice results with the secret flag set. |
| The "modifier" attribute defines the font asset to use when displaying a dice result modifier. |
pollbox: This tag defines the way that poll results are displayed in the chat window control.
Child Tag | Description |
|---|---|
<frame> | String defining the frame asset to use for dice results. |
<margin> | The "value" attribute is a number defining the margin between the text and the poll results, while the "numbertailmargin" attribute is a number defining the margin after the poll results. |
<icon> | The "empty" attribute defines the icon asset to use when displaying a missing vote. |
Examples
<textsettings>
<selectioncolor>BCD2E9</selectioncolor>
<icon link="button_link" linkshare="button_link_share" emptylink="button_link_empty" chat="button_speak" />
<font simple="sheettext" normal="reference-r" bold="reference-b" italic="reference-i" bolditalic="reference-bi" title="reference-h" />
</textsettings>
<imagesettings>
<shortcut icon="image_pin" iconpublic="image_pin_public" hotspot="2,21" />
</imagesettings>
<distance>
<base>5</base>
<diagmult>1.5</diagmult>
<suffix>'</suffix>
</distance>
<diebox>
<frame name="diebox" />
<margin value="16" numbertailmargin="10" />
<secreticon name="gmdie" />
</diebox>
<pollbox>
<frame name="diebox" />
<margin value="21" numbertailmargin="10" />
<icons empty="poll_empty" positive="poll_check" negative="poll_negative" />
</pollbox>Deprecated
The "categoryselectionsettings" tag is being deprecated, but the information can still be found in the ruleset API reference.