Adding homebrew compendiums - thejoester/pf2e-alchemist-remaster-ducttape GitHub Wiki
How to add homebrew compendiums for formulas to be added upon level up.
You can add homebrew Item compendiums so that when the Alchemist character levels up, it will search through that compendium for higher level versions of formulas they know.
In the settings, under PF2e Alchemist Remaster Duct Tape settings, click "Add Homebrew Item Compendiums"
Enter the compendium name and click add. If the compendium is valid the text under "Compendiums to be added" will be green. If the text is red the compendium does not exist or the format is wrong. If the compendium is not an Item compendium, it will not add it and display a UI error.
Proper formats
Here are the proper formats for compendiums:
World Compendiums: world.compendium-name
Module Compendiums: module-name.compendium-name
How to find the name.
If you do not know for sure how the module name or compendium name is formatted, here is how you can find it:
- In your compendiums tab, find and open the compendium you want to use.
- Pick any item in the compendium and open it.
- Go to the Rules tab
- Under "Source ID" you will see something like
Compendium.joes-pf2-stuff.joes-items-pf2.Item.0ql3yim4bZhwrJIo
, we only want what is betweenCompendium.
andItem.
=joes-pf2-stuff.joes-items-pf2
Requirements
In order for this module to properly detect your homebrew item formulas the slug must match the pf2e system format. The beginning of the slug for items must match! For example, for Acid Flask (Lesser) the slug is acid-flask-lesser
and for Acid Flask (Moderate) the slug is acid-flask-moderate
. Both start with acid-flask
.
So your home brew item must also match in the same way. If you are modifying an existing item and want it to be linked to the original item, for example you want another Acid Flask between Lesser and Moderate called Acid Flask (Intermediate), the slug should be acid-flask-intermediate
.
If you are creating an alternate item, for example you want to change how much healing the Elixir of Life elixirs do, and have custom names the slugs must follow the same convention. For example:
joes-elixir-of-life-lesser
joes-elixir-of-life-moderate
joes-elixir-of-life-greater