update docs for infiniteSky

develop
myk002 2022-07-25 22:00:56 -07:00
parent 69d88a62dd
commit 06fc84fb39
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 13 additions and 19 deletions

@ -1,14 +1,20 @@
infiniteSky infiniteSky
=========== ===========
Automatically allocates new z-levels of sky at the top of the map as you build up, Tags:
or on request allocates many levels all at once. :dfhack-keybind:``
Automatically allocates new z-levels of sky at the top of the map as you build
up, or on request allocates many levels all at once.
Usage: Usage:
``infiniteSky n`` ``enable infiniteSky``
Raise the sky by n z-levels. Enables monitoring of constructions. If you build anything in the second
``infiniteSky enable/disable`` highest z-level, it will allocate one more sky level. You can build stairs
Enables/disables monitoring of constructions. If you build anything in the second to highest z-level, it will allocate one more sky level. This is so you can continue to build stairs upward. up as high as you like!
``infiniteSky [<n>]``
Raise the sky by n z-levels. If run without parameters, raises the sky by
one z-level.
.. warning:: .. warning::

@ -33,19 +33,7 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"infiniteSky", "infiniteSky",
"Creates new sky levels on request, or as needed.", "Creates new sky levels on request, or as needed.",
infiniteSky, false, infiniteSky));
"Usage:\n"
" infiniteSky\n"
" creates one more z-level\n"
" infiniteSky [n]\n"
" creates n more z-level(s)\n"
" infiniteSky enable\n"
" enables monitoring of constructions\n"
" infiniteSky disable\n"
" disable monitoring of constructions\n"
"\n"
"If construction monitoring is enabled, then the plugin will automatically create new sky z-levels as you construct upward.\n"
));
return CR_OK; return CR_OK;
} }