On Windows, DFHack is compatible with the SDL version of DF, but not the legacy version.
On Windows, you have to use the SDL version of DF.
It is also possible to use the Windows DFHack with Wine under Linux and OS X.
It is also possible to use the Windows DFHack with Wine under Linux and OS X.
@ -95,7 +112,7 @@ DFHack basically extends what DF can do with something similar to the drop-down
console found in Quake engine games. On Windows, this is a separate command line
console found in Quake engine games. On Windows, this is a separate command line
window. On linux, the terminal used to launch the dfhack script is taken over
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
(so, make sure you start from a terminal). Basic interaction with dfhack
involves entering commands into the console. For some basic instroduction,
involves entering commands into the console. For some basic instructions,
use the 'help' command. To list all possible commands, use the 'ls' command.
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
Many commands have their own help or detailed description. You can use
'command help' or 'command ?' to show that.
'command help' or 'command ?' to show that.
@ -158,22 +175,28 @@ In this case, updating symbols.xml is not necessary.
=============================
=============================
Something doesn't work, help!
Something doesn't work, help!
=============================
=============================
First, don't panic :) Second, dfhack keeps a few log files in DF's folder
First, don't panic :)
- stderr.log and stdout.log. You can look at those and possibly find out what's
happening.
Second, dfhack keeps a few log files in DF's folder (``stderr.log`` and
If you found a bug, you can either report it in the bay12 DFHack thread,
``stdout.log``). Looking at these might help you solve the problem.
the issues tracker on github, contact me (peterix@gmail.com) or visit the
If it doesn't, you can ask for help in the forum thread or on IRC.
#dfhack IRC channel on freenode.
If you found a bug, you can report it in the Bay12 DFHack thread, the issues
tracker on github, or visit the #dfhack IRC channel on freenode.
=============
=============
The init file
The init file
=============
=============
If your DF folder contains a file named ``dfhack.init``, its contents will be run
If your DF folder contains a file named ``dfhack.init``, its contents will be
every time you start DF. This allows setting up keybindings. An example file
run every time you start DF. This allows keybindings and other settings to
is provided as ``dfhack.init-example`` - you can tweak it and rename to dfhack.init
persist across runs. An example file is provided as ``dfhack.init-example`` -
if you want to use this functionality.
you can tweak it and rename to ``dfhack.init`` if you want to use this
functionality. If only the example init file is found, will be used and a
warning will be shown.
When a savegame is loaded, the ``onLoad.init`` file in its raw folder is run. It works the same way as ``dfhack.init``. It is recommended that modders use this to improve mobility of save games.
When a savegame is loaded, an ``onLoad.init`` file in its raw folder is run,
as a save-portable alternative to ``dfhack.init``. It is recommended that
modders use this to improve mobility of save games and compatibility of mods.
Setting keybindings
Setting keybindings
===================
===================
@ -252,10 +275,10 @@ If the first non-whitespace character is ``:``, the command is parsed in a speci
alternative mode: first, non-whitespace characters immediately following the ``:``
alternative mode: first, non-whitespace characters immediately following the ``:``
are used as the command name; the remaining part of the line, starting with the first
are used as the command name; the remaining part of the line, starting with the first
non-whitespace character *after* the command name, is used verbatim as the first argument.
non-whitespace character *after* the command name, is used verbatim as the first argument.
The following two command lines are exactly equivalent:
The following two command lines are exactly equivalent::
* ``:foo a b "c d" e f``
:foo a b "c d" e f
* ``foo "a b \"c d\" e f"``
foo "a b \"c d\" e f"
This is intended for commands like ``rb_eval`` that evaluate script language statements.
This is intended for commands like ``rb_eval`` that evaluate script language statements.
@ -396,13 +419,14 @@ that pre-filled.
rendermax
rendermax
---------
---------
A collection of renderer replacing/enhancing filters. For better effect try changing the
A collection of renderer replacing/enhancing filters. For better effect try changing the
black color in palette to non totally black. For more info see thread in forums:
black color in palette to non totally black. For more info see `the Bay12 forum thread`_.
.._`the Bay12 forum thread`: http://www.bay12forums.com/smf/index.php?topic=128487
Options:
Options:
``rendermax trippy``
``rendermax trippy``
Randomizes each tiles color. Used for fun mainly.
Randomizes the color of each tiles. Used for fun, or testing.
``rendermax light``
``rendermax light``
Enable lighting engine.
Enable lighting engine.
``rendermax light reload``
``rendermax light reload``
@ -467,8 +491,6 @@ care to exactly preserve the mineral counts reported by ``prospect all``.
The amounts of different layer stones may slightly change in some cases
The amounts of different layer stones may slightly change in some cases
if vein mass shifts between Z layers.
if vein mass shifts between Z layers.
This command is very unlikely to work on maps generated before version 0.34.08.
Note that there is no undo option other than restoring from backup.
Note that there is no undo option other than restoring from backup.
changelayer
changelayer
@ -609,8 +631,8 @@ Options:
:building:Subsequent items will become part of the currently selected building. Best used for loading traps; do not use with workshops, or you will need to deconstruct the building to use the item.
:building:Subsequent items will become part of the currently selected building. Best used for loading traps; do not use with workshops, or you will need to deconstruct the building to use the item.
deramp (by zilpin)
deramp
------------------
------
Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.
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).
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).
@ -1006,9 +1028,9 @@ A permanent alias for 'digl x'.
Load the savegame where you want to copy the settings to, run the batch file (from the shell):
autobutcher.bat
To export them, open a terminal in the DF directory, and run
``dfhack-run autobutcher list_export > autobutcher.bat`` (or ``.sh`` on OSX or
Linux). To import, load your new save and run the script you created.
autochop
autochop
---------
---------
@ -1994,7 +2009,7 @@ Open the dashboard by running::
getplants autochop
getplants autochop
The plugin must be activated (with 'a') before it can be used. You can then set logging quotas
The plugin must be activated (with ``c``) before it can be used. You can then set logging quotas
and restrict designations to specific burrows (with 'Enter') if desired. The plugin's activity
and restrict designations to specific burrows (with 'Enter') if desired. The plugin's activity
cycle runs once every in game day.
cycle runs once every in game day.
@ -2055,7 +2070,7 @@ Other jobs are automatically assigned as described above. Each of these setting
Jobs are rarely assigned to nobles with responsibilities for meeting diplomats or merchants,
Jobs are rarely assigned to nobles with responsibilities for meeting diplomats or merchants,
never to the chief medical dwarf, and less often to the bookeeper and manager.
never to the chief medical dwarf, and less often to the bookeeper and manager.
Hunting is never assigned without a butchery, and fishing is nver assigned without a fishery.
Hunting is never assigned without a butchery, and fishing is never assigned without a fishery.
For each labor a preference order is calculated based on skill, biased against masters of other
For each labor a preference order is calculated based on skill, biased against masters of other
trades and excluding those who can't do the job. The labor is then added to the best <minimum>
trades and excluding those who can't do the job. The labor is then added to the best <minimum>
@ -2063,7 +2078,7 @@ dwarves for that labor. We assign at least the minimum number of dwarfs, in ord
and then assign additional dwarfs that meet any of these conditions:
and then assign additional dwarfs that meet any of these conditions:
* The dwarf is idle and there are no idle dwarves assigned to this labor
* The dwarf is idle and there are no idle dwarves assigned to this labor
* The dwarf has nonzero skill associated with the labor
* The dwarf has non-zero skill associated with the labor
* The labor is mining, hunting, or woodcutting and the dwarf currently has it enabled.
* The labor is mining, hunting, or woodcutting and the dwarf currently has it enabled.
We stop assigning dwarfs when we reach the maximum allowed.
We stop assigning dwarfs when we reach the maximum allowed.
@ -2078,18 +2093,10 @@ twice.
dfusion
dfusion
-------
-------
This is the DFusion lua plugin system by Warmist, running as a DFHack plugin. There are two parts to this plugin: an interactive script that shows a text based menu and lua modules. Some of the functionality of is intentionaly left out of the menu:
This is the DFusion system (a DFHack precursor) by Warmist, running as a DFHack
plugin. For detail on this legacy system, see the `Bay12 forums thread`_.
:Friendship:a binary plugin that allows multi race forts (to use make a script that imports plugins.dfusion.friendship and use Friendship:install{table} table should contain list of race names.)
:Embark:a binary plugin that allows multi race embark (to use make a script that imports plugins.dfusion.embark and use Embark:install{table} table should contain list of race names or list of pairs (race-name, caste_id)).
See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic=93317.0
PeridexisErrant