Homebrew: Background

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

Building a background

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.

Background code block
"background": [
    {
        "name": "",
        "source": "",
        "skillProficiencies": [
            {
                "": true
            }
        ],
        "entries": [
            ""
        ]
    }
]
  • "source" β€” make sure it is the same as the "json" key in the _meta.
  • "skillProficiencies" β€” write the name of the skill inside the quotation marks. If you want more than one skill, copy the line and put it after the true, separated by a comma.
  • "entries" β€” the text part of the background.

To have more than one background, add a new object block {} after the last curly brace }. REMEMBER to separate the objects with commas!

More options

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

Choose between a list of skills

  • You can choose a "count" of skills as follows
"skillProficiencies": [
    {
        "choose": {
            "from": [
                "arcana",
                "investigation",
                "religion",
                "survival"
            ],
            "count": 2
        }
    }
]

Tool proficiencies

  • You can define which tools you can get proficient with. The current options are:
"toolProficiencies": [
    {
        "artisan's tools": true,
        "cartographer's tools": true,
        "disguise kit": true,
        "forgery kit": true,
        "gaming set": true,
        "herbalism kit": true,
        "musical instrument": true,
        "navigator's tools": true,
        "thieves' tools": true,
        "vehicles (land)": true,
        "vehicles (water)": true,
        "any": 0
    }
]
  • Just like with skills, you can choose from a list
(The "any" option works with the number of options you get)
"toolProficiencies": [
    {
        "choose": {
            "from": [
                "artisan's tools",
                "forgery kit",
                "gaming set"
            ],
            "count": 2
        }
    }
]

Language Proficiencies

  • Write the names of the languages between quotation marks, followed by the word true.
"languageProficiencies": [
    {
        "dwarvish": true,
        "goblin": true
    }
]
  • You can also choose a "count" of languages from a list
"languageProficiencies": [
    {
        "choose": {
            "from": [
                "giant",
                "orcish",
                "goblin"
            ],
            "count": 2
        }
    }
]

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 descript boolean
name Array of Strings descript boolean
name Integer descript boolean
name Object descript boolean



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


Reference Tag: (how to link to entries within the "entries":)
{@background <name_of_background>|<json_source>|<optional_text>}


Example:
{@backgorund Athlete|MOT}


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.