update docs for stocks

develop
myk002 2022-07-31 13:30:04 -07:00
parent 5621a19278
commit e1e245b4b4
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 21 additions and 6 deletions

@ -1,5 +1,20 @@
stocks stocks
====== ======
Replaces the DF stocks screen with an improved version. Tags:
:dfhack-keybind:`stocks` :dfhack-keybind:`stocks`
Enhanced fortress stock management interface. When the plugin is enabled, two
new hotkeys become available:
* :kbd:`e` on the vanilla DF stocks screen (:kbd:`z` and then select Stocks)
will launch the fortress-wide stock management screen.
* :kbd:`i` when a stockpile is selected in :kbd:`q` mode will launch the
stockpile inventory management screen.
Usage::
enable stocks
stocks show
Running ``stocks show`` will bring you to the fortress-wide stock management
screen from whereever you are.

@ -1469,10 +1469,10 @@ static command_result stocks_cmd(color_ostream &out, vector <string> & parameter
DFhackCExport command_result plugin_init (color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init (color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back( commands.push_back(PluginCommand(
PluginCommand( "stocks",
"stocks", "An improved stocks display screen", "An improved stocks management screen.",
stocks_cmd, false, "Run 'stocks show' open the stocks display screen, or 'stocks version' to query the plugin version.")); stocks_cmd));
ViewscreenStocks::reset(); ViewscreenStocks::reset();