Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Template for new versions:
# Future

## New Tools
- `stockflow`: (reinstated) queue manager jobs based on free space in stockpiles
- `smooth-movement`: smoothly animate creature, item, and vehicle movement in the fortress viewport
- `export-world-map`: Export world map data for GIS and other external tools.

Expand Down
18 changes: 8 additions & 10 deletions docs/plugins/stockflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ stockflow

.. dfhack-tool::
:summary: Queue manager jobs based on free space in stockpiles.
:tags: unavailable
:tags: fort auto workorders stockpile

With this plugin, the fortress bookkeeper can tally up free space in specific
stockpiles and queue jobs through the manager to produce items to fill the free
With this plugin, you can tally up free space in specific stockpiles and
automatically queue jobs through the manager to produce items to fill the free
space.

When the plugin is enabled, the :kbd:`q` menu of each stockpile will have two
new options:
When the plugin is enabled, selecting a stockpile in the UI will show the
stockflow overlay panel with two options:

* :kbd:`j`: Select a job to order, from an interface like the manager's screen.
* :kbd:`J`: Cycle between several options for how many such jobs to order.

Whenever the bookkeeper updates stockpile records, new work orders will
be placed on the manager's queue for each such selection, reduced by the
number of identical orders already in the queue.
About once per in-game day, new work orders will be placed on the manager's
queue for each such selection, reduced by the number of identical orders
already in the queue.

This plugin is similar to `workflow`, but uses stockpiles to manage job triggers
instead of abstract stock quantities.
Expand All @@ -31,5 +31,3 @@ Usage
Display whether the plugin is enabled.
``stockflow list``
List any work order settings for your stockpiles.
``stockflow fast``
Enqueue orders once per day instead of waiting for the bookkeeper.
2 changes: 1 addition & 1 deletion plugins/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ if(BUILD_SUPPORTED)
#dfhack_plugin(steam-engine steam-engine.cpp)
add_subdirectory(smooth-movement)
dfhack_plugin(spectate spectate.cpp LINK_LIBRARIES lua)
#dfhack_plugin(stockflow stockflow.cpp LINK_LIBRARIES lua)
dfhack_plugin(stockflow stockflow.cpp LINK_LIBRARIES lua)
add_subdirectory(stockpiles)
dfhack_plugin(stocks stocks.cpp LINK_LIBRARIES lua)
dfhack_plugin(strangemood strangemood.cpp)
Expand Down
Loading
Loading