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

update docs for embark-tools

develop
myk002 2022-07-24 23:59:04 -07:00
parent d94fef36ff
commit 02cc085a43
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
3 changed files with 31 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/plugins/embark-assistant.rst
Unescape Escape View File

@ -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. with far more options than DF's vanilla search tool.
If you enable the plugin, you'll also be able to invoke ``embark-assistant`` 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:: Usage::

36
docs/plugins/embark-tools.rst
Unescape Escape View File

@ -1,12 +1,32 @@
embark-tools 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.
<embark-tools; Extend the embark screen functionality.>`
:anywhere: Allows embarking anywhere (including sites, mountain-only biomes, Usage::
and oceans). Use with caution.
:mouse: Implements mouse controls (currently in the local embark region only) enable embark-tools
:sand: Displays an indicator when sand is present in the currently-selected embark-tools enable|disable all
area, similar to the default clay/stone indicators. embark-tools enable|disable <tool> [<tool> ...]
:sticky: Maintains the selected local area while navigating the world map
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.

14
plugins/embark-tools.cpp
Unescape Escape View File

@ -752,20 +752,10 @@ DFhackCExport command_result plugin_init (color_ostream &out, std::vector <Plugi
add_tool(new MouseControl); add_tool(new MouseControl);
add_tool(new SandIndicator); add_tool(new SandIndicator);
add_tool(new StablePosition); add_tool(new StablePosition);
std::string help = "";
help += "embark-tools (enable/disable) tool [tool...]\n"
"Tools:\n";
FOR_ITER_TOOLS(iter)
{
help += (" " + iter->second->getId() + ": " + iter->second->getDesc() + "\n");
}
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"embark-tools", "embark-tools",
"A collection of embark tools", "Extend the embark screen functionality.",
embark_tools_cmd, embark_tools_cmd));
false,
help.c_str()
));
return CR_OK; return CR_OK;
} }