MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs for autogems

develop
myk002 2022-07-18 13:59:11 -07:00
parent 3ca7997d3e
commit b1916f16b1
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
3 changed files with 20 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/plugins/autogems-reload.rst
Unescape Escape View File

@ -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

13
docs/plugins/autogems.rst
Unescape Escape View File

@ -1,7 +1,12 @@
autogems
========
Creates a new Workshop Order setting, automatically cutting rough gems
when `enabled <enable>`.
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`).

20
plugins/autogems.cpp
Unescape Escape View File

@ -41,19 +41,6 @@ typedef int32_t mat_index;
typedef std::map<mat_index, int> 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<mat_index> 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 <PluginCommand> &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;
}