diff --git a/docs/plugins/stockpiles.rst b/docs/plugins/stockpiles.rst index 000527ce5..76d52117d 100644 --- a/docs/plugins/stockpiles.rst +++ b/docs/plugins/stockpiles.rst @@ -2,27 +2,41 @@ stockpiles ========== -Offers the following commands to save and load stockpile settings. -See `gui/stockpiles` for an in-game interface. +Tags: +:dfhack-keybind:`copystock` +:dfhack-keybind:`savestock` +:dfhack-keybind:`loadstock` -: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. - :dfhack-keybind:`copystock` +Import and export stockpile settings. 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. -: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 saves or - players. e.g.: ``savestock food_settings.dfstock`` +Usage: -:loadstock: Loads a saved stockpile settings file and applies it to the currently selected - stockpile. e.g.: ``loadstock food_settings.dfstock`` +``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 + saves or players. +``loadstock `` + Loads a saved stockpile settings file and applies it to the currently + selected stockpile. -To use savestock and loadstock, use the :kbd:`q` command to highlight a stockpile. -Then run savestock giving it a descriptive filename. Then, in a different (or -the same!) gameworld, you can highlight any stockpile with :kbd:`q` then execute the -``loadstock`` command passing it the name of that file. The settings will be -applied to that stockpile. +Filenames with spaces are not supported. Generated materials, divine metals, +etc. are not saved as they are different in every world. -Note that files are relative to the DF folder, so put your files there or in a -subfolder for easy access. Filenames should not have spaces. Generated materials, -divine metals, 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. diff --git a/plugins/stockpiles/stockpiles.cpp b/plugins/stockpiles/stockpiles.cpp index 05e5c9f96..aa36e20bd 100644 --- a/plugins/stockpiles/stockpiles.cpp +++ b/plugins/stockpiles/stockpiles.cpp @@ -61,39 +61,21 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector : filename to save stockpile settings to (will be overwritten!)\n" - ) - ); - commands.push_back ( - PluginCommand ( - "loadstock", "Load and apply stockpile settings from a file.", - loadstock, loadstock_guard, - "Must be in 'q' mode and have a stockpile selected.\n" - "example: 'loadstock food.dfstock' will load the settings from 'food.dfstock'\n" - "in your stockpile folder and apply them to the selected stockpile.\n" - " -d, --debug: enable debug output\n" - " : filename to load stockpile settings from\n" - ) - ); + commands.push_back(PluginCommand( + "copystock", + "Copy stockpile under cursor.", + copystock, + copystock_guard)); + commands.push_back(PluginCommand( + "savestock", + "Save the active stockpile's settings to a file.", + savestock, + savestock_guard)); + commands.push_back(PluginCommand( + "loadstock", + "Load and apply stockpile settings from a file.", + loadstock, + loadstock_guard)); } return CR_OK;