update docs for resume

develop
myk002 2022-07-29 17:12:01 -07:00
parent a7011421b4
commit c6d5fcb378
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 16 additions and 14 deletions

@ -1,4 +1,15 @@
resume
======
Allows automatic resumption of suspended constructions, along with colored
UI hints for construction status.
Tags:
:dfhack-keybind:``
Color planned buildings based on their suspend status. When enabled, this plugin
will display a colored 'X' over suspended buildings. When run as a command, it
can resume all suspended building jobs, allowing you to quickly recover if a
bunch of jobs were suspended due to the workers getting scared off by wildlife
or items temporarily blocking buildling sites.
Usage::
enable resume
resume all

@ -302,18 +302,9 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
{
commands.push_back(
PluginCommand(
"resume", "Display and easily resume suspended constructions",
resume_cmd, false,
"resume show\n"
" Show overlay when paused:\n"
" Yellow: Suspended construction\n"
" Red: Suspended after resume attempt, possibly stuck\n"
" Green: Planned building waiting for materials\n"
"resume hide\n"
" Hide overlay\n"
"resume all\n"
" Resume all suspended building constructions\n"
));
"resume",
"Mark suspended constructions on the map and easily resume them.",
resume_cmd));
return CR_OK;
}