diff --git a/docs/Tags.rst b/docs/Tags.rst index 432632ba1..294358bd8 100644 --- a/docs/Tags.rst +++ b/docs/Tags.rst @@ -1,19 +1,20 @@ :orphan: -- `tag/adventure`: Tools that are useful while in adventure mode -- `tag/fort`: Tools that are useful while in fort mode -- `tag/legends`: Tools that are useful while in legends mode -- `tag/items`: Tools that create or modify in-game items -- `tag/units`: Tools that create or modify units -- `tag/jobs`: Tools that create or modify jobs -- `tag/labors`: Tools that deal with labor assignment -- `tag/auto`: Tools that automatically manage some aspect of your fortress -- `tag/map`: Map modification -- `tag/system`: Tools related to working with DFHack commands or the core DFHack library -- `tag/productivity`: Tools that help you do things that you could do manually, but using the tool is better and faster -- `tag/animals`: Tools that help you manage animals -- `tag/fix`: Tools that fix specific bugs -- `tag/inspection`: Tools that let you inspect game data -- `tag/buildings`: Tools that help you work wtih placing or configuring buildings and furniture -- `tag/quickfort`: Tools that are involved in creating and playing back blueprints -- `tag/dev`: Tools useful for develpers and modders +- `tag/adventure`: Tools that are useful while in adventure mode. +- `tag/fort`: Tools that are useful while in fort mode. +- `tag/legends`: Tools that are useful while in legends mode. +- `tag/items`: Tools that create or modify in-game items. +- `tag/units`: Tools that create or modify units. +- `tag/jobs`: Tools that create or modify jobs. +- `tag/labors`: Tools that deal with labor assignment. +- `tag/auto`: Tools that automatically manage some aspect of your fortress. +- `tag/map`: Map modification. +- `tag/system`: Tools related to working with DFHack commands or the core DFHack library. +- `tag/productivity`: Tools that help you do things that you could do manually, but using the tool is better and faster. +- `tag/animals`: Tools that help you manage animals. +- `tag/fix`: Tools that fix specific bugs. +- `tag/inspection`: Tools that let you inspect game data. +- `tag/buildings`: Tools that help you work wtih placing or configuring buildings and furniture. +- `tag/quickfort`: Tools that are involved in creating and playing back blueprints. +- `tag/dev`: Tools useful for develpers and modders. +- `tag/interface`: Tools that modify or extend the user interface. diff --git a/docs/plugins/mousequery.rst b/docs/plugins/mousequery.rst index 2f613acaa..eedca7646 100644 --- a/docs/plugins/mousequery.rst +++ b/docs/plugins/mousequery.rst @@ -1,16 +1,36 @@ mousequery ========== -Adds mouse controls to the DF interface, e.g. click-and-drag designations. +Tags: `tag/fort`, `tag/interface` +:dfhack-keybind:`mousequery` -Options: - -:plugin: enable/disable the entire plugin -:rbutton: enable/disable right mouse button -:track: enable/disable moving cursor in build and designation mode -:edge: enable/disable active edge scrolling (when on, will also enable tracking) -:live: enable/disable query view when unpaused -:delay: Set delay when edge scrolling in tracking mode. Omit amount to display current setting. +Adds mouse controls to the DF interface. For example, with ``mousequery`` you +can click on buildings to configure them, hold the mouse button to draw dig +designations, or click and drag to move the map around. Usage:: - mousequery [plugin] [rbutton] [track] [edge] [live] [enable|disable] + enable mousequery + mousequery [rbutton|track|edge|live] [enable|disable] + mousequery drag [left|right|disable] + mousequery delay [] + +:rbutton: When the right mouse button is clicked, cancel out of menus or + scroll the main map if you r-click near an edge. +:track: Move the cursor with the mouse instead of the cursor keys when you + are in build or designation modes. +:edge: Scroll the map when you move the cursor to a map edge. See ``delay`` + below. If enabled also enables ``track``. +:delay: Set delay in milliseconds for map edge scrolling. Omit the amount to + display the current setting. +:live: Display information in the lower right corner of the screen about + the items/building/tile under the cursor, even while unpaused. + +Examples +-------- + +``mousequery rbutton enable`` + Enable using the right mouse button to cancel out of menus and scroll the + map. +``mousequery edge enable`` +``mousequery delay 300`` + Enable edge scrolling and set the delay to 300ms. diff --git a/plugins/mousequery.cpp b/plugins/mousequery.cpp index 618252ad3..cd85de2bc 100644 --- a/plugins/mousequery.cpp +++ b/plugins/mousequery.cpp @@ -916,19 +916,9 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector \n" - " Set delay when edge scrolling in tracking mode. Omit amount to display current setting.\n" - )); + "mousequery", + "Add mouse functionality to Dwarf Fortress.", + mousequery_cmd)); return CR_OK; }