Homebrew: Condition

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

Building a condition

As with any Homebrew item, make sure you have reviewed the _Meta section. If your file doesn't have it, it won't work.

Basic skeleton

To start, copy the following code block and fill the empty "" values.

Condition code block
"condition": [
    {
        "name": "",
        "source": "",
        "page": 0,
        "entries": [
            ""
        ]
    }
]
  • "name" β€” the name of the condition
  • "source" β€” make sure it is the same as the "json" key in the _meta.
  • "page" β€” the page of the document where this condition appears. If this does not apply, leave at 0.
  • "entries" β€” the text of the condition. You can write several strings ("") separated with a comma.:

More options

Make sure you are adding these blocks in the same level as the "name", "source", etc.

Color

Choose a specific color for the condition. (used in the DM screen?). The code should be HEX format.

"color": "ffffff"

Adding an image

"conditionFluff" needs to be its own data block, outside of "condition".

"conditionFluff": [
    {
        "name": "",
        "source": "",
        "images": [
            {
                "type": "image",
                "href": {
                    "type": "external",
                    "url": ""
                }
            }
        ]
    }
]

Reference Tag

How to link to entries within the strings

{@condition <condition_name> | <json_source> | <optional_display_text>}
Example:
{@condition stunned|PHB}
{@condition stunned|PHB|and optional link text added with another pipe}


Field List Sources

If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.

Field Name Data Type Description Required
name String Title for the condition True
entries Array of Strings descriptive text True
source String json (_meta's json value) True
page Integer page number within source True
srd Boolean If the condition is part of the SRD False
color String Hexadecimal Color code False



πŸ—„οΈ Reference Files:
πŸ›’οΈ Requirements Specs (Schemata)
[[ |🧾 Blank Template]]
πŸ“– Sample JSON
[[ |πŸ’Ύ Functional Example]]
πŸ“š Repository of Other Examples


Homebrew Support


Known Issues
Looks like its perfect... (Did we miss anything?)


FAQ
Nothing's here (Do you have any suggestions?)
Best Practices
None as yet (Do you have any suggestions?)



Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.