¶ Compendium Contribution Guidelines
Awesome! You're looking to contribute to our compendiums, below is an explanation how you can go about doing this and some guidelines for while doing so.
¶ Rule Elements
Almost all of our automation is done through the use of Rule Elements, please read through the Rule Elements Guide for info on how you can add automation.
¶ What is automatable?
As of Alpha 15 the following things are automatable, this list will expend as more rules are added:
- Flat modifiers on rolls
- Granting of other items (such as moves)
- Roll Options (storing state, such as noting someone is trained, or is channeled)
- Anything you can automate with Active Effects
- Such as modifiers on a sheet
- works the same as in V3.x
If something applies an effect to you, such as Inspired Training making a pokemon become 'Inspired' a new Effect item should be created alongside the automation of the original 'Inspired Training' feature, the format of this should be Effect: [effect-name] so in this case it would be "Effect: Inspired" and should list its effect. The original granting item may still list the effect as well, and will in it's description link towards the effect item. Please put in placeholder [Link to Item] when you modify the description.
Example
For example, if you provide Inspired Training like this:
Alongside the effect item, the end result will look like this:
¶ What cannot be automated
Some examples of things that cannot be automated yet
- Things that affect effectiveness
- Move effects
- 'using' an ability (only static effects work for now)
¶ How to edit items and sent them to us properly
¶ Oops. This looks outdated!
Hey there! This was specificially for during the Alpha, and will be updated in the near future with the correct details.
To edit an item in the compendium the first step is to import it into your world. You can do this by searching for the item in the compendium, right clicking, and selecting Import Entry.
Alternatively you can also drag the item from Quick Insert (/ a floating compendium window) onto your items tab.
After this you can edit the item as needed.
Once you're fully done and have tested that your item works, right click the item in the sidebar and select Export Data. This will download the item to your computer as a .json file.
Share this file in #compendium-project
¶ Need help?
Feel free to reach out over in #alpha-feedback to get your questions answered.