Difference between revisions of "Homebrew: Cult"

From 5etools Community Wiki
Jump to: navigation, search
(Completed page)
m (Added reference tag)
 
Line 52: Line 52:
 
     "entry": "{@spell Minor illusion} (cantrip)"
 
     "entry": "{@spell Minor illusion} (cantrip)"
 
  }
 
  }
 +
 +
 +
==Reference Tag==
 +
How to link to entries within the <code>"entries":</code>
 +
::<code>{@cult <name_of_cult>|<json_source>|<optional_text>}</code>
 +
 +
::Example:
 +
:::{@cult Cult of Asmodeus}
 +
:::{@cult Cult of Asmodeus|MTF}
 +
:::{@cult Cult of Asmodeus|MTF|and optional link text}
  
  
Line 88: Line 98:
 
----
 
----
  
<br/>
 
: <font color="#2e7bab">Reference Tag:</font> (how to link to entries within the <code>"entries":</code>)
 
::<code> </code>
 
<br/>
 
:: Example:
 
 
 
 
<br/>
 
 
==Homebrew Support==
 
==Homebrew Support==
 
----
 
----

Latest revision as of 13:15, 27 July 2020

framless
v1.1.0

Building a cult

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.

Cult code block
"cult": [
    {
        "name": "",
        "source": "",
        "entries": [
            ""
        ]
    }
]
  • "name" — the name of the cult.
  • "source" — make sure it is the same as the "json" key in the _meta.
  • "entries" — consists of text strings ("") separated by commas.

More options

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

Page

The page of the document in which this cult appears (not always applicable).

"page": 0

Cult type

This will render in the "Subtype" column in the table, plus they appear in the filters.

"type": ""

Goals

This will render as "Goals: Giving puppies to every citizen".

"goal": {
    "entry": "Giving puppies to every citizen"
}

Typical Cultists

This will render as "Typical Cultists: any NPC that has a nose".

"cultists": {
    "entry": "Any NPC that has a nose"
}

Signature Spells

  • This special entry will render as "Signature spells: Minor illusion (cantrip)" It is recomended to tag the spells for quick access.
"signaturespells": {
    "entry": "{@spell Minor illusion} (cantrip)"
}


Reference Tag

How to link to entries within the "entries":

{@cult <name_of_cult>|<json_source>|<optional_text>}
Example:
{@cult Cult of Asmodeus}
{@cult Cult of Asmodeus|MTF}
{@cult Cult of Asmodeus|MTF|and optional link text}


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 the Cult boolean
source String json (_meta's json value) boolean
page Integer page number the entry starts boolean
type String type of cult boolean
goal Object what are the cult's goals boolean
cultist Object descript boolean
signaturespells Object List of spells boolean
entries Array of Strings general description of the cult 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.