From f0fc0d442872c64afd2190d8e3f8adc73a810e8c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Petr=20Mr=C3=A1zek?=
On Linux, DFHack replaces the SDL library distributed with DF.
+On Windows, DFHack replaces the SDL library distributed with DF.
DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git.
diff --git a/README.rst b/README.rst
index 74d78bd7b..d1dcc2d21 100644
--- a/README.rst
+++ b/README.rst
@@ -86,6 +86,31 @@ Commands
Almost all the commands support using the 'help DFHack is a Dwarf Fortress memory access library and a set of basic
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
@@ -326,146 +326,156 @@ access DF memory and allow for easier development of new tools. Contents The project is currently hosted on github, for both source and
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 DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.
OSX is not supported due to lack of developers with a Mac. Currently, only version 0.31.25 is supported. If you need DFHack
@@ -474,7 +484,7 @@ for older versions, look for older releases. It is possible to use the Windows DFHack under wine/OSX. Installing DFhack involves copying files into your DF folder.
Copy the files from a release archive so that: If any of the plugins or dfhack itself refuses to load, check the stderr.log file created in your DF folder. 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 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. Most of the commands come from plugins. Those reside in 'hack/plugins/'. 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. If your DF folder contains a file named dfhack.init, its contents will be run every time you start DF. This allows setting up keybindings. An example file is provided as dfhack.init-example - you can tweak it and rename to dfhack.init if you want to use this functionality. Almost all the commands support using the 'help <command-name>' built-in command to retrieve further help without having to look at this document. Alternatively, some accept a 'help'/'?' option on their command line. This allows taking control over your followers and other creatures in adventure mode. For example, you can make them pick up new arms and armor and equip them properly. A package of different adventure mode tools (currently just one) Changes material of the vein under cursor to the specified inorganic RAW material. Makes the game view follow the currently highlighted unit after you exit from current menu/cursor mode. Handy for watching dwarves running around. Deactivated by moving the view manually. Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game. Disables pausing (both manual and automatic) with the exception of pause forced by 'reveal hell'.
This is nice for digging under rivers. This utility lets you quickly move all items designated to be dumped.
Items are instantly moved to the cursor position, the dump flag is unset,
and the forbid flag is set, as if it had been dumped normally.
Be aware that any active dump item tasks still point at the item. Cursor must be placed on a floor tile so the items can be dumped there. Destroy items marked for dumping under cursor. Identical to autodump destroy-here, but intended for use as keybinding. Destroy the selected item. The item may be selected in the 'k' list, or inside a container. If called again before the game is resumed, cancels destroy. Cleans all the splatter that get scattered all over the map, items and creatures.
In an old fortress, this can significantly reduce FPS lag. It can also spoil your
!!FUN!!, so think before you use it. 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. Confiscates items owned by dwarfs.
By default, owned food on the floor and rotten items are confistacted and dumped. Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies. 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). This generates a minecraft world out of the currently loaded fortress.
Generated worlds are placed into your DF folder, named "World #". This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin. See the bay12 thread for details: http://www.bay12forums.com/smf/index.php?topic=69682.15 This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye. Makes your minions move at ludicrous speeds. Set traffic designations using flood-fill starting at the cursor. 'filltraffic H' - When used in a room with doors, it will set traffic to HIGH in just that room. Set traffic designations for every single tile of the map (useful for resetting traffic designations). Up to version 0.31.12, Elves only sent Diplomats to your fortress to propose tree cutting quotas due to a bug; once that bug was fixed, Elves stopped caring about excess tree cutting. This command adds a Diplomat position to all Elven civilizations, allowing them to negotiate tree cutting quotas (and allowing you to violate them and potentially start wars) in case you haven't already modified your raws accordingly. This command adds the Guild Representative position to all Human civilizations, allowing them to make trade agreements (just as they did back in 0.28.181.40d and earlier) in case you haven't already modified your raws accordingly. Removes invalid references to mineral inclusions and restores missing ones. Use this if you broke your embark with tools like tiletypes, or if you accidentally placed a construction on top of a valuable mineral floor. Due to a bug in all releases of version 0.31, merchants no longer bring wagons with their caravans. This command re-enables them for all appropriate civilizations. 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. 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. Command for general job query and manipulation. Alter the material of the selected job. Invoked as: job-material <inorganic-token> Manages DFHack keybindings. Currently it supports any combination of Ctrl/Alt/Shift with F1-F9, or A-Z. 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. 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. I take no responsibility of anything that happens as a result of using this tool :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. Very similar to extirpate, but additionally sets the plants on fire. The fires can and will spread ;) Prints a big list of all the present minerals and plants. By default, only the visible part of the map is scanned. If called during the embark selection screen, displays an estimate of layer stone availability.
If the 'all' option is specified, also estimates veins. The estimate is computed either
for 1 embark tile of the blinking biome, or for all tiles of the embark rectangle. Allows renaming various things. 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'. This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor. Tool for turning cooking of seeds and plants on/off depending on how much you have of them. See 'seedwatch help' for detailed description. Copies the parameters of the currently highlighted stockpile to the custom stockpile settings and switches to custom stockpile placement mode, effectively allowing you to copy/paste stockpiles easily. 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). All the data resides in the 'stonesense' directory. For detailed instructions, see stonesense/README.txt Compatible with Windows > XP SP3 and most modern Linux distributions. Can be used for painting map tiles and is a interactive command, much like liquids.
You can paint tiles by their properties - shape, general material and a few others (paint).
You can also paint only over tiles that match a set of properties (filter) For more details, see the 'help' command while using this. 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). 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). This command can be used for exploratory mining. See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining There are two variables that can be set: pattern and filter. After you have a pattern set, you can use 'expdig' to apply it again. A command for easy designation of filled and hollow circles.
It has several types of options. After you have set the options, the command called with no options
repeats with the last selected parameters. Prints the current weather map by default. Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Manage control of repeat jobs. If no options are specified, enables or disables the plugin.
@@ -1235,7 +1282,7 @@ Otherwise, enables or disables any of the following options: When the plugin is enabled, it protects all repeat jobs from removal.
If they do disappear due to any cause, they are immediately re-added to their
workshop and suspended. Keep metal bolts within 900-1000, and wood/bone within 150-200.Introduction
+Introduction
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
Getting DFHack
+Getting DFHack
Compatibility
+Compatibility
Installation/Removal
+Installation/Removal
@@ -494,7 +504,7 @@ Copy the files from a release archive so that:
Using DFHack
+Using DFHack
Something doesn't work, help!
+Something doesn't work, help!
The init file
+The init file
Commands
+Commands
adv-bodyswap
+Usage
+
+
+
+
+advtools
+Usage
+
+
+
+list-equipped [all]:
+
+ List armor and weapons equipped by your companions. If all is specified, also lists non-metal clothing.
+changevein
+follow
+forcepause
+forcepause
@@ -527,23 +574,23 @@ If you found a bug, you can either report it in the bay12 DFHack thread, the iss
nopause
+nopause
autodump
+autodump
Options
+Options
autodump-destroy-here
+autodump-destroy-here
autodump-destroy-item
+autodump-destroy-item
clean
+clean
Options
+Options
Extra options for 'map'
+Extra options for 'map'
spotclean
+spotclean
cleanowned
+cleanowned
Options
+Options
colonies
+colonies
Options
+Options
deramp (by zilpin)
+deramp (by zilpin)
df2minecraft
+df2minecraft
dfusion
+dfusion
Confirmed working DFusion plugins:
+Confirmed working DFusion plugins:
drybuckets
+drybuckets
fastdwarf
+fastdwarf
@@ -709,10 +756,10 @@ Generated worlds are placed into your DF folder, named "World #".
filltraffic
+filltraffic
Traffic Type Codes:
+Traffic Type Codes:
Other Options:
+Other Options:
Example:
+Example:
alltraffic
+alltraffic
Traffic Type Codes:
+Traffic Type Codes:
fixdiplomats
+fixdiplomats
fixmerchants
+fixmerchants
fixveins
+fixveins
fixwagons
+fixwagons
flows
+flows
getplants
+getplants
Options
+Options
job
+job
job-material
+job-material
job-duplicate
+job-duplicate
@@ -860,10 +907,10 @@ Generated worlds are placed into your DF folder, named "World #".
keybinding
+keybinding
Options
+Options
liquids
+liquids
mode
+mode
extirpate
+extirpate
Options
+Options
immolate
+immolate
prospect
+prospect
Options
+Options
Pre-embark estimate
+Pre-embark estimate
Options
+Options
rename
+rename
Options
+Options
reveal
+reveal
revflood
+revflood
seedwatch
+seedwatch
copystock
+copystock
ssense / stonesense
+ssense / stonesense
tiletypes
+tiletypes
tubefill
+tubefill
vdig
+vdig
expdig
+expdig
Patterns:
+Patterns:
Filters:
+Filters:
Examples:
+Examples:
@@ -1126,11 +1173,11 @@ You can also paint only over tiles that match a set of properties (filter)
digcircle
+digcircle
Designation types:
+Designation types:
Examples:
+Examples:
weather
+weather
Options:
+Options:
workflow
+workflow
Usage
+Usage
Function
+Function
Constraint examples
+Constraint examples
workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
@@ -1283,11 +1330,11 @@ the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command