v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Utility:DFHack/createitem"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (→‎Shells: link)
Line 72: Line 72:
 
* Gauntlets (will automatically be created in pairs)
 
* Gauntlets (will automatically be created in pairs)
 
  GLOVES:ITEM_GLOVES_GAUNTLETS ''material''
 
  GLOVES:ITEM_GLOVES_GAUNTLETS ''material''
 +
* Gloves (will automatically be created in pairs)
 +
GLOVES:ITEM_GLOVES_GLOVES ''material''
 
* Helm
 
* Helm
 
  HELM:ITEM_HELM_HELM ''material''
 
  HELM:ITEM_HELM_HELM ''material''
Line 84: Line 86:
 
* High boots
 
* High boots
 
  SHOES:ITEM_SHOES_BOOTS ''material''
 
  SHOES:ITEM_SHOES_BOOTS ''material''
 +
* Low boots
 +
SHOES:ITEM_SHOES_BOOTS_LOW ''material''
 
* Cloak
 
* Cloak
 
  ARMOR:ITEM_ARMOR_CLOAK ''material''
 
  ARMOR:ITEM_ARMOR_CLOAK ''material''

Revision as of 04:20, 11 March 2022

This is a list of createitem commands for DFHack.

Not to be confused with gui/create-item, an interactive Lua script, or create-items, a Ruby script with different syntax and support for fewer types of items.

Usage

Format:

createitem [Item token] [Material] [Quantity (optional)]
  • NOTE: A much simpler alternative is available via the dfhack terminal gui/hack-wish. It is a basic GUI which guides you through which item you want to create, then the material, and finally the quality modifier.
  • If you select a unit, then that unit will craft the item (and gain appropriate skills), otherwise the first unit in the fortress will be automatically selected.
  • By default, items will be placed on the floor beneath the cursor.
    • If you select a container (such as a barrel, backpack, or minecart) and type "createitem item", all subsequently created items will be placed inside that container.
    • If you select a building (such as a workshop, chest, or weapon rack) and type "createitem building", all subsequently created items will be placed inside that building.
    • Typing "createitem floor" will switch it back to placing created items on the floor.
  • A list of valid item tokens can be found here. Note that CORPSE, CORPSEPIECE, and FOOD are not supported by DFHack.
  • You can create multiple items at once by appending a number to the createitem command (e.g. createitem BOULDER INORGANIC:HEMATITE 20). Note that certain item types will be created in stacks, while others will be created as individual items - see the Reactions page for more information.
  • Text in italics should be replaced with the ID from the relevant raw page on this wiki. For example, to make goblin-cap logs, visit the goblin-cap page and view the raws. The ID is found in the first token, separated from the item type with a colon - for example, the ID for goblin-caps is GOBLIN_CAP, retrieved from [PLANT:GOBLIN_CAP].

Items

Inorganic items

Most of these can be obtained from the list of item tokens.

Stone

  • Boulders (i.e. mined stones):
BOULDER INORGANIC:stone
  • Blocks
BLOCKS INORGANIC:stone

Wood

  • Logs
WOOD PLANT_MAT:tree:WOOD
  • Blocks
BLOCKS PLANT_MAT:tree:WOOD

Metal

BAR INORGANIC:metal

Gems

  • Rough gems
ROUGH INORGANIC:gem
  • Small cut gems
SMALLGEM INORGANIC:gem
  • Large cut gems
GEM INORGANIC:gem

Glass

Raw glass:

ROUGH glass:NONE
Glass Material token ("glass")
Green glass GLASS_GREEN
Clear glass GLASS_CLEAR
Crystal glass GLASS_CRYSTAL

(Items made of glass, e.g. furniture, use these names as well)

Misc

  • Quires
TOOL:ITEM_TOOL_QUIRE material
  • Pipe sections
PIPE_SECTION material

Armor

  • Gauntlets (will automatically be created in pairs)
GLOVES:ITEM_GLOVES_GAUNTLETS material
  • Gloves (will automatically be created in pairs)
GLOVES:ITEM_GLOVES_GLOVES material
  • Helm
HELM:ITEM_HELM_HELM material
  • Cap
HELM:ITEM_HELM_CAP material
  • Breastplate
ARMOR:ITEM_ARMOR_BREASTPLATE material
  • Mail shirt
ARMOR:ITEM_ARMOR_MAIL_SHIRT material
  • Greaves
PANTS:ITEM_PANTS_GREAVES material
  • High boots
SHOES:ITEM_SHOES_BOOTS material
  • Low boots
SHOES:ITEM_SHOES_BOOTS_LOW material
  • Cloak
ARMOR:ITEM_ARMOR_CLOAK material
  • Shield
SHIELD:ITEM_SHIELD_SHIELD material
  • Buckler
SHIELD:ITEM_SHIELD_BUCKLER material
  • Skirt (long)
PANTS:ITEM_PANTS_SKIRT_LONG material
  • Skirt (short)
PANTS:ITEM_PANTS_SKIRT_SHORT material
  • Skirt
PANTS:ITEM_PANTS_SKIRT material

Weapons

  • Whip:
WEAPON:ITEM_WEAPON_WHIP material
  • Battle axe:
WEAPON:ITEM_WEAPON_AXE_BATTLE material
  • War hammer:
WEAPON:ITEM_WEAPON_HAMMER_WAR material
  • Short sword:
WEAPON:ITEM_WEAPON_SWORD_SHORT material
  • Spear:
WEAPON:ITEM_WEAPON_SPEAR material
  • Mace:
WEAPON:ITEM_WEAPON_MACE material
  • Crossbow:
WEAPON:ITEM_WEAPON_CROSSBOW material
  • Pick:
WEAPON:ITEM_WEAPON_PICK material
  • Bow:
WEAPON:ITEM_WEAPON_BOW material
  • Blowgun:
WEAPON:ITEM_WEAPON_BLOWGUN material
  • Pike:
WEAPON:ITEM_WEAPON_PIKE material
  • Halberd:
WEAPON:ITEM_WEAPON_HALBERD material
  • Two-handed sword:
WEAPON:ITEM_WEAPON_SWORD_2H material
  • Long sword:
WEAPON:ITEM_WEAPON_SWORD_LONG material
  • Maul:
WEAPON:ITEM_WEAPON_MAUL material
  • Great axe:
WEAPON:ITEM_WEAPON_AXE_GREAT material
  • Dagger:
WEAPON:ITEM_WEAPON_DAGGER_LARGE material
  • Scourge:
WEAPON:ITEM_WEAPON_SCOURGE material
  • Flail:
WEAPON:ITEM_WEAPON_FLAIL material
  • Morningstar:
WEAPON:ITEM_WEAPON_MORNINGSTAR material
  • Scimitar:
WEAPON:ITEM_WEAPON_SCIMITAR material
  • Training axe:
WEAPON:ITEM_WEAPON_AXE_TRAINING material
  • Training sword:
WEAPON:ITEM_WEAPON_SWORD_SHORT_TRAINING material
  • Training spear:
WEAPON:ITEM_WEAPON_SPEAR_TRAINING material

Ammo

  • Bolts:
AMMO:ITEM_AMMO_BOLTS material
AMMO:ITEM_AMMO_BOLTS PLANT:GOBLIN_CAP:WOOD

Trap components

  • Menacing spike
TRAPCOMP:ITEM_TRAPCOMP_MENACINGSPIKE material
  • Large, serrated disc
TRAPCOMP:ITEM_TRAPCOMP_LARGESERRATEDDISC material
  • Spiked ball
TRAPCOMP:ITEM_TRAPCOMP_SPIKEDBALL material
  • Enormous corkscrew
TRAPCOMP:ITEM_TRAPCOMP_ENORMOUSCORKSCREW material
  • Giant axe blade
TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE material

Tools

  • Nest box
TOOL:ITEM_TOOL_NEST_BOX material

Furniture

Format:

createitem Item token (from list below) Material

"Material" is the same as the material used to create basic items (e.g. logs, boulders, bars, etc.)

Item Item token
Armor stand ARMORSTAND
Bag BOX
Bed BED
Box BOX
Cabinet CABINET
Cage CAGE
Chair CHAIR
Chest BOX
Coffer
Coffin COFFIN
Door DOOR
Floodgate FLOODGATE
Grate GRATE
Hatch cover HATCH_COVER
Mechanisms TRAPPARTS
Slab SLAB
Statue STATUE
Table TABLE
Traction bench TRACTION_BENCH
Weapon rack WEAPONRACK

Animal products

Cloth/leather

  • Yarn (creature must be able to produce wool):
CLOTH CREATURE_MAT:creature:HAIR
  • Silk (creature must be able to produce silk):
CLOTH CREATURE_MAT:creature:SILK
  • Plant fiber (only works with appropriate plants):
CLOTH PLANT_MAT:plant:THREAD

(Example: createitem CLOTH PLANT_MAT:GRASS_TAIL_PIG:THREAD 1)

  • Leather (tanned):
SKIN_TANNED CREATURE_MAT:creature:LEATHER

Shells

  • Shells (when demanded for moods, for example) are body parts and cannot be created directly. But it is possible to create a raw fish, then process it in a fishery:
FISH_RAW creature:caste

Example:

createitem FISH_RAW POND_TURTLE:MALE

Plant products

Seeds

  • Seeds for farming:
SEEDS PLANT_MAT:plant:SEED

Mill Products

  • Flour, dyes, and sugar:
POWDER_MISC PLANT_MAT:plant:MILL

Example: createitem POWDER_MISC PLANT_MAT:MUSHROOM_CUP_DIMPLE:MILL

Note that powders will only be usable if you create them into a bag by doing "createitem item" beforehand.

Equipment

  • Flask/Waterskin/Vial:
FLASK:NONE material
  • Backpack:
BACKPACK:NONE material

Materials

Unusual materials that work for most items above

Body parts

Format:

item CREATURE_MAT:creature:material

Valid materials:

  • Edible (e.g. for MEAT items)
    • MUSCLE
    • EYE4
    • BRAIN
    • LUNG
    • HEART
    • LIVER
    • GUT
    • STOMACH
    • GIZZARD
    • PANCREAS
    • SPLEEN
    • KIDNEY
  • Craftable
    • BONE1,4
    • SHELL3
    • HOOF3
    • HORN3
    • IVORY3
    • TOOTH1
    • SILK3
    • HAIR1,4 (sometimes)
  • Processable
    • SKIN1,4
      • LEATHER
    • FAT
      • TALLOW
        • SOAP
    • MILK3
      • CHEESE
  • Useless
    • CHITIN2
    • CARTILAGE1,4
    • SPINE3
    • NERVE
    • SINEW3
    • BLOOD3
    • PUS3
    • ICHOR3
    • GOO3
    • FEATHER3
    • SCALE3
    • CLAW3
    • NAIL3
    • TALON3
1 - only present on standard creatures
2 - only present on chitinous creatures
3 - only present on some creatures
4 - missing from some creatures