Homebrew: Reward

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

This article refers to the Dungeonmaster's Guide Boons, located in the "Supernatural Gifts & Rewards" page. For the Supernatural Boons that first appeared in Mordekainen's Tome of Foes, check Boons.

Building a reward

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.

Reward code block
{
    "name": "",
    "source": "",
    "page": 0,
    "type": "",
    "entries": [
        ""
    ]
}
  • "name" — The name of the Reward.
  • "source" — Make sure it is the same as the "json" key in the _meta.
  • "page" — Page of the document the reward appears at (leave at 0 if not applicable).
  • "type" — Choose between one of the existing types, or use any other you like. Any string will be accepted, and will automatically create a filter for it.
  • "entries" — Consists of text strings ("") separated by commas.


Reference Tag

How to link to entries within the "entries":

{@reward <name>|<json_in_meta>|<optional_disply_text>}
Example:
{@reward Blessing of Health}
{@reward Dimir Charm|GGR}


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 name of reward True
source String json (_meta's json value) True
page Integer page number within source False
type String descript True
ability Object action description False
ability Object action description False
signaturespells Object action description False
entries Array of Strings action description True



🗄️ 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?)


NAME OF THE ISSUE
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Work Around  : Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


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.