diff --git a/docs/plugins/stocks.rst b/docs/plugins/stocks.rst index 404c96a6d..076f2ab6f 100644 --- a/docs/plugins/stocks.rst +++ b/docs/plugins/stocks.rst @@ -1,5 +1,20 @@ stocks ====== -Replaces the DF stocks screen with an improved version. - +Tags: :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. diff --git a/plugins/stocks.cpp b/plugins/stocks.cpp index 7c715d956..62c13dcd5 100644 --- a/plugins/stocks.cpp +++ b/plugins/stocks.cpp @@ -1469,10 +1469,10 @@ static command_result stocks_cmd(color_ostream &out, vector & parameter DFhackCExport command_result plugin_init (color_ostream &out, std::vector &commands) { - commands.push_back( - PluginCommand( - "stocks", "An improved stocks display screen", - stocks_cmd, false, "Run 'stocks show' open the stocks display screen, or 'stocks version' to query the plugin version.")); + commands.push_back(PluginCommand( + "stocks", + "An improved stocks management screen.", + stocks_cmd)); ViewscreenStocks::reset();