From b1916f16b191e975d56900101c21a2b7d99b2443 Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 18 Jul 2022 13:59:11 -0700 Subject: [PATCH] update docs for autogems --- docs/plugins/autogems-reload.rst | 9 +++++++++ docs/plugins/autogems.rst | 13 +++++++++---- plugins/autogems.cpp | 20 ++------------------ 3 files changed, 20 insertions(+), 22 deletions(-) create mode 100644 docs/plugins/autogems-reload.rst diff --git a/docs/plugins/autogems-reload.rst b/docs/plugins/autogems-reload.rst new file mode 100644 index 000000000..a37117746 --- /dev/null +++ b/docs/plugins/autogems-reload.rst @@ -0,0 +1,9 @@ +autogems-reload +=============== + +Reloads the autogems configuration file. You might need to do this if you have +manually modified the contents while the game is running. + +Usage:: + + autogems-reload diff --git a/docs/plugins/autogems.rst b/docs/plugins/autogems.rst index 59800e1b9..ad3b0f9c3 100644 --- a/docs/plugins/autogems.rst +++ b/docs/plugins/autogems.rst @@ -1,7 +1,12 @@ autogems ======== -Creates a new Workshop Order setting, automatically cutting rough gems -when `enabled `. -See `gui/autogems` for a configuration UI. If necessary, the ``autogems-reload`` -command reloads the configuration file produced by that script. +Automatically cut rough gems. This plugin periodically scans your stocks of +rough gems and creates manager orders for cutting them at a Jeweler's Workshop. + +Usage:: + + enable autogems + +Run `gui/autogems` for a configuration UI, or access the new ``Auto Cut Gems`` +option from the Current Workshop Orders screen (:kbd:`o`-:kbd:`W`). diff --git a/plugins/autogems.cpp b/plugins/autogems.cpp index fcd8fcdc7..d296caf7f 100644 --- a/plugins/autogems.cpp +++ b/plugins/autogems.cpp @@ -41,19 +41,6 @@ typedef int32_t mat_index; typedef std::map gem_map; bool running = false; -const char *tagline = "Creates a new Workshop Order setting, automatically cutting rough gems."; -const char *usage = ( - " enable autogems\n" - " Enable the plugin.\n" - " disable autogems\n" - " Disable the plugin.\n" - "\n" - "While enabled, the Current Workshop Orders screen (o-W) have a new option:\n" - " g: Auto Cut Gems\n" - "\n" - "While this option is enabled, jobs will be created in Jeweler's Workshops\n" - "to cut any accessible rough gems.\n" -); std::set blacklist; void add_task(mat_index gem_type, df::building_workshopst *workshop) { @@ -385,11 +372,8 @@ DFhackCExport command_result plugin_enable(color_ostream& out, bool enable) { DFhackCExport command_result plugin_init(color_ostream &out, std::vector &commands) { commands.push_back(PluginCommand( "autogems-reload", - "Reload autogems config file", - cmd_reload_config, - false, - "Reload autogems config file" - )); + "Reload autogems config file.", + cmd_reload_config)); return CR_OK; }