Register

Item Macro

An Add-on Module for Foundry Virtual Tabletop

Author: Forien Project Source: Project URL Versions 11+ (Verified 11.315) Last Updated 2 months, 2 weeks ago

Discord Patreon Ko-Fi

This FoundryVTT module allows macros to be saved inside of an item and for various different ways to execute them.  

You can execute the macro from the "item" class using the executeMacro(...args) function, from the character sheet (if the settings are satisfied to do so), from the hotbar using the default rollItemMacro function for your system (if the settings are satisfied to do so), or from token-action-hud.

List of supported systems

Please note that if your system is not on this list, you can still save and run macros on the item and you can use all API functions to access and execute those macros programatically!

Usage

Once activated, open an Item Sheet, click on the Item Macro button to open the Macro window.

In Action

Various different settings will change the way Item Macro interacts with the game server.

In Action

With no settings enabled, you can still execute the macro that is saved in the item, perfect for macros!

In Action

Added context menu support allowing GM users to mass update item-macros on like named items throughout the game! (the context menu is on items in the game directory, will update all item-macros in the item-directory, actor items, and token items)

Added Item Functionality

  1. Item.hasMacro() => returns boolean on if the item has a macro command
  2. Item.getMacro() => returns Macro instance, if the item has a macro command
  3. Item.setMacro(Macro) => overwrites and saves given Macro to the Item
  4. Item.executeMacro(...args) => executes Macro command, giving item, speaker, actor, token, character, and event constants. This is recognized as the macro itself. Pass an event as the first argument.

Contact

For questions, feature requests, or bug reports, feel free to contact me on the Foundry Discord (forien) or open an issue here directly.

You are also welcome to join my Discord where you can talk about this and other Foundry modules.

Support

If you wish to support module's development, please consider becoming my Patreon or donating through Paypal or Ko-Fi. Thanks!

Acknowledgements

Supported Game Systems

  1. Dungeons & Dragons Fifth Edition

    Latest Version: Version 3.1.2 Last Updated 4 days ago
  2. Savage Worlds Adventure Edition

    Latest Version: Version 3.3.11 Last Updated 2 weeks ago
  3. Old-School Essentials

    Latest Version: Version 1.10.2 Last Updated 2 weeks, 5 days ago
  4. Dungeon World

    Latest Version: Version 1.7.2 Last Updated 1 month ago
  5. Warhammer Fantasy Roleplay 4th Edition

    Latest Version: Version 7.0.3 Last Updated 5 months, 2 weeks ago
  6. Starfinder

    Latest Version: Version v0.25.2 Last Updated 8 months, 1 week ago
  7. Simple Worldbuilding System

    Latest Version: Version 0.8.2 Last Updated 10 months, 1 week ago

Categories

Available Versions

  1. Version 1.11.1

    2 months, 2 weeks ago
    Foundry Version 11+ (Verified 11.315) Manifest URL Read Notes
  2. Version 1.11.0

    2 months, 2 weeks ago
    Foundry Version 11+ (Verified 11.315) Manifest URL Read Notes
  3. Version 1.10.5

    4 months ago
    Foundry Version 11+ (Verified 11.315) Manifest URL Read Notes
  4. Version 1.10.4

    4 months ago
    Foundry Version 11+ (Verified 11.315) Manifest URL Read Notes
  5. Version 1.10.3

    4 months, 3 weeks ago
    Foundry Version 11+ (Verified 11.308) Manifest URL Read Notes
  6. Version 1.10.2

    5 months, 3 weeks ago
    Foundry Version 11+ (Verified 11.308) Manifest URL Read Notes
  7. Version 1.10.0

    Foundry Version 11+ (Verified 11.308) Manifest URL Read Notes
  8. Version 1.8.0

    Foundry Version 0.8.0 - 10 (Verified 10) Manifest URL Read Notes
  9. Version 1.7.4

    Foundry Version 0.8.0 - 10 (Verified 10) Manifest URL Read Notes
  10. Version 1.6.0

    Foundry Version 0.8.8 - 10 (Verified 9) Manifest URL Read Notes
  11. Version 1.5.6

    Foundry Version 0.8.8 - 10 (Verified 0.8.9) Manifest URL Read Notes
  12. Version 1.5.5

    Foundry Version 0.8.8 - 10 (Verified 0.8.8) Manifest URL Read Notes
  13. Version 1.5.4

    Foundry Version 0.8.8 - 10 (Verified 0.8.8) Manifest URL Read Notes
  14. Version 1.5.3

    Foundry Version 0.8.0 - 10 (Verified 0.8.6) Manifest URL Read Notes