update docs for autochop

develop
myk002 2022-07-18 12:52:38 -07:00
parent 5ff31e0cc1
commit 51c817191c
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 16 additions and 13 deletions

@ -1,16 +1,20 @@
autochop autochop
======== ========
Automatically manage tree cutting designation to keep available logs withing given
quotas.
Open the dashboard by running:: Auto-harvest trees when low on stockpiled logs. This plugin can designate trees
for chopping when your stocks are low on logs.
Usage::
enable autochop enable autochop
The plugin must be activated (with :kbd:`d`-:kbd:`t`-:kbd:`c`-:kbd:`a`) before Then, open the settings menu with :kbd:`c` from the designations menu (the
it can be used. You can then set logging quotas and restrict designations to option appears when you have "Chop Down Trees" selected with :kbd:`d`-:kbd:`t`).
specific burrows (with 'Enter') if desired. The plugin's activity cycle runs
once every in game day. Set your desired thresholds and enable autochopping with :kbd:`a`.
You can also restrict autochopping to specific burrows. Highlight a burrow name
with the Up/Down arrow keys and hit :kbd:`Enter` to mark it as the autochop
burrrow.
If you add ``enable autochop`` to your dfhack.init there will be a hotkey to Autochop checks your stock of logs and designates trees once every in game day.
open the dashboard from the chop designation menu.

@ -935,10 +935,9 @@ DFhackCExport command_result plugin_enable(color_ostream &out, bool enable)
DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"autochop", "Auto-harvest trees when low on stockpiled logs", "autochop",
df_autochop, false, "Auto-harvest trees when low on stockpiled logs.",
"Opens the automated chopping control screen. Specify 'debug' to forcibly save settings.\n" df_autochop));
));
initialize(); initialize();
return CR_OK; return CR_OK;