diff --git a/docs/plugins/stockpiles.rst b/docs/plugins/stockpiles.rst index bfc378ed0..01cd3159b 100644 --- a/docs/plugins/stockpiles.rst +++ b/docs/plugins/stockpiles.rst @@ -5,32 +5,20 @@ stockpiles .. dfhack-tool:: :summary: Import and export stockpile settings. - :tags: untested fort design productivity stockpiles + :tags: fort design productivity stockpiles :no-command: -.. dfhack-command:: copystock - :summary: Copies the configuration of the selected stockpile. - .. dfhack-command:: savestock :summary: Exports the configuration of the selected stockpile. .. dfhack-command:: loadstock - :summary: Imports the configuration of the selected stockpile. + :summary: Imports configuration for the selected stockpile. -When the plugin is enabled, the :kbd:`q` menu of each stockpile will have an -option for saving or loading the stockpile settings. See `gui/stockpiles` for -an in-game interface. +Select a stockpile in the UI first to use these commands. Usage ----- -``enable stockpiles`` - Add a hotkey that you can hit to easily save and load settings from - stockpiles selected in :kbd:`q` mode. -``copystock`` - Copies the parameters of the currently highlighted stockpile to the custom - stockpile settings and switches to custom stockpile placement mode, - effectively allowing you to copy/paste stockpiles easily. ``savestock `` 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 @@ -45,9 +33,9 @@ etc. are not saved as they are different in every world. Examples -------- -``savestock food_settings.dfstock`` - Export the stockpile settings for the stockpile currently selected in - :kbd:`q` mode to a file named ``food_settings.dfstock``. -``loadstock food_settings.dfstock`` - Set the selected stockpile settings to those saved in the - ``food_settings.dfstock`` file. +``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.