diff --git a/docs/plugins/automelt.rst b/docs/plugins/automelt.rst index 9abe2cc9c..4a3bc6e60 100644 --- a/docs/plugins/automelt.rst +++ b/docs/plugins/automelt.rst @@ -6,9 +6,9 @@ automelt :tags: untested fort productivity items stockpiles :no-command: -When `enabled `, this plugin adds an option to the :kbd:`q` menu for -stockpiles. When the ``automelt`` option is selected for the stockpile, any -items placed in the stockpile will automatically be designated to be melted. +Automelt checks monitor-enabled stockpiles once every in-game day, and will mark valid items for melting. + +Please see `gui/automelt` for the interactive configuration dialog. Usage ----- @@ -16,3 +16,31 @@ Usage :: enable automelt + automelt [status] + automelt (designate) + automelt (monitor|nomonitor) + +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 `` + Enable/disable monitoring of a given stockpile. Requires the stockpile to have a name set. \ No newline at end of file