Page Updated:   2022-03-29

Main Page: API:Script Index

AttackMaster API provides functions to manage weapons, armour & shields, including taking weapons in hand and using them to attack, for the AD&D 2E sheet. It's a part of the RPGMaster suite of APIs.

It uses standard AD&D 2e rules to the full extent, taking into account: ranged weapon ammo management with ranges varying appropriately and range penalties/bonuses applied; Strength & Dexterity bonuses where appropriate; any magic bonuses to attacks that is in effect (if used with RoundMaster API effects); penalties & bonuses for non-proficiency, proficiency, specialisation & mastery; penalties for non-Rangers attacking with two weapons; use of 1-handed, 2-handed or many-handed weapons and restrictions on the number of weapons & shields that can be held at the same time; plus many other features. This API works best with the MagicMaster API and its databases which hold the data for automatic definition of weapons and armour. However, some attack commands will generally work with manual entry of weapons onto the character sheet. The CommandMaster API can be used by the GM to easily manage weapon proficiencies.

Specification for weapons, armour & shields are implemented as ability macros in specific database character sheets. This API comes with a wide selection of weapon and armour macros, held in two databases that are created and updated automatically when the API is run. If the MagicMaster API is also loaded, it provides many more specifications for standard and magic items that are beneficial to melee actions and armour class. The GM can add to the provided items in the databases using standard Roll20 Character Sheet editing, following the instructions provided in section 8.

Contents 1 Forum 2 How AttackMaster Works 2.1 Specifying a token 2.2 Who can make AttackMaster API command calls 2.3 Weapons that can be used 2.4 Allocating weapons to a Character 2.5 Selecting weapons to attack with 2.6 Making attacks 2.7 Ammunition 2.8 Ranged weapon and ammunition ranges 2.9 Dancing weapons 2.10 Armour Class management 2.11 Saves 3 How To Use AttackMaster 3.1 Installation and Configuration 3.2 Script Use 3.3 Syntax 4 Command Index 4.1 Menus 4.2 Attacking commands 4.3 Weapon Management 4.4 Ammunition Management 4.5 Armour Class and Saving Throws 4.6 Other Commands 5 Command Details 5.1 Menus 5.1.1 Display a menu to do actions relating to attacks 5.1.2 Display a menu of other actions 5.2 Attacking Commands 5.2.1 Attack an opponent with a weapon 5.2.2 Use two weapons to attack 5.3 Weapon Management 5.3.1 Change weapons currently in hand 5.3.2 Manage a dancing weapon 5.3.3 Manage weapon statistics 5.3.4 Adding & removing weapons and ammunition 5.4 Ammunition Management 5.4.1 Ammunition recovery 5.4.2 Ammunition quantity amendment 5.5 Armour Class and Saving Throws 5.5.1 Edit Armour 5.5.2 Review Armour Class 5.5.3 Saving Throws 5.6 Other commands 5.6.1 Display help on these commands 5.6.2 Configure API behavior 5.6.3 Check database completeness & integrity 5.6.4 Handshake with other APIs 5.6.5 Switch on or off Debug mode 6 Configuring the Token and Character Sheet for use with the API 6.1 Token configuration 6.2 Use with various game system character sheets 6.3 Matching the API to a type of Character Sheet 6.4 Character Attributes, Races, Classes and Levels 6.5 Spells and Powers 6.6 Magic Items and Equipment 6.7 Weapons and Ammo 7 Character Sheet data fields 8 Weapon, Ammo & Armour Databases 8.1 General Database information 8.2 Weapon & Ammunition Databases 8.2.1 Longsword 8.2.2 Bastardsword+1 8.2.3 Longbow 8.2.4 Flight-Arrow+2 (Ammunition Database) 8.2.5 Self-ammoed weapons e.g. Warhammer 8.2.6 Artifact sword 8.3 Armour Databases 8.3.1 Chain Mail 8.3.2 Shield+2 8.3.3 Armour-of-Vulnerability+-3 8.4 Specs & Data field values 8.4.1 Specs sections 8.4.1.1 Weapon Types 8.4.1.2 Weapon Item-Classes 8.4.1.3 Weapon Handedness 8.4.1.4 Weapon Group-Types 8.4.1.5 Armour Types 8.4.1.6 Armour Item-Classes 8.4.1.7 Armour Handedness 8.4.1.8 Armour Group-Types 8.4.2 Data Sections 8.4.3 Character Sheet data fields 9 Changelog

Forum

RPGMaster Forum

How AttackMaster Works

Specifying a token

Most of the AttackMaster API commands need to know the token_id of the token that represents the character, NPC or creature that is to be acted upon. This ID can be specified in two possible ways:

1. explicitly in the command call using either a literal Roll20 token ID or using @{selected|token_id} or @{target|token_id} in the command string to read the token_id of a selected token on the map window,
   or
2. by having a token selected on the map window, not specifying the token_id in the command call, and allowing the API to discover the selected token_id.

In either case, if more than one token is selected at the time of the call then using either @{selected|token_id} to specify the token in the command call, or allowing the command to find a selected token, is likely (but not guaranteed) to take the first token that was selected. To avoid ambiguity, it is generally recommended to make command calls with only one token selected on the map window.

Who can make AttackMaster API command calls

The majority of API command calls can be made by both the GM and all Players. The typical means for command calls to be made is via Character Sheet Token Action Buttons (standard Roll20 functionality - see Roll20 Help Centre for information) which trigger Ability macros on the Character Sheet which simply make the API command call. The Character Sheets can be controlled by the GM or Players. The API knows if it is a GM or a Player that has triggered the call, and reacts accordingly.

Weapons that can be used

Any weapon in the Weapons tables on the Character Sheet can be used for attacks. However, the very best approach is to use the functions in this and other RPGMaster APIs (especially MagicMaster) to manage weapon choice. Weapon definitions are held in weapon databases. All standard weapons from the AD&D 2e Players Handbook are included, as well as many magic variations.

Allocating weapons to a Character

Weapons and ammunition are held in the Items table, which holds data on all items that the Character / NPC / creature has on their person- see section 7 regarding where the Item table is on the Character Sheet and the data that is held in it. The added weapon must have a listing in the Weapons database.

The easiest way to enter the correct data into the Items table is to use the !attk --menu menu and select to edit weapons and armour, or use the !attk --edit-weapons command to bring up the edit weapons menu, or use the MagicMaster API, which supports finding and looting weapons e.g. from a chest or a dead body, or just the DM or Player choosing weapons from a menu. If a Ranged Weapon that uses ammunition is added, a quantity of the respective ammunition (or multiple types of ammunition) must also be added to the Items table.

Multiple weapons of many different types can be added, including those with magical properties. The system will take all the weapon statistics into account using the information in the associated databases.

Selecting weapons to attack with

Each Character / NPC / creature has a defined number of hands (which can be different from 2), and AttackMaster provides a menu to take any weapon(s) that are in the Items table in hand. Doing so enters all the correct information from the weapons database into the Weapons, Damage and Ranged Weapons tables, and the correct ammunition type(s) held in the Items table into the Ammo table.

Making attacks

Several different attack approaches are supported by the API.

Roll20 rolls:	the system makes an attack dice roll and modifies it using the data on the Character Sheet, then displays the results to the Player. Hovering the mouse over the displayed values of AC (armour class) hit and the Adjustments will display information explaining the values. Buttons are displayed to make Damage rolls which can be used if the attack was deemed successful (the target's AC was the same or worse than the AC hit).
Player rolls:	the system prompts for the Player to roll a dice and enter the result, and then modifies the roll entered using the data on the Character Sheet and displays the result to the Player. As above, hovering the mouse over the displayed results will explain how the amounts were calculated. Buttons to make Damage rolls are also displayed, which will also prompt the user to make a dice roll (showing the dice that should be rolled).
Targeted attack:	DM only option. The DM can, if they choose, make a targeted attack, which prompts the DM to select the target. The system then rolls the Attack dice and the Damage dice and displays all possible results, and also displays the AC and HP of the target for quick analysis.

Ammunition

The system handles both Ranged weapons that take ammunition, such as bows and slings, and also “self-ammoed” Ranged weapons like daggers, that can be thrown at a target. The quantity of ammunition or self-ammoed weapons is managed by the system: as they are used in attacks, the quantity in the Characters Item table decreases. A menu can be called to recover ammunition, in agreement with the DM - the same menu can be used to add or remove quantities of ammunition for other reasons (such as being purchased). Some types of ammo always breaks and can't be recovered (for example glass arrows) - this is charged ammo.

Ranged weapon and ammunition ranges

Each type of ammunition has a range with the weapon used to fire it. These ranges can be different for different types of weapon - thus a longbow can fire an flight arrow further than a short bow, and a sheaf arrow has different ranges than the flight arrow with each. The ranges that can be achieved by the weapon and ammunition combination are displayed when they are used in an attack, and the Player is asked to select which range to use, which then applies the correct range modifier to the attack roll.

Dancing weapons

The system can support any weapon becoming a dancing weapon, with qualities that can be the same as or different from a Sword of Dancing. In the system a dancing weapon does not have to be held in hand in order for it to be available for attacks and, if using the InitiativeMaster API, the weapon is also automatically added to the Turn Order Tracker for its attacks to be performed in battle sequence. All of this can be achieved automatically if used with the RoundMaster API, with durations of 'warm up' and 'dancing' dealt with, as well as magical properties changing as the rounds progress - that function requires some editing of the Effects database to adapt for a particular weapon - see section 8 of the RoundMaster API documentation for details.

Armour Class management

The system continually checks the Armour Class of each Character / NPC / creature by examining the information on the Character Sheet and the items in the Item table. Armour and Shields can be placed in the Items table which will be discovered, and the specifications from the Armour database used to calculate the appropriate AC under various conditions and display them to the Player. The process the system made to achieve the calculated AC will be shown.

Many magic items have AC qualities, such as Bracers of Defence and Rings of Protection, and if the MagicMaster API is used these are also taken into account - invalid combinations will also be prevented, such as Rings of Protection with magical armour. If allocated to a Token Circle, the calculated AC is compared to the displayed Token AC and any difference highlighted - this may be due to magical effects currently in place, for instance - the highlight allows the Player to review why this might be.

Saves

The corollary to attacks is saves. The system provides a menu to access, review, update and make saving throws and the appropriate modifiers.

The initial menu presented shows the saving throw table from the Character Sheet (always the one from the Character tab rather than the Monster Tab - monster saving throws should be copied to both). Each type of save has a button to make the saving throw: the system will perform the roll and display the result with an indication of success or failure. The menu also shows buttons to add a situational adjustment (as per the AD&D 2e PHB) and to modify the saving throw table.

The easiest way to set the correct saving throws for each type of save, based on class, level & race, is to use the CommandMaster API Character Sheet setup commands.

How To Use AttackMaster

Installation and Configuration

Copy the script's code, available from the menu on the right and stored at Roll20's API GitHub Repository. Paste the code into a new script in your campaign's API Script Editor. Save the new script and it will be available inside your campaign. It will install several new Character Sheets & Handouts: The handout AttackMaster Help' provides a full manual of how to use AttackMaster. The handout RPGMaster CharSheet Setup provides information on setting up a character sheet for use with AttackMaster. The handout Weapon & Armour Database Help provides information on the databases that come with the API, and how to add to and change them.

Script Use

After installing the script, refer the the handout AttackMaster Help for full information on use. Below is a copy of the contents of that handout.

Syntax

The AttackMaster API is called using !attk.

!attk --help

Commands to be sent to the AttackMaster API must be preceded by two hyphens ‘--’ as above for the --help command. Parameters to these commands are separated by vertical bars ‘|’, for example:

!attk --attk-hit token_id | [message] | [monster weap1] | [monster weap2] | [monster weap3]

If optional parameters are not to be included, but subsequent parameters are needed, use two vertical bars together with nothing between them, e.g.

!attk --checkac token_id || [SADJ / PADJ / BADJ]

Commands can be stacked in the call, for example:

!attk --checkac token_id | [ SILENT ] | [SADJ / PADJ / BADJ] –weapon token_id

When specifying the commands in this document, parameters enclosed in square brackets [like this] are optional: the square brackets are not included when calling the command with an optional parameter, they are just for description purposes in this document. Parameters that can be one of a small number of options have those options listed, separated by forward slash ‘/’, meaning at least one of those listed must be provided (unless the parameter is also specified in [] as optional): again, the slash ‘/’ is not part of the command. Parameters in UPPERCASE are literal, and must be spelt as shown (though their case is actually irrelevant).

Command Index

Menus

--menu [token_id]
--other-menu [token_id]

Attacking commands

--attk-hit [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]
--attk-roll [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]
--attk-target [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]
--twoswords [token_id]|[prime-weapon]

Weapon Management

--weapon [token_id]
--dance [token_id] | weapon  | [ STOP ]
--mod-weapon [token_id] | weapon | MELEE / RANGED / DMG / AMMO | adjustments
--quiet-modweap [token_id] | weapon | MELEE / RANGED / DMG / AMMO | adjustments
--edit-weapons [token_id]

Ammunition Management

--ammo [token_id]
--setammo [token_id] | ammo_name | [ [+/-]cur_qty / = ] | [ [+/-]max_qty / = ] | [ SILENT ]

Armour Class and Saving Throws

--edit-armour [token_id]
--checkac [token_id] | [ SILENT ] | [SADJ / PADJ / BADJ]
--save [token_id] | [situation-mod]

Other Commands

--help
--check-db [ db-name ]
--handshake from | [cmd]
--hsq from | [cmd]
--hsr from | [cmd] | [TRUE/FALSE]
--debug [ ON / OFF ]

Command Details

Menus

Display a menu to do actions relating to attacks

--menu [token_id]

Takes an optional token ID – if not specified uses selected token

Displays a Chat menu with buttons for: Attacking, with either Roll20 rolling a dice, or the Player entering a dice roll result; changing what is in the Character’s (or NPC’s) hands; to recover spent ammo; and to check the current Armour Class for the Character under various circumstances. If the GM uses the menu, an additional button for a Targeted Hit appears, which allows the GM to select both the attacker and the target and get full specs on the hit and damage done, and the AC & current hit Points of the target.

Display a menu of other actions

--other-menu [token_id]

Takes an optional token ID – if not specified uses selected token

Displays a Chat menu with buttons for: saving throws and saving throw management; and managing light sources for the character’s token (if Dynamic Lighting is being used) (requires MagicMaster API to work). If the GM uses the menu, two further options appear: mark the token selected as Dead (which also marks the body as an inanimate object that can be looted); and the ability to adjust damage for the selected token for any arbitrary reason, which can also be noted.

Attacking Commands

Attack an opponent with a weapon

--attk-hit [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]
--attk-roll [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]
--attk-target [token_id] | [message] | [monster weap1] | [monster weap2] | [monster weap3]

Each takes an optional token ID (if not specified uses selected token), an optional formatted message to include with the attack damage, and up to three optional names for each of the monster attacks that are displayed on the attack menu.

Each of these three commands present a menu of currently possible attacks, using the weapons and ammo in-hand or, for monsters using the Monster tab on the AD&D 2e Character Sheet, up to 3 types of monster attacks. Ranged weapon attacks will prompt the Player to specify which range to fire at. Selecting one of the possible attacks has different outcomes based on the command used:

The optional message is displayed as part of the display of the damage done on a successful hit. If a monster, the message can be three concatenated messages separated by ‘$$’. The message can include API Buttons if needed. The following characters must be replaced (escaped) using these replacements:

--attk-hit	prompts Roll20 to make an attack roll, using 3D dice if they are enabled, displays the AC hit with supporting information on how this was calculated and displays buttons to roll for damage if the attack is successful.
--attk-roll	displays an entry field to allow the Player to enter the value of their own dice roll (for those that prefer to roll their own dice) though the default entry will also roll the dice for the player. Subsequently, the process is the same as --attk-hit.
--attk-target	is only available to the GM. It asks the GM to select a target token for the attack. It then displays the AC the attack roll will hit and the AC of the selected target. It also automatically rolls damage for Small/Medium and Large targets, and displays the current Hit Points for the targeted token.

Character	Parameter separator	?	[	]	<	>	@	-	|	:	&	{	}
Substitute	%%	^	<<	>>			`	~	¦		&amp;	&#123;	&#125;
Alternative (no ; )	\vbar	\ques	\lbrak	\rbrak	\lt	\gt	\at	\dash	\vbar	\clon	\amp	\lbrc	\rbrc

Use two weapons to attack

--twoswords [token_id]|[prime-weapon]

Takes an optional token ID (if not specified uses selected token) and an optional weapon name.

This command sets the system up to apply the correct penalties / bonuses when using two weapons to attack. Under AD&D 2e rules, only types of Fighter & Rogue can use 2 weapons at a time to attack in a round, and only Rangers do so without penalty. Using this command with the name of a prime-weapon specified will mark that weapon as the Primary which will get the smaller penalty of the two and will also be allowed multiple attacks per round (if using InitiativeMaster API). Use of any other weapon during the current or subsequent rounds will incur a larger penalty and be restricted to one attack per round regardless of type of weapon, level & proficiency. Penalties are adjusted by the Dexterity Reaction Adjustment. See AD&D 2e PHB p96 for full explanation of rules applied.

Calling this command without a prime-weapon specified will terminate two-weapon mode and no penalties will be applied for the current and subsequent rounds.

Weapon Management

Change weapons currently in hand

--weapon [token_id]

Takes an optional token ID – if not specified uses selected token.

This command displays a chat menu displaying what is currently in the Character’s (or NPC or creature’s) hands, and allowing the Player to change what is held to any weapon or shield that they have in their backpack. Subsequent attacks will then use the newly specified weapon(s). Selecting a ranged weapon that uses ammunition, the appropriate ammunition held in their backpack is also loaded into the character’s “quiver”.

Selecting a hand (either Left or Right) will display any 1-handed weapons that can be used for selection in a list. Selecting the Both Hands button will display all the 2-handed weapons (including bows) that can be used for selection in a list. Some weapons can be used either 1-handed or 2-handed, and the appropriate stats will be given based on the selection made.

If being used by the GM, the menu also has an option to change the number of hands the creature has, which will then allow the creature to hold (and attack with) more than two items, or to hold items that require more than two hands.

Note: this function is dependent on the weapon and shield definitions including certain key information in a specified format: see section 8 below.

Manage a dancing weapon

--dance [token_id] | weapon  | [ STOP ]

Takes an optional token ID (if not specified uses selected token), a mandatory weapon name, and an optional STOP command.

This command marks the named weapon as “dancing” which means it will no longer occupy a hand, but will still appear in the list of possible attacks when an attack is made. When started, the --weapon command is automatically run so that an additional weapon can be taken in the freed-up hand.

Appending the “STOP” command will un-mark the weapon as dancing. The Player will have to take the no-longer dancing weapon back in hand, if they so desire, using the --weapon command.

Note: the most effective use of the --dance command is when combined with the RoundMaster effect management system, to count down rounds of use, automatically call the --dance command at the appropriate time, and stop the dancing automatically after the appropriate duration.

Manage weapon statistics

--mod-weapon [token_id] | weapon | MELEE / RANGED / DMG / AMMO | adjustments
--quiet-modweap [token_id] | weapon | MELEE / RANGED / DMG / AMMO | adjustments

Each command takes an optional token ID (if not specified uses selected token), a mandatory weapon name, and a mandatory data type.

These commands allow the specifications of any weapon currently in-hand to be adjusted programmatically. E.g. the magical plus on to-hit and damage can be adjusted round by round (as for a Sword of Dancing. The type of data to be adjusted must be identified using the data type parameter: MELEE & RANGED alter To-Hit data, and DMG & AMMO alter Damage.

The weapon parameter can name a specific weapon name, a type of weapon (e.g. bow, long-blade, club etc), a changed weapon name (previously changed by this command), or even ‘all’ for all currently held weapons. All data of the specified data type for all weapons that match the weapon parameter may then be altered, using the comma-separated adjustments parameter. Each adjustment is of the format

field_id:[=][+/-]value

where the field_ids are:

w:	weapon name	t:	weapon type	st:	weapon super-type
sb:	strength bonus	db:	dexterity bonus	+:	magical plus
n:	number of attacks per round	pl:	proficiency level	pd:	dancing proficiency level
ch:	critical hit roll	cm:	critical miss roll	sz:	size
r:	range (can be #/#/#)	ty:	damage type	sp:	speed in segments
sm:	damage vs small & medium	l:	damage vs large

Numeric values can be preceeded by + or -, which will adjust rather than replace the current value. To set a value as negative, precede the minus by an equals thus =-value. For attributes that are relevant to multiple data types, only the specified data type will be adjusted. Multiple attributes can be adjusted using one command call by concatenating comma-delimited adjustments. E.g.

--mod-weap @{selected|token_id}|Sword-of-Dancing|MELEE|sb:0,+:+1,sp:-1

If the weapon is not found, the GM receives an error message, but no other issues occur.

Adding & removing weapons and ammunition

--edit-weapons [token_id]

Takes an optional token ID – if not specified uses selected token.

The very best way for the Character, NPC or creature to acquire weapons (or any other items including magic items) is to use the MagicMaster API and its commands and databases. However, AttackMaster provides a small subset of those facilities to allow the DM and/or Players to add weapons, ammo & armour to their Character Sheet item bags. Once added, these items can be taken ‘in-hand’ by the Character (using the --weapon command) and then used to attack.

The advantage of doing this over just typing the item names into the Character Sheet tables is that the items are assured to exist in the weapon, ammo & armour databases that come with the API and so all other aspects of the API will work properly.

This command and --edit-armour are identical, and call the same menu.

Ammunition Management

Ammunition recovery

--ammo [token_id]

Takes an optional token ID – if not specified uses selected token.

This command displays a chat menu of ammunition that the Character has on their person (not just the ammo that they have in their quiver or in-hand) including any ammunition that has run-out but might still be recoverable. The Player can ask the DM if they can retrieve any ammunition of the types displayed that they have recently used and, once the DM responds with the amount recovered, click on the type of ammunition in the list and enter the amount recovered. Both the amount on their person, and any amount in their quiver or in-hand are updated.

Note: enter the amount recovered not the new total. The amount entered will be added to the current amount held, and then this new value set as the new maximum. A negative amount can also be entered, which will be removed from the current quantity and will also set the new maximum.

Note: after a Long Rest (see MagicMaster API) all ammunition maximum totals are set to current quantities at that time. It is assumed that during the period of a long rest, some creature will have found any loose ammo, or it will otherwise have been broken or lost.

Note: ammunition that has the item-type of ‘charged’ will appear on the menu with a grey box which cannot be selected, indicating that the ammo cannot be recovered – such ammunition always breaks on contact: e.g. glass arrows.

Ammunition quantity amendment

--setammo [token_id] | ammo_name | [ [+/-]cur_qty / = ] | [ [+/-]max_qty / = ] | [ SILENT ]

Takes an optional token ID (if not specified uses selected token), the unique name of the ammunition, an optional value for the current quantity, optionally preceded by +/- or replaced by an =, an optional value for the maximum quantity with the same +/- & = possibilities, and an optional parameter of “Silent” (case insensitive).

This command allows programmatic or macro alteration of the quantity of a type of ammo:

• The current quantity and/or the maximum held (i.e. the amount to which ammunition can be recovered up to – see section 4.1 Ammunition Recovery, above) can be set to absolute values just by entering numbers for the parameters.
• Either parameter can be preceded by a + or -, in which case the parameter will modify the corresponding current value, rather than replacing it.
• Either parameter can be an = by itself. In this instance, the corresponding value is set to the other corresponding value (after any modification) i.e. putting = for cur_qty sets the current quantity held to be the maximum possible, or putting = for max_qty sets the maximum possible to be the current quantity. Putting = for both does nothing.
• No value can go below 0, and the current quantity will be constrained at or below the maximum quantity.

So, for example, this command will set the maximum quantity to 10 and set the current quantity to be equal to it:

!attk –setammo @{selected|token_id}|Flight-Arrow+1|=|10|silent

If the “Silent” parameter is not specified, then the Ammunition Recovery chat menu will display with the amended values once complete, and a message is displayed with the changes that occurred.

Note: if more than one ammo item of the same name is listed in the backpack table (see section 7 on Character Sheet Setup), only the first item found will be amended. If no item of that name is found, nothing happens and no menus or messages are displayed.

Armour Class and Saving Throws

Edit Armour

--edit-armour [token_id]
--edit-armor [token_id]

Takes an optional token ID – if not specified uses selected token.

The very best way for the Character, NPC or creature to acquire armour (or any other items including magic items) is to use the MagicMaster API and its commands and databases. However, AttackMaster provides a small subset of those facilities to allow the DM and/or Players to add weapons, ammo & armour to their Character Sheet item bags. Once added, these items can be taken ‘in-hand’ by the Character (using the --weapon command), and improve the Armour Class of the Character appropriately.

The advantage of doing this over just typing the item names into the Character Sheet tables is that the items are assured to exist in the weapon, ammo & armour databases that come with the API and so all other aspects of the API will work properly (see section 5.2 below).

This command is identical to the --edit-weapons command and uses the same menu.

Review Armour Class

--checkac [token_id] | [ SILENT ] | [SADJ / PADJ / BADJ]

Takes an optional token ID (if not specified uses selected token), an optional “Silent” command, and an optional damage type which can be “SADJ”, “PADJ” or “BADJ” (the “Silent” and damage type parameters are not case sensitive).

This command analyses the items in the Character’s backpack table (see section 7 on Character Sheet Setup) using the information in the various item databases supplied / created by the API(s), and taking into account the current Dexterity bonuses calculates the current Armour Class of the Character. It then displays a chat message with its results and an explanation of how it came to them. If the optional damage type is provided, the calculation takes this into account.

The system can use the information in the databases to take into account magical armour plusses, combined effects of armour that can work together (like Armour and Shields), exclude combinations that are not allowed (like Rings of Protection with magical armour), and the armour types allowed for various character classes and races including specialist variations.

The system automatically updates this information any time the Character changes what is in their hands (e.g. if they pick up or put down a shield) using the --weapon command. If using the InitMaster API, the command is also run every time the character does an Initiative roll. If using the MagicMaster API, the command is also run any time items are looted from a chest or NPC, or stored away or given to another character.

The system remembers on the Character Sheet what its calculations are each time. If the most recent calculation results in a change in Armour Class for the character, the character’s token AC (if displayed) will be modified by the difference between the old and new values. This modified value will be shown on the Armour Class Review message in the chat window if it is different from the calculated value.

Note: the token displayed AC is only modified by the difference between the previous and current calculations. This allows magical and other effects (such as those managed by the RoundMaster API) to alter the token displayed AC and not be overwritten by a change in calculated AC, but still take into account the change. The token AC can be manually updated at any time without impact on this functionality, to overcome any errors.

Note: if the token is configured following the Master Series API standard (see CommandMaster API documentation), the token bar for the displayed AC is normally hidden. if the calculated AC and token displayed AC are different (see above) then the AC token bar appears, representing the difference between the two. This acts as a visual reminder to the DM and Player that the token is the subject of some effect on AC – it also helps to identify if there is a difference in error, so that this can be manually rectified (by manually altering the token displayed AC). Once the two are again the same and the –check-ac command run, the token AC bar will again be hidden.

Saving Throws

--save [token_id] | [ situation-mod ]
--save [token_id] | [ situation-mod ] | save-type | saving-throw

Takes an optional token ID (if not specified uses selected token), and different forms of the command take an optional situational modifier to the saving throw, a type of save (which can be one of ‘paralysis’, ‘poison’, ‘death’, ‘rod’, ‘staff’, ‘wand’, ‘petrification’, ‘polymorph’, ‘breath’, or ‘spell’, not sensitive to case), and the base, unmodified saving throw achieved on a dice.

This command can either display a menu from which to display and manage the saving throw table, and make saving throws or, in its second form, to make a saving throw and check the result against the saving throw table.

The first form shows all the possible saves that can be made, the saving through that needs to be achieved to make the save, and any modifiers that apply to this particular character. There are buttons to modify the saving throw table and the modifiers, and/or to apply a “situational modifier” to immediate saving throws (the “situational modifier” only applies to current rolls and is not remembered). Also, each type of saving throw can actually be made by clicking the buttons provided. Doing so effectively runs the second form of the command.

The situational modifier can optionally be passed in as a value with the command call if so desired, instead of selecting via the button on the menu.

Running the second form of the command (or selecting to make a saving throw from the first form’s menu) will execute the saving throw (as a dice roll if this is specified instead of a straight value) of the specified type, using the data in the character’s saving throw table to assess success or failure, displaying the outcome and the calculation behind it in the chat window.

Other commands

Display help on these commands

--help

This command does not take any arguments. It displays a very short version of this document, showing the mandatory and optional arguments, and a brief description of each command.

Configure API behavior

--config [PROF/ALL-WEAPS/WEAP-CLASS/ALL-ARMOUR/MASTER-RANGE/SPECIALIST-RULES/SPELL-NUM] | [TRUE/FALSE]

Takes two optional arguments, the first a switchable flag name, and the second TRUE or FALSE.

Allows configuration of several API behaviors. If no arguments given, displays menu for DM to select configuration. Parameters have the following effects:

Flag	True	False
PROF	Strictly apply non-proficient weapon penalties as per PHB	Use the non-proficient weapon penalty displayed on the Character Sheet
ALL-WEAPS	Allow any character of any class to use and become proficient in any weapon.	Restrict the use of weapons by class to some degree set by WEAP-CLASS
WEAP-CLASS	Weapons not allowed to a class get a penalty of -100	Weapons not allowed to a class get double non-proficient penalty
ALL-ARMOUR	All armour types allowed for all classes	Armour not allowed to a class not included in AC calculations
MASTER-RANGE	Ranged weapon Mastery gives double damage at Point Blank range	Ranged weapon Mastery not allowed, as per PHB
SPECIALIST-RULES	Only Specialist Wizards specified in the PHB get an extra spell per spell level	Any non-Standard Wizard gets an extra spell per spell level
SPELL-NUM	Spellcaster spells per level restricted to PHB rules	Spellcaster spells per level alterable using Misc Spells button

Check database completeness & integrity

--check-db [ db-name ]

Takes an optional database name or part of a database name: if a partial name, checks all character sheets with the provided text in their name that also have ‘-db’ as part of their name. If omitted, checks all character sheets with ‘-db’ in the name. Not case sensitive. Can only be used by the GM.

This command finds all databases that match the name or partial name provided (not case sensitive), and checks them for completeness and integrity. The command does not alter any ability macros, but ensures that the casting time (‘ct-‘) attributes are correctly created, that the item lists are sorted and complete, and that any item-specific power & spell specifications are correctly built and saved.

This command is very useful to run after creating/adding new items as ability macros to the databases (see section 8 below). It does not check if the ability macro definition itself is valid, but if it is then it ensures all other aspects of the database consistently reflect the new ability(s).

Handshake with other APIs

–hsq from|[command]
–handshake from|[command]

Either form performs a handshake with another API, whose call (without the ‘!’) is specified as from in the command parameters (the response is always an –hsr command). The command calls the from API command responding with its own command to confirm that RoundMaster is loaded and running: e.g.

Received: !attk –hsq init
Response: !init –hsr attk

Optionally, a command query can be made to see if the command is supported by RoundMaster if the command string parameter is added, where command is the RoundMaster command (the ‘--’ text without the ‘--‘). This will respond with a true/false response: e.g.

Received: !attk –handshake init|menu
Response: !init –hsr attk|menu|true

Switch on or off Debug mode

--debug (ON/OFF)

Takes one mandatory argument which should be ON or OFF.

The command turns on a verbose diagnostic mode for the API which will trace what commands are being processed, including internal commands, what attributes are being set and changed, and more detail about any errors that are occurring. The command can be used by the DM or any Player – so the DM or a technical advisor can play as a Player and see the debugging messages.

Configuring the Token and Character Sheet for use with the API

Token configuration

The API can work with any Token configuration but requires tokens that are going to participate in attacks to represent a Character Sheet, so that actions relevant to the token can be selected.
A single Character Sheet can have multiple Tokens representing it, and each of these are able to do individual attacks using the actions made possible by the data on the Character Sheet jointly represented. However, if such multi-token Characters / NPCs / creatures are likely to encounter spells that will affect the Character Sheet (such as Haste and Slow) they must be split with each Token representing a separate Character Sheet, or else the one spell will affect all tokens associated with the Character Sheet, whether they were targeted or not! In fact, it is recommended that tokens and character sheets are 1-to-1 to keep things simple.
The recommended Token Bar assignments for all APIs in the Master Series are:

Bar1 (Green Circle):	Armour Class (AC field) – only current value
Bar2 (Blue Circle):	Base Thac0 (thac0-base field) before adjustments – only current value
Bar3 (Red Circle):	Hit Points (HP field) – current & max

It is recommended to use these assignments, and they are the bar assignments set by the CommandMaster API if its facilities are used to set up the tokens. All tokens must be set the same way, whatever way you eventually choose.
These assignments can be changed in the APIs that use them, by changing the fields object near the top of the API script.

Use with various game system character sheets

The API issued is initially set up to work with the AD&D 2E character sheet (as this is what the author mostly plays). However, it can be set up for any character sheet. In each API script, right at the top, is an object definition called fields: see the next section for details. This can be altered to get the API to work with other character sheets.
The AttackMaster API, as with all the other RPGMaster series APIs, use Roll20 Roll Templates extensively. This is sometimes the only way to get Roll20 to roll 3D animated dice (using a Character Sheet ability macro triggered by a Player), as 3D animated dice do not work when commanded by an API via a sendchat() call, due to a reported bug. Of course, there is a default Roll Template provided by the Roll20 system, but it is a bit clunky and Roll Templates provided by Character Sheet coders are often better. AttackMaster and other RPGMaster APIs use these Character Sheet-defined Roll Templates, by default from the AD&D 2e Character Sheet. As with every other field, the Roll Templates used can be altered in the fields object.
The coding of the API is designed to use the AD&D 2E system of attack systems and calculations. If you use another system, future developments might support additional approaches. Contact the author for information and to pass on ideas (see the link in the sidebar at the top).

Matching the API to a type of Character Sheet

The API has an object definition called fields, which contains items of the form
Internal_api_name: [sheet_field_name, field_attribute, optional_default_value, optional_set_with_worker_flag]
A typical example might be:

	Fighter_level:['level-class1','current'],
	Or
	MUSpellNo_memable:['spell-level-castable','current','',true],

In order to change the field that the API uses on the character sheet for a different one, you can change the sheet_field_name and/or field_attribute for the one you want to use. However, the Internal_api_name and the other values should not be changed as otherwise the system will not work.
Table names are slightly different: always have an internal_api_name ending in ‘_table’ and their definition specifies the repeating table name and the index of the starting row of the table or -1 for a static field as the 1st row, with the 2nd row starting at repeating row number 0.
Internal_api_table: [sheet_repeating_table_name,starting_index]
An example is:

MW_table:['repeating_weapons',0],

The Internal_api_table must not be altered! Doing so will cause the system not to work. However, the sheet_repeating_table_name and starting_index can be altered to match any character sheet.
Each character sheet must have repeating tables to hold weapons, ammo, spells and magic items. By default, melee weapons ‘in hand’ are held in sections of the repeating_weapons table, melee weapon damage in the repeating_weapons-damage table, ranged weapons in the repeating_weapons2 table, ammo in the repeating_ammo table, spells in the repeating_spells table and magic items are held in the repeating_potions table. Other repeating tables are also used, some of which are intended to be hidden and not visible in the Character Sheet. The table management system provided by the API creates, expands and writes to repeating attributes automatically, and the DM & Players do not need to worry about altering or updating any of these tables on the Character Sheet.

Character Attributes, Races, Classes and Levels

Character Attributes of Strength, Dexterity, Constitution, Intelligence, Wisdom and Charisma are not directly important to the AttackMaster API, but the resulting bonuses and penalties are. All Attributes and resulting modifiers should be entered into the Character Sheet in the appropriate places (that is in the Character Sheet fields identified in the fields API object as noted in the section above).
The Character’s race is also important for calculating saves and ability to use certain items. The race should be set in the appropriate Character Sheet field. Currently, the races ‘dwarf’, ‘elf’, ‘gnome’, ‘halfelf’, ‘halfling’, ‘half-orc’, and ‘human’ are implemented (not case sensitive, and spaces, hyphens and underscores are ignored). If not specified, human is assumed. The race impacts saves, some magic items and armour, and bonuses on some attacks.
The system supports single-class and multi-class characters. Classes must be entered in the appropriate fields on the Character Sheet. Classes and levels affect spell casting ability, weapon multiple attack numbers per round, ability to do two-weapon attacks with or without penalty, and the ability to backstab and the related modifiers among other things. Class and level also determine valid armour, shields, some magic items and saves.
Note: on the Advanced D&D 2e Character Sheet, Fighter classes must be in the first class column, Wizard classes in the second column, Priest classes in the third, Rogues in the fourth, and Psions (or any others) in the fifth. It is important that these locations are adhered to.
Note: classes of Fighter and Rogue (such as Paladins, Rangers and Bards) that can use clerical &/or wizard spells will automatically be allowed to cast spells once they reach the appropriate level by AD&D 2e rules, but not before. They do not also need an entry under a spellcaster column.
The following Classes are currently supported, and the class name must be entered into the class field. If missing, the top row is assumed in each case:

Fighter classes	Wizard Classes	Priest Classes	Rogue Classes	Psion Classes
Warrior	Wizard	Priest	Rogue	Psion
Fighter	Mage	Cleric	Thief
Ranger	Abjurer	Druid	Bard
Paladin	Conjurer	Healer	Assassin
Beastmaster	Diviner	Priest of Life
Barbarian	Enchanter	Priest of War
Defender (Dwarven)	Illusionist	Priest of Light
	Invoker	Priest of Knowledge
	Necromancer	Shaman
	Transmuter

The level for each class must be entered in the corresponding field. Multiple classes and levels can be entered, and will be dealt with accordingly. Generally, the most beneficial outcome for any combination will be used. If not entered, 0 (zero) is assumed (i.e. a commoner)

Spells and Powers

The best (and easiest) way to give a Character or NPC spells and powers is to use the MagicMaster API. However, for the purposes of just doing initiative and selecting which spell to cast in the round, the spells and powers can be entered manually onto the character sheet. Spells are held in the relevant section of the Spells table, which by default is set to the character sheet spells table, repeating_spells. As with other fields, this can be changed in the fields object. Note that on the Advanced D&D 2e character sheet Wizard spells, Priest spells & Powers are all stored in various parts of this one very large table.
If you are just using the character sheet fields to type into, add spells (or powers) to the relevant “Spells Memorised” section (using the [+Add] buttons to add more as required) a complete row at a time (that is add columns before starting the next row). Enter the spell names into the “Spell Name” field, and “1” into each of the “current” & “maximum” “Cast Today” fields – the API suite counts down to zero on using a spell, so in order for a spell to appear as available (not greyed out) on the relevant menus, the “current” number left must be > 0. This makes spells consistent with other tables in the system (e.g. potion dose quantities also count down as they are consumed, etc).
Then, you need to set the “Spell Slots” values on each level of spell to be correct for the level of caster. Just enter numbers into each of the “Level”, “Misc.” and “Wisdom” (for Priests) fields, and/or tick “Specialist” for the Wizard levels as relevant. This will determine the maximum number of spells memorised each day, that will appear in the relevant spells menus. Do the same for Powers using the “Powers Available” field. As with other fields on the character sheet, each of these fields can be re-mapped by altering the fields object in the APIs.

Magic Items and Equipment

All magic items and standard equipment, including weapons, armour, lanterns etc, are held in the Items table, which by default is set to the potions table, repeating_potions, on the Character Sheet. As with other fields, this can be changed in the fields object. The best way to put items into this table is by using the MagicMaster API. However, it generally is possible to enter item names and quantities directly into the table and use them within the system. Only items that also exist in the supplied databases will actually work fully with the API (i.e. be recognised by the API as weapons, armour, ammo, etc). Initial weapon, ammunition and armour databases are provided with the AttackMaster API, and in addition to these Initial magic item, spell and power databases are provided with the MagicMaster API. Other items can be in the table and used for undertaking initiative actions but will not otherwise be effective. New databases and database items can be added using the specifications and instructions contained in the AttackMaster and MagicMaster API documentation.

Weapons and Ammo

For the AttackMaster API to support weapon attack actions melee weapons, damage, ranged weapons and ammo must be entered directly into the melee weapon, damage, ranged weapon and ammo tables on the Character Sheet. This is best done using the AttackMaster commands --edit-weapons (to load from the database) and --weapon (to take weapons in-hand), which will ensure all the right values are entered in the right fields, including taking into account the impact of weapon proficiencies, specialisation, mastery, character races and class/level. However, manual entry will generally work to the extent to allow weapon attack actions to be selected.

Character Sheet data fields

As stated in the previous section, the Character Sheet field mapping to the API script can be altered using the definition of the fields object. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document.

Weapon, Ammo & Armour Databases

General Database information

The RPGMaster APIs use a number of Character Sheets as databases to hold Ability Macros defining weapons, ammo, and items of armour and their specifications. The API is distributed with many weapon, ammo and armour definitions and it also checks for, creates and updates these Character Sheet databases on start-up. DMs can add their own weapons, ammo and armour to additional databases, but the databases provided are totally rewritten when new updates are released so the DM must add their own database sheets. If the provided databases are accidentally deleted, they will be automatically recreated the next time the Campaign is opened. Additional databases should be named as follows:

Weapons:	additional databases: MI-DB-Weapons-[added name] where [added name] can be replaced with anything you want.
Ammo:	additional databases: MI-DB-Ammo-[added name] where [added name] can be replaced with anything you want.
Armour:	additional databases: MI-DB-Armour-[added name] where [added name] can be replaced with anything you want.

However: the system will ignore any database with a name that includes a version number of the form “v#.#” where # can be any number or group of numbers e.g. MI-DB v2.13 will be ignored. This is so that the DM can version control their databases, with only the current one (without a version number) being live.

There can be as many additional databases as you want. Other Master series APIs come with additional databases, some of which overlap - this does not cause a problem as version control and merging unique macros is managed by the APIs.

Important Note: all Character Sheet databases must have their ‘ControlledBy’ value (found under the [Edit] button at the top right of each sheet) set to ‘All Players’. This must be for all databases, both those provided (set by the API) and any user-defined ones. Otherwise, Players will not be able to run the macros contained in them.

Each database has a similar structure, with:

• Ability Macros named as the weapon, ammo or armour specified, and used to describe and provide specifications for using the commands with the AttackMaster API;
• Custom Attributes with the attribute name “ct-ability-macro-name”, one per Ability Macro, which defines the speed and type for each item;
• An entry in a list on the character sheet in the spell book of the relevant Character Sheet tab (various spell books for different items – see entry below);
• Optionally, some entries come also with attributes that define Powers and Spells delivered by or stored on the item.

Note: a DM only needs to program the Ability Macro using the formats shown in the next section, and then run the !attk --check-db or !magic --check-db command, which will correctly parse the ability macro and set the rest of the database entries as needed.

Ability Macros can be whatever the DM wants and can be as simple or as complex as desired. Roll Templates are very useful when defining ability macros. When a Player or an NPC or Monster views the specifications of a weapon, ammunition or piece of armour, the APIs run the relevant Ability Macro from the databases as if it had been run by the Player from the chat window. All Roll20 functions for macros are available.

Weapon & Ammunition Databases

Weapon databases are all character sheets that have names that start with MI-DB-Weapon (though in fact, weapons can be in any database starting with MI-DB- if desired), and can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored. Ammunition databases are similar, with the root database MI-DB-Ammo.

As previously stated, each weapon definition has 3 parts in the database (see Section 1): an Ability Macro with a name that is unique and matches the weapon, an Attribute with the name of the Ability Macro preceded by “ct-“, and a listing in the database character sheet of the ability macro name separated by ‘|’ along with other weapons. The quickest way to understand these entries is to examine existing entries. Do go to the root databases and take a look (but be careful not to alter anything unless you know what you’re doing!)

Note: The DM creating new weapons does not need to worry about anything other than the Ability Macro in the database, as running the AttackMaster or MagicMaster –check-db MI-DB-Weapons command will update all other aspects of the database appropriately for all databases that have a name starting with or including ‘MI-DB-Weapons’, as long as the Specs and Data fields are correctly defined. Use the parameter 'MI-DB-Ammo' to check and update the ammunition databases. Running the command –check-db with no parameters will check and update all databases.

Ability macros can be added to a database just by using the [+Add] button at the top of the Abilities column in the Attributes and Abilities tab of the Database Character Sheet, and then using the edit “pencil” icon on the new entry to open it for editing. Ability macros are standard Roll20 functionality and not dependent on the API. Refer to the Roll20 Help Centre for more information.

Here are some examples:

Longsword

/w "@{selected|character_name}" &{template:2Edefault} {{name=Longsword}} {{subtitle=Sword}} {{Speed=[[5]]}} {{Size=Medium}} {{Weapon=1-handed melee long-blade}} Specs=[Longsword,Melee,1H,Long-blade] {{To-hit=+0 + Str bonus}} ToHitData=[w:Longsword, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:5] {{Attacks=1 per round + level & specialisation, Slashing}} {{Damage=+0, vs SM:1d8, L:1d12, + Str bonus}} DmgData=[w:Longsword, sb:1, +:0, SM:1d8, L:1d12] {{desc=This is a normal sword. The blade is sharp and keen, but nothing special.}}

The ability specification for this Longsword uses a Roll20 Roll Template, in this case defined by the Advanced D&D 2e Character Sheet by Peter B (see the documentation for the Character Sheet on Roll20 for specifications of this Roll Template), but any Roll Template you desire can be used. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the APIs are those highlighted. Each of these elements are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:

Specs = [Type, Class, Handedness, Weapon Group]

The Specs section describes what weapon type and proficiency groups this weapon belongs to. These fields must be in this order. This format is identical for all database items, whether in these databases or others used by the Master series of APIs.

Type	is the type of the weapon, often the same as the ability macro name without magical plusses.
Class	is one of Melee, Ranged, or Ammo.
Handedness	is #H, where # is the number of hands needed to wield the weapon.
Weapon Group	is the group of related weapons that the weapon belongs to.

ToHitData = [w:Longsword, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:5]

The ToHitData section specifies the data relating to an attack with the weapon. These fields can be in any order.

w:	<text> the name to display for attacks with this weapon
sb:	<0/1> strength bonus flag - specifies if the strength bonus is applicable to the To-Hit roll
+:	<[+/-]#> the magical attack bonus/penalty - an integer of any size
n:	<#[/#]> the basic number of attacks per round: the API will modify to account for specialisation and level
ch:	<1-20> the roll for a Critical Hit, shown in the API with a green border to the attack AC achieved
cm:	<1-20> the roll for a Critical Miss, shown in the API with a red border to the attack AC achieved
sz:	<T/S/M/L/H/G> the size of the weapon
ty:	<SPB> the type of damage done by the weapon - Slashing, Piercing and/or Bludgeoning
sp:	<#> the speed of the weapon in segments
r:	<[+/-/=]# [/#/#/#] > the range or range modifier of the weapon. Ranged weapons use PB / S / M / L

The number of attacks per round, n:, can be an integer or a fraction such as 3/2 meaning 3 attacks every 2 rounds. If using the InitMaster API the Tracker will have the correct number of entries for the Character relating to the number of attacks in the current round.

The range for the weapon, r:, can be a single integer (representing the range of a melee weapon or simple ranged weapon) or a range modifier, starting with +, -, or =. The range modifier will amend the range of the ammo for a ranged weapon - ranged weapons vary their range with the ammo used. The weapon can use that range or modify it. Ranged weapon range modifiers can be of the form [[+/-]#/][+/-]#/[+/-]#/[+/-]# which will add or subtract a different modifier for each range ([Point Blank] / Short / Medium / Long – Point Blank range is optional)

DmgData = [w:Longsword, sb:1, +:0, SM:1d8, L:1d12]

The DmgData section specifies the data relating to the damage done by the weapon, and relates to melee weapons only (not ranged weapons). These fields can be in any order.

w:	<text> the name to display for damage calculations for this weapon
sb:	<0/1> strength bonus flag - specifies if the strength bonus is applicable to the Damage roll
+:	<[+/-]#> the magical damage bonus/penalty - an integer of any size
sm:	<dice roll spec> the base dice roll vs. small/medium creatures excluding any magical bonus
l:	<dice roll spec> the base dice roll vs. large/huge creatures excluding any magical bonus

Bastardsword+1

/w "@{selected|character_name}" &{template:2Edefault} {{name=Bastard Sword+1}} {{subtitle=Magic Sword}} {{Speed=[[5]]}} {{Size=Medium}} {{Weapon=1 or 2-handed melee long blade}} Specs=[Bastard-Sword,Melee,1H,Long-blade], [Bastard-Sword,Melee,2H,Long-blade] {{To-hit=+1 + Str Bonus}} ToHitData=[w:Bastard Sword+1, sb:1, +:1, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:6,rc:uncharged],[w:Bastard Sword 2H+1, sb:1, +:1, n:1, ch:20, cm:1, sz:M, ty:S, r:5, sp:8,,rc:uncharged] {{Attacks=1 per round + specialisation & level, Slashing}} {{Damage=+1, 1-handed SM:1d8 L:1d12, 2-handed SM:2d4 L:2d8}} DmgData=[w:Bastard Sword+1,sb:1,+:1,SM:1d8,L:1d12],[w:Bastard Sword 2H+1,sb:1,+:1,SM:2d4,L:2d8] {{desc=This is a normal magical sword. The blade is sharp and keen, and is a +[[1]] magical weapon at all times.}}

The Bastardsword can be used either single handed or two handed with different to-hit and damage outcomes. This can be represented in the macro as shown here, with multiple specification sections. When using the AttackMaster API !attk --weapon command to take the Bastardsword in hand, choosing 1 hand (either left or right) will use the 1-handed specifications, and choosing to take it in Both Hands will use the 2-handed specifications.

All the field definitions are the same as for the Longsword example above, but there are (in this case) two sets of data for each section, the first set for 1-handed, the second set for 2-handed (as defined by the handedness entry in the Specs section data sets.

Longbow

/w "@{selected|character_name}" &{template:2Edefault} {{name=Longbow}} {{subtitle=Bow}} {{Speed=[[8]]}} {{Size=Medium}} {{Weapon=Ranged 2-handed Bow}} Specs=[Longbow,Ranged,2H,Bow] {{To-hit=+0 + Dex Bonus}} ToHitData=[w:Longbow,sb:0,db:1,+:0,n:2,ch:20,cm:1,sz:L,ty:P,sp:8] {{Attacks=Piercing, 2 per round}} {{desc=This is a normal longbow. The wood is polished, the string taut, but nothing special.}}

A ranged weapon like a Longbow uses the same data section definitions as melee weapons except for the following additions and differences.

ToHitData=[w:Longbow,sb:0,db:1,+:0,n:2,ch:20,cm:1,sz:L,ty:P,sp:8]

The To-Hit section has an extra option:

db:	<0/1> dexterity bonus flag - specifies if the dexterity bonus is applicable to the To-Hit roll.
r:	the range data is not provided because this weapon does not modify the range of its ammo, but could be provided if required.

There is no DmgData section, as damage is defined by the ammo.

Flight-Arrow+2 (Ammunition Database)

/w "@{selected|character_name}" &{template:2Edefault} {{name=Flight Arrow+2}} {{subtitle=Magic Weapon}} {{Speed=As per bow}} {{Size=Small}} Specs=[Flight-Arrow,Ammo,1H,Arrow],[Flight-Arrow,Ammo,1H,Arrow] {{Ammo=+2,
**Warbow** vs. SM:1d8, L:1d8,
**Other Bows** vs. SM:1d6, L:1d6, Piercing}} AmmoData=[w:Flight Arrow+2, st:Bow, sb:1, +:2, SM:1d6, L:1d6],[w:Warbow Flight Arrow+2, t:warbow, sb:1, +:2, SM:1d8,L:1d8] {{Range=PB:30, others vary by bow
**Shortbow:**
S:50, M:100, L150,
**Longbow:**
S:60, M:120, L:210,
**Warbow:**
S90, M:160, L:250,
**Composite Sbow:**
S:50, M:100, L:180,
**Composite Lbow:**
S:70, M:140, L:210}} RangeData=[t:longbow, +:2, r:3/6/12/21],[t:shortbow, +:2, r:3/5/10/15],[t:warbow, +:2, r:3/9/16/25],[t:compositelongbow, +:2, r:3/7/14/21],[t:compositeshortbow, +:2, r:3/5/10/18] {{desc=A magical Flight Arrow of very fine quality}}

Ammo has a different specification, as the To-Hit data sections are obviously part of the ranged weapon data. Instead it provides data on which weapons this can be ammo for, and what ranges it has for each. To determine this, it uses the weapon type and group-type set in the weapon Specs section.

AmmoData=[w:Flight Arrow+2, st:Bow, sb:1, +:2, SM:1d6, L:1d6],[w:Warbow Flight Arrow+2, t:warbow, sb:1, +:2, SM:1d8,L:1d8]

The AmmoData section has mostly the same as the DmgData sections (order of fields is immaterial and spaces, hyphens and underscores ignored in type and supertype names), but repeated data sets relate to the data for different types of weapon, and in addition:

t:	<weapon-type> the specific type of ranged weapon this data matches - takes priority over st:. An example is Longbow
st:	<group-type> the group-type of ranged weapon this data can be used for. An example is Bow, which means all bows

RangeData=[t:longbow, +:2, r:3/6/12/21],[t:shortbow, +:2, r:3/5/10/15],[t:warbow, +:2, r:3/9/16/25], [t:compositelongbow, +:2, r:3/7/14/21],[t:compositeshortbow, +:2, r:3/5/10/18],[st:bow, +:2, r:3/5/10/15]

The RangeData section has one or more data sets relating to weapons that result in different ranges. The range specifications can have 3 or 4 parts: if 4, the first is for Point Blank range which is only relevant for specialists; the remaining 3 are always short, medium & long ranges.

Self-ammoed weapons e.g. Warhammer

/w "@{selected|character_name}" &{template:2Edefault} {{name=Warhammer}} {{subtitle=Hammer/Club}} {{Speed=[[4]]}} {{Size=Medium}} {{Weapon=1-handed melee or thrown club}} Specs=[Warhammer,Melee,1H,Club],[Warhammer,Ranged,1H,Club] {{To-hit=+0 + Str & Dex bonus}} ToHitData=[w:Warhammer, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, r:5, sp:4],[ w:Warhammer, sb:1, db:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, sp:4] {{Attacks=1 per round + level & specialisation, Bludgeoning}} {{Damage=+0, vs SM:1d4+1, L:1d4, + Str bonus}} DmgData=[ w:Warhammer, sb:1, +:0, SM:1+1d4, L:1d4][] {{Ammo=+0, vs SM:1d4+1, L:1d4, + Str bonus}} AmmoData=[w:Warhammer,t:Warhammer,st:Throwing-club,sb:1,+:0,SM:1+1d4,L:1d4] {{Range=S:10, M:20, L:30}} RangeData=[t:Warhammer,+:0,r:1/2/3] {{desc=This is a normal warhammer. The blade is sharp and keen, but nothing special.}}

A melee weapon that can also be thrown, and is its own ammunition, is termed a “self-ammoed” weapon. Its definition combines the data elements of both melee weapons, ranged weapons and ammunition.

Specs=[Warhammer,Melee,1H,Club],[Warhammer,Ranged,1H,Club]

Has two data sets, one as a melee weapon and one as a ranged weapon.

ToHitData=[w:Warhammer, sb:1, +:0, n:1, ch:20, cm:1, sz:M, ty:B, r:5, sp:4],[ w:Warhammer, sb:1, db:1,  +:0, n:1, ch:20, cm:1, sz:M, ty:B, sp:4]

Also has two sets of data, each of which relates to the corresponding Specs set.

DmgData=[ w:Warhammer, sb:1, +:0, SM:1+1d4, L:1d4],[]

Does have two data sets, but the one corresponding to the ranged data is empty, as this data is in the Ammo data set.

AmmoData=[w:Warhammer,t:Warhammer,st:Throwing-club,sb:1,+:0,SM:1+1d4,L:1d4]

There is only 1 Ammo data set, as it only relates to the one weapon, itself.

RangeData=[t:Warhammer,+:0,r:1/2/3]

And only 1 Range data set, as it only relates to itself.

Artifact sword

/w "@{selected|character_name}" &{template:2Edefault} {{name=Jim the Sun Blade<br> Intelligent, Neutral}} {{subtitle=Magic Sword}} {{Speed=[[3]]}} WeapData=[w:Jim the Sun Blade,ns:5][cl:PW,w:Jims-Locate-Object,sp:100,lv:6,pd:1],[cl:PW,w:Jims-Find-Traps,sp:5,lv:6,pd:2],[cl:PW,w:Jims-Levitation,sp:2,lv:1,pd:3],[cl:PW,w:Jims-Sunlight,sp:3,lv:6,pd:1],[cl:PW,w:Jims-Fear,sp:4,lv:6,pd:2] {{Size=Special (feels like a Shortsword)}} {{Weapon=1 or 2 handed melee Long or Short blade}} Specs=[Bastard-sword|Short-sword,Melee,1H,Long-blade|Short-blade],[Bastard-sword|Short-sword,Melee,1H,Long-blade|Short-blade],[Bastard-sword,Melee,2H,Long-blade],[Bastard-sword,Melee,2H,Long-blade] {{To-hit=+2, +4 vs Evil + Str Bonus}} ToHitData=[w:Jim +2,sb:1,+:2,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim vs Evil+4,sb:1,+:4,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim 2H +2,sb:1,+:2,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3],[w:Jim 2H vs Evil+4,sb:1,+:4,n:1,ch:20,cm:1,sz:M,ty:S,r:5,sp:3] {{Attacks=1 per round}} {{Damage=+2, +4 vs Evil, + 1-handed SM:1d8 L:1d12, 2-handed SM:2d4 L:2d8}} DmgData=[w:Jim+2,sb:1,+:2,SM:1d8,L:1d12],[w:Jim vs Evil+4,sb:1,+:4,SM:2d4,L:2d8],[w:Jim 2H +2,sb:1,+:2,SM:1d8,L:1d12],[w:Jim 2H vs Evil+4,sb:1,+:4,SM:2d4,L:2d8] {{desc=An intelligent weapon: A Sun Blade called Jim (DMs Guide Page 185). It is Neutral. It needs its owner to be proficient with either a Short or Bastard Sword or promise to get such proficiency as soon as possible. It cannot be used by someone who is not proficient. It requires its owner to be Neutral on at least one of its axis, and may not be Evil. NG LN CN and of cause true N are all ok. Abilities:
**1:** It is +2 normally, or +4 against evil creatures, and does Bastard sword damage.
**2:** It feels and react as if it is a short sword and uses short sword striking time.
**3:** [Locate Object](!magic --mi-power @{selected|token_id}|Jims-Locate-Object|Jim-the-Sun-Blade|6) at 6th Level in 120’ radius (1x day).
**4:** [Detect traps](!magic --mi-power @{selected|token_id}|Jims-Find-Traps|Jim-the-Sun-Blade|6) of large size in 10’ radius (2xday).
**5:** [Levitation](!magic --mi-power @{selected|token_id}|Jims-Levitation|Jim-the-Sun-Blade|1) 3x a day for 1 turn (cast at 1st Level).
**6:** [Sunlight](!magic --mi-power @{selected|token_id}|Jims-Sunlight|Jim-the-Sun-Blade|6) Once a day, upon command, the blade can be swung vigorously above the head, and it will shed a bright yellow radiance that is like full daylight. The radiance begins shining in a 10-foot radius around the sword-wielder, spreading outward at 5 feet per round for 10 rounds thereafter, creating a globe of light with a 60-foot radius. When the swinging stops, the radiance fades to a dim glow that persists for another turn before disappearing entirely.
**7:** It has a special purpose namely Defeat Evil.
**8:** On hitting an Evil being it causes [Fear](!magic --mi-power @{selected|token_id}|Jims-Fear|Jim-the-Sun-Blade|6) for 1d4 rounds (unless saving throw is made). It can do this **twice a day** when the wielder desires.
**9:** It speaks Common and its name is Jim. It will talk to the party.
**10:** It has an ego of 16 and is from Yorkshire.
**11:** It will insist on having a Neutral wielder. (See Intelligent weapons on page 187 in DMG).
**12:** If picked by a player, it will be keen to become the players main weapon.
**13:** If picked up by a player who is not Neutral it will do them 16 points of damage}}

An artefact such as an intelligent sword with powers introduces data sets that specify the powers that the artefact has and how often they can be used. These match the API Buttons with calls to the MagicMaster API to enact the powers.

WeapData=[w:Jim the Sun Blade,ns:5][cl:PW,w:Jims-Locate-Object,sp:100,lv:6,pd:1],[cl:PW,w:Jims-Find-Traps,sp:5,lv:6,pd:2],[cl:PW,w:Jims-Levitation,sp:2,lv:1,pd:3],[cl:PW,w:Jims-Sunlight,sp:3,lv:6,pd:1],[cl:PW,w:Jims-Fear,sp:4,lv:6,pd:2]

The WeapData data sets can be used to define the powers that an artefact has (or stored spells - see MagicMaster API for more information on spell storing)

1^st data set:

w:	<text> The name of the weapon (not currently used)
ns:	<#> The number of spells or powers for which the specifications follow

Subsequent data sets:

cl:	< MU / PR / PW > The type of data: MU=Wizard, PR=Priest, PW=Power
w:	<text> Name of the spell or power: must be the same as the corresponding database definition
sp:	<#> Speed of the spell/power casting in segments (1/10ths of a round)
lv:	<#> The level at which the artefact will cast the spell/power (if omitted will use character’s level)
pd:	<-1 / #> Number per day, or -1 for “use at will”

Armour Databases

Armour databases are all character sheets that have names that start with MI-DB-Armour (as with weapons, this can be in any database starting with MI-DB- if desired), and can have anything put at the end, though those with version numbers of the form v#.# as part of the name will be ignored.

As previously stated and as per the weapon and ammunition databases, each armour definition has 3 parts in the database (see Section 1): the Ability Macro, the ct- attribute, and the listing (and occasionally attributes for powers and spells). The quickest way to understand these entries is to examine existing entries. Do go to the root databases and take a look (but be careful not to alter anything unless you know what you’re doing!)

Note:The DM creating new armour entries does not need to worry about anything other than the Ability Macro in the database, as running the !attk --check-db MI-DB-Armour or !magic --check-db MI-DB-Armour command will update all other aspects of the database appropriately for all databases that have a name starting with or including ‘MI-DB-Armour’, as long as the Specs and Data fields are correctly defined. Running the command –check-db with no parameters will check and update all databases.

Here are some examples:

Chain Mail

/w "@{selected|character_name}" &{template:2Edefault}{{name=Chain Mail}}{{subtitle=Armour}}{{Armour=Chain Mail}} Specs=[Chain Mail,Armour,0H,Mail]{{AC=[[5]] vs all attacks}} ACData=[a:Chain Mail,st:Mail,+:0,ac:5,sz:L,wt:40]{{Speed=[[0]]}}{{Size=Large}}{{Immunity=None}}{{Saves=No effect}}{{desc=This armor is made of interlocking metal rings. It is always worn with a layer of quilted fabric padding underneath to prevent painful chafing and to cushion the impact of blows. Several layers of mail are normally hung over vital areas. The links yield easily to blows, absorbing some of the shock. Most of the weight of this armor is carried on the shoulders and it is uncomfortable to wear for long periods of time.}}

The ability specification for this suit of Chain Mail uses a Roll20 Roll Template, in this case defined by the Advanced D&D 2e Character Sheet by Peter B. The entries in the Roll Template itself can be anything you desire, giving as much or as little information as you want. However, the important elements for the AttackMaster API are those highlighted. Each of these elements are inserted between the elements of the Roll Template, meaning they will not be seen by the player when the macro is run. Generally spaces, hyphens and underscores in the data elements are ignored, and case is not significant. Each element is described below:

Specs=[Chain Mail,Armour,0H,Mail]

The Specs section of the specification has exactly the same format as for weapons and ammunition (and indeed all database items). See section 9 for the definition of the fields.

Note:The armour Type (the 1^st parameter) and Group-Type (the 4^th parameter) are used to determine if the character is of a class that can use the armour. Currently implemented types are listed in Section 9.

Note: Armour that fits on the body generally does not take any hands to hold, and so the third field, Handedness, is set to “0H”.

ACData=[a:Chain Mail,st:Mail,+:0,ac:5,sz:L,wt:40]

The Armour Class Data (ACData) section holds data specific to the armour. As with other data sections, fields can be in any order, and spaces, hyphens, underscores and case are ignored.

a:	< text > the name of the armour to be displayed. Often the same as the Ability.
st:	< group-type > the supertype of the armour, often the same as the fourth parameter of the Specs section.
+:	<[+/-]#> the magical bonus or penalty of the armour (defaults to 0 if not supplied).
ac:	<[-]#> the base armour class (excluding magical bonuses) for this type of armour.
sz:	<[T/S/M/L/H]> The size of the item (not necessarily indicating its fit).
wt:	<#> The weight of the item in lbs (could be considered kg - or any measure - if everything is the same).

Other possible fields are:

t:	< armour-type > The specific armour type, often the same as the first parameter of the Specs section.
db:	<[-/+]#> The dexterity bonus or penalty that wearing the armour bestowes.
+m:	<[-/+]#> The adjustment that the armour gives vs. missiles and ammunition of ranged weapons.
+s:	<[-/+]#> The magical adjustment specifically against slashing damage.
+p:	<[-/+]#> The magical adjustment specifically against piercing damage.
+b:	<[-/+]#> The magical adjustment specifically against bludgeoning damage.
rc:	<recharging/curse type> Armour can be “cursed”, but generally does not have charges. Default is “uncharged”. See MagicMaster API documentation for more information on charges and curses.

Shield+2

/w "@{selected|character_name}" &{template:2Edefault}{{name=Shield+2}}{{subtitle=Shield}}{{Shield=1-handed +2 Medium Shield made of wood & metal}}Specs=[Medium Shield,Shield,1H,Shield]{{AC=+[[2]] against all attacks from the front}}ACData=[a:Medium Shield+2, st:Shield, +:2,sz:M, wt:10] {{Speed=[[0]]}} {{Size=M}} {{Immunity=None}} {{Saves=No effect}} {{desc=All shields improve a character's Armor Class by 1 or more against a specified number of attacks. A shield is useful only to protect the front and flanks of the user. Attacks from the rear or rear flanks cannot be blocked by a shield (exception: a shield slung across the back does help defend against rear attacks). The reference to the size of the shield is relative to the size of the character. Thus, a human's small shield would have all the effects of a medium shield when used by a gnome.

• The medium shield* is carried on the forearm and gripped with the hand. Its weight prevents the character from using his shield hand for other purposes. With a medium shield, a character can protect against any frontal or flank attacks.}}

As can be seen here, the specification for a Shield is almost identical in structure to that of any other armour, the major difference being in the Specs section type field.

Note: The ac: field in the data section for a shield is always assumed to be “+1”, meaning a shield adds 1 to the base AC before magical adjustments are taken into account. However, it can be specified as a different value, if desired.

Note: All shields except a Buckler must be taken in hand using the !attk --weapon command before the Armour Class system of the AttackMaster API adds it to the AC for the character. A buckler is a special type of very small shield that is strapped to the arm and can counter only 1 blow per melee round, but allows both (all) hands to be free. In fact, any shield can have this functionality if desired, by setting the handedness field of the Specs section to be “0H”, meaning it take no hands to hold it.

Armour-of-Vulnerability+-3

/w "@{selected|character_name}" &{template:2Edefault}{{name=Field Plate Armour of Vulnerability+/-3}}{{subtitle=Cursed Armour}}{{Armour=+/-3 selectively magical Field Plate}}Specs=[Armour-of-Vulnerability|Armour-of-Resistance,Armour,0H,Plate]{{AC=[[2]][[0-3]] better AC against Slashing damage +[[3]] worse AC against any other type}}ACData=[a:Armour-of-Vulnerability+-3,st:Mail,+S:3,+P:-3,+B:-3,ac:2,sz:L,wt:60,sp:0,rc:cursed]{{Speed=0}}{{Size=Large}}{{Immunity=None}}{{Saves=No effect}}{{desc=Curse. This armor is cursed, a fact that is revealed only when an identify spell is cast on the armor or you attune to it. Attuning to the armor curses you until you are targeted by the remove curse spell or similar magic; removing the armor fails to end the curse. While cursed, you have vulnerability to two of the three damage types associated with the armor (not the one to which it grants resistance).}}{{desc1=This armour provides resistance to Slashing damage only, but vulnerability to Piercing and Bludgeoning damage.
This armor is a combination of chain or brigandine with metal plates (cuirass, epaulettes, elbow guards, gauntlets, tasets, and greaves) covering vital areas. The weight is distributed over the whole body and the whole thing is held together by buckles and straps. This is the most common form of heavy armor.
For each +1 bonus to armor, regardless of the type of armor, the wearer\'s Armor Class moves downward (toward AC 2 . . . to 1 . . . to 0, -1, -2, and so on). Note, however, that Armor Class can never be improved beyond -10}}

This is a slightly more complex type of armour. It is a cursed item, and generally appears initially as Armour-of-Resistance+3, hence the Specs first parameter of armour type having two possible values, separated by ‘|’.

The use of the damage type specific magical adjustment fields can be seen in the data section, along with the use of the rc: field tag with the value ‘cursed’. See section 9 for a complete list of rc: field values.

Specs & Data field values

Below are lists of the current possible values for the item database Ability macro sections.

Specs sections

Specs=[Type, Item-Class, Handedness, Group-Type]

Weapon Types

There is an infinite list of weapon types: generally the type is the weapon name without any reference to magical plusses, so the Type of a Longsword+2 is Longsword. This Type is used to check for Proficiency.

Weapon Item-Classes

Melee	Melee weapon which strikes while in hand
Ranged	Weapon that causes damage when thrown or with ammunition
Ammo	Ammunition for a ranged weapon of a specific Type or Group-Type

Weapon Handedness

0H	A weapon that does not take a hand (e.g. spike on helm)
1H	A weapon that is 1-handed, such as a short sword
2H	A weapon that takes 2 hands to wield, such as a longbow
3H	A weapon that takes 3 hands…
4H	Etc (e.g. a siege weapon that needs 2 people to operate it)
…	…

Weapon Group-Types

Weapon Group-Types determine related weapons for weapon proficiency, and whether it can be used by a Character of a specific class. The APIs use the definitions in the AD&D2e Fighter’s Handbook section on ‘Tight Groups’, extended to cover certain additional weapons and weapon types. Those implemented so far for the Weapon databases are:

Arrow	Club	Great-Blade	Long-Blade	Short-Blade	Whip
Axe	Crossbow	Hook	Medium-Blade	Sling
Blowgun	Dart	Horeshoes	Pick	Spear
Bow	Fencing-Blade	Innate	Polearm	Staff
Bullet	Flail	Lance	Quarrel	Throwing-Blade

Types and Group-Types that can be used by various Character Classes are:

Warrior	Any
Fighter	Any
Ranger	Any
Paladin	Any
Beastmaster	Any
Barbarian	Any
Defender	axe, club, flail, long-blade, fencing-blade, medium-blade, short-blade, polearm
Wizard (all types)	dagger, staff, dart, knife, sling
Priest / Cleric	club, mace, hammer, staff
Druid	club, sickle, dart, spear, dagger, scimitar, sling, staff
Healer	club, quarterstaff, mancatcher, sling
Priest of Life	club, quarterstaff, mancatcher, sling
Priest of War	Any
Priest of Light	dart, javelin, spear
Priest of Knowledge	sling, quarterstaff
Shaman	long-blade, medium-blade, short-blade, blowgun, club, staff, shortbow, horsebow, hand-xbow
Rogue / Thief	club, short-blade, dart, hand-xbow, lasso, shortbow, sling, broadsword, longsword, staff
Bard	Any
Assassin	Any

Armour Types

There is an infinite list of armour types: generally the type is the armour name without any reference to magical plusses, so the Type of Plate-Mail+2 is Plate-Mail. This Type is used to check for Proficiency.

Armour Item-Classes

Armour	Any type of armour that does not need to be held to work
Shield	A barrier that is held in hand(s) and defends against one or more attacks from the front

Armour Handedness

0H	Armour and Shields that are not held in the hand (e.g. a Buckler or a Helm)
1H	Generally a type of Shield that must be held in a hand
2H	Armour and Shields that use two hands, and/or prevent use of those hands for other things
3H	Generally siege engines that shield against attacks… (not yet implemented)
…	etc.

Armour Group-Types

Armour Types and Group Types determine whether the armour can be used by various Character Classes. Here are the currently implemented restrictions:

Warrior	Any
Fighter	Any
Ranger	Any
Paladin	Any
Beastmaster	Any
Barbarian	padded, leather, hide, brigandine, ring-mail, scale-mail, chain-mail, shield, ring, magic-item, cloak
Defender	Any
Wizard (all types)	magic-item, ring, cloak
Priest / Cleric	Any
Druid	leather, padded, hide, wooden-shield, magic-item, ring, cloak
Healer	Any
Priest of Life	Any
Priest of War	Any
Priest of Light	studded-leather, ring-mail, chain-mail, shield, ring, magic-item, cloak
Priest of Knowledge	magic-item, ring, cloak
Shaman	padded, leather, hide, brigandine, ring-mail, scale-mail, chain-mail, splint-mail, banded-mail, shield, ring, magic-item, cloak
Rogue / Thief	Any
Bard	padded, leather, hide, brigandine, ring-mail, scale-mail, chain-mail, ring, magic-item, cloak
Assassin	Any

Data Sections

<thead> </thead>

Field	Format	Default Value	Description	Can be used in
				ToHit Data	Dmg Data	Ammo Data	Range Data	Weapon Data	AC Data
w:	< text >	\'-\'	Name to be displayed	X	X	X
w:	< text >	\'-\'	Name of spell or power					X
a:	< text >	\'-\'	Name to be displayed						X
t:	< text >	\'\'	Type			X	X		X
st:	< text >	\'\'	Group Type (aka Tight-Group)			X	X		X
sb:	0 / 1	0	Strength Bonus	X	X	X
db:	0 / 1	1	Dexterity Bonus	X					X
+:	[ + / - ] #	0	Magical adjustment	X	X	X	X		X
+m:	[ + / - ] #	0	Missile attack adjustment						X
+s:	[ + / - ] #	0	Slashing damage adjustment						X
+p:	[ + / - ] #	0	Piercing damage adjustment						X
+b:	[ + / - ] #	0	Bludgeoning damage adjustment						X
n:	# [ / # ]	1	Attacks per round	X
dp:	#	0	Dancing proficiency adjustment	X
ch:	1 - 20	20	Critical Hit roll value	X
cm:	1 - 20	1	Critical Miss roll value	X
sz:	[ t / s / m / l / h ]	\'\'	Size of item	X		X			X
r:	[# /] # / # / #	\'\'	Range	X			X
r:	[+/-]# [ / [+/-]# / [+/-]# / [+/-]# ]	0	Range Modifier	X
ty:	SPB any combination	\'\'	Type of damage	X
sp:	[-]#	0	Speed in segments (1/10 round)	X				X
sm:	dice roll format	0	Damage roll for Small & Medium opponents		X	X
l:	dice roll format	0	Damage roll for Large & Huge opponents		X	X
ac:	[-]#	\'\'	Armour class						X
wt:	#	1	Weight of item in lbs	X					X
ns:	#	0	Number of spells & powers defined for item					X	X
cl:	MU / PR / PW	\'\'	Type of spell or power					X
lv:	#	1	Level at which spell/power is cast					X
pd:	-1 / #	1	Number per day (power only)					X
rc:	Charged / Uncharged / Rechargeable / Recharging / Self-charging / Cursed / Charged-Cursed / Recharging-Cursed / Self-charging-Cursed	Uncharged	Initial charged and Cursed status of item when found	X					X

Character Sheet data fields

As stated in section 7, the Character Sheet field mapping to the API script can be altered using the definition of the fields object. You can find the complete mapping for all APIs in the RPGMaster series, with an explanation of each, in a separate document.

Changelog

v1.040 (2022-02-02)

• Added --config command and menu for DM to alter some API behavior.
• Multiple weapon changes and additions

v1.039 (2022-01-23)

• Fixed Spear definition for self-ammo-ed ranged weapon & added powerful-longsword
• Fixed illegal characters not rendered by One-Click install
• Added Bow mastery to do double damage at PB range (removed from specialist)

v1.038 (2022-01-09)

• Improved Indexing & Performance
• Changed data tags to reflect newest standard
• Fixed bug relating to AC0 when calculating AC
• Added magically summoned weapons (e.g. Mordenkainen's Sword) for new spells

v1.037 (2021-12-14)

• First version for public release