Package Description

VTT Hook Macros

Advanced Scripting Module

This module allows you to set macros to run when a particular Hook is sent by Foundry VTT. The hook that acts as a trigger and which macro to use can be configured using a Journal Entry.


Create a journal with the name you put in the module settings. (default: Hook Macros)

Then in that journal you can add hooks that you want to trigger macros.

The general input method is:

@Hook[hook name] @Macro[macro name]

      The hooks and macro names are case sensitive.

You can have more than one macro on a line, for the same hook, but you can't put multiple hooks on the same line.
ᵐᵘˡᵗⁱᵖˡᵉ ʰᵒᵒᵏˢ ᵒⁿ ᵒⁿᵉ ˡⁱⁿᵉ ᶜᵃⁿ ᶜᵃᵘˢᵉ ʲᵒᵘʳⁿᵃˡ ᶜᵒʳʳᵘᵖᵗⁱᵒⁿ

Optionally, if you type @Macro[macro name](arg1,arg2 ,arg3) you can use args from The Furnace

If you don't know what hook you need, The Furnace has a handy option that allows you to enable debugging. Which will show hooks in the console when they are called. Open the console with ctrl + shift + i or F12

Things to watch out for

Don't create macros that run from the chat hook and create chat messages that take more than 1 seconds to output to chat.

Known non-functional hooks

  • init

Known issues

  • Firefox 77 doesn't support regex lookbehinds and doesn't function as such, please use Firefox Beta 78, or wait until June 30th 2020 for it to release.


Check the Changelog

If you acidentally created a macro that locks you out of the game. You can fix it by holding the END key while logging into your world. This makes the module not run any macros.

Tagged Categories

  1. Automation Enhancers

Available Versions

  1. Version 1.1.0

  2. Version 1.2.0

  3. Version 1.2.1

  4. Version 1.3.1

  5. Version 1.3.2

  6. Version 1.3.3

  7. Version 2.0.0

  8. Version 2.0.1

  9. Version 2.0.2