From 30bb98d9f5cbeb19a77f542cac6d11c155c1728f Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Sun, 5 Feb 2012 19:25:06 +0400 Subject: Document the keybinding command. --- Readme.html | 477 +++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 259 insertions(+), 218 deletions(-) (limited to 'Readme.html') diff --git a/Readme.html b/Readme.html index 101fb77b..5aba08eb 100644 --- a/Readme.html +++ b/Readme.html @@ -318,7 +318,7 @@ ul.auto-toc {
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,121 +326,127 @@ 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 the 31.25 version is supported. If you need DFHack +
Currently, only version 0.31.25 is supported. If you need DFHack for older versions, look for older releases.
On Windows, you have to use the SDL version of DF.
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:
@@ -485,32 +491,52 @@ 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 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). +
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.
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).
-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.
-Most of the commands come from plugins. Those reside in 'DF/plugins/'.
+The second way to interact with DFHack is to bind the available commands to in-game hotkeys. The old way to do this is via 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').
+A new and more flexible way is the keybinding command in the dfhack console. However, bindings created this way are not automatically remembered between runs of the game, so it becomes necessary to use the dfhack.init file to ensure that they are re-created every time it is loaded.
+Interactive commands like 'liquids' cannot be used as hotkeys.
+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.
Almost all the commands have a 'help'/'?' option that will give you further help without having to look at this document.
+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.
+Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.
++++
+- Activate with 'forcepause 1'
+- Deactivate with 'forcepause 0'
+
Disables pausing (both manual and automatic) with the exception of pause forced by 'reveal hell'. +This is nice for digging under rivers.
+Instantly kills DF without saving.
+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.
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.
+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.
Since DF v0.31.1 merchants no longer bring wagons due to a bug. This command re-enables them for all appropriate civilizations.
+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.
| shrubs: | affect all shrubs on the map | +
|---|---|
| keybinding list <key>: | |
| List bindings active for the key combination. | |
| trees: | affect all trees on the map | +
| keybinding clear <key> <key>...: | |
| Remove bindings for the specified keys. | |
| all: | affect every plant! | +
| keybinding add <key> "cmdline" "cmdline"...: | |
| Add bindings for the specified key. | +|
| keybinding set <key> "cmdline" "cmdline"...: | |
| Clear, and then add bindings for the specified key. | |
When multiple commands are bound to the same key combination, DFHack selects the first applicable one. Later 'add' commands, and earlier entries within one 'add' command have priority. Commands that are not specifically intended for use as a hotkey are always considered applicable.
Very similar to extirpate, but additionally sets the plants on fire. The fires can and will spread ;)
-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
Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.
--+-
-- Activate with 'forcepause 1'
-- Deactivate with 'forcepause 0'
-
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.
+| shrubs: | affect all shrubs on the map | +
|---|---|
| trees: | affect all trees on the map | +
| all: | affect every plant! | +
Disables pausing (both manual and automatic) with the exception of pause forced by 'reveal hell'. -This is nice for digging under rivers.
Instantly kills DF without saving.
+Makes all saplings present on the map grow into trees (almost) 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.
| rename squad <index> "name": | |
|---|---|
| Rename squad by index to 'name'. | +|
| Rename squad by index to 'name'. | |
| rename hotkey <index> "name": | |
| Rename hotkey by index. This allows assigning longer commands to the DF hotkeys. | +|
| Rename hotkey by index. This allows assigning longer commands to the DF hotkeys. | |
| rename unit "nickname": | |
| Rename a unit/creature highlighted in the DF user interface. | +|
| Rename a unit/creature highlighted in the DF user interface. | |
| rename unit-profession "custom profession": | |
| Change proffession name of the highlighted unit/creature. | +|
| Change proffession name of the highlighted unit/creature. | |
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.
Shows items needed for current strange mood.
+Shows all items needed for the currently active strange mood.
Copies the parameters of the currently highlighted stockpile to the custom stockpile settings. Basically a way to copy stockpiles easily.
+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.
@@ -996,31 +1037,31 @@ for 1 embark tile of the blinking biome, or for all tiles of the embark rectangl http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repositoryCan 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.