diff --git a/docs/plugins/embark-assistant.rst b/docs/plugins/embark-assistant.rst index 4500a919e..88f59efab 100644 --- a/docs/plugins/embark-assistant.rst +++ b/docs/plugins/embark-assistant.rst @@ -1,9 +1,22 @@ embark-assistant ================ +Tags: +:dfhack-keybind:`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. +:index:`Embark site selection support. +` Run this command while the +pre-embark screen is displayed to show extended (and correct(?)) resource +information for the embark rectangle as well as normally undisplayed sites in +the current embark region. You will also have access to a site selection tool +with far more options than DF's vanilla search tool. + +If you enable the plugin, you'll also be able to invoke ``embark-assistant`` +with the :kdb:`A` key on the pre-embark screen. + +Usage:: + + enable embark-assistant + embark-assistant + +Note the site selection tool requires a display height of at least 46 lines to +display properly. diff --git a/plugins/embark-assistant/embark-assistant.cpp b/plugins/embark-assistant/embark-assistant.cpp index 61a1b4f83..b7afe494b 100644 --- a/plugins/embark-assistant/embark-assistant.cpp +++ b/plugins/embark-assistant/embark-assistant.cpp @@ -178,17 +178,9 @@ IMPLEMENT_VMETHOD_INTERPOSE(start_site_hook, feed); DFhackCExport command_result plugin_init (color_ostream &out, std::vector &commands) { commands.push_back(PluginCommand( - "embark-assistant", "Embark site selection support.", - embark_assistant, false, /* false means that the command can be used from non-interactive user interface */ - // Extended help string. Used by CR_WRONG_USAGE and the help command: - " This command starts the embark-assist plugin that provides embark site\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" - " 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" - " options than DF's vanilla search tool. For detailed help invoke the\n" - " in game info screen. Prefers 46 lines to display properly.\n" - )); + "embark-assistant", + "Embark site selection support.", + embark_assistant)); return CR_OK; }