Skip to content

Commit

Permalink
SWB update
Browse files Browse the repository at this point in the history
  • Loading branch information
trioderegion authored Jul 4, 2022
1 parent c299902 commit 084b004
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
# Item Macro

This is a FoundryVTT module for the 5e, SFRPG, SWADE, Old-School Essentials, and Dungeon World (as of now) systems. It allow macros to be saved inside of an item and for various different ways to execute macros.
This is a FoundryVTT module for the **5e, SFRPG, SWADE, Old-School Essentials, Dungeon World, and Simple Worldbuilding (as of now) systems. It allow macros to be saved inside of an item and for various different ways to execute macros.
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.

# Known Issues

Token Action Hud may experience some problems with the update.
Midi-QOL should be fine with the update.
Tidy Sheets Favorite tab will not work with this update.

# Installation

1. Inside Foundry's Configuration and Setup screen, go to **Add-on Modules**
Expand Down Expand Up @@ -37,9 +31,18 @@ Added context menu support allowing GM users to mass update item-macros on like
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.

## Added System Functionality

### Simple Worldbuilding

* Item names on actor sheets have been converted to rollable links that will execute the macro attached to the item when the "Enable Character Sheet Hook" is enabled.
* Item names will now highlight on hover to indicate this added functionality.
* Dragging an item to the hotbar will create a macro utilizing an added system helper `game.worldbuilding.rollItemMacro(itemNameString)`.
* Dropping formula-type item attributes will continue to create the default `new Roll` system macro.

# Support

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

# License

Expand Down

0 comments on commit 084b004

Please sign in to comment.