Skip to content
Companion API script for the Pathfinder Character Sheet
Branch: Development
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Prototype 0.03
Prototype 0.04
Prototype 0.05
Prototype 0.06
Prototype 0.061
Prototype 0.062
Prototype 0.07
Prototype 0.075
Prototype 0.076
Prototype 0.077
Prototype 0.078
Prototype 0.079
Prototype 0.080
Prototype 0.081
Prototype 0.082
Prototype 0.083
Prototype 0.084
Prototype 0.085
Prototype 0.086
Prototype 0.087
Prototype 0.088
Prototype 0.089
Prototype 0.1
Prototype 0.11
Prototype 0.12
Prototype 0.13
Prototype 0.14
Prototype 0.15
Prototype 0.16
Prototype 0.17
Prototype 0.20
Prototype 0.21
V1.01511665715
LICENSE
README.md

README.md

THIS IS STILL BETA SO USE ON A COPY OF YOUR CAMPAIGN OR CHARACTERS. The API can access multiple characters at once so it is best to backup first.

NOTE* This version requires the PathMath script available from the one-click Drop-down

To start up type: !pfc --help

To access the menu type: !pfc --config

Known issues

  1. Applying buffs/conditions: the buff or condition is activated, but we are still working on getting a given effect to fully propagate throughout the sheet
  2. Statblock parsing:
    1. DO NOT attempt to parse Lucifer, Prince of Darkness from pfsrd. He is just too large, and will almost certainly crash your script environment by triggering an infinite loop error.
    2. While the script supports importing of multiple statblocks with a single command, limit how many creatures you import at a given time as the time it takes to import increases non-linearly (especially if they cast spells).
  3. I would recommend waiting to install the script until I upload the next version of the beta as some of the syntax for how resource tracking is handled will be changed.

For more detailed instructions and macro examples, see the User's Manual

Companion API Script vPrototype 0.085

Configuration Options

  1. Automatically create token actions for macro menus: Enabling this will automatically create the indicated abilities for all PCs and NPCs as they are created or made into NPCs. Enabling the setting adds a menu where you can specify what menus should be created for all characters categorized by PC or NPC.
  2. Automatic Resource Tracking: Will create handling for automatically tracking ammo for weapons and spell, ability, and item usages.
  3. Automatically handle HP changes: Enabling this will autodeduct damage from temporary hp before affecting HP. It will also prevent healing from occurring beyond the max HP of a character.
  4. Maintain PC default tokens: Enabling this option will bring up a table to set what attribute (by case insensitive name) each bar should link to and whether that bar should be visible to players or not. Having this option turned on will also update the default token of a character whenever there is a change made to that character (excluding movement and var value/max changes). NOTE: With this setting enabled, setting a token to represent a character will update the bar links and values to be synced appropriately. This will not be reflected in the token setup pop-up until you reload the menu. Exit the menu by hitting "CANCEL" (NOT "APPLY") and your token will be set as the default token for that character and setup as per the settings in the config menu.
  5. Apply Condition/Buff statusmarkers: Enabling this will apply the appropriate statusmarker to all tokens representing the buffed/conditioned character if that character is controlled by at least one player. You can designate statusmarkers to use for buffs on a per character basis by using the !pfc --buffstatus command while you have a single token selected or by passing a single character id after (e.g. !pfc --buffstatus|@{Jord Strongbow|character_id}. NOTE this setting will not work correctly unless Maintain PC default tokens is enabled

Current macro setup, auto attribute handling and command syntax:

Automatic Attribute Handling

  1. HP & Temp HP: If this option is enabled in the config menu health deducted from a character's HP will be deducted from their temp hp first before being applied to their HP. Note this will not work with API applied HP changes (other than those caused by this script).

Macro Setup

  1. Weapons: Weapons can be setup to track ammo usage (according to # of attacks used, including usage of manyshot), other item usage, spell usage, ability usage, and custom attribute usage.
  2. Ammo Tracking: Setting the ammo field of a weapon to anything besides 1 tells the script that that weapon uses ammo. The script willgenerate the following field in the macro text of the weapon: ||ammo=?{Name of Ammunition Item}||. After the first time you answer this query, it will be replaced with your response.You can also manually put a different query in here to be prompted for what ammunition to use with each attack routine.
  3. Spell or Ability Tracking: If a weapon is linked to a spell or ability (that has uses), an additional roll template field will be added to the macro that will display a button to outputthe spell card as well as buttons to increment, decrement, or custom adjust the number of spells used.
  4. Spells: A field similar to that for weapons linked to a spell will be added to all spells. Abilities: A field similar to that for weapons linked to an ability will be added to all abilities that have uses. custom attribute: Entering %%What you named the custom attribute%% into the description field (notes field for weapons) will cause the script to put a field similar to the spell or ability to allow you to adjust the quantity of it. This will only be created for those custom attributes that have a current/max comparison. This can also be used to add fields for spells,abilities, or items without having to directly edit the macro text.

Command syntax

  1. Item tracking: !pfc --resource,item=Item Name,current=max OR +/-X OR X,max=+/-X OR X|characterid|characterid|...
  2. Ability tracking: !pfc --resource,ability=Ability Name,current=max OR +/-X OR X|characterid|characterid|...
  3. Spell tracking: !pfc --resource,spell=Spell Name,current=max OR +/-X OR X|characterid|characterid|...
  4. Custom Attribute tracking: !pfc --resource,note=Custom Attribute Name,current=max OR +/-X OR X|characterid|characterid|...
  5. Whisper Adjusting: !pfc --whisper,npc=public/private/swap,pc=public/private/swap,stats=public/private/swap|characerid|characterid|...
  6. Access the Config Menu: !pfc --config
  7. Apply/Remove Buffs Conditions: !pfc --apply,condition=all or part of a condtion name,buff=all or part of a buff name that has already been setup on the character,remove/swap|characterid|characterid|...
  8. Import Statblock: !pfc --parse|characterid|characterid|characterid| OR !pfc --parse|{{statblock NEWCREATURE statblock NEW CREATURE ...}} Copy your statblock (pure text only - copy into a text editor first to clean off formatting) into the gmnotes of a fresh character or directly via chat, and then run the command. I have only tested the parser on pfsrd statblocks (and not many of those) so far, and hope to overcome the issues preventing multiple statblocks from being imported at once, as well as hopefully eventually allowing statblocks to be imported from chat.
  9. Buff statusmarker wizard: !pfc --buffstatus|characterid The characterid is optional if you have a token representing a character selected. The command only works on a single character; having more than one token selected or passing more than one character id will only act on the first character in the list (this is unpredictable when using selected tokens).
You can’t perform that action at this time.