Prelim. doc updates.

develop
eamondo2 2023-01-22 05:14:08 -05:00
parent 9bcd9c27bf
commit 4d876f85b7
1 changed files with 31 additions and 3 deletions

@ -6,9 +6,9 @@ automelt
:tags: untested fort productivity items stockpiles :tags: untested fort productivity items stockpiles
:no-command: :no-command:
When `enabled <enable>`, this plugin adds an option to the :kbd:`q` menu for Automelt checks monitor-enabled stockpiles once every in-game day, and will mark valid items for melting.
stockpiles. When the ``automelt`` option is selected for the stockpile, any
items placed in the stockpile will automatically be designated to be melted. Please see `gui/automelt` for the interactive configuration dialog.
Usage Usage
----- -----
@ -16,3 +16,31 @@ Usage
:: ::
enable automelt enable automelt
automelt [status]
automelt (designate)
automelt (monitor|nomonitor) <stockpile>
Examples
--------
Automatically designate all meltable items in the stockpile `melt` for melting. ::
enable automelt
automelt monitor melt
Enable monitoring for the stockpile `melt`, and mmediately designate all meltable items in monitored stockpiles for melting. ::
automelt monitor melt
automelt designate
Commands
--------
``status``
Shows current configuration and relevant statistics
``designate``
Designates items in monitored stockpiles for melting right now. This works even if ``automelt`` is not currently enabled.
``(no)monitor <stockpile>``
Enable/disable monitoring of a given stockpile. Requires the stockpile to have a name set.