update docs for automelt

develop
myk002 2022-07-18 16:13:20 -07:00
parent 0ba3a4684b
commit fd84fdce73
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 12 additions and 6 deletions

@ -1,5 +1,11 @@
automelt
========
When automelt is enabled for a stockpile, any meltable items placed
in it will be designated to be melted.
This plugin adds an option to the :kbd:`q` menu when `enabled <enable>`.
Quickly designate items to be melted. When `enabled <enable>`, 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.
Usage::
enable automelt

@ -297,9 +297,9 @@ DFhackCExport command_result plugin_enable(color_ostream &out, bool enable)
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{
commands.push_back(
PluginCommand(
"automelt", "Automatically melt metal items in marked stockpiles.",
automelt_cmd, false, ""));
PluginCommand("automelt",
"Automatically melt metal items in marked stockpiles.",
automelt_cmd));
return CR_OK;
}