dfhack/docs/plugins/stockpiles.rst

521 lines
12 KiB
ReStructuredText

stockpiles
==========
.. dfhack-tool::
:summary: Import, export, or modify stockpile settings.
2023-03-05 17:21:28 -07:00
:tags: fort design productivity stockpiles
Commands act upon the stockpile selected in the UI unless another stockpile
identifier is specified on the commandline.
2022-08-17 23:42:02 -06:00
Usage
-----
::
stockpiles [status]
stockpiles list [<search>]
stockpiles import <name> [<options>]
stockpiles export <name> [<options>]
Exported stockpile settings are saved in the ``dfhack-config/stockpiles``
folder, where you can view and delete them, if desired. Names can only
contain numbers, letters, periods, and underscores.
The names of library settings files are all prefixed by the string ``library/``.
You can specify library files explicitly by including the prefix, or you can
just write the short name to use a player-exported file by that name if it
exists, and the library file if it doesn't.
2022-07-31 14:29:53 -06:00
Examples
--------
``stockpiles``
Shows the list of all your stockpiles and some relevant statistics.
``stockpiles list``
Shows the list of previously exported stockpile settings files, including
the stockpile configuration library.
``stockpiles list plants``
Shows the list of exported stockpile settings files that include the
substring ``plants``.
``stockpiles import library/plants``
Imports the library ``plants`` settings file into the currently selected
stockpile.
``stockpiles import plants``
Imports a player-exported settings file named ``plants``, or the library
``plants`` settings file if a player-exported file by that name doesn't
exist.
2023-03-20 20:21:44 -06:00
``stockpiles import -m enable plants``
Enables plants in the selected stockpile.
2023-03-21 01:19:49 -06:00
``stockpiles import -m disable cat_food -f tallow``
2023-03-20 20:21:44 -06:00
Disables all tallow in the selected food stockpile.
``stockpiles export mysettings``
Export the settings for the currently selected stockpile to a file named
``dfhack-config/stockpiles/mysettings.dfstock``.
2023-03-20 20:21:44 -06:00
``stockpiles export mysettings -i categories,types``
Export the stockpile category and item settings, but ignore the container
and general settings. This allows you to import the configuration later
without touching the container and general settings of the target
stockpile.
Options
-------
``-s``, ``--stockpile <name or id>``
Specify a specific stockpile by name or internal ID instead of using the
stockpile currently selected in the UI.
2023-03-15 19:04:46 -06:00
``-i``, ``--include <comma separated list of elements to include>``
When exporting, you can include this option to select only specific elements
of the stockpile to record. If not specified, everything is included. When
the file is later imported, only the included settings will be modified. The
options are explained below in the next section.
2023-03-15 22:54:48 -06:00
``-m``, ``--mode (set|enable|disable)``
When importing, choose the algorithm used to apply the settings. In ``set``
mode (the default), the stockpile is cleared and the settings in the file
are enabled. In ``enable`` mode, enabled settings in the file are *added*
to the stockpile, but no other settings are changed. In ``disable`` mode,
enabled settings in the file are *removed* from the current stockpile
configuration, and nothing else is changed.
2023-03-21 00:25:52 -06:00
``-f``, ``--filter <search>[,<search>...]``
When importing, only modify the settings that contain at least one of the
given substrings.
2023-03-15 19:04:46 -06:00
Configuration elements
----------------------
2023-03-21 00:25:52 -06:00
The different configuration elements you can include in an exported settings
file are:
2023-03-15 19:04:46 -06:00
2023-03-15 22:54:48 -06:00
:containers: Max bins, max barrels, and num wheelbarrows.
:general: Whether the stockpile takes from links only and whether organic
and/or inorganic materials are allowed.
:categories: The top-level categories of items that are enabled for the
stockpile, like Ammo, Finished goods, or Stone.
2023-03-15 19:04:46 -06:00
:types: The elements below the categories, which include the sub-categories, the
specific item types, and any toggles the category might have (like Prepared
meals for the Food category).
2023-09-01 19:45:50 -06:00
Overlay
-------
This plugin provides a panel that appears when you select a stockpile via an
`overlay` widget. You can use it to easily toggle `logistics` plugin features
like autotrade, automelt, or autotrain.
.. _stockpiles-library:
The stockpiles settings library
-------------------------------
DFHack comes with a library of useful stockpile settings files that are ready
2023-03-20 20:21:44 -06:00
for import. If the stockpile configuration that you need isn't directly
represented, you can often use the ``enable`` and ``disable`` modes and/or
the ``filter`` option to transform an existing saved stockpile setting. Some
2023-03-21 00:25:52 -06:00
stockpile configurations can only be achieved with filters since the stockpile
lists are different for each world. For example, to disable all tallow in your
main food stockpile, you'd run this command::
2023-03-20 20:21:44 -06:00
2023-03-21 01:19:49 -06:00
stockpiles import cat_food -m disable -f tallow
2023-03-20 20:21:44 -06:00
Top-level categories
~~~~~~~~~~~~~~~~~~~~
Each stockpile category has a file that allows you to enable or disable the
entire category, or with a filter, any matchable subset thereof::
2023-03-21 01:19:49 -06:00
cat_ammo
cat_animals
cat_armor
cat_bars_blocks
cat_cloth
cat_coins
cat_corpses
cat_finished_goods
cat_food
cat_furniture
cat_gems
cat_leather
cat_refuse
cat_sheets
cat_stone
cat_weapons
cat_wood
2023-05-28 06:37:29 -06:00
In addition, there are files for ``all``, which includes all categories except
refuse and corpses (mirroring the "all" configuration in-game), and
``everything``, which really includes all categories.
2023-05-28 06:37:29 -06:00
For many of the categories, there are also flags, subcategory prefixes, and
item properties that you can match with filters. In addition, there are
normally at least a few convenient pre-made settings files that manipulate
interesting category subsets.
2023-03-20 20:21:44 -06:00
2023-06-07 12:57:16 -06:00
Cross-category stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Settings files::
artifacts
masterworks
Example command for a meltable weapons stockpile::
stockpiles import cat_weapons
stockpiles import -m disable cat_weapons -f other/
stockpiles import -m disable artifacts
stockpiles import -m disable masterworks
2023-03-20 20:21:44 -06:00
Ammo stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 00:25:52 -06:00
Subcategory prefixes::
type/
mats/
other/
core/
total/
2023-03-21 01:19:49 -06:00
Settings files::
2023-03-21 00:25:52 -06:00
bolts
metalammo
boneammo
woodammo
Example commands for a stockpile of metal bolts::
2023-03-21 01:19:49 -06:00
stockpiles import cat_ammo -f mats/,core/,total/
2023-03-21 00:25:52 -06:00
stockpiles import -m enable bolts
2023-03-20 20:21:44 -06:00
Animal stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:19:49 -06:00
Flags::
cages
traps
2023-05-28 06:37:29 -06:00
Properties::
tameable
2023-03-21 01:19:49 -06:00
Settings files::
cages
traps
Example commands for a stockpile of empty cages::
stockpiles import cages
Or, using the flag for the same effect::
stockpiles import cat_animals -f cages
2023-03-20 20:21:44 -06:00
Armor stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:19:49 -06:00
Flags and subcategory prefixes::
nouse
canuse
body/
head/
feet/
hands/
legs/
shield/
mats/
other/
core/
total/
Settings files::
2023-03-20 20:21:44 -06:00
2023-03-21 01:19:49 -06:00
metalarmor
otherarmor
ironarmor
bronzearmor
copperarmor
steelarmor
usablearmor
unusablearmor
Example commands for a stockpile of sub-masterwork meltable armor::
stockpiles import cat_armor
stockpiles import -m disable -f other/,core/mas,core/art cat_armor
2023-03-20 20:21:44 -06:00
Bar stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:19:49 -06:00
Subcategory prefixes::
mats/bars/
other/bars/
mats/blocks/
other/blocks/
Settings files::
bars
metalbars
ironbars
pigironbars
steelbars
otherbars
coal
potash
ash
pearlash
soap
blocks
Example commands for a stockpile of blocks::
stockpiles import blocks
2023-03-20 20:21:44 -06:00
Cloth stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:19:49 -06:00
Subcategory prefixes::
thread/silk/
thread/plant/
thread/yarn/
thread/metal/
cloth/silk/
cloth/plant/
cloth/yarn/
cloth/metal/
Settings files::
thread
adamantinethread
cloth
adamantinecloth
2023-03-20 20:21:44 -06:00
Notes:
2023-03-21 01:19:49 -06:00
* ``thread`` and ``cloth`` settings files set all materials that are not
2023-03-21 03:13:23 -06:00
adamantine.
2023-03-20 20:21:44 -06:00
2023-05-28 06:37:29 -06:00
Corpse stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Properties::
tameable
2023-03-20 20:21:44 -06:00
Finished goods stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Subcategory prefixes::
type/
mats/
other/
core/
total/
Settings files::
stonetools
woodtools
crafts
goblets
toys
Example commands for a toy stockpile::
2023-05-28 06:37:29 -06:00
stockpiles import cat_finished_goods -f mats/,other/,core/,total/
2023-03-21 01:46:21 -06:00
stockpiles import -m enable toys
2023-03-20 20:21:44 -06:00
Food stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Flags and subcategory prefixes::
preparedmeals
meat/
fish/prepared/
fish/unprepared/
egg/
plants/
drink/plant/
drink/animal/
cheese/plant/
cheese/animal/
seeds/
leaves/
powder/plant/
powder/animal/
glob/
liquid/plant/
liquid/animal/
liquid/misc/
paste/
pressed/
Settings files::
preparedmeals
unpreparedfish
plants
booze
seeds
dye
miscliquid
wax
Example commands for a kitchen ingredients stockpile::
stockpiles import cat_food -f meat/,fish/prepared/,egg/,cheese/,leaves/,powder/,glob/,liquid/plant/,paste/,pressed/
stockpiles import cat_food -m enable -f milk,royal_jelly
stockpiles import dye -m disable
stockpiles import cat_food -m disable -f tallow,thread,liquid/misc/
2023-03-20 20:21:44 -06:00
Furniture stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Subcategory prefixes::
type/
mats/
other/
core/
total/
Settings files::
pots
2023-06-05 05:17:13 -06:00
barrels
2023-03-21 01:46:21 -06:00
bags
buckets
sand
2023-03-20 20:21:44 -06:00
* Because of the limitations of Dwarf Fortress, ``bags`` cannot distinguish
between empty bags and bags filled with gypsum powder.
2023-03-21 01:46:21 -06:00
Example commands for a sand bag stockpile::
stockpiles import cat_furniture
stockpiles import cat_furniture -m disable -f type/
stockpiles import sand -m enable
2023-03-20 20:21:44 -06:00
Gem stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Subcategory prefixes::
mats/rough/
mats/cut/
other/rough/
other/cut/
Settings files::
roughgems
roughglass
cutgems
cutglass
cutstone
2023-03-20 20:21:44 -06:00
Refuse stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Flags and subcategory prefixes::
rawhide/fresh
rawhide/rotten
type/
corpses/
bodyparts/
skulls/
bones/
hair/
shells/
teeth/
horns/
2023-05-28 06:37:29 -06:00
Properties::
tameable
2023-03-21 01:46:21 -06:00
Settings files::
rawhides
tannedhides
usablehair
2023-03-20 20:21:44 -06:00
Notes:
* ``usablehair`` Only hair and wool that can make usable clothing is included,
i.e. from sheep, llamas, alpacas, and trolls.
2023-03-21 01:46:21 -06:00
Example commands for a craftable refuse stockpile::
2023-03-20 20:21:44 -06:00
2023-03-21 01:46:21 -06:00
stockpiles import cat_refuse -f skulls/,bones/,shells',teeth/,horns/
2023-03-20 20:21:44 -06:00
stockpiles import usablehair -m enable
2023-03-21 01:46:21 -06:00
Sheet stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Subcategory prefixes::
paper/
parchment/
2023-03-20 20:21:44 -06:00
Stone stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Settings files::
metalore
ironore
economic
flux
plasterproducing
coalproducing
otherstone
bauxite
clay
2023-03-20 20:21:44 -06:00
Weapon stockpile adjustments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2023-03-21 01:46:21 -06:00
Flags and subcategory prefixes::
nouse
canuse
type/weapon/
type/trapcomp/
mats/
other/
core/
total/
Settings files::
metalweapons
stoneweapons
otherweapons
trapcomponents
ironweapons
silverweapons
bronzeweapons
copperweapons
steelweapons
platinumweapons
adamantineweapons
usableweapons
unusableweapons
Example commands for a non-metallic trap components stockpile::
stockpiles import cat_weapons
stockpiles import cat_weapons -m disable -f type/weapon/
stockpiles metalweapons -m disable