MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme to reflect 31.25 support.

develop
Petr Mrázek 2011-04-04 11:55:25 +02:00
parent 63522cc66e
commit 59d775ef3a
2 changed files with 77 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.rst
Unescape Escape View File

@ -19,13 +19,6 @@ binaries at http://github.com/peterix/dfhack
.. _github: http://www.github.com/ .. _github: http://www.github.com/
Packages
========
The library and tools are packaged for Archlinux and are available both
in AUR and the arch-games repository.
The package name is dfhack-git :)
============= =============
Compatibility Compatibility
============= =============
@ -45,15 +38,21 @@ Windows
0.31.01 - 0.31.03 legacy 0.31.01 - 0.31.03 legacy
0.31.04 - 0.31.24 SDL 0.31.04 - 0.31.25 SDL
Linux Linux
===== =====
0.31.05 - 0.31.19 native. Native linux DF
---------------
0.31.05 - 0.31.19: spotty support (some things might not work)
0.31.22 - 0.31.25: full support
Windows DF under wine
---------------------
0.31.01 - 0.31.03 legacy
There are missing offsets but Map tools should be OK. Linux support is 0.31.04 - 0.31.25 SDL
a bit lacking, I'm working on it. Very slowly. All supported Windows versions
running in wine can be used with native DFHack binaries.
===== =====
Tools Tools

131
Readme.html
Unescape Escape View File

@ -324,38 +324,39 @@ allow for easier development of new tools.</p>
<p class="topic-title first">Contents</p> <p class="topic-title first">Contents</p>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li> <li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
<li><a class="reference internal" href="#getting-dfhack" id="id2">Getting DFHack</a><ul> <li><a class="reference internal" href="#getting-dfhack" id="id2">Getting DFHack</a></li>
<li><a class="reference internal" href="#packages" id="id3">Packages</a></li> <li><a class="reference internal" href="#compatibility" id="id3">Compatibility</a><ul>
<li><a class="reference internal" href="#windows" id="id4">Windows</a></li>
<li><a class="reference internal" href="#linux" id="id5">Linux</a><ul>
<li><a class="reference internal" href="#native-linux-df" id="id6">Native linux DF</a></li>
<li><a class="reference internal" href="#windows-df-under-wine" id="id7">Windows DF under wine</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#compatibility" id="id4">Compatibility</a><ul>
<li><a class="reference internal" href="#windows" id="id5">Windows</a></li>
<li><a class="reference internal" href="#linux" id="id6">Linux</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#tools" id="id7">Tools</a><ul> <li><a class="reference internal" href="#tools" id="id8">Tools</a><ul>
<li><a class="reference internal" href="#dfattachtest" id="id8">dfattachtest</a></li> <li><a class="reference internal" href="#dfattachtest" id="id9">dfattachtest</a></li>
<li><a class="reference internal" href="#dfcleanmap" id="id9">dfcleanmap</a></li> <li><a class="reference internal" href="#dfcleanmap" id="id10">dfcleanmap</a></li>
<li><a class="reference internal" href="#dfderamp-by-zilpin" id="id10">dfderamp (by zilpin)</a></li> <li><a class="reference internal" href="#dfderamp-by-zilpin" id="id11">dfderamp (by zilpin)</a></li>
<li><a class="reference internal" href="#dfdoffsets" id="id11">dfdoffsets</a></li> <li><a class="reference internal" href="#dfdoffsets" id="id12">dfdoffsets</a></li>
<li><a class="reference internal" href="#dfexpbench" id="id12">dfexpbench</a></li> <li><a class="reference internal" href="#dfexpbench" id="id13">dfexpbench</a></li>
<li><a class="reference internal" href="#dfflows" id="id13">dfflows</a></li> <li><a class="reference internal" href="#dfflows" id="id14">dfflows</a></li>
<li><a class="reference internal" href="#dfincremental" id="id14">dfincremental</a></li> <li><a class="reference internal" href="#dfincremental" id="id15">dfincremental</a></li>
<li><a class="reference internal" href="#dflair" id="id15">dflair</a></li> <li><a class="reference internal" href="#dflair" id="id16">dflair</a></li>
<li><a class="reference internal" href="#dfliquids" id="id16">dfliquids</a></li> <li><a class="reference internal" href="#dfliquids" id="id17">dfliquids</a></li>
<li><a class="reference internal" href="#dfmode" id="id17">dfmode</a></li> <li><a class="reference internal" href="#dfmode" id="id18">dfmode</a></li>
<li><a class="reference internal" href="#dfpause" id="id18">dfpause</a></li> <li><a class="reference internal" href="#dfpause" id="id19">dfpause</a></li>
<li><a class="reference internal" href="#dfposition" id="id19">dfposition</a></li> <li><a class="reference internal" href="#dfposition" id="id20">dfposition</a></li>
<li><a class="reference internal" href="#dfprobe" id="id20">dfprobe</a></li> <li><a class="reference internal" href="#dfprobe" id="id21">dfprobe</a></li>
<li><a class="reference internal" href="#dfprospector" id="id21">dfprospector</a></li> <li><a class="reference internal" href="#dfprospector" id="id22">dfprospector</a></li>
<li><a class="reference internal" href="#dfreveal" id="id22">dfreveal</a></li> <li><a class="reference internal" href="#dfreveal" id="id23">dfreveal</a></li>
<li><a class="reference internal" href="#dfsuspend" id="id23">dfsuspend</a></li> <li><a class="reference internal" href="#dfsuspend" id="id24">dfsuspend</a></li>
<li><a class="reference internal" href="#dftubefill" id="id24">dftubefill</a></li> <li><a class="reference internal" href="#dftubefill" id="id25">dftubefill</a></li>
<li><a class="reference internal" href="#dfunstuck" id="id25">dfunstuck</a></li> <li><a class="reference internal" href="#dfunstuck" id="id26">dfunstuck</a></li>
<li><a class="reference internal" href="#dfvdig" id="id26">dfvdig</a></li> <li><a class="reference internal" href="#dfvdig" id="id27">dfvdig</a></li>
<li><a class="reference internal" href="#dfveinlook" id="id27">dfveinlook</a></li> <li><a class="reference internal" href="#dfveinlook" id="id28">dfveinlook</a></li>
<li><a class="reference internal" href="#dfweather" id="id28">dfweather</a></li> <li><a class="reference internal" href="#dfweather" id="id29">dfweather</a></li>
<li><a class="reference internal" href="#your-tool-here" id="id29">Your tool here</a></li> <li><a class="reference internal" href="#your-tool-here" id="id30">Your tool here</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -365,20 +366,14 @@ allow for easier development of new tools.</p>
<h1><a class="toc-backref" href="#id2">Getting DFHack</a></h1> <h1><a class="toc-backref" href="#id2">Getting DFHack</a></h1>
<p>The project is currently hosted on <a class="reference external" href="http://www.github.com/">github</a>, for both source and <p>The project is currently hosted on <a class="reference external" href="http://www.github.com/">github</a>, for both source and
binaries at <a class="reference external" href="http://github.com/peterix/dfhack">http://github.com/peterix/dfhack</a></p> binaries at <a class="reference external" href="http://github.com/peterix/dfhack">http://github.com/peterix/dfhack</a></p>
<div class="section" id="packages">
<h2><a class="toc-backref" href="#id3">Packages</a></h2>
<p>The library and tools are packaged for Archlinux and are available both
in AUR and the arch-games repository.</p>
<p>The package name is dfhack-git :)</p>
</div>
</div> </div>
<div class="section" id="compatibility"> <div class="section" id="compatibility">
<h1><a class="toc-backref" href="#id4">Compatibility</a></h1> <h1><a class="toc-backref" href="#id3">Compatibility</a></h1>
<p>DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.</p> <p>DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.</p>
<p>OSX is not supported due to lack of developers with a Mac.</p> <p>OSX is not supported due to lack of developers with a Mac.</p>
<p>Currently supported Dwarf Fortress versions are Windows and Linux.</p> <p>Currently supported Dwarf Fortress versions are Windows and Linux.</p>
<div class="section" id="windows"> <div class="section" id="windows">
<h2><a class="toc-backref" href="#id5">Windows</a></h2> <h2><a class="toc-backref" href="#id4">Windows</a></h2>
<div class="note"> <div class="note">
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<p class="last">Windows 2000 is currently <em>not supported</em> due to missing OS <p class="last">Windows 2000 is currently <em>not supported</em> due to missing OS
@ -386,56 +381,62 @@ functionality. If you know how to easily suspend processes, you can
fix it :)</p> fix it :)</p>
</div> </div>
<p>0.31.01 - 0.31.03 legacy</p> <p>0.31.01 - 0.31.03 legacy</p>
<p>0.31.04 - 0.31.24 SDL</p> <p>0.31.04 - 0.31.25 SDL</p>
</div> </div>
<div class="section" id="linux"> <div class="section" id="linux">
<h2><a class="toc-backref" href="#id6">Linux</a></h2> <h2><a class="toc-backref" href="#id5">Linux</a></h2>
<p>0.31.05 - 0.31.19 native.</p> <div class="section" id="native-linux-df">
<p>There are missing offsets but Map tools should be OK. Linux support is <h3><a class="toc-backref" href="#id6">Native linux DF</a></h3>
a bit lacking, I'm working on it. Very slowly. All supported Windows versions <p>0.31.05 - 0.31.19: spotty support (some things might not work)</p>
running in wine can be used with native DFHack binaries.</p> <p>0.31.22 - 0.31.25: full support</p>
</div>
<div class="section" id="windows-df-under-wine">
<h3><a class="toc-backref" href="#id7">Windows DF under wine</a></h3>
<p>0.31.01 - 0.31.03 legacy</p>
<p>0.31.04 - 0.31.25 SDL</p>
</div>
</div> </div>
</div> </div>
<div class="section" id="tools"> <div class="section" id="tools">
<h1><a class="toc-backref" href="#id7">Tools</a></h1> <h1><a class="toc-backref" href="#id8">Tools</a></h1>
<p>All the DFHack tools are terminal programs. This might seem strange to Windows <p>All the DFHack tools are terminal programs. This might seem strange to Windows
users, but these are meant mostly as examples for developers. Still, they can users, but these are meant mostly as examples for developers. Still, they can
be useful and are cross-platform just like the library itself.</p> be useful and are cross-platform just like the library itself.</p>
<div class="section" id="dfattachtest"> <div class="section" id="dfattachtest">
<h2><a class="toc-backref" href="#id8">dfattachtest</a></h2> <h2><a class="toc-backref" href="#id9">dfattachtest</a></h2>
<p>Test of the process attach/detach mechanism.</p> <p>Test of the process attach/detach mechanism.</p>
</div> </div>
<div class="section" id="dfcleanmap"> <div class="section" id="dfcleanmap">
<h2><a class="toc-backref" href="#id9">dfcleanmap</a></h2> <h2><a class="toc-backref" href="#id10">dfcleanmap</a></h2>
<p>Cleans all the splatter that get scattered all over the map. <p>Cleans all the splatter that get scattered all over the map.
Only exception is mud. It leaves mud alone.</p> Only exception is mud. It leaves mud alone.</p>
</div> </div>
<div class="section" id="dfderamp-by-zilpin"> <div class="section" id="dfderamp-by-zilpin">
<h2><a class="toc-backref" href="#id10">dfderamp (by zilpin)</a></h2> <h2><a class="toc-backref" href="#id11">dfderamp (by zilpin)</a></h2>
<p>Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.</p> <p>Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.</p>
</div> </div>
<div class="section" id="dfdoffsets"> <div class="section" id="dfdoffsets">
<h2><a class="toc-backref" href="#id11">dfdoffsets</a></h2> <h2><a class="toc-backref" href="#id12">dfdoffsets</a></h2>
<p>Dumps the offsets for the currently running DF version into the terminal.</p> <p>Dumps the offsets for the currently running DF version into the terminal.</p>
</div> </div>
<div class="section" id="dfexpbench"> <div class="section" id="dfexpbench">
<h2><a class="toc-backref" href="#id12">dfexpbench</a></h2> <h2><a class="toc-backref" href="#id13">dfexpbench</a></h2>
<p>Just a simple benchmark of the data export speed.</p> <p>Just a simple benchmark of the data export speed.</p>
</div> </div>
<div class="section" id="dfflows"> <div class="section" id="dfflows">
<h2><a class="toc-backref" href="#id13">dfflows</a></h2> <h2><a class="toc-backref" href="#id14">dfflows</a></h2>
<p>A tool for checking how many liquid tiles are actively checked for flows.</p> <p>A tool for checking how many liquid tiles are actively checked for flows.</p>
</div> </div>
<div class="section" id="dfincremental"> <div class="section" id="dfincremental">
<h2><a class="toc-backref" href="#id14">dfincremental</a></h2> <h2><a class="toc-backref" href="#id15">dfincremental</a></h2>
<p>A simple memory search tool for DF. Requires arcane knowledge ;)</p> <p>A simple memory search tool for DF. Requires arcane knowledge ;)</p>
</div> </div>
<div class="section" id="dflair"> <div class="section" id="dflair">
<h2><a class="toc-backref" href="#id15">dflair</a></h2> <h2><a class="toc-backref" href="#id16">dflair</a></h2>
<p>Marks all of the map as a lair, preventing item scatter on abandon/reclaim.</p> <p>Marks all of the map as a lair, preventing item scatter on abandon/reclaim.</p>
</div> </div>
<div class="section" id="dfliquids"> <div class="section" id="dfliquids">
<h2><a class="toc-backref" href="#id16">dfliquids</a></h2> <h2><a class="toc-backref" href="#id17">dfliquids</a></h2>
<p>A command prompt for liquid creation and manipulation (the Moses <p>A command prompt for liquid creation and manipulation (the Moses
effect included!) Also allows painting obsidian walls directly.</p> effect included!) Also allows painting obsidian walls directly.</p>
<div class="note"> <div class="note">
@ -445,7 +446,7 @@ temperatures (creating heat traps). You've been warned.</p>
</div> </div>
</div> </div>
<div class="section" id="dfmode"> <div class="section" id="dfmode">
<h2><a class="toc-backref" href="#id17">dfmode</a></h2> <h2><a class="toc-backref" href="#id18">dfmode</a></h2>
<p>This tool lets you change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results. <p>This tool lets you change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results.
There are a few good ones though.</p> There are a few good ones though.</p>
<div class="admonition-example admonition"> <div class="admonition-example admonition">
@ -457,55 +458,55 @@ You just lost a fortress and gained an adventurer.</p>
<p>I take no responsibility of anything that happens as a result of using this tool :P</p> <p>I take no responsibility of anything that happens as a result of using this tool :P</p>
</div> </div>
<div class="section" id="dfpause"> <div class="section" id="dfpause">
<h2><a class="toc-backref" href="#id18">dfpause</a></h2> <h2><a class="toc-backref" href="#id19">dfpause</a></h2>
<p>Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.</p> <p>Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.</p>
</div> </div>
<div class="section" id="dfposition"> <div class="section" id="dfposition">
<h2><a class="toc-backref" href="#id19">dfposition</a></h2> <h2><a class="toc-backref" href="#id20">dfposition</a></h2>
<p>Prints the game mode, current DF window properties and cursor position in both local and world coordinates.</p> <p>Prints the game mode, current DF window properties and cursor position in both local and world coordinates.</p>
</div> </div>
<div class="section" id="dfprobe"> <div class="section" id="dfprobe">
<h2><a class="toc-backref" href="#id20">dfprobe</a></h2> <h2><a class="toc-backref" href="#id21">dfprobe</a></h2>
<p>Can be used to determine tile properties like temperature.</p> <p>Can be used to determine tile properties like temperature.</p>
</div> </div>
<div class="section" id="dfprospector"> <div class="section" id="dfprospector">
<h2><a class="toc-backref" href="#id21">dfprospector</a></h2> <h2><a class="toc-backref" href="#id22">dfprospector</a></h2>
<p>Lists all available minerals on the map and how much of them there is.</p> <p>Lists all available minerals on the map and how much of them there is.</p>
</div> </div>
<div class="section" id="dfreveal"> <div class="section" id="dfreveal">
<h2><a class="toc-backref" href="#id22">dfreveal</a></h2> <h2><a class="toc-backref" href="#id23">dfreveal</a></h2>
<p>Reveals the whole map, waits for input and hides it again. If you close <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> the tool while it waits, the map remains revealed.</p>
</div> </div>
<div class="section" id="dfsuspend"> <div class="section" id="dfsuspend">
<h2><a class="toc-backref" href="#id23">dfsuspend</a></h2> <h2><a class="toc-backref" href="#id24">dfsuspend</a></h2>
<p>Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.</p> <p>Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.</p>
</div> </div>
<div class="section" id="dftubefill"> <div class="section" id="dftubefill">
<h2><a class="toc-backref" href="#id24">dftubefill</a></h2> <h2><a class="toc-backref" href="#id25">dftubefill</a></h2>
<p>Fills all the 'candy stores' with 'delicious candy'. No need to fear the clowns. Don't use if you haven't seen the hidden fun stuff <p>Fills all the 'candy stores' with 'delicious candy'. No need to fear the clowns. Don't use if you haven't seen the hidden fun stuff
yet ;)</p> yet ;)</p>
</div> </div>
<div class="section" id="dfunstuck"> <div class="section" id="dfunstuck">
<h2><a class="toc-backref" href="#id25">dfunstuck</a></h2> <h2><a class="toc-backref" href="#id26">dfunstuck</a></h2>
<p>Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.</p> <p>Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.</p>
</div> </div>
<div class="section" id="dfvdig"> <div class="section" id="dfvdig">
<h2><a class="toc-backref" href="#id26">dfvdig</a></h2> <h2><a class="toc-backref" href="#id27">dfvdig</a></h2>
<p>Designates a whole vein for digging. Point the cursor at a vein and run this thing :) <p>Designates a whole vein for digging. Point the cursor at a vein and run this thing :)
Running 'dfXvdig' on Windows or using the '-x' parameter will dig stairs between z-levels to follow the veins.</p> Running 'dfXvdig' on Windows or using the '-x' parameter will dig stairs between z-levels to follow the veins.</p>
</div> </div>
<div class="section" id="dfveinlook"> <div class="section" id="dfveinlook">
<h2><a class="toc-backref" href="#id27">dfveinlook</a></h2> <h2><a class="toc-backref" href="#id28">dfveinlook</a></h2>
<p>Simplistic map viewer for linux. Mostly a debug/development thing.</p> <p>Simplistic map viewer for linux. Mostly a debug/development thing.</p>
</div> </div>
<div class="section" id="dfweather"> <div class="section" id="dfweather">
<h2><a class="toc-backref" href="#id28">dfweather</a></h2> <h2><a class="toc-backref" href="#id29">dfweather</a></h2>
<p>Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Fill those ponds without mucking around with dfliquids <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> :D Rain can also stop brush fires.</p>
</div> </div>
<div class="section" id="your-tool-here"> <div class="section" id="your-tool-here">
<h2><a class="toc-backref" href="#id29">Your tool here</a></h2> <h2><a class="toc-backref" href="#id30">Your tool here</a></h2>
<p>Write one ;)</p> <p>Write one ;)</p>
</div> </div>
</div> </div>