This is a FoundryVTT module that allows macros to be saved inside of a note. The note can then be executed by hovering over the note and [Shift, Alt, Ctrl] Clicking the note. You can execute the macro from the "noteDocument" class using the executeMacro(...args) function, from the note-macros macro window, or by [Shift, Alt, Ctrl] clicking the note.
None known.
- Inside Foundry's Configuration and Setup screen, go to Add-on Modules
- Click "Install Module"
- Seach for the Module, install in the Module Manager.
- (OR) In the Manifest URL field paste:
https://github.com/Kekilla0/Note-Macro/raw/master/module.json
Once activated, open an Tile Configuration Window, click on the Note Macro button to open the Macro window.
Various different settings will change the way Tile Macro interacts with the game.
With a simple [Shift, Alt, Ctrl] click, execute the macro directly from the canvas!
The following variables are available
note - The note placeable the macro is bound to
journal - The respective journal of the note
speaker - Return of ChatMessage.getSpeaker()
actor - The actor associated with the speaker
token - The token associated with the speaker
character - The executing user's character
- TileDocument.hasMacro() => returns boolean on if the note has a macro command
- TileDocument.getMacro() => returns Macro instance, if the note has a macro command
- TileDocument.setMacro(Macro) => overwrites and saves given Macro to the note
- TileDocument.executeMacro(...args) => executes Macro command, giving note, macro, speaker, actor, token, character, and event constants. Pass an event as the first argument.
For questions, feature requests, or bug reports, feel free to contact me on the Foundry Discord (Kekilla#7036) or open an issue here directly.
This Foundry VTT module, written by Kekilla, is licensed under Mit License
This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development.