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'.
- Disclaimer
- How it works
- Installation
- Dependencies and incompatibilities
- Required set-up (
⚠️ read this!) - Optional integrations
- Contributing
Plutonium Addon: Automation is not supported by any of the modules listed below. If you encounter an issue in your game, disable Plutonium and Plutonium Addon: Automation and try again. If an issue persists, consider raising an issue or asking about it in our Discord server before bringing it to the attention of other module authors.
Warning
Some places discourage discussion of Plutonium and Plutonium Addon: Automation. Be aware of any rules before mentioning these modules outside this repo and our Discord server.
Plutonium Addon: Automation runs invisibly and (mostly) silently.
While the module is activated in your world, each time Plutonium would import a document, it will check if any automation data is available for that document. If so, it will import the document with the additional automation data included. If not, it will import the document as if Plutonium Addon: Automation were not enabled (although sometimes slightly and non-destructively tweaked for better compatibility with the modules below).
Some automations don't use effects directly, but rather call item macros. If you, as the GM, wish to allow players to view/edit macros on items they own, install Item Macro and configure it to allow the Player access option.
Tip
There's no need to import everything prematurely, 'just in case'. As with Plutonium, all data is included in the module itself, and, if you use any module integrations, you'll be missing out on updates from them.
You can install the module using the following manifest URL:
https://github.com/TheGiddyLimit/plutonium-addon-automation/releases/latest/download/module.json
Besides Plutonium itself, Plutonium Addon: Automation requires:
- DFred's Convenient Effects (DFCE)
- Dynamic Active Effects (DAE)
- Midi QoL
- Times Up
Some specific automations require one or more additional modules:
If you import a document which requires one of these modules, you will be prompted to install/activate it. The automation is highly unlikely to function as intended if you use it before activating the module.
Caution
Plutonium Addon: Automation is designed for the extensive automation provided by the 'Midi ecosystem' and, as such, isn't designed for modules such as Whistler's Item Rolls Extended or Ready Set Roll for D&D5e. Using either of these may cause problems.
You must configure some modules in a specific way, or the automations won't work. Configure the following:
- DFreds Convenient Effects > Modify Status Effects — select either
Replace(preferred) orAdd. - Midi QoL > Midi QoL config > Workflow > Apply Convenient Effects — select
Apply Item effects, if absent apply CE.
If you have Item Macro activated, 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 either ensure that each user configures this or use a module such as Force Client Settings to guarantee it. Also note that this is not required if you use the system-specific Token Action HUD Core and Token Action HUD D&D 5e modules.)
Plutonium Addon: Automation can make use of data provided by other modules to provide better automations for more documents. An integration is available for:
This integration is only active if the above module is installed and active, and can be disabled in Plutonium Addon: Automation's settings.
Please see CONTRIBUTING.md.