A module for the Foundry VTT Pathfinder 2e system that provides helper effects and macros for ranged combat.
This module is built for the Pathfinder 2e system, which receives regular updates, and some of those updates may occassionally break the functionality of this module. I will do my best to fix issues caused by updates, but this may require losing support for earlier versions of the system.
Also, some parts of this module may require features/functions from the latest release of the Pathfinder 2e system.
In summary, each release of this module only officially supports the latest release of the Pathfinder 2e system at the time of release, which will be listed in the Changelog. If you encounter an issue, please make sure you're using the latest system version. If the issue persists on the most recent version, please report it!
When you have a reloadable weapon (e.g. reload 1 or higher), you can use the Reload macro to reload your weapon, and give yourself the Loaded effect showing that the weapon is loaded. If you have the feats, this also applies the effects of Crossbow Ace and Crossbow Crack Shot. Firing the weapon removes the Loaded effect.
You can also use the Reload NPCs macro to reload all NPCs on the scene. This will reload all the NPCs' weapons (if required) as long as no further input is required, such as selecting ammunition.
If Prevent Firing Weapon if not Loaded is enabled (default: true) in the module settings, then you must reload weapons before you can fire them.
Capacity and Double Barrel (e.g. Pepperbox and Double-Barreled Musket)
Weapons with the capacity or double barrel trait can be loaded and fired much like other reloadable weapons, but they can be loaded with more than one round, up to their capacity (2 for double barrel).
If Prevent Firing Weapon if not Loaded is enabled, then you must also have the Chamber Loaded effect to fire a capacity weapon. You can use either the Next Chamber macro to switch to a loaded chamber (if the weapon is already loaded with at least one round) or the Reload macro to load a new round. You can fire a double barrel weapon as long as at least one barrel is loaded.
You can use the Fire Both Barrels macro to switch to firing both barrels of weapons with the double barrel trait, to deal increased damage. While you have this enabled, you must have both barrels loaded to fire double-barreled weapons.
The Loaded effect targets a specific weapon and serves as a reminder that the weapon is loaded. This effect is removed if the weapon is fired and, optionally, the weapon cannot be fired if it isn't loaded.
The Crossbow Ace and Crossbow Crack Shot effects apply the feat effects and can be applied to a particular crossbow.
- Note: You do not need to use the "Reloaded crossbow or Hunted Prey" toggle when using these effects.
- Note: You must remove the effects manually once you've made your damage roll.
This advanced version of the reloading system handles ammunition management for reloadable and repeating weapons. A Game Master can enable this in the module settings (default: disabled). This feature is currently implemented only for PCs.
With the Advanced Ammunition System, there are a few changes that affect all weapons that use ammunition:
- You must have selected ammunition to use the weapon.
- When the last piece of ammunition in a stack is consumed, the quantity of the stack is reduced to 0 instead of being deleted.
How the rest of the system works depends on the type of weapon:
Reload 0 (e.g. Longbow)
You don't need to do anything to prepare to fire the weapon. The selected ammunition is consumed when you make the attack roll.
Reload 1+ (e.g. Crossbow)
You must reload the weapon using the Reload macro before you can fire. The selected ammunition is consumed when you reload the weapon, and the Loaded effect will specify what ammunition is loaded.
If you change the weapon's selected ammunition and use the Reload macro again, the loaded ammunition will be put back in your inventory and the new ammunition loaded.
You can also use the Unload macro to remove the loaded ammunition from the weapon and put it back in your inventory.
Repeating (e.g. Repeating Crossbow)
Repeating weapons work similarly to reloadable weapons, except you use the Reload Magazine to load a magazine, creating the Magazine Loaded effect.
The Magazine Loaded effect works similarly to the Loaded effect, except the effect also tracks the number of rounds remaining in the magazine. Ammunition is consumed from the magazine when you fire the weapon. When the magazine is empty, it remains loaded (representing the need to remove the existing magazine before replacing it with a new one) but you cannot fire the weapon while the magazine is empty.
You can also use the Reload Magazine macro while a magazine is already loaded:
- If you've changed the weapon's selected ammunition, the new magazine will be loaded. If the current magazine had any remaining ammunition, it is put back in your inventory.
- If the weapon's selected ammunition is the same as the loaded magazine, it will only be swapped if reloading will change the remaining ammunition in the magazine.
You can use the Unload macro to just remove the loaded magazine and, if it still has ammunition remaining, put it back in your inventory.
When a magazine with remaining (but not full) ammunition is removed from a weapon, it creates a new item in your inventory with one magazine with that amount of ammunition remaining. This can create a number of separate items all for the same type of ammunition. You can use the Consolidate Repeating Weapon Ammunition macro to tidy your inventory. This gathers up all the repeating ammunition of each type you have and creates as many full magazines as possible in one stack, and one extra magazine (in a separate stack) with any remaining ammunition left over.
Repeating and Reload 1+ (e.g. Repeating Heavy Crossbow)
Repeating weapons that still require reloading work almost identically to other repeating weapons, with the extra step that you must use the Reload macro before firing each shot. The ammunition is still only consumed when you fire the weapon. Using the Unload macro will also remove the Loaded effect.
The Hunt Prey macro applies the Hunted Prey effect to your character, with the name of your current target, as a reminder of who your hunted prey is. It also applies the Crossbow Ace effect for your equipped crossbow(s) if you have the feat.
While you have a hunted prey, the "Hunted Prey" toggle will automatically be enabled while you have your prey (and only your prey) targeted.
You can use the Load Alchemical Crossbow macro to load a lesser alchemical bomb into an Alchemical Crossbow. This will give your weapon the Loaded Bomb effect, granting an additional 1d6 damage (type depending on the loaded bomb) for the next three shots. As per the Alchemical Crossbow's description, once the first shot has been fired, you have only one minute to fire the remaining shots or they are wasted.
You can use the Unload Alchemical Crossbow macro to unload the bomb from your Alchemical Crossbow. If you haven't fired the crossbow since loading the bomb, you'll get it back in your inventory, but if you've used at least one use, the remaining uses will be wasted.
You can use the Alchemical Shot macro to pour an alchemical bomb into a firearm or crossbow. This will give your weapon the Alchemical Shot effect, changing its damage type, and adding persistent damage to its damage rolls. It will also add a roll note to the weapon's attack rolls in case of a failure, informing you to take damage. The effect will be removed upon the end of your turn or firing another shot with that weapon.
This enhancement to thrown weapons handles the management of which weapons are worn, held, and dropped. A Game Master can enable or disable this system in the module settings (default: disabled). This feature is currently implemented only for PCs.
With the Advanced Thrown Weapon system, thrown weapons are treated as individual items even if they're part of the same stack. For example, if you have three throwing daggers in a stack which is set as "worn", drawing the weapon will instead create a new stack with one throwing dagger and set that one as held. The other two will remain in the original stack as "worn". This is the same for dropping, sheathing, stowing etc. Empty stacks are then removed.
When you attack with a thrown weapon, the weapon will be added to a "dropped" stack, however the original "held" stack will still be kept, even if it's empty. This is so the damage buttons are still usable, but you won't be able to roll another attack until you've drawn or picked up another one.
You can use the NPC Weapon Configuration macro with an NPC selected to map their attacks onto weapons and ammunition in their inventory, and enable the Advanced Ammunition and Thrown Weapon Systems for that NPC. Assigning ammunition to an attack will cause the ammunition to be consumed when fired, and enabling the Advanced Ammunition System or Advanced Thrown Weapon System will allow the NPC to take full advantage of the features detailed above.
For NPCs which will have tokens which are not linked to their actor, open their character sheet from the Actors directory and configure their weapons before placing the tokens. The tokens will inherit the configuration from the actor and can then be tweaked as necessary by selecting the token and using the NPC Weapon Configuration macro again.
These are the settings available for the module (all world-scope).
If enabled, the action represented used by a macro is posted to chat, as well as the summary of what happened. If disabled, the summary is still posted.
If enabled, when you fire a weapon while using non-standard ammunition, the ammunition item will be posted to chat instead of the compact "X has used Y" message.
If enabled, weapons with a reload entry (or reload trait, for NPCs) cannot be fired unless they're loaded.
Enable the Advanced Ammunition System, as described above, for PCs.
Enable the Advanced Thrown Weapon System, as described above, for PCs.
When the module generates a message for an action being performed (e.g. reload, hunt prey etc), the message will only appear for uses with at least the permission level set here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent