Permalink
Browse files

Updated Readme to have info about dfweather, current version support …

…info.
  • Loading branch information...
1 parent 717bfb4 commit 0fe5ac98eba8f10910341ecdc83f3592ce51ff0b @peterix peterix committed Sep 20, 2010
Showing with 64 additions and 46 deletions.
  1. +8 −2 README.rst
  2. +56 −44 Readme.html
View
10 README.rst
@@ -45,11 +45,12 @@ Windows
fix it :)
0.31.01 - 0.31.03 legacy
-0.31.04 - 0.31.12 SDL
+0.31.04 - 0.31.13 SDL
+There are missing offsets but Map tools should be OK. Wait for updates...
Linux
=====
-0.31.05 - 0.31.12 native.
+0.31.05 - 0.31.13 native.
There are missing offsets but Map tools should be OK. Linux support is
a bit lacking, I'm working on it. All supported Windows versions
running in wine can be used with native DFHack binaries.
@@ -128,6 +129,11 @@ dfcleartask
===========
Solves the problem of unusable items after reclaim by clearing the 'in_job' bit of all items.
+dfweather
+===========
+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.
+
Your tool here
==============
Write one ;)
View
100 Readme.html
@@ -338,35 +338,37 @@
<li><a class="reference internal" href="#dfliquids" id="id9">dfliquids</a></li>
<li><a class="reference internal" href="#dfposition" id="id10">dfposition</a></li>
<li><a class="reference internal" href="#dfprospector" id="id11">dfprospector</a></li>
-<li><a class="reference internal" href="#dfreveal" id="id12">dfreveal</a></li>
-<li><a class="reference internal" href="#dfunstuck" id="id13">dfunstuck</a></li>
-<li><a class="reference internal" href="#dfvdig" id="id14">dfvdig</a></li>
-<li><a class="reference internal" href="#dfflows" id="id15">dfflows</a></li>
-<li><a class="reference internal" href="#dfattachtest" id="id16">dfattachtest</a></li>
-<li><a class="reference internal" href="#dfsuspend" id="id17">dfsuspend</a></li>
-<li><a class="reference internal" href="#dfexpbench" id="id18">dfexpbench</a></li>
-<li><a class="reference internal" href="#dfdoffsets" id="id19">dfdoffsets</a></li>
-<li><a class="reference internal" href="#dfcleartask" id="id20">dfcleartask</a></li>
-<li><a class="reference internal" href="#your-tool-here" id="id21">Your tool here</a></li>
+<li><a class="reference internal" href="#dfprobe" id="id12">dfprobe</a></li>
+<li><a class="reference internal" href="#dfreveal" id="id13">dfreveal</a></li>
+<li><a class="reference internal" href="#dfunstuck" id="id14">dfunstuck</a></li>
+<li><a class="reference internal" href="#dfvdig" id="id15">dfvdig</a></li>
+<li><a class="reference internal" href="#dfflows" id="id16">dfflows</a></li>
+<li><a class="reference internal" href="#dfattachtest" id="id17">dfattachtest</a></li>
+<li><a class="reference internal" href="#dfsuspend" id="id18">dfsuspend</a></li>
+<li><a class="reference internal" href="#dfexpbench" id="id19">dfexpbench</a></li>
+<li><a class="reference internal" href="#dfdoffsets" id="id20">dfdoffsets</a></li>
+<li><a class="reference internal" href="#dfcleartask" id="id21">dfcleartask</a></li>
+<li><a class="reference internal" href="#dfweather" id="id22">dfweather</a></li>
+<li><a class="reference internal" href="#your-tool-here" id="id23">Your tool here</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#using-the-library-as-a-developer" id="id22">Using the library as a developer</a><ul>
-<li><a class="reference internal" href="#contributing-to-dfhack" id="id23">Contributing to DFHack</a><ul>
-<li><a class="reference internal" href="#coding-style" id="id24">Coding style</a></li>
-<li><a class="reference internal" href="#how-to-get-new-code-into-dfhack" id="id25">How to get new code into DFHack</a></li>
-<li><a class="reference internal" href="#layout-for-tools" id="id26">Layout for tools</a></li>
-<li><a class="reference internal" href="#modules-what-are-they" id="id27">Modules - what are they?</a></li>
-<li><a class="reference internal" href="#dependencies" id="id28">Dependencies</a><ul>
-<li><a class="reference internal" href="#current-internal-dependencies" id="id29">Current internal dependencies</a></li>
-<li><a class="reference internal" href="#current-external-dependencies" id="id30">Current external dependencies</a></li>
-<li><a class="reference internal" href="#build-time-dependencies" id="id31">Build-time dependencies</a></li>
+<li><a class="reference internal" href="#using-the-library-as-a-developer" id="id24">Using the library as a developer</a><ul>
+<li><a class="reference internal" href="#contributing-to-dfhack" id="id25">Contributing to DFHack</a><ul>
+<li><a class="reference internal" href="#coding-style" id="id26">Coding style</a></li>
+<li><a class="reference internal" href="#how-to-get-new-code-into-dfhack" id="id27">How to get new code into DFHack</a></li>
+<li><a class="reference internal" href="#layout-for-tools" id="id28">Layout for tools</a></li>
+<li><a class="reference internal" href="#modules-what-are-they" id="id29">Modules - what are they?</a></li>
+<li><a class="reference internal" href="#dependencies" id="id30">Dependencies</a><ul>
+<li><a class="reference internal" href="#current-internal-dependencies" id="id31">Current internal dependencies</a></li>
+<li><a class="reference internal" href="#current-external-dependencies" id="id32">Current external dependencies</a></li>
+<li><a class="reference internal" href="#build-time-dependencies" id="id33">Build-time dependencies</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference internal" href="#memory-offset-definitions" id="id32">Memory offset definitions</a></li>
+<li><a class="reference internal" href="#memory-offset-definitions" id="id34">Memory offset definitions</a></li>
</ul>
</div>
</div>
@@ -395,11 +397,12 @@
fix it :)</p>
</div>
<p>0.31.01 - 0.31.03 legacy
-0.31.04 - 0.31.12 SDL</p>
+0.31.04 - 0.31.13 SDL
+There are missing offsets but Map tools should be OK. Wait for updates...</p>
</div>
<div class="section" id="linux">
<h2><a class="toc-backref" href="#id6">Linux</a></h2>
-<p>0.31.05 - 0.31.12 native.
+<p>0.31.05 - 0.31.13 native.
There are missing offsets but Map tools should be OK. Linux support is
a bit lacking, I'm working on it. All supported Windows versions
running in wine can be used with native DFHack binaries.</p>
@@ -433,53 +436,62 @@
<h2><a class="toc-backref" href="#id11">dfprospector</a></h2>
<p>Lists all available minerals on the map and how much of them there is.</p>
</div>
+<div class="section" id="dfprobe">
+<h2><a class="toc-backref" href="#id12">dfprobe</a></h2>
+<p>Can be used to determine tile properties.</p>
+</div>
<div class="section" id="dfreveal">
-<h2><a class="toc-backref" href="#id12">dfreveal</a></h2>
+<h2><a class="toc-backref" href="#id13">dfreveal</a></h2>
<p>Reveals the whole map, waits for input and hides it again. If you close
the tool while it waits, the map remains revealed.</p>
</div>
<div class="section" id="dfunstuck">
-<h2><a class="toc-backref" href="#id13">dfunstuck</a></h2>
+<h2><a class="toc-backref" href="#id14">dfunstuck</a></h2>
<p>Use if you prematurely close any of the tools and DF appears to be
stuck.</p>
</div>
<div class="section" id="dfvdig">
-<h2><a class="toc-backref" href="#id14">dfvdig</a></h2>
+<h2><a class="toc-backref" href="#id15">dfvdig</a></h2>
<p>Designates a whole vein for digging. Point the cursor at a vein and run
this thing :)</p>
</div>
<div class="section" id="dfflows">
-<h2><a class="toc-backref" href="#id15">dfflows</a></h2>
+<h2><a class="toc-backref" href="#id16">dfflows</a></h2>
<p>A tool for checking how many liquid tiles are actively checked for
flows.</p>
</div>
<div class="section" id="dfattachtest">
-<h2><a class="toc-backref" href="#id16">dfattachtest</a></h2>
+<h2><a class="toc-backref" href="#id17">dfattachtest</a></h2>
<p>Test of the process attach/detach mechanism.</p>
</div>
<div class="section" id="dfsuspend">
-<h2><a class="toc-backref" href="#id17">dfsuspend</a></h2>
+<h2><a class="toc-backref" href="#id18">dfsuspend</a></h2>
<p>Test of the process suspend/resume mechanism.</p>
</div>
<div class="section" id="dfexpbench">
-<h2><a class="toc-backref" href="#id18">dfexpbench</a></h2>
+<h2><a class="toc-backref" href="#id19">dfexpbench</a></h2>
<p>Just a simple benchmark of the data export speed.</p>
</div>
<div class="section" id="dfdoffsets">
-<h2><a class="toc-backref" href="#id19">dfdoffsets</a></h2>
+<h2><a class="toc-backref" href="#id20">dfdoffsets</a></h2>
<p>Dumps the offsets for the currently running DF version into the terminal.</p>
</div>
<div class="section" id="dfcleartask">
-<h2><a class="toc-backref" href="#id20">dfcleartask</a></h2>
+<h2><a class="toc-backref" href="#id21">dfcleartask</a></h2>
<p>Solves the problem of unusable items after reclaim by clearing the 'in_job' bit of all items.</p>
</div>
+<div class="section" id="dfweather">
+<h2><a class="toc-backref" href="#id22">dfweather</a></h2>
+<p>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.</p>
+</div>
<div class="section" id="your-tool-here">
-<h2><a class="toc-backref" href="#id21">Your tool here</a></h2>
+<h2><a class="toc-backref" href="#id23">Your tool here</a></h2>
<p>Write one ;)</p>
</div>
</div>
<div class="section" id="using-the-library-as-a-developer">
-<h1><a class="toc-backref" href="#id22">Using the library as a developer</a></h1>
+<h1><a class="toc-backref" href="#id24">Using the library as a developer</a></h1>
<p>The library is compilable under Linux with GCC and under Windows with
MinGW32 and MSVC compilers. It is using the cmake build system. See
COMPILE for details.</p>
@@ -490,17 +502,17 @@
code does have a lot of comments though (and getting better all the
time).</p>
<div class="section" id="contributing-to-dfhack">
-<h2><a class="toc-backref" href="#id23">Contributing to DFHack</a></h2>
+<h2><a class="toc-backref" href="#id25">Contributing to DFHack</a></h2>
<p>Several things should be kept in mind when contributing to DFHack.</p>
<div class="section" id="coding-style">
-<h3><a class="toc-backref" href="#id24">Coding style</a></h3>
+<h3><a class="toc-backref" href="#id26">Coding style</a></h3>
<p>DFhack uses ANSI formatting and four spaces as indentation. Line
endings are UNIX. The files use UTF-8 encoding. Code not following this
won't make me happy, because I'll have to fix it. There's a good chance
I'll make <em>you</em> fix it ;)</p>
</div>
<div class="section" id="how-to-get-new-code-into-dfhack">
-<h3><a class="toc-backref" href="#id25">How to get new code into DFHack</a></h3>
+<h3><a class="toc-backref" href="#id27">How to get new code into DFHack</a></h3>
<p>You can send patches or make a clone of the github repo and ask me on
the IRC channel to pull your code in. I'll review it and see if there
are any problems. I'll fix them if they are minor.</p>
@@ -510,7 +522,7 @@
fixing.</p>
</div>
<div class="section" id="layout-for-tools">
-<h3><a class="toc-backref" href="#id26">Layout for tools</a></h3>
+<h3><a class="toc-backref" href="#id28">Layout for tools</a></h3>
<p>Tools live in the tools/ folder. There, they are split into three
categories.</p>
<dl class="docutils">
@@ -531,7 +543,7 @@
</dl>
</div>
<div class="section" id="modules-what-are-they">
-<h3><a class="toc-backref" href="#id27">Modules - what are they?</a></h3>
+<h3><a class="toc-backref" href="#id29">Modules - what are they?</a></h3>
<p>DFHack uses modules to partition sets of features into manageable
chunks. A module can have both client and server side.</p>
<p>Client side is the part that goes into the main library and is
@@ -548,7 +560,7 @@
pretty fast, but needs quite a bit of care to not break.</p>
</div>
<div class="section" id="dependencies">
-<h3><a class="toc-backref" href="#id28">Dependencies</a></h3>
+<h3><a class="toc-backref" href="#id30">Dependencies</a></h3>
<dl class="docutils">
<dt>Internal</dt>
<dd>either part of the codebase or statically linked.</dd>
@@ -560,7 +572,7 @@
attribution at most. External dependencies for tools can be either
that, or any Free Software licenses.</p>
<div class="section" id="current-internal-dependencies">
-<h4><a class="toc-backref" href="#id29">Current internal dependencies</a></h4>
+<h4><a class="toc-backref" href="#id31">Current internal dependencies</a></h4>
<dl class="docutils">
<dt>tinyxml</dt>
<dd>used by core dfhack to read offset definitions from Memory.xml</dd>
@@ -572,7 +584,7 @@
</dl>
</div>
<div class="section" id="current-external-dependencies">
-<h4><a class="toc-backref" href="#id30">Current external dependencies</a></h4>
+<h4><a class="toc-backref" href="#id32">Current external dependencies</a></h4>
<dl class="docutils">
<dt>wide-character ncurses</dt>
<dd>used for the veinlook tool on Linux.</dd>
@@ -581,7 +593,7 @@
</dl>
</div>
<div class="section" id="build-time-dependencies">
-<h4><a class="toc-backref" href="#id31">Build-time dependencies</a></h4>
+<h4><a class="toc-backref" href="#id33">Build-time dependencies</a></h4>
<dl class="docutils">
<dt>cmake</dt>
<dd>you need cmake to generate the build system and some configuration
@@ -592,7 +604,7 @@
</div>
</div>
<div class="section" id="memory-offset-definitions">
-<h1><a class="toc-backref" href="#id32">Memory offset definitions</a></h1>
+<h1><a class="toc-backref" href="#id34">Memory offset definitions</a></h1>
<p>The files with memory offset definitions used by dfhack can be found in the
data folder.</p>
</div>

0 comments on commit 0fe5ac9

Please sign in to comment.