Update readme

develop
Petr Mrázek 2011-08-15 08:07:24 +02:00
parent e14548ba4c
commit 7898d2b6b2
2 changed files with 83 additions and 63 deletions

@ -19,6 +19,8 @@ binaries at http://github.com/peterix/dfhack
Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads
All new releases are announced in the bay12 thread: http://tinyurl.com/dfhack-ng
=============
Compatibility
=============
@ -46,6 +48,11 @@ Uninstalling is basically the same, in reverse:
* On Windows, first delete SDL.dll and rename SDLreal.dll to SDL.dll. Then remove the other DFHack files
* On Linux, Remove the DFHack files.
The stonesense plugin might require some additional libraries on Linux:
* libjpeg 8
If it refuses to load, check the stderr.log file created in your DF folder.
============
Using DFHack
============
@ -60,6 +67,12 @@ Some commands can't be used from hotkeys - this includes interactive commands li
Most of the commands come from plugins. Those reside in 'DF/plugins/'.
=============================
Something doesn't work, help!
=============================
First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening.
If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (peterix@gmail.com) or visit the #dfhack IRC channel on freenode.
========
Commands
========

@ -331,49 +331,50 @@ access DF memory and allow for easier development of new tools.</p>
<li><a class="reference internal" href="#compatibility" id="id7">Compatibility</a></li>
<li><a class="reference internal" href="#installation-removal" id="id8">Installation/Removal</a></li>
<li><a class="reference internal" href="#using-dfhack" id="id9">Using DFHack</a></li>
<li><a class="reference internal" href="#commands" id="id10">Commands</a><ul>
<li><a class="reference internal" href="#autodump" id="id11">autodump</a><ul>
<li><a class="reference internal" href="#options" id="id12">Options</a></li>
<li><a class="reference internal" href="#something-doesn-t-work-help" id="id10">Something doesn't work, help!</a></li>
<li><a class="reference internal" href="#commands" id="id11">Commands</a><ul>
<li><a class="reference internal" href="#autodump" id="id12">autodump</a><ul>
<li><a class="reference internal" href="#options" id="id13">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cleanmap" id="id13">cleanmap</a></li>
<li><a class="reference internal" href="#cleanowned" id="id14">cleanowned</a><ul>
<li><a class="reference internal" href="#id1" id="id15">Options</a></li>
<li><a class="reference internal" href="#cleanmap" id="id14">cleanmap</a></li>
<li><a class="reference internal" href="#cleanowned" id="id15">cleanowned</a><ul>
<li><a class="reference internal" href="#id1" id="id16">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#colonies" id="id16">colonies</a><ul>
<li><a class="reference internal" href="#id2" id="id17">Options</a></li>
<li><a class="reference internal" href="#colonies" id="id17">colonies</a><ul>
<li><a class="reference internal" href="#id2" id="id18">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#deramp-by-zilpin" id="id18">deramp (by zilpin)</a></li>
<li><a class="reference internal" href="#dfusion" id="id19">dfusion</a><ul>
<li><a class="reference internal" href="#confirmed-working-dfusion-plugins" id="id20">Confirmed working DFusion plugins:</a></li>
<li><a class="reference internal" href="#deramp-by-zilpin" id="id19">deramp (by zilpin)</a></li>
<li><a class="reference internal" href="#dfusion" id="id20">dfusion</a><ul>
<li><a class="reference internal" href="#confirmed-working-dfusion-plugins" id="id21">Confirmed working DFusion plugins:</a></li>
</ul>
</li>
<li><a class="reference internal" href="#flows" id="id21">flows</a></li>
<li><a class="reference internal" href="#grow" id="id22">grow</a></li>
<li><a class="reference internal" href="#extirpate" id="id23">extirpate</a><ul>
<li><a class="reference internal" href="#id3" id="id24">Options</a></li>
<li><a class="reference internal" href="#flows" id="id22">flows</a></li>
<li><a class="reference internal" href="#grow" id="id23">grow</a></li>
<li><a class="reference internal" href="#extirpate" id="id24">extirpate</a><ul>
<li><a class="reference internal" href="#id3" id="id25">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#immolate" id="id25">immolate</a></li>
<li><a class="reference internal" href="#liquids" id="id26">liquids</a></li>
<li><a class="reference internal" href="#mode" id="id27">mode</a></li>
<li><a class="reference internal" href="#forcepause" id="id28">forcepause</a></li>
<li><a class="reference internal" href="#die" id="id29">die</a></li>
<li><a class="reference internal" href="#probe" id="id30">probe</a></li>
<li><a class="reference internal" href="#prospector" id="id31">prospector</a><ul>
<li><a class="reference internal" href="#id4" id="id32">Options</a></li>
<li><a class="reference internal" href="#immolate" id="id26">immolate</a></li>
<li><a class="reference internal" href="#liquids" id="id27">liquids</a></li>
<li><a class="reference internal" href="#mode" id="id28">mode</a></li>
<li><a class="reference internal" href="#forcepause" id="id29">forcepause</a></li>
<li><a class="reference internal" href="#die" id="id30">die</a></li>
<li><a class="reference internal" href="#probe" id="id31">probe</a></li>
<li><a class="reference internal" href="#prospector" id="id32">prospector</a><ul>
<li><a class="reference internal" href="#id4" id="id33">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#reveal" id="id33">reveal</a></li>
<li><a class="reference internal" href="#unreveal" id="id34">unreveal</a></li>
<li><a class="reference internal" href="#revtoggle" id="id35">revtoggle</a></li>
<li><a class="reference internal" href="#revflood" id="id36">revflood</a></li>
<li><a class="reference internal" href="#ssense-stonesense" id="id37">ssense / stonesense</a></li>
<li><a class="reference internal" href="#tubefill" id="id38">tubefill</a></li>
<li><a class="reference internal" href="#vdig" id="id39">vdig</a></li>
<li><a class="reference internal" href="#weather" id="id40">weather</a></li>
<li><a class="reference internal" href="#reveal" id="id34">reveal</a></li>
<li><a class="reference internal" href="#unreveal" id="id35">unreveal</a></li>
<li><a class="reference internal" href="#revtoggle" id="id36">revtoggle</a></li>
<li><a class="reference internal" href="#revflood" id="id37">revflood</a></li>
<li><a class="reference internal" href="#ssense-stonesense" id="id38">ssense / stonesense</a></li>
<li><a class="reference internal" href="#tubefill" id="id39">tubefill</a></li>
<li><a class="reference internal" href="#vdig" id="id40">vdig</a></li>
<li><a class="reference internal" href="#weather" id="id41">weather</a></li>
</ul>
</li>
</ul>
@ -384,6 +385,7 @@ access DF memory and allow for easier development of new tools.</p>
<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>
<p>Releases can be downloaded from here: <a class="reference external" href="https://github.com/peterix/dfhack/downloads">https://github.com/peterix/dfhack/downloads</a></p>
<p>All new releases are announced in the bay12 thread: <a class="reference external" href="http://tinyurl.com/dfhack-ng">http://tinyurl.com/dfhack-ng</a></p>
</div>
<div class="section" id="compatibility">
<h1><a class="toc-backref" href="#id7">Compatibility</a></h1>
@ -417,21 +419,26 @@ Copy the files from a release archive so that:</p>
<p>DFHack basically extends what DF can do with something similar to a quake console. On Windows, this is a separate command line window. On linux, the terminal used to launch the dfhack script is taken over (so, make sure you start from a terminal).
Basic interaction with dfhack involves entering commands into the console. For some basic instroduction, use the 'help' command. To list all possible commands, use the 'ls' command.
Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.</p>
<p>The command line has some nce line editing capabilities, including history that's preserved between different runs of DF (use up/down keys to go through the history).</p>
<p>The command line has some nice line editing capabilities, including history that's preserved between different runs of DF (use up/down keys to go through the history).</p>
<p>The second way to interact with DFHack is to bind the available commands to in-game hotkeys. This is done in the hotkey/zoom menu (normally opened with the 'h' key). Binding the commands is done by assigning a command as a hotkey name (with 'n').
Some commands can't be used from hotkeys - this includes interactive commands like 'liquids' and commands that have names longer than 9 characters.</p>
<p>Most of the commands come from plugins. Those reside in 'DF/plugins/'.</p>
</div>
<div class="section" id="something-doesn-t-work-help">
<h1><a class="toc-backref" href="#id10">Something doesn't work, help!</a></h1>
<p>First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening.
If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (<a class="reference external" href="mailto:peterix&#64;gmail.com">peterix&#64;gmail.com</a>) or visit the #dfhack IRC channel on freenode.</p>
</div>
<div class="section" id="commands">
<h1><a class="toc-backref" href="#id10">Commands</a></h1>
<h1><a class="toc-backref" href="#id11">Commands</a></h1>
<div class="section" id="autodump">
<h2><a class="toc-backref" href="#id11">autodump</a></h2>
<h2><a class="toc-backref" href="#id12">autodump</a></h2>
<p>Automated item dumping tool. All loose items on the floor marked
for dumping are insta-dumped to the position of the in-game cursor.</p>
<p>Cursor must be placed on a floor tile. Instadumped items may not
show up in the cursor description list until you save/reload.</p>
<div class="section" id="options">
<h3><a class="toc-backref" href="#id12">Options</a></h3>
<h3><a class="toc-backref" href="#id13">Options</a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
@ -443,16 +450,16 @@ show up in the cursor description list until you save/reload.</p>
</div>
</div>
<div class="section" id="cleanmap">
<h2><a class="toc-backref" href="#id13">cleanmap</a></h2>
<h2><a class="toc-backref" href="#id14">cleanmap</a></h2>
<p>Cleans all the splatter that get scattered all over the map.
By default, it leaves mud and snow alone.</p>
</div>
<div class="section" id="cleanowned">
<h2><a class="toc-backref" href="#id14">cleanowned</a></h2>
<h2><a class="toc-backref" href="#id15">cleanowned</a></h2>
<p>Confiscates items owned by dwarfs.
By default, owned food on the floor and rotten items are confistacted and dumped.</p>
<div class="section" id="id1">
<h3><a class="toc-backref" href="#id15">Options</a></h3>
<h3><a class="toc-backref" href="#id16">Options</a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
@ -472,10 +479,10 @@ By default, owned food on the floor and rotten items are confistacted and dumped
</div>
</div>
<div class="section" id="colonies">
<h2><a class="toc-backref" href="#id16">colonies</a></h2>
<h2><a class="toc-backref" href="#id17">colonies</a></h2>
<p>Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.</p>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id17">Options</a></h3>
<h3><a class="toc-backref" href="#id18">Options</a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
@ -487,16 +494,16 @@ By default, owned food on the floor and rotten items are confistacted and dumped
</div>
</div>
<div class="section" id="deramp-by-zilpin">
<h2><a class="toc-backref" href="#id18">deramp (by zilpin)</a></h2>
<h2><a class="toc-backref" href="#id19">deramp (by zilpin)</a></h2>
<p>Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.
It also removes any and all 'down ramps' that can remain after a cave-in (you don't have to designate anything for that to happen).</p>
</div>
<div class="section" id="dfusion">
<h2><a class="toc-backref" href="#id19">dfusion</a></h2>
<h2><a class="toc-backref" href="#id20">dfusion</a></h2>
<p>This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.</p>
<p>See the bay12 thread for details: <a class="reference external" href="http://www.bay12forums.com/smf/index.php?topic=69682.15">http://www.bay12forums.com/smf/index.php?topic=69682.15</a></p>
<div class="section" id="confirmed-working-dfusion-plugins">
<h3><a class="toc-backref" href="#id20">Confirmed working DFusion plugins:</a></h3>
<h3><a class="toc-backref" href="#id21">Confirmed working DFusion plugins:</a></h3>
<p>:simple_embark:allows changing the number of dwarves available on embark.</p>
<div class="note">
<p class="first admonition-title">Note</p>
@ -509,19 +516,19 @@ It also removes any and all 'down ramps' that can remain after a cave-in (you do
</div>
</div>
<div class="section" id="flows">
<h2><a class="toc-backref" href="#id21">flows</a></h2>
<h2><a class="toc-backref" href="#id22">flows</a></h2>
<p>A tool for checking how many tiles contain flowing liquids. If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map.</p>
</div>
<div class="section" id="grow">
<h2><a class="toc-backref" href="#id22">grow</a></h2>
<h2><a class="toc-backref" href="#id23">grow</a></h2>
<p>Makes all saplings present on the map grow into trees (almost) instantly.</p>
</div>
<div class="section" id="extirpate">
<h2><a class="toc-backref" href="#id23">extirpate</a></h2>
<h2><a class="toc-backref" href="#id24">extirpate</a></h2>
<p>A tool for getting rid of trees and shrubs. By default, it only kills a tree/shrub under the cursor.
The plants are turned into ashes instantly.</p>
<div class="section" id="id3">
<h3><a class="toc-backref" href="#id24">Options</a></h3>
<h3><a class="toc-backref" href="#id25">Options</a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
@ -537,11 +544,11 @@ The plants are turned into ashes instantly.</p>
</div>
</div>
<div class="section" id="immolate">
<h2><a class="toc-backref" href="#id25">immolate</a></h2>
<h2><a class="toc-backref" href="#id26">immolate</a></h2>
<p>Very similar to extirpate, but additionally sets the plants on fire. The fires can and <em>will</em> spread ;)</p>
</div>
<div class="section" id="liquids">
<h2><a class="toc-backref" href="#id26">liquids</a></h2>
<h2><a class="toc-backref" href="#id27">liquids</a></h2>
<p>Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey.
For more information, refer to the command's internal help.</p>
<div class="note">
@ -551,7 +558,7 @@ temperatures (creating heat traps). You've been warned.</p>
</div>
</div>
<div class="section" id="mode">
<h2><a class="toc-backref" href="#id27">mode</a></h2>
<h2><a class="toc-backref" href="#id28">mode</a></h2>
<p>This command lets you see and 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>
<div class="admonition-example admonition">
@ -563,22 +570,22 @@ 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>
</div>
<div class="section" id="forcepause">
<h2><a class="toc-backref" href="#id28">forcepause</a></h2>
<h2><a class="toc-backref" href="#id29">forcepause</a></h2>
<p>Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.</p>
</div>
<div class="section" id="die">
<h2><a class="toc-backref" href="#id29">die</a></h2>
<h2><a class="toc-backref" href="#id30">die</a></h2>
<p>Instantly kills DF without saving.</p>
</div>
<div class="section" id="probe">
<h2><a class="toc-backref" href="#id30">probe</a></h2>
<h2><a class="toc-backref" href="#id31">probe</a></h2>
<p>Can be used to determine tile properties like temperature.</p>
</div>
<div class="section" id="prospector">
<h2><a class="toc-backref" href="#id31">prospector</a></h2>
<h2><a class="toc-backref" href="#id32">prospector</a></h2>
<p>Lists all available minerals on the map and how much of them there is. By default, only processes the already discovered part of the map.</p>
<div class="section" id="id4">
<h3><a class="toc-backref" href="#id32">Options</a></h3>
<h3><a class="toc-backref" href="#id33">Options</a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
@ -590,23 +597,23 @@ You just lost a fortress and gained an adventurer.</p>
</div>
</div>
<div class="section" id="reveal">
<h2><a class="toc-backref" href="#id33">reveal</a></h2>
<h2><a class="toc-backref" href="#id34">reveal</a></h2>
<p>This reveals the map. By default, HFS will remain hidden so that the demons don't spawn. You can use 'reveal hell' to reveal everything. With hell revealed, you won't be able to unpause until you hide the map again.</p>
</div>
<div class="section" id="unreveal">
<h2><a class="toc-backref" href="#id34">unreveal</a></h2>
<h2><a class="toc-backref" href="#id35">unreveal</a></h2>
<p>Reverts the effects of 'reveal'.</p>
</div>
<div class="section" id="revtoggle">
<h2><a class="toc-backref" href="#id35">revtoggle</a></h2>
<h2><a class="toc-backref" href="#id36">revtoggle</a></h2>
<p>Switches between 'reveal' and 'unreveal'.</p>
</div>
<div class="section" id="revflood">
<h2><a class="toc-backref" href="#id36">revflood</a></h2>
<h2><a class="toc-backref" href="#id37">revflood</a></h2>
<p>This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.</p>
</div>
<div class="section" id="ssense-stonesense">
<h2><a class="toc-backref" href="#id37">ssense / stonesense</a></h2>
<h2><a class="toc-backref" href="#id38">ssense / stonesense</a></h2>
<p>This is an isometric visualizer that is runs in a second window.</p>
<p>This requires working graphics acceleration, at least a dual core CPU (otherwise it will slow down DF) and on Linux, the allegro 5 libraries installed (look for 'allegro5' in your package manager app).</p>
<p>All the data resides in the 'stonesense' directory.</p>
@ -616,15 +623,15 @@ You just lost a fortress and gained an adventurer.</p>
<a class="reference external" href="http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository">http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository</a></p>
</div>
<div class="section" id="tubefill">
<h2><a class="toc-backref" href="#id38">tubefill</a></h2>
<h2><a class="toc-backref" href="#id39">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="#id39">vdig</a></h2>
<h2><a class="toc-backref" href="#id40">vdig</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="weather">
<h2><a class="toc-backref" href="#id40">weather</a></h2>
<h2><a class="toc-backref" href="#id41">weather</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>