Merge pull request #1590 from Bumber64/machine-toggle

Add `machine-toggle` tool

Author: ab9rf

changelog.txt

@@ -27,12 +27,14 @@ Template for new versions:
 # Future
 
 ## New Tools
+- `machine-toggle`: interface for toggling gear assemblies, as well as pressure plates (previously in `trackstop`) (available only if ``armok`` tools are shown)
 
 ## New Features
 
 ## Fixes
 
 ## Misc Improvements
+- `trackstop`: ``pressureplate`` overlay moved to `machine-toggle` as an ``armok`` tool
 
 ## Removed
 

docs/machine-toggle.rst

@@ -0,0 +1,21 @@
+machine-toggle
+==============
+
+.. dfhack-tool::
+    :summary: Overlay to modify pressure plates and gear assemblies after construction.
+    :tags: fort armok buildings interface
+
+This script provides 2 overlays that are managed by the `overlay` framework.
+The script does nothing when executed.
+Track stops and rollers are handled by `trackstop`.
+
+The ``pressureplate`` overlay allows the player to change the trigger settings
+of a selected pressure plate after it has been constructed. Manual value entry
+of ranges for minecart and creature triggers is provided, allowing greater
+precision than the game interface normally permits. Incrementing or decrementing
+values always restricts them to the usual intervals.
+
+The ``gearassembly`` overlay allows the player to toggle the state of a selected
+gear assembly without linking it to a lever first. This is useful for dwarfputing
+and other applications where it may be desirable to default to the disengaged
+state until triggered.

docs/trackstop.rst

@@ -2,20 +2,15 @@ trackstop
 =========
 
 .. dfhack-tool::
-    :summary: Overlay to allow changing track stop and related building settings after construction.
+    :summary: Overlay to allow changing track stop and roller settings after construction.
     :tags: fort buildings interface
 
-This script provides 3 overlays that are managed by the `overlay` framework.
+This script provides 2 overlays that are managed by the `overlay` framework.
 The script does nothing when executed.
+Pressure plates and gear assemblies are handled by `machine-toggle`.
 
 The ``trackstop`` overlay allows the player to change the friction and dump
 direction of a selected track stop after it has been constructed.
 
 The ``rollers`` overlay allows the player to change the roller direction and
 speed of a selected roller after it has been constructed.
-
-The ``pressureplate`` overlay allows the player to change the trigger settings
-of a selected pressure plate after it has been constructed. Manual value entry
-of ranges for minecart and creature triggers is provided, allowing greater
-precision than the game interface normally permits. Incrementing or decrementing
-values always restricts them to the usual intervals.