Homebrew: Variant Rules

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

Variant Rules are rules that modify or change the game's mechanics. They can be simply discussing new items features or properties, or as complicated as having to be willing to perform whatever action your character is supposed to be attempting. In short they are the house rules the DM is choosing to use in their playstyle.

Building Variant Rules

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 "" values.

Variant Rule code block
"variantrule": [
   {
       "name": "",
       "source": "",
       "page": 0,
       "ruleType": "",
       "entries": [
           ""
       ]
   }

]

  • "name" — The name of the Variant Rule.
  • "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 "O" Optional, "V" Variant, "VO" Variant Optional or "VV" Variant Variant.
  • "entries" — Consists of text strings ("") separated by commas.

Reference Tag

How to link to entries within the string.

{@variantrule <name_of_variantRule> | <json_source> | <optional_text_information>}
Example:
 {@variantrule Multiclassing|phb} 
 {@variantrule Multiclassing|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 Name/Title of the Variant Rule True
type String False
entries Array of Strings descriptive text of the variant rules True
source String json (_meta's json value) True
page Integer The Page number it apepars upon False
ruleType string One of the follow:
Optional ("O"), Variant ("V"), Unknown ("U")
boolean



🗄️ 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.

Do you have time to take a Survey?