Use the file link provided in our patreon page for the month offered to our miraculous tier patrons and paste it into the mod installer page for Foundry Setup.
Once installed, Open your world and enable the module. At time of writing this module has no dependencies.
Once enabled, find the Example Animation Macros compendium in your compendium list and right click, before clicking Import all Content. Hit yes at the prompt.
The compendiums can be easily imported by dragging actors onto the field from them. Legacy or Stat-L actors do not support any other images than what is currently included in the actors (some have WC for wildcard which means multiple images per actor).
The macros are simple time code reading scripts meant to play back an animation, wait x time and then change the image again. We currently have macros for attack actions and knockout animations.
Any TD Anim Actor supports attacks. In the macro directory you will find multiple ParsedAnimation-Attack macros. These are using Search strings to lookup which attack to use based on the name, and each animation video file has Attack1/2/3 in its name along with a timecode to tell how long to play for. If you use the attack macro without a number, it will pick a random one available in the same folder as the idle animation.
The ParsedAnimation-KO Macro will do similar to the attack macro, finding a death animation + static pose in the same folder as the default image if applicable, and then playback the animation before switching to the static dead image (TD Stat actors have just the static image). If you need to undo this animation/switch, just select the token and use the Undo-KO macro to reset the image state.
If you want your creatures actions to drive the animation macro triggers, we currently have set up all actors to support MidiQOL's macro call on use feature.
To enable:
Now if you edit an action for any TD Anim actor, you will see under the details tab a new field called On Use Macro, which will have the assigned macro to trigger the best matching animation if applicable.
All of our TD Anim actors support a knockout/death animation to a static death frame. Our TD Stat actors also support a static death frame as well with the same macros. We recommend using Combat Utility Belt with Triggler at this time.
To Enable:
You can test easily with any Character mentioned above by setting the token HP to 0 and watch it trigger. If a creature has a fortitude effect and you wish to undo the animation and go back to the idle state, use the Undo-KO macro to fix the HP to 1 and the token image back to original.
We are constantly working on improving your experience. If you have any issues or feedback please reach out to us on discord!
🍻 Cheers! 🍻 Thorsten & Kelanel - Team Vivid