Getting Started - chrisk123999/chris-premades GitHub Wiki

Getting Started with Cauldron of Plentiful Resources for First-Time Users

Installing Dependencies

FoundryVTT should automatically ask if you want to install any missing dependencies when you install Cauldron of Plentiful Resources for the first time. However, sometimes modules fail to install or are for a newer version of the D&D System or FoundryVTT than Cauldron of Plentiful Resources supports. A list of required dependencies and their minimum versions can be found here.

This is the most common issue with enabling the module

Dependency Settings

Midi-QOL:

  • Roll Automation Support: true main settings
  • Apply Convenient Effects: Apply Item effects, if absent, apply CE workflow settings -> workflow tab -> specials
  • Merge Rolls to one card: true workflow settings -> misc tab
  • Auto roll damage: Always OR Damage Roll Needed workflow settings -> gm tab AND player tab

Workflow Settings -> QuickSettings -> Full Automation: As few button presses as possible is a good start

Dynamic effects using Active Effects (DAE):

  • Display results of inline rolls: true This setting is STRONGLY recommended so that features that use DAE's inline rolling will actually display

Once you have your settings ready, check the home page of the CPR wiki for information on how the module functions. For more information of CPR's own settings, see CPR's settings

How to use the Module

For Individual Items

The easiest way to use a CPR automation on an individual item is to go through the item's Medkit. The first time and item is "Medkitted", it's name must be an exact match to the item in CPR's compendiums. This means the name must be in English, spelled correctly, and using the name as formatted by DDBI. Some items vary between the included SRD compendiums and DDBI's importing of items. CPR's items go off the DDBI imported names.

UnmedkittedItemTitlebar

This item has a yellow-colored Medkit because there is an automation available to apply. Clicking it will show the item Medkit, with a dropdown to select available automations matching the item's name. Clicking the Apply button will apply the automation to the item, and will add the Configuration tab to the Medkit for applicable items.

MedkitDropdown

The configuration tab of an item will have categories of customization options for an item. Most of these will be cosmetic, such as animations or Summons' names. Any options that change the functioning of an automation are considered "Homebrew" customizations and are a different permission level, set in the general settings menu of CPR. Players without permissions to change automations or configurations will be able to view them, but the inputs they do not have permission for will be disabled.

ConfigurationTab

Once the item has its automation applied, most automations will work without any further set up required. However, some automations may need compendium options to be selected in the CPR settings. CPR uses it's own API to function, and thus will not display any on use item or on use actor macros. As long as the Medkit is the intended color, the automation is applied.

On an Actor

The Medkit icon on an actor's title bar opens the actor Medkit, which gives an overview of the automations on an actor. This Medkit does not include any configuration options. Clicking the Update button will apply automations according to the priorities in CPR's Additional Compendiums setting, or will update the current automation on an item. A Summary tab will then display with the updated items and their sources.

ActorMedkitTooltip

With DDBI

Cauldron of Plentiful Resources was design with DDBI in mind. CPR is best used in conjunction with DDBI and importing characters through it from DDB.

For Characters: On the D&D Beyond Importer pop-up window, on the Active Effects tab, enable Use effects from Chris's Premades module?. This will automatically replace features included in the module.

For Monsters: In the compendiums sidebar tab, on the DDB Muncher popup window, enable Use effects from Chris's Premades module?.... This will automatically replace monster features when munching them. You will need to Spell Munch before Monster Munch to include those features.

A Note on Compendiums: CPR has multiple automations which require pulling items from specified compendiums. These are best fulfilled with compendiums created by DDBI. Munching Items, Spells, and Monsters is highly recommended, as items imported by DDBI are the standard that CPR is developed off of, and will work best with.

General Settings

Most settings here will be on by default and won't necessarily need to be changed. However, the Class Spell List setting needs to be set up in order for features that use spells lists to work.

Class Spell List

The Class Spell List setting requires a single journal with Spell List type pages. This must either be created by hand or imported from the SRD compendiums. Keep in mind the SRD compendium will have non-automated spells linked to them and will not include non-srd spells. These journal pages each need to have the same Identifier as the relevant class. You can then drag in spells from a compendium to add to the spell list. It is recommended to use DDBI munched spells. This journal must be kept in the sidebar.

SpellList

Compendiums Settings

One last thing to check before diving into using CPR's automated items is the Compendium Options menu in the CPR settings. It is a good idea to look at each of the settings in here to confirm they are using your preferred compendiums. By default, it will select DDBI compendiums, and it is recommended to use munched compendiums from DDBI, CPR is tested with items formatted from DDBI.

CompendiumMenu