From e901194daa9b7974a568c0566133816b6c30c5ef Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Petr=20Mr=C3=A1zek?=
Date: Wed, 17 Aug 2011 14:42:51 +0200
Subject: [PATCH] Update readme for expdig.
---
README.rst | 33 +++++++++++++++++++++++++
Readme.html | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++--
2 files changed, 101 insertions(+), 2 deletions(-)
diff --git a/README.rst b/README.rst
index 127c08ce1..24a253e1e 100644
--- a/README.rst
+++ b/README.rst
@@ -242,6 +242,39 @@ vdig
====
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).
+vdigx
+=====
+A permanent alias for 'vdig x'.
+
+expdig
+======
+This command can be used for exploratory mining.
+
+See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining
+
+There are two variables that can be set: pattern and filter.
+
+Patterns:
+---------
+:diag5: diagonals separated by 5 tiles
+:ladder: A 'ladder' pattern
+:clear: Just remove all dig designations
+:cross: A cross, exactly in the middle of the map.
+
+Filters:
+--------
+:all: designate whole z-level
+:hidden: designate only hidden tiles of z-level (default)
+:designated: Take current designation and apply pattern to it.
+
+After you have a pattern set, you can use 'expdig' to apply it again.
+
+Examples:
+---------
+* 'expdig diag5 hidden' = designate the diagonal 5 patter over all hidden tiles.
+* 'expdig' = apply last used pattern and filter.
+* 'expdig ladder designated' = Take current designations and replace them with the ladder pattern.
+
weather
=======
Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.
diff --git a/Readme.html b/Readme.html
index e12322084..f8cfa665d 100644
--- a/Readme.html
+++ b/Readme.html
@@ -374,7 +374,14 @@ access DF memory and allow for easier development of new tools.
ssense / stonesense
tubefill
vdig
-weather
+vdigx
+expdig
+
+weather
@@ -413,6 +420,14 @@ Copy the files from a release archive so that:
On Linux, Remove the DFHack files.
+
+- The stonesense plugin might require some additional libraries on Linux:
+-
+
+
+If it refuses to load, check the stderr.log file created in your DF folder.
@@ -630,8 +645,59 @@ You just lost a fortress and gained an adventurer.
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).
+
+
+
A permanent alias for 'vdig x'.
+
+
+
+
This command can be used for exploratory mining.
+
See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining
+
There are two variables that can be set: pattern and filter.
+
+
+
+
+
+
+diag5: | diagonals separated by 5 tiles |
+
+ladder: | A 'ladder' pattern |
+
+clear: | Just remove all dig designations |
+
+cross: | A cross, exactly in the middle of the map. |
+
+
+
+
+
+
+
+
+
+
+all: | designate whole z-level |
+
+hidden: | designate only hidden tiles of z-level (default) |
+
+designated: | Take current designation and apply pattern to it. |
+
+
+
+
After you have a pattern set, you can use 'expdig' to apply it again.
+
+
+
+
+- 'expdig diag5 hidden' = designate the diagonal 5 patter over all hidden tiles.
+- 'expdig' = apply last used pattern and filter.
+- 'expdig ladder designated' = Take current designations and replace them with the ladder pattern.
+
+
+
-
+
Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.
Fill those ponds without mucking around with dfliquids :D Rain can also stop brush fires.