JSON INFO

Use the Home key to return to the top.

Table of Contents

Introduction

This document describes the contents of the json files used in Cataclysm: Dark Days Ahead. You are probably reading this if you want to add or change content of Cataclysm: Dark Days Ahead and need to learn more about what to find where and what each file and property does.

Overall structure

The game data is distributed amongst many JSON files in data. Most of the core game data is in data/json, with mod data in data/mods. There is also some in other subdirectories of data, but you are less likely to be interested in those.

Each JSON file is a list of JSON objects

[
  {
    "…": "…"
  },
  {
    "…": "…"
  }
]

Each object must have a "type" member that tells the game how to interpret that object. For example, crafting recipes have "type": "recipe", vehicle parts have "type": "vehicle_part", and so on. Note that items are a little unusual; there are multiple types which can be used to define an item. See the item documentation for more details.

Each of these types is documented separately, either below or in other documentation which should be linked from below (doubtless a few have been missed; feel free to file bugs for missing documentation).

The documentation is organized by file, because objects of the same type tend to be defined together in one file or a collection of co-located files. However, the game does not enforce this convention and in practice you could define a JSON object of any type in any file. If you were writing a small mod it might be reasonable to simply put all your JSON in a single file and that would be fine.

There are a few cases where certain objects must be loaded before other objects and the names of the files defining those objects will affect the loading order; sticking to established convention should avoid that issue.

There are a few features that most types of JSON object have in common. Those common features are documented in the next section.

Common properties

For most types, every object of that type must have a unique id. That id is typically defined by the "id" field. For example:

  {
    "type": "skill",
    "id": "barter",
    "name": { "str": "bartering" },
    "description": "…",
    "display_category": "display_social"
  }

This defines a skill with id barter.

"copy-from" and "abstract"

Sometimes you want to define an object which is similar to another object, or a collection of similar objects. In most cases you can achieve this with "copy-from", specifying the id of the object you wish to copy. For example, the definition of a harvested pine tree copies t_tree_pine (the unharvested pine tree) and then specifies only a few properties. Other properties (such as the fact that it’s impassable, flammable, etc.) are inherited from t_tree_pine.

  {
    "type": "terrain",
    "id": "t_tree_pine_harvested",
    "copy-from": "t_tree_pine",
    "name": "pine tree",
    "description": "A towering coniferous tree that belongs to the 'Pinus' genus, with the New England species varying from 'P. strobus', 'P. resinosa' and 'P. rigida'.  Some of the branches have been stripped away and many of the pinecones aren't developed fully yet, but given a season, it could be harvestable again.",
    "symbol": "4",
    "color": "brown",
    "looks_like": "t_tree_deadpine",
    "transforms_into": "t_tree_pine",
    "examine_action": "harvested_plant"
  },

Sometimes you might want define a collection of objects which are similar, but there is no obvious single object that the others should copy. In this case, you can create a special, abstract object and have all the others copy it.

An abstract object specifies its id via the "abstract" field rather than "id". For example, here is the abstract vehicle alternator:

  {
    "abstract": "vehicle_alternator",
    "type": "vehicle_part",
    "fuel_type": "battery",
    "symbol": "*",
    "color": "yellow",
    "broken_color": "red",
    "flags": [ "ALTERNATOR" ]
  },

All vehicle alternator definitions use "copy-from": "vehicle_alternator" to inherit these common properties, but because vehicle_alternator is an abstract object, it does not appear in the game as a real vehicle part you can install.

When using "copy-from", you can define fields that were also defined in the object you are copying, and the new value will override the old. However, sometimes you want to change the value in the copied object without overriding it entirely; there is support for that. See the JSON inheritance documentation for details.

"copy-from" also implies "looks_like" connection, so you don’t have to specify the id multiple times.

Navigating the JSON

A lot of the JSON involves cross-references to other JSON entities. To make it easier to navigate, we provide a script tools/json_tools/cddatags.py that can build a tags file for you. This enables you to jump to the definition of an object given its id.

To run the script you’ll need Python 3. On Windows you’ll probably need to install that, and associate .py files with Python. Then open a command prompt, navigate to your CDDA folder, and run tools\json_tools\cddatags.py.

To use this feature your editor will need ctags support. When that’s working you should be able to easily jump to the definition of any entity. For example, by positioning your cursor over an id and hitting the appropriate key combination.

  • In Vim, this feature exists by default, and you can jump to a definition using ^].
  • In Notepad++ go to “Plugins” -> “Plugins Admin” and enable the “TagLEET” plugin. Then select any id and press Alt+Space to open the references window.

Common field types

This section describes some common features of formatting values in CDDA JSON files.

Units

Most values which represent physical quantities (length, volume, time, etc.) are given as a string with a numerical value and an abbreviation of the unit, separated with a space. Generally we use SI units and try to stick to the conventional SI abbreviations. For example, a volume of 3 liters would be defined as "3 L".

Time duration

A string containing one or more pairs of number and time duration unit. Number and unit, as well as each pair, can be separated by an arbitrary amount of spaces. Available units:

  • “hours”, “hour”, “h” - one hour
  • “days”, “day”, “d” - one day
  • “minutes”, “minute”, “m” - one minute
  • “turns”, “turn”, “t” - one turn,

Examples:

  • ” +1 day -23 hours 50m “ (1*24*60 - 23*60 + 50 == 110 minutes)
  • “1 turn 1 minutes 9 turns” (1 minute and 10 seconds because 1 turn is 1 second)

Translatable strings

Some json strings are extracted for translation, for example item names, descriptions, etc. The exact extraction is handled in lang/extract_json_strings.py. Apart from the obvious way of writing a string without translation context, the string can also have an optional translation context (and sometimes a plural form), by writing it like:

"name": { "ctxt": "foo", "str": "bar", "str_pl": "baz" }

or, if the plural form is the same as the singular form:

"name": { "ctxt": "foo", "str_sp": "foo" }

You can also add comments for translators by adding a “//~” entry like below. The order of the entries does not matter.

"name": {
    "//~": "as in 'foobar'",
    "str": "bar"
}

Currently, only some JSON values support this syntax (see here for a list of supported values and more detailed explanation).

The string extractor will extract all encountered strings from JSON for translation. But if some string should not be translated, such as text that is not normally visible to the player (names and descriptions of monster-only effects and spells), then you can write "NO_I18N" in the comment for translators:

"name": {
    "//~": "NO_I18N",
    "str": "Fake Monster-Only Spell"
},
"description": {
    "//~": "NO_I18N",
    "str": "Fake Monster-Only Spell Description"
}

The extractor will skip these two specified strings and only these, extracting the remaining unmarked strings from the same JSON object.

Comments

JSON has no intrinsic support for comments. However, by convention in CDDA JSON, any field starting with // is a comment.

{
  "//" : "comment"
}

If you want multiple comments in a single object then append a number to //. For example:

{
  "//" : "comment",
  "//1" : "another comment",
  "//2" : "yet another comment"
}

File descriptions

Here’s a quick summary of what each of the JSON files contain, broken down by folder. This list is not comprehensive, but covers the broad strokes.

data/json/

Filename Description
achievements.json achievements
anatomy.json a listing of player body parts - do not edit
ascii_arts.json ascii arts for item descriptions
bionics.json bionics, does NOT include bionic effects
body_parts.json an expansion of anatomy.json - do not edit
clothing_mods.json definition of clothing mods
conducts.json conducts
connect_groups.json definition of terrain and furniture connect groups
construction.json definition of construction menu tasks
default_blacklist.json a standard blacklist of joke monsters
doll_speech.json talking doll speech messages
dreams.json dream text and linked mutation categories
disease.json disease definitions
effects.json common effects and their effects
emit.json smoke and gas emissions
flags.json common flags and their descriptions
furniture.json furniture, and features treated like furniture
game_balance.json various options to tweak game balance
gates.json gate terrain definitions
harvest.json item drops for butchering corpses
health_msgs.json messages displayed when the player wakes
item_actions.json descriptions of standard item actions
item_category.json item categories and their default sort
item_groups.json item spawn groups
lab_notes.json lab computer messages
martialarts.json martial arts styles and buffs
materials.json material types
monster_attacks.json monster attacks
monster_drops.json monster item drops on death
monster_factions.json monster factions
monster_flags.json monster flags and their descriptions
monstergroups.json monster spawn groups
monstergroups_egg.json monster spawn groups from eggs
monsters.json monster descriptions, mostly zombies
morale_types.json morale modifier messages
mutation_category.json messages for mutation categories
mutation_ordering.json draw order for mutation and CBM overlays in tiles mode
mutations.json traits/mutations
names.json names used for NPC/player name generation
overmap_connections.json connections for roads and tunnels in the overmap
overmap_terrain.json overmap terrain
player_activities.json player activities
professions.json profession definitions
recipes.json crafting/disassembly recipes
regional_map_settings.json settings for the entire map generation
road_vehicles.json vehicle spawn information for roads
rotatable_symbols.json rotatable symbols - do not edit
scent_types.json type of scent available
scores.json scores
skills.json skill descriptions and ID’s
snippets.json flier/poster/monster speech/dream/etc descriptions
species.json monster species
speed_descripton.json monster speed description
speech.json monster vocalizations
statistics.json statistics and transformations used to define scores and achievements
start_locations.json starting locations for scenarios
techniques.json generic for items and martial arts
terrain.json terrain types and definitions
test_regions.json test regions
tips.json tips of the day
tool_qualities.json standard tool qualities and their actions
traps.json standard traps
tutorial.json messages for the tutorial (that is out of date)
vehicle_groups.json vehicle spawn groups
vehicle_parts.json vehicle parts, does NOT affect flag effects
vitamin.json vitamins and their deficiencies

selected subfolders

data/json/items/

See below for specifics on the various items

Filename Description
ammo.json common base components like batteries and marbles
ammo_types.json standard ammo types by gun
archery.json bows and arrows
armor.json armor and clothing
bionics.json Compact Bionic Modules (CBMs)
biosignatures.json animal waste
books.json books
chemicals_and_resources.json chemical precursors
comestibles.json food/drinks
containers.json containers
crossbows.json crossbows and bolts
fake.json fake items for bionics or mutations
fuel.json liquid fuels
grenades.json grenades and throwable explosives
handloaded_bullets.json random ammo
melee.json melee weapons
newspaper.json flyers, newspapers, and survivor notes. snippets.json for messages
ranged.json guns
software.json software for SD-cards and USB sticks
tool_armor.json clothes and armor that can be (a)ctivated
toolmod.json modifications of tools
tools.json tools and items that can be (a)ctivated
vehicle_parts.json components of vehicles when they aren’t on the vehicle

data/json/items/comestibles/

data/json/requirements/

Standard components and tools for crafting (See Recipe requirements)

Filename Description
ammo.json ammo components
cooking_components.json common ingredient sets
cooking_requirements.json cooking tools and heat sources
materials.json thread, fabric, and other basic materials
toolsets.json sets of tools commonly used together
uncraft.json common results of taking stuff apart
vehicle.json tools to work on vehicles

data/json/vehicles/

Groups of vehicle definitions with self-explanatory names of files:

Filename
bikes.json
boats.json
cars.json
carts.json
custom_vehicles.json
emergency.json
farm.json
helicopters.json
military.json
trains.json
trucks.json
utility.json
vans_busses.json
vehicles.json

Description and content of each JSON file

This section describes each json file and their contents. Each json has their own unique properties that are not shared with other Json files (for example ‘chapters’ property used in books does not apply to armor). This will make sure properties are only described and used within the context of the appropriate JSON file.

data/json/ JSONs

Ascii_arts

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary.
picture Array of string, each entry is a line of an ascii picture and must be at most 41 columns long. \ have to be replaced by \\ in order to be visible. 
  {
    "type": "ascii_art",
    "id": "cashcard",
    "picture": [
      "",
      "",
      "",
      "       <color_white>╔═══════════════════╗",
      "       <color_white>║                   ║",
      "       <color_white>║</color> <color_yellow>╔═   ╔═╔═╗╔═║ ║</color>   <color_white>║",
      "       <color_white>║</color> <color_yellow>║═ ┼ ║ ║═║╚╗║═║</color>   <color_white>║",
      "       <color_white>║</color> <color_yellow>╚═   ╚═║ ║═╝║ ║</color>   <color_white>║",
      "       <color_white>║                   ║",
      "       <color_white>║   RIVTECH TRUST   ║",
      "       <color_white>║                   ║",
      "       <color_white>║                   ║",
      "       <color_white>║ 555 993 55221 066 ║",
      "       <color_white>╚═══════════════════╝"
    ]
  }

For information about tools with option to export ASCII art in format ready to be pasted into ascii_arts.json, see ASCII_ARTS.md.

Snippets

Snippets are the way for the game to store multiple instances of text, and use it on demand for different purposes: in item descriptions, NPC dialogues or in Effect on conditions

Snippets may be made in two ways:

First is when snippet contain multiple fields, mainly text and id - in this case the game would be able to save it, and call only specific one - for example, if used in item description or in lab report file

{
  "type": "snippet",
  "category": "test_breads",  // Category is the id of a snippet
  "text": [
    {
      "id": "bread1",                                 // Id of this exact text, in this case "flatbread"
      "name": "flatbread because i love flatbread",   // Name of a snippet, not actually used anywhere except to describe the snippet
      "text": "flatbread",                            // Text, that would be used if this snippet category is called
      "effect_on_examine": [ "effect_on_condition" ], // Examining of this snippet will call effect_on_condition
      "weight": 10                                    // Weight of this specific snippet, in case of this group the probability to get this one would be 10/13 ~= 76%
    },
    { "id": "bread2", "text": "yeast bread" },
    { "id": "bread3", "text": "cornbread" },
    { "id": "bread4", "text": "fruit bread" }
  ]
}

Second is when snippet contain plain text with no ids - it is used, when the snippet can be generated on the fly, and the game don’t need to memorize which one it should be - like in dialogue, for example (we don’t need the game to remember what character used when talked to you)

{
  "type": "snippet",
  "category": "test_breads", 
  "text": [
    "flatbread",
    "yeast bread",
    "cornbread",
    "fruit bread"
  ]
}

There is also a multiple ways to use said snippet:

Items can utilize it using snippet_category, in this case the whole description of an item would be replaced with randomly picked snipped out of category:

"snippet_category": "test_breads",

Alternatively, the snippet_category may itself contain a range of descriptions, avoiding making a new category:

"snippet_category": [
  { "id": "bread1", "text": "flatbread" },
  { "id": "bread2", "text": "yeast bread" },
  { "id": "bread3", "text": "cornbread" },
  { "id": "bread4", "text": "fruit bread" }
]

note, that using id is mandatory in every way, if you don’t want to make the game change the description of an item every time they do anything in the game

Both dialogues and snippets may reference the snippets right inside themselves - to differentiate the snippets, that are used in this way, their id contain <> in the name, like <test_breads>

"dynamic_line": "I don't even <swear> know anymore.  I have no <swear> idea what is going on.  I'm just doing what I can to stay alive.  The world ended and I bungled along not dying, until I met you."

{
  "type": "snippet",
  "category": "<music_description>",
  "text": [ "some <musicgenre>.", "some <musicgenre>. The <musicdesc_part> is <musicdesc_evaluation>." ]
},

Item descriptions also capable to use snippet system, but to use them, expand_snippets should be true, otherwise snippet won’t be used

{
  "id": "nice_mug",
  "type": "GENERIC",
  "name": { "str": "complimentary mug" },
  "description": "A ceramic mug.  It says \"Nice job, <name_g>!\"",
  "expand_snippets": true,
...
}

Same works with variants

{
  "id": "mean_mug",
  "type": "GENERIC",
  "name": { "str": "insulting mug" },
  "description": "A ceramic mug.",
  "variant_type": "generic",
  "variants": [
    {
      "id": "fuck_you",
      "name": { "str": "insulting mug" },
      "description": "It says \"<fuck_you>, <name_b>!\"",
      "append": true,
      "expand_snippets": true,
      "weight": 1
    },
    {
      "id": "worst_dad",
      "name": { "str": "bad dad mug" },
      "description": "It says \"Worlds Worst Dad\"",
      "append": true,
      "weight": 1
    }
  ],
  "material": [ "ceramic" ],
  "weight": "375 g",
  "volume": "375 ml"
}

Using expand_snippets required only where snippets are used - if item do not uses snippet, but variant does, then only variant require to have "expand_snippets":true Using expand_snippets on item itself will work as all variants have "expand_snippets":true, but variants without any snippet would be effectively removed

{
  "id": "mean_mug",
  "type": "GENERIC",
  "name": { "str": "insulting mug" },
  "description": "A ceramic mug.",
  "expand_snippets": true,
  "variant_type": "generic",
  "variants": [
    {
      "id": "fuck_you",
      "name": { "str": "insulting mug" },
      "description": "It says \"<fuck_you>, <name_b>!\"",
      "append": true,
      "weight": 1
    },
    {
      "id": "worst_dad",
      "name": { "str": "bad mug" },
      "description": "This mug never appears, because it doesnn't have any snippets",
      "append": true,
      "weight": 1
    }
  ],
  "material": [ "ceramic" ],
  "weight": "375 g",
  "volume": "375 ml"
}

Item groups can specify the description of the item that is spawned:

{
  "type": "item_group",
  "id": "test_itemgroup",
  "//": "it spawns `child's drawing` item with `mutant_kid_boss_5` description"
  "entries": [
    { "item": "note_mutant_alpha_boss", "snippets": "mutant_kid_boss_5" },
  ]
}

Without specifying, the random snippet would be used

Snippets can also be used in EoC, see EFFECT_ON_CONDITION.md#u_message

Items, that uses effect on condition action to reveal a snippet, may utilize conditional_names syntax to change the name of an item, depending on it’s description

log_psych is the category of snippet, dream_1 is the id of a snippet, and name is the name of new item

{
  "type": "GENERIC",
  "id": "psych_file",
  "name": { "str": "lab report (psychology)", "str_pl": "lab reports (psychology)" },
  "conditional_names": [
    { "type": "SNIPPET_ID", "condition": "log_psych", "value": "dream_1", "name": { "str_sp": "Session S-3397-5" } },
    { "type": "SNIPPET_ID", "condition": "log_psych", "value": "dream_2", "name": { "str_sp": "Session T-1215-4" } },
    { "type": "SNIPPET_ID", "condition": "log_psych", "value": "dream_3", "name": { "str_sp": "Scrawled note" } }
  ],
  "description": "A folder full of what appear to be transcripts of confidential psychotherapy sessions.  Most of it is rather trivial, but certain passages catch your eye…",
  "copy-from": "file",
  "use_action": {
    "type": "effect_on_conditions",
    "description": "Activate to read the file",
    "effect_on_conditions": [
      {
        "id": "EOC_LAB_FILE_PSY",
        "effect": [ { "u_message": "log_psych", "snippet": true, "same_snippet": true, "popup": true } ]
      }
    ]
  }
}

Once the item would be activated, the description would be replaced with one of log_psych texts, and the lab report (psychology) name would be replaced with one of conditional_names

Snippets also support the color codes

"<color_yellow_red>Biohazard</color>",

To use literal < and > characters in a snippet, escape them with <lt> and <gt>. For example, <lt>swear<gt> expands into <swear> rather than any snippet in the <swear> category.

Addiction types

Addictions are defined in JSON using "addiction_type":

{
  "type": "addiction_type",
  "id": "caffeine",
  "name": "Caffeine Withdrawal",
  "type_name": "caffeine",
  "description": "Strength - 1;   Slight sluggishness;   Occasional cravings",
  "craving_morale": "morale_craving_caffeine",
  "effect_on_condition": "EOC_CAFFEINE_ADDICTION"
}
Field Description
"name" The name of the addiction’s effect as it appears in the player’s status
"type_name" The name of the addiction’s source
"description" Description of the addiction’s effects as it appears in the player’s status
"craving_morale" ID of the morale_type penalty
"effect_on_condition" ID of the effect_on_condition (can also be an inline EOC) which activates on each update_body (aka every turn)
"builtin" (for legacy addiction code) Name of a hardcoded function to process the addiction’s effect. For new addictions, use "effect_on_condition" instead.

Each turn, the player’s addictions are processed using either the given effect_on_condition or builtin. These effects usually have a rng condition so that the effect isn’t applied constantly every turn. Ex:

  {
    "type": "effect_on_condition", 
    "id": "EOC_MARLOSS_R_ADDICTION",
    "condition": { "math": [ "rand(800) <= addiction_rational(800, 20, u_addiction_intensity('marloss_r'))" ] },
    "effect": [
      { "u_add_morale": "morale_craving_marloss", "bonus": -5, "max_bonus": -30 },
      { "u_message": "You daydream about luscious pink berries as big as your fist.", "type": "info" },
      { "if": { "math": [ "u_val('focus') > 40" ] }, "then": { "math": [ "u_val('focus')", "--" ] } }
    ]
  },

Current hardcoded builtins:

  • nicotine_effect
  • alcohol_effect
  • diazepam_effect
  • opiate_effect
  • amphetamine_effect
  • cocaine_effect
  • crack_effect

Body Graphs

Body graphs are displayed in the body status menu, accessible by pressing s on the player’s @-screen. These are interactive graphs that highlight different body parts or sub body parts.

{
  "type": "body_graph",
  "id": "head",
  "parent_bodypart": "head",
  "fill_sym": "#",
  "fill_color": "white",
  "rows": [
    "             7777777777777              ",
    "          7777777777777777777           ",
    "         777777777777777777777          ",
    "        ######66666666666######         ",
    "        ####666666666666666####         ",
    "        ####666666666666666####         ",
    "      9 #####6666666666666##### 0       ",
    "      99#####111###4###222#####00       ",
    "      99####11111#444#22222####00       ",
    "      99##5555555544455555555##00       ",
    "       9##5555555544455555555##0        ",
    "        ##5555555444445555555##         ",
    "         ###555533333335555###          ",
    "          #####333333333#####           ",
    "           #######333#######            ",
    "            ###############             ",
    "            8 ########### 8             ",
    "         8888888 ##### 8888888          ",
    "       88888888888   88888888888        ",
    "           88888888888888888            "
  ],
  "parts": {
    "1": { "sub_body_parts": [ "eyes_left" ], "select_color": "red", "nested_graph": "eyes" },
    "2": { "sub_body_parts": [ "eyes_right" ], "select_color": "red", "nested_graph": "eyes" },
    "3": { "sub_body_parts": [ "mouth_lips" ], "select_color": "red", "nested_graph": "mouth" },
    "4": { "sub_body_parts": [ "mouth_nose" ], "select_color": "red", "nested_graph": "mouth" },
    "5": { "sub_body_parts": [ "mouth_cheeks" ], "select_color": "red", "nested_graph": "mouth" },
    "6": { "sub_body_parts": [ "head_forehead" ], "select_color": "red" },
    "7": { "sub_body_parts": [ "head_crown" ], "select_color": "red" },
    "8": { "sub_body_parts": [ "head_throat", "head_nape" ], "select_color": "red" },
    "9": { "sub_body_parts": [ "head_ear_r" ], "select_color": "red" },
    "0": { "sub_body_parts": [ "head_ear_l" ], "select_color": "red" }
  }
}
Field description
type Always body_graph.
id String uniquely identifying this graph.
parent_bodypart (optional) ID of the parent body part of this graph, if any. Only used to display the current body part as the window’s subtitle.
fill_sym (optional) Specifies a character to fill all sections of the graph when viewing in-game.
fill_color (optional) Specifies a color to use for unselected sections of the graph when viewing in-game.
rows Array of strings that form the graph. The symbols used for each fragment may correspond to an entry in parts, which form the sections of the graph. Empty spaces ( ) are ignored for the purposes of filling.
mirror (optional) Can be specified instead of rows. This takes a string ID referring to a different body_graph, which will be flipped horizontally and used as the rows in this graph (ex: hand_l mirrors hand_r).
parts A list of symbols present in the graph that correspond to specific body parts or sub body parts.

The resolution limit for the rows field is 40x20, in order to maintain compatibility with 80x24 terminals.

Graph Parts

The parts field can be used to define the interaction with different sections of the graph. Each part should reference at least one body part or sub body part.

Field description
body_parts An array of body_part IDs that are represented by this graph section.
sub_body_parts An array of sub_body_part IDs that are represented by this graph section.
sym (optional) A symbol to override fragments belonging to this section.
select_color (optional) Color to use when selecting this section.
nested_graph (optional) ID of another body_graph. When the player selects and confirms this section, the UI switches to the given nested graph.

Body_parts

| Identifier | Description |— |— | id | (mandatory) Unique ID. Must be one continuous word, use underscores if necessary. | name | (mandatory) In-game name displayed. | limb_type | (mandatory) Type of limb, as defined by bodypart.h. Certain functions will check only a given bodypart type for their purposes. Currently implemented types are: head, torso, sensor, mouth, arm, hand, leg, foot, wing, tail, other. | limb_types | (optional) (Can be used instead of limb_type) Weighted list of limb types this body part can emulate. The weights are modifiers that determine how good this body part is at acting like the given limb type. (Ex: [ [ "foot", 1.0 ], [ "hand", 0.15 ] ]) | secondary_types | (optional) List of secondary limb types for the bodypart, to include it in relevant calculations. | accusative | (mandatory) Accusative form for this bodypart. | heading | (mandatory) How it’s displayed in headings. | heading_multiple | (mandatory) Plural form of heading. Gets used if opposite bodyparts have the same encumbrance data, health and temperature. | encumbrance_text | (mandatory) Message printed when the limb reaches 40 encumbrance. | encumbrance_threshold| (optional) Encumbrance value where the limb’s scores start scaling based on encumbrance. Default 0, meaning scaling from the first point of encumbrance. | encumbrance_limit | (optional) When encumbrance reaches or surpasses this value the limb stops contributing its scores. Default 100. | grabbing_effect | (optional) Effect id of the GRAB_FILTER effect to apply to a monster grabbing this limb, necessary for adequate grab removal (see MONSTER_SPECIAL_ATTACKS.md for the grab logic). | hp_bar_ui_text | (mandatory) How it’s displayed next to the hp bar in the panel. | main_part | (mandatory) What is the main part this one is attached to. (If this is a main part it’s attached to itself) | connected_to | (mandatory if main_part is itself) What is the next part this one is attached to towards the “root” bodypart (the root bodypart should be connected to itself). Each anatomy should have a unique root bodypart, usually the head. | base_hp | (mandatory) The amount of hp this part has before any modification. | opposite_part | (mandatory) What is the opposite part of this one in case of a pair. | hit_size | (mandatory) Size of the body part for (melee) attack targeting. Monster special attacks are capable of targeting set bodypart hitsizes (see hitsize_min/max in MONSTERS.md). The character’s whole hitsize sum / base hitsize sum acts as a denominator of dodge rolls, meaning extra limbs passively make it harder to dodge. | hit_difficulty | (mandatory) How hard is it to hit a given body part, assuming “owner” is hit. Higher number means good hits will veer towards this part, lower means this part is unlikely to be hit by inaccurate attacks. Formula is chance *= pow(hit_roll, hit_difficulty) | drench_capacity | (mandatory) How wet this part can get before being 100% drenched. 0 makes the limb waterproof, morale checks for absolute wetness while other effects for wetness percentage - making a high drench_capacity prevent the penalties longer. | drench_increment | (optional) Units of “wetness” applied each time the limb gets drenched. Default 2, ignored by diving underwater. | drying_rate | (optional float) Divisor on the time needed to dry a given amount of wetness from a bodypart, modified by clothing. Final drying rate depends on breathability, weather, and drying_capacity of the bodypart. | wet_morale | (optional) Mood bonus/malus when the limb gets wet, representing the morale effect at 100% limb saturation. Modified by worn clothing and ambient temperature. | stylish_bonus | (optional) Mood bonus associated with wearing fancy clothing on this part. (default: 0) | hot_morale_mod | (optional) Mood effect of being too hot on this part. (default: 0) | cold_morale_mod | (optional) Mood effect of being too cold on this part. (default: 0) | squeamish_penalty | (optional) Mood effect of wearing filthy clothing on this part. (default: 0) | fire_warmth_bonus | (optional) How effectively you can warm yourself at a fire with this part. (default: 0) | temp_mod | (optional array) Intrinsic temperature modifier of the bodypart. The first value (in the same “temperature unit” as mutations’ bodytemp_modifier) is always applied, the second value is applied on top when the bodypart isn’t overheated. | env_protection | (optional) Innate environmental protection of this part. (default: 0) | stat_hp_mods | (optional) Values modifying hp_max of this part following this formula: hp_max += int_mod*int_max + dex_mod*dex_max + str_mod*str_max + per_mod*per_max + health_mod*get_healthy() with X_max being the unmodified value of the X stat and get_healthy() being the hidden health stat of the character. | heal_bonus | (optional) Innate amount of HP the bodypart heals every successful healing roll. See the ALWAYS_HEAL and HEAL_OVERRIDE flags. | mend_rate | (optional) Innate mending rate of the limb, should it get broken. Default 1.0, used as a multiplier on the healing factor after other factors are calculated. | health_limit | (optional) Amount of limb HP necessary for the limb to provide its melee techniques and conditional_flags. Defaults to 1, meaning broken limbs don’t contribute. | ugliness | (optional) Ugliness of the part that can be covered up, negatives confer beauty bonuses. | ugliness_mandatory | (optional) Inherent ugliness that can’t be covered up by armor. | bionic_slots | (optional) How many bionic slots does this part have. | is_limb | (optional) Is this bodypart a limb and capable of breaking. (default: false) | smash_message | (optional) The message displayed when using that part to smash something. | smash_efficiency | (optional) Modifier applied to your smashing strength when using this part to smash terrain or furniture unarmed. (default: 0.5) | flags | (optional) List of bodypart flags. These are considered character flags, similar to bionic/trait/effect flags. | conditional_flags | (optional) List of character flags this limb provides as long as it’s above health_limit HP. | techniques | (optional) List of melee techniques granted by this limb as long as it’s above its health_limit HP. The chance for the technique to be included in each attack’s tech list is dependent on limb encumbrance. ( !x_in_y(current encumbrance / technique_encumbrance_limit) | technique_encumbrance_limit | (optional) Level of encumbrance that disables the given techniques for this limb completely, lower encumbrance still reduces the chances of the technique being chosen (see above). | limb_scores | (optional) List of arrays defining limb scores. Each array contains 2 mandatory values and 1 optional value. Value 1 is a reference to a limb_score id. Value 2 is a float defining the limb score’s value. (optional) Value 3 is a float defining the limb score’s maximum value (mostly just used for manipulator score). | effects_on_hit | (optional) Array of effects that can apply whenever the limb is damaged. For details see below. | unarmed_damage | (optional) An array of objects, each detailing the amount of unarmed damage the bodypart contributes to unarmed attacks and their armor penetration. The unarmed damages of each limb are summed and added to the base unarmed damage. Should be used for limbs the character is expected to always attack with, for special attacks use a dedicated technique. | similar_bodyparts | (optional) Array of (sub)bodypart ids. Armor coverage is automatically extended to these bodyparts - Ex: any armor covering the bodypart arm_l will cover arm_bear_l with the same coverage in the below example. Sublocations will need a similar definition as well to ensure correct function. Currently bodyparts can only point at bodyparts and sub-bodyparts at sub-bodyparts. Only one step of substitution occurs ( Ie. an armor covering arm_l will cover arm_bear_l, but not any similar bps defined in arm_bear_l ). Any coverage of a similar sbp will imply coverage of the substitute subpart’s parent for the sub-part in question: Armor covering the elbows will cover similar elbows on other limbs, but not any of the other locations. | armor | (optional) An object containing damage resistance values. Ex: "armor": { "bash": 2, "cut": 1 }. See Part Resistance for details.

{
  "id": "arm_l",
  "type": "body_part",
  "//": "See comments in `body_part_struct::load` of bodypart.cpp about why xxx and xxx_multiple are not inside a single translation object.",
  "name": "left arm",
  "name_multiple": "arms",
  "accusative": { "ctxt": "bodypart_accusative", "str": "left arm" },
  "accusative_multiple": { "ctxt": "bodypart_accusative", "str": "arms" },
  "heading": "L. Arm",
  "heading_multiple": "Arms",
  "encumbrance_text": "Melee and ranged combat is hampered.",
  "hp_bar_ui_text": "L ARM",
  "main_part": "arm_l",
  "connected_to": "torso",
  "opposite_part": "arm_r",
  "hit_size": 9,
  "hit_difficulty": 0.95,
  "limb_type": "arm",
  "limb_scores": [ [ "manip", 0.1, 0.2 ], [ "lift", 0.5 ], [ "block", 1.0 ], [ "swim", 0.1 ] ],
  "armor": { "electric": 2, "stab": 1 },
  "side": "left",
  "legacy_id": "ARM_L",
  "hot_morale_mod": 0.5,
  "cold_morale_mod": 0.5,
  "fire_warmth_bonus": 600,
  "squeamish_penalty": 5,
  "is_limb": true,
  "base_hp": 60,
  "drench_capacity": 10,
  "smash_message": "You elbow-smash the %s.",
  "bionic_slots": 20,
  "similar_bodyparts": [ "arm_bear_l" ],
  "sub_parts": [ "arm_shoulder_l", "arm_upper_l", "arm_elbow_l", "arm_lower_l" ]
}

On-hit Effects

An array of effects to add whenever the limb in question takes damage. Variables for each entry:

Identifier Description
id (mandatory) ID of the effect to apply.
global (optional) Bool, if true the effect won’t apply to the bodypart but to the whole character. Default false.
dmg_type (optional) String id of the damage type eligible to apply the effect. Defaults to all damage.
dmg_threshold (optional) Integer, amount of damage to trigger the effect. For main parts used as percent of limb max health, for minor parts as absolute damage amount. Default 1.
dmg_scale_increment (optional) Float, steps of scaling based on damage above damage_threshold. Default 1.
chance (optional) Integer, percent chance to trigger the effect. Default 100.
chance_dmg_scaling (optional) Float, chance is increased by this value for every dmg_scale_increment above dmg_threshold. Default 0.
intensity (optional) Integer, intensity of effect to apply. Default 1.
intensity_dmg_scaling (optional) Float, intensity is increased by this value for every dmg_scale_increment above dmg_threshold. Default 0.
max_intensity (optional) Integer, max intensity the limb can gain as part of the onhit effect - other sources of effects like spells or explicit special attack effects can still apply higher intensities. Default INT_MAX.
duration (optional) Integer, duration of effect to apply in seconds. Default 1.
duration_dmg_scaling (optional) Float, duration is increased by this value for every dmg_scale_increment above dmg_threshold. Default 0.
max_duration (optional) Integer, max seconds duration the limb can gain as part of the onhit effect - see max_intensity. Default INT_MAX. 
{
"effects_on_hit": [
    {
      "id": "staggered",
      "dmg_type": "bash",
      "dmg_threshold": 5,
      "dmg_scale_increment": 5,
      "chance": 10,
      "chance_dmg_scaling": 10,
      "duration": 5,
      "duration_dmg_scaling": 2,
      "max_duration": 15
    },
    {
      "id": "downed",
      "global": true,
      "dmg_threshold": 20,
      "dmg_scale_increment": 10,
      "chance": 5,
      "chance_dmg_scaling": 20,
      "duration": 2,
      "duration_dmg_scaling": 0.5
    }
  ]
}

Limb scores

Limb scores act as the basis of calculating the effect of limb encumbrance and damage on the abilities of characters. Most limb scores affect the character via character_modifiers, for further information see there. They are defined using the "limb_score" type:

{
  "type": "limb_score",
  "id": "lift",
  "name": "Lifting",
  "affected_by_wounds": true,
  "affected_by_encumb": false
}
  • "type": Always “limb_score”.
  • "id": Identifies this limb score
  • "name": Mandatory. Defines a translatable name for this limb score that will be displayed in the UI.
  • "affected_by_wounds": Optional, defaults to true. Determines whether this limb score is affected by the character’s limb health. Lower limb health => lower score.
  • "affected_by_encumb": Optional, defaults to true. Determines whether this limb score is affected by the character’s limb encumbrance. Higher encumbrance => lower score.

Here are the currently defined limb scores:

Limb score id Description
consume_liquid Speed modifier when consuming liquids.
consume_solid Speed multiplier when consuming solids.
manipulator_score Modifies aim speed, reload speed, thrown attack speed, ranged dispersion and crafting speed. The manipulator scores of each limb type are aggregated and the best limb group is chosen for checks.
manipulator_max The upper limit of manipulator score the limb can contribute to.
lifting_score Modifies melee attack stamina and move cost, as well as a number of STR checks. A sum above 0.5 qualifies for wielding two-handed weapons and similar checks. Arms below 0.1 lift score don’t count as working for the purposes of melee combat.
blocking_score The blocking limb is chosen by a roll weighted by eligible limbs’ block score, and blocking efficiency is multiplied by the target limb’s score.
breathing_score Modifies stamina recovery speed and shout volume.
vision_score Modifies ranged dispersion, ranged and melee weakpoint hit chances.
nightvision_score Modifies night vision range (multiplier on the calculated range).
reaction_score Modifies dodge chance, block chance, melee weakpoint hit chances.
balance_score Modifies thrown attack speed, movement cost and melee attack rolls.
footing_score Modifies movement cost.
movement_speed_score Modifies movement cost.
swim_score Modifies swim speed.

These limb scores are referenced in "body_part" within the "limb_scores" array. (See body parts).

Character Modifiers

Character modifiers define how effective different behaviours are for actions the character takes. These are usually derived from a limb score.

{
  "type": "character_mod",
  "id": "ranged_dispersion_manip_mod",
  "description": "Hand dispersion when using ranged attacks",
  "mod_type": "+",
  "value": { "limb_score": "manip", "max": 1000.0, "nominator": 22.8, "subtract": 22.8 }
},
{
  "type": "character_mod",
  "id": "slip_prevent_mod",
  "description": "Slip prevention modifier",
  "mod_type": "x",
  "value": {
    "limb_score": [ [ "grip", 3.0 ], [ "lift", 2.0 ], "footing" ],
    "override_encumb": true,
    "limb_score_op": "+",
    "denominator": 6.0
  }
},
{
  "type": "character_mod",
  "id": "stamina_move_cost_mod",
  "description": "Stamina move cost modifier",
  "mod_type": "x",
  "value": { "builtin": "stamina_move_cost_modifier" }
}
Field Description
type Always “character_mod”.
id Unique identifier for this character modifier.
description Translatable text that describes the function of this modifier, which will be displayed in the UI.
mod_type Describes how this modifier is applied. Can be "+" (added), "x" (multiplied), or "" (unspecified).
value Object that describes how this modifier is calculated.

Character Modifiers - Value

Field Description
limb_score Refers to a limb_score id, or an array of limb_score id’s (can be a weighted list). These are the limb scores from which this modifier is derived. For additive calculations ( limb_score_op: "+") the score is multiplied by the weight, for multiplicative calculation (limb_score_op: "x") it is raised to the weight’s power.
limb_score_op (optional) Operation (add + or multiply x) to apply when multiple limb scores are defined. Ex: x => score1 x score2 x score3 .... (Defaults to x)
limb_type (optional) Refers to a limb_type as defined in body_part. If present, only limb scores from body parts with that limb_type are used.
override_encumb (optional) Boolean (true/false). If specified, this forces the limb score to be affected/unaffected by limb encumbrance if true/false. (Overrides affected_by_encumb in limb_score)
override_wounds (optional) Boolean (true/false). If specified, this forces the limb score to be affected/unaffected by limb health if true/false.(Overrides affected_by_wounds in limb_score)
min (optional) Defines a minimum value for this modifier. Generally only used for “bonus” multipliers that provide a benefit. Should not be used together with max.
max (optional) Defines a maximum value for this modifier. Generally used for “cost” multipliers that provide a malus. Should not be used together with min. This value can be defined as a decimal or as the special value "max_move_cost".
nominator (optional) Causes the limb score to divide the specified value, such that nominator / ( limb_score * denominator ).
denominator (optional) Divides the limb score (or the nominator, if specified) by the specified value, such that limb_score / denominator.
subtract (optional) Defines a value to subtract from the resulting modifier, such that mod - subtract.
builtin Instead of a limb score, the value object can define a built-in function to handle the calculation of the modifier.

The modifier is normally derived from a limb score, which is modified in a sequence of operations. Here are some possible outcomes for different combinations of specified fields in value:

// Only one "limb_score" specified:
mod = limb_score;
// 3 score id's in "limb_score" array (with "x" operation):
mod = limb_score1 * limb_score2 * limb_score3;
// "max" specified:
mod = min( max, limb_score );
// "min" specified:
mod = max( min, limb_score );
// Both "max" and "nominator" specified:
mod = min( max, nominator / limb_score );
// "max", "nominator", and "subtract" specified:
mod = min( max, ( nominator / limb_score ) - subtract );
// "max", "denominator", and "subtract" specified:
mod = min( max, ( limb_score / denominator ) - subtract );

Bionics

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary.
name In-game name displayed.
description In-game description.
act_cost (optional) How many kJ it costs to activate the bionic. Strings can be used “1 kJ”/”1000 J”/”1000000 mJ” (default: 0)
deact_cost (optional) How many kJ it costs to deactivate the bionic. Strings can be used “1 kJ”/”1000 J”/”1000000 mJ” (default: 0)
react_cost (optional) How many kJ it costs over time to keep this bionic active, does nothing without a non-zero “time”. Strings can be used “1 kJ”/”1000 J”/”1000000 mJ” (default: 0)
trigger_cost (optional) How many kJ it costs to trigger special effects for this bionic. This can be a reaction to specific conditions or an action taken while the bionic is active. Strings can be used “1 kJ”/”1000 J”/”1000000 mJ” (default: 0)
time (optional) How long, when activated, between drawing cost. If 0, it draws power once. (default: 0)
upgraded_bionic (optional) Bionic that can be upgraded by installing this one.
available_upgrades (optional) Upgrades available for this bionic, i.e. the list of bionics having this one referenced by upgraded_bionic.
encumbrance (optional) A list of body parts and how much this bionic encumber them.
known_ma_styles (optional) A list of martial art styles that are known to the wearer when the bionic is activated
canceled_mutations (optional) A list of mutations/traits that are removed when this bionic is installed (e.g. because it replaces the fault biological part).
mutation_conflicts (optional) A list of mutations that prevent this bionic from being installed.
included_bionics (optional) Additional bionics that are installed automatically when this bionic is installed. This can be used to install several bionics from one CBM item, which is useful as each of those can be activated independently.
included (optional) Whether this bionic is included with another. If true this bionic does not require a CBM item to be defined. (default: false)
env_protec (optional) How much environmental protection does this bionic provide on the specified body parts.
protec (optional) An array of resistance values that determines the types of protection this bionic provides on the specified body parts.
occupied_bodyparts (optional) A list of body parts occupied by this bionic, and the number of bionic slots it take on those parts.
capacity (optional) Amount of power storage added by this bionic. Strings can be used “1 kJ”/”1000 J”/”1000000 mJ” (default: 0)
fuel_options (optional) A list of materials that this bionic can use to produce bionic power.
is_remote_fueled (optional) If true this bionic allows you to plug your power banks to an external power source (solar backpack, UPS, vehicle etc) via a cable. (default: false)
fuel_capacity (optional) Volume of fuel this bionic can store.
fuel_efficiency (optional) Fraction of fuel energy converted into power. (default: 0)
passive_fuel_efficiency (optional) Fraction of fuel energy passively converted into power. Useful for CBM using PERPETUAL fuel like muscle, wind or sun_light. (default: 0)
exothermic_power_gen (optional) If true this bionic emits heat when producing power. (default: false)
coverage_power_gen_penalty (optional) Fraction of coverage diminishing fuel_efficiency. Float between 0.0 and 1.0. (default: nullopt)
power_gen_emission (optional) emit_id of the field emitted by this bionic when it produces energy. Emit_ids are defined in emit.json.
stat_bonus (optional) List of passive stat bonus. Stat are designated as follow: “DEX”, “INT”, “STR”, “PER”.
activated_eocs (optional) List of effect_on_conditions that attempt to activate when this CBM is successfully activated.
processed_eocs (optional) List of effect_on_conditions that attempt to activate each turn this CBM is active.
deactivated_eocs (optional) List of effect_on_conditions that attempt to activate when this CBM is successfully deactivated.
enchantments (optional) List of enchantments applied by this CBM (see MAGIC.md for instructions on enchantment. NB: enchantments are not necessarily magic.) Values can either be the enchantment’s id or an inline definition of the enchantment.
learned_spells (optional) Map of {spell:level} you gain when installing this CBM, and lose when you uninstall this CBM. Spell classes are automatically gained.
learned_proficiencies (optional) Array of proficiency ids you gain when installing this CBM, and lose when uninstalling
installation_requirement (optional) Requirement id pointing to a requirement defining the tools and components necessary to install this CBM.
dupes_allowed (optional) Boolean to determine if multiple copies of this bionic can be installed. Defaults to false.
cant_remove_reason (optional) String message to be displayed as the reason it can’t be uninstalled. Having any value other than "" as this will prevent unistalling the bionic. Formatting includes two %s for example: The Telescopic Lenses are part of %1$s eyes now. Removing them would leave %2$s blind. (default: "")
social_modifiers (optional) Json object with optional members: persuade, lie, and intimidate which add or subtract that amount from those types of social checks
activated_on_install (optional) Auto-activates this bionic when installed.
required_bionic (optional) Bionic which is required to install this bionic, and which cannot be uninstalled if this bionic is installed
give_mut_on_removal (optional) A list of mutations/traits that are added when this bionic is uninstalled (for example a “blind” mutation if you removed bionic eyes after installation).
passive_pseudo_items (optional) This fake item is added into player’s inventory, when bionic is installed.
installable_weapon_flags (optional) Items with this flag can be installed inside this bionic
fake_weapon (optional) Activation of this bionic spawn an irremovable weapon in your hands. Require BIONIC_TOGGLED flag
active_flags (optional) Activation of this bionic applies this character flag
auto_deactivates (optional) Activation of this bionic automatically turn of another bionic, if character has one
toggled_pseudo_items (optional) Activation of this bionic spawn an irremovable tool in your hands. Require BIONIC_TOGGLED flag
spell_on_activation (optional) Activation of this bionic allow you to cast a spell
activated_close_ui (optional) Activation of this bionic closes the bionic menu 
{
    "id"           : "bio_batteries",
    "name"         : "Battery System",
    "active"       : false,
    "act_cost"     : 0,
    "time"         : 1,
    "fuel_efficiency": 1,
    "stat_bonus": [ [ "INT", 2 ], [ "STR", 2 ] ],
    "fuel_options": [ "battery" ],
    "fuel_capacity": 500,
    "encumbrance"  : [ [ "torso", 10 ], [ "arm_l", 10 ], [ "arm_r", 10 ], [ "leg_l", 10 ], [ "leg_r", 10 ], [ "foot_l", 10 ], [ "foot_r", 10 ] ],
    "description"  : "You have a battery draining attachment, and thus can make use of the energy contained in normal, everyday batteries. Use 'E' to consume batteries.",
    "canceled_mutations": ["HYPEROPIC"],
    "mutation_conflicts": [ "HUGE" ],
    "installation_requirement": "sewing_standard",
    "included_bionics": ["bio_blindfold"]
},
{
    "id": "bio_purifier",
    "type": "bionic",
    "name": "Air Filtration System",
    "description": "Surgically implanted in your trachea is an advanced filtration system.  If toxins, or airborne diseases find their way into your windpipe, the filter will attempt to remove them.",
    "occupied_bodyparts": [ [ "torso", 4 ], [ "mouth", 2 ] ],
    "env_protec": [ [ "mouth", 7 ] ],
    "protec": [
      [ "arm_l", { "bash": 3, "cut": 3, "bullet": 3 } ],
      [ "arm_r", { "bash": 3, "cut": 3, "bullet": 3 } ],
      [ "hand_l", { "bash": 3, "cut": 3, "bullet": 3 } ],
      [ "hand_r", { "bash": 3, "cut": 3, "bullet": 3 } ]
    ],
    "flags": [ "BIONIC_NPC_USABLE" ]
},
  {
    "id": "bio_hydraulics",
    "type": "bionic",
    "name": { "str": "Hydraulic Muscles" },
    "description": "While activated, your muscles will be greatly enhanced, increasing your strength by 20.",
    "occupied_bodyparts": [ [ "torso", 10 ], [ "arm_l", 8 ], [ "arm_r", 8 ], [ "leg_l", 10 ], [ "leg_r", 10 ] ],
    "flags": [ "BIONIC_TOGGLED", "BIONIC_NPC_USABLE" ],
    "act_cost": "10 kJ",
    "react_cost": "10 kJ",
    "time": "1 s",
    "required_bionic": "bio_weight"
  },
  {
    "type": "bionic",
    "id": "afs_bio_skullgun",
    "name": { "str": "Skullgun" },
    "description": "Concealed in your head is a single shot 10mm pistol.  Activate the bionic to fire and reload the skullgun.",
    "occupied_bodyparts": [ [ "head", 5 ] ],
    "encumbrance": [ [ "head", 5 ] ],
    "fake_weapon": "bio_skullgun_gun",
    "flags": [ "BIONIC_GUN" ],
    "stat_bonus": [ [ "INT", -4 ], [ "PER", -2 ] ],
    "canceled_mutations": [ "INT_UP", "INT_UP_2", "INT_UP_3", "INT_UP_4", "INT_ALPHA", "SKULLGUN_STUPID" ],
    "give_mut_on_removal": [ "SKULLGUN_STUPID" ],
    "activated_close_ui": true
  }

Bionics effects are defined in the code and new effects cannot be created through JSON alone. When adding a new bionic, if it’s not included with another one, you must also add the corresponding CBM item in data/json/items/bionics.json. Even for a faulty bionic.

Damage Types

Field Description
name The name of the damage type as it appears in the protection values in the item info screen.
skill (optional) Determines the skill used when dealing this damage type. (defaults to none)
physical (optional) Identifies this damage type as originating from physical sources. (defaults to false)
melee_only (optional) Identifies this damage type as originating from melee weapons and attacks. (defaults to false)
edged (optional) Identifies this damage type as originating from a sharp or pointy weapon or implement. (defaults to false)
environmental (optional) This damage type corresponds to environmental sources. Currently influences whether an item or piece of armor includes environmental resistance against this damage type. (defaults to false)
material_required (optional) Determines whether materials must defined a resistance for this damage type. (defaults to false)
mon_difficulty (optional) Determines whether this damage type should contribute to a monster’s difficulty rating. (defaults to false)
no_resist (optional) Identifies this damage type as being impossible to resist against (ie. “pure” damage). (defaults to false)
immune_flags (optional) An object with two optional fields: "character" and "monster". Both inner fields list an array of character flags and monster flags, respectively, that would make the character or monster immune to this damage type.
magic_color (optional) Determines which color identifies this damage type when used in spells. (defaults to “black”)
derived_from (optional) An array that determines how this damage type should be calculated in terms of armor protection and monster resistance values. The first value is the source damage type and the second value is the modifier applied to source damage type calculations.
onhit_eocs (optional) An array of effect-on-conditions that activate when a monster or character hits another monster or character with this damage type. In this case, u refers to the damage source and npc refers to the damage target.
ondamage_eocs (optional) An array of effect-on-conditions that activate when a monster or character takes damage from another monster or character with this damage type. In this case, u refers to the damage source and npc refers to the damage target. Also have access to some context vals 
  {
    "//": "stabbing/piercing damage",
    "id": "stab",
    "type": "damage_type",
    "melee_only": true,
    "physical": true,
    "edged": true,
    "magic_color": "light_red",
    "name": "pierce",
    "skill": "stabbing",
    "//2": "derived from cut only for monster defs",
    "derived_from": [ "cut", 0.8 ],
    "immune_flags": { "character": [ "STAB_IMMUNE" ] }
  },
  {
    "//": "e.g. electrical discharge",
    "id": "electric",
    "type": "damage_type",
    "physical": false,
    "magic_color": "light_blue",
    "name": "electric",
    "immune_flags": { "character": [ "ELECTRIC_IMMUNE" ], "monster": [ "ELECTRIC", "ELECTRIC_FIELD" ] },
    "onhit_eocs": [ "EOC_ELECTRIC_ONHIT" ]
  }

Damage Info Ordering

Damage types are displayed in various parts of the item info UI, representing armor resistances, melee damage, etc. Using damage_info_order we can reorder how these are shown, and even determine whether they can be displayed at all.

Field Description
id Unique identifier, must correspond to an existing damage_type
info_display (optional) Determines the detail in which this damage type is displayed in protection values. Valid values are “detailed”, “basic”, and “none”. (defaults to “none”)
verb (optional) A verb describing how this damage type is applied (ex: “bashing”). Used in the melee section of an item’s info.
*_info (optional) An object that determines the order and visibility of this damage type for the specified section of an item’s info. "order" determines where in the list of damage types it will be displayed in this section, and "show_type" determines whether to show this damage type in this section. Possible sections include: bionic_info, protection_info, pet_prot_info, melee_combat_info, and ablative_info. 
{
  "id": "acid",
  "type": "damage_info_order",
  "info_display": "basic",
  "verb": "corroding",
  "bionic_info": { "order": 500, "show_type": true },
  "protection_info": { "order": 800, "show_type": true },
  "pet_prot_info": { "order": 500, "show_type": true },
  "melee_combat_info": { "order": 500, "show_type": false },
  "ablative_info": { "order": 500, "show_type": false }
}

Dreams

Identifier Description
messages List of potential dreams.
category Mutation category needed to dream.
strength Mutation category strength required (1 = 20-34, 2 = 35-49, 3 = 50+). 
{
    "messages" : [
        "You have a strange dream about birds.",
        "Your dreams give you a strange feathered feeling."
    ],
    "category" : "MUTCAT_BIRD",
    "strength" : 1
}

Disease

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary.
min_duration The minimum duration the disease can last. Uses strings “x m”, “x s”,”x d”.
max_duration The maximum duration the disease can last.
min_intensity The minimum intensity of the effect applied by the disease
max_intensity The maximum intensity of the effect.
health_threshold The amount of health above which one is immune to the disease. Must be between -200 and 200. (optional )
symptoms The effect applied by the disease.
affected_bodyparts The list of bodyparts on which the effect is applied. (optional, default to bp_null) 
  {
    "type": "disease_type",
    "id": "bad_food",
    "min_duration": "6 m",
    "max_duration": "1 h",
    "min_intensity": 1,
    "max_intensity": 1,
    "affected_bodyparts": [ "TORSO" ],
    "health_threshold": 100,
    "symptoms": "foodpoison"
  }

End Screen

Identifier Description
id (mandatory) Unique ID. Must be one continuous word, use underscores if necessary.
priority (mandatory) Int used to chose among several end sreens with valid conditions, higher value have higher priority. Priority 0 is the default tombstone end.
picture_id (mandatory) ID of an ascii art, see #Ascii_arts.
condition (mandatory) Conditions necessary to display this end screen. See the “Dialogue conditions” section of NPCs for the full syntax.
added_info (optional) Vector of pairs of a pair of int character offset and Line number and a string to be written on the end screen. The string can use talk tags, see the “Special Custom Entries” section of NPCs for the full syntax.
last_words_label (optional) String used to label the last word input prompt. If left empty no prompt will be displayed. 
  {
    "type": "end_screen",
    "id": "death_cross",
    "priority": 1,
    "picture_id": "ascii_rip_cross",
    "condition": {
      "and": [
        { "not": "u_is_alive" },
        {
          "or": [ { "u_has_item": "holybook_bible1" }, { "u_has_item": "holybook_bible2" }, { "u_has_item": "holybook_bible3" } ]
        },
        { "not": { "and": [ { "u_has_trait": "CANNIBAL" }, { "u_has_trait": "PSYCHOPATH" } ] } }
      ]
    },
    "added_info": [
      [ [ 8, 8 ], "In memory of: <u_name>" ],
      [ [ 15, 9 ], "Survived: <time_survived>" ],
      [ [ 17, 10 ], "Kills: <total_kills>" ]
    ],
    "last_words_label": "Last Words:"
  }

Emitters

Emitters randomly place fields around their positions - every turn for monster emissions, every ten seconds for furniture/terrain.

Identifier Description
id Unique ID
field Field type emitted. This can be a Variable Object, see the doc for more info.
intensity Initial intensity of the spawned fields (spawning multiple fields will still cause their intensity to increase). Default 1. This can be a Variable Object, see the doc for more info.
chance Percent chance of the emitter emitting, values above 100 will increase the quantity of fields placed via roll_remainder (ex: chance: 150 will place one field 50% of the time and two fields the other 50% ). Failing the roll will disable the whole emission for the tick, not rolled for every qty! Default 100. This can be a Variable Object, see the doc for more info.
qty Number of fields placed. Fields are placed using the field propagation rules, allowing fields to spread. Default 1. This can be a Variable Object, see the doc for more info. 
  {
    "id": "emit_shock_burst",
    "type": "emit",
    "field": "fd_electricity",
    "intensity": 3,
    "chance": 1,
    "qty": 10
  },

Item Groups

Item groups have been expanded, look at the detailed docs to their new description. The syntax listed here is still valid.

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary
items List of potential item ID’s. Chance of an item spawning is x/T, where X is the value linked to the specific item and T is the total of all item values in a group.
groups ?? 
{
    "id":"forest",
    "items":[
        ["rock", 40],
        ["stick", 95],
        ["mushroom", 4],
        ["mushroom_poison", 3],
        ["mushroom_magic", 1],
        ["blueberries", 3]
    ],
    "groups":[]
}

Item Category

When you sort your inventory by category, these are the categories that are displayed.

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary
name_header The name of the category used for headers. This is what shows up in-game when you open the inventory.
name_noun The name of the category used for descriptive text, including singular and plural names.
zone The corresponding loot_zone (see loot_zones.json)
sort_rank Used to sort categories when displaying. Lower values are shown first
priority_zones When set, items in this category will be sorted to the priority zone if the conditions are met. If the user does not have the priority zone in the zone manager, the items get sorted into zone set in the ‘zone’ property. It is a list of objects. Each object has 3 properties: ID: The id of a LOOT_ZONE (see LOOT_ZONES.json), filthy: boolean. setting this means filthy items of this category will be sorted to the priority zone, flags: array of flags
spawn_rate Sets amount of items from item category that might spawn. Checks for spawn_rate value for item category. If spawn_chance is 0.0, the item will not spawn. If spawn_chance is greater than 0.0 and less than 1.0, it will make a random roll (0.0-1.0) to check if the item will have a chance to spawn. If spawn_chance is more than or equal to 1.0, it will add a chance to spawn additional items from the same category. Items will be taken from item group which original item was located in. Therefore this parameter won’t affect chance to spawn additional items for items set to spawn solitary in mapgen (e.g. through use of item or place_item). 
{
    "id": "armor",
    "name": "ARMOR",
    "zone": "LOOT_ARMOR",
    "sort_rank": -21,
    "priority_zones": [ { "id": "LOOT_FARMOR", "filthy": true, "flags": [ "RAINPROOF" ] } ],
    "spawn_rate": 0.5
}

Item Properties

Properties are bound to item’s type definition and code checks for them for special behaviour, for example the property below makes a container burst open when filled over 75% and it’s thrown.

  {
    "properties": { "burst_when_filled": "75" }
  }

Item Variables

Item variables are bound to the item itself and used to serialize special behaviour, for example folding a vehicle serializes the folded vehicle’s name and list of parts (part type ids, part damage, degradation etc) into json string for use when unfolding.

They can originate from code - like in the example above when folding a vehicle.

Alternatively item variables may also originate from the item’s prototype. Specifying them can be done in the item’s definition, add the variables key and inside write a key-value map.

Example:

    "variables": {
      "special_key": "spiffy value"
    }

This will make any item instantiated from that prototype get assigned this variable, once the item is spawned the variables set on the prototype no longer affect the item’s variables, a migration can clear out the item’s variables and reassign the prototype ones if reset_item_vars flag is set.

Item faults

Faults can be defined for more specialized damage of an item.

{
  "type": "fault",
  "id": "fault_gun_chamber_spent", // unique id for the fault
  "name": { "str": "Spent casing in chamber" }, // fault name for display
  "description": "This gun currently...", // fault description
  "item_prefix": "jammed", // optional string, items with this fault will be prefixed with this
  "price_modifier": 0.4, // (Optional, double) Defaults to 1 if not specified. A multiplier on the price of an item when this fault is present. Values above 1.0 will increase the item's value.
  "flags": [ "JAMMED_GUN" ] // optional flags, see below
}

flags trigger hardcoded C++ chunks that provide effects, see JSON_FLAGS.md for a list of possible flags.

Item fault fixes

Fault fixes are methods to fix faults, the fixes can optionally add other faults, modify damage, degradation and item variables.

{
  "type": "fault_fix",
  "id": "mend_gun_fouling_clean", // unique id for the fix
  "name": "Clean fouling", // name for display
  "success_msg": "You clean your %s.", // message printed when fix is applied
  "time": "50 m", // time to apply fix
  "faults_removed": [ "fault_gun_dirt", "fault_gun_blackpowder" ], // faults removed when fix is applied
  "faults_added": [ "fault_gun_unlubricated" ], // faults added when fix is applied
  "skills": { "mechanics": 1 }, // skills required to apply fix
  "set_variables": { "dirt": "0" }, // sets the variables on the item when fix is applied
  "adjust_variables_multiply": { "dirt": ".8" }, // adjusts the variables on the item when fix is applied using MULTIPLICATION
  "requirements": [ [ "gun_cleaning", 1 ] ], // requirements array, see below
  "mod_damage": 1000, // damage to modify on item when fix is applied, can be negative to repair
  "mod_degradation": 50, // degradation to modify on item when fix is applied, can be negative to reduce degradation
  "time_save_profs": { "prof_gun_cleaning": 0.5 }, // this prof change how fast you fix the item
  "time_save_flags": { "EASY_CLEAN": 0.5 } // This flag on the item change how fast you fix this item
}

requirements is an array of requirements, they can be specified in 2 ways:

  • An array specifying an already defined requirement by it’s id and a multiplier, [ "gun_lubrication", 2 ] will add gun_lubrication requirement and multiply the components and tools ammo required by 2.
  • Inline object specifying the requirement in the same way recipes define it

Materials

Identifier Description
id Unique ID. Lowercase snake_case. Must be one continuous word, use underscores if necessary.
name In-game name displayed.
resist An object that determines resistance values for this material.
chip_resist Returns resistance to being damaged by attacks against the item itself.
bash_dmg_verb Verb used when material takes bashing damage.
cut_dmg_verb Verb used when material takes cutting damage.
dmg_adj Description added to damaged item in ascending severity.
dmg_adj Adjectives used to describe damage states of a material.
density Affects vehicle collision damage, with denser parts having the advantage over less-dense parts.
wind_resist Percentage 0-100. How effective this material is at stopping wind from getting through. Higher values are better. If none of the materials an item is made of specify a value, a default of 99 is assumed.
vitamins Vitamins in a material. Usually overridden by item specific values. An integer percentage of ideal daily value.
specific_heat_liquid Specific heat of a material when not frozen (J/(g K)). Default 4.186 - water.
specific_heat_solid Specific heat of a material when frozen (J/(g K)). Default 2.108 - water.
latent_heat Latent heat of fusion for a material (J/g). Default 334.
freezing_point Freezing point of this material (C). Default 0 C ( 32 F ).
edible Optional boolean. Default is false.
rotting Optional boolean. Default is false.
breathability What breathability the clothes, made out of this material, would have; can be IMPERMEABLE (0%), POOR (30%), AVERAGE (50%), GOOD (80%), MOISTURE_WICKING (110%), SECOND_SKIN (140%)
burn_products Burning this material drop this items; array, first in array is the id of an item, and another is the number, respond for effeciency of burning - the bigger the burnable item is (by weight), and the more items there is, the bigger output; Multiple items could be returned simultaneously, like [ [ "corpse_ash", 0.035 ], [ "glass_shard", 0.5 ] ],
repair_difficulty Skill level that would be used to repair this item by default; if item has multiple materials, the most difficult would be used
repaired_with Material, that would be used to repair item, made out of this material
salvaged_into Item, into which this material could be salvaged
sheet_thickness Clothes, made out of this material, has this thickness, meaning clothes thickness should be multiple of this value; layered kevlar has "sheet_thickness": 4.4,, meaning all clothes that uses layered kevlar should be either 4.4, 8.8, 13.2 etc milimeters thick; unless "ignore_sheet_thickness": true is used for this clothes
uncomfortable Clothes made out of this material is always uncomfortable, no matter of it’s properties
soft True for pliable materials, whose length doesn’t prevent fitting into a container, or through the opening of a container. Default is false.
conductive True if the material conducts electricity, defaults to false
reinforces Optional boolean. Default is false.

There are seven -resist parameters: acid, bash, chip, cut, elec, fire, and bullet. These are integer values; the default is 0 and they can be negative to take more damage.

{
    "type": "material",
    "id": "hflesh",
    "name": "Human Flesh",
    "density": 5,
    "specific_heat_liquid": 3.7,
    "specific_heat_solid": 2.15,
    "latent_heat": 260,
    "edible": true,
    "rotting": true,
    "resist": { "bash": 1, "cut": 1, "acid": 1, "heat": 1, "bullet": 1 },
    "chip_resist": 2,
    "dmg_adj": [ "bruised", "mutilated", "badly mutilated", "thoroughly mutilated" ],
    "bash_dmg_verb": "bruised",
    "cut_dmg_verb": "sliced",
    "vitamins": [ [ "calcium", 0.1 ], [ "vitB", 1 ], [ "iron", 1.3 ] ],
    "burn_data": [
      { "fuel": 1, "smoke": 1, "burn": 1, "volume_per_turn": "2500_ml" },
      { "fuel": 2, "smoke": 3, "burn": 2, "volume_per_turn": "10000_ml" },
      { "fuel": 3, "smoke": 10, "burn": 3 }
    ]
}

Note that the above example gives floats, not integers, for the vitamins values. This is likely incorrect; they should be replaced with integers.

Fuel data

Every material can have fuel data that determines how much horse power it produces per unit consumed. Currently, gases and plasmas cannot really be fuels.

If a fuel has the PERPETUAL flag, engines powered by it never use any fuel. This is primarily intended for the muscle pseudo-fuel, but mods may take advantage of it to make perpetual motion machines.

"fuel_data" : {
    "energy": "34200_kJ",        // Energy per litre of fuel.
                                 // https://en.wikipedia.org/wiki/Energy_density
   "perpetual": true,            // this material is a perpetual fuel like `wind`, `sunlight`, `muscle`, `animal` and `metabolism`.
   "pump_terrain": "t_gas_pump", // optional. terrain id for the fuel's pump, if any.
   "explosion_data": {           // optional for fuels that can cause explosions
        "chance_hot": 2,         // 1 in chance_hot of explosion when attacked by HEAT weapons
        "chance_cold": 5,        // 1 in chance_cold of explosion when attacked by other weapons
        "factor": 1.0,           // explosion factor - larger numbers create more powerful explosions
        "fiery": true,           // true for fiery explosions
        "size_factor": 0.1       // size factor - larger numbers make the remaining fuel increase explosion power more
    }
}

Burn data

Every material can have burn data that determines how it interacts with fire. Fundamentally, the intensity, smoke production, and longevity of fires depends on the volume of consumed items. However, these values allow for certain items to burn more for a given volume, or even put out or inhibit the growth of fires.

Note that burn_data is defined per material, but items may be made of multiple materials. For such cases, each material of the item will be calculated separately, as if it was multiple items each corresponding to a single material.

"burn_data": [
    { "immune": true,                    // Defaults to false, optional boolean. If true, makes the resulting material immune to fire. As such it can neither provide fuel nor be burned or damaged.
	"fuel": 300,                     // Float value that determines how much time and intensity this material adds to a fire. Negative values will subtract fuel from the fire, smothering it. 
	                                 // Items with a phase ID of liquid should be made of materials with a value of >= 200 if they are intended to be flammable.
	"smoke": 0,                      // Float value, determines how much smoke this material produces when burning.
	"volume_per_turn": "750 ml",     // If non-zero and lower than item's volume, scale burning by volume_per_turn / volume
	"burn": 1 }                      // Float value, determines how quickly a fire will convert items made of this material to fuel. Does not affect the total fuel provided by a given
                                         // volume of a given material.
    ],

Monster Groups

Group definition

Identifier Description
name Unique ID. Must be one continuous word, use underscores if necessary.
default (optional) Default monster, used to represent the monster group. (default: The monster with the highest weight in the group)
monsters To choose a monster for spawning, the game creates entries equal to the sum of all weight and picks one. Each monster will have a number of entries equal to its weight. See the table below for how to build the single monster definitions.
is_safe (optional) (bool) Check to not trigger safe-mode warning, currently inconsequential.
is_animal (optional) (bool) Check if that group has only normal animals, currently inconsequential.
replace_monster_group (optional) (bool) Check if the group should be replaced completely by another monster group as game time progresses - doesn’t affect already spawned monsters, as such mostly superseded by monster evolution.
new_monster_group_id (optional) (string) The id of the monster group that should replace this one.
replacement_time (optional) (int) The amount of time before the group should be replaced by the new one, in days. Final replacement date is calculated by replacement_time * evolution factor.

Monster/Subgroup definition

In monster groups, within the "monsters" array, you can define "group" objects as well as "monster" objects. Groups use the same fields as monsters, but they are processed differently. When the game looks for possible spawns from a monster group, it will recursively check subgroups if they exist. The weight of the subgroup is defined just like monster objects, so spawn chances only matter for top-level objects.

Identifier Description
monster The monster’s unique ID, eg. "mon_zombie". Indicates that this entry is a “monster”.
group The sub-group’s unique ID eg. "GROUP_ZOMBIE". Indicates that this entry is a “monstergroup”.
weight (optional) Chance of occurrence (weight / total weight in group) (default: 1)
freq (optional) Not used anymore, works exactly like weight
cost_multiplier (optional) How many monsters each monster in this definition should count as, if spawning a limited number of monsters. (default: 1)
pack_size (optional) The minimum and maximum number of monsters in this group that should spawn together. (default: [1,1])
conditions (optional) Conditions limit when monsters spawn. Valid options: SUMMER, WINTER, AUTUMN, SPRING, DAY, NIGHT, DUSK, DAWN. Multiple Time-of-day conditions (DAY, NIGHT, DUSK, DAWN) will be combined together so that any of those conditions makes the spawn valid. Multiple Season conditions (SUMMER, WINTER, AUTUMN, SPRING) will be combined together so that any of those conditions makes the spawn valid.
starts (optional) This entry becomes active after this time. Specified using time units. (multiplied by the evolution scaling factor)
ends (optional) This entry becomes inactive after this time. Specified using time units. (multiplied by the evolution scaling factor)
spawn_data (optional) Any properties that the monster only has when spawned in this group. ammo defines how much of which ammo types the monster spawns with. Only applies to “monster” type entries.
event (optional) If present, this entry can only spawn during the specified event. See the holiday enum for possible values. Defaults to none. (Ex: "event": "halloween") 
// Example of a monstergroup containing only "monster" entries:
{
  "name" : "GROUP_ANT",
  "default" : "mon_ant",
  "monsters" : [
    { "monster" : "mon_ant", "weight" : 870, "cost_multiplier" : 0 },
    { "monster" : "mon_ant_larva", "weight" : 40, "cost_multiplier" : 0 },
    { "monster" : "mon_ant_soldier", "weight" : 90, "cost_multiplier" : 5 },
    { "monster" : "mon_ant_queen", "weight" : 0, "cost_multiplier" : 0 },
    { "monster" : "mon_thing", "weight" : 100, "cost_multiplier" : 0, "pack_size" : [3,5], "conditions" : ["DUSK","DAWN","SUMMER"] },
    { "monster" : "mon_santa", "weight" : 500, "event" : "christmas" }
  ]
},
// Example of a monstergroup containing subgroups:
{
  "type": "monstergroup",
  "name": "GROUP_MIGO_RAID",
  "//": "Meta-group for mi-gos on-the-go.",
  "monsters": [
    { "group": "GROUP_MI-GO_BASE_CAPTORS", "weight": 150, "cost_multiplier": 6, "pack_size": [ 1, 2 ] },
    { "group": "GROUP_MI-GO_SCOUT_TOWER", "weight": 100, "cost_multiplier": 4, "pack_size": [ 0, 2 ] },
    { "monster": "mon_mi_go_guard", "weight": 200, "cost_multiplier": 4 },
    { "monster": "mon_mi_go", "weight": 500, "cost_multiplier": 2, "pack_size": [ 3, 4 ] }
  ]
}

Monster Factions

Identifier Description
name Unique ID. Must be one continuous word, use underscores when necessary.
base_faction Optional base faction. Relations to other factions are inherited from it and relations of other factions to this one check this.
by_mood Be hostile towards this faction when angry, neutral otherwise. Default attitude to all other factions.
neutral Always be neutral towards this faction.
friendly Always be friendly towards this faction. By default a faction is friendly towards itself.
hate Always be hostile towards this faction. Will change target to monsters of this faction if available. 
{
    "name"         : "cult",
    "base_faction" : "zombie",
    "by_mood"      : ["slime"],
    "neutral"      : ["nether"],
    "friendly"     : ["slime"],
    "hate"         : ["fungus"]
}

Monsters

See MONSTERS.md

Mutation Categories

See MUTATIONS.md

Names 

{ "name" : "Aaliyah", "gender" : "female", "usage" : "given" }, // Name, gender, "given"/"family"/"city" (first/last/city name).

Profession item substitution

Defines item replacements that are applied to the starting items based upon the starting traits. This allows for example to replace wool items with non-wool items when the characters starts with the wool allergy trait.

If the JSON objects contains a “item” member, it defines a replacement for the given item, like this:

{
  "type": "profession_item_substitutions",
  "item": "sunglasses",
  "sub": [
    { "present": [ "HYPEROPIC" ], "new": [ "fitover_sunglasses" ] },
    { "present": [ "MYOPIC" ], "new": [ { "fitover_sunglasses", "ratio": 2 } ] }
  ]
}

This defines each item of type “sunglasses” shall be replaced with:

  • an item “fitover_sunglasses” if the character has the “HYPEROPIC” trait,
  • two items “fitover_sunglasses” if the character has the “MYOPIC” trait.

If the JSON objects contains a “trait” member, it defines a replacement for multiple items that applies when the character has the given trait:

{
  "type": "profession_item_substitutions",
  "trait": "WOOLALLERGY",
  "sub": [
    { "item": "blazer", "new": [ "jacket_leather_red" ] },
    { "item": "hat_hunting", "new": [ { "item": "hat_cotton", "ratio": 2 } ] }
  ]
}

This defines characters with the WOOLALLERGY trait get some items replaced:

  • “blazer” is converted into “jacket_leather_red”,
  • each “hat_hunting” is converted into two “hat_cotton” items.

If the JSON objects contains a “bonus” member, it defines which items will be received, like this:

{
  "type": "profession_item_substitutions",
  "group": {
    "items": [ "winter_pants_army", "undershirt", "socks", "sweatshirt", "boots_hiking", "knife_folding", "wristwatch" ],
    "entries": [
      { "group": "charged_two_way_radio" },
      { "group": "charged_matches" },
      { "item": "ear_plugs" },
      { "item": "water_clean", "container-item": "canteen" },
      { "item": "m1911", "ammo-item": "45_acp", "charges": 7, "container-item": "holster" },
      { "item": "45_acp", "charges": 23 },
      { "item": "garand", "ammo-item": "3006", "charges": 8, "contents-item": "shoulder_strap" },
      { "item": "3006", "charges": 8, "container-item": "garandclip" },
      { "item": "3006", "charges": 4 }
    ]
  },
  "bonus": {
    "present": [ "ALBINO" ],
    "absent": [ "HYPEROPIC" ]
  }
}

Professions

Professions are specified as JSON objects with the “type” member set to “profession”. The following properties (mandatory, except if noted otherwise) are supported:

  {
    "type": "profession",
    "id": "profession_example",                                // Unique ID for the profession
    "name": { "male": "Groom", "female": "Bride" },            // String, either a single gender neutral (i.e. "Survivor") or object with members "male" and "female"
    "description": "This is an example profession.",           // In-game description
    "points": 0,                                               // Point cost of profession. Positive values cost points and negative values grant points. Has no effect as of 0.G
    "npc_background": "BG_survival_story_LAB",                 // (optional) BG_trait_group ID, provides list of background stories. (see BG_trait_groups.json)
    "addictions": [ { "intensity": 10, "type": "nicotine" } ], // (optional) Array of addictions. Requires "type" as the string ID of the addiction (see JSON_FLAGS.md) and "intensity"
    "skills": [ { "name": "archery", "level": 2 } ],           // (optional) Array of starting skills. Requires "name" as the string ID of the skill (see skills.json) and "level", which is a value added to the skill level after character creation
    "missions": [ "MISSION_LAST_DELIVERY" ],                   // (optional) Array of starting mission IDs
    "proficiencies": [ "prof_knapping" ],                      // (optional) Array of starting proficiencies
    "items": {                                                 // (optional) Object of items the character starts with (see below for further explanation)
      "both": {
        "entries": [
          { "item": "jeans" },
          { "item": "tank_top", "variant": "tank_top_camo" },
          { "item": "ear_plugs", "custom-flags": [ "no_auto_equip" ] },
          { "item": "socks" },
          { "item": "sneakers" },
          { "item": "water_clean", "container-item": "canteen" },
          { "item": "m1911", "ammo-item": "45_acp", "charges": 7, "container-item": "holster" },
          { "item": "45_acp", "charges": 23 },
          { "item": "legpouch_large", "contents-group": "army_mags_m4" }
        ]
      },
      "male": { "entries": [ { "item": "boxer_shorts" } ] },
      "female": { "entries": [ { "item": "bra" }, { "item": "panties" } ] }
    }
    "age_lower": 18,                                           // (optional) Int. The lowest age that a character with this profession can generate with. This places no limits on manual input, only on random generation (i.e. Play Now!). Defaults to 21
    "age_upper": 25,                                           // (optional) Int. Similar as above
    "pets": [ { "name": "mon_black_rat", "amount": 13 } ],     // (optional) Array of starting monster IDs, tamed as pets
    "vehicle": "car_sports",                                   // (optional) String of a starting vehicle ID. The vehicle will be spawned at the closest road, with the character "remembering" its location in the overmap
    "flags": [ "SCEN_ONLY", "NO_BONUS_ITEMS" ],                // (optional) Array of flags applied to the character, for character creation purposes
    "CBMs": [ "bio_fuel_cell_blood" ],                         // (optional) Array of starting implanted CMBs
    "traits": [ "PROF_CHURL", "ILLITERATE" ],                  // (optional) Array of starting traits/mutations. For further information, see mutations.json and MUTATIONS.md. Note: "trait" is also supported, used for a single trait/mutation ID (legacy!)
    "requirement": "achievement_survive_28_days",              // (optional) String of an achievement ID required to unlock this profession
    "spells": [                                                // (optional) Array of starting spell IDs the character knows upon creation. For further information, see MAGIC.md
      { "id": "magic_missile", "level": 4 },
      { "id": "summon_undead", "level": 5 },
      { "id": "necrotic_gaze", "level": 1 }
    ],
    "recipes": [ "beartrap" ]                                  // (optional) Array of starting recipe IDs the character knows upon creation
  },

The following fields are further described

items

Items the player starts with when selecting this profession. One can specify different items based on the gender of the character. Each lists of items should be an array of items IDs, or pairs of item IDs and snippet IDs. Item IDs may appear multiple times, in which case multiple times are spawned. The syntax for each of the three lists is identical. The old and new formats can be combined, with the old format shown here for legacy purposes:

  "items": {
    "both": [
      { "item": "jeans" },
      "rock",
      [ "tshirt_text", "allyourbase" ],
      { "item": "tank_top", "variant": "tank_top_camo" }
    ],
    "male": { "entries": [ { "item": "boxer_shorts" } ] },
    "female": [ "panties" ]
  }

hobbies

(optional) Array of string profession IDs. A list of hobbies that will be the only hobbies this profession can choose from. If empty, all hobbies will be allowed.

whitelist_hobbies

(optional) Boolean. If false, hobbies will instead be a list of hobbies that this profession cannot choose from. Defaults to true.

Hobbies

Hobbies consist of backgrounds for the character upon creation, designed in the code as subtype professions. These can be combined with the “primary” profession, adding minor bonuses and/or demerits on top of the starting parameters, allowing more flexibility and character identity. Note: hobby fields derive from those used in professions. The following is a non-exhaustive list:

  {
    "type": "profession",
    "subtype": "hobby",
    "id": "hobby_profession",                                  // Unique ID of the hobby
    "name": "Driving License",                                 // String, in-game name
    "description": "Description goes here",                    // In-game description
    "points": 0,                                               // Point cost of profession. Positive values cost points and negative values grant points. Has no effect as of 0.G
    "skills": [                                                // (optional) Array of starting skills, added on top of the profession starting skills
      { "level": 2, "name": "driving" }
    ],
    "proficiencies": [ "prof_driver" ],                        // (optional) Array of starting proficiencies
    "addictions": [ { "intensity": 40, "type": "opiate" } ],   // (optional) Array of addictions, added on top of the profession starting addictions
    "traits": [ "LOVES_BOOKS" ],                               // (optional) Array of starting traits/mutations
    "CBMs": [ "bio_adrenaline" ],                              // (optional) Array of starting implanted CMBs
    "spells": [ { "id": "create_atomic_light", "level": 5 } ]  // (optional) Array of starting spell IDs the character knows upon creation
  },

Profession groups

Profession groups are a list of hobbies added to the character upon creation. While the list is automatically added by hardcode to each character upon creation (adding a minimum set of skills to all characters, regardless of their professions), the list can be modified via JSON. Thus, it is listed here for reference and modding purposes only.

  {
    "type": "profession_group",
    "id": "adult_basic_background",
    "professions": [
      "driving_license",
      "simple_home_cooking",
      "computer_literate",
      "social_skills",
      "high_school_graduate",
      "mundane_survival"
    ]
  }

The array of hobbies (listed as professions) is whitelisted to all characters. Thus, if one wants to start with no hobbies, the list has to be set as:

    "professions": [  ]

Recipes

Crafting recipes are defined as a JSON object with the following fields:

"result": "javelin",         // ID of resulting item
"activity_level": "LIGHT_EXERCISE", // (Mandatory) Options are NO_EXERCISE, LIGHT_EXERCISE, MODERATE_EXERCISE, BRISK_EXERCISE, ACTIVE_EXERCISE, EXTRA_EXERCISE. How energy intensive of an activity this craft is. E.g. making an anvil is much more exercise than cooking a fish.
"byproducts": [ [ "" ] ],    // Optional (default: empty). Additional items generated by crafting this recipe.
"byproduct_group": [         // Optional (default: empty). Same as above, but using item group definitions.
  { "item": "item_id_1", "count": [ 1, 4 ] },
  { "item": "item_id_2", "charges": [ 8, 15 ] },
],
"category": "CC_WEAPON",     // Category of crafting recipe. CC_NONCRAFT used for disassembly recipes
"subcategory": "CSC_WEAPON_PIERCING",
"id_suffix": "",             // Optional (default: empty string). Some suffix to make the ident of the recipe unique. The ident of the recipe is "<id-of-result><id_suffix>".
"variant": "javelin_striped", // Optional (default: empty string). Specifies a variant of the result that this recipe will always produce. This will append the variant's id to the recipe ident "<id-of-result>_<variant_id>".
"override": false,           // Optional (default: false). If false and the ident of the recipe is already used by another recipe, loading of recipes fails. If true and a recipe with the ident is already defined, the existing recipe is replaced by the new recipe.
"delete_flags": [ "CANNIBALISM" ], // Optional (default: empty list). Flags specified here will be removed from the resultant item upon crafting. This will override flag inheritance, but *will not* delete flags that are part of the item type itself.
"skill_used": "fabrication", // Skill trained and used for success checks
"skills_required": [["survival", 1], ["throw", 2]], // Skills required to unlock recipe
"book_learn": {	             // (optional) Books that this recipe can be learned from.
    "textbook_anarch" : {    // ID of the book the recipe can be learned from
        "skill_level" : 7,   // Skill level at which it can be learned
        "recipe_name" : "something", // (optional) Name of the recipe as it should appear in the book's description (default is the name of resulting item of the recipe)
        "hidden" : true },   // (optional) If set to true, recipe will not be shown in the description of the book
    "textbook_gaswarfare" : { // Additional book this recipe can be learnt from.
        "skill_level" : 8
    }
},
"difficulty": 3,             // Difficulty of success check
"time": "5 m",               // Preferred time to perform recipe, can specify in minutes, hours etc.
"time": 5000,                // Legacy time to perform recipe (where 1000 ~= 10 turns ~= 10 seconds game time).
"reversible": true,          // Can be disassembled. Time taken is as long as to craft the item.
"reversible": { "time": "30 s" }, // Can be disassembled. Time to disassemble as specified.
"autolearn": true,           // Automatically learned upon gaining required skills
"autolearn" : [              // Automatically learned upon gaining listed skills
    [ "survival", 2 ],
    [ "fabrication", 3 ]
],
"decomp_learn" : 4,          // Can be learned by disassembling an item of same type as result at this level of the skill_used
"decomp_learn" : [           // Can be learned by disassembling an item of same type as result at specified levels of skills
    [ "survival", 1 ],
    [ "fabrication", 2 ]
],
"proficiencies" : [ // The proficiencies related to this recipe
    {
      "proficiency": "prof_knapping", // The id of a proficiency
      "required": false, // Whether or not you must have the proficiency to craft it. Incompatible with `time_multiplier`
      "time_multiplier": 2.0 // The multiplier on time taken to craft this recipe if you do not have this proficiency
      "skill_penalty": 1.5 // The effective skill penalty when crafting without this proficiency. Defaults to 1.0. Multiple proficiencies will add to this value.
      "learning_time_multiplier": 1.2 // The multiplier on learning speed for this proficiency. By default, it's the time of the recipe, divided by the time multiplier, and by the number of proficiencies that can also be learned from it.
      "max_experience": "15 m" // This recipe cannot raise your experience for that proficiency above 15 minutes worth.
    }
]
"contained": true, // Boolean value which defines if the resulting item comes in its designated container. Automatically set to true if any container is defined in the recipe. 
"container": "jar_glass_sealed", //The resulting item will be contained by the item set here, overrides default container.
"container_variant": "jar_glass_sealed_strawberry_picture", //The container specified above will spawn as the specified variant, overrides the normal weighted behavior.
"batch_time_factors": [25, 15], // Optional factors for batch crafting time reduction. First number specifies maximum crafting time reduction as percentage, and the second number the minimal batch size to reach that number. In this example given batch size of 20 the last 6 crafts will take only 3750 time units.
"charges": 2,                // Number of resulting items/charges per craft. Uses default charges if not set. If a container is set, this is the amount that gets put inside it, capped by container capacity.
"result_mult": 2,            // Multiplier for resulting items. Also multiplies container items.
"flags": [                   // A set of strings describing boolean features of the recipe
  "BLIND_EASY",
  "ANOTHERFLAG"
],
"result_eocs": [ {"id": "TEST", "effect": { "u_message": "You feel Test" } } // List of inline effect_on_conditions or effect_on_condition ids that attempt to activate when this recipe is successfully finished.  If a value is provided a result becomes optional, though a name and id will be needed it it is missing.  If no result is provided and a description is present, that will be displayed as the result on the crafting gui.
], 
"construction_blueprint": "camp", // an optional string containing an update_mapgen_id.  Used by faction camps to upgrade their buildings
"on_display": false,         // this is a hidden construction item, used by faction camps to calculate construction times but not available to the player
"qualities": [               // Generic qualities of tools needed to craft
  { "id": "CUT", "level": 1, "amount": 1 }
],
"tools": [                   // Specific tools needed to craft
[
  [ "fire", -1 ]             // Charges consumed when tool is used, -1 means no charges are consumed
]],
"using": [                   // Requirement IDs and multipliers of tools and materials used
  [ "req_a", 3 ],            // Second number multiplies requirement materials by that amount
  [ "req_b", 5 ],            // Need 3x everything in req_a, 5x everything in req_b
],
"components": [              // Items (or item alternatives) required to craft this recipe
  [
    [ "item_a", 5 ]          // First ingredient: need 5 of item_a
  ],
  [
    [ "item_b", 2 ],         // Also need 2 of item_b...
    [ "item_c", 4 ]          // OR 4 of item_c (but do not need both)
  ],
  [
    // ... any number of other component ingredients (see below)
  ]
],
"component_blacklist": [     // List of item types that don't get added to result item components. Reversible recipes won't recover these and comestibles will not include them in calorie calculations.
  "item_a",
  "item_b"
]

Practice recipes

Recipes may instead be defined with type “practice”, to make them appear in the “PRACTICE” tab of the crafting menu. These recipes do not have a “result”, but they may define “byproducts”/”byproduct_group”. See PRACTICE_RECIPES.md for how to define them.

Nested recipes

Similar recipes may instead be nested allowing you to save space in the UI. This is done as such:

{
  "id": "nested_steel_legs",
  "type": "nested_category",
  "activity_level": "BRISK_EXERCISE",
  "category": "CC_ARMOR",
  "subcategory": "CSC_ARMOR_LEGS",
  "name": "steel leg guards",
  "description": "Recipes related to constructing steel leg guards in various thickness and steel variants.",
  "skill_used": "fabrication",
  "nested_category_data": [
    "xl_armor_qt_heavy_leg_guard",
    "armor_qt_heavy_leg_guard",
    "xl_armor_ch_heavy_leg_guard",
    "armor_ch_heavy_leg_guard",
    "xl_armor_hc_heavy_leg_guard",
    "armor_hc_heavy_leg_guard",
    "xl_armor_mc_heavy_leg_guard",
    "armor_mc_heavy_leg_guard",
    "xl_armor_lc_heavy_leg_guard",
    "armor_lc_heavy_leg_guard",
    "xl_armor_qt_leg_guard",
    "armor_qt_leg_guard",
    "xl_armor_ch_leg_guard",
    "armor_ch_leg_guard",
    "xl_armor_hc_leg_guard",
    "armor_hc_leg_guard",
    "xl_armor_mc_leg_guard",
    "armor_mc_leg_guard",
    "xl_armor_lc_leg_guard",
    "armor_lc_leg_guard",
    "xl_armor_qt_light_leg_guard",
    "armor_qt_light_leg_guard",
    "xl_armor_ch_light_leg_guard",
    "armor_ch_light_leg_guard",
    "xl_armor_hc_light_leg_guard",
    "armor_hc_light_leg_guard",
    "xl_armor_mc_light_leg_guard",
    "armor_mc_light_leg_guard",
    "xl_armor_lc_light_leg_guard",
    "armor_lc_light_leg_guard"
  ],
  "difficulty": 5,
  "autolearn": [ [ "fabrication", 5 ] ]
}

So it is identical to a normal recipe with the addition of the “nested_category_data” which lists all of the recipe ID’s that are in the category.

If you want to hide recipes that are nested you can set their category and subcategory as:

"category": "CC_*",
"subcategory": "CSC_*_NESTED",

Recipe requirements

The tool quality and component requirements for a recipe may be expressed in a combination of several ways, with these JSON fields:

  • “qualities” defines item qualities like CUT or HAMMER, and quality levels needed to craft
  • “tools” lists item ids of tools (or several alternative tools) needed for crafting the recipe
  • “components” lists item or requirement ids, intended mainly for material ingredients
  • “using” gives requirement ids; the requirement may have nested tools, qualities, or components

These fields may be used similarly in uncrafting, constructions, vehicle parts, and vehicle faults. The first three fields are applicable to “requirement” definitions as well, and may be nested; see the requirements section.

A recipe’s “components” lists all the required items or ingredients needed to craft the finished item from the recipe. Each component is given as an integer quantity of a specific item id or requirement id, or as a list of several alternative item/requirement quantities.

The syntax of a component in its simplest form is an item id and quantity. Continuing the “javelin” recipe, let’s require a single “spear_wood” item:

"components": [
  [ [ "spear_wood", 1 ] ]
]

A single component may also have substitutions; for instance, to allow crafting from one “spear_wood” or one “pointy_stick”:

"components": [
  [ [ "spear_wood", 1 ], [ "pointy_stick", 1 ] ]
]

Notice that the first example with only “spear_wood” was simply the degenerate case - a list of alternatives with only 1 alternative - which is why it was doubly nested in [ [ ... ] ].

The javelin would be better with some kind of leather or cloth grip. To require 2 rags, 1 leather, or 1 fur in addition to the wood spear or pointy stick:

"components": [
  [ [ "spear_wood", 1 ], [ "pointy_stick", 1 ] ],
  [ [ "sheet_cotton", 2 ], [ "leather", 1 ], [ "fur", 1 ] ]
]

And to bind the grip onto the javelin, some sinew or thread should be required, which can have the “NO_RECOVER” keyword to indicate they cannot be recovered if the item is deconstructed:

"components": [
  [ [ "spear_wood", 1 ], [ "pointy_stick", 1 ] ],
  [ [ "sheet_cotton", 2 ], [ "leather", 1 ], [ "fur", 1 ] ],
  [ [ "sinew", 20, "NO_RECOVER" ], [ "thread", 20, "NO_RECOVER" ] ]
]

Note: Related to “NO_RECOVER”, some items such as “superglue” and “duct_tape” have an “UNRECOVERABLE” flag on the item itself, indicating they can never be reclaimed when disassembling. See JSON_FLAGS.md for how to use this and other item flags.

Defining common requirements

To avoid repeating commonly used sets of components, instead of an individual item id, provide the id of a requirement type, along with a quantity, and the "LIST" keyword. Typically these are defined within data/json/requirements.

For example if these grip_patch and grip_wrap requirements were defined:

[
  {
    "id": "grip_patch",
    "type": "requirement",
    "components": [ [ [ "sheet_cotton", 2 ], [ "leather", 1 ], [ "fur", 1 ] ] ]
  },
  {
    "id": "grip_wrap",
    "type": "requirement",
    "components": [ [ [ "sinew", 20, "NO_RECOVER" ], [ "thread", 20, "NO_RECOVER" ] ] ]
  }
]

Then javelin recipe components could use 1 grip and 1 wrap, for example:

"result": "javelin",
"components": [
  [ [ "spear_wood", 1 ], [ "pointy_stick", 1 ] ],
  [ [ "grip_patch", 1, "LIST" ] ],
  [ [ "grip_wrap", 1, "LIST" ] ]
]

And other recipes needing two such grips could simply require 2 of each:

"result": "big_staff",
"components": [
  [ [ "stick_long", 1 ] ],
  [ [ "grip_patch", 2, "LIST" ] ],
  [ [ "grip_wrap", 2, "LIST" ] ]
]

The "using" field in a recipe works similarly, but "using" may only refer to requirement ids, not specific items or tools. A requirement included with "using" must also give a multiplier, telling how many units of that requirement are needed. As with "components", the “using” list is formatted as a collection of alternatives, even if there is only one alternative.

For instance, this "uncraft" recipe for a motorbike alternator uses either 20 units of the "soldering_standard" requirement, or 5 units of the "welding_standard" requirement:

{
  "type": "uncraft",
  "result": "alternator_motorbike",
  "qualities": [ { "id": "SCREW", "level": 1 } ],
  "using": [ [ "soldering_standard", 20 ], [ "welding_standard", 5 ] ],
  "components": [ [ [ "power_supply", 1 ] ], [ [ "cable", 20 ] ], [ [ "bearing", 5 ] ], [ [ "scrap", 2 ] ] ]
}

Requirements may include "tools" or "qualities" in addition to "components". Here we have a standard soldering requirement needing either a "soldering_iron" or "toolset", plus 1 unit of the "solder_wire" component:

{
  "id": "soldering_standard",
  "type": "requirement",
  "//": "Tools and materials needed for soldering metal items or electronics",
  "tools": [ [ [ "soldering_iron", 1 ], [ "toolset", 1 ] ] ],
  "components": [ [ [ "solder_wire", 1 ] ] ]
}

This simplifies recipes needing soldering, via the "using" field. For instance, a simple "tazer" recipe could require 10 units of the soldering requirement, along with some other components:

{
  "type": "recipe",
  "result": "tazer",
  "using": [ [ "soldering_standard", 10 ] ],
  "components": [ [ [ "amplifier", 1 ] ], [ [ "power_supply", 1 ] ], [ [ "scrap", 2 ] ] ],
  "//": "..."
}

Requirements can be used not just for regular crafting and uncrafting recipes, but also for constructions and vehicle part installation and mending.

NOTE: Requirement lists included in mods overwrite the previously loaded requirement list with a matching id. This means that two mods modifying the same requirement id will overwrite each other. This can be avoided by using "extend" to extend from the previously loaded list. Ex.:

{
  "id": "bone_sturdy",
  "type": "requirement",
  "extend": {
    "components": [
      [
        [ "frost_bone_human", 1 ],
        [ "alien_bone", 1 ]
      ]
    ]
  }
}

Overlapping recipe component requirements

If recipes have requirements which overlap, this makes it more difficult for the game to calculate whether it is possible to craft a recipe at all.

For example, the survivor telescope recipe has the following requirements (amongst others):

1 high-quality lens
AND
1 high-quality lens OR 1 small high-quality lens

These overlap because both list the high-quality lens.

A small amount of overlap (such as the above) can be handled, but if you have too many component lists which overlap in too many ways, then you may see an error during recipe finalization that your recipe is too complex. In this case, the game may not be able to correctly predict whether it can be crafted.

To work around this issue, if you do not wish to simplify the recipe requirements, then you can split your recipe into multiple steps. For example, if we wanted to simplify the above survivor telescope recipe we could introduce an intermediate item “survivor eyepiece”, which requires one of either lens, and then the telescope would require a high-quality lens and an eyepiece. Overall, the requirements are the same, but neither recipe has any overlap.

For more details, see this pull request and the related issue.

Constructions 

"group": "spike_pit",                                               // Construction group, used to group related constructions in UI
"category": "DIG",                                                  // Construction category
"skill": "fabrication",                                             // Primary skill, that would be used in the recipe
"difficulty": 1,                                                    // Difficulty of primary skill
"required_skills": [ [ "survival", 1 ] ],                           // Skill levels required to undertake construction
"qualities": [ [ [ { "id": "SCREW", "level": 1 } ] ],               // Tool qualities, required to construct
"tools": [ [ [ "oxy_torch", 10 ], [ "welder", 50 ] ] ],             // Tools and amount of charges, that would be used in construction
"using": [ [ "welding_standard", 64 ] ],                            // Requirements that would be used in construction
"activity_level": "EXTRA_EXERCISE",                                 // Activity level of the activity, harder activities consume more calories over time. Valid values are, from easiest to most demanding of the body: `NO_EXERCISE`, `LIGHT_EXERCISE`, `MODERATE_EXERCISE`, `BRISK_EXERCISE`, `ACTIVE_EXERCISE`, `EXTRA_EXERCISE`.
"do_turn_special": "do_turn_shovel",                                // Special effect, that occur, when you perform a construction. Can be either `do_turn_shovel` (cause "hsh!" message every minute, may trigger a buried trap, if there is one) or `do_turn_exhume` (applied mood effect for gravedigging related to your traits)
"vehicle_start": true,                                              // Hardcoded check for construction recipe, that result into vehicle frame; Can be used only with `done_vehicle`
"time": "30 m",                                                     // Time required to complete construction. Integers will be read as minutes or a time string can be used.
"components": [ [ [ "spear_wood", 4 ], [ "pointy_stick", 4 ] ] ],   // Items used in construction
"pre_special": [ "check_empty", "check_up_OK" ],                    // Required something that isn't terrain. The syntax also allows for a square bracket enclosed list of specials which all have to be fulfilled
"pre_terrain": "t_pit",                                             // Alternative to pre_special; Required terrain to build on
"pre_flags": [ "WALL", { "flag": "DIGGABLE", "force_terrain": true } ], // Flags beginning furniture/terrain must have. force_ter forces the flag to apply to the underlying terrain
"post_terrain": "t_pit_spiked",                                     // Terrain type after construction is complete
"post_special": "done_mine_upstairs",                               // Required to do something beyond setting the post terrain. The syntax also allows for a square bracket enclosed list of specials which all have to be fulfilled
"pre_note": "Build a spikes on a diggable terrain",                 // Create an annotation to this recipe
"dark_craftable": true,                                             // If true, you can construct it with lack of light
"byproducts": [ { "item": "material_soil", "count": [ 2, 5 ] } } ], // Items, that would be left after construction
"strict": false,                                                    // If true, the build activity for this construction will only look for prerequisites in the same group
"on_display": false                                                 // This is a hidden construction item, used by faction camps to calculate construction times but not available to the player
pre_special Description
check_channel Must be empty and have a current in at least one orthogonal tile
check_empty_lite Tile is empty (no furniture, trap, item, or vehicle)
check_empty Tile is empty (no furniture, trap, item, or vehicle) and flat terrain
check_unblocked Tile is empty (no furniture, trap, item, or vehicle), and either flat terrain or empty space
check_support Must have at least two solid walls/obstructions nearby on orthogonals (non-diagonal directions only) or solid support directly below to support the tile
check_support_below Must have at least two solid walls/obstructions at the Z level below on orthogonals (non-diagonal directions only) or solid support directly below to support the tile and be empty lite but with a ledge trap acceptable, as well as open air
check_single_support Must have solid support directly below to support the tile
check_stable Tile on level below has a flag SUPPORTS_ROOF
check_empty_stable Tile is empty and stable
check_nofloor_above Tile on level above has a flag NO_FLOOR
check_deconstruction The furniture (or tile, if no furniture) in the target tile must have a “deconstruct” entry
check_up_OK Tile is below the maximum possible elevation (can build up here)
check_down_OK Tile is above the lowest possible elevation (can dig down here)
check_no_trap There is no trap object in this tile
check_ramp_low Both this and the next level above can be built up one additional Z level
check_ramp_high There is a complete downramp on the next higher level, and both this and next level above can be built up one additional Z level
check_no_wiring The tile must either be free of a vehicle, or at least a vehicle that doesn’t have the WIRING flag
check_matching_down_above The tile directly above must have the same base identifier but with a suffix of ‘down’
post_special Description
done_trunk_plank Generate logs and then planks here (under the assumption the tile was a trunk or stump)
done_grave Finish grave digging by performing burial activities
done_vehicle Create a new vehicle and name it
done_appliance Finish the placement of a partially placed appliance
done_wiring Place a wiring “appliance” at the location
done_deconstruct Finish deconstruction of furniture or, if not present, terrain
done_dig_grave Finish digging up a grave and find what’s inside of it
done_dig_grave_nospawn Finish digging up a grave and retrieve a coffin (which is not an option above)
done_dig_stair Finish diggins stairs downwards (with handling of what’s beneath and how to get up)
done_mine_downstair Same as the previous one, but mining rather than digging
done_mine_upstair Finish mining stairs from below
done_wood_stairs Finish building stairs from below
done_window_curtains Finish boarding up window and get materials from curtains
done_extract_maybe_revert_to_dirt Finish sand/clay extraction, which may exhaust the resource
done_mark_firewood Sets a firewood source trap at the location
done_mark_practice_target Sets a target practice trap at the location
done_ramp_low Sets a t_ramp_down_low at the tile above the target
done_ramp_high Sets a t_ramp_down_high at the tile above the target
done_matching_down_above The terrain on the Z level above is set to the corresponding terrain at this level, but with the “down” suffix instead
remove_above Remove the terrain at the Z level above and replace it with t_open_air
add_roof Add the roof specified for the terrain at the site to the tile above

Scent_types

Identifier Description
id Unique ID. Must be one continuous word, use underscores if necessary.
receptive_species Species able to track this scent. Must use valid ids defined in species.json 
  {
    "type": "scent_type",
    "id": "sc_flower",
    "receptive_species": [ "MAMMAL", "INSECT", "MOLLUSK", "BIRD" ]
  }

Scores, Achievements, and Conducts

Scores are defined in two or three steps based on events. To see what events exist and what data they contain, read event.h.

Each event contains a certain set of fields. Each field has a string key and a cata_variant value. The fields should provide all the relevant information about the event.

For example, consider the gains_skill_level event. You can see this specification for it in event.h:

template<>
struct event_spec<event_type::gains_skill_level> {
    static constexpr std::array<std::pair<const char *, cata_variant_type>, 3> fields = {{
            { "character", cata_variant_type::character_id },
            { "skill", cata_variant_type::skill_id },
            { "new_level", cata_variant_type::int_ },
        }
    };
};

From this, you can see that this event type has three fields:

  • character, with the id of the character gaining the level.
  • skill, with the id of the skill gained.
  • new_level, with the integer level newly acquired in that skill.

Events are generated by the game when in-game circumstances dictate. These events can be transformed and summarized in various ways. There are three concepts involved: event streams, event statistics, and scores.

  • Each event_type defined by the game generates an event stream.
  • Further event streams can be defined in json by applying an event_transformation to an existing event stream.
  • An event_statistic summarizes an event stream into a single value (usually a number, but other types of value are possible).
  • A score uses such a statistic to define an in-game score which players can see.

event_transformation

An event_transformation can modify an event stream, producing another event stream.

The input stream to be transformed is specified either as an "event_type", to use one of the built-in event type streams, or an "event_transformation", to use another json-defined transformed event stream.

Any or all of the following alterations can be made to the event stream:

  • Add new fields to each event based on event field transformations. The event field transformations can be found in event_field_transformations.cpp.
  • Filter events based on the values they contain to produce a stream containing some subset of the input stream.
  • Drop some fields which are not of interest in the output stream.

Here are examples of each modification:

"id": "avatar_kills_with_species",
"type": "event_transformation",
"event_type": "character_kills_monster", // Transformation acts upon events of this type
"new_fields": { // A dictionary of new fields to add to the event
    // The key is the new field name; the value should be a dictionary of one element
    "species": {
        // The key specifies the event_field_transformation to apply; the value specifies
        // the input field whose value should be provided to that transformation.
        // So, in this case, we are adding a new field 'species' which will
        // contain the species of the victim of this kill event.
        "species_of_monster": "victim_type"
    }
}

"id": "moves_on_horse",
"type": "event_transformation",
"event_type" : "avatar_moves", // An event type.  The transformation will act on events of this type
"value_constraints" : { // A dictionary of constraints
    // Each key is the field to which the constraint applies
    // The value specifies the constraint.
    // "equals" can be used to specify a constant cata_variant value the field must take.
    // "lt", "lteq", "gteq" and "gt" can be used with int type to compare against a constant cata_variant value.
    // "equals_any" can be used to check for a value in a set of values
    // "equals_statistic" specifies that the value must match the value of some statistic (see below)
    "mount" : { "equals": [ "mtype_id", "mon_horse" ] }
}
// Since we are filtering to only those events where 'mount' is 'mon_horse', we
// might as well drop the 'mount' field, since it provides no useful information.
"drop_fields" : [ "mount" ]

The parameter to "equals" (and other single-value comparators) is normally a length-two array specifying a cata_variant_type and a value. As a short cut, you can simply specify an int or bool (e.g. "equals": 7 or "equals": true) for fields which have those types.

The parameter to "equals_any" will be a pair where the first element is a string cata_variant_type and the second is an array of values. For example:

"value_constraints": {
  "oter_type_id": { "equals_any": [ "oter_type_str_id", [ "central_lab_finale", "lab_finale" ] ] }
}

Value constraints are type-checked, so you should see an error message at game data verification time if the variant type you have specified doesn’t match the type of the field you’re matching.

event_statistic

As with event_transformation, an event_statistic requires an input event stream. That input stream can be specified in the same was as for event_transformation, via one of the following two entries:

"event_type" : "avatar_moves" // Events of this built-in type
"event_transformation" : "moves_on_horse" // Events resulting from this json-defined transformation

Then it specifies a particular stat_type and potentially additional details as follows:

The number of events:

"stat_type" : "count"

The sum of the numeric value in the specified field across all events:

"stat_type" : "total"
"field" : "damage"

The maximum of the numeric value in the specified field across all events:

"stat_type" : "maximum"
"field" : "damage"

The minimum of the numeric value in the specified field across all events:

"stat_type" : "minimum"
"field" : "damage"

Assume there is only a single event to consider, and take the value of the given field for that unique event:

"stat_type": "unique_value",
"field": "avatar_id"

The value of the given field for the first event in the input stream:

"stat_type": "first_value",
"field": "avatar_id"

The value of the given field for the last event in the input stream:

"stat_type": "last_value",
"field": "avatar_id"

Regardless of stat_type, each event_statistic can also have:

// Intended for use in describing scores and achievement requirements.
"description": "Number of things"

score

Scores simply associate a description to an event for formatting in tabulations of scores. The description specifies a string which is expected to contain a %s format specifier where the value of the statistic will be inserted.

Note that even though most statistics yield an integer, you should still use %s.

If the underlying statistic has a description, then the score description is optional. It defaults to “: ".

"id": "score_headshots",
"type": "score",
"description": "Headshots: %s",
"statistic": "avatar_num_headshots"

achievement

Achievements are goals for the player to aspire to, in the usual sense of the term as popularized in other games.

An achievement is specified via requirements, each of which is a constraint on an event_statistic. For example:

{
  "id": "achievement_kill_zombie",
  "type": "achievement",
  // The achievement name and description are used for the UI.
  // Description is optional and can provide extra details if you wish.
  "name": "One down, billions to go\u2026",
  "description": "Kill a zombie",
  // if you don't specify requirements because the achievement is given by an EOC
  // you should set manually_given to true, this will avoid errors.
  // this value defaults to false
  "manually_given": false,
  "requirements": [
    // Each requirement must specify the statistic being constrained, and the
    // constraint in terms of a comparison against some target value.
    { "event_statistic": "num_avatar_zombie_kills", "is": ">=", "target": 1 }
  ]
},

The "is" field must be ">=", "<=" or "anything". When it is not "anything" the "target" must be present, and must be an integer.

Additional optional fields for each entry in requirements are:

  • "visible", which can take the values "always", "when_requirement_completed", "when_achievement_completed", or "never" to dictate when a requirement is visible. Non-visible requirements will be hidden in the UI.
  • "description" will override the default description of the requirement, for cases where the default is not suitable. The default takes the form x/y foo where x is the current statistic value, y is the target value, and foo is the statistic description (if any).

There are further optional fields for the achievement:

"hidden_by": [ "other_achievement_id" ]

Give a list of other achievement ids. This achievement will be hidden (i.e. not appear in the achievements UI) until all of the achievements listed have been completed.

Use this to prevent spoilers or to reduce clutter in the list of achievements.

If you want an achievement to be hidden until completed, then mark it as hidden_by its own id.

"time_constraint": { "since": "game_start", "is": "<=", "target": "1 minute" }

This allows putting a time limit (either a lower or upper bound) on when the achievement can be claimed. The "since" field can be either "game_start" or "cataclysm". The "target" describes an amount of time since that reference point.

Note that achievements can only be captured when a statistic listed in their requirements changes. So, if you want an achievement which would normally be triggered by reaching some time threshold (such as “survived a certain amount of time”) then you must place some requirement alongside it to trigger it after that time has passed. Pick some statistic which is likely to change often, and add an "anything" constraint on it. For example:

{
  "id": "achievement_survive_one_day",
  "type": "achievement",
  "description": "The first day of the rest of their unlives",
  "time_constraint": { "since": "game_start", "is": ">=", "target": "1 day" },
  "requirements": [ { "event_statistic": "num_avatar_wake_ups", "is": "anything" } ]
},

This is a simple “survive a day” but is triggered by waking up, so it will be completed when you wake up for the first time after 24 hours into the game.

conduct

A conduct is a self-imposed constraint that players can choose to aspire to maintain. In some ways a conduct is the opposite of an achievement: it specifies a set of conditions which can be true at the start of a game, but might cease to be true at some point.

The implementation of conducts shares a lot with achievements, and their specification in JSON uses all the same fields. Simply change the "type" from "achievement" to "conduct".

The game enforces that any requirements you specify for a conduct must “become false” in the sense that once they are false, they can never become true again. So, for example, an upper bound on some monotonically increasing statistic is acceptable, but you cannot use a constraint on a statistic which might go down and up arbitrarily.

With a good motivating example, this constraint might be weakened, but for now it is present to help catch errors.

Skills 

{
  "type": "skill",
  "id": "smg",
  "name": { "str": "submachine guns" },
  "description": "Comprised of an automatic rifle carbine designed to fire a pistol cartridge, submachine guns can reload and fire quickly, sometimes in bursts, but they are relatively inaccurate and may be prone to mechanical failures.",
  "tags": [ "combat_skill" ],
  "time_to_attack": { "min_time": 20, "base_time": 30, "time_reduction_per_level": 1 },
  "display_category": "display_ranged",
  "sort_rank": 11000,
  "teachable": true,
  "companion_skill_practice": [ { "skill": "hunting", "weight": 25 } ]
}
Field Purpose
name Name of the skill as displayed in the the character info screen.
description Description of the skill as displayed in the the character info screen.
tags Identifies special cases. Currently valid tags are: “combat_skill” and “contextual_skill”.
time_to_attack Object used to calculate the movecost for firing a gun.
display_category Category in the character info screen where this skill is displayed.
sort_rank Order in which the skill is shown.
teachable Whether it’s possible to teach this skill between characters. (Default = true)
companion_skill_practice Determines the priority of this skill within a mision skill category when an NPC gains experience from a companion mission.
companion_combat_rank_factor (int) Affects an NPC’s rank when determining the success rate for combat missions.
companion_survival_rank_factor (int) Affects an NPC’s rank when determining the success rate for survival missions.
companion_industry_rank_factor (int) Affects an NPC’s rank when determining the success rate for industry missions.

Speed Description 

{
    "type": "speed_description",
    "id": "mon_speed_centipede",
    "values": [ // (optional)
        {
            // value is mandatory
            "value": 1.40,
            // description is optional
            "descriptions": "Absurdly faster than you", // single description
        },
        {
            "value": 1.00,
            "descriptions": [ // array of descriptions, chosen randomly when called
                "Roughly around the same speed",
                "At a similar pace as you"
            ]
        },
        {
            "value": 0.01,
            "descriptions": [ // array of descriptions, chosen randomly when called
                "Barely moving",
                "Is it even alive?"
            ]
        },
        {
            "value": 0.00, // immobile monsters have it set to zero
            "descriptions": [ "It's immobile" ] // array of descriptions with a single description
        }
    ]
}

There won’t be any errors on two values with the same value but avoid it as one of them won’t get called.

Currently the ratio for values is player_tiles_per_turn / monster_speed_rating. The monster speed rating is their effective_speed / 100, their effective speed is equal to the monster speed, but the leap ability increases it by 50.

Values are checked from highest first, the order they’re defined in doesn’t matter since they get sorted, but keep them organized anyway.

Having a value of 0.00 is important but not necessary, as it’s used in case the ratio turns zero for whatever reason ( like monster has the flag MF_IMMOBILE ). If the ratio is zero and this value doesn’t exist, the returned string will be empty.

Mood Face 

{
    "type": "mood_face",
    "id": "DEFAULT_HORIZONTAL",
    "values": [ // mandatory
        {
            "value": 200, // mandatory
            "face": "<color_green>@w@</color>" // mandatory
        },
        {
            "value": -200,
            "face": "<color_red>XvX</color>" // adding a color is also mandatory
        },
        {
            "value": -201, // morale is clamped [200, -200] on regular gameplay, not necessary unless debugging
            "face": "<color_yellow>@^@</color>"
        }
    ]
}

Color is mandatory, or else it won’t appear on the sidebar.

DEFAULT and DEFAULT_HORIZONTAL for the default value, must not be deleted ( modifying is fine ).

THRESH_TRAIT and THRESH_TRAIT_HORIZONTAL for traits. Examples: For THRESH_BIRD: THRESH_BIRD and THRESH_BIRD_HORIZONTAL For THRESH_SPIDER: THRESH_SPIDER and THRESH_SPIDER_HORIZONTAL

The id must be exact as it is hardcoded to look for that.

HORIZONTAL means 3 characters width.

Tool Qualities

Defined in tool_qualities.json.

Format and syntax:

{
  "type": "tool_quality",
  "id": "SAW_W",                      // Unique ID
  "name": { "str": "wood sawing" },   // Description used in tabs in-game when looking at entries with the id
  "usages": [ [ 2, [ "LUMBER" ] ] ]   // Not mandatory.  The special actions that may be performed with the item.
},

Examples of various usages syntax:

"usages": [ [ 1, [ "PICK_LOCK" ] ] ]
"usages": [ [ 2, [ "LUMBER" ] ] ]
"usages": [ [ 1, [ "salvage", "inscribe"] ] ]
"usages": [ [ 2, [ "HACKSAW", "saw_barrel" ] ] ]
"usages": [ [ 1, [ "CHOP_TREE", "CHOP_LOGS" ] ], [ 2, [ "LUMBER" ] ] ]

The usages line is only required for items that have qualities that allow special actions on activation. See Use Actions for specific actions and documentation.

IDs of actions and the plaintext action description for the player are defined in item_actions.json.

Each usage must be defined first by the minimum level of the tool quality that is required for that action to be possible, then the ID of the action or array of actions that is possible with that tool quality level or greater.

As shown in the examples, one or more actions for multiple tool levels may be defined and if multiple levels are defined, those must be defined in a higher order array.

Comment lines using the normal "//" (or "//1", or higher numbers) format are allowed (see Comments).

Qualities are (non-exclusively) associated with items in the various item definitions in the json files by adding a "qualities": line. For example: "qualities": [ [ "ANVIL", 2 ] ], associates the ANVIL quality at level 2 to the item.

Traits/Mutations

See MUTATIONS.md

Trait Migrations

See MUTATIONS.md

Traps 

    "type": "trap",
    "id": "tr_beartrap", // Unique ID
    "name": "bear trap", // In-game name displayed
    "color": "blue",
    "symbol": "^",
    "visibility": 2, // 0 to infinity, 0 means a blatantly obvious trap, the higher, the harder to spot.
    "avoidance": 7, // 0 to infinity, affects how easy it is to dodge a triggered trap. 0 means dead easy, the higher the harder.
    "difficulty": 3, // 0 to 99, 0 means disarming is always successful (e.g funnels or other benign traps), 99 means disarming is impossible.
    "trap_radius": 1, // 0 to infinity, radius of space the trap needs when being deployed.
    "action": "blade", // C++ function that gets run when trap is triggered, usually in trapfunc.cpp
    "map_regen": "microlab_shifting_hall",  // a valid overmap id, for map_regen action traps
    "benign": true, // For things such as rollmats, funnels etc. They can not be triggered.
    "always_invisible": true, // Super well hidden traps the player can never detect
    "funnel_radius": 200, // millimeters. The higher the more rain it will capture.
    "comfort": 0, // Same property affecting furniture and terrain
    "floor_bedding_warmth": -500, // Same property affecting furniture and terrain. Also affects how comfortable a resting place this is(affects healing). Vanilla values should not exceed 1000.
    "eocs": [ "EOC_COOL_EOC_TRAP" ], // array of eocs to trigger, only usable with "action": "eocs". The alpha talker is the creature that triggered the trap and the trap's location is passed as a context variable trap_location for use with ranged traps. Items can't currently trigger eoc traps.
    "spell_data": { "id": "bear_trap" }, // data required for trapfunc::spell(), only usable with "action": "spell"
    "trigger_weight": "200 g", // If an item with this weight or more is thrown onto the trap, it triggers. Defaults to 500 grams.
    "drops": [ "beartrap" ], // ID of item spawned when disassembled
    "flags": [ "UNDODGEABLE", "AVATAR_ONLY" ], // UNDODGEABLE means that it can not be dodged, no roll required. AVATAR_ONLY means only the player can trigger this trap.
    "vehicle_data": {
      "damage": 300,
      "sound_volume": 8,
      "sound": "SNAP!",
      "sound_type": "trap",
      "sound_variant": "bear_trap",
      "remove_trap": true,
      "spawn_items": [ "beartrap" ]
    },
    "trigger_message_u": "A bear trap closes on your foot!", // This message will be printed when player steps on a trap
    "trigger_message_npc": "A bear trap closes on <npcname>'s foot!", // This message will be printed when NPC or monster steps on a trap
    "sound_threshold": [5,10] // Optional.  Minimum volume of sound that will trigger this trap.  Defaults to [0,0] (Will not trigger from sound).  If two values [min,max] are provided, trap triggers on a linearly increasing chance depending on volume, from 25% (min) to 100%(max).  To always trigger at some noise, say noise level N, specify as [N,N].  IMPORTANT: Not all traps work with this system.  Make sure to double check and test.

Vehicle Groups 

"id":"city_parked",            // Unique ID. Must be one continuous word, use underscores if necessary
"vehicles":[                 // List of potential vehicle ID's. Chance of a vehicle spawning is X/T, where
  ["suv", 600],           //    X is the value linked to the specific vehicle and T is the total of all
  ["pickup", 400],          //    vehicle values in a group
  ["car", 4700],
  ["road_roller", 300]
]

Vehicle Parts

Vehicle components when installed on a vehicle.

"id": "wheel",                // Unique identifier, must not contain a # symbol
"name": "wheel",              // Displayed name
"looks_like": "small_wheel",  // (Optional) hint to tilesets if this part has no tile,
                              // use the looks_like tile.
"bonus": 100,                 // Function depends on part type:
                              // seatbelt part is in "str" (non-functional #30239)
                              // muffler part is % noise reduction
                              // horn part volume
                              // light part intensity
                              // recharger part charging speed in watts
                              // funnel part water collection area in mm^2
"color": "dark_gray",         // Color used when part is working
"broken_color": "light_gray", // Color used when part is broken
"location": "fuel_source",    // Optional. One of the checks used when determining if a part 
                              // can be installed on a given tile. A part cannot be installed
                              // if any existing part occupies the same location.
"damage_modifier": 50,        // (Optional, default = 100) Dealt damage multiplier when this
                              // part hits something, as a percentage. Higher = more damage to
                              // creature struck
"durability": 200,            // How much damage the part can take before breaking
"description": "A wheel.",    // A description of this vehicle part when installing it
"fuel_type": "diesel",        // (Optional, default = "NULL") Type of fuel/ammo the part consumes,
                              // as an item id
"epower": -10                 // The electrical power use of the part, in watts.
                              // Negative values mean power is consumed, positive values mean power
                              // is generated.  Power consumption usually also requires the
                              // ENABLED_DRAINS_EPOWER flag and for the item to be turned on.
                              // Solar panel power gneration is modified by sun angle.
                              // When sun is at 90 degrees the panel produces the full epower.
"item": "wheel",              // The item used to install this part, and the item obtained when
                              // removing this part.
"remove_as": "solar_panel",   // Overrides "item", item returned when removing this part.
"difficulty": 4,              // Your mechanics skill must be at least this level to install this part
"breaks_into" : [             // When the vehicle part is destroyed, items from this item group
                              // (see ITEM_SPAWN.md) will be spawned around the part on the ground.
  {"item": "scrap", "count": [0,5]} // instead of an array, this can be an inline item group,
],
"breaks_into" : "some_item_group", // or just the id of an item group.
"flags": [                    // Flags associated with the part
     "EXTERNAL", "MOUNT_OVER", "WHEEL", "MOUNT_POINT", "VARIABLE_SIZE"
],
"requirements": {             // (Optional) Special installation, removal, or repair requirements
                              // for the part.  Each field consists of an object, with fields
                              // "skills", "time", and "using".
  "install": {
    "skills": [ [ "mechanics", 1 ] ], // "skills" is a list of lists, with each list being a skill
                              // name and skill level.
    "time": "200 s",          // "time" is a string specifying the time to perform the action.
    "using": [ [ "vehicle_screw", 1 ] ] // "using" is a list of list, with each list being a
                              // crafting requirement.
  },
  "removal": { "skills": [ [ "mechanics", 1 ] ], "time": "200 s", "using": [ [ "vehicle_screw", 1 ] ] },
  "repair": { "skills": [ [ "mechanics", 1 ] ], "time": "20 s", "using": [ [ "adhesive", 1 ] ] }
},
"control_requirements": {     // (Optional) Control requirements of the vehicle this part is installed.
  "air": {                    // Requirements of flying in air.
    "proficiencies": [ "prof_helicopter_pilot" ], // "proficiencies" is a list of proficiency names.
  },
  "land": {                    // Requirements of running on ground.
    "skills": [ [ "driving", 1 ] ], // "skills" is a list of lists, with each list being a skill
                              // name and skill level.
  }
},
"pseudo_tools" : [            // Crafting tools provided by this part
  { "id": "hotplate", "hotkey": "h" },
  { "id": "pot" }
],
"folded_volume": "750 ml", // volume this vpart takes in folded form, undefined or null disables folding
"folding_tools": [ "needle_curved" ], // tool itype_ids required for folding
"folding_time": "100 seconds", // time to fold this part
"unfolding_tools": [ "hand_pump" ], // tool itype_ids required for unfolding
"unfolding_time": "150 seconds", // time to unfold this part
"damage_reduction" : {        // Flat reduction of damage; see "Part Resistance". If not specified, set to zero
    "all" : 10,
    "physical" : 5
},
"qualities": [ [ "SELF_JACK", 17 ] ], // (Optional) A list of lists, with each list being a tool
                              // quality and the quality level, that the vehicle part provides.
                              // Only the "LIFT", "JACK", and "SELF_JACK" qualities are valid.
"transform_terrain": {        // (Optional) This part can transform terrain, like a plow.
  "pre_flags": [ "PLOWABLE" ], // (Optional) List of flags for the terrain that can be transformed.
  "post_terrain": "t_dirtmound", // (Optional*) The resulting terrain.
  "post_furniture": "f_boulder", // (Optional*) The resulting furniture.
  "post_field": "fd_fire",    // (Optional*) The resulting field.
  "post_field_intensity": 10, // (Mandatory if post_field is specified) The field's intensity.
  "post_field_age": "20 s"    // (Mandatory if post_field is specified) The field's time to live.
                              // *One of "post_terrain", "post_furniture", or "post_field" is required.
},
"variants_bases": [ // variant bases to generate (see below)
  { "id": "scooter", "label": "Scooter" },
  { "id": "bike", "label": "bike" }
],
"variants": [
    {
        "id": "front",         // variant id (must be unique in this part)
        "label": "Front",      // label to display for ui
        "symbols": "oooooooo", // symbols when part isn't broken
        "symbols_broken": "x"  // symbols when part is broken
    },
    { "id": "rear", "label": "Rear", "symbols": "o", "symbols_broken": "x" }
]

Symbols and Variants

Vehicle parts can have cosmetic variants that use different symbols and tileset sprites. They are declared by the “variants” object. Variants are used in the vehicle prototype as a suffix following the part id (ie id#variant), for example "frame#nw" or "halfboard#cover".

symbols and symbols_broken can be either a string of 1 character (A 1 character string is effectively 8 of that characters) or 8 characters long. The length is measured in console characters. An 8 character string represents the 8 symbols used for parts which can rotate; abcdefgh will put a when part is rotated north, b for NW, c for west, d for SW etc.

A subset of unicode box drawing characters is supported as symbols: │ ─ ┼ ┌ ┐ ┘ └, thick vertical and thick horizontal lines ┃ ━ are partially supported, they’re rendered as H and = because there are no equivalents in curses ACS encoding.

Variant bases are for generating extra variants from the specified ones, in the example above will make part loader perform cartesian product between each base and each of the variants, making finalized variants list the following: [ "front", "rear", "scooter_front", "scooter_rear", "bike_front", "bike_rear" ], the base’s label field is appended to the variant’s label.

For more details on how tilesets interact with variants and ids look into VEHICLES_JSON.md “Part Variants” section.

Unless specified as optional, the following fields are mandatory for parts with appropriate flag and are ignored otherwise.

The following optional fields are specific to CARGO parts. 

"size": "400 L",              // for parts with "CARGO" flag the capacity in liters
"cargo_weight_modifier": 33,  // (Optional, default = 100) Multiplies cargo weight by this percentage.

The following optional fields are specific to ENGINEs. 

"power": "15000 W"            // Engine motive power in watts.
"energy_consumption": "55 W"  // Engine power consumption at maximum power in watts.  Defaults to
                              // electrical power and the E_COMBUSTION flag turns it to thermal
                              // power produced from fuel_type.  Should always be larger than "power".
"m2c": 50,                    // The ratio of safe power to maximum power.
"backfire_threshold": 0.5,    // (Optional, default = 0) The engine will backfire (producing noise
                              // and smoke if the ratio of damaged HP to max HP is below this value.
"backfire_freq": 20,          // (Optional, default = 0) One in X chance of a backfire if the
                              // ratio of damaged HP to max HP is below the backfire_threshold.
"noise_factor": 15,           // (Optional, default = 0). Multiple engine power by this number to
                              // determine noise.
"damaged_power_factor": 0.5,  // (Optional, default = 0) If more than 0, power when damaged is
                              // scaled to power * ( damaged_power_factor +
                              // ( 1 - damaged_power_factor ) * ( damaged HP / max HP )
"muscle_power_factor": 0,     // (Optional, default = 0) Increases engine power by
                              // avatar (ST - 8) * muscle_power_factor.
"exclusions": [ "souls" ]     // (Optional, defaults to empty). A list of words. A new engine can't
                              // be installed on the vehicle if any engine on the vehicle shares a
                              // word from exclusions.
"fuel_options": [ "soul", "black_soul" ] // (Optional field, defaults to fuel_type).  A list of
                              // item_ids. An engine can be fueled by any fuel type in its
                              // fuel_options.  If provided, it overrides fuel_type and should
                              // include the fuel in fuel_type.
                              // To be a fuel an item needs to be made of only one material,
                              // this material has to produce energy, *ie* have a `data_fuel` entry,
                              // and it needs to have consumable charges.

The following optional fields are specific to WHEELs. 

"wheel_offroad_rating": 0.5,  // multiplier of wheel performance offroad
"wheel_terrain_modifiers": { "FLAT": [ 0, 5 ], "ROAD": [ 0, 2 ] }, // see below
"contact_area": 153,          // The surface area of the wheel in contact with the ground under
                              // normal conditions in cm^2.  Wheels with higher contact area
                              // perform better off-road.
"rolling_resistance": 1.0,    // The "squishiness" of the wheel, per SAE standards.  Wheel rolling
                              // resistance increases vehicle drag linearly as vehicle weight
                              // and speed increase.
"diameter": 8,                // diameter of wheel (in inches)
"width": 4,                   // width of the wheel (in inches)

wheel_terrain_modifiers field provides a way to modify wheel traction according to the flags set on terrain tile under each wheel.

The key is one of the terrain flags, the list of flags can be found in JSON_FLAGS.md.

The value expects an array of length 2. The first element is a modifier override applied when wheel is on the flagged terrain, the second element is an additive modifier penalty applied when wheel is NOT on flagged terrain, values of 0 are ignored. The modifier is applied over a base value provided by map::move_cost_ter_furn.

Examples:

  • Standard wheel has the field set to { "FLAT": [ 0, 4 ], "ROAD": [ 0, 2 ] }. If wheel is not on terrain flagged FLAT then the traction is 1/4 of base value. If not on terrain flagged ROAD then it’s 1/2 of base value. If neither flag is present then traction will be 1/6 of base value. If terrain is flagged with both ROAD and FLAT then the base value from map::move_cost_ter_furn is used.
  • rail_wheel has the field set to { "RAIL": [ 2, 8 ] }. If wheel is on terrain flagged RAIL the traction is overridden to be 1/2 of value calculated by map::move_cost_ter_furn, this value is the first element and considered an override, so if there had been modifiers applied prior to this they are ignored. If on terrain not flagged with RAIL then traction will be 1/8 of base value.

The following optional fields are specific to ROTORs. 

"rotor_diameter": 15,         // Rotor diameter in meters.  Larger rotors provide more lift.

The following optional fields are specific to WORKBENCHes.

These values apply to crafting tasks performed at the WORKBENCH.

"multiplier": 1.1,            // Crafting speed multiplier.
"mass": 1000000,              // Maximum mass in grams of a completed craft that can be crafted.
"volume": "20L",              // Maximum volume (as a string) of a completed craft that can be craft.

The following optional fields are specific to SEATs. 

"comfort": 3,                 // (Optional, default=0). Sleeping comfort as for terrain/furniture.
"floor_bedding_warmth": 300,  // (Optional, default=0). Bonus warmth as for terrain/furniture. Also affects how comfortable a resting place this is(affects healing). Vanilla values should not exceed 1000.
"bonus_fire_warmth_feet": 200,// (Optional, default=0). Bonus fire warmth as for terrain/furniture.

The following optional field describes pseudo tools for any part.

Crafting stations (e.g. kitchen, welding rigs etc) have tools that they provide as part of forming the inventory for crafting as well as providing menu items when examining the vehicle tile. Following example array gives the vpart a pot as passive tool for crafting because it has no hotkey defined. It also has a hotplate that can be activated by examining it with e then h on the part’s vehicle tile.

"pseudo_tools" : [
  { "id": "hotplate", "hotkey": "h" },
  { "id": "pot" }
],

Part Resistance

Damage resistance values, used by:

"all" : 0.0f,        // Initial value of all resistances, overridden by more specific types
"physical" : 10,     // Initial value for bash, cut and stab
"non_physical" : 10, // Initial value for acid, heat, cold, electricity and biological
"biological" : 0.2f, // Resistances to specific types. Those override the general ones.
"bash" : 3,
"cut" : 3,
"acid" : 3,
"stab" : 3,
"heat" : 3,
"cold" : 3,
"electric" : 3

Vehicle Placement 

"id":"road_straight_wrecks",  // Unique ID. Must be one continuous word, use underscores if necessary
"locations":[ {               // List of potential vehicle locations. When this placement is used, one of those locations will be chosen at random.
  "x" : [0,19],               // The x placement. Can be a single value or a range of possibilities.
  "y" : 8,                    // The y placement. Can be a single value or a range of possibilities.
  "facing" : [90,270]         // The facing of the vehicle. Can be a single value or an array of possible values.
} ]

Vehicle Spawn 

"id":"default_city",            // Unique ID. Must be one continuous word, use underscores if necessary
"spawn_types":[ {       // List of spawntypes. When this vehicle_spawn is applied, it will choose from one of the spawntypes randomly, based on the weight.
  "description" : "Clear section of road",           //    A description of this spawntype
  "weight" : 33,          //    The chance of this spawn type being used.
  "vehicle_function" : "jack-knifed_semi", // This is only needed if the spawntype uses a built-in json function.
  "vehicle_json" : {      // This is only needed for a json-specified spawntype.
  "vehicle" : "car",      // The vehicle or vehicle_group to spawn.
  "placement" : "%t_parked",  // The vehicle_placement to use when spawning the vehicle. This is not needed if the x, y, and facing are specified.
  "x" : [0,19],     // The x placement. Can be a single value or a range of possibilities. Not needed if placement is specified.
  "y" : 8,   // The y placement. Can be a single value or a range of possibilities. Not needed if placement is specified.
  "facing" : [90,270], // The facing of the vehicle. Can be a single value or an array of possible values. Not needed if placement is specified.
  "number" : 1, // The number of vehicles to spawn.
  "fuel" : -1, // The fuel of the new vehicles. Defined in percentage. 0 is empty, 100 is full tank, -1 is random from 7% to 35% (default).
  "status" : 1  // The status of the new vehicles. -1 = light damage (default), 0 = undamaged, 1 = disabled: destroyed seats, controls, tanks, tires, OR engine.
} } ]

Vehicles

See also VEHICLES_JSON.md

"id": "shopping_cart",                     // Internally-used name.
"name": "Shopping Cart",                   // Display name, subject to i18n.
"blueprint": "#",                          // Preview of vehicle - ignored by the code, so use only as documentation
"parts": [                                 // Parts list
    {"x": 0, "y": 0, "part": "box"},       // Part definition, positive x direction is to the left, positive y is to the right
    {"x": 0, "y": 0, "part": "casters"}    // See vehicle_parts.json for part ids
]
                                           /* Important! Vehicle parts must be defined in the
                                            * same order you would install
                                            * them in the game (ie, frames and mount points first).
                                            * You also cannot break the normal rules of installation
                                            * (you can't stack non-stackable part flags). */

Weakpoint Sets

A thin container for weakpoint definitions. The only unique fields for this object are "id" and "type". The "weakpoints" array contains weakpoints that are defined the same way as in monster definitions. See Weakpoints for details.

{
  "type": "weakpoint_set",
  "id": "wps_zombie_headshot",
  "weakpoints": [
    {
      "id": "wp_head_stun",
      "name": "the head",
      "coverage": 5,
      "crit_mult": { "all": 1.1 },
      "armor_mult": { "physical": 0.75 },
      "difficulty": { "melee": 1, "ranged": 3 },
      "effects": [
        {
          "effect": "stunned",
          "duration": [ 1, 2 ],
          "chance": 5,
          "message": "The %s is stunned!",
          "damage_required": [ 1, 10 ]
        },
        {
          "effect": "stunned",
          "duration": [ 1, 2 ],
          "chance": 25,
          "message": "The %s is stunned!",
          "damage_required": [ 11, 100 ]
        }
      ]
    }
  ]
}

Weakpoint sets are applied to a monster using the monster’s "weakpoint_sets" field. Each subsequent weakpoint set overwrites weakpoints with the same id from the previous set. This allows hierarchical sets that can be applied from general -> specific, so that general weakpoint sets can be reused for many different monsters, and more specific sets can override some general weakpoints for specific monsters. For example:

"//": "(in MONSTER type)",
"weakpoint_sets": [ "humanoid", "zombie_headshot", "riot_gear" ]

In the example above, the "humanoid" weakpoint set is applied as a base, then the "zombie_headshot" set overwrites any previously defined weakpoints with the same id (ex: “wp_head_stun”). Then the "riot_gear" set overwrites any matching weakpoints from the previous sets with armour-specific weakpoints. Finally, if the monster type has an inline "weakpoints" definition, those weakpoints overwrite any matching weakpoints from all sets.

Weakpoints only match if they share the same id, so it’s important to define the weakpoint’s id field if you plan to overwrite previous weakpoints.

data/json/items/ JSONs

Generic Items 

"type": "GENERIC",                // Defines this as some generic item
"id": "socks",                    // Unique ID. Must be one continuous word, use underscores if necessary
"name": {
    "ctxt": "clothing",           // Optional translation context. Useful when a string has multiple meanings that need to be translated differently in other languages.
    "str": "pair of socks",       // The name appearing in the examine box.  Can be more than one word separated by spaces
    "str_pl": "pairs of socks"    // Optional. If a name has an irregular plural form (i.e. cannot be formed by simply appending "s" to the singular form), then this should be specified. "str_pl" may also be needed if the unit test cannot determine if the correct plural form can be formed by simply appending "s". "str_sp" should be used instead of "str" or "str_pl" if the singular and plural forms are the same.
},
"conditional_names": [ {          // Optional list of names that will be applied in specified conditions (see Conditional Naming section for more details).
    "type": "COMPONENT_ID",       // The condition type.
    "condition": "leather",       // The condition to check for.
    "name": { "str": "pair of leather socks", "str_pl": "pairs of leather socks" } // Name field, same rules as above.
} ],
"container": "null",             // What container (if any) this item should spawn within
"repairs_like": "scarf",          // If this item does not have recipe, what item to look for a recipe for when repairing it.
"color": "blue",                 // Color of the item symbol.
"symbol": "[",                   // The item symbol as it appears on the map. Must be a Unicode string exactly 1 console cell width.
"looks_like": "sheet_cotton",              // hint to tilesets if this item has no tile, use the looks_like tile
"description": "Socks. Put 'em on your feet.", // Description of the item
"snippet_category": "snippet_category",        // Can be used instead of description, if author want to have multiple ways to describe an item. See #Snippets
"ascii_picture": "ascii_socks", // Id of the asci_art used for this item
"phase": "solid",                            // (Optional, default = "solid") What phase it is
"weight": "350 g",                           // Weight, weight in grams, mg and kg can be used - "50 mg", "5 g" or "5 kg". For stackable items (ammo, comestibles) this is the weight per charge.
"volume": "250 ml",                          // Volume, volume in ml and L can be used - "50 ml" or "2 L". For stackable items (ammo, comestibles) this is the volume of stack_size charges.
"integral_volume": "50 ml",                        // Volume added to base item when item is integrated into another (eg. a gunmod integrated to a gun). Volume in ml and L can be used - "50 ml" or "2 L". Default is the same as volume.
"integral_weight": "50 g",                        // Weight added to base item when item is integrated into another (eg. a gunmod integrated to a gun). Default is the same as weight.
"longest_side": "15 cm",                     // Length of longest item dimension. Default is cube root of volume.
"rigid": false,                              // For non-rigid items volume (and for worn items encumbrance) increases proportional to contents
"insulation": 1,                             // (Optional, default = 1) If container or vehicle part, how much insulation should it provide to the contents
"price": "1 USD",                                // Used when bartering with NPCs. For stackable items (ammo, comestibles) this is the price for stack_size charges. Can use string "cent" "USD" or "kUSD".
"price_postapoc": "1 USD",                       // Same as price but represent value post Cataclysm. Can use string "cent" "USD" or "kUSD".
"stackable": true,                           // This item can be stacked together, similarly to `charges`
"degradation_multiplier": 0.8,               // Controls how quickly an item degrades when taking damage. 0 = no degradation. Defaults to 1.0.
"solar_efficiency": 0.3,                     // Efficiency of solar energy conversion for solarpacks; require SOLARPACK_ON to generate electricity; default 0
"source_monster": "mon_zombie",               // This item is corpse of this monster (so it has weight and volume of this monster), and revive into this monster; require COPRSE flag
"thrown_damage": [ { "damage_type": "bash", "amount": 15 } ], // Damage, that would be dealt when you throw this item; lack of this field fall back to use melee damage, including player's str bonus applied to melee attack
"material": [                                // Material types, can be as many as you want.  See materials.json for possible options
  { "type": "cotton", "portion": 9 },        // type indicates the material's ID, portion indicates proportionally how much of the item is composed of that material
  { "type": "plastic" }                      // portion can be omitted and will default to 1. In this case, the item is 90% cotton and 10% plastic.
],
"repairs_with": [ "plastic" ],               // Material types that this item can be repaired with. Defaults to all the item materials.
"weapon_category": [ "WEAPON_CAT1" ],        // (Optional) Weapon categories this item is in for martial arts.
"melee_damage": {                            // (Optional) Damage caused by using it as a melee weapon.  These values cannot be negative.
  "bash": 0,
  "cut": 0
},
"to_hit" {                                   // (Optional) To hit bonus values, omit if item isn't suited to be used as a melee weapon, see [GAME_BALANCE.md](/GAME_BALANCE.html#to-hit-value) for individual value breakdowns.
  "grip": "solid",                           // the item's grip value
  "length": "long",                          // the item's length value
  "surface": "point",                        // the item's striking surface value
  "balance": "neutral"                       // the item's balance value
},
"to_hit": 1,                                 // (Optional, legacy, default = -2) To-hit bonus if using it as a melee weapon.
"variant_type": "gun"      // Possible options: "gun", "generic" - controls which options enable/disable seeing the variants of this item.
"variants": [              // Cosmetic variants this item can have
  {
    "id": "variant_a",                           // id used in spawning to spawn this variant specifically
    "name": { "str": "Variant A" },             // The name used instead of the default name when this variant is selected
    "description": "A fancy variant A",         // The description used instead of the default when this variant is selected
    "ascii_picture": "valid_ascii_art_id",      // An ASCII art picture used when this variant is selected. If there is none, the default (if it exists) is used.
    "symbol": "/",                              // Valid unicode character to replace the item symbol. If not specified, no change will be made.
    "color": "red",                             // Replacement color of item symbol. If not specified, no change will be made.
    "weight": 2,                                // The relative chance of this variant being selected over other variants when this item is spawned with no explicit variant. Defaults to 1. If it is 0, this variant will not be selected
    "append": true,                             // If this description should just be appended to the base item description instead of completely overwriting it.
    "expand_snippets": true                     // Allows to use snippet tags, see #Snippets
  }
],
"flags": ["VARSIZE"],                        // Indicates special effects, see JSON_FLAGS.md
"environmental_protection_with_filter": 6,   // the resistance to environmental effects if an item (for example a gas mask) requires a filter to operate and this filter is installed. Used in combination with use_action 'GASMASK' and 'DIVE_TANK'
"magazine_well": 0,                          // Volume above which the magazine starts to protrude from the item and add extra volume
"magazines": [                               // Magazines types for each ammo type (if any) which can be used to reload this item
    [ "9mm", [ "glockmag" ] ]                // The first magazine specified for each ammo type is the default
    [ "45", [ "m1911mag", "m1911bigmag" ] ],
],
"milling": {                                 // Optional. If given, the item can be milled in a water/wind mill.
  "into": "flour",                           // The item id of the result of the milling.
  "recipe": "paste_nut_mill_10_1"            // Reference to the recipe that performs the task. The syntax is <product name>_mill_<source amount>_<product amount>. The recipe is then defined as a normal recipe for the source with the product as its result and an id_suffix of "mill_X_Y". 
                                             // See data/json/recipes/food/milling.json for such recipes. Can also use "milling": { "into": "null", "recipe": "" } to override milling from a copied base item.
},
"explode_in_fire": true,                     // Should the item explode if set on fire
"nanofab_template_group": "nanofab_recipes", // This item is nanofabricator recipe, and point to itemgroup with items, that it could possibly contain; require nanofab_template_group
"template_requirements": "nanofabricator",   // `requirement`, that needed to craft any of this templates; used as "one full requirememt per 250 ml of item's volume" - item with volume 750 ml would require three times of `requirement`, item of 2L - eight times of `requirement`
"explosion": {                               // Physical explosion data
    "power": 10,                             // Measure of explosion power in grams of TNT equivalent explosive, affects damage and range.
    "distance_factor": 0.9,                  // How much power is retained per traveled tile of explosion. Must be lower than 1 and higher than 0.
    "max_noise": 25,                         // Maximum amount of (auditory) noise the explosion might produce.
    "fire": true,                            // Should the explosion leave fire
    "shrapnel": 200,                         // Total mass of casing, rest of fragmentation variables set to reasonable defaults.
    "shrapnel": {
        "casing_mass": 200,                  // Total mass of casing, casing/power ratio determines fragment velocity.
        "fragment_mass": 0.05,               // Mass of each fragment in grams. Large fragments hit harder, small fragments hit more often.
        "recovery": 10,                      // Percentage chance to drop an item at landing point.
        "drop": "nail"                       // Which item to drop at landing point.
    }
},

To hit object

For additional clarity, an item’s to_hit bonus can be encoded as string of 4 fields. All the fields are mandatory:

"to_hit": {
    "grip": "weapon",      // one of "bad", "none", "solid", or "weapon"
    "length": "hand",      // one of "hand", "short", or "long"
    "surface": "any",      // one of "point", "line", "any", or "every"
    "balance": "neutral"   // one of "clumsy", "uneven", "neutral", or "good"
}

See GAME_BALANCE.md

Ammo 

{
  "id": "223",            // ID of the ammo
  "type": "AMMO",         // Defines this as ammo. It can use the same entries as a GENERIC item
                          // Additionally, some AMMO specific entries consist of the following:
  "ammo_type": "shot",    // Determines where the items can be loaded in. Requires a proper `"ammunition_type"` to be declared (see below). In this case, the `223` rounds can be loaded into magazines that accept `shot`-type ammo
  "damage": {             // Ranged damage when fired
    "damage_type": "bullet",  // Type of the damage that would be dealt
    "amount": 39,             // Amount of damage to be dealt
    "armor_penetration": 2,   // Flat armor penetration
    "barrels": [              // Replaces the `amount` when weapon has barrel lenghth defined, allow to change the damage of the single round depending on the barrel length.
      { "barrel_length": "28 mm", "amount": 13 },  // If weapon has barrel lengh this or less, this amount of the damage would be applied
      { "barrel_length": "30 mm", "amount": 14 },
      { "barrel_length": "35 mm", "amount": 15 },
      { "barrel_length": "39 mm", "amount": 16 }
    ]
  },
  "range": 5,             // Range when fired
  "recovery_chance": 6,   // Percentage of chance to recover the ammo after firing
  "dispersion": 0,        // Inaccuracy of ammo, measured in 100ths of Minutes Of Angle (MOA)
  "shot_counter": 5,      // Increases amount of shots produced by gun by this amount. `"shot_counter": 5` means each shot will be counted as 6 shots (1 you actually perform + 5). Designed for using in suppressor mod breakage and for stuff like replaceable barrels, but not used anywhere at this moment
  "projectile_count": 5,  // Amount of pellets, that the ammo will shot, like in shotgun-like weapon. If used, `"shot_damage"` should be specified
  "multi_projectile_effects": true,  // (Optional) Boolean, default false. If the projectile_count is greater than 1, determines if the extra projectiles will also trigger any ammo effects. (For more on ammo effects see below)
  "shot_damage": { "damage_type": "bullet", "amount": 15 },  // (Optional) Specifies the damage caused by a single projectile fired from this round. If present, projectile_count must also be specified. Syntax is the same as `"damage"`
  "critical_multiplier": 4,  // If the hit is a critical hit, all ranged damage dealt will be multiplied by this
  "shot_spread": 100,     // (Optional) Specifies the additional dispersion of single projectiles. Only meaningful if shot_count is present.
  "recoil": 18,           // Recoil caused when firing. Roughly set to the projectile's muzzle energy in J, the same value the ammo's damage is derived from. See also the gun's min_cycle_recoil value
  "count": 25,            // Number of rounds that spawn together
  "stack_size": 50,       // (Optional) How many rounds are in the above-defined volume. If omitted, is the same as 'count'
  "show_stats": true,     // (Optional) Force stat display for combat ammo. (for projectiles lacking both damage and prop_damage)
  "loudness": 10,         // (Optional) Modifier that can increase or decrease base gun's noise when firing. If loudness value is not specified, then game calculates it automatically from ammo's range, damage, and armor penetration.
  "casing": "223_casing", // Casing of the ammo that would be left after shooting
  "effects": ["COOKOFF", "SHOT"]  // Ammo effcts, see below
},

Additionally, non-"type": "AMMO" items can be considered as ammo (capable of being shot, capable of being loaded into a MAGAZINE pocket), by adding the ammo_data field, which supports the same fields as the AMMO type. Do note that a proper ammunition_type is also required:

  {
    "id": "water_clean",
    "type": "COMESTIBLE",
    ...
    "ammo_data": { "ammo_type": "water", "damage": { "damage_type": "cold", "amount": 2 }, "range": 4 },
    ...
  },
  {
    "id": "water",
    "type": "ammunition_type",
    "name": "water",
    "default": "water"
  },

Ammo Effects

ammo_effects define what effect the projectile, that you shoot, would have. List of existing ammo effects, including hardcoded one, can be found at data/json/ammo_effects.json

{
  "id": "AE_NULL",           // id of an effect
  "type": "ammo_effect",     // define it is an ammo effect
  "aoe": {                   // this field would be spawned at the tile projectile hit
    "field_type": "fd_fog",  // field, that would be spawned around the center of projectile; default "fd_null"
    "intensity_min": 1,      // min intensity of the field; default 0
    "intensity_max": 3,      // max intensity of the field; default 0
    "radius": 5,             // radius of a field to spawn; default 1
    "radius_z": 1,           // radius across z-level; default 0
    "chance": 100,           // probability to spawn 1 unit of field, from 0 to 100; default 100
    "size": 0,               // seems to be the threshold, where autoturret stops shooting the weapon to prevent friendly fire;; default 0
    "check_passable": false, // if false, projectile is able to penetrate impassable terrains, if penetration is defined (like walls and windows); if true, projectile can't penetrate even the sheet of glass; default false
    "check_sees": false,     // if false, field can be spawned behind the opaque wall (for example, behind the concrete wall); if true, it can't; default false
    "check_sees_radius": 0   // if "check_sees" is true, and this value is smaller than "radius", this value is used as radius instead. The purpose nor reasoning is unknown, probably some legacy of mininuke, so just don't use it; default 0
  },
  "trail": {                 // this field would be spawned across whole projectile path
    "field_type": "fd_fog",  // field, that would be spawned; defautl "fd_null"
    "intensity_min": 1,      // min intensity of the field; default 0
    "intensity_max": 3,      // max intensity of the field; default 0
    "chance": 100            // probability to spawn 1 unit of field, from 0 to 100; default 100
  },
  "explosion": {             // explosion, that will happen at the tile that projectile hit
    "power": 0,              // mandatory; power of the explosion, in grams of tnt; pipebomb is about 300, grenade (without shrapnel) is 240
    "distance_factor": 0.8,  // how fast the explosion decay, closer to 1 mean lesser "power" loss per tile, 0.8 means 20% of power loss per tile; default 0.75, value should be bigger than 0, but lesser than 1
    "fire": false,           // explosion create a fire, related to it's power, distance and distance_factor
    "shrapnel": {            // explosion create a shrapnel, that deal the damage, calculated by gurney equasion
      "casing_mass": 0,      // total mass of casing, casing/power ratio determines fragment velocity.
      "fragment_mass": 0.0,  // Mass of each fragment in grams. Large fragments hit harder, small fragments hit more often.
      "recovery": 0,         // Percentage chance to drop an item at landing point.
      "drop": "null"         // Which item to drop at landing point
    }
  },
  "do_flashbang": false,     // Creates a one tile radius EMP explosion at the hit location; default false
  "do_emp_blast": false      // Creates a hardcoded flashbang explosion; default false
  "foamcrete_build": false   // Creates foamcrete fields and walls on the hit location, used in aftershock; default false
  "eoc": [ "EOC_CAUSE_PAIN", "EOC_CAUSE_VOMIT" ], // Runs EoC when hit the target. See EFFECT_ON_CONDITION.md#typical-alpha-and-beta-talkers-by-cases for more information
  "spell_data": { "id": "bear_trap" } // Spell, that would be casted when projectile hits an enemy
  "spell_data": { "id": "release_the_deltas", "hit_self": true, "min_level": 10 }, //another example
  "always_cast_spell ": false // if spell_data is used, and this is true, spell would be casted even if projectile did not deal any damage. Default false.
}

Magazine 

"type": "MAGAZINE",              // Defines this as a MAGAZINE
...                              // same entries as above for the generic item.
// Only MAGAZINE type items may define the following fields:
"ammo_type": [ "40", "357sig" ], // What types of ammo this magazine can be loaded with
"capacity" : 15,                 // Capacity of magazine (in equivalent units to ammo charges)
"count" : 0,                     // Default amount of ammo contained by a magazine (set this for ammo belts)
"default_ammo": "556",           // If specified override the default ammo (optionally set this for ammo belts)
"reload_time" : 100,             // How long it takes to load each unit of ammo into the magazine
"mag_jam_mult": 1.25             // Multiplier for gun mechanincal malfunctioning from magazine, mostly when it's damaged; Values lesser than 1 reflect better quality of the magazine, that jam less; bigger than 1 result in gun being more prone to malfunction and jam at lesser damage level; zero mag_jam_mult (and zero gun_jam_mult in a gun) would remove any chance for a gun to malfunction. Only works if gun has any fault from gun_mechanical_simple group presented; Jam chances are described in Character::handle_gun_damage(); at this moment it is roughly: 0.027% for undamaged magazine, 5% for 1 damage (|\), 24% for 2 damage (|.), 96% for 3 damage (\.), and 250% for 4 damage (XX), then this and gun values are summed up. Rule of thumb: helical mags should have 3, drum mags should have 2, the rest can be tweaked case by case, but mostly doesn't worth emulating it
"linkage" : "ammolink"           // If set one linkage (of given type) is dropped for each unit of ammo consumed (set for disintegrating ammo belts)

Armor

Armor can be defined like this:

"type" : "ARMOR",                   // Defines this as armor
...                                 // same entries as above for the generic item.
                                    // additional some armor specific entries:
"covers" : [ "foot_l", "foot_r" ],  // Where it covers.  Use bodypart_id defined in body_parts.json
"warmth" : 10,                      //  (Optional, default = 0) How much warmth clothing provides
"environmental_protection" : 0,     //  (Optional, default = 0) How much environmental protection it affords
"encumbrance" : 0,                  // Base encumbrance (unfitted value)
"max_encumbrance" : 0,              // When a character is completely full of volume, the encumbrance of a non-rigid storage container will be set to this. Otherwise it'll be between the encumbrance and max_encumbrance following the equation: encumbrance + (max_encumbrance - encumbrance) * non-rigid volume / non-rigid capacity.  By default, max_encumbrance is encumbrance + (non-rigid volume / 250ml).
"sided": true,                      // (Optional, default false) If true, this is a sided armor. Sided armor is armor that even though it describes covering, both legs, both arms, both hands, etc. actually only covers one "side" at a time but can be moved back and forth between sides at will by the player.
"coverage": 80,                     // What percentage of body part is covered (in general)
"cover_melee": 60,                  // What percentage of body part is covered (against melee)
"cover_ranged": 45,                 // What percentage of body part is covered (against ranged)
"cover_vitals": 10,                 // What percentage of critical hit damage is mitigated
"material_thickness" : 1,           // Thickness of material, in millimeter units (approximately).  Ordinary clothes range from 0.1 to 0.5. Particularly rugged cloth may reach as high as 1-2mm, and armor or protective equipment can range as high as 10 or rarely more.
"power_armor" : false,              // If this is a power armor item (those are special).
"energy_shield_max_hp" : false,     // Determines the inital value for the `ENERGY_SHIELD_HP` and `ENERGY_SHIELD_MAX_HP` item variables used by energy shields. The field has no effect for armor pieces without the `ENERGY_SHIELD` flag.
"non_functional" : "destroyed",     //this is the itype_id of an item that this turns into when destroyed. Currently only works for ablative armor.
"damage_verb": "makes a crunch, something has shifted", // if an item uses non-functional this will be the description when it turns into its non functional variant.
"valid_mods" : ["steel_padded"],    // List of valid clothing mods. Note that if the clothing mod doesn't have "restricted" listed, this isn't needed.
"armor": [ ... ]

Armor Portion Data

Encumbrance and coverage can be defined on a piece of armor as such:

"armor": [
  {
    "encumbrance": [ 2, 8 ],
    "breathability": "AVERAGE",
    "layers": [ "SKINTIGHT" ],
    "rigid_layer_only": true,
    "coverage": 95,
    "cover_melee": 95,
    "cover_ranged": 50,
    "cover_vitals": 5,
    "covers": [ "torso" ],
    "specifically_covers": [ "torso_upper", "torso_neck", "torso_lower" ],
    "material": [
      { "type": "cotton", "covered_by_mat": 100, "thickness": 0.2 },
      { "type": "plastic", "covered_by_mat": 15, "thickness": 0.8, "ignore_sheet_thickness": "true" }
    ]
  },
  {
    "encumbrance": 2,
    "volume_encumber_modifier": 0.5,
    "coverage": 80,
    "cover_melee": 80,
    "cover_ranged": 70,
    "cover_vitals": 5,
    "activity_noise": { "volume": 8, "chance": 60 },
    "covers": [ "arm_r", "arm_l" ],
    "specifically_covers": [ "arm_shoulder_r", "arm_shoulder_l" ],
    "material": [
      { "type": "cotton", "covered_by_mat": 100, "thickness": 0.2 }
    ]
  }
]
Encumbrance

(integer, or array of 2 integers) The value of this field (or, if it is an array, the first value in the array) is the base encumbrance (unfitted) of this item. When specified as an array, the second value is the max encumbrance - when the pockets of this armor are completely full of items, the encumbrance of a non-rigid item will be set to this. Otherwise it’ll be between the first value and the second value following this the equation: first value + (second value - first value) * non-rigid volume / non-rigid capacity. By default, the max encumbrance is the encumbrance + (non-rigid volume / 250ml). volume_encumber_modifier is the more modern way to do it is to set a scaling factor on the armor itself. This is much easier to read and quickly parse (not requiring mental math) and is a direct scaling on that 250ml constant. So if I set a “volume_encumber_modifier” of .25 it means that it’s one additional encumbrance per 1000ml (250ml/.25).

Encumbrance_modifiers

Experimental feature for having an items encumbrance be generated by weight instead of a fixed number. Takes an array of “DESCRIPTORS” described in the code. If you don’t need any descriptors put “NONE”. This overrides encumbrance putting it as well will make it be ignored. Currently only works for head armor.

breathability

Overrides the armor breathability, which is driven by armor material. Can be IMPERMEABLE (0%), POOR (30%), AVERAGE (50%), GOOD (80%), MOISTURE_WICKING (110%), SECOND_SKIN (140%)

Layers

What layer this piece of armor occupy. Can be PERSONAL, SKINTIGHT, NORMAL, WAIST, OUTER, BELTED, AURA, see ARMOR_BALANCE_AND_DESIGN.md#layers for details

rigid_layer_only

If true, this armor portion is rigid, and conflict with another rigid clothes on the same layers.

Coverage

(integer) What percentage of time this piece of armor will be hit (and thus used as armor) when an attack hits the body parts in covers.

cover_melee and cover_ranged represent the percentage of time this piece of armor will be hit by melee and ranged attacks respectively. Usually these would be the same as coverage.

cover_vitals represents the percentage of critical hit damage is absorbed. Only the excess damage on top of normal damage is mitigated, so a vital coverage value of 100 means that critical hits would do the same amount as normal hits.

Covers

(array of strings) What body parts this section of the armor covers. See the bodypart_ids defined in body_parts.json for valid values.

Specifically Covers

(array of strings) What sub body parts this section of the armor covers. See the sub_bodypart_ids defined in body_parts.json for valid values. These are used for wearing multiple armor pieces on a single layer without gaining encumbrance penalties. They are not mandatory if you don’t specify them it is assumed that the section covers all the body parts it covers entirely. strapped layer items, and outer layer armor should always have these specified otherwise it will conflict with other pieces.

Part Materials

(array of objects) The type, coverage and thickness of the materials that make up this portion of the armor.

  • type indicates the material ID.
  • covered_by_mat (optional) indicates how much (%) of this armor portion is covered by said material. Defaults to 100.
  • thickness (optional) indicates the thickness of said material for this armor portion. Defaults to 0.0. The portion coverage and thickness determine how much the material contributes towards the armor’s resistances. NOTE: These material definitions do not replace the standard "material" tag. Instead they provide more granularity for controlling different armor resistances.
  • ignore_sheet_thickness (optional, default false) materials that come in a specific thickness, if you don’t use a multiple of the allowed thickness the game throws an error

covered_by_mat should not be confused with coverage. When specifying covered_by_mat, treat it like the portion field using percentage instead of a ratio value. For example:

"armor": [
  {
    "covers" : [ "arm_r", "arm_l" ],
    "material": [
      {
        "type": "cotton",
        "covered_by_mat": 100,
        "thickness": 0.2
      },
      {
        "type": "plastic",
        "covered_by_mat": 15,
        "thickness": 0.6
      }
    ],
    ...
  }
]

The case above describes a portion of armor that covers the arms. This portion is 100% covered by cotton, so a hit to the arm part of the armor will definitely impact the cotton. That portion is also 15% covered by plastic. This means that during damage absorption, the cotton material contributes 100% of its damage absorption, while the plastic material only contributes 15% of its damage absorption. Damage absorption is also affected by thickness, so thickness and material cover both provide positive effects for protection.

Armor Data

Alternately, every item (book, tool, gun, even food) can be used as armor if it has armor_data:

"type" : "TOOL",      // Or any other item type
...                   // same entries as for the type (e.g. same entries as for any tool),
"armor_data" : {      // additionally the same armor data like above
    "warmth" : 10,
    "environmental_protection" : 0,
    "armor": [
      {
        "material": [
          { "type": "cotton", "covered_by_mat": 100, "thickness": 0.2 },
          { "type": "plastic", "covered_by_mat": 15, "thickness": 0.6 }
        ],
        "covers" : [ "foot_l", "foot_r" ],
        "encumbrance" : 0,
        "coverage" : 80,
        "cover_melee": 80,
        "cover_ranged": 70,
        "cover_vitals": 5
      }
    ],
    "power_armor" : false
}

Guidelines for thickness:

According to https://propercloth.com/reference/fabric-thickness-weight/, dress shirts and similar fine clothing range from 0.15mm to 0.35mm. According to https://leathersupreme.com/leather-hide-thickness-in-leather-jackets/:

  • Fashion leather clothes such as thin leather jackets, skirts, and thin vests are 1.0mm or less.
  • Heavy leather clothes such as motorcycle suits average 1.5mm.

From this site, an equivalency guideline for fabric weight to mm:

Cloth oz/yd2 g/m2 Inches mm
Fiberglass (plain weave) 2.3 78 0.004 0.10
Fiberglass (plain weave) 6.0 203 0.007 0.17
Kevlar (TM) (plain weave) 5.0 170 0.010 0.25
Carbon Fiber (plain weave) 5.8 197 0.009 0.23
Carbon Fiber (unidirectional) 9.0 305 0.011 0.28

Chart cobbled together from several sources for more general materials:

Fabric oz/yd2 Max g/m2 Inches mm to use
Very light 0-4 136 0.006-0.007 0.15
Light 4-7 237 0.008 0.2
Medium 7-11 373 0.009-0.011 0.25
Heavy 11-14 475 0.012-0.014 0.3

Shoe thicknesses are outlined at https://secretcobbler.com/choosing-leather/; TL;DR: upper 1.2 - 2.0mm, lining 0.8 - 1.2mm, for a total of 2.0 - 3.2mm.

For turnout gear, see https://web.archive.org/web/20220331215535/http://bolivar.mo.us/media/uploads/2014/09/2014-06-bid-fire-gear-packet.pdf.

Armor inheritance

Inheritance of one armor using another allows to copy all its values, including layers, thicknesses, and another. Additionally, the replace_materials could be used to replace one material in parent armor to another material in child node, in format "replace_materials": { "material_1": "material_2" }. For example:

{
  "id": "skeleton_plate",
  "type": "TOOL_ARMOR",
  "copy-from": "armor_lc_plate",
  "name": { "str": "skeletal plate" },
  "description": "A full body multilayered suit of skeletal plate armor.",
  "replace_materials": { "lc_steel": "bone", "lc_steel_chain": "flesh" },
  "extend": { "flags": [ "INTEGRATED", "UNBREAKABLE", "NO_SALVAGE" ] },
  "proportional": { "encumbrance": 0.3 }
}

In this json, the item inherited all stats of armor_lc_plate, but replaced lc_steel material with bone, and lc_steel_chain with flesh. Multiple additional flags were added using extend, and encumbrance was proportionally decreased to 30% of original.

Pet Armor

Pet armor can be defined like this:

"type" : "PET_ARMOR",     // Defines this as armor
...                   // same entries as above for the generic item.
                      // additional some armor specific entries:
"environmental_protection" : 0,  //  (Optional, default = 0) How much environmental protection it affords
"material_thickness" : 1,  // Thickness of material, in millimeter units (approximately).  Generally ranges between 1 - 5, more unusual armor types go up to 10 or more
"pet_bodytype":        // the body type of the pet that this monster will fit. See MONSTERS.md
"max_pet_vol":          // the maximum volume of the pet that will fit into this armor. Volume in ml or L can be used - "50 ml" or "2 L".
"min_pet_vol":          // the minimum volume of the pet that will fit into this armor. Volume in ml or L can be used - "50 ml" or "2 L".
"power_armor" : false, // If this is a power armor item (those are special).

Alternately, every item (book, tool, gun, even food) can be used as armor if it has armor_data:

"type" : "TOOL",      // Or any other item type
...                   // same entries as for the type (e.g. same entries as for any tool),
"pet_armor_data" : {      // additionally the same armor data like above
    "environmental_protection" : 0,
    "pet_bodytype": "dog",
    "max_pet_vol": "35000 ml",
    "min_pet_vol": "25000 ml",
    "material_thickness" : 1,
    "power_armor" : false
}

Books

Books can be defined like this:

"type" : "BOOK",      // Defines this as a BOOK
...                   // same entries as above for the generic item.
                      // additional some book specific entries:
"max_level" : 5,      // Maximum skill level this book will train to
"intelligence" : 11,  // Intelligence required to read this book without penalty
"time" : "35 m",      // Time a single read session takes. An integer will be read in minutes or a time string can be used.
"fun" : -2,           // Morale bonus/penalty for reading
"skill" : "computer", // Skill raised
"chapters" : 4,       // Number of chapters (for fun only books), each reading "consumes" a chapter. Books with no chapters left are less fun (because the content is already known to the character).
"required_level" : 2,  // Minimum skill level required to learn
"martial_art": "style_mma", // Martial art learned from this book; incompatible with `skill`
"proficiencies": [    // Having this book mitigate lack of proficiency, required for crafting 
  { 
    "proficiency": "prof_fermenting", // id of proficiency
    "time_factor": 0.1,               // slowdown for using this book proficiency - slowdown from lack of proficiency is multiplied on this value, so for `0.75`, if recipe adds 10 hours for lack of proficiency,  with book it would be [ 10 * ( 1 - 0.75 ) = ] 2.5 hours; multiple books stacks, but in logarithmic way, meaning having more books of the same proficiency is better than having one book, but never would be better than learning the proficiency
    "fail_factor": 0.25               // works same as `time_factor`
  },
  { "proficiency": "prof_brewing", "time_factor": 0.25, "fail_factor": 0.5 },
  { "proficiency": "prof_winemaking", "time_factor": 0.1, "fail_factor": 0.25 }
],

It is possible to omit the max_level field if the book you’re creating contains only recipes and it’s not supposed to level up any skill. In this case the skill field will just refer to the skill required to learn the recipes.

Alternately, every item (tool, gun, even food) can be used as book if it has book_data:

"type" : "TOOL",      // Or any other item type
...                   // same entries as for the type (e.g. same entries as for any tool),
"book_data" : {       // additionally the same book data like above
    "max_level" : 5,
    "intelligence" : 11,
    "time" : 35,
    "fun" : -2,
    "skill" : "computer",
    "chapters" : 4,
    "use_action" : "MA_MANUAL", // The book_data can have use functions (see USE ACTIONS) that are triggered when the books has been read. These functions are not triggered by simply activating the item (like tools would).
    "required_level" : 2
}

Since many book names are proper names, it’s often necessary to explicitly specify the plural forms. The following is the game’s convention on plural names of books:

  1. For non-periodical books (textbooks, manuals, spellbooks, etc.),
    1. If the book’s singular name is a proper name, then the plural name is copies of (singular name). For example, the plural name of Lessons for the Novice Bowhunter is copies of Lessons for the Novice Bowhunter.
    2. Otherwise, the plural name is the usual plural of the singular name. For example, the plural name of tactical baton defense manual is tactical baton defense manuals
  2. For periodicals (magazines and journals),
    1. If the periodical’s singular name is a proper name, and doesn’t end with “Magazine”, “Weekly”, “Monthly”, etc., the plural name is issues of (singular name). For example, the plural name of Archery for Kids is issues of Archery for Kids.
    2. Otherwise, the periodical’s plural name is the usual plural of the singular name. For example, the plural name of Crafty Crafter's Quarterly is Crafty Crafter's Quarterlies.
  3. For board games (represented internally as book items),
    1. If the board game’s singular name is a proper name, the plural is sets of (singular name). For example, the plural name of Picturesque is sets of Picturesque.
    2. Otherwise the plural name is the usual plural. For example, the plural of deck of cards is decks of cards.

Conditional Naming

The conditional_names field allows defining alternate names for items that will be displayed instead of (or in addition to) the default name, when specific conditions are met. Take the following (incomplete) definition for sausage as an example of the syntax:

{
  "name": "sausage",
  "conditional_names": [
    {
      "type": "FLAG",
      "condition": "CANNIBALISM",
      "name": "Mannwurst"
    },
    {
      "type": "COMPONENT_ID_SUBSTRING",
      "condition": "mutant",
      "name": { "str_sp": "sinister %s" }
    },
    {
      "type": "COMPONENT_ID",
      "condition": "mutant",
      "name": { "str_sp": "sinister %s" }
    },
    {
      "type": "VAR",
      "condition": "DISPLAY_NAME_MORALE",
      "name": { "str_sp": "%s (morale)" },
      "value" : "true"
    },
    {
      "type": "SNIPPET_ID",
      "condition": "test",
      "value":"one",
      "name": { "str_sp": "Report 1" } }
  ]
}

You can list as many conditional names for a given item as you want. Each conditional name must consist of 3 elements:

  1. The condition type:
    • COMPONENT_ID_SUBSTRING searches all the components of the item (and all of their components, and so on) for an item with the condition string in their ID. The ID only needs to contain the condition, not match it perfectly (though it is case sensitive). For example, supplying a condition mutant would match mutant_meat.
    • COMPONENT_ID Similar to COMPONENT_ID_SUBSTRING, but search the exact component match
    • FLAG which checks if an item has the specified flag (exact match).
    • VITAMIN which checks if an item has the specified vitamin (exact match).
    • VAR which checks if an item has a variable with the given name (exact match) and value = value.
    • SNIPPET_IDwhich checks if an item has a snippet id variable set by an effect_on_condition with the given name (exact match) and snippets id = value.
  2. The condition you want to look for.
  3. The name to use if a match is found. Follows all the rules of a standard name field, with valid keys being str, str_pl, and ctxt. You may use %s here, which will be replaced by the name of the item. Conditional names defined prior to this one are taken into account.

So, in the above example, if the sausage is made from mutant humanoid meat, and therefore both has the CANNIBALISM flag, and has a component with mutant in its ID:

  1. First, the item name is entirely replaced with “Mannwurst” if singular, or “Mannwursts” if plural.
  2. Next, it is replaced by “sinister %s”, but %s is replaced with the name as it was before this step, resulting in “sinister Mannwurst” or “sinister Mannwursts”.

NB: If "str": "sinister %s" was specified instead of "str_sp": "sinister %s", the plural form would be automatically created as “sinister %ss”, which would become “sinister Mannwurstss” which is of course one S too far. Rule of thumb: If you are using %s in the name, always specify an identical plural form unless you know exactly what you’re doing!

Color Key

When adding a new book, please use this color key:

  • Magazines: pink
  • “Paperbacks” Short enjoyment books (including novels): light_cyan
  • “Hardbacks” Long enjoyment books (including novels): light_blue
  • “Small textbook” Beginner level textbooks, guides and martial arts books: green
  • “Large textbook” Advanced level textbooks and advanced guides: blue
  • Religious books: dark_gray
  • “Printouts” (including spiral-bound, binders, and similar) Technical documents, (technical?) protocols, (lab) journals, personal diaries: light_green
  • Other reading material/non-books (use only if every other category does not apply): light_gray

A few exceptions to this color key may apply, for example for books that don’t are what they seem to be. Never use yellow and red, those colors are reserved for sounds and infrared vision.

CBMs

CBMs can be defined like this:

"type" : "BIONIC_ITEM",         // Defines this as a CBM
...                             // same entries as above for the generic item.
                                // additional some CBM specific entries:
"bionic_id" : "bio_advreactor", // ID of the installed bionic if not equivalent to "id"
"difficulty" : 11,              // Difficulty of installing CBM
"is_upgrade" : true,            // Whether the CBM is an upgrade of another bionic.
"installation_data" : "AID_bio_advreactor" // ID of the item which allows for almost guaranteed installation of corresponding bionic.

Comestibles 

"type" : "COMESTIBLE",      // Defines this as a COMESTIBLE
...                         // same entries as above for the generic item.
// Only COMESTIBLE type items may define the following fields:
"spoils_in" : 0,            // A time duration: how long a comestible is good for. 0 = no spoilage.
"use_action" : [ "CRACK" ],     // What effects a comestible has when used, see special definitions below
"stim" : 40,                // Stimulant effect
"sleepiness_mod": 3,           // How much sleepiness this comestible removes. (Negative values add sleepiness)
"comestible_type" : "MED",  // Comestible type, used for inventory sorting. One of 'FOOD', 'DRINK', 'MED', or 'INVALID' (consider using a different "type" than COMESTIBLE instead of using INVALID)
"consumption_effect_on_conditions" : [ "EOC_1" ],  // Effect on conditions to run after consuming.  Inline or string id supported
"quench" : 0,               // Thirst quenched
"healthy" : -2,             // Health effects (used for sickness chances)
"addiction_potential" : 80, // Default strength for this item to cause addictions
"addiction_type" : [ "crack", { "addiction": "cocaine", "potential": 5 } ], // Addiction types (if no potential is given, the "addiction_potential" field is used to determine the strength of that addiction)
"monotony_penalty" : 0,     // (Optional, default: 2 or 0 depending on material) Fun is reduced by this number for each one you've consumed in the last 48 hours.
                            // Comestibles with any material of junk food (id: "junk") default to 0. All other comestibles default to 2 when unspecified.
                            // Can't drop fun below 0, unless the comestible also has the "NEGATIVE_MONOTONY_OK" flag.
"calories" : 0,             // Hunger satisfied (in kcal)
"nutrition" : 0,            // Hunger satisfied (OBSOLETE)
"tool" : "apparatus",       // Tool required to be eaten/drank
"charges" : 4,              // Number of uses when spawned
"stack_size" : 8,           // (Optional) How many uses are in the above-defined volume. If omitted, is the same as 'charges'
"fun" : 50                  // Morale effects when used
"freezing_point": 32,       // (Optional) Temperature in C at which item freezes, default is water (32F/0C)
"cooks_like": "meat_cooked",         // (Optional) If the item is used in a recipe, replaces it with its cooks_like
"parasites": 10,            // (Optional) one_in(x) chance of becoming parasitized when eating
"contamination": [ { "disease": "bad_food", "probability": 5 } ],         // (Optional) List of diseases carried by this comestible and their associated probability. Values must be in the [0, 100] range.
"vitamins": [ [ "calcium", "60 mg" ], [ "iron", 12 ] ],         // Vitamins provided by consuming a charge (portion) of this.  Some vitamins ("calcium", "iron", "vitC") can be specified with the weight of the vitamins in that food.  Vitamins specified by weight can be in grams ("g"), milligrams ("mg") or micrograms ("μg", "ug", "mcg").  If a vitamin is not specified by weight, it is specified in "units", with meaning according to the vitamin definition.  Nutrition vitamins ("calcium", "iron", "vitC") are an integer percentage of ideal daily value average.  Vitamins array keys include the following: calcium, iron, vitC, mutant_toxin, bad_food, blood, and redcells.
"material": [                     // All materials (IDs) this food is made of
  { "type": "flesh", "portion": 3 }, // See Generic Item attributes for type and portion details
  { "type": "wheat", "portion": 5 }
],
"primary_material": "meat",       // What the primary material ID is. Materials determine specific heat.
"rot_spawn": {                    // Defines what creature would be spawned when this item rots away. Primarily used for eggs
  "group": "GROUP_EGG_CHICKEN",   // id of monster group that would be spawned. Cannot be used with "monster"
  "monster": "mon_moose_calf",    // id of a monster that would be spawned. Cannot be used with "group"
  "amount": 2,                    // if "monster" is used, defines how many instances of this monster will be spawned; 
  "amount": [ 1, 3 ],             // also can be an array, then the game will roll the number between two values
  "chance": 70                    // chance for the monster to spawn from a single item
}
"smoking_result": "dry_meat",     // Food that results from drying this food in a smoker
"petfood": [ "FUNGALFRUIT", "MIGOFOOD" ] // (Optional) Pet food categories this item is in.

Containers

Any Item can be a container. To add the ability to contain things to an item, you need to add pocket_data. The below example is a typical container (shown with optional default values, or mandatory if the value is mandatory)

"pocket_data": [
  {
    "pocket_type": "CONTAINER",       // Typical container pocket. Pockets can also be MAGAZINE.
    "max_contains_volume": mandatory, // Maximum volume this pocket can hold, totaled among all contained items.  For example "2 L" or "2000 ml" would hold two liters of items.
    "max_contains_weight": mandatory, // Maximum weight this pocket can hold, totaled among all container items.  For example "6 kg" is about enough to contain a bowling ball.
    "min_item_volume": "0 ml",        // Minimum volume of item that can be placed into this pocket.  Items smaller than this cannot be placed in the pocket.
    "max_item_volume": "0 ml",        // Maximum volume of item that can fit through the opening into this pocket.  For example, a 2-liter bottle has a "17 ml" opening.
    "max_item_length": "0 mm",        // Maximum length of items that can fit in this pocket, by their longest_side.  Default is the diagonal opening length assuming volume is a cube (cube_root(vol)*square_root(2))
    "min_item_length": "0 mm",        // Minimum length of the item that can fit int this pocket
    "spoil_multiplier": 1.0,          // How putting an item in this pocket affects spoilage.  Less than 1.0 and the item will be preserved longer; 0.0 will preserve indefinitely.
    "weight_multiplier": 1.0,         // The items in this pocket magically weigh less inside than outside.  Nothing in vanilla should have a weight_multiplier.
    "volume_multiplier": 1.0,         // The items in this pocket have less volume inside than outside.  Can be used for containers that'd help in organizing specific contents, such as cardboard rolls for duct tape.
    "volume_encumber_modifier": 1,    // Default 1. How much this pocket contributes to enumbrance compared to an average item; Works same as volume_encumber_modifier from armor data, see JSON_INFO.md#armor-portion-data
    "moves": 100,                     // Indicates the number of moves it takes to remove an item from this pocket, assuming best conditions.
    "rigid": false,                   // Default false. If true, this pocket's size is fixed, and does not expand when filled.  A glass jar would be rigid, while a plastic bag is not.
    "forbidden": true,                // Default false. If true, this pocket cannot be used by players. 
    "magazine_well": "0 ml",          // Amount of space you can put items in the pocket before it starts expanding.  Only works if rigid = false.
    "watertight": false,              // Default false. If true, can contain liquid.
    "airtight": false,                // Default false. If true, can contain gas.
    "ablative": false,                // Default false. If true, this item holds a single ablative plate. Make sure to include a flag_restriction on the type of plate that can be added.
    "holster": false,                 // Default false. If true, only one stack of items can be placed inside this pocket, or one item if that item is not count_by_charges.
    "open_container": false,          // Default false. If true, the contents of this pocket will spill if this item is worn by a character or placed into another item.
    "fire_protection": false,         // Default false. If true, the pocket protects the contained items from exploding if tossed into a fire.
    "transparent": false              // Default false. If true, the pocket is transparent, as you can see items inside it afar; in the future this would be used for light also
    "extra_encumbrance": 3,           // Additional encumbrance given to character, if this pocket is used
    "ripoff": 3,                      // Default 0, as can't be ripped; Chance this pockets contents get ripped off when escaping a grab - random number between 0 and strength of the grab (20 for generic zed, for example) against random number between 0 and ten times of ripoff
    "activity_noise": {               // Define the noise generated, if you walk, and this container is not empty 
        "volume": 8,                  // How loud the noise would be
        "chance": 60                  // Chance to generate a noise per move, from 0 to 100
      }, 
    "default_magazine": "medium_battery_cell", // Define the default magazine this item would have when spawned. Can be overwritten by item group
    "ammo_restriction": { "ammotype": count }, // Restrict pocket to a given ammo type and count.  This overrides mandatory volume, weight, watertight and airtight to use the given ammo type instead.  A pocket can contain any number of unique ammo types each with different counts, and the container will only hold one type (as of now).  If this is left out, it will be empty.
    "flag_restriction": [ "FLAG1", "FLAG2" ],  // Items can only be placed into this pocket if they have a flag that matches one of these flags.
    "item_restriction": [ "item_id" ],         // Only these item IDs can be placed into this pocket. Overrides ammo and flag restrictions.
    "material_restriction": [ "material_id" ], // Only items that are mainly made of this material can enter.
	// If multiple of "flag_restriction", "material_restriction" and "item_restriction" are used simultaneously then any item that matches any of them will be accepted.

    "sealed_data": { "spoil_multiplier": 0.0 } // If a pocket has sealed_data, it will be sealed when the item spawns.  The sealed version of the pocket will override the unsealed version of the same datatype.

    "inherits_flags": true // Items in this pocket pass their flags to the parent item.
  }
]

Melee 

"id": "hatchet",       // Unique ID. Must be one continuous word, use underscores if necessary
"symbol": ";",         // ASCII character used in-game
"color": "light_gray", // ASCII character color
"name": "hatchet",     // In-game name displayed
"description": "A one-handed hatchet. Makes a great melee weapon, and is useful both for cutting wood, and for use as a hammer.", // In-game description
    "price": "95 cent",           // Used when bartering with NPCs.  Can use string "cent" "USD" or "kUSD".
"material": [          // Material types.  See materials.json for possible options
  { "type": "iron", "portion": 2 }, // See Generic Item attributes for type and portion details
  { "type": "wood", "portion": 3 }
],
"weight": 907,         // Weight, measured in grams
"volume": "1500 ml",   // Volume, volume in ml and L can be used - "50 ml" or "2 L"
"melee_damage": {      // Damage caused by using it as a melee weapon
  "bash": 12,
  "cut": 12
},
"flags" : ["CHOP"],    // Indicates special effects
"to_hit" {             // (Optional) To hit bonus values, omit if item isn't suited to be used as a melee weapon, see [GAME_BALANCE.md](/GAME_BALANCE.html#to-hit-value) for individual value breakdowns.
  "grip": "solid",                           
  "length": "long",                          
  "surface": "point",                        
  "balance": "neutral"                       
}

Memory Cards

Memory card information can be defined on any GENERIC item by adding an object named memory_card, this field does not support extend/remove, only override.

"id": "memory_card_unread",
"name": "memory card (unread)",
// ...
"memory_card": {
  "data_chance": 0.5,                  // 50% chance to contain data
  "on_read_convert_to": "memory_card", // converted to this itype_id on read
  "photos_chance": 0.33,               // 33% chance to contain new photos
  "photos_amount": 3,                  // contains between 1 and 3 new photos
  "songs_chance": 0.33,                // 33% chance to contain new songs
  "songs_amount": 4,                   // contains between 1 and 4 new songs
  "recipes_chance": 0.33,              // 33% chance to contain new recipes
  "recipes_amount": 5,                 // contains between 1 and 5 new recipes
  "recipes_level_min": 4,              // recipes will have at least level 4
  "recipes_level_max": 8,              // recipes will have at most level 8
  "recipes_categories": [ "CC_FOOD" ], // (Optional) Array, defaults `CC_FOOD`. Memory card can contain recipes from any of these categories.
  "secret_recipes": true               // (Optional) Boolean, default false. If true, can contain recipes with the `SECRET` flag.
}

Gun

Guns can be defined like this:

"type": "GUN",             // Defines this as a GUN
...                        // same entries as above for the generic item.
                           // additional some gun specific entries:
"skill": "pistol",         // Skill used for firing
"ammo": [ "357", "38" ],   // Ammo types accepted for reloading
"ranged_damage": 0,        // Ranged damage when fired
"range": 0,                // Range when fired
"dispersion": 32,          // Inaccuracy of gun, measured in 100ths of Minutes Of Angle (MOA)
// When sight_dispersion and aim_speed are present in a gun mod, the aiming system picks the "best"
// sight to use for each aim action, which is the fastest sight with a dispersion under the current
// aim threshold.
"min_strength": 8,         // Minimal strength required to use this gun. Mostly used in different bows
"sight_dispersion": 10,    // Inaccuracy of gun derived from the sight mechanism, measured in 100ths of Minutes Of Angle (MOA)
"recoil": 0,               // Recoil caused when firing, measured in 100ths of Minutes Of Angle (MOA)
"durability": 8,           // Resistance to damage/rusting, also determines misfire chance
"gun_jam_mult": 1.25       // Multiplier for gun mechanincal malfunctioning, mostly when it's damaged; Values lesser than 1 reflect better quality of the gun, that jam less; bigger than 1 result in gun being more prone to malfunction and jam at lesser damage level; zero gun_jam_mult (and zero mag_jam_mult if magazine is presented) would remove any chance for a gun to malfunction. Only apply if gun has any fault from gun_mechanical_simple group presented; Jam chances are described in Character::handle_gun_damage(); at this moment it is roughly: 0.05% for undamaged gun, 3% for 1 damage (|\), 15% for 2 damage (|.), 45% for 3 damage (\.), and 80% for 4 damage (XX), then this and magazine values are summed up
"blackpowder_tolerance": 8,// One in X chance to get clogged up (per shot) when firing blackpowder ammunition (higher is better). Optional, default is 8.
"min_cycle_recoil": 0,     // Minimum ammo recoil for the gun to be able to fire more than once per attack (to cycle), else shooting it results in a cycling failure. Set at 90% of the base ammo recoil, or 75% of the value if the weapon is known to cycle with blackpowder. This is to prevent the weapon from cycling with any kind of ammo
"clip_size": 100,          // Maximum amount of ammo that can be loaded
"faults": [ "fault_gun_dirt", "fault_gun_chamber_spent" ], // Type of faults, that can be applied to this gun; usually are inherited from single abstract like rifle_base, but exceptions exist
"handling": 10             // handling of the weapon; better handling means less recoil
"energy_drain": "2 kJ",    // Additionally to the normal ammo (if any), a gun can require some electric energy. Drains from battery in gun. Use flags "USE_UPS" and "USES_BIONIC_POWER" to drain other sources. This also works on mods. Attaching a mod with energy_drain will add/increase drain on the weapon.
"heat_per_shot": 10,       // Each shot from this weapon adds this amount of heat
"cooling_value": 3,        // Amount of heat value, that is reduced every turn
"overheat_threshold": 100, // Heat value, at which fault may occur, see #Item faults; values below zero mean item won't be able to fault
"ammo_to_fire" 1,          // Amount of ammo used
"modes": [ [ "DEFAULT", "semi-auto", 1 ], [ "AUTO", "auto", 4 ] ], // Firing modes on this gun, DEFAULT,AUTO, or MELEE followed by the name of the mode displayed in game, and finally the number of shots of the mod.
"reload": 450,             // Amount of time to reload, 100 = 1 second = 1 "turn"
"reload_noise": "Ping!",   // Sound, that would be produced, when the gun is reloaded; seems to not work
"reload_noise_volume": 4,  // how loud the reloading is
"built_in_mods": ["m203"], //An array of mods that will be integrated in the weapon using the IRREMOVABLE tag.
"default_mods": ["m203"]   //An array of mods that will be added to a weapon on spawn.
"barrel_volume": "30 mL",  // Amount of volume lost when the barrel is sawn. Approximately 250 ml per inch is a decent approximation.
"valid_mod_locations": [ [ "brass catcher", 1 ], [ "grip", 1 ] ],  // The valid locations for gunmods and the mount of slots for that location.
"loudness": 10             // Amount of noise produced by this gun when firing. If no value is defined, then it's calculated based on loudness value from loaded ammo. Final loudness is calculated as gun loudness + gunmod loudness + ammo loudness. If final loudness is 0, then the gun is completely silent.

Alternately, every item (book, tool, armor, even food) can be used as gun if it has gun_data:

"type": "TOOL",      // Or any other item type
...                   // same entries as for the type (e.g. same entries as for any tool),
"gun_data" : {        // additionally the same gun data like above
    "skill": ...,
    "recoil": ...,
    ...
}

Gunmod

Gun mods can be defined like this:

"type": "GUNMOD",              // Defines this as a GUNMOD
...                            // Same entries as above for the generic item.
                               // Additionally some gunmod specific entries:
// Only GUNMOD type items may define the following fields:
"location": "stock",           // Mandatory. Where is this gunmod is installed?
"mod_targets": [ "crossbow" ], // Mandatory. What kind of weapons can this gunmod be used with?
"install_time": "30 s",        // Mandatory. How long does installation take? An integer will be read as moves or a time string can be used.
"acceptable_ammo": [ "9mm" ],  // Optional filter restricting mod to guns with those base (before modifiers) ammo types
"ammo_modifier": [ "57" ],     // Optional field which if specified modifies parent gun to use these ammo types
"magazine_adaptor": [ [ "223", [ "stanag30" ] ] ], // Optional field which changes the types of magazines the parent gun accepts
"pocket_mods": [ { "pocket_type": "MAGAZINE_WELL", "item_restriction": [ "ai_338mag", "ai_338mag_10" ] } ], // Optional field, alters the original pockets of the weapon ; share the syntax with pocket_data; pocket type MAGAZINE and MAGAZINE_WELL are always overwritten, pocket type CONTAINER is always added to existing pockets; for MAGAZINE and MAGAZINE_WELL both ammo_modifier and magazine_adaptor fields are required to correctly migrate ammo type; type: TOOLMOD can use this field also
"damage_modifier": { "damage_type": "bullet", "amount": -1 }, // Optional field increasing or decreasing base gun damage
"dispersion_modifier": 15,     // Optional field increasing or decreasing base gun dispersion
"loudness_modifier": 4,        // Optional field increasing or decreasing base guns loudness
"loudness_multiplier": 0.5     // Optional field increasing or decreasing base guns loudness as multiplier. 0.5 would halve the gun loudness, 2 would double it
"range_modifier": 2,           // Optional field increasing or decreasing base gun range
"range_multiplier": 1.2,       // Optional field multiplying base gun range
"integral_longest_side": "5 cm", // Length that would be added to a gun when this mod is installed
"overwrite_min_cycle_recoil": 1350, // Using this field will overwrite gun's min_cycle_recoil
"reload_noise": "chuk chuk.",   // Message, that would be produced when you reload a gun with this mod; Seems to not work 
"reload_noise_volume": 2,       // Amount of noise produced, when you reload a gun with this mod
"aim_speed_modifier": -2,       // Changes how fast you aim a gun with this mod
"add_mod": [ [ "grip", 1 ], [ "sights", 1 ] ], // adds this amoutn of gunmods to gun, if this gunmod is installed
"energy_drain_multiplier": 1.2, // if weapon uses `energy_drain`, multiplies it on this amount
"field_of_view": 270,           // #53180 has an image of it, but it represent how big FoV of the scope - when characters start to aim, it doesn't use the scope whatsoever, aiming into "general direction", and then transfer to using scope to pinpoint the target. The bigger FoV is, the sooner character would be able to use the scope (target acquisition with higher power scopes is very very difficult); put simple: the bigger FoV, the faster player can aim, to some degree; measured in MOA (minutes of angle)
"min_skills": [ [ "weapon", 3 ], [ "gun", 4 ] ], // minimal skill level required to install this gunmod
"shot_spread_multiplier_modifier": -0.8, // For shotguns, changes the spread of the pellets. Given a default multiplier of 1.0(100%), a multiplier modifier of -0.8 results in 0.2(20%) shot spread. Multipliers from all mods are summed up, but in vanilla game, only choke should be able to manipulate with shot spread - **shotgun barrel length doesn't affect pellet spread**
"energy_drain_modifier": "200 kJ",  // Optional field increasing or decreasing base gun energy consumption (per shot) by adding given value. This addition is not multiplied by energy_drains_multiplier.
"energy_drains_multiplier": 2.5, // Optional field increasing or decreasing base gun energy consumption (per shot) by multiplying by given value.
"reload_modifier": -10,        // Optional field increasing or decreasing base gun reload time in percent
"min_str_required_mod": 14,    // Optional field increasing or decreasing minimum strength required to use gun
"aim_speed": 3,                // A measure of how quickly the player can aim, in moves per point of dispersion.
"ammo_effects": [ "BEANBAG" ], // List of IDs of ammo_effect types
"consume_chance": 5000,        // Odds against CONSUMABLE mod being destroyed when gun is fired (default 1 in 10000)
"consume_divisor": 10,         // Divide damage against mod by this amount (default 1)
"handling_modifier": 4,        // Improve gun handling. For example a forward grip might have 6, a bipod 18
"mode_modifier": [ [ "AUTO", "auto", 4 ] ], // Modify firing modes of the gun, to give AUTO or REACH for example
"barrel_length": "45 mm"       // Specify a direct barrel length for this gun mod. If used only the first mod with a barrel length will be counted
"overheat_threshold_modifier": 100,   // Add a flat amount to gun's "overheat_threshold"; if the threshold is 100, and the modifier is 10, the result is 110; if the modifier is -25, the result is 75
"overheat_threshold_multiplier": 1.5, // Multiply gun's "overheat_threshold" by this number; if the threshold is 100, and the multiplier is 1.5, the result is 150; if the multiplier is 0.8, the result is 80
"cooling_value_modifier": 2,          // Add a flat amount to gun's "cooling_value"; works the same as overheat_threshold_modifier
"cooling_value_multiplier": 0.5,      // Multiply gun's "cooling_value" by this number; works the same as overheat_threshold_multiplier
"heat_per_shot_modifier":  -2,        //  Add a flat amount to gun's "heat_per_shot"; works the same as overheat_threshold_modifier
"heat_per_shot_multiplier": 2.0,      // Multiply the gun's "heat_per_shot" by this number; works the same as overheat_threshold_multiplier
"is_bayonet": true,     // Optional, if true, the melee damage of this item is added to the base damage of the gun. Defaults to false.
"blacklist_slot": [ "rail", "underbarrel" ],      // prevents installation of the gunmod if the specified slot(s) are present on the gun.
"blacklist_mod": [ "m203", "m320" ],      // prevents installation of the gunmod if the specified mods(s) are present on the gun.

Alternately, every item (book, tool, armor, even food) can be used as a gunmod if it has gunmod_data:

"type": "TOOL",       // Or any other item type
...                   // same entries as for the type (e.g. same entries as for any tool),
"gunmod_data" : {
    "location": ...,
    "mod_targets": ...,
    ...
}

Batteries 

"type": "BATTERY",    // Defines this as a BATTERY
...                   // Same entries as above for the generic item
                      // Additionally some battery specific entries:
"max_energy": "30 kJ" // Mandatory. Maximum energy quantity the battery can hold

Tools 

"id": "torch_lit",    // Unique ID. Must be one continuous word, use underscores if necessary
"type": "TOOL",       // Defines this as a TOOL
"symbol": "/",        // ASCII character used in-game
"color": "brown",     // ASCII character color
"name": "torch (lit)", // In-game name displayed
"description": "A large stick, wrapped in gasoline soaked rags. This is burning, producing plenty of light", // In-game description
    "price": "0 cent",           // Used when bartering with NPCs.  Can use string "cent" "USD" or "kUSD".
"material": [ { "type": "wood", "portion": 1 } ], // Material types.  See materials.json for possible options. Also see Generic Item attributes for type and portion details
"techniques": [ "FLAMING" ], // Combat techniques used by this tool
"flags": [ "FIRE" ],      // Indicates special effects
"weight": 831,        // Weight, measured in grams
"volume": "1500 ml",  // Volume, volume in ml and L can be used - "50 ml" or "2 L"
"melee_damage": {     // Damage caused by using it as a melee weapon
  "bash": 12,
  "cut": 0
},
"to_hit" {             // (Optional) To hit bonus values, omit if item isn't suited to be used as a melee weapon, see [GAME_BALANCE.md](/GAME_BALANCE.html#to-hit-value) for individual value breakdowns.
  "grip": "solid",                           
  "length": "long",                          
  "surface": "point",                        
  "balance": "neutral"                       
}
"turns_per_charge": 20, // Charges consumed over time, deprecated in favor of power_draw
"fuel_efficiency": 0.2, // When combined with being a UPS this item will burn fuel for its given energy value to produce energy with the efficiency provided. Needs to be > 0 for this to work
"use_action": [ "firestarter" ], // Action performed when tool is used, see special definition below
"qualities": [ [ "SCREW", 1 ] ], // Inherent item qualities like hammering, sawing, screwing (see tool_qualities.json)
"charged_qualities": [ [ "DRILL", 3 ] ], // Qualities available if tool has at least charges_per_use charges left
// Only TOOL type items may define the following fields:
"ammo": [ "NULL" ],        // Ammo types used for reloading
"charge_factor": 5,        // this tool uses charge_factor charges for every charge required in a recipe; intended for tools that have a "sub" field but use a different ammo that the original tool
"charges_per_use": 1,      // Charges consumed per tool use
"initial_charges": 75,     // Charges when spawned
"max_charges": 75,         // Maximum charges tool can hold
"rand_charges": [10, 15, 25], // Randomize the charges when spawned. This example has a 50% chance of rng(10, 15) charges and a 50% chance of rng(15, 25). (The endpoints are included.)
"power_draw": "50 mW",          // Energy consumption per second
"revert_to": "torch_done", // Transforms into item when charges are expended
"revert_msg": "The torch fades out.", // Message, that would be printed, when revert_to is used
"sub": "hotplate",         // optional; this tool has the same functions as another tool
"variables": {
  "vehicle_name": "Wheelchair",         // this tool is a foldable vehicle, that could bypass the default foldability rules; this is the name of the vehicle that would be unfolded 
  "folded_parts": "folded_parts_syntax" // this is the parts that this vehice has -it uses it's own syntax, different from `"type": "vehicle"`, so better to read the examples in `unfoldable.json`
}

Seed Data

Every item type can have optional seed data, if the item has seed data, it’s considered a seed and can be planted:

"seed_data" : {
    "fruit": "weed", // The item id of the fruits that this seed will produce.
    "seeds": false, // (optional, default is true). If true, harvesting the plant will spawn seeds (the same type as the item used to plant). If false only the fruits are spawned, no seeds.
    "fruit_div": 2, // (optional, default is 1). Final amount of fruit charges produced is divided by this number. Works only if fruit item is counted by charges.
    "byproducts": ["withered", "straw_pile"], // A list of further items that should spawn upon harvest.
    "plant_name": "sunflower", // The name of the plant that grows from this seed. This is only used as information displayed to the user.
    "grow" : 91, // A time duration: how long it takes for a plant to fully mature. Based around a 91 day season length (roughly a real world season) to give better accuracy for longer season lengths
                // Note that growing time is later converted based upon the season_length option, basing it around 91 is just for accuracy purposes
                // A value 91 means 3 full seasons, a value of 30 would mean 1 season.
    "required_terrain_flag": "PLANTABLE" // A tag that terrain and furniture would need to have in order for the seed to be plantable there.
					 // Default is "PLANTABLE", and using this will cause any terain the plant is wrown on to turn into dirt once the plant is planted, unless furniture is used.
					 // Using any other tag will not turn the terrain into dirt.
}

Brewing Data

Every item type can have optional brewing data, if the item has brewing data, it can be placed in a vat and will ferment into a different item type.

Currently only vats can only accept and produce liquid items.

"brewable" : {
    "time": 3600, // A time duration: how long the fermentation will take.
    "results": { "beer": 1, "yeast": 10 } // Ids with a multiplier for the amount of results per charge of the brewable items.
}

Effects_carried

(optional, default: empty list)

Effects of the artifact when it’s in the inventory (main inventory, wielded, or worn) of the player.

Possible values (see src/enums.h for an up-to-date list):

  • AEP_STR_UP Strength + 4
  • AEP_DEX_UP Dexterity + 4
  • AEP_PER_UP Perception + 4
  • AEP_INT_UP Intelligence + 4
  • AEP_ALL_UP All stats + 2
  • AEP_SPEED_UP +20 speed
  • AEP_IODINE Reduces radiation
  • AEP_SNAKES Summons friendly snakes when you’re hit
  • AEP_INVISIBLE Makes you invisible
  • AEP_CLAIRVOYANCE See through walls
  • AEP_SUPER_CLAIRVOYANCE See through walls to a great distance
  • AEP_STEALTH Your steps are quieted
  • AEP_EXTINGUISH May extinguish nearby flames
  • AEP_GLOW Four-tile light source
  • AEP_PSYSHIELD Protection from fear paralyze attack
  • AEP_RESIST_ELECTRICITY Protection from electricity
  • AEP_CARRY_MORE Increases carrying capacity by 200
  • AEP_SAP_LIFE Killing non-zombie monsters may heal you
  • AEP_HUNGER Increases hunger
  • AEP_THIRST Increases thirst
  • AEP_SMOKE Emits smoke occasionally
  • AEP_EVIL Addiction to the power
  • AEP_SCHIZO Mimicks schizophrenia
  • AEP_RADIOACTIVE Increases your radiation
  • AEP_MUTAGENIC Mutates you slowly
  • AEP_ATTENTION Draws netherworld attention slowly
  • AEP_STR_DOWN Strength - 3
  • AEP_DEX_DOWN Dex - 3
  • AEP_PER_DOWN Per - 3
  • AEP_INT_DOWN Int - 3
  • AEP_ALL_DOWN All stats - 2
  • AEP_SPEED_DOWN -20 speed
  • AEP_FORCE_TELEPORT Occasionally force a teleport
  • AEP_MOVEMENT_NOISE Makes noise when you move
  • AEP_BAD_WEATHER More likely to experience bad weather
  • AEP_SICK Decreases health over time

effects_worn

(optional, default: empty list)

Effects of the artifact when it’s worn (it must be an armor item to be worn).

Possible values are the same as for effects_carried.

effects_wielded

(optional, default: empty list)

Effects of the artifact when it’s wielded.

Possible values are the same as for effects_carried.

effects_activated

(optional, default: empty list)

Effects of the artifact when it’s activated (which require it to have a "use_action": [ "ARTIFACT" ] and it must have a non-zero max_charges value).

Possible values (see src/artifact.h for an up-to-date list):

  • AEA_STORM Emits shock fields
  • AEA_FIREBALL Targeted
  • AEA_ADRENALINE Adrenaline rush
  • AEA_MAP Maps the area around you
  • AEA_BLOOD Shoots blood all over
  • AEA_SLEEPINESS Creates interdimensional sleepiness
  • AEA_ACIDBALL Targeted acid
  • AEA_PULSE Destroys adjacent terrain
  • AEA_HEAL Heals minor damage
  • AEA_CONFUSED Confuses all monsters in view
  • AEA_ENTRANCE Chance to make nearby monsters friendly
  • AEA_BUGS Chance to summon friendly insects
  • AEA_TELEPORT Teleports you
  • AEA_LIGHT Temporary light source
  • AEA_GROWTH Grow plants, a la triffid queen
  • AEA_HURTALL Hurts all monsters!
  • AEA_FUN Temporary morale bonus
  • AEA_SPLIT Split between good and bad
  • AEA_RADIATION Spew radioactive gas
  • AEA_PAIN Increases player pain
  • AEA_MUTATE Chance of mutation
  • AEA_PARALYZE You lose several turns
  • AEA_FIRESTORM Spreads minor fire all around you
  • AEA_ATTENTION Attention from sub-prime denizens
  • AEA_TELEGLOW Teleglow disease
  • AEA_NOISE Loud noise
  • AEA_SCREAM Noise & morale penalty
  • AEA_DIM Darkens the sky slowly
  • AEA_FLASH Flashbang
  • AEA_VOMIT User vomits
  • AEA_SHADOWS Summon shadow creatures
  • AEA_STAMINA_EMPTY Empties most of the player’s stamina gauge

Software Data

Every item type can have software data, it does not have any behavior:

"software_data" : {
    "type": "USELESS", // unused
    "power" : 91 // unused
}

Use Actions

The contents of use_action fields can either be a string indicating a built-in function to call when the item is activated (defined in iuse.cpp), or one of several special definitions that invoke a more structured function.

"use_action": {
  "type": "transform",                      // The type of method, in this case one that transforms the item
  "target": "gasoline_lantern_on",          // The item to transform to
  "target_group": "twisted_geometry",       // If used, target is a random item from itemgroup
  "variant_type": "condom_plain",           // (optional) Defaults to `<any>`. Specific variant type to set for the transformed item. Special string `<any>` will pick a random variant from all available variants, based on the variant's defined weight
  "active": true,                           // Whether the item is active once transformed
  "ammo_scale": 0,                          // For use when an item automatically transforms into another when its ammo drops to 0, or to allow guns to transform with 0 ammo
  "msg": "You turn the lamp on.",           // Message to display when activated
  "need_fire": 1,                           // Whether fire is needed to activate
  "need_fire_msg": "You need a lighter!",   // Message to display if there is no fire
  "need_charges": 1,                        // Number of charges the item needs to transform
  "need_charges_msg": "The lamp is empty.", // Message to display if there aren't enough charges
  "need_empty": true,                       // Whether the item must be empty to be transformed; false by default
  "need_worn": true,                        // Whether the item must be worn to be transformed, cast spells, or use EOCs; false by default
  "need_wielding": true,                    // Whether the item must be wielded to be transformed, cast spells, or use EOCs; false by default
  "qualities_needed": { "WRENCH_FINE": 1 }, // Tool qualities needed, e.g. "fine bolt turning 1"
  "target_charges": 3,                      // Number of charges the transformed item has
  "rand_target_charges": [ 10, 15, 25 ],    // Randomize the charges the transformed item has. This example has a 50% chance of rng(10, 15) charges and a 50% chance of rng(15, 25) (endpoints are included)
  "ammo_qty": 3,                            // If zero or positive set remaining ammo of transformed item to this
  "random_ammo_qty": [ 1, 5 ],              // If this has values, set remaining ammo of transformed item to one of them chosen at random
  "ammo_type": "tape",                      // If both this and ammo_qty are specified then set transformed item to this specific ammo
  "container": "jar",                       // Container holding the target item
  "sealed": true,                           // Whether the transformed container is sealed; true by default
  "menu_text": "Lower visor",               // (optional) Text displayed in the activation screen. Defaults to "Turn on"
  "moves": 500                              // Moves required to transform the item in excess of a normal action
},
"use_action": {
  "type": "explosion",               // An item that explodes when it runs out of charges
  "explosion": {                     // (optional) Physical explosion data
                                     // Specified like `"explosion"` field in generic items
  },
  "draw_explosion_radius": 5,        // How large to draw the radius of the explosion
  "draw_explosion_color": "blue",    // The color to use when drawing the explosion
  "do_flashbang": true,              // Whether to do the flashbang effect
  "flashbang_player_immune": true,   // Whether the player is immune to the flashbang effect
  "fields_radius": 3,                // The radius of spread for fields produced
  "fields_type": "fd_tear_gas",      // The type of fields produced
  "fields_min_intensity": 3,         // Minimum intensity of field generated by the explosion
  "fields_max_intensity": 3,         // Maximum intensity of field generated by the explosion
  "emp_blast_radius": 4,             // The radius of EMP blast created by the explosion
  "scrambler_blast_radius": 4        // The radius of scrambler blast created by the explosion
},
"use_action": {
  "type": "change_scent",              // Change the scent type of the user
  "scent_typeid": "sc_fetid",          // The scenttype_id of the new scent
  "charges_to_use": 2,                 // Charges consumed when the item is used. Default is 1
  "scent_mod": 150,                    // Modifier added to the scent intensity. Default is 0
  "duration": "6 m",                   // How long does the effect last
  "effects": [ { "id": "fetid_goop", "duration": 360, "bp": "torso", "permanent": true } ],  // List of effects with their ID, duration, bodyparts, and permanent bool
  "waterproof": true,                  // Is the effect waterproof. (Default: false)
  "moves": 500                         // Number of moves required in the process
},
"use_action": {
  "type": "consume_drug",                 // A drug the player can consume
  "activation_message": "You smoke your crack rocks.  Mother would be proud.", // Message, ayup
  "effects": { "high": 15 },              // Effects and their duration
  "damage_over_time": [
    {
      "damage_type": "pure",              // Type of damage
      "duration": "1 m",                  // For how long this damage will be applied
      "amount": -10,                      // Amount of damage applied every turn, negative damage heals
      "bodyparts": [ "torso", "head", "arm_l", "leg_l", "arm_r", "leg_r" ] // Body parts hit by the damage
    }
  ]
  "stat_adjustments": { "hunger": -10 },   // Adjustment to make to player stats
  "fields_produced": { "cracksmoke": 2 },  // Fields to produce, mostly used for smoke
  "charges_needed": { "fire": 1 },         // Charges to use in the process of consuming the drug
  "tools_needed": { "apparatus": -1 },     // Tool needed to use the drug
  "moves": 50,                             // Number of moves required in the process, default value is 100
  "vitamins": [                            // What and how much vitamin is given by this drug
    [ "mutagen_alpha", 225 ],
    [ "mutagen", 125 ]
  ] 
},
"use_action": {
  "type": "place_monster",          // Place a turret / manhack / whatever monster on the map
  "monster_id": "mon_manhack",      // Monster ID, see monsters.json
  "difficulty": 4,                  // Difficulty for programming it (manhacks have 4, turrets 6, etc.)
  "hostile_msg": "It's hostile!",   // (optional) Message when programming the monster failed and it's hostile
  "friendly_msg": "Good!",          // (optional) Message when the monster is programmed properly and it's friendly
  "place_randomly": true,           // Places the monster randomly around the player or lets the player decide where to put it (default: false)
  "skills": [ "unarmed", "throw" ], // (optional) Array of skill IDs. Higher skill level means more likely to place a friendly monster
  "moves": 60,                      // How many move points the action takes
  "is_pet": false                   // Specifies if the spawned monster is a pet. The monster will only spawn as a pet if it is spawned as friendly, hostile monsters will never be pets
},
"use_action": {
  "type": "place_npc",                     // Place NPC of specific class on the map
  "npc_class_id": "true_foodperson",       // NPC ID, see npcs/npc.json
  "summon_msg": "You summon a food hero!", // (optional) Message when summoning the NPC
  "place_randomly": true,                  // Places NPC randomly around the player or lets the player decide where to put it (default: false)
  "radius": 1,                             // Maximum radius for random NPC placement
  "moves": 50                              // How many move points the action takes
},
"use_action": {
  "type": "link_up",       // Connect item to a vehicle or appliance, such as plugging a chargeable device into a power source
                           // If the item has the CABLE_SPOOL flag, it has special behaviors available, like connecting vehicles together
  "cable_length": 4,       // (optional) Maximum length of the cable. Defaults to the item type's maximum charges
                           // If extended by other cables, will use the sum of all cables' lengths
  "charge_rate": "60 W",   // (optional) The charge rate of the plugged-in device's batteries in watts. Defaults to "0 W"
                           // A positive value will charge the device's chargeable batteries at the expense of the connected power grid
                           // A negative value will charge the connected electrical grid's batteries at the expense of the device's
                           // A value of 0 won't charge the device's batteries, but will still let the device operate off of the connected power grid
  "efficiency": 0.85f,     // (optional) This out of 1.0 chance to successfully add 1 charge every charge interval. Defaults to 0.85f, AKA 85% efficiency
                           // A value less than 0.001 means the cable won't transfer any electricity at all
                           // If extended by other cables, will use the product of all cable's efficiencies multiplied together
  "menu_text":             // (optional) Text displayed in the activation screen. Defaults to Plug in / Manage cables
  "move_cost": 50          // (optional) Move cost of attaching the cable. Defaults to 5
  "targets": [             // (optional) Array of link_states that are valid connection points of the cable. Defaults to only allowing disconnection
    "no_link",             // Must be included to allow letting the player manually disconnect the cable
    "vehicle_port",        // Can connect to a vehicle's cable ports / electrical controls or an appliance
    "vehicle_battery",     // Can connect to a vehicle's battery or an appliance
    "vehicle_tow",         // Can be used as a tow cable between two vehicles
    "bio_cable",           // Can connect to a cable system bionic
    "ups",                 // Can link to a UPS
    "solarpack"            // Can link to a worn solar pack
  ],
  "can_extend": [          // (optional) Array of cable items that can be extended by this one. Defaults to none
    "extension_cable",
    "long_extension_cable",
    "ELECTRICAL_DEVICES"   // "ELECTRICAL_DEVICES" is a special keyword that lets this cable extend all electrical devices that have link_up actions
  ]
},
"use_action": {
  "type": "deploy_furn",
  "furn_type": "f_foo"          // What furniture this item will be transmuted into
},
"use_action": {
  "type": "deploy_appliance",
  "base": "item_id"             // Base item of the appliance this item will turn into
},
"use_action": {
  "type": "delayed_transform",  // Like transform, but it will only transform when the item has a certain age
  "transform_age": 600,         // The minimal age of the item. Items that are younger won't transform. In turns (60 turns = 1 minute)
  "not_ready_msg": "The yeast has not been done The yeast isn't done culturing yet." // A message, shown when the item is not old enough
},
"use_action": {
  "type": "firestarter",  // Start a fire, like with a lighter.
  "moves": 15,            // Number of moves it takes to start the fire. This is reduced by survival skill
  "moves_slow": 1500,     // Number of moves it takes to start a fire on something that is difficult to ignite. This is reduced by survival skill
  "need_sunlight": true   // Whether the character needs to be in direct sunlight, e.g. to use magnifying glasses
},
"use_action": {
  "type": "unpack",                 // Unpack this item
  "group": "gobag_contents",        // Item group this unpacks into
  "items_fit": true,                // Do the armor items in this fit? Defaults to false
  "filthy_volume_threshold": "10 L" // If the items unpacked from this item have volume, and this item is filthy, at what amount of held volume should they become filthy
},
"use_action": {
  "type": "salvage",       // Try to salvage base materials from an item, e.g. cutting up cloth to get rags or leather
  "moves_per_part": 25,    // (optional) Number of moves it takes
  "material_whitelist": [  // List of material IDs (not item IDs!) that can be salvage from
    "cotton",              // The list here is the default list, used when there is no explicit martial list given
    "leather",             // If the item (that is to be cut up) has any material not in the list, it can not be cut up
    "fur",
    "wood",
    "wool"
  ]
},
"use_action": {
  "type": "inscribe",          // Inscribe a message on an item or on the ground
  "on_items": true,            // Whether the item can inscribe on an item
  "on_terrain": false,         // Whether the item can inscribe on the ground
  "material_restricted": true, // Whether the item can only inscribe on certain item materials. Not used when inscribing on the ground
  "material_whitelist": [      // List of material IDs (not item IDs!) that can be inscribed on
    "wood",                    // Only used when inscribing on an item, and only when material_restricted is true
    "plastic",                 // The list here is the default that is used when no explicit list is given.
    "glass",
    "chitin",
    "steel",
    "silver"
  ]
},
"use_action": {
  "type": "fireweapon_off",               // Activate a fire based weapon
  "target_id": "firemachete_on",          // The item type to transform this item into
  "success_message": "Your No. 9 glows!", // A message that is shows if the action succeeds
  "failure_message": "",                  // (optional) A message that is shown if the action fails, for whatever reason. If not given, no message will be printed
  "lacks_fuel_message": "Out of fuel",    // Message that is shown if the item has no charges
  "noise": 0,                             // (optional) The noise it makes to active the item. 0 means no sound at all
  "moves": 0,                             // The number of moves it takes the character to even try this action (independent of the result)
  "success_chance": 0                     // How likely it is to succeed the action. Default is to always succeed. Try numbers in the range of 0-10
},
"use_action": {
  "type": "fireweapon_on",                          // Function for active (burning) fire based weapons
  "noise_chance": 1,                                // The chance (one in X) that the item will make a noise, rolled on each turn
  "noise": 0,                                       // The sound volume it makes, if it makes a noise at all. If 0, no sound is made, but the noise message is still printed
  "noise_message": "Your No. 9 hisses.",            // The message / sound description (if noise is > 0), that appears when the item makes a sound
  "voluntary_extinguish_message": "Your No. 9 goes dark.", // Message that appears when the item is turned of by player
  "charges_extinguish_message": "Out of ammo!",     // Message that appears when the item runs out of charges
  "water_extinguish_message": "Your No. 9 hisses in the water and goes out.", // Message that appears if the character walks into water and the fire of the item is extinguished
  "auto_extinguish_chance": 0,                      // If > 0, this is the (one in X) chance that the item goes out on its own
  "auto_extinguish_message": "Your No. 9 cuts out!" // Message that appears if the item goes out on its own (only required if auto_extinguish_chance is > 0)
},
"use_action": {
  "type": "musical_instrument",   // The character plays an instrument (this item) while walking around.
  "speed_penalty": 10,            // This is subtracted from the characters speed.
  "volume": 12,                   // Volume of the sound of the instrument.
  "fun": -5,                      // Together with fun_bonus, this defines how much morale the character gets from playing the instrument. They get `fun + fun_bonus * <character-perception>` morale points out of it. Both values and the result may be negative
  "fun_bonus": 2,
  "description_frequency": 20,    // Once every Nth turn, a randomly chosen description (from the that array) is displayed
  "player_descriptions": [
    "You play a little tune on your flute.",
    "You play a beautiful piece on your flute.",
    "You play a piece on your flute that sounds harmonious with nature."
  ]
},
"use_action": {
  "type": "holster",                          // Holster or draw a weapon
  "holster_prompt": "Holster item",           // Prompt to use when selecting an item
  "holster_msg": "You holster your %s",       // Message to show when holstering an item
  "max_volume": "1500 ml",                    // Maximum volume of each item that can be holstered. Volume in ml and L can be used - "50 ml" or "2 L"
  "min_volume": "750 ml",                     // Minimum volume of each item that can be holstered or 1/3 max_volume if unspecified. Volume can be in ml or L: "50 ml" or "2 L"
  "max_weight": 2000,                         // Maximum weight of each item. If unspecified no weight limit is imposed
  "multi": 1,                                 // Total number of items that holster can contain
  "draw_cost": 10,                            // Base move cost per unit volume when wielding the contained item
  "skills": [ "pistol", "shotgun" ],          // Guns using any of these skills can be holstered
  "flags": [ "SHEATH_KNIFE", "SHEATH_SWORD" ] // Items with any of these flags set can be holstered
},
"use_action": {
  "type": "bandolier",       // Store ammo and later reload using it
  "capacity": 10,            // Total number of rounds that can be stored
  "ammo": [ "shot", "9mm" ]  // What types of ammo can be stored?
},
"use_action": {
  "type": "reveal_map",             // Reveal specific terrains on the overmap
  "radius": 180,                    // Radius around the player where things are revealed. A single overmap is 180x180 tiles
  "terrain": [ "hiway", "road" ],   // IDs of overmap terrain types that should be revealed (as many as you want)
  "message": "You add roads and tourist attractions to your map." // Displayed after the revelation
},
"use_action": {
  "type": "heal",               // Heal damage, possibly some statuses
  "limb_power": 10,             // How much hp to restore when healing limbs? Mandatory value
  "head_power": 7,              // How much hp to restore when healing head? If unset, defaults to 0.8 * limb_power
  "torso_power": 15,            // How much hp to restore when healing torso? If unset, defaults to 1.5 * limb_power
  "bleed": 4,                   // How many bleed effect intensity levels can be reduced by it. Base value
  "disinfectant_power": 4,      // Quality of disinfection. Antiseptic is 4, alcohol wipe is 2; float
  "bite": 0.95,                 // Chance to remove bite effect
  "infect": 0.1,                // Chance to remove infected effect
  "move_cost": 250,             // Cost in moves to use the item
  "limb_scaling": 1.2,          // How much extra limb hp should be healed per first aid level. Defaults to 0.25 * limb_power
  "head_scaling": 1.0,          // How much extra limb hp should be healed per first aid level. Defaults to (limb_scaling / limb_power) * head_power
  "torso_scaling": 2.0,         // How much extra limb hp should be healed per first aid level. Defaults to (limb_scaling / limb_power) * torso_power
  "effects": [                  // Effects to apply to patient on finished healing. Same syntax as in consume_drug effects
    { "id": "pkill1", "duration": 120 }
  ],
  "used_up_item": "rag_bloody"  // Item produced on successful healing. If the healing item is a tool, it is turned into the new type. Otherwise a new item is produced
},
"use_action": {
  "type": "place_trap",                // Places a trap
  "allow_underwater": false,           // (optional) Allow placing this trap when the player character is underwater
  "allow_under_player": false,         // (optional) Allow placing the trap on the same square as the player character (e.g. for benign traps)
  "needs_solid_neighbor": false,       // (optional) Trap must be placed between two solid tiles (e.g. for tripwire)
  "needs_neighbor_terrain": "t_tree",  // (optional) If non-empty: a terrain id, the trap must be placed adjacent to that terrain. Default is empty
  "outer_layer_trap": "tr_blade",      // (optional) If non-empty: a trap id, makes the game place a 3x3 field of traps. The center trap is the one defined by "trap", the 8 surrounding traps are defined by this (e.g. tr_blade for blade traps). Default is empty
  "bury_question": "",                 // (optional) If non-empty: a question that will be asked if the player character has a shoveling tool and the target location is diggable. It allows to place a buried trap. If the player answers the question (e.g. "Bury the X-trap?") with yes, the data from the "bury" object will be used.
  "bury": {                            // If the bury_question was answered with yes, data from this entry will be used instead of outer data
                                       // This json object should contain "trap", "done_message", "practice" and "moves", with the same meaning as below
  },
  "trap": "tr_engine",                             // The trap to place.
  "done_message": "Place the beartrap on the %s.", // The message that appears after the trap has been placed. %s is replaced with the terrain name of the place where the trap has been put
  "practice": 4,                                   // How much practice to the "traps" skill placing the trap gives
  "moves": 10                                      // (optional) The move points that are used by placing the trap. Default is 100
},
"use_action": {
  "type": "sew_advanced",  // Modify clothing
  "materials": [           // Materials to deal with
    "cotton",
    "leather"
  ],
  "skill": "tailor",       // Skill used
  "clothing_mods": [       // Clothing mods to deal with
    "leather_padded",
    "kevlar_padded"
  ]
},
"use_action": {
  "type": "effect_on_conditions",          // Activate effect_on_conditions
  "menu_text": "Infuse saline",            // (optional) Text displayed in the activation screen. Defaults to "Activate item"
  "description": "This debugs the game",   // Usage description
  "effect_on_conditions": [ "test_cond" ]  // IDs of the effect_on_conditions to activate
},
"use_action": {
  "type": "message",       // Displays message text
  "message": "Read this.", // Message that is shown
  "name": "Light fuse"     // (optional) Name for the action. Default "Activate"
},
"use_action": {
  "type": "sound",            // Makes sound
  "name": "Turn on",          // Optional name for the action. Default "Activate"
  "sound_message": "Bzzzz.",  // message shown to player if they are able to hear the sound. %s is replaced by item name
  "sound_id": "misc",         // ID of the audio to be played. Default "misc". See SOUNDPACKS.md for more details
  "sound_variant": "default", // Default is "default"
  "sound_volume": 5           // Loudness of the noise
},
"use_action": {
  "type": "manualnoise",              // Makes sound. Includes ammo checks and may take moves from player
  "use_message": "You do the thing",  // Shown to player who activated it
  "noise_message": "Bzzz",            // Shown if player can hear the sound. Default "hsss"
  "noise_id": "misc",                 // ID of the audio to be played. Default is "misc". See SOUNDPACKS.md for more details
  "noise_variant": "default",         // Default is "default"
  "noise": 6,                         // Loudness of the noise. Default is 0
  "moves": 40                         // How long the action takes. Default is 0
},
"use_action": {
  "type": "cast_spell",       // Casts the following spell. See MAGIC.md for more details
  "spell_id": "mana_doping",  // ID of the spell to cast
  "no_fail": true,            // If the spell is allowed to fail when casted (e.g. high difficulty may cause the cast to fail)
  "level": 1,                 // Level of the spell
  "need_worn": true,          // (optional) If the item has to be worn to cast the spell
  "need_wielding": true,      // (optional) If the item has to be wielded to cast the spell
  "mundane": true             // (optional) This spell uses magic-related features, but is not magic itself. The description is changed from "This item casts spell_name at level spell_level" to "This item when activated: spell_name"
},

Drop Actions

Similar to use_action, this drop_actions would be triggered when you throw the item

"drop_action": {                  
  "type": "emit_actor",           // allow to emit a specific field when thrown
  "emits": [ "emit_acid_drop" ],  // id of emit to spread
  "scale_qty": true               // if true, throwing more than one charge of item with emit_actor increases the size of emission
  }

Tick Actions

"tick_action" of active tools is executed once on every turn. This action can be any use action or iuse but some of them may not work properly when not executed by player.

If "tick_action" is defined as array of multiple actions they all are executed in order. Multiple use actions of same type cannot be used at once.

Delayed Item Actions

Item use actions can be used with a timer delay.

Item "transform" action can set and start the timer. This timer starts when the player activates the item.

"use_action": {
    "type": "transform"
    "target": "grenade_act",
    "target_timer": "5 seconds"  // Sets timer on item to this
}

Timer inherent to the item itself can be set by defining "countdown_interval" in item json. This timer is started at the birth of the item.

    "id": "migo_plate_undergrown",
    "name": { "str": "undergrown iridescent carapace plate" },
    "countdown_interval": "24 hours",

Once the duration of the timer has passed the "countdown_action" is executed. This action can be any use action but many actions do not behave well when they are not triggered by the player.

"countdown_action": {
    "type": "explosion",
    "explosion": { "power": 240, "shrapnel": { "casing_mass": 217, "fragment_mass": 0.08 } }
}

Additionally "revert_to" can be defined in item definitions (not in use action). The item is deactivated and turned to this type after the "countdown_action". If no revert_to is specified the item is destroyed.

json/ JSONs

Harvest 

{
    "id": "jabberwock",
    "type": "harvest",
    "leftovers": "ruined_candy",
    "message": "You messily hack apart the colossal mass of fused, rancid flesh, taking note of anything that stands out.",
    "entries": [
      { "drop": "meat_tainted", "type": "flesh", "mass_ratio": 0.33 },
      { "drop": "fat_tainted", "type": "flesh", "mass_ratio": 0.1 },
      { "drop": "jabberwock_heart", "base_num": [ 0, 1 ], "scale_num": [ 0.6, 0.9 ], "max": 3, "type": "flesh" }
    ],
},
{
  "id": "mammal_large_fur",
  "//": "drops large stomach",
  "type": "harvest",
  "entries": [
    { "drop": "meat", "type": "flesh", "mass_ratio": 0.32 },
    { "drop": "meat_scrap", "type": "flesh", "mass_ratio": 0.01 },
    { "drop": "lung", "type": "flesh", "mass_ratio": 0.0035 },
    { "drop": "liver", "type": "offal", "mass_ratio": 0.01 },
    { "drop": "brain", "type": "flesh", "mass_ratio": 0.005 },
    { "drop": "sweetbread", "type": "flesh", "mass_ratio": 0.002 },
    { "drop": "kidney", "type": "offal", "mass_ratio": 0.002 },
    { "drop": "stomach_large", "scale_num": [ 1, 1 ], "max": 1, "type": "offal" },
    { "drop": "bone", "type": "bone", "mass_ratio": 0.15 },
    { "drop": "sinew", "type": "bone", "mass_ratio": 0.00035 },
    { "drop": "fur", "type": "skin", "mass_ratio": 0.02 },
    { "drop": "fat", "type": "flesh", "mass_ratio": 0.07 }
  ]
},
{
  "id": "CBM_SCI",
  "type": "harvest",
  "entries": [
    {
      "drop": "bionics_sci",
      "type": "bionic_group",
      "flags": [ "FILTHY", "NO_STERILE", "NO_PACKED" ],
      "faults": [ "fault_bionic_salvaged" ]
    },
    { "drop": "meat_tainted", "type": "flesh", "mass_ratio": 0.25 },
    { "drop": "fat_tainted", "type": "flesh", "mass_ratio": 0.08 },
    { "drop": "bone_tainted", "type": "bone", "mass_ratio": 0.1 }
  ]
},

id

Unique id of the harvest definition.

type

Should always be harvest to mark the object as a harvest definition.

message

Optional message to be printed when a creature using the harvest definition is butchered. May be omitted from definition.

entries

Array of dictionaries defining possible items produced on butchering and their likelihood of being produced. drop value should be the id string of the item to be produced.

type value should refer to an existing harvest_drop_type associated with body part the item comes from. Acceptable values are as follows: flesh: the “meat” of the creature. offal: the “organs” of the creature. these are removed when field dressing. skin: the “skin” of the creature. this is what is ruined while quartering. bone: the “bones” of the creature. you will get some amount of these from field dressing, and the rest of them from butchering the carcass. mutagen: an item from harvested mutagenic samples obtained from dissection. mutagen_group: an item group that can produce an item from harvested mutagenic samples obtained from dissection. bionic: an item gained by dissecting the creature. not restricted to CBMs. bionic_group: an item group that will give an item by dissecting a creature. not restricted to groups containing CBMs.

flags value should be an array of strings. These flags will be added to the items of that entry upon harvesting.

faults value should be an array of fault_id strings. These faults will be added to the items of that entry upon harvesting.

For every type other then those with “dissect_only” (see below) the following entries scale the results: base_num value should be an array with two elements in which the first defines the minimum number of the corresponding item produced and the second defines the maximum number. scale_num value should be an array with two elements, increasing the minimum and maximum drop numbers respectively by element value * survival skill. max upper limit after base_num and scale_num are calculated using mass_ratio value is a multiplier of how much of the monster’s weight comprises the associated item. to conserve mass, keep between 0 and 1 combined with all drops. This overrides base_num, scale_num and max

For types with “dissect_only” (see below), the following entries can scale the results: max this value (in contrary to max for other types) corresponds to maximum butchery roll that will be passed to check_butcher_cbm() in activity_handlers.cpp; view check_butcher_cbm() to see corresponding distribution chances for roll values passed to that function

leftovers

itype_id of the item dropped as leftovers after butchery or when the monster is gibbed. Default as “ruined_chunks”.

Harvest Drop Type 

{
  "type": "harvest_drop_type",
  "id": "mutagen",
  "dissect_only": true,
  "group": false,
  "harvest_skills": [ "firstaid", "chemistry" ],
  "msg_fielddress_fail": "harvest_drop_mutagen_field_dress",
  "msg_fielddress_success": "",
  "msg_butcher_fail": "harvest_drop_mutagen_butcher",
  "msg_butcher_success": "",
  "msg_dissect_fail": "harvest_drop_mutagen_dissect_failed",
  "msg_dissect_success": ""
}

Harvest drop types are used in harvest drop entries to control how the drop is processed. dissect_only only allows the drop to be produced when dissecting. group indicates that an associated drop refers to an item group instead of a single item type.

harvest_skills refers to the id of skills that affect the yields of this harvest drop type. If omitted, this defaults to the survival skill. For example, dissecting a zomborg for CBMs will produce better results when the “electronics” and “firstaid” skills are high. harvest_skills can be either a single string (just one skill) or an array of strings.

msg_<butcher_type>_<result> refers to a snippet to be printed when the specified butcher type either succeeds or fails. Currently, the following message types are available:

  • "msg_fielddress_fail"
  • "msg_fielddress_success"
  • "msg_butcher_fail"
  • "msg_butcher_success"
  • "msg_dissect_fail"
  • "msg_dissect_success"

Weapon Category 

{
    "type": "weapon_category",
    "id": "WEAP_CAT"
    "name": "Weapon Category",
    "proficiencies": [ "prof_baz" ]
}

proficiencies is a list of proficiencies that may apply bonuses when using weapons with this category. See the proficiency documentation for more details.

Connect group definitions

Connect groups can be used by id in terrain and furniture connect_groups, connects_to and rotates_to properties.

Examples from the actual definitions:

group_flags: Flags that imply that terrain or furniture is added to this group.

connects_to_flags: Flags that imply that terrain or furniture connects to this group.

rotates_to_flags: Flags that imply that terrain or furniture rotates to this group.

[
  {
    "type": "connect_group",
    "id": "WALL",
    "group_flags": [ "WALL", "CONNECT_WITH_WALL" ],
    "connects_to_flags": [ "WALL", "CONNECT_WITH_WALL" ]
  },
  {
    "type": "connect_group",
    "id": "CHAINFENCE"
  },
  {
    "type": "connect_group",
    "id": "INDOORFLOOR",
    "group_flags": [ "INDOORS" ],
    "rotates_to_flags": [ "WINDOW", "DOOR" ]
  }
]

Furniture 

{
    "type": "furniture",
    "id": "f_toilet",
    "name": "toilet",
    "symbol": "&",
    "looks_like": "chair",
    "color": "white",
    "move_cost_mod": 2,
    "keg_capacity": 240,
    "deployed_item": "plastic_sheet",
    "light_emitted": 5,
    "required_str": 18,
    "flags": [ "TRANSPARENT", "BASHABLE", "FLAMMABLE_HARD" ],
    "connect_groups" : [ "WALL" ],
    "connects_to" : [ "WALL" ],
    "rotates_to" : [ "INDOORFLOOR" ],
    "crafting_pseudo_item": "anvil",
    "examine_action": "toilet",
    "close": "f_foo_closed",
    "open": "f_foo_open",
    "lockpick_result": "f_safe_open",
    "lockpick_message": "With a click, you unlock the safe.",
    "bash": "TODO",
    "deconstruct": "TODO",
    "max_volume": "1000 L",
    "examine_action": "workbench",
    "workbench": { "multiplier": 1.1, "mass": 10000, "volume": "50L" },
    "boltcut": {
      "result": "f_safe_open",
      "duration": "1 seconds",
      "message": "The safe opens.",
      "sound": "Gachunk!",
      "byproducts": [ { "item": "scrap", "count": 3 } ]
    },
    "hacksaw": {
      "result": "f_safe_open",
      "duration": "12 seconds",
      "message": "The safe is hacksawed open!",
      "sound": "Gachunk!",
      "byproducts": [ { "item": "scrap", "count": 13 } ]
    },
    "oxytorch": {
      "result": "f_safe_open",
      "duration": "30 seconds",
      "message": "The safe opens!",
      "byproducts": [ { "item": "scrap", "count": 13 } ]
    },
    "prying": {
      "result": "f_crate_o",
      "message": "You pop open the crate.",
      "prying_data": {
        "difficulty": 6,
        "prying_level": 1,
        "noisy": true,
        "failure": "You pry, but can't pop open the crate."
      }
    }
}

type

Fixed string, must be furniture to identify the JSON object as such.

"id", "name", "symbol", "looks_like", "color", "bgcolor", "max_volume", "open", "close", "bash", "deconstruct", "examine_action", "flags"

Same as for terrain, see below in the chapter “Common to furniture and terrain”.

move_cost_mod

Movement cost modifier (-10 = impassable, 0 = no change). This is added to the movecost of the underlying terrain.

keg_capacity

Determines capacity of some furnitures with liquid storage that have hardcoded interactions. Value is per 250mL (e.g. "keg_capacity": 8, = 2L)

deployed_item

Item id string used to create furniture. Allows player to interact with the furniture to ‘take it down’ (transform it to item form).

lockpick_result

(Optional) When the furniture is successfully lockpicked, this is the furniture it will turn into.

lockpick_message

(Optional) When the furniture is successfully lockpicked, this is the message that will be printed to the player. When it is missing, a generic "The lock opens…" message will be printed instead.

light_emitted

How much light the furniture produces. 10 will light the tile it’s on brightly, 15 will light that tile and the tiles around it brightly, as well as slightly lighting the tiles two tiles away from the source. For examples: An overhead light is 120, a utility light, 240, and a console, 10.

boltcut

(Optional) Data for using with an bolt cutter.

"boltcut": {
    "result": "furniture_id", // (optional) furniture it will become when done, defaults to f_null
    "duration": "1 seconds", // ( optional ) time required for bolt cutting, default is 1 second
    "message": "You finish cutting the metal.", // ( optional ) message that will be displayed when finished
    "sound": "Gachunk!", // ( optional ) description of the sound when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

hacksaw

(Optional) Data for using with an hacksaw.

"hacksaw": {
    "result": "furniture_id", // (optional) furniture it will become when done, defaults to f_null
    "duration": "1 seconds", // ( optional ) time required for hacksawing, default is 1 second
    "message": "You finish cutting the metal.", // ( optional ) message that will be displayed when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

oxytorch

(Optional) Data for using with an oxytorch.

oxytorch: {
    "result": "furniture_id", // (optional) furniture it will become when done, defaults to f_null
    "duration": "1 seconds", // ( optional ) time required for oxytorching, default is 1 second
    "message": "You quickly cut the metal", // ( optional ) message that will be displayed when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

prying

(Optional) Data for using with prying tools

"prying": {
    "result": "furniture_id", // (optional) furniture it will become when done, defaults to f_null
    "duration": "1 seconds", // (optional) time required for prying, default is 1 second
    "message": "You finish prying the door.", // (optional) message that will be displayed when finished prying successfully
    "byproducts": [ // (optional) list of items that will be spawned when finished successfully
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range inclusive
        }
    ],
    "prying_data": {
        "prying_nails": false, // (optional, default false) if set to true, ALL fields below are ignored
        "difficulty": 0, // (optional, default 0) base difficulty of prying action
        "prying_level": 0, // (optional, default 0) minimum prying level tool needs to have
        "noisy": false, // (optional, default false) makes noise when successfully prying
        "alarm": false, // (optional) has an alarm, on success will trigger the police
        "breakable": false, // (optional) has a chance to trigger the break action on failure
        "failure": "You try to pry the window but fail." // (optional) failure message
    }
}

required_str

Strength required to move the furniture around. Negative values indicate an unmovable furniture.

crafting_pseudo_item

(Optional) Id of an item (tool) that will be available for crafting when this furniture is range (the furniture acts as an item of that type).

workbench

(Optional) Can craft here. Must specify a speed multiplier, allowed mass, and allowed volume. Mass/volume over these limits incur a speed penalty. Must be paired with a "workbench" examine_action to function.

plant_data

(Optional) This is a plant. Must specify a plant transform, and a base depending on context. You can also add a harvest or growth multiplier if it has the GROWTH_HARVEST flag.

surgery_skill_multiplier

(Optional) Surgery skill multiplier (float) applied by this furniture to survivor standing next to it for the purpose of surgery.

Terrain 

{
    "type": "terrain",
    "id": "t_spiked_pit",
    "name": "spiked pit",
    "symbol": "0",
    "looks_like": "pit",
    "color": "ltred",
    "move_cost": 10,
    "light_emitted": 10,
    "trap": "spike_pit",
    "max_volume": "1000 L",
    "flags": ["TRANSPARENT", "DIGGABLE"],
    "connect_groups" : [ "WALL" ],
    "connects_to" : [ "WALL" ],
    "rotates_to" : [ "INDOORFLOOR" ],
    "close": "t_foo_closed",
    "open": "t_foo_open",
    "lockpick_result": "t_door_unlocked",
    "lockpick_message": "With a click, you unlock the door.",
    "bash": "TODO",
    "deconstruct": "TODO",
    "alias": "TODO",
    "harvestable": "blueberries",
    "transforms_into": "t_tree_harvested",
    "allowed_template_ids": [ "standard_template_construct", "debug_template", "afs_10mm_smart_template" ],
    "shoot": { "reduce_damage": [ 2, 12 ], "reduce_damage_laser": [ 0, 7 ], "destroy_damage": [ 40, 120 ], "no_laser_destroy": true },
    "harvest_by_season": [
      { "seasons": [ "spring", "autumn" ], "id": "burdock_harv" },
      { "seasons": [ "summer" ], "id": "burdock_summer_harv" }
    ],
    "liquid_source": { "id": "water", "min_temp": 7.8, "count": [ 24, 48 ] },
    "roof": "t_roof",
    "examine_action": "pit",
    "boltcut": {
      "result": "t_door_unlocked",
      "duration": "1 seconds",
      "message": "The door opens.",
      "sound": "Gachunk!",
      "byproducts": [ { "item": "scrap", "2x4": 3 } ]
    },
    "hacksaw": {
      "result": "t_door_unlocked",
      "duration": "12 seconds",
      "message": "The door is hacksawed open!",
      "sound": "Gachunk!",
      "byproducts": [ { "item": "scrap", "2x4": 13 } ]
    },
    "oxytorch": {
      "result": "t_door_unlocked",
      "duration": "60 seconds",
      "message": "The door opens!",
      "byproducts": [ { "item": "scrap", "count": 10 } ]
    },
    "prying": {
      "result": "t_fence_post",
      "duration": "30 seconds",
      "message": "You pry out the fence post.",
      "byproducts": [ { "item": "nail", "count": 6 }, { "item": "2x4", "count": 3 } ],
      "prying_data": { "prying_nails": true }
    }
}

type

Fixed string, must be “terrain” to identify the JSON object as such.

"id", "name", "symbol", "looks_like", "color", "bgcolor", "max_volume", "open", "close", "bash", "deconstruct", "examine_action", "flags"

Same as for furniture, see below in the chapter “Common to furniture and terrain”.

move_cost

Move cost to move through. A value of 0 means it’s impassable (e.g. wall). You should not use negative values. The positive value is multiple of 50 move points, e.g. value 2 means the player uses 2*50 = 100 move points when moving across the terrain.

heat_radiation

Heat emitted for a terrain. A value of 0 means no fire (i.e, same as not having it). A value of 1 equals a fire of intensity of 1.

light_emitted

How much light the terrain emits. 10 will light the tile it’s on brightly, 15 will light that tile and the tiles around it brightly, as well as slightly lighting the tiles two tiles away from the source. For examples: An overhead light is 120, a utility light, 240, and a console, 10.

lockpick_result

(Optional) When the terrain is successfully lockpicked, this is the terrain it will turn into.

lockpick_message

(Optional) When the terrain is successfully lockpicked, this is the message that will be printed to the player. When it is missing, a generic "The lock opens…" message will be printed instead.

trap

(Optional) Id of the built-in trap of that terrain.

For example the terrain t_pit has the built-in trap tr_pit. Every tile in the game that has the terrain t_pit also has, therefore, an implicit trap tr_pit on it. The two are inseparable (the player can not deactivate the built-in trap, and changing the terrain will also deactivate the built-in trap).

A built-in trap prevents adding any other trap explicitly (by the player and through mapgen).

boltcut

(Optional) Data for using with an bolt cutter.

"boltcut": {
    "result": "ter_id", // terrain it will become when done
    "duration": "1 seconds", // ( optional ) time required for bolt cutting, default is 1 second
    "message": "You finish cutting the metal.", // ( optional ) message that will be displayed when finished
    "sound": "Gachunk!", // ( optional ) description of the sound when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

hacksaw

(Optional) Data for using with an hacksaw.

"hacksaw": {
    "result": "terrain_id", // terrain it will become when done
    "duration": "1 seconds", // ( optional ) time required for hacksawing, default is 1 second
    "message": "You finish cutting the metal.", // ( optional ) message that will be displayed when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

oxytorch

(Optional) Data for using with an oxytorch.

oxytorch: {
    "result": "terrain_id", // terrain it will become when done
    "duration": "1 seconds", // ( optional ) time required for oxytorching, default is 1 second
    "message": "You quickly cut the bars", // ( optional ) message that will be displayed when finished
    "byproducts": [ // ( optional ) list of items that will be spawned when finished
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range ( inclusive )
        }
    ]
}

prying

(Optional) Data for using with prying tools

"prying": {
    "result": "terrain_id", // terrain it will become when done
    "duration": "1 seconds", // (optional) time required for prying nails, default is 1 second
    "message": "You finish prying the door.", // (optional) message that will be displayed when finished prying successfully
    "byproducts": [ // (optional) list of items that will be spawned when finished successfully
        {
            "item": "item_id",
            "count": 100 // exact amount
        },
        {
            "item": "item_id",
            "count": [ 10, 100 ] // random number in range inclusive
        }
    ],
    "prying_data": {
        "prying_nails": false, // (optional, default false) if set to true, ALL fields below are ignored
        "difficulty": 0, // (optional, default 0) base difficulty of prying action
        "prying_level": 0, // (optional, default 0) minimum prying level tool needs to have
        "noisy": false, // (optional, default false) makes noise when successfully prying
        "alarm": false, // (optional) has an alarm, on success will trigger the police
        "breakable": false, // (optional) has a chance to trigger the break action on failure
        "failure": "You try to pry the window but fail." // (optional) failure message
    }
}

transforms_into

(Optional) Used for various transformation of the terrain. If defined, it must be a valid terrain id. Used for example:

  • When harvesting fruits (to change into the harvested form of the terrain).
  • In combination with the HARVESTED flag and harvest_by_season to change the harvested terrain back into a terrain with fruits.

allowed_template_ids

(Optional) Array used for specifying templates that a nanofabricator can create

curtain_transform

(Optional) Terrain id

Transform into this terrain when an examine_action of curtains is used and the Tear down the curtains option is selected.

shoot

(Optional) Array of objects

Defines how this terrain will interact with ranged projectiles. Has the following objects:

    // Base chance to hit the object at all (defaults to 100%)
    int chance_to_hit = 0;
    // Minimum damage reduction to apply to shot when hit
    int reduce_dmg_min = 0;
    // Maximum damage reduction to apply to shot when hit
    int reduce_dmg_max = 0;
    // Minimum damage reduction to apply to laser shots when hit
    int reduce_dmg_min_laser = 0;
    // Maximum damage reduction to apply to laser shots when hit
    int reduce_dmg_max_laser = 0;
    // Damage required to have a chance to destroy
    int destroy_dmg_min = 0;
    // Damage required to guarantee destruction
    int destroy_dmg_max = 0;
    // Are lasers incapable of destroying the object (defaults to false)
    bool no_laser_destroy = false;

harvest_by_season

(Optional) Array of objects containing the seasons in which to harvest and the id of the harvest entry used.

Example:

"harvest_by_season": [ { "seasons": [ "spring", "summer", "autumn", "winter" ], "id": "blackjack_harv" } ],

liquid_source

(Optional) Object, that contain liquids this terrain or furniture can give

Example:

"liquid_source": {
  "id": "water",      // id of a liquid given by ter/furn
  "min_temp": 7.8,    // the lowest possible temperature of liquid taken from here, in centigrade; Used only by "water_source" examine action. Liquid is either the ambient temperature or the `min_temp`, whichever is higher.
  "count": [ 24, 48 ] // if source is finite, how much there should be of it. Omit if it need to have infinite amount of liquid. Accepts either single number, or array of two numbers. Used only by "finite_water_source" examine action
}

roof

(Optional) The terrain of the terrain on top of this (the roof).

Common To Furniture And Terrain

Some values can/must be set for terrain and furniture. They have the same meaning in each case.

id

Id of the object, this should be unique among all object of that type (all terrain or all furniture types). By convention (but technically not needed), the id should have the “f_” prefix for furniture and the “t_” prefix for terrain. This is not translated. It must not be changed later as that would break save compatibility.

name

Displayed name of the object. This will be translated.

flags

(Optional) Various additional flags, see JSON_FLAGS.md.

connect_groups

(Optional) Makes the type a member of one or more Connection groups.

Does not make the type connect or rotate itself, but serves as the passive side. For the active, connecting or rotating side, see connects_to and rotates_to.

Connection groups

Connect groups are defined by JSON types connect_group.
Current connect groups are:

NONE                 SAND
WALL                 PIT_DEEP
CHAINFENCE           LINOLEUM
WOODFENCE            CARPET
RAILING              CONCRETE
POOLWATER            CLAY
WATER                DIRT
PAVEMENT             ROCKFLOOR
PAVEMENT_MARKING     MULCHFLOOR
RAIL                 METALFLOOR
COUNTER              WOODFLOOR
CANVAS_WALL          INDOORFLOOR

WALL is implied by the flags WALL and CONNECT_WITH_WALL. INDOORFLOOR is implied by the flag INDOORS. Implicit groups can be removed be using tilde ~ as prefix of the group name.

connects_to

(Optional) Makes the type connect to terrain types in the given groups (see connect_groups). This affects tile rotation and connections, and the ASCII symbol drawn by terrain with the flag “AUTO_WALL_SYMBOL”.

Example: - , | , X and Y are terrain which share a group in connect_groups and connects_to. O does not have it. X and Y also have the AUTO_WALL_SYMBOL flag. X will be drawn as a T-intersection (connected to west, south and east), Y will be drawn as a horizontal line (going from west to east, no connection to south).

-X-    -Y-
 |      O

Group WALL is implied by the flags WALL and CONNECT_WITH_WALL. Implicit groups can be removed be using tilde ~ as prefix of the group name.

rotates_to

(Optional) Makes the type rotate towards terrain types in the given groups (see connect_groups).

Terrain can only rotate depending on terrain, while funiture can rotate depending on terrain and on other funiture.

The parameters can e.g. be used to have window curtains on the indoor side only, or to orient traffic lights depending on the pavement.

Group INDOORFLOOR is implied by the flags DOOR and WINDOW. Implicit groups can be removed be using tilde ~ as prefix of the group name.

symbol

ASCII symbol of the object as it appears in the game. The symbol string must be exactly one character long. This can also be an array of 4 strings, which define the symbol during the different seasons. The first entry defines the symbol during spring. If it’s not an array, the same symbol is used all year round.

comfort

How comfortable this terrain/furniture is. Impact ability to fall asleep on it. uncomfortable = -999, neutral = 0, slightly_comfortable = 3, comfortable = 5, very_comfortable = 10

floor_bedding_warmth

Bonus warmth offered by this terrain/furniture when used to sleep. Also affects how comfortable a resting place this is(affects healing). Vanilla values should not exceed 1000.

fall_damage_reduction

Flat damage reduction or increase if negative number. Like falling on a bush or soft chair or mattress or sofa.

bonus_fire_warmth_feet

Increase warmth received on feet from nearby fire (default = 300)

looks_like

id of a similar item that this item looks like. The tileset loader will try to load the tile for that item if this item doesn’t have a tile. looks_like entries are implicitly chained, so if ‘throne’ has looks_like ‘big_chair’ and ‘big_chair’ has looks_like ‘chair’, a throne will be displayed using the chair tile if tiles for throne and big_chair do not exist. If a tileset can’t find a tile for any item in the looks_like chain, it will default to the ascii symbol.

color or bgcolor

Color of the object as it appears in the game. “color” defines the foreground color (no background color), “bgcolor” defines a solid background color. As with the “symbol” value, this can be an array with 4 entries, each entry being the color during the different seasons.

NOTE: You must use ONLY ONE of “color” or “bgcolor”

coverage

The coverage percentage of a furniture piece of terrain. <30 won’t cover from sight. (Does not interact with projectiles, gunfire, or other attacks. Only line of sight.)

max_volume

(Optional) Maximal volume that can be used to store items here. Volume in ml and L can be used - “50 ml” or “2 L”

examine_action

(Optional) The json function that is called when the object is examined. See EXAMINE.md.

close and open

(Optional) The value should be a terrain id (inside a terrain entry) or a furniture id (in a furniture entry). If either is defined, the player can open / close the object. Opening / closing will change the object at the affected tile to the given one. For example one could have object “safe_c”, which “open”s to “safe_o” and “safe_o” in turn “close”s to “safe_c”. Here “safe_c” and “safe_o” are two different terrain (or furniture) types that have different properties.

bash

(Optional) Defines whether the object can be bashed and if so, what happens. See “map_bash_info”.

deconstruct

(Optional) Defines whether the object can be deconstructed and if so, what the results shall be. See “map_deconstruct_info”.

map_bash_info

Defines the various things that happen when the player or something else bashes terrain or furniture.

{
    "str_min": 80,
    "str_max": 180,
    "str_min_blocked": 15,
    "str_max_blocked": 100,
    "str_min_supported": 15,
    "str_max_supported": 100,
    "sound": "crunch!",
    "sound_vol": 2,
    "sound_fail": "whack!",
    "sound_fail_vol": 2,
    "ter_set": "t_dirt",
    "furn_set": "f_rubble",
    "ter_set_bashed_from_above": "t_rock_floor_no_roof",
    "explosive": 1,
    "collapse_radius": 2,
    "destroy_only": true,
    "bash_below": true,
    "tent_centers": ["f_groundsheet", "f_fema_groundsheet", "f_skin_groundsheet"],
    "items": "bashed_item_result_group"
}
str_min, str_max

The bash succeeds if str >= random # between str_min & str_max

str_min_blocked, str_max_blocked

(Optional) Will be used instead of str_min & str_max if the furniture is blocked, for example a washing machine behind a door

str_min_supported, str_max_supported

(Optional) Will be used instead of str_min & str_max if beneath this is something that can support a roof.

sound, sound_fail, sound_vol, sound_fail_vol

(Optional) Sound and volume of the sound that appears upon destroying the bashed object or upon unsuccessfully bashing it (failing). The sound strings are translated (and displayed to the player).

furn_set, ter_set

The terrain / furniture that will be set when the original is destroyed. This is mandatory for bash entries in terrain, but optional for entries in furniture (it defaults to no furniture).

ter_set_bashed_from_above

If terrain is bashed from above (like in explosion), this terrain would be spawned instead of ter_set. Usually the version of terrain without a roof is used

explosive

(Optional) If greater than 0, destroying the object causes an explosion with this strength (see game::explosion).

destroy_only

If true, only used for destroying, not normally bashable

bash_below

This terrain is the roof of the tile below it, try to destroy that too. Further investigation required

tent_centers, collapse_radius

(Optional) For furniture that is part of tents, this defines the id of the center part, which will be destroyed as well when other parts of the tent get bashed. The center is searched for in the given “collapse_radius” radius, it should match the size of the tent.

items

(Optional) An item group (inline) or an id of an item group, see ITEM_SPAWN.md. The default subtype is “collection”. Upon successful bashing, items from that group will be spawned.

map_deconstruct_info 

{
    "furn_set": "f_safe",
    "ter_set": "t_dirt",
    "skill": { "skill": "electronics", "multiplier": 0.5, "min": 1, "max": 8 },
    "items": "deconstructed_item_result_group"
}
furn_set, ter_set

The terrain / furniture that will be set after the original has been deconstructed. “furn_set” is optional (it defaults to no furniture), “ter_set” is only used upon “deconstruct” entries in terrain and is mandatory there.

skill

(Optional) The skill that will be practised after deconstruction. Min is the minimum level to receive xp, max is the level cap after which no xp is received but practise still occurs delaying rust and multiplier multiplies the base xp given which is based on the mean of min and max. If skill is specified, multiplier defaults to 1.0, min to 0 and max to 10.

items

(Optional) An item group (inline) or an id of an item group, see ITEM_SPAWN.md. The default subtype is “collection”. Upon deconstruction the object, items from that group will be spawned.

plant_data 

{
  "transform": "f_planter_harvest",
  "base": "f_planter",
  "growth_multiplier": 1.2,
  "harvest_multiplier": 0.8
}
transform

What the PLANT furniture turn into when it grows a stage, or what a PLANTABLE furniture turns into when it is planted on.

emissions

(Optional) An array listing the emit_id of the fields the terrain/furniture will produce every 10 seconds.

base

What the ‘base’ furniture of the PLANT furniture is - what it would be if there was not a plant growing there. Used when monsters ‘eat’ the plant to preserve what furniture it is.

growth_multiplier

A flat multiplier on the growth speed on the plant. For numbers greater than one, it will take longer to grow, and for numbers less than one it will take less time to grow.

harvest_multiplier

A flat multiplier on the harvest count of the plant. For numbers greater than one, the plant will give more produce from harvest, for numbers less than one it will give less produce from harvest.

clothing_mod 

"type": "clothing_mod",
"id": "leather_padded",   // Unique ID.
"flag": "leather_padded", // flag to add to clothing.
"item": "leather",        // item to consume.
"implement_prompt": "Pad with leather",      // prompt to show when implement mod.
"destroy_prompt": "Destroy leather padding", // prompt to show when destroy mod.
"restricted": true,       // (optional) If true, clothing must list this mod's flag in "valid_mods" list to use it. Defaults to false.
"mod_value": [            // List of mod effect.
    {
        "type": "bash",   // "bash", "cut", "bullet", "fire", "acid", "warmth", and "encumbrance" is available.
        "value": 1,       // value of effect.
        "round_up": false // (optional) round up value of effect. defaults to false.
        "proportion": [   // (optional) value of effect proportions to clothing's parameter.
            "thickness",  //            "thickness" and "coverage" is available.
            "coverage"
        ]
    }
]

Flags

Flags, that can be used in different entries, can also be made in json, allowing it to be used in pocket restrictions and EoC checks, or having a json flag and information in json, while being backed in code


{
  "type": "json_flag", // define it as json flag
  "id": "COMPLETELY_MADE_UP_FLAG", // id of a flag
  "name": "ultra-light battery", // name of a flag, used in pocket restrictions shown as `compatible magazines: form factors` 
  "info": "This will hook to a <info>Hub 01 proprietary</info> skirt connector", // this information would be shown, if possible - like in item description
  "restriction": "Item must be an armored skirt", // for pocket restriction, this information would be shown in `restrictions` field in pocket info
  "conflicts": "FANCY", // if something with this flag will met something with conflict flag, only one will be applied
  "taste_mod": -5, // for consumables, it will add -5 to taste, that can't be removed with cooking
  "inherit": true, // is this flag inherited to another thing if it's attached/equipped, like if you put ESAPI plate into plate carrier, their `CANT_WEAR` flag won't be applied to plate carrier, and you could wear it as usually
  "craft_inherit": true // if true, if you craft something with this flag, this flag would be applied to result also
  "item_prefix": "[...",
  "item_suffix": "...]" // `item_prefix` and `item_suffix` will be added to the prefix and suffix of the item name
},

Scenarios

Scenarios are specified as JSON object with type member set to scenario.

{
    "type": "scenario",
    "id": "schools_out",
    ...
}

The id member should be the unique id of the scenario.

The following properties (mandatory, except if noted otherwise) are supported:

description

(string)

The in-game description.

name

(string or object with members “male” and “female”)

The in-game name, either one gender-neutral string, or an object with gender specific names. Example:

"name": {
    "male": "Runaway groom",
    "female": "Runaway bride"
}

points

(integer)

Point cost of scenario. Positive values cost points and negative values grant points.

items

(optional, object with optional members “both”, “male” and “female”)

Items the player starts with when selecting this scenario. One can specify different items based on the gender of the character. Each lists of items should be an array of items ids. Ids may appear multiple times, in which case the item is created multiple times.

Example:

"items": {
    "both": [
        "pants",
        "rock",
        "rock"
    ],
    "male": [ "briefs" ],
    "female": [ "panties" ]
}

This gives the player pants, two rocks and (depending on the gender) briefs or panties.

flags

(optional, array of strings)

A list of flags. TODO: document those flags here.

cbms

(optional, array of strings)

A list of CBM ids that are implanted in the character.

traits, forced_traits, forbidden_traits

(optional, array of strings)

Lists of trait/mutation ids. Traits in “forbidden_traits” are forbidden and can’t be selected during the character creation. Traits in “forced_traits” are automatically added to character. Traits in “traits” enables them to be chosen, even if they are not starting traits.

forced_traits can also be specified with a variant, as { "trait": "trait_id", "variant": "variant_id" } (replacing just "trait_id").

allowed_locs

(optional, array of strings)

A list of starting location ids (see start_locations.json) that can be chosen when using this scenario.

start_name

(string)

The name that is shown for the starting location. This is useful if the scenario allows several starting locations, but the game can not list them all at once in the scenario description. Example: if the scenario allows to start somewhere in the wilderness, the starting locations would contain forest and fields, but its “start_name” may simply be “wilderness”.

professions

(optional, array of strings)

A list of allowed professions that can be chosen when using this scenario. The first entry is the default profession. If this is empty, all professions are allowed.

hobbies

(optional, array of strings)

A list of allowed hobbies that can be chosen when using this scenario. If this is empty, all hobbies are allowed.

whitelist_hobbies

(optional, bool)

When set to false, the hobbies in hobbies are hobbies that cannot be chosen when using this scenario. This value defaults to true.

map_special

(optional, string)

Add a map special to the starting location, see JSON_FLAGS for the possible specials.

requirement

(optional, an achievement ID)

The achievement you need to do to access this scenario

reveal_locale

(optional, boolean)

Defaults true. If a road can be found within 3 OMTs of the starting position, reveals a path to the nearest city and that city’s center.

eocs

(optional, array of strings)

A list of eocs that are triggered once for each new character on scenario start.

missions

(optional, array of strings)

A list of mission ids that will be started and assigned to the player at the start of the game. Only missions with the ORIGIN_GAME_START origin are allowed. The last mission in the list will be the active mission, if multiple missions are assigned.

start_of_cataclysm

(optional, object with optional members “hour”, “day”, “season” and “year”)

Allows customization of Cataclysm start date. If start_of_cataclysm is not set the corresponding default values are used instead - Year 1, Spring, Day 61, 00:00:00. Can be changed in new character creation screen.

"start_of_cataclysm": { "hour": 7, "day": 10, "season": "winter", "year": 1 }
Identifier Description
hour (optional, integer) Hour of the day. Default value is 0.
day (optional, integer) Day of the season. Default value is 61.
season (optional, integer) Season of the year. Default value is spring.
year (optional, integer) Year. Default value is 1.

start_of_game

(optional, object with optional members “hour”, “day”, “season” and “year”)

Allows customization of game start date. If start_of_game is not set the corresponding default values are used instead - Year 1, Spring, Day 61, 08:00:00. Can be changed in new character creation screen.

Attention: Game start date is automatically adjusted, so it is not before the Cataclysm start date.

"start_of_game": { "hour": 8, "day": 16, "season": "winter", "year": 2 }
Identifier Description
hour (optional, integer) Hour of the day. Default value is 8.
day (optional, integer) Day of the season. Default value is 61.
season (optional, integer) Season of the year. Default value is spring.
year (optional, integer) Year. Default value is 1.

Starting locations

Starting locations are specified as JSON object with “type” member set to “start_location”:

{
    "type": "start_location",
    "id": "field",
    "name": "An empty field",
    "terrain": [ "field", { "om_terrain": "hospital", "om_terrain_match_type": "PREFIX" } ],
    "city_sizes": [ 0, 16 ],
    "city_distance": [ 0, -1 ],
    "allowed_z_levels": [ 0, 0 ],
    ...
}

The id member should be the unique id of the location.

The following properties (mandatory, except if noted otherwise) are supported:

name

(string)

The in-game name of the location.

terrain

(array of strings and/or objects)

String here contains the id of an overmap terrain type (see overmap_terrain.json) of the starting location. The game will chose a random place with that terrain.

If it is an object - it has following attributes:

 Identifier        |                                   Description                                           | ---------------------- | --------------------------------------------------------------------------------------- | `om_terrain`           | ID of overmap terrain which will be selected as the target. Mandatory.                  | `om_terrain_match_type`| Optional. Matching rule to use with `om_terrain`. Defaults to TYPE. Details are below.  | `parameters`           | Optional. Parameter key/value pairs to set. Details are below.                          |

om_terrain_match_type defaults to TYPE if unspecified, and has the following possible values:

  • EXACT - The provided string must completely match the overmap terrain id, including linear direction suffixes for linear terrain types or rotation suffixes for rotated terrain types.

  • TYPE - The provided string must completely match the base type id of the overmap terrain id, which means that suffixes for rotation and linear terrain types are ignored.

  • SUBTYPE - The provided string must completely match the base type id of the overmap terrain id as well as the linear terrain type ie “road_curved” will match “road_ne”, “road_es”, “road_sw” and “road_wn”.

  • PREFIX - The provided string must be a complete prefix (with additional parts delimited by an underscore) of the overmap terrain id. For example, “forest” will match “forest” or “forest_thick” but not “forestcabin”.

  • CONTAINS - The provided string must be contained within the overmap terrain id, but may occur at the beginning, end, or middle and does not have any rules about underscore delimiting.

parameters is an object containing one or more keys to set to a specific value provided, say to pick a safe variant of a map. The keys and values must be valid for the overmap terrains in question. This can also be used with 0 weight values to provide unique starting map variations that don’t spawn normally.

Examples

Any overmap terrain that is either "shelter" or begins with shelter_

{
    "om_terrain": "shelter",
    "om_terrain_match_type": "PREFIX"
}

Any overmap terrain that is either "mansion" or begins with mansion_, and forces the parameter mansion_variant to be set to haunted_scenario_only

{
    "om_terrain": "mansion",
    "om_terrain_match_type": "PREFIX",
    "parameters": { "mansion_variant": "haunted_scenario_only" }
}

city_sizes

(array of two integers)

Restricts possible start location based on nearest city size (similar to how overmap specials are restricted).

city_distance

(array of two integers)

Restricts possible start location based on distance to nearest city (similar to how overmap specials are restricted).

allowed_z_levels

(array of two integers)

Restricts possible start location based on z-level (e.g. there is no need to search forests on z-levels other than 0).

flags

(optional, array of strings)

Arbitrary flags. Two flags are supported in the code: ALLOW_OUTSIDE and BOARDED (see JSON_FLAGS.md). Mods can modify this via “extend” / “delete”.

{
    "type": "start_location",
    "id": "sloc_house_boarded",
    "copy-from": "sloc_house",
    "name": "House (boarded up)",
    "extend": { "flags": [ "BOARDED" ] }
},

Mutation overlay ordering

The file mutation_ordering.json defines the order that visual mutation and bionic overlays are rendered on a character ingame. The layering value from 0 (bottom) - 9999 (top) sets the order.

Example:

[
    {
        "type" : "overlay_order",
        "overlay_ordering" :
        [
        {
            "id" : [ "BEAUTIFUL", "BEAUTIFUL2", "BEAUTIFUL3", "LARGE", "PRETTY", "RADIOACTIVE1", "RADIOACTIVE2", "RADIOACTIVE3", "REGEN" ],
            "order" : 1000
        },{
            "id" : [ "HOOVES", "ROOTS1", "ROOTS2", "ROOTS3", "TALONS" ],
            "order" : 4500
        },{
            "id" : "FLOWERS",
            "order" : 5000
        },{
            "id" : [ "PROF_CYBERCOP", "PROF_FED", "PROF_PD_DET", "PROF_POLICE", "PROF_SWAT", "PHEROMONE_INSECT" ],
            "order" : 8500
        },{
            "id" : [ "bio_armor_arms", "bio_armor_legs", "bio_armor_torso", "bio_armor_head", "bio_armor_eyes" ],
            "order" : 500
        }
        ]
    }
]

id

(string)

The internal ID of the mutation. Can be provided as a single string, or an array of strings. The order value provided will be applied to all items in the array.

order

(integer)

The ordering value of the mutation overlay. Values range from 0 - 9999, 9999 being the topmost drawn layer. Mutations that are not in any list will default to 9999.

MOD tileset

MOD tileset defines additional sprite sheets. It is specified as JSON object with type member set to mod_tileset.

Example:

[
    {
    "type": "mod_tileset",
    "compatibility": [ "MshockXottoplus" ],
    "tiles-new": [
        {
        "file": "test_tile.png",
        "tiles": [
            {
            "id": "player_female",
            "fg": 1,
            "bg": 0
            },
            {
            "id": "player_male",
            "fg": 2,
            "bg": 0
            }
        ]
        }
    ]
    }
]

compatibility

(string)

The internal ID of the compatible tilesets. MOD tileset is only applied when base tileset’s ID exists in this field.

tiles-new

Setting of sprite sheets. Same as tiles-new field in tile_config. Sprite files are loaded from the same folder json file exists.

Obsoletion and migration

OBSOLETION_AND_MIGRATION.md

Field types

Fields can exist on top of terrain/furniture, and support different intensity levels. Each intensity level inherits its properties from the lower one, so any field not explicitly overwritten will carry over. They affect both characters and monsters, but a lot of fields have hardcoded effects that are potentially different for both (found in map_field.cpp:creature_in_field). Gaseous fields that have a chance to do so are spread depending on the local wind force when outside, preferring spreading down to on the same Z-level, which is preferred to spreading upwards. Indoors and by weak winds fields spread randomly.

  {
    "type": "field_type", // this is a field type
    "id": "fd_gum_web", // id of the field
    "immune_mtypes": [ "mon_spider_gum" ], // list of monster immune to this field
    "legacy_enum_id": -1, // Not used anymore, default -1
    "legacy_make_rubble": true, // Transform terrain into rubble, was used when rubble was a field, not used now
    "priority": 4, // Fields with higher priority are drawn above another - smoke is drawn above the acid pool, not vice versa
    "intensity_levels":  // The below fields are all tied to the specific intensity unless they got defined in the lower-level one
    [
      { "name": "shadow",  // name of this level of intensity
        "sym": "{", // symbol of this level of intensity
        "color":  "brown", // color of this level of intensity
        "transparent": false, // default true, on false this intensity blocks vision
        "dangerous": false, // is this level of intensity considered dangerous for monster avoidance and player warnings
        "move_cost": 120, // Extra movement cost for moving through this level of intensity (on top of base terrain/furniture movement costs)
        "extra_radiation_min": 1,
        "extra_radiation_max": 5, // This level of intensity will add a random amount of radiation between the min and the max value to its tile
        "radiation_hurt_damage_min": 5,
        "radiation_hurt_damage_max": 7, // When standing in this field hurt every limb for a random amount of damage between the min and max value. Requires extra_radiation_min > 0
        "radiation_hurt_message": "Ouch", // String to print when you get hurt by radiation_hurt_damage
        "intensity_upgrade_chance": 1,
        "intensity_upgrade_duration": "1 days", // Every "upgrade_duration" a "1-in-upgrade_chance" roll is made. On success, increase the field intensity by 1
        "monster_spawn_chance": 5,
        "monster_spawn_count": 2,
        "monster_spawn_radius": 15,
        "monster_spawn_group": "GROUP_NETHER", // 1-in-spawn_chance roll to spawn spawn_count entries from spawn_group monstergroup and place them in a spawn_radius radius around the field
        "light_emitted": 2.5, // light level emitted by this intensity
        "light_override": 3.7 }, //light level on the tile occupied by this field will be set at 3.7 no matter the ambient light.
        "translucency": 2.0, // How much light the field blocks (higher numbers mean less light can penetrate through)
        "concentration": 1, // How concentrated this intensity of gas is. Generally the thin/hazy cloud intensity will be 1, the standard gas will be 2, and thick gas will be 4. The amount of time a gas mask filter will last will be divided by this value.
        "convection_temperature_mod": 12, // Heat given off by this level of intensity
        "effects":  // List of effects applied to any creatures within the field as long as they aren't immune to the effect or the field itself
        [
          {
            "effect_id": "webbed", // Effect ID
            "min_duration": "1 minutes",
            "max_duration": "5 minutes", // Effect duration randomized between min and max duration
            "intensity": 1, // Intensity of the effect to apply
            "body_part": "head", // Bodypart the effect gets applied to, default BP_NULL ("whole body")
            "is_environmental": false, // If true the environmental effect roll is used to determine if the effect gets applied: <intensity>d3 > <target BP's armor/bionic env resist>d3
            "immune_in_vehicle": // If true, *standing* inside a vehicle (like without walls or roof) protects from the effect
            "immune_inside_vehicle": false, // If true being inside a vehicle protects from the effect
            "immune_outside_vehicle": false, // If true being *outside* a vehicle protects from the effect,
            "chance_in_vehicle": 2,
            "chance_inside_vehicle": 2,
            "chance_outside_vehicle": 2, // 1-in-<chance> chance of the effect being applied when traversing a field in a vehicle, inside a vehicle (as in, under a roof), and outside a vehicle
            "message": "You're debilitated!", // Message to print when the effect is applied to the player
            "message_npc": "<npcname> is debilitated!", // Message to print when the effect is applied to an NPC
            "message_type": "bad", // Type of the above messages - good/bad/mixed/neutral
            "immunity_data": {...} // See Immunity Data below
          }
        ]
        "scent_neutralization": 3, // Reduce scents at the field's position by this value        
    ],
    "npc_complain": { "chance": 20, "issue": "weed_smoke", "duration": "10 minutes", "speech": "<weed_smoke>" }, // NPCs in this field will complain about being in it once per <duration> if a 1-in-<chance> roll succeeds, giving off a <speech> bark that supports snippets
    "immunity_data": {...} // See Immunity Data below
    "decay_amount_factor": 2, // The field's rain decay amount is divided by this when processing the field, the rain decay is a function of the weather type's precipitation class: very_light = 5s, light = 15s, heavy = 45 s
    "half_life": "3 minutes", // If above 0 the field will disappear after two half-lifes on average
    "underwater_age_speedup": "25 minutes", // Increase the field's age by this time every tick if it's on a terrain with the SWIMMABLE flag
    "linear_half_life": "true", // If true the half life decay is converted to a non-random, linear wait based on the defined half_life time. 
    "outdoor_age_speedup": "20 minutes", // Increase the field's age by this duration if it's on an outdoor tile
    "accelerated_decay": true, // If the field should use a more simple decay calculation, used for cosmetic fields like gibs
    "percent_spread": 90, // The field must succeed on a `rng( 1, 100 - local windpower ) > percent_spread` roll to spread. The field must have a non-zero spread percent and the GAS phase to be eligible to spread in the first place
    "phase": "gas", // Phase of the field. Gases can spread after spawning and can be spawned out of emitters through impassable terrain with the PERMEABLE flag
    "apply_slime_factor": 10, // Intensity of slime to apply to creatures standing in this field (Why not use an effect? No idea.)
    "gas_absorption_factor": "80m", // Length a full 100 charge gas mask filter will last in this gas. Will be divided by the concentration of the gas, and should be 80m for concentration 1 toxic gas or similar. The worst gas should still be kept out for 20 minutes in a concentration 4 thick gas.
    "is_splattering": true, // If splatters of this field should bloody vehicle parts
    "dirty_transparency_cache": true, // Should the transparency cache be recalculated when the field is modified (used for nontransparent, spreading fields)
    "has_fire": false, // Is this field a kind of fire (for immunity, monster avoidance and similar checks)
    "has_acid": false, // See has_fire
    "has_elec": false, // See has_fire
    "has_fume": false, // See has_fire, non-breathing monsters are immune to this field
    "display_items": true, // If the field should obscure items on this tile
    "display_field": true, // If the field has a visible sprite or symbol, default false
    "description_affix": "covered_in", // Description affix for items in this field, possible values are "in", "covered_in", "on", "under", and "illuminated_by"
    "wandering_field": "fd_toxic_gas", // Spawns the defined field in an `intensity-1` radius, or increases the intensity of such fields until their intensity is the same as the parent field
    "decrease_intensity_on_contact": true, // Decrease the field intensity by one each time a character walk on it.
    "mopsafe": false, // field is safe to use in a mopping zone
    "bash": {
      "str_min": 1, // lower bracket of bashing damage required to bash
      "str_max": 3, // higher bracket
      "sound_vol": 2, // noise made when successfully bashing the field
      "sound_fail_vol": 2, // noise made when failing to bash the field
      "sound": "shwip", // sound on success
      "sound_fail": "shwomp", // sound on failure
      "msg_success": "You brush the gum web aside.", // message on success
      "move_cost": 120, // how many moves it costs to successfully bash that field (default: 100)
      "items": [                                   // item dropped upon successful bashing
        { "item": "2x4", "count": [ 5, 8 ] },
        { "item": "nail", "charges": [ 6, 8 ] },
        { "item": "splinter", "count": [ 3, 6 ] },
        { "item": "sheet_cotton", "count": [ 40, 55 ] },
        { "item": "scrap", "count": [ 10, 20 ] }
      ]
    },
    "indestructible": true // Field cannot be bashed or destroyed, but may still expire over time.  Useful when combined with the bash field because it can allow fields to prevent bashing terrain but not be destructible.
  }

Emits

Defines field emissions

{
  "id": "emit_rad_cloud", // id of emission
  "type": "emit",         
  "field": "fd_nuke_gas", // field, that would be emitted
  "intensity": 3,         // intensity of the field to be emitted
  "qty": 100,             // amount of fields that would be emitted, in a circle, 1 means 1 field; 9 would be 3x3, 16 would be 4x4 square etc
  "chance": 50            // chance to emit one unit of field, from 1 to 100
},

Immunity data

Immunity data can be provided at the field level or at the effect level based on intensity and body part. At the field level it applies immunity to all effects.

"immunity_data": {  // Object containing the necessary conditions for immunity to this field.  Any one fulfilled condition confers immunity:
      "flags": [ "WEBWALK" ],  // Immune if the character has any of the defined character flags (see Character flags)
      "body_part_env_resistance": [ [ "mouth", 15 ], [ "sensor", 10 ] ], // Immune if ALL bodyparts of the defined types have the defined amount of env protection
      "immunity_flags_worn": [ [ "sensor", "FLASH_PROTECTION" ] ], // Immune if ALL parts of the defined types wear an item with the defined flag
      "immunity_flags_worn_any": [ [ "sensor", "BLIND" ], [ "hand", "PADDED" ] ], // Immune if ANY part of the defined type wears an item with the corresponding flag -- in this example either a blindfold OR padded gloves confer immunity
},

Option sliders 

{
  "type": "option_slider",
  "id": "world_difficulty",
  "context": "WORLDGEN",
  "name": "Difficulty",
  "default": 3,
  "levels": [
    {
      "level": 0,
      "name": "Cakewalk?",
      "description": "Monsters are much easier to deal with, and plenty of items can be found.",
      "options": [
        { "option": "MONSTER_SPEED", "type": "int", "val": 90 },
        { "option": "MONSTER_RESILIENCE", "type": "int", "val": 75 },
        { "option": "SPAWN_DENSITY", "type": "float", "val": 0.8 },
        { "option": "MONSTER_UPGRADE_FACTOR", "type": "float", "val": 8 },
        { "option": "ITEM_SPAWNRATE", "type": "float", "val": 1.5 }
      ]
    },
    ...
  ]
}

Option sliders - Fields

Field Description
"type" (mandatory) Always "option_slider"
"id" (mandatory) Uniquely identifies this option_slider
"context" The hardcoded context in which this option_slider is used (ex: the world creation menu shows option sliders in the WORLDGEN context)
"name" (mandatory) The translated name of this option_slider
"default" The default level for this option_slider (defaults to 0)
"levels" (mandatory) A list of definitions for each level of this option_slider

Option sliders - Levels

Each object in the "levels" field uses these fields:

Field Description
"level" (mandatory) The numeric index of this level in the slider. Indexes start at 0 and increase sequentially.
"name" (mandatory) The name of this slider level, acts as a short descriptor for the selected level.
"description" A longer description for the effects of this slider level.
"options" (mandatory) A list of option values to apply when selecting this slider level.

Each option defines an "option" tag that corresponds to an option ID as listed in the options_manager::add_options_* functions in src/options.cpp. The "type" field determines how the "val" field is interpreted:

type val
"int" An integer. Ex: "type": "int", "val": 5
"float" A decimal number. Ex: "type": "float", "val": 0.8
"bool" A boolean. Ex: "type": "bool", "val": false
"string" A text value. Ex: "type": "string", "val": "crops"