Homebrew: Vehicles

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

Previously called "ships"; These are the functional shift from the first release of the ships information when 5e initially launched, following UA "Of Ships and Sea", and then formally included with the Campaign set for Ghosts of Saltmarch.

There are two main types of vehicle data types in 5eTools, Ships and War Machines. They share many optional data, but their required fields are different.

Building a Ship

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.

Ship code block
{
    "name": "",
    "source": "",
    "page": 0,
    "vehicleType": "SHIP",
    "terrain": [
        ""
    ],
    "size": "",
    "pace": 0,
    "str": 0,
    "dex": 0,
    "con": 0,
    "int": 0,
    "wis": 0,
    "cha": 0,
    "action": [
        ""
    ],
    "hull": {
        "ac": 0,
        "hp": 0,
        "dt": 0
    },
    "control": [
        {
            "name": "",
            "ac": 0,
            "hp": 0,
            "dt": 0,
            "entries": [
                ""
            ]
        }
    ],
    "movement": [
        {
            "name": "",
            "ac": 0,
            "hp": 0,
            "hpNote": "",
            "isControl": false,
            "speed": [
                {
                    "mode": "water",
                    "entries": [
                        ""
                    ]
                }
            ]
        }
    ],
    "weapon": [
        {
            "name": "",
            "count": 0,
            "ac": 0,
            "hp": 0,
            "dt": 0,
            "entries": [
                ""
            ]
        }
    ],
    "other": [
        {
            "name": "",
            "entries": [
                ""
            ]
        }
    ]
}
  • "name" — The name of the feat.
  • "source" — Make sure it is the same as the "json" key in the _meta.
  • "page" — Page of the document the vehicle appears at (leave at 0 if not applicable).
  • "vehicleType" — The type of vehicle, leave as "SHIP" for ships.
  • "terrain" — The terrain in which the ship can traverse move through. Choose between "air", "land" or "sea". More than one option is possible.
  • "size" — Choose between "F" Fine, "D" Diminutive, "T" Tiny,"S" Small,"M" Medium,"L" Large,"H" Huge,"G" Gargantuan,"C" Colossal,"V" Varies.
  • "pace" — Travel pace, measured in miles per hour, The website will autocalculate the miles per day, plus the combat speed.
  • Ability Scores — The ship's relative ability scores.
  • "action" — The entries written here will be rendered under an "Actions" title. The crew thresholds for these actions can be defined, which will be explained in the extra fields section.
  • "hull" — Usually the main body of the ship. The "dt" Damage Threshold is optional.
  • "control" — A Control section of the ship. The "dt" Damage Threshold is optional.
  • "movement" — A Movement section of the ship. The "dt" Damage Threshold is optional. "hpNote" will be shown next to the Hit Points, usually to explain how damage affects the ship's speed. If "isControl" is set to true, the section will be named "Movement and Control". The "mode" will be shown as "Speed (water)", "Speed (air)" etc.
  • "weapon" — A weapon section of the ship. "count" will show how many stations of that type are present on the ship.
  • "other" — A free text section, with customizable name and content.

Extra Fields

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

Specifying dimensions

Shown after the ship's size as (80 ft. by 20 ft.).
"dimensions": [
    "80 ft.",
    "20 ft."
]

Ship's Capacity

You can limit the ship's crew, passenger and cargo's capacity. Cargo is measured in tons.
"capCrew": 20,
"capPassenger": 10,
"capCargo": 1

Damage and Condition Immunity

The conditions will be automatically linked.
"immune": [
    "poison",
    "psychic"
],
"conditionImmune": [
    "blinded",
    "charmed"
]

Action Thresholds

The format is "N of actions": "Minimum Crew".
"actionThresholds": {
    "0": 0,
    "1": 3,
    "2": 20,
    "3": 40
}

Building an Infernal War Machine

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.

War Machine code block
{
    "name": "War Machine",
    "source": "",
    "page": 0,
    "vehicleType": "INFWAR",
    "terrain": [
        ""
    ],
    "size": "C",
    "weight": 0,
    "speed": 0,
    "str": 0,
    "dex": 0,
    "con": 0,
    "int": 0,
    "wis": 0,
    "cha": 0,
    "hp": {
        "hp": 0,
        "dt": 0,
        "mt": 0
    },
    "trait": [
        {
            "name": "",
            "entries": [
                ""
            ]
        }
    ],
    "actionStation": [
        {
            "name": "",
            "entries": [
                ""
            ]
        }
    ]
}
  • "name" — The name of the feat.
  • "source" — Make sure it is the same as the "json" key in the _meta.
  • "page" — Page of the document the vehicle appears at (leave at 0 if not applicable).
  • "vehicleType" — The type of vehicle, leave as "INFWAR" for ships.
  • "terrain" — The terrain in which the War Machine can traverse move through. Choose between "air", "land" or "sea". More than one option is possible.
  • "size" — Choose between "F" Fine, "D" Diminutive, "T" Tiny,"S" Small,"M" Medium,"L" Large,"H" Huge,"G" Gargantuan,"C" Colossal,"V" Varies.
  • "weight" — Measured in pounds.
  • "speed" — Measured in feet. The website autocalculates the travel pace.
  • Ability Scores — The ship's relative ability scores.
  • "hp""dt" is the Damage Threshold, "mt" the Mishap one.
  • "trait" — The traits of the Machine.
  • "actionStation" — Will appear in their own section.

Extra Fields

Creature and Cargo Capacity

You can limit the War Machine's capacity. Cargo is measured in pounds.
"capCreature": 8,
"capCargo": 2000

Damage and Condition Immunity

The conditions will be automatically linked.
"immune": [
    "poison",
    "psychic"
],
"conditionImmune": [
    "blinded",
    "charmed"
]


Reference Tag

How to link to entries within string

{@vehicle <name> | <json_in_meta> | <optional_disply_text>}
Example:
{@vehicle Galley}, 
{@vehicle Galley|UAOfShipsAndSea}


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 Vehicle True
source String json (_meta's json value) True
page Integer The Page number it apepars upon False
size String A single Letter designation for size category False
capCrew Integer total capacity (crew) False
capPassenger Integer total capacity (passenger) False
capCargo Integer the weight it can hold for cargo (in tons) False
pace Integer Travel Pace (in miles per hour) False
str Integer A Vehicles relative Strength Ability False
dex Integer A Vehicles relative Dexterity Ability False
con Integer A Vehicles relative Constitution Ability False
int Integer A Vehicles relative Intelligence Ability False
wis Integer A Vehicles relative Wisdom Ability False
cha Integer A Vehicles relative Charisma Ability False
conditionImmune Array of Strings Immunity to defined conditions False
immune Array of Strings Immunity to defined damage types False
HomebrewSchema: hull hull Array of Objects The Hull's defense and helath False
HomebrewSchema: control control Array of Objects The Helm/Control mechanism's defense and health False
HomebrewSchema: movement movement Array of Objects The movement method's defense and health False
HomebrewSchema: weapon weapon Array of Objects Weapons defense, health, and attack abilites False
HomebrewSchema: other other Array of Objects descript boolean

🗄️ Reference Files:
🛢️ Requirements Specs (Schemata)
[[ |🧾 Blank Template]]
📖 Sample JSON
💾 No Functional Example as yet
📚 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.