Skip to content

Akisame-AI/plutonium-addon-automation

 
 

Repository files navigation

Plutonium Addon: Automation

Plutonium Addon: Automation is a module to extend Plutonium, for the purpose of marrying the importation of D&D 5e game material with the automation provided by the 'Midi ecosystem'.


How it works

Plutonium Addon: Automation runs invisibly and mostly silently.

While the module is activated in your world, each time Plutonium imports something, it'll check to see if any automation data is set for that thing. If there is, it will import the item with that data. If not, it will import using the Plutonium standard, filling out fields as a reasonable guess.

As with Plutonium, all data is included in the module itself. There's no need to import everything prematurely, 'just in case'.

Some effects don't use effects directly, but rather call hidden macros. To view/edit these macros, install and activate Item Macro.

Dependencies and incompatibilities

Besides Plutonium itself, Plutonium Addon: Automation requires:

Some specific items require other modules. You will only be prompted to install/activate these modules if you import an item that requires it.

As above, Plutonium Addon: Automation is designed for the extensive automation provided 'Midi ecosystem' and, as such, isn't designed for modules such as MARS 5e, MRE 5e, and Better Rolls. Using them may cause problems. Also, we don't recommend using this with Combat Utility Belt.

Required set-up

You can install the module using the following manifest url:

https://github.com/TheGiddyLimit/plutonium-addon-automation/releases/latest/download/module.json

You must configure some modules in a specific way, or the automation won't work. Configure the following:

  • DFreds Convenient Effects > Modify Status Effects — select either Replace (preferred) or Add.
  • Midi QoL > Midi QoL config > Workflow > Apply Convenient Effects — select Apply Item effects, if absent apply CE.

If you have Item Macro active, you also need to configure it as follows:

  • Item Macro > Override default macro execution — uncheck this.
  • Item Macro > Character Sheet Hook — uncheck this.
  • (If installed) Token Action HUD > Item-Macro: item macro, original item, or both — select Show the original item. (Note this is a user setting, so ensure that each user does this or use a module such as Force Client Settings to guarantee it.)

Contributing

Please see CONTRIBUTING.md. See also the tools page.

About

An interoperability addon which makes Plutonium play nice with automation modules.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 93.9%
  • Handlebars 4.9%
  • Shell 1.2%