Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Add some callout boxes for ✨ visibility ✨
- Remove a couple of module references because they're now years old and no one still even thinking about using them should be allowed access to dnd5e v3.0.x
- Miscellaneous touch-ups because I'm a perfectionist
  • Loading branch information
Spappz authored Mar 16, 2024
1 parent 673fe30 commit aad2790
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@

## Disclaimer

*Plutonium Addon: Automation* is **NOT** supported by any of the modules listed below. If you encounter an issue with your game, disable *Plutonium* and *Plutonium Addon: Automation* and try again.
*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](https://github.com/TheGiddyLimit/plutonium-addon-automation/issues) or asking about it in our [Discord server](https://discord.gg/5etools) before bringing it to the attention of other module authors.

If an issue persists, consider asking about it in the [Issues section](https://github.com/TheGiddyLimit/plutonium-addon-automation/issues) or in our [Discord](https://discord.gg/5etools) before bringing it to the attention of other module authors.

⚠️ Beware the rules of other spaces when discussing *Plutonium* and/or *Plutonium Addon: Automation* module outwith the above channels! ⚠️
> [!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](https://discord.gg/5etools).
## How it works

*Plutonium Addon: Automation* runs invisibly and mostly silently.
*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 Plutonium standard (although sometimes slightly tweaked to better enable the module dependencies outlined below).
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 standardly for Plutonium (although sometimes slightly and non-destructively tweaked for better compatibility with the modules below).

As with Plutonium, **all data is included in the module itself**. There's no need to import everything prematurely, 'just in case'.
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](https://foundryvtt.com/packages/itemacro) and configure it to allow the _Player access_ option.

Some automations don't use effects directly, but rather call item macros. If you, as the GM, wish to allow players to view/edit these macros on items they own, install and configure [Item Macro](https://foundryvtt.com/packages/itemacro) 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](#optional-integrations), you'll be missing out on updates from them.
## Installation

Expand All @@ -38,7 +38,7 @@ You can install the module using the following manifest URL:

### Dependencies and incompatibilities

Besides Plutonium itself, *Plutonium Addon: Automation* **requires**:
Besides *Plutonium* itself, *Plutonium Addon: Automation* **requires**:
- [DFred's Convenient Effects](https://foundryvtt.com/packages/dfreds-convenient-effects) (DFCE)
- [Dynamic Active Effects](https://foundryvtt.com/packages/dae) (DAE)
- [Midi QoL](https://foundryvtt.com/packages/midi-qol)
Expand All @@ -52,7 +52,8 @@ 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.

*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](https://foundryvtt.com/packages/wire), [Ready Set Roll for D&D5e](https://foundryvtt.com/packages/ready-set-roll-5e), [MRE 5e](https://foundryvtt.com/packages/mre-dnd5e), and [Better Rolls](https://foundryvtt.com/packages/betterrolls5e). Using any of these may cause problems. We also don't recommend using this with [Combat Utility Belt](https://foundryvtt.com/packages/combat-utility-belt).
> [!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](https://foundryvtt.com/packages/wire) or [Ready Set Roll for D&D5e](https://foundryvtt.com/packages/ready-set-roll-5e). Using either of these may cause problems.
### Required set-up

Expand All @@ -65,11 +66,11 @@ If you have [Item Macro](https://foundryvtt.com/packages/itemacro) activated, yo

- _**Item Macro** > Override default macro execution_ — uncheck this.
- _**Item Macro** > Character Sheet Hook_ — uncheck this.
- (If installed) _**[Token Action HUD](https://foundryvtt.com/packages/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](https://foundryvtt.com/packages/force-client-settings) to guarantee it.)
- (If installed) _**[Token Action HUD](https://foundryvtt.com/packages/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](https://foundryvtt.com/packages/force-client-settings) to guarantee it. Also note that this is _not_ required if you use the system-specific [Token Action HUD Core](https://foundryvtt.com/packages/token-action-hud-core) and [Token Action HUD D&D 5e](https://foundryvtt.com/packages/token-action-hud-dnd5e) modules.)

### Optional integrations

*Plutonium Addon: Automation* can optionally make use of data provided by other modules. An integration is available for:
*Plutonium Addon: Automation* can make use of data provided by other modules to provide better automations for more documents. An integration is available for:
- [Chris's Premades](https://foundryvtt.com/packages/chris-premades)
- [Midi SRD](https://foundryvtt.com/packages/midi-srd)

Expand Down

0 comments on commit aad2790

Please sign in to comment.