Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 2.29 KB

File metadata and controls

90 lines (65 loc) · 2.29 KB

combine

.. dfhack-tool::
    :summary: Combine items that can be stacked together.
    :tags: fort productivity items plants stockpiles

Usage

combine (all|here) [<options>]

Examples

combine
Displays help
combine all --dry-run
Preview stack changes for all types in all stockpiles.
combine all
Merge stacks for all stockpile and all types
combine all --types=meat,plant
Merge meat and plant type stacks in all stockpiles.
combine here
Merge stacks in the selected stockpile.

Commands

all
Search all stockpiles.
here
Search the currently selected stockpile.

Options

-h, --help
Prints help text. Default if no options are specified.
-d, --dry-run
Display the stack changes without applying them.
-t, --types <comma separated list of types>

Filter item types. Default is all. Valid types are:

all: all of the types listed here.

ammo: AMMO

drink: DRINK

fat: GLOB and CHEESE

fish: FISH, FISH_RAW and EGG

food: FOOD

meat: MEAT

parts: CORPSEPIECE

plant: PLANT and PLANT_GROWTH

powders: POWDERS_MISC

seed: SEEDS

-q, --quiet
Only print changes instead of a summary of all processed stockpiles.
-v, --verbose n
Print verbose output, n from 1 to 4.

Notes

The following conditions prevent an item from being combined:
  1. An item is not in a stockpile.
  2. An item is sand or plaster.
  3. An item is rotten, forbidden/hidden, marked for dumping/melting, on fire, encased, owned by a trader/hostile/dwarf or is in a spider web.
  4. An item is part of a corpse and not butchered.
The following categories are defined:
  1. Corpse pieces, grouped by piece type and race
  2. Items that have an associated race/caste, grouped by item type, race, and caste
  3. Ammo, grouped by ammo type, material, and quality. If the ammo is a masterwork, it is also grouped by who created it.
  4. Anything else, grouped by item type and material

Each category has a default stack size of 30 unless a larger stack already exists "naturally" in your fort. In that case the largest existing stack size is used.