DFHack is a Dwarf Fortress memory access library and a set of basic
tools using this library. The library is a work in progress, so things
might change as more tools are written for it.
It is an attempt to unite the various ways tools access DF memory and
allow for easier development of new tools.
tools that use it. Tools come in the form of plugins or (not yet)
external tools. It is an attempt to unite the various ways tools
access DF memory and allow for easier development of new tools.
..contents::
@ -19,220 +17,187 @@ binaries at http://github.com/peterix/dfhack
.._github: http://www.github.com/
Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads
=============
Compatibility
=============
DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.
OSX is not supported due to lack of developers with a Mac.
In general, the older DF release you use, the less features will work.
DFHack development is always focused on the latest DF version. Go too
far into the past, and only the most basic tools will work.
Currently, only the 31.25 version is supported. If you need DFHack
for older versions, look for older releases.
Windows
=======
..note::
Windows 2000 is currently *not supported* due to missing OS
functionality. If you know how to easily suspend processes, you can
fix it :)
On Windows, you have to use the SDL version of DF.
0.31.01 - 0.31.03 legacy
It is possible to use the Windows DFHack under wine/OSX.
0.31.04 - 0.31.25 SDL
====================
Installation/Removal
====================
Installing DFhack involves copying files into your DF folder.
Copy the files from a release archive so that:
Linux
=====
Native linux DF
---------------
0.31.05 - 0.31.24: spotty support (some things might not work)
* On Windows, SDL.dll is replaced
* On Linux, the 'dfhack' script is placed in the same folder as the 'df' script
0.31.25: full support
Uninstalling is basically the same, in reverse:
Windows DF under wine
---------------------
0.31.01 - 0.31.03 legacy
* 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.
0.31.04 - 0.31.25 SDL
============
Using DFHack
============
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.
=====
Tools
=====
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
be useful and are cross-platform just like the library itself.
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.
dfattachtest
============
Test of the process attach/detach mechanism.
Most of the commands come from plugins (those reside in DF/plugins/).
dfautodump
==========
========
Commands
========
autodump
========
Automated item dumping tool. All loose items on the floor marked
for dumping are insta-dumped to the position of the in-game cursor.
Cursor must be placed on a floor tile. Instadumped items may not
show up in the cursor description list until you save/reload.
Options:
--------
-d Destroy instead of dumping. Doesn't require a cursor.
Options
-------
:destroy:Destroy instead of dumping. Doesn't require a cursor.
dfcleanmap
==========
cleanmap
========
Cleans all the splatter that get scattered all over the map.
Only exception is mud. It leaves mud alone.
By default, it leaves mud and snow alone.
dfcleanowned
============
Removes the ownership flag from items.
cleanowned
==========
Confiscates items owned by dwarfs.
By default, owned food on the floor and rotten items are confistacted and dumped.
Options:
--------
-a confiscate all owned items
-l confiscated and dump all items scattered on the floor
-x confiscate/dump items with wear level 'x' and more
-X confiscate/dump items with wear level 'X' and more
-d a dry run. combine with other options to see what will happen without it actually happening.
Options
-------
:all:confiscate all owned items
:scattered:confiscated and dump all items scattered on the floor
:x:confiscate/dump items with wear level 'x' and more
:X:confiscate/dump items with wear level 'X' and more
:dryrun:a dry run. combine with other options to see what will happen without it actually happening.
On Windows:
* dfremovelitter.bat runs the tool with -lx
* dfconfiscate.bat runs the tool with -a
colonies
========
Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.
dfcleartask
===========
Items marked for a job can get stuck during a abandon/reclaim. This tool aims to fix that.
Best used immediately after a reclaim. Not thoroughly tested, use at your own risk.
Options
-------
:bees:turn colonies into honey bee colonies
dfderamp (by zilpin)
====================
deramp (by zilpin)
==================
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).
dfdoffsets
==========
Dumps the offsets for the currently running DF version into the terminal.
dfexpbench
==========
Just a simple benchmark of the data export speed.
dfflows
=======
A tool for checking how many liquid tiles are actively checked for flows.
dfincremental
=============
A simple memory search tool for DF. Requires arcane knowledge ;)
flows
=====
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.
dfgrow
======
grow
====
Makes all saplings present on the map grow into trees (almost) instantly.
dfimmolate
==========
extirpate
=========
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.
Options:
--------
-s affect all shrubs on the map
-t affect all trees on the map
-i instead of just instaburning plants to ashes, produce fire. WILL KILL FPS!
Options
-------
:shrubs:affect all shrubs on the map
:trees:affect all trees on the map
:all:affect every plant!
The windows binary releases contain many .bat files that can run the tool with different parameters.
dfstatus (by enjia2000)
=======================
Runs next to DF and shows some vital statistics of the fort, including food and booze.
immolate
========
Very similar to extirpate, but additionally sets the plants on fire. The fires can and *will* spread ;)
dflair
======
Marks all of the map as a lair, preventing item scatter on abandon/reclaim.
dfliquids
=========
A command prompt for liquid creation and manipulation (the Moses
effect included!) Also allows painting obsidian walls directly.
liquids
=======
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.
..note::
Spawning and deleting liquids can F up pathing data and
temperatures (creating heat traps). You've been warned.
dfmode
mode
======
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.
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.
..admonition:: Example
You are in fort game mode (0 game mode), managing your fortress (0 control mode) and paused.
You switch to the arena game mode, *assume control of a creature* and the switch to adventure game mode(1).
You are in fort game mode, managing your fortress and paused.
You switch to the arena game mode, *assume control of a creature* and then switch to adventure game mode(1).
You just lost a fortress and gained an adventurer.
I take no responsibility of anything that happens as a result of using this tool :P
dfpause
=======
forcepause
==========
Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.
dfposition
==========
Prints the game mode, current DF window properties and cursor position in both local and world coordinates.
die
===
Instantly kills DF without saving.
dfprobe
=======
probe
=====
Can be used to determine tile properties like temperature.
dfprospector
prospector
============
Lists all available minerals on the map and how much of them there is.
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.
Options:
--------
-a processes all tiles, even hidden ones.
Options
-------
:all:processes all tiles, even hidden ones.
On windows, it's possible to run dfprospector-all.bat to process all the tiles without messing with terminal windows.
Also on Windos, dfprospector-text.bat will print the output into a file and then show it in a notepad program (whatever opens .txt by default).
reveal
======
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.
dfreveal
unreveal
========
Reveals the whole map, waits for input and hides it again. If you close
the tool while it waits, the map remains revealed.
dfunreveal
==========
Hides everything and then only reveals the part of the map accessible from the position of DF's cursor. Place the cursor in open space that you want to keep revealed - this should include the surface world.
Can be used to fix maps stuck revealed or hide parts of the fortress blocked off by walls.
dfsuspend
=========
Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.
dftubefill
==========
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 ;)
Reverts the effects of 'reveal'.
dfunstuck
revtoggle
=========
Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.
Switches between 'reveal' and 'unreveal'.
dfvdig
======
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.
revflood
========
This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.
dfveinlook
tubefill
==========
Simplistic map viewer. Mostly a debug/development thing. Now supported on Windows too!
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).
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.
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).
Your tool here
==============
Write one ;)
weather
=======
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>The project is currently hosted on <aclass="reference external"href="http://www.github.com/">github</a>, for both source and
binaries at <aclass="reference external"href="http://github.com/peterix/dfhack">http://github.com/peterix/dfhack</a></p>
<p>Releases can be downloaded from here: <aclass="reference external"href="https://github.com/peterix/dfhack/downloads">https://github.com/peterix/dfhack/downloads</a></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 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>
<td>confiscated and dump all items scattered on the floor</td></tr>
<tr><tdclass="option-group">
<kbd><spanclass="option">-x</span></kbd></td>
<td>confiscate/dump items with wear level 'x' and more</td></tr>
<tr><tdclass="option-group">
<kbd><spanclass="option">-X</span></kbd></td>
<td>confiscate/dump items with wear level 'X' and more</td></tr>
<tr><tdclass="option-group">
<kbd><spanclass="option">-d</span></kbd></td>
<td>a dry run. combine with other options to see what will happen without it actually happening.</td></tr>
<trclass="field"><thclass="field-name">all:</th><tdclass="field-body">confiscate all owned items</td>
</tr>
<trclass="field"><thclass="field-name">scattered:</th><tdclass="field-body">confiscated and dump all items scattered on the floor</td>
</tr>
<trclass="field"><thclass="field-name">x:</th><tdclass="field-body">confiscate/dump items with wear level 'x' and more</td>
</tr>
<trclass="field"><thclass="field-name">X:</th><tdclass="field-body">confiscate/dump items with wear level 'X' and more</td>
</tr>
<trclass="field"><thclass="field-name">dryrun:</th><tdclass="field-body">a dry run. combine with other options to see what will happen without it actually happening.</td>
</tr>
</tbody>
</table>
<dlclass="docutils">
<dt>On Windows:</dt>
<dd><ulclass="first last simple">
<li>dfremovelitter.bat runs the tool with -lx</li>
<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>
<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 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>
<divclass="admonition-example admonition">
<pclass="first admonition-title">Example</p>
<pclass="last">You are in fort game mode (0 game mode), managing your fortress (0 control mode) and paused.
You switch to the arena game mode, <em>assume control of a creature</em> and the switch to adventure game mode(1).
<pclass="last">You are in fort game mode, managing your fortress and paused.
You switch to the arena game mode, <em>assume control of a creature</em> and then switch to adventure game mode(1).
You just lost a fortress and gained an adventurer.</p>
</div>
<p>I take no responsibility of anything that happens as a result of using this tool :P</p>
<p>Hides everything and then only reveals the part of the map accessible from the position of DF's cursor. Place the cursor in open space that you want to keep revealed - this should include the surface world.
Can be used to fix maps stuck revealed or hide parts of the fortress blocked off by walls.</p>
<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>
<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>
<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>
Petr Mrázek