diff options
Diffstat (limited to 'Readme.html')
| -rw-r--r-- | Readme.html | 94 |
1 files changed, 52 insertions, 42 deletions
diff --git a/Readme.html b/Readme.html index 3fc8f27a..4e1a06eb 100644 --- a/Readme.html +++ b/Readme.html @@ -467,33 +467,35 @@ access DF memory and allow for easier development of new tools.</p> </ul> </li> <li><a class="reference internal" href="#tubefill" id="id125">tubefill</a></li> -<li><a class="reference internal" href="#vdig" id="id126">vdig</a></li> -<li><a class="reference internal" href="#vdigx" id="id127">vdigx</a></li> -<li><a class="reference internal" href="#expdig" id="id128">expdig</a><ul> -<li><a class="reference internal" href="#patterns" id="id129">Patterns:</a></li> -<li><a class="reference internal" href="#filters" id="id130">Filters:</a></li> -<li><a class="reference internal" href="#id23" id="id131">Examples:</a></li> +<li><a class="reference internal" href="#digv" id="id126">digv</a></li> +<li><a class="reference internal" href="#digvx" id="id127">digvx</a></li> +<li><a class="reference internal" href="#digl" id="id128">digl</a></li> +<li><a class="reference internal" href="#diglx" id="id129">diglx</a></li> +<li><a class="reference internal" href="#digexp" id="id130">digexp</a><ul> +<li><a class="reference internal" href="#patterns" id="id131">Patterns:</a></li> +<li><a class="reference internal" href="#filters" id="id132">Filters:</a></li> +<li><a class="reference internal" href="#id23" id="id133">Examples:</a></li> </ul> </li> -<li><a class="reference internal" href="#digcircle" id="id132">digcircle</a><ul> -<li><a class="reference internal" href="#shape" id="id133">Shape:</a></li> -<li><a class="reference internal" href="#action" id="id134">Action:</a></li> -<li><a class="reference internal" href="#designation-types" id="id135">Designation types:</a></li> -<li><a class="reference internal" href="#id24" id="id136">Examples:</a></li> +<li><a class="reference internal" href="#digcircle" id="id134">digcircle</a><ul> +<li><a class="reference internal" href="#shape" id="id135">Shape:</a></li> +<li><a class="reference internal" href="#action" id="id136">Action:</a></li> +<li><a class="reference internal" href="#designation-types" id="id137">Designation types:</a></li> +<li><a class="reference internal" href="#id24" id="id138">Examples:</a></li> </ul> </li> -<li><a class="reference internal" href="#weather" id="id137">weather</a><ul> -<li><a class="reference internal" href="#id25" id="id138">Options:</a></li> +<li><a class="reference internal" href="#weather" id="id139">weather</a><ul> +<li><a class="reference internal" href="#id25" id="id140">Options:</a></li> </ul> </li> -<li><a class="reference internal" href="#workflow" id="id139">workflow</a><ul> -<li><a class="reference internal" href="#id26" id="id140">Usage</a></li> -<li><a class="reference internal" href="#function" id="id141">Function</a></li> -<li><a class="reference internal" href="#constraint-examples" id="id142">Constraint examples</a></li> +<li><a class="reference internal" href="#workflow" id="id141">workflow</a><ul> +<li><a class="reference internal" href="#id26" id="id142">Usage</a></li> +<li><a class="reference internal" href="#function" id="id143">Function</a></li> +<li><a class="reference internal" href="#constraint-examples" id="id144">Constraint examples</a></li> </ul> </li> -<li><a class="reference internal" href="#mapexport" id="id143">mapexport</a></li> -<li><a class="reference internal" href="#dwarfexport" id="id144">dwarfexport</a></li> +<li><a class="reference internal" href="#mapexport" id="id145">mapexport</a></li> +<li><a class="reference internal" href="#dwarfexport" id="id146">dwarfexport</a></li> </ul> </li> </ul> @@ -1330,21 +1332,29 @@ You can also paint only over tiles that match a set of properties (filter)</p> <h2><a class="toc-backref" href="#id125">tubefill</a></h2> <p>Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).</p> </div> -<div class="section" id="vdig"> -<h2><a class="toc-backref" href="#id126">vdig</a></h2> +<div class="section" id="digv"> +<h2><a class="toc-backref" href="#id126">digv</a></h2> <p>Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).</p> </div> -<div class="section" id="vdigx"> -<h2><a class="toc-backref" href="#id127">vdigx</a></h2> -<p>A permanent alias for 'vdig x'.</p> +<div class="section" id="digvx"> +<h2><a class="toc-backref" href="#id127">digvx</a></h2> +<p>A permanent alias for 'digv x'.</p> </div> -<div class="section" id="expdig"> -<h2><a class="toc-backref" href="#id128">expdig</a></h2> +<div class="section" id="digl"> +<h2><a class="toc-backref" href="#id128">digl</a></h2> +<p>Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).</p> +</div> +<div class="section" id="diglx"> +<h2><a class="toc-backref" href="#id129">diglx</a></h2> +<p>A permanent alias for 'digl x'.</p> +</div> +<div class="section" id="digexp"> +<h2><a class="toc-backref" href="#id130">digexp</a></h2> <p>This command can be used for exploratory mining.</p> <p>See: <a class="reference external" href="http://df.magmawiki.com/index.php/DF2010:Exploratory_mining">http://df.magmawiki.com/index.php/DF2010:Exploratory_mining</a></p> <p>There are two variables that can be set: pattern and filter.</p> <div class="section" id="patterns"> -<h3><a class="toc-backref" href="#id129">Patterns:</a></h3> +<h3><a class="toc-backref" href="#id131">Patterns:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1365,7 +1375,7 @@ You can also paint only over tiles that match a set of properties (filter)</p> </table> </div> <div class="section" id="filters"> -<h3><a class="toc-backref" href="#id130">Filters:</a></h3> +<h3><a class="toc-backref" href="#id132">Filters:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1381,7 +1391,7 @@ You can also paint only over tiles that match a set of properties (filter)</p> <p>After you have a pattern set, you can use 'expdig' to apply it again.</p> </div> <div class="section" id="id23"> -<h3><a class="toc-backref" href="#id131">Examples:</a></h3> +<h3><a class="toc-backref" href="#id133">Examples:</a></h3> <dl class="docutils"> <dt>designate the diagonal 5 patter over all hidden tiles:</dt> <dd><ul class="first last simple"> @@ -1402,11 +1412,11 @@ You can also paint only over tiles that match a set of properties (filter)</p> </div> </div> <div class="section" id="digcircle"> -<h2><a class="toc-backref" href="#id132">digcircle</a></h2> +<h2><a class="toc-backref" href="#id134">digcircle</a></h2> <p>A command for easy designation of filled and hollow circles. It has several types of options.</p> <div class="section" id="shape"> -<h3><a class="toc-backref" href="#id133">Shape:</a></h3> +<h3><a class="toc-backref" href="#id135">Shape:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1421,7 +1431,7 @@ It has several types of options.</p> </table> </div> <div class="section" id="action"> -<h3><a class="toc-backref" href="#id134">Action:</a></h3> +<h3><a class="toc-backref" href="#id136">Action:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1436,7 +1446,7 @@ It has several types of options.</p> </table> </div> <div class="section" id="designation-types"> -<h3><a class="toc-backref" href="#id135">Designation types:</a></h3> +<h3><a class="toc-backref" href="#id137">Designation types:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1459,7 +1469,7 @@ It has several types of options.</p> repeats with the last selected parameters.</p> </div> <div class="section" id="id24"> -<h3><a class="toc-backref" href="#id136">Examples:</a></h3> +<h3><a class="toc-backref" href="#id138">Examples:</a></h3> <ul class="simple"> <li>'digcircle filled 3' = Dig a filled circle with radius = 3.</li> <li>'digcircle' = Do it again.</li> @@ -1467,11 +1477,11 @@ repeats with the last selected parameters.</p> </div> </div> <div class="section" id="weather"> -<h2><a class="toc-backref" href="#id137">weather</a></h2> +<h2><a class="toc-backref" href="#id139">weather</a></h2> <p>Prints the current weather map by default.</p> <p>Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.</p> <div class="section" id="id25"> -<h3><a class="toc-backref" href="#id138">Options:</a></h3> +<h3><a class="toc-backref" href="#id140">Options:</a></h3> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> @@ -1487,10 +1497,10 @@ repeats with the last selected parameters.</p> </div> </div> <div class="section" id="workflow"> -<h2><a class="toc-backref" href="#id139">workflow</a></h2> +<h2><a class="toc-backref" href="#id141">workflow</a></h2> <p>Manage control of repeat jobs.</p> <div class="section" id="id26"> -<h3><a class="toc-backref" href="#id140">Usage</a></h3> +<h3><a class="toc-backref" href="#id142">Usage</a></h3> <dl class="docutils"> <dt><tt class="docutils literal">workflow enable <span class="pre">[option...],</span> workflow disable <span class="pre">[option...]</span></tt></dt> <dd><p class="first">If no options are specified, enables or disables the plugin. @@ -1511,7 +1521,7 @@ Otherwise, enables or disables any of the following options:</p> </dl> </div> <div class="section" id="function"> -<h3><a class="toc-backref" href="#id141">Function</a></h3> +<h3><a class="toc-backref" href="#id143">Function</a></h3> <p>When the plugin is enabled, it protects all repeat jobs from removal. If they do disappear due to any cause, they are immediately re-added to their workshop and suspended.</p> @@ -1522,7 +1532,7 @@ the amount has to drop before jobs are resumed; this is intended to reduce the frequency of jobs being toggled.</p> </div> <div class="section" id="constraint-examples"> -<h3><a class="toc-backref" href="#id142">Constraint examples</a></h3> +<h3><a class="toc-backref" href="#id144">Constraint examples</a></h3> <p>Keep metal bolts within 900-1000, and wood/bone within 150-200.</p> <pre class="literal-block"> workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100 @@ -1559,11 +1569,11 @@ the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command </div> </div> <div class="section" id="mapexport"> -<h2><a class="toc-backref" href="#id143">mapexport</a></h2> +<h2><a class="toc-backref" href="#id145">mapexport</a></h2> <p>Export the current loaded map as a file. This will be eventually usable with visualizers.</p> </div> <div class="section" id="dwarfexport"> -<h2><a class="toc-backref" href="#id144">dwarfexport</a></h2> +<h2><a class="toc-backref" href="#id146">dwarfexport</a></h2> <p>Export dwarves to RuneSmith-compatible XML.</p> </div> </div> |
