dfhack/docs/plugins/stockpiles.rst

42 lines
1.1 KiB
ReStructuredText

.. _stocksettings:
stockpiles
==========
.. dfhack-tool::
:summary: Import and export stockpile settings.
2023-03-05 17:21:28 -07:00
:tags: fort design productivity stockpiles
:no-command:
.. dfhack-command:: savestock
:summary: Exports the configuration of the selected stockpile.
.. dfhack-command:: loadstock
2023-03-05 17:21:28 -07:00
:summary: Imports configuration for the selected stockpile.
2023-03-05 17:21:28 -07:00
Select a stockpile in the UI first to use these commands.
2022-08-17 23:42:02 -06:00
Usage
-----
2022-07-31 14:29:53 -06:00
``savestock <filename>``
Saves the currently highlighted stockpile's settings to a file in your
Dwarf Fortress folder. This file can be used to copy settings between game
saves or players.
``loadstock <filename>``
Loads a saved stockpile settings file and applies it to the currently
selected stockpile.
2022-07-31 14:29:53 -06:00
Filenames with spaces are not supported. Generated materials, divine metals,
etc. are not saved as they are different in every world.
2022-07-31 14:29:53 -06:00
Examples
--------
2023-03-05 17:21:28 -07:00
``savestock food``
Export the stockpile settings for the currently selected stockpile to a
file named ``food.dfstock``.
``loadstock food``
Set the selected stockpile settings to those saved in the ``food.dfstock``
file.