Difference between revisions of "API:RPGMaster"
From Roll20 Wiki
(→General) |
(→Installation for AD&D 2E) |
||
| Line 54: | Line 54: | ||
==Installation for AD&D 2E== | ==Installation for AD&D 2E== | ||
<p>'''Note:''' It is highly recommended that you create a copy of your campaign before installing these (or any other) APIs, as APIs can cause major issues if not set up correctly or they contain bugs. This also means you can play around with use of the ''RPGMaster'' APIs in a safe environment - just try out all the features which are mostly fully available via easily accessible on-screen buttons. Nothing should break as a result of this (but no guarantees!)</p> | <p>'''Note:''' It is highly recommended that you create a copy of your campaign before installing these (or any other) APIs, as APIs can cause major issues if not set up correctly or they contain bugs. This also means you can play around with use of the ''RPGMaster'' APIs in a safe environment - just try out all the features which are mostly fully available via easily accessible on-screen buttons. Nothing should break as a result of this (but no guarantees!)</p> | ||
| − | <p>1. Load | + | <p>1. Load CommandMaster from the One-Click install menu: this will load all the other relevant APIs, including the ChatSetAttr and Tokenmod APIs which are needed for full operation. Check that all the APIs (or at least the ones you want) have loaded. '''RPGMaster Library AD+D2e must be loaded! Please ensure this is the case!''' If any of them don't load for some reason, they are all also individually available on the One-Click install menu.</p> |
<p>2. Use the command <code>!cmd --initialise</code> which will create a number of ''Player Macros'' visible on the Macro menu (accessed via the "3 bulleted lines" icon at the top of the Chat Window).</p> | <p>2. Use the command <code>!cmd --initialise</code> which will create a number of ''Player Macros'' visible on the Macro menu (accessed via the "3 bulleted lines" icon at the top of the Chat Window).</p> | ||
<p>3. Go to the Player Macro menu described in 2 & tick the boxes for all the macros to appear ''In bar'', and then tick the box for ''Show Macro Quick Bar''. Buttons to access the macros set up will appear on your screen (normally at the bottom of the Roll20 map window).</p> | <p>3. Go to the Player Macro menu described in 2 & tick the boxes for all the macros to appear ''In bar'', and then tick the box for ''Show Macro Quick Bar''. Buttons to access the macros set up will appear on your screen (normally at the bottom of the Roll20 map window).</p> | ||
Revision as of 14:40, 6 October 2022
 | Page Updated: 2022-10-06 |
RPGMaster APIs
The RPGMaster suite of APIs is a set of APIs created primarily for enhancing AD&D 2E gameplay, made by Richard E. The APIs are compatible with the Advanced 2nd Edition character sheet.
Some of the APIs can be used with other sheets.
Forum
RPGMaster APIs for AD&D 2E - old frozen forum thread RPGMaster APIs for AD&D 2E - main forum thread
Contents |
RPGMaster "How To" videos
- RPGMaster Intro video 1 10min (Updated 17-01-22) How to load and initialise the APIs
- RPGMaster Intro video 2 21min Setting up a Token & Character Sheet for use with the APIs
- RPGMaster Intro video 3 12min Introduction to the standard Token Action buttons
- RPGMaster Intro video 4 16min Doing Initiative with RPGMaster APIs
- RPGMaster Intro video 5 22min Attacking with melee & ranged weapons and ammo
- RPGMaster Intro video 6 19min Obtaining & using Magic Items
- RPGMaster Intro video 7 11min Other Actions such as Saving Throws and Light sources
- RPGMaster Intro video 8 25min Setting up Wizards, and casting simple spells
- RPGMaster Intro video 9 23min Setting up Priests, and casting more complex spells
- RPGMaster Intro video 10 19min Even more complex spells with duration and system-wide effects
- RPGMaster Intro video 11 22min Powers and power-like effects
- RPGMaster Intro video 12 23min Spell-Storing & Powerful magic items, use & creation
- RPGMaster Intro video 13 13min Setting up simple Monsters
- RPGMaster Intro video 14 23min Complex Monsters with spells, powers and more than 2 hands
- RPGMaster Intro video 15 17min Introduction to the RPGMaster databases
- RPGMaster Intro video 16 18min A bit more detail about the spells databases and how to create your own Spells
- RPGMaster Intro video 17 30min More detail about the Magic Items databases and how to create your own Items
- RPGMaster Intro video 18 32min The Weapons & Ammo databases and how to create your own Melee & Ranged Weapons and Ammo
APIs
General
These have utility to be used with sheets other than just the Advanced 2nd Edition-sheet
- Script:InitMaster -- currently configured to only use the AD&D2e Character Sheet from Peter B. It uses the Roll Templates defined in that sheet extensively.
- See Configuring the Token and Character Sheet for use with the API-section for use with other sheets. Future development will focus on implementing more generic functionality.
- Script:RoundMaster -- purpose is to extend the functionality of the t Turn Tracker capability. Based on the old TrackerJacker API, extended to support Effect Macros triggered when statuses are added, exist on, or are removed from tokens. Effect Macros are user programmable and can do anything Roll20 or added APIs can do.
- See Effect Database for RoundMaster API for information on Effect Macros, how to create them and their use in-game.
- Script:RPGMaster Library -- Holds all RPG-version specific data, rulesets and processing for the RPGMaster series of APIs, but also provides Roll Templates, Character Sheet table management functions, database management functions and other useful functions that can be used by API authors and others (Roll Templates are usable from macros) that are applicable to unsupported RPGs.
AD&D 2E only
- Script:AttackMaster -- provides functions to manage weapons, armour & shields, including taking weapons in hand and using them to attack. It uses standard AD&D 2e rules to the full extent
- Script:CommandMaster -- It manages the initialisation of a Campaign to use the RPGMaster APIs, communication and command syntax updates between the APIs and, most importantly for the DM, easy menu-driven setup of Tokens and Character Sheets to work with the APIs.
- Script:MagicMaster -- provides functions to manage all types of magic, including Wizard & Priest spell use and effects; Character, NPC & Monster Powers; and discovery, looting, use and cursing of Magic Items.
- Script:MoneyMaster
Databases
- API:RPGMaster-CharacterSheets - RPGMaster Character Sheet setup Wiki page
- API:RPGMaster-ClassDB - RPGMaster Class database Wiki page
- API:RPGMaster-AttacksDB - RPGMaster Attacks database Wiki page
- API:RPGMaster-WeaponsArmorDB - RPGMaster Weapon, Ammo & Armour databases Wiki page
Installation for AD&D 2E
Note: It is highly recommended that you create a copy of your campaign before installing these (or any other) APIs, as APIs can cause major issues if not set up correctly or they contain bugs. This also means you can play around with use of the RPGMaster APIs in a safe environment - just try out all the features which are mostly fully available via easily accessible on-screen buttons. Nothing should break as a result of this (but no guarantees!)
1. Load CommandMaster from the One-Click install menu: this will load all the other relevant APIs, including the ChatSetAttr and Tokenmod APIs which are needed for full operation. Check that all the APIs (or at least the ones you want) have loaded. RPGMaster Library AD+D2e must be loaded! Please ensure this is the case! If any of them don't load for some reason, they are all also individually available on the One-Click install menu.
2. Use the command !cmd --initialise which will create a number of Player Macros visible on the Macro menu (accessed via the "3 bulleted lines" icon at the top of the Chat Window).
3. Go to the Player Macro menu described in 2 & tick the boxes for all the macros to appear In bar, and then tick the box for Show Macro Quick Bar. Buttons to access the macros set up will appear on your screen (normally at the bottom of the Roll20 map window).
4. Select one or more tokens on the map window that represent Characters, NPCs or Monsters and select the Token-Setup button. A menu will appear in the Chat Window showing stuff that can be done with the tokens and their linked character sheets to set them up for use with the RPGMaster APIs.
5. Add Magic Items, Weapons, Armour and more to the Character Sheets represented by the selected tokens using the Add-Items button. These items are different from just listing them on the sheet, as they are active and many actually have effects in-game when used, such as setting attack and damage bonuses for set durations, speeding up or slowing down Initiatives rolled (i.e. Haste & Slow effects), granting Powers and storing Spells, etc.
Related Pages
- Advanced 2nd Edition -character sheet
- API:Script Index
