Difference between revisions of "Homebrew: Item"

From 5etools Community Wiki
Jump to: navigation, search
(Start of the restructure)
(Half of all the propierties added — also finished the tables at the bottom)
 
Line 32: Line 32:
 
:*<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.
 
:*<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.
  
 +
==General Tags==
 +
===Age===
 +
The only current official ones are "modern"and "renaissance", but any string can be used. it will show up as a "Type" filter.
 +
"age": "modern"
 +
===Carrying capacity===
 +
How many pounds a Mount (or similar) can carry.
 +
"carryingCapacity": 120
 +
===Requires Attunement===
 +
If anyone can attune with the item, use <code>"true"</code>.
 +
"reqAttune": true
 +
The item may only be attunable by a certain class/people. Can handle any string.
 +
"reqAttune": "by a bard"
 +
It is possible that the attunement is optional.
 +
"reqAttune": "optional"
 +
===Cursed Items===
 +
Some magic items bear curses that bedevil their users, sometimes long after a user has stopped using an item.
 +
"curse": true
 +
===Damage resistance===
 +
Enter the type of damage the item gives you resist to.
 +
"resist": "cold"
 +
===Spellcasting Focus Types===
 +
Choose between <code>"arcane"</code> (Sorcerers, Warlocks and Wizards), <code>"holy"</code> (Clerics and Paladins) or <code>"druid"</code> (Druids)
 +
"sfcType": "arcane"
 +
===Speed===
 +
The top speed of mounts and vehicles
 +
"speed": 50
 +
===Item Tier===
 +
A distinction mainly used in the DMG that separates <code>"major"</code> and <code>"minor"</code> Magic Items.
 +
"tier": "major"
 +
===Value===
 +
Monetary value of the item. Use copper pieces.
 +
"value": 1000
 +
 +
==Weapon tags==
 +
===Ammunition===
 +
For items that '''use''' ammunition, not the ammunition items themselves.
 +
"ammunition": true
 +
===Damage===
 +
The damage dice of a weapon is declared as follows.
 +
"dmg1": "1d8"
 +
For Versatile weapons or those that offer an alternative damage dice, a second one can be defined.
 +
"dmg2": "2d6"
 +
Finally, declare the type of damage the weapon deals. For all the different damage types, see the table at the bottom of the page.
 +
"dmgType": "S"
 +
===Range===
 +
Define the range of a ranged weapon.
 +
"range": "80/320"
 +
===Reload===
 +
The amount of shots before the weapon needs to be reloaded.
 +
"reload": 5
 +
 +
==Armor tags==
 +
===Armor Class===
 +
The base Armor Class the item provides.
 +
"ac": 12
 +
There is also a free text version of this:
 +
"acSpecial": "12 AC, 15 AC during the night"
 +
===Stealth Disadvantage===
 +
Mainly used for Heavy Armors, displays a text explaining this drawback.
 +
"stealth": true
 +
===Minimum Strenght===
 +
The minimum Strenght value a character needs to not be slowed when wearing the item.
 +
 +
This will result in a line saying "If the wearer has a Strength score lower than x, their speed is reduced by 10 feet."
 +
"strength": 15
  
 
==Extra tables==
 
==Extra tables==
 
<div><ul>
 
<div><ul>
 
<li style="display: inline-table;">
 
<li style="display: inline-table;">
{| class="wikitable"
+
{| class="wikitable sortable"
|+ List of all avaliable item types
+
|+ Item types
 
|-
 
|-
 
! Code !! Meaning
 
! Code !! Meaning
Line 43: Line 108:
 
| "A"|| Ammunition
 
| "A"|| Ammunition
 
|-
 
|-
| "AF"|| Ammunition
+
| "AF"|| Ammunition (futuristic)
 
|-
 
|-
 
| "AT"|| Artisan Tool
 
| "AT"|| Artisan Tool
Line 102: Line 167:
 
|} </li>
 
|} </li>
 
<li style="display: inline-table; margin-left:30px;">
 
<li style="display: inline-table; margin-left:30px;">
{| class="wikitable"
+
{| class="wikitable sortable"
 +
|+ Damage types
 
|-
 
|-
! Header text !! Header text
+
! Code !! Meaning
 
|-
 
|-
| "A"|| Ammunition
+
| "A"|| Acid
 
|-
 
|-
| "AF"|| Ammunition
+
| "B"|| Bludgeoning
 
|-
 
|-
| "AT"|| Artisan Tool
+
| "C"|| Cold
 
|-
 
|-
| "EM"|| Eldritch Machine
+
| "F"|| Fire
 
|-
 
|-
| "EXP"|| Explosive
+
| "O"|| Force
 
|-
 
|-
| "G"|| Adventuring Gear
+
| "L"|| Lightning
 
|-
 
|-
| "GS"|| Gaming Set
+
| "N"|| Necrotic
 
|-
 
|-
| "HA"|| Heavy Armor
+
| "P"|| Piercing
 
|-
 
|-
| "INS"|| Instrument
+
| "I"|| Poison
 
|-
 
|-
| "LA"|| Light Armor
+
| "Y"|| Psychic
 
|-
 
|-
| "M"|| Melee Weapon
+
| "R"|| Radiant
 
|-
 
|-
| "MA"|| Medium Armor
+
| "S"|| Slashing
 
|-
 
|-
| "MNT"|| Mount
+
| "T"|| Thunder
 
|-
 
|-
| "GV"|| Generic Variant
+
|} </li>
 +
<li style="display: inline-table; margin-left:30px;">
 +
{| class="wikitable sortable"
 +
|+ Properties
 
|-
 
|-
| "P"|| Potion
+
! Code !! Meaning
 
|-
 
|-
| "R"|| Ranged Weapon
+
| "T"|| Thrown
 
|-
 
|-
| "RD"|| Rod
+
| "V"|| Versatile
 
|-
 
|-
| "RG"|| Ring
+
| "H"|| Heavy
 
|-
 
|-
| "S"|| Shield
+
| "2H"|| Two-Handed
 
|-
 
|-
| "SC"|| Scroll
+
| "F"|| Finesse
 
|-
 
|-
| "SCF"|| Spellcasting Focus
+
| "L"|| Light
 
|-
 
|-
| "OTH"|| Other
+
| "R"|| Reach
 
|-
 
|-
| "T"|| Tool
+
| "A"|| Ammunition
 
|-
 
|-
| "TAH"|| Tack and Harness
+
| "LD"|| Loading
 
|-
 
|-
| "TG"|| Trade Good
+
| "S"|| Special
 
|-
 
|-
| "$"|| Treasure
+
| "AF"|| Ammunition (futuristic)
 
|-
 
|-
| "VEH"|| Vehicle (land)
+
| "RLD"|| Reload
 
|-
 
|-
| "SHP"|| Vehicle (water)
+
| "BF"|| Burst Fire
|-
 
| "AIR"|| Vehicle (air)
 
 
|-
 
|-
| "WD"|| Wand
 
 
|} </li>
 
|} </li>
 
</ul></div>
 
</ul></div>

Latest revision as of 18:45, 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.

General Tags

Age

The only current official ones are "modern"and "renaissance", but any string can be used. it will show up as a "Type" filter.

"age": "modern"

Carrying capacity

How many pounds a Mount (or similar) can carry.

"carryingCapacity": 120

Requires Attunement

If anyone can attune with the item, use "true".

"reqAttune": true

The item may only be attunable by a certain class/people. Can handle any string.

"reqAttune": "by a bard"

It is possible that the attunement is optional.

"reqAttune": "optional"

Cursed Items

Some magic items bear curses that bedevil their users, sometimes long after a user has stopped using an item.

"curse": true

Damage resistance

Enter the type of damage the item gives you resist to.

"resist": "cold"

Spellcasting Focus Types

Choose between "arcane" (Sorcerers, Warlocks and Wizards), "holy" (Clerics and Paladins) or "druid" (Druids)

"sfcType": "arcane"

Speed

The top speed of mounts and vehicles

"speed": 50

Item Tier

A distinction mainly used in the DMG that separates "major" and "minor" Magic Items.

"tier": "major"

Value

Monetary value of the item. Use copper pieces.

"value": 1000

Weapon tags

Ammunition

For items that use ammunition, not the ammunition items themselves.

"ammunition": true

Damage

The damage dice of a weapon is declared as follows.

"dmg1": "1d8"

For Versatile weapons or those that offer an alternative damage dice, a second one can be defined.

"dmg2": "2d6"

Finally, declare the type of damage the weapon deals. For all the different damage types, see the table at the bottom of the page.

"dmgType": "S"

Range

Define the range of a ranged weapon.

"range": "80/320"

Reload

The amount of shots before the weapon needs to be reloaded.

"reload": 5

Armor tags

Armor Class

The base Armor Class the item provides.

"ac": 12

There is also a free text version of this:

"acSpecial": "12 AC, 15 AC during the night"

Stealth Disadvantage

Mainly used for Heavy Armors, displays a text explaining this drawback.

"stealth": true

Minimum Strenght

The minimum Strenght value a character needs to not be slowed when wearing the item.

This will result in a line saying "If the wearer has a Strength score lower than x, their speed is reduced by 10 feet."

"strength": 15

Extra tables

  • Item types
    Code Meaning
    "A" Ammunition
    "AF" Ammunition (futuristic)
    "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
  • Damage types
    Code Meaning
    "A" Acid
    "B" Bludgeoning
    "C" Cold
    "F" Fire
    "O" Force
    "L" Lightning
    "N" Necrotic
    "P" Piercing
    "I" Poison
    "Y" Psychic
    "R" Radiant
    "S" Slashing
    "T" Thunder
  • Properties
    Code Meaning
    "T" Thrown
    "V" Versatile
    "H" Heavy
    "2H" Two-Handed
    "F" Finesse
    "L" Light
    "R" Reach
    "A" Ammunition
    "LD" Loading
    "S" Special
    "AF" Ammunition (futuristic)
    "RLD" Reload
    "BF" Burst Fire

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.