Difference between revisions of "Homebrew: Item"

From 5etools Community Wiki
Jump to: navigation, search
m (An Example:)
(Start of the restructure)
Line 1: Line 1:
__NOTOC__
 
 
{{HomebrewHeader}}
 
{{HomebrewHeader}}
  
==🍺item ==
+
==Building an item ==
<description_of_the_homebrew_category_and_use>
+
As with any Homebrew item, make sure you have reviewed the [[Homebrew: Meta|'''_Meta''']] section. If your file doesn't have it, it won't work.
  
====An Example:====
+
===Basic skeleton===
The [[Homebrew: Meta|'''_Meta''']] is normally included in a full JSON, for this example it has been removed. See [[Homebrew: Meta|the link]] for how to develop the _meta.
+
To start, copy the following code block and fill the empty <code>""</code> values.
"tag": {
 
 
},
 
  
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
+
<div class="toccolours mw-collapsible mw-collapsed" overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Learn More</div>
+
<div style="font-weight:bold;line-height:2;">Item code block</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
: In the example; <description_of_results/fields>
+
"item": [
 +
    {
 +
        "name": "",
 +
        "source": "",
 +
        "page": "",
 +
        "type": "",
 +
        "rarity": "none",
 +
        "entries": [
 +
            ""
 +
        ]
 +
    }
 +
]
 
</div></div>
 
</div></div>
  
== Field List ('''Sources''') ==
+
:*<code>"name"</code> — the name of the item.
<small>If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.</small>
+
:*<code>"source"</code> — make sure it is the same as the <code>"json"</code> key in the <code>_meta</code>.
{| class="wikitable sortable"
+
:*<code>"page"</code> — the page of the document where this item appears. If this does not apply, leave at 0.
 +
:*<code>"type"</code> — the type of the item. See the table below for all the different options.
 +
:*<code>"rarity"</code> — "None" is for mundane items. "Unknown (Magic)" is for miscellaneous magical items. "Unknown" is for miscellaneous mundane items. "Varies" is for item groups.
 +
"rare", "none", "uncommon", "very rare", "legendary", "artifact", "unknown", "common", "unknown (magic)", "varies"
 +
:*<code>"entries"</code> — the text of the item. You can write several strings ("") separated with a comma. If the item doesn't have any associated text, it is safe to remove.
 +
 
 +
 
 +
==Extra tables==
 +
<div><ul>
 +
<li style="display: inline-table;">
 +
{| class="wikitable"
 +
|+ List of all avaliable item types
 +
|-
 +
! Code !! Meaning
 +
|-
 +
| "A"|| Ammunition
 +
|-
 +
| "AF"|| Ammunition
 +
|-
 +
| "AT"|| Artisan Tool
 +
|-
 +
| "EM"|| Eldritch Machine
 +
|-
 +
| "EXP"|| Explosive
 +
|-
 +
| "G"|| Adventuring Gear
 +
|-
 +
| "GS"|| Gaming Set
 +
|-
 +
| "HA"|| Heavy Armor
 +
|-
 +
| "INS"|| Instrument
 +
|-
 +
| "LA"|| Light Armor
 +
|-
 +
| "M"|| Melee Weapon
 +
|-
 +
| "MA"|| Medium Armor
 +
|-
 +
| "MNT"|| Mount
 +
|-
 +
| "GV"|| Generic Variant
 +
|-
 +
| "P"|| Potion
 +
|-
 +
| "R"|| Ranged Weapon
 +
|-
 +
| "RD"|| Rod
 +
|-
 +
| "RG"|| Ring
 +
|-
 +
| "S"|| Shield
 +
|-
 +
| "SC"|| Scroll
 +
|-
 +
| "SCF"|| Spellcasting Focus
 +
|-
 +
| "OTH"|| Other
 +
|-
 +
| "T"|| Tool
 +
|-
 +
| "TAH"|| Tack and Harness
 +
|-
 +
| "TG"|| Trade Good
 
|-
 
|-
! Field Name !! Data Type !!  Description !! Required
+
| "$"|| Treasure
 
|-
 
|-
| '''name''' || String || descript || boolean
+
| "VEH"|| Vehicle (land)
 
|-
 
|-
| name || Array of Strings || descript || boolean
+
| "SHP"|| Vehicle (water)
 
|-
 
|-
| name || Integer || descript || boolean
+
| "AIR"|| Vehicle (air)
 
|-
 
|-
| name || Object || descript || boolean
+
| "WD"|| Wand
|}
+
|} </li>
 
+
<li style="display: inline-table; margin-left:30px;">
<br/>
 
----
 
<div style="font-weight:bold;line-height:1.6;font-size:140%">🗄️ Reference Files:</div>
 
:: [[ |🛢️ Requirements Specs (Schemata) ]]
 
:: [[ |🧾 Blank Template]]
 
:: [[ |📖 Sample JSON]]
 
:: [[ |💾 Functional Example]]
 
:: [[ |📚 Repository of Other Examples]]
 
----
 
 
 
<br/>
 
: <font color="#2e7bab">Reference Tag:</font> (how to link to entries within the <code>"entries":</code>)
 
::<code> </code>
 
<br/>
 
:: Example:
 
 
 
 
 
<br/>
 
=== Homebrew Support===
 
----
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
 
<div style="font-weight:bold;line-height:1.6;">Known Issues</div>
 
<div class="mw-collapsible-content">
 
:: Looks like its perfect... (Did we miss anything?)
 
<br/>
 
:: '''NAME OF THE ISSUE'''
 
 
 
:::: <font color="#2e7bab">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.</font>
 
 
 
:::: <font style="font-weight: bold; font-variant: small-caps"> Work Around </font> : <font style="font-variant: small-caps">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.</font>
 
<br/>
 
</div>
 
<div style="font-weight:bold;line-height:1.6;">FAQ</div>
 
<div class="mw-collapsible-content">
 
:: Nothing's here (Do you have any suggestions?)
 
</div>
 
<div style="font-weight:bold;line-height:1.6;">Best Practices</div>
 
<div class="mw-collapsible-content">
 
:: None as yet (Do you have any suggestions?)
 
</div>
 
</div>
 
 
 
<br/>
 
----
 
==='''Related Features'''===
 
----
 
:*[[Homebrew]]
 
:*[[]]
 
:*[[]]
 
 
 
<br/>
 
{{FeatureSupport}}
 
 
 
 
 
Fields
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 150: Line 165:
 
|-
 
|-
 
| "WD"|| Wand
 
| "WD"|| Wand
|}
+
|} </li>
 +
</ul></div>
 +
 
 +
==Reference Tag==
 +
How to link to entries within the <code>"entries":</code>
 +
::<code> </code>
 +
 
 +
:: Example:
 +
 
 +
 
 +
==Field List Sources==
 +
<small>If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field Name !! Data Type !!  Description !! Required
 +
|-
 +
| '''name''' || String || descript || boolean
 +
|-
 +
| name || Array of Strings || descript || boolean
 +
|-
 +
| name || Integer || descript || boolean
 +
|-
 +
| name || Object || descript || boolean
 +
|}
 +
 
 +
<br/>
 +
----
 +
<div style="font-weight:bold;line-height:1.6;font-size:140%">🗄️ Reference Files:</div>
 +
:: [[ |🛢️ Requirements Specs (Schemata) ]]
 +
:: [[ |🧾 Blank Template]]
 +
:: [[ |📖 Sample JSON]]
 +
:: [[ |💾 Functional Example]]
 +
:: [[ |📚 Repository of Other Examples]]
 +
----
 +
 
 +
 
 +
==Homebrew Support==
 +
----
 +
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">Known Issues</div>
 +
<div class="mw-collapsible-content">
 +
:: Looks like its perfect... (Did we miss anything?)
 +
<br/>
 +
:: '''NAME OF THE ISSUE'''
 +
 
 +
:::: <font color="#2e7bab">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.</font>
 +
 
 +
:::: <font style="font-weight: bold; font-variant: small-caps"> Work Around </font> : <font style="font-variant: small-caps">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.</font>
 +
<br/>
 +
</div>
 +
<div style="font-weight:bold;line-height:1.6;">FAQ</div>
 +
<div class="mw-collapsible-content">
 +
:: Nothing's here (Do you have any suggestions?)
 +
</div>
 +
<div style="font-weight:bold;line-height:1.6;">Best Practices</div>
 +
<div class="mw-collapsible-content">
 +
:: None as yet (Do you have any suggestions?)
 +
</div>
 +
</div>
 +
 
 +
<br/>
 +
----
 +
==Related Features==
 +
----
 +
:*[[Homebrew]]
 +
:*[[]]
 +
:*[[]]
 +
 
 +
<br/>
 +
{{FeatureSupport}}

Revision as of 15:03, 30 July 2020

framless
v1.1.0

Building an item

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.

Item code block
"item": [
    {
        "name": "",
        "source": "",
        "page": "",
        "type": "",
        "rarity": "none",
        "entries": [
            ""
        ]
    }
]
  • "name" — the name of the item.
  • "source" — make sure it is the same as the "json" key in the _meta.
  • "page" — the page of the document where this item appears. If this does not apply, leave at 0.
  • "type" — the type of the item. See the table below for all the different options.
  • "rarity" — "None" is for mundane items. "Unknown (Magic)" is for miscellaneous magical items. "Unknown" is for miscellaneous mundane items. "Varies" is for item groups.
"rare", "none", "uncommon", "very rare", "legendary", "artifact", "unknown", "common", "unknown (magic)", "varies"
  • "entries" — the text of the item. You can write several strings ("") separated with a comma. If the item doesn't have any associated text, it is safe to remove.


Extra tables

  • List of all avaliable item types
    Code Meaning
    "A" Ammunition
    "AF" Ammunition
    "AT" Artisan Tool
    "EM" Eldritch Machine
    "EXP" Explosive
    "G" Adventuring Gear
    "GS" Gaming Set
    "HA" Heavy Armor
    "INS" Instrument
    "LA" Light Armor
    "M" Melee Weapon
    "MA" Medium Armor
    "MNT" Mount
    "GV" Generic Variant
    "P" Potion
    "R" Ranged Weapon
    "RD" Rod
    "RG" Ring
    "S" Shield
    "SC" Scroll
    "SCF" Spellcasting Focus
    "OTH" Other
    "T" Tool
    "TAH" Tack and Harness
    "TG" Trade Good
    "$" Treasure
    "VEH" Vehicle (land)
    "SHP" Vehicle (water)
    "AIR" Vehicle (air)
    "WD" Wand
  • Header text Header text
    "A" Ammunition
    "AF" Ammunition
    "AT" Artisan Tool
    "EM" Eldritch Machine
    "EXP" Explosive
    "G" Adventuring Gear
    "GS" Gaming Set
    "HA" Heavy Armor
    "INS" Instrument
    "LA" Light Armor
    "M" Melee Weapon
    "MA" Medium Armor
    "MNT" Mount
    "GV" Generic Variant
    "P" Potion
    "R" Ranged Weapon
    "RD" Rod
    "RG" Ring
    "S" Shield
    "SC" Scroll
    "SCF" Spellcasting Focus
    "OTH" Other
    "T" Tool
    "TAH" Tack and Harness
    "TG" Trade Good
    "$" Treasure
    "VEH" Vehicle (land)
    "SHP" Vehicle (water)
    "AIR" Vehicle (air)
    "WD" Wand

Reference Tag

How to link to entries within the "entries":

Example:


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]]


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.