diff --git a/docs/plugins/embark-assistant.rst b/docs/plugins/embark-assistant.rst index 88f59efab..3a6081655 100644 --- a/docs/plugins/embark-assistant.rst +++ b/docs/plugins/embark-assistant.rst @@ -11,7 +11,7 @@ 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. +with the :kbd:`A` key on the pre-embark screen. Usage:: diff --git a/docs/plugins/embark-tools.rst b/docs/plugins/embark-tools.rst index fcab18fc7..987b76df6 100644 --- a/docs/plugins/embark-tools.rst +++ b/docs/plugins/embark-tools.rst @@ -1,12 +1,32 @@ embark-tools ============ -A collection of embark-related tools. Usage and available tools:: +Tags: +:dfhack-keybind:`embark-tools` - embark-tools enable/disable tool [tool]... +:index:`Extend the embark screen functionality. +` -:anywhere: Allows embarking anywhere (including sites, mountain-only biomes, - and oceans). Use with caution. -:mouse: Implements mouse controls (currently in the local embark region only) -:sand: Displays an indicator when sand is present in the currently-selected - area, similar to the default clay/stone indicators. -:sticky: Maintains the selected local area while navigating the world map +Usage:: + + enable embark-tools + embark-tools enable|disable all + embark-tools enable|disable [ ...] + +Avaliable tools are: + +``anywhere`` + Allows embarking anywhere (including sites, mountain-only biomes, and + oceans). Use with caution. +``mouse`` + Implements mouse controls (currently in the local embark region only). +``sand`` + Displays an indicator when sand is present in the currently-selected area, + similar to the default clay/stone indicators. +``sticky`` + Maintains the selected local area while navigating the world map. + +Example +------- + +``embark-tools enable all`` + Enable all embark screen extensions. diff --git a/plugins/embark-tools.cpp b/plugins/embark-tools.cpp index b87295020..924def798 100644 --- a/plugins/embark-tools.cpp +++ b/plugins/embark-tools.cpp @@ -752,20 +752,10 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector second->getId() + ": " + iter->second->getDesc() + "\n"); - } commands.push_back(PluginCommand( "embark-tools", - "A collection of embark tools", - embark_tools_cmd, - false, - help.c_str() - )); + "Extend the embark screen functionality.", + embark_tools_cmd)); return CR_OK; }