@ -19,6 +19,8 @@ binaries at http://github.com/peterix/dfhack
Releases can be downloaded from here: https://github.com/peterix/dfhack/downloads
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
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 Windows, first delete SDL.dll and rename SDLreal.dll to SDL.dll. Then remove the other DFHack files
* On Linux, Remove the 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
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/'.
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.
@ -384,6 +385,7 @@ access DF memory and allow for easier development of new tools.</p>
<p>The project is currently hosted on <aclass="reference external"href="http://www.github.com/">github</a>, for both source and
<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>
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>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>All new releases are announced in the bay12 thread: <aclass="reference external"href="http://tinyurl.com/dfhack-ng">http://tinyurl.com/dfhack-ng</a></p>
@ -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).
<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.
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>
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').
<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>
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>
<p>Most of the commands come from plugins. Those reside in 'DF/plugins/'.</p>
<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 (<aclass="reference external"href="mailto:peterix@gmail.com">peterix@gmail.com</a>) or visit the #dfhack IRC channel on freenode.</p>
<p>This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.</p>
<p>This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.</p>
<p>See the bay12 thread for details: <aclass="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>
<p>See the bay12 thread for details: <aclass="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>
<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>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 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.
<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>
There are a few good ones though.</p>
<divclass="admonition-example admonition">
<divclass="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>
<p>I take no responsibility of anything that happens as a result of using this tool :P</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>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>This is an isometric visualizer that is runs in a second window.</p>
<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>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>
<p>All the data resides in the 'stonesense' directory.</p>
@ -616,15 +623,15 @@ You just lost a fortress and gained an adventurer.</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>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>
<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>