Trackstop plugin documentation.

NEWS

@@ -1,5 +1,8 @@
 DFHack future
 
+    New plugins:
+        - trackstop: Shows track stop friction and dump direction in its 'q' menu
+
 DFHack 0.40.13-r1
     Internals:
         - unified spatter structs

Readme.html

@@ -529,6 +529,7 @@ access DF memory and allow for easier development of new tools.</p>
 <li><a class="reference internal" href="#search" id="id158">Search</a></li>
 <li><a class="reference internal" href="#automaterial" id="id159">AutoMaterial</a></li>
 <li><a class="reference internal" href="#stockpile-automation" id="idautomelt">Stockpile Automation</a></li>
+<li><a class="reference internal" href="#track-stop-menu" id="idtrackstop">Track Stop Menu</a></li>
 <li><a class="reference internal" href="#gui-advfort" id="id160">gui/advfort</a></li>
 <li><a class="reference internal" href="#gui-assign-rack" id="id161">gui/assign-rack</a></li>
 <li><a class="reference internal" href="#gui-choose-weapons" id="id162">gui/choose-weapons</a></li>
@@ -3275,6 +3276,20 @@ enable automelt
 <p>When querying a stockpile an option will appear to toggle automelt for this stockpile.
 Any items placed in this stockpile will be designated to be melted.</p>
 </div>
+<div class="section" id="track-stop-menu">
+<h2><a class="toc-backref" href="#idtrackstop">Track Stop Menu</a></h2>
+<p>The <cite>q</cite> menu of track stops is completely blank by default.  To enable one:</p>
+<pre class="literal-block">
+enable trackstop
+</pre>
+<p>This allows you to view and/or change the track stop's friction and dump direction settings.
+It re-uses the keybindings from the track stop building interface:</p>
+<ul class="simple">
+<li>BUILDING_TRACK_STOP_FRICTION_UP</li>
+<li>BUILDING_TRACK_STOP_FRICTION_DOWN</li>
+<li>BUILDING_TRACK_STOP_DUMP</li>
+</ul>
+</div>
 <div class="section" id="gui-advfort">
 <h2><a class="toc-backref" href="#id160">gui/advfort</a></h2>
 <p>This script allows to perform jobs in adventure mode. For more complete help

Readme.rst

@@ -2655,6 +2655,19 @@ Enable the automelt plugin in your dfhack.init with::
 When querying a stockpile an option will appear to toggle automelt for this stockpile.
 Any items placed in this stockpile will be designated to be melted.
 
+Track Stop Menu
+===============
+
+The `q` menu of track stops is completely blank by default.  To enable one::
+
+    enable trackstop
+
+This allows you to view and/or change the track stop's friction and dump direction settings.
+It re-uses the keybindings from the track stop building interface:
+
+* BUILDING_TRACK_STOP_FRICTION_UP
+* BUILDING_TRACK_STOP_FRICTION_DOWN
+* BUILDING_TRACK_STOP_DUMP
 
 gui/advfort
 ===========