2022-07-10 00:01:46 -06:00
|
|
|
stockpiles
|
|
|
|
|
==========
|
2022-08-09 23:37:24 -06:00
|
|
|
|
|
|
|
|
.. dfhack-tool::
|
2023-03-15 18:16:42 -06:00
|
|
|
:summary: Import, export, or modify stockpile settings and features.
|
2023-03-05 17:21:28 -07:00
|
|
|
:tags: fort design productivity stockpiles
|
2022-08-09 23:37:24 -06:00
|
|
|
|
2023-03-15 18:16:42 -06:00
|
|
|
If you are importing or exporting setting and don't want to specify a building
|
|
|
|
|
ID, select a stockpile in the UI before running the command.
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-08-17 23:42:02 -06:00
|
|
|
Usage
|
|
|
|
|
-----
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2023-03-15 18:16:42 -06:00
|
|
|
::
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2023-03-15 18:16:42 -06:00
|
|
|
stockpiles [status]
|
|
|
|
|
stockpiles list [<search>]
|
|
|
|
|
stockpiles export <name> [<options>]
|
|
|
|
|
stockpiles import <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, underscores, dashes, and spaces. If
|
|
|
|
|
the name has spaces, be sure to surround it with double quotes (:kbd:`"`).
|
|
|
|
|
|
|
|
|
|
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-10 00:01:46 -06:00
|
|
|
|
2022-07-31 14:29:53 -06:00
|
|
|
Examples
|
|
|
|
|
--------
|
|
|
|
|
|
2023-03-15 18:16:42 -06:00
|
|
|
``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.
|
|
|
|
|
``stockpiles export mysettings``
|
|
|
|
|
Export the settings for the currently selected stockpile to a file named
|
|
|
|
|
``dfhack-config/stockpiles/mysettings.dfstock``.
|
|
|
|
|
|
|
|
|
|
Options
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
``-s``, ``--stockpile <id>``
|
|
|
|
|
Specify a specific stockpile ID instead of using the one currently selected
|
|
|
|
|
in the UI.
|
|
|
|
|
|
|
|
|
|
.. _stockpiles-library:
|
|
|
|
|
|
|
|
|
|
The stockpiles settings library
|
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
|
|
DFHack comes with a library of useful stockpile settings files that are ready
|
|
|
|
|
for import:
|
|
|
|
|
|
|
|
|
|
TODO: port alias library here
|
