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

Add basic embark-assistant docs (closes #1226)

develop
lethosor 2018-02-11 03:08:02 -05:00
parent 269d575267
commit 6260062d05
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Plugins.rst
Unescape Escape View File

@ -526,6 +526,18 @@ nopause
Disables pausing (both manual and automatic) with the exception of pause forced Disables pausing (both manual and automatic) with the exception of pause forced
by `reveal` ``hell``. This is nice for digging under rivers. by `reveal` ``hell``. This is nice for digging under rivers.
.. _embark-assistant:
embark-assistant
================
This plugin provides embark site selection help. It has to be run with the
``embark-assistant`` command while the pre-embark screen is displayed and shows
extended (and correct(?)) resource information for the embark rectangle as well
as normally undisplayed sites in the current embark region. It also has a site
selection tool with more options than DF's vanilla search tool. For detailed
help invoke the in game info screen. Requires 42 lines to display properly.
.. _embark-tools: .. _embark-tools:
embark-tools embark-tools

2
plugins/embark-assistant/embark-assistant.cpp
Unescape Escape View File

@ -138,7 +138,7 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
embark_assistant, true, /* true means that the command can't be used from non-interactive user interface */ embark_assistant, true, /* true means that the command can't be used from non-interactive user interface */
// Extended help string. Used by CR_WRONG_USAGE and the help command: // Extended help string. Used by CR_WRONG_USAGE and the help command:
" This command starts the embark-assist plugin that provides embark site\n" " This command starts the embark-assist plugin that provides embark site\n"
" selection help. It has to be called while th pre embark screen is\n" " selection help. It has to be called while the pre-embark screen is\n"
" displayed and shows extended (and correct(?)) resource information for\n" " displayed and shows extended (and correct(?)) resource information for\n"
" the embark rectangle as well as normally undisplayed sites in the\n" " the embark rectangle as well as normally undisplayed sites in the\n"
" current embark region. It also has a site selection tool with more\n" " current embark region. It also has a site selection tool with more\n"