:destroy:Destroy instead of dumping. Doesn't require a cursor.
:destroy:Destroy instead of dumping. Doesn't require a cursor.
cleanmap
clean
========
=====
Cleans all the splatter that get scattered all over the map.
Cleans all the splatter that get scattered all over the map, items and creatures.
By default, it leaves mud and snow alone.
In an old fortress, this can significantly reduce FPS lag. It can also spoil your
!!FUN!!, so think before you use it.
Options
-------
:map:Clean the map tiles. By default, it leaves mud and snow alone.
:units:Clean the creatures. Will also clean hostiles.
:items:Clean all the items. Even a poisoned blade.
Extra options for 'map'
-----------------------
:mud:Remove mud in addition to the normal stuff.
:snow:Also remove snow coverings.
spotclean
=========
Works like 'clean map snow mud', but only for the tile under the cursor. Ideal if you want to keep that bloody entrance 'clean map' would clean up.
cleanowned
cleanowned
==========
==========
@ -131,7 +147,7 @@ See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic
Confirmed working DFusion plugins:
Confirmed working DFusion plugins:
----------------------------------
----------------------------------
:simple_embark:allows changing the number of dwarves available on embark.
:simple_embark:allows changing the number of dwarves available on embark.
..note::
..note::
@ -139,10 +155,66 @@ Confirmed working DFusion plugins:
* This is currently working only on Windows.
* This is currently working only on Windows.
* The game will be suspended while you're using dfusion. Don't panic when it doen't respond.
* The game will be suspended while you're using dfusion. Don't panic when it doen't respond.
fastdwarf
=========
Makes your minions move at ludicrous speeds.
* Activate with 'fastdwarf 1'
* Deactivate with 'fastdwarf 0'
filltraffic
===========
Set traffic designations using flood-fill starting at the cursor.
Traffic Type Codes:
-------------------
:H:High Traffic
:N:Normal Traffic
:L:Low Traffic
:R:Restricted Traffic
Other Options:
--------------
:X:Fill accross z-levels.
:B:Include buildings and stockpiles.
:P:Include empty space.
Example:
--------
'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room.
tiletraffic
===========
Set traffic designations for every single tile of the map (useful for resetting traffic designations).
Traffic Type Codes:
-------------------
:H:High Traffic
:N:Normal Traffic
:L:Low Traffic
:R:Restricted Traffic
Example:
--------
'filltraffic N' - Set traffic to 'normal' for all tiles.
flows
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.
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.
getplants
=========
This tool allows plant gathering and tree cutting by RAW ID. Specify the types of trees to cut down and/or shrubs to gather by their plant names, separated by spaces.
Options
-------
:-t:Select trees only (exclude shrubs)
:-s:Select shrubs only (exclude trees)
:-c:Clear designations instead of setting them
:-x:Apply selected action to all plants except those specified (invert selection)
Specifying both -t and -s will have no effect. If no plant IDs are specified, all valid plant IDs will be listed.
grow
grow
====
====
Makes all saplings present on the map grow into trees (almost) instantly.
Makes all saplings present on the map grow into trees (almost) instantly.
@ -174,7 +246,7 @@ For more information, refer to the command's internal help.
temperatures (creating heat traps). You've been warned.
temperatures (creating heat traps). You've been warned.
mode
mode
======
====
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.
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.
There are a few good ones though.
@ -200,7 +272,7 @@ Can be used to determine tile properties like temperature.
prospector
prospector
============
============
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.
Lists all available minerals on the map, how much of them there is and the z-levels where they can be found. By default, only processes the already discovered part of the map.
Options
Options
-------
-------
@ -208,7 +280,7 @@ Options
reveal
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.
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. If you really want to unpause with hell revealed, use 'reveal demons'.
unreveal
unreveal
========
========
@ -222,11 +294,17 @@ revflood
========
========
This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.
This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.
seedwatch
=========
Tool for turning cooking of seeds and plants on/off depending on how much you have of them.
See 'seedwatch help' for detailed description.
ssense / stonesense
ssense / stonesense
===================
===================
An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).
An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).
Unfortunately currently fails to run on Windows XP and most Linux distributions.
Compatible with Windows > XP SP3 and most modern Linux distributions.
All the data resides in the 'stonesense' directory.
All the data resides in the 'stonesense' directory.
<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>
<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>
<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>
@ -450,21 +472,21 @@ Some commands can't be used from hotkeys - this includes interactive commands li
<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.
<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>
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>Works like 'clean map snow mud', but only for the tile under the cursor. Ideal if you want to keep that bloody entrance 'clean map' would clean up.</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 tool allows plant gathering and tree cutting by RAW ID. Specify the types of trees to cut down and/or shrubs to gather by their plant names, separated by spaces.</p>
<trclass="field"><thclass="field-name">-t:</th><tdclass="field-body">Select trees only (exclude shrubs)</td>
</tr>
<trclass="field"><thclass="field-name">-s:</th><tdclass="field-body">Select shrubs only (exclude trees)</td>
</tr>
<trclass="field"><thclass="field-name">-c:</th><tdclass="field-body">Clear designations instead of setting them</td>
</tr>
<trclass="field"><thclass="field-name">-x:</th><tdclass="field-body">Apply selected action to all plants except those specified (invert selection)</td>
</tr>
</tbody>
</table>
<p>Specifying both -t and -s will have no effect. If no plant IDs are specified, all valid plant IDs will be listed.</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">
@ -596,22 +755,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>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>
<p>Lists all available minerals on the map, how much of them there is and the z-levels where they can be found. By default, only processes the already discovered part of the map.</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. If you really want to unpause with hell revealed, use 'reveal demons'.</p>
<p>An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).</p>
<p>An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).</p>
<p>Unfortunately currently fails to run on Windows XP and most Linux distributions.</p>
<p>Compatible with Windows > XP SP3 and most modern Linux distributions.</p>
<p>All the data resides in the 'stonesense' directory.</p>
<p>All the data resides in the 'stonesense' directory.</p>
<p>Older versions, support and extra graphics can be found in the bay12 forum thread:
<p>Older versions, support and extra graphics can be found in the bay12 forum thread:
<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>
Petr Mrázek