From c5101b2ea4f2685dd306f91840ab471048e52495 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Fri, 21 Sep 2012 12:19:48 +0400 Subject: [PATCH] Group commands in the readme document by their general type. There are way too many of them now for a flat list to work. --- README.rst | 1536 ++++++++++++++++++----------------- Readme.html | 2217 +++++++++++++++++++++++++-------------------------- 2 files changed, 1902 insertions(+), 1851 deletions(-) diff --git a/README.rst b/README.rst index 40d7b74e3..b0258bb30 100644 --- a/README.rst +++ b/README.rst @@ -152,33 +152,109 @@ Almost all the commands support using the 'help ' built-in command to retrieve further help without having to look at this document. Alternatively, some accept a 'help'/'?' option on their command line. + +Game progress +============= + +die +--- +Instantly kills DF without saving. + +forcepause +---------- +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' + +nopause +------- +Disables pausing (both manual and automatic) with the exception of pause forced +by 'reveal hell'. This is nice for digging under rivers. + +fastdwarf +--------- +Makes your minions move at ludicrous speeds. + + * Activate with 'fastdwarf 1' + * Deactivate with 'fastdwarf 0' + + +Game interface +============== + +follow +------ +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. + +tidlers +------- +Toggle between all possible positions where the idlers count can be placed. + +twaterlvl +--------- +Toggle between displaying/not displaying liquid depth as numbers. + +copystock +---------- +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. + +rename +------ +Allows renaming various things. + +Options: + + :rename squad "name": Rename squad by index to 'name'. + :rename hotkey \"name\": 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 unit-profession "custom profession": Change proffession name of the + highlighted unit/creature. + :rename building "name": Set a custom name for the selected building. + The building must be one of stockpile, workshop, furnace, trap, + siege engine or an activity zone. + + +Adventure mode +============== + adv-bodyswap -============ +------------ 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. -Usage ------ +Usage: + * When viewing unit details, body-swaps into that unit. * In the main adventure mode screen, reverts transient swap. advtools -======== +-------- A package of different adventure mode tools (currently just one) - -Usage ------ -:list-equipped [all]: List armor and weapons equipped by your companions. - If all is specified, also lists non-metal clothing. -:metal-detector [all-types] [non-trader]: Reveal metal armor and weapons in - shops. The options disable the checks - on item type and being in shop. +Usage: + + :list-equipped [all]: List armor and weapons equipped by your companions. + If all is specified, also lists non-metal clothing. + :metal-detector [all-types] [non-trader]: Reveal metal armor and weapons in + shops. The options disable the checks + on item type and being in shop. + + +Map modification +================ changelayer -=========== +----------- Changes material of the geology layer under cursor to the specified inorganic RAW material. Can have impact on all surrounding regions, not only your embark! By default changing stone to soil and vice versa is not allowed. By default @@ -191,18 +267,18 @@ as well, though. Mineral veins and gem clusters will stay on the map. Use tl;dr: You will end up with changing quite big areas in one go, especially if you use it in lower z levels. Use with care. -Options -------- -:all_biomes: Change selected layer for all biomes on your map. +Options: + + :all_biomes: Change selected layer for all biomes on your map. Result may be undesirable since the same layer can AND WILL be on different z-levels for different biomes. Use the tool 'probe' to get an idea how layers and biomes are distributed on your map. -:all_layers: Change all layers on your map (only for the selected biome + :all_layers: Change all layers on your map (only for the selected biome unless 'all_biomes' is added). Candy mountain, anyone? Will make your map quite boring, but tidy. -:force: Allow changing stone to soil and vice versa. !!THIS CAN HAVE + :force: Allow changing stone to soil and vice versa. !!THIS CAN HAVE WEIRD EFFECTS, USE WITH CARE!! Note that soil will not be magically replaced with stone. You will, however, get a stone floor after digging so it @@ -211,16 +287,16 @@ Options You will, however, get a soil floor after digging so it could be helpful for creating farm plots on maps with no soil. -:verbose: Give some details about what is being changed. -:trouble: Give some advice about known problems. + :verbose: Give some details about what is being changed. + :trouble: Give some advice about known problems. Examples: ---------- -``changelayer GRANITE`` + + ``changelayer GRANITE`` Convert layer at cursor position into granite. -``changelayer SILTY_CLAY force`` + ``changelayer SILTY_CLAY force`` Convert layer at cursor position into clay even if it's stone. -``changelayer MARBLE all_biomes all_layers`` + ``changelayer MARBLE all_biomes all_layers`` Convert all layers of all biomes which are not soil into marble. .. note:: @@ -239,18 +315,18 @@ Examples: You did save your game, right? changevein -========== +---------- Changes material of the vein under cursor to the specified inorganic RAW material. Only affects tiles within the current 16x16 block - for veins and large clusters, you will need to use this command multiple times. Example: --------- -``changevein NATIVE_PLATINUM`` + + ``changevein NATIVE_PLATINUM`` Convert vein at cursor position into platinum ore. changeitem -========== +---------- Allows changing item material and base quality. By default the item currently selected in the UI will be changed (you can select items in the 'k' list or inside containers/inventory). By default change is only allowed if materials @@ -261,474 +337,283 @@ in weirdness. To get an idea how the RAW id should look like, check some items with 'info'. Using 'force' might create items which are not touched by crafters/haulers. -Options -------- -:info: Don't change anything, print some info instead. -:here: Change all items at the cursor position. Requires in-game cursor. -:material, m: Change material. Must be followed by valid material RAW id. -:quality, q: Change base quality. Must be followed by number (0-5). -:force: Ignore subtypes, force change to new material. +Options: + + :info: Don't change anything, print some info instead. + :here: Change all items at the cursor position. Requires in-game cursor. + :material, m: Change material. Must be followed by valid material RAW id. + :quality, q: Change base quality. Must be followed by number (0-5). + :force: Ignore subtypes, force change to new material. Examples: ---------- -``changeitem m INORGANIC:GRANITE here`` + + ``changeitem m INORGANIC:GRANITE here`` Change material of all items under the cursor to granite. -``changeitem q 5`` + ``changeitem q 5`` Change currently selected item to masterpiece quality. -cursecheck -========== -Checks a single map tile or the whole map/world for cursed creatures (ghosts, -vampires, necromancers, werebeasts, zombies). +colonies +-------- +Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies. -With an active in-game cursor only the selected tile will be observed. -Without a cursor the whole map will be checked. +Options: -By default cursed creatures will be only counted in case you just want to find -out if you have any of them running around in your fort. Dead and passive -creatures (ghosts who were put to rest, killed vampires, ...) are ignored. -Undead skeletons, corpses, bodyparts and the like are all thrown into the curse -category "zombie". Anonymous zombies and resurrected body parts will show -as "unnamed creature". + :bees: turn colonies into honey bee colonies + +deramp (by zilpin) +------------------ +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). -Options +feature ------- -:detail: Print full name, date of birth, date of curse and some status - info (some vampires might use fake identities in-game, though). -:nick: Set the type of curse as nickname (does not always show up - in-game, some vamps don't like nicknames). -:all: Include dead and passive cursed creatures (can result in a quite - long list after having FUN with necromancers). -:verbose: Print all curse tags (if you really want to know it all). +Enables management of map features. -Examples: ---------- -``cursecheck detail all`` - Give detailed info about all cursed creatures including deceased ones (no - in-game cursor). -``cursecheck nick`` - Give a nickname all living/active cursed creatures on the map(no in-game - cursor). +* Discovering a magma feature (magma pool, volcano, magma sea, or curious + underground structure) permits magma workshops and furnaces to be built. +* Discovering a cavern layer causes plants (trees, shrubs, and grass) from + that cavern to grow within your fortress. -.. note:: +Options: - * If you do a full search (with the option "all") former ghosts will show up - with the cursetype "unknown" because their ghostly flag is not set - anymore. But if you happen to find a living/active creature with cursetype - "unknown" please report that in the dfhack thread on the modding forum or - per irc. This is likely to happen with mods which introduce new types - of curses, for example. + :list: Lists all map features in your current embark by index. + :show X: Marks the selected map feature as discovered. + :hide X: Marks the selected map feature as undiscovered. -follow -====== -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. +liquids +------- +Allows adding magma, water and obsidian to the game. It replaces the normal +dfhack command line and can't be used from a hotkey. Settings will be remembered +as long as dfhack runs. Intended for use in combination with the command +liquids-here (which can be bound to a hotkey). -forcepause -========== -Forces DF to pause. This is useful when your FPS drops below 1 and you lose -control of the game. +For more information, refer to the command's internal help. - * Activate with 'forcepause 1' - * Deactivate with 'forcepause 0' +.. note:: -nopause -======= -Disables pausing (both manual and automatic) with the exception of pause forced -by 'reveal hell'. This is nice for digging under rivers. + Spawning and deleting liquids can F up pathing data and + temperatures (creating heat traps). You've been warned. -die -=== -Instantly kills DF without saving. +liquids-here +------------ +Run the liquid spawner with the current/last settings made in liquids (if no +settings in liquids were made it paints a point of 7/7 magma by default). -autodump -======== -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. +Intended to be used as keybinding. Requires an active in-game cursor. -Cursor must be placed on a floor tile so the items can be dumped there. -Options -------- -:destroy: Destroy instead of dumping. Doesn't require a cursor. -:destroy-here: Destroy items only under the cursor. -:visible: Only process items that are not hidden. -:hidden: Only process hidden items. -:forbidden: Only process forbidden items (default: only unforbidden). +tiletypes +--------- +Can be used for painting map tiles and is an interactive command, much like +liquids. -autodump-destroy-here -===================== -Destroy items marked for dumping under cursor. Identical to autodump -destroy-here, but intended for use as keybinding. +The tool works with two set of options and a brush. The brush determines which +tiles will be processed. First set of options is the filter, which can exclude +some of the tiles from the brush by looking at the tile properties. The second +set of options is the paint - this determines how the selected tiles are +changed. -autodump-destroy-item -===================== -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. +Both paint and filter can have many different properties including things like +general shape (WALL, FLOOR, etc.), general material (SOIL, STONE, MINERAL, +etc.), state of 'designated', 'hidden' and 'light' flags. -burrow -====== -Miscellaneous burrow control. Allows manipulating burrows and automated burrow -expansion while digging. +The properties of filter and paint can be partially defined. This means that +you can for example do something like this: -Options -------- -:enable feature ...: -:disable feature ...: Enable or Disable features of the plugin. -:clear-unit burrow burrow ...: -:clear-tiles burrow burrow ...: Removes all units or tiles from the burrows. -:set-units target-burrow src-burrow ...: -:add-units target-burrow src-burrow ...: -:remove-units target-burrow src-burrow ...: Adds or removes units in source - burrows to/from the target burrow. Set is equivalent to clear and add. -:set-tiles target-burrow src-burrow ...: -:add-tiles target-burrow src-burrow ...: -:remove-tiles target-burrow src-burrow ...: Adds or removes tiles in source - burrows to/from the target burrow. In place of a source burrow it is - possible to use one of the following keywords: ABOVE_GROUND, - SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED - -Features --------- -:auto-grow: When a wall inside a burrow with a name ending in '+' is dug - out, the burrow is extended to newly-revealed adjacent walls. - This final '+' may be omitted in burrow name args of commands above. - Digging 1-wide corridors with the miner inside the burrow is SLOW. +:: -catsplosion -=========== -Makes cats just *multiply*. It is not a good idea to run this more than once or -twice. + filter material STONE + filter shape FORTIFICATION + paint shape FLOOR -clean -===== -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. +This will turn all stone fortifications into floors, preserving the material. -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. +Or this: +:: -Extra options for 'map' ------------------------ -:mud: Remove mud in addition to the normal stuff. -:snow: Also remove snow coverings. + filter shape FLOOR + filter material MINERAL + paint shape WALL -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. +Turning mineral vein floors back into walls. -cleanowned -========== -Confiscates items owned by dwarfs. By default, owned food on the floor -and rotten items are confistacted and dumped. +The tool also allows tweaking some tile flags: -Options -------- -:all: confiscate all owned items -:scattered: confiscated and dump all items scattered on the floor -:x: confiscate/dump items with wear level 'x' and more -:X: confiscate/dump items with wear level 'X' and more -:dryrun: a dry run. combine with other options to see what will happen - without it actually happening. +Or this: -Example: --------- -``cleanowned scattered X`` : This will confiscate rotten and dropped food, garbage on the floors and any worn items with 'X' damage and above. +:: -colonies -======== -Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies. + paint hidden 1 + paint hidden 0 -Options -------- -:bees: turn colonies into honey bee colonies +This will hide previously revealed tiles (or show hidden with the 0 option). -deramp (by zilpin) -================== -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). +Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword: -dfusion -======= -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 + paint hidden ANY + paint shape ANY + filter material any + filter shape any + filter any -Confirmed working DFusion plugins: ----------------------------------- -:simple_embark: allows changing the number of dwarves available on embark. +You can use several different brushes for painting tiles: + * Point. (point) + * Rectangular range. (range) + * A column ranging from current cursor to the first solid tile above. (column) + * DF map block - 16x16 tiles, in a regular grid. (block) -.. note:: - - * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes. - * 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. - -drybuckets -========== -This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye. - -fastdwarf -========= -Makes your minions move at ludicrous speeds. - - * Activate with 'fastdwarf 1' - * Deactivate with 'fastdwarf 0' +Example: -feature -======= -Enables management of map features. +:: -* Discovering a magma feature (magma pool, volcano, magma sea, or curious - underground structure) permits magma workshops and furnaces to be built. -* Discovering a cavern layer causes plants (trees, shrubs, and grass) from - that cavern to grow within your fortress. + range 10 10 1 -Options -------- -:list: Lists all map features in your current embark by index. -:show X: Marks the selected map feature as discovered. -:hide X: Marks the selected map feature as undiscovered. +This will change the brush to a rectangle spanning 10x10 tiles on one z-level. +The range starts at the position of the cursor and goes to the east, south and +up. -filltraffic -=========== -Set traffic designations using flood-fill starting at the cursor. +For more details, see the 'help' command while using this. -Traffic Type Codes: -------------------- -:H: High Traffic -:N: Normal Traffic -:L: Low Traffic -:R: Restricted Traffic +tiletypes-commands +------------------ +Runs tiletypes commands, separated by ;. This makes it possible to change +tiletypes modes from a hotkey. -Other Options: +tiletypes-here -------------- -: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. - -alltraffic -========== -Set traffic designations for every single tile of the map (useful for resetting traffic designations). +Apply the current tiletypes options at the in-game cursor position, including +the brush. Can be used from a hotkey. -Traffic Type Codes: -------------------- -:H: High Traffic -:N: Normal Traffic -:L: Low Traffic -:R: Restricted Traffic +tiletypes-here-point +-------------------- +Apply the current tiletypes options at the in-game cursor position to a single +tile. Can be used from a hotkey. -Example: +tubefill -------- -'alltraffic N' - Set traffic to 'normal' for all tiles. +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). -fixdiplomats -============ -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. +extirpate +--------- +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. -fixmerchants -============ -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. +Options: -fixveins -======== -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. + :shrubs: affect all shrubs on the map + :trees: affect all trees on the map + :all: affect every plant! -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. +grow +---- +Makes all saplings present on the map grow into trees (almost) instantly. -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. +immolate +-------- +Very similar to extirpate, but additionally sets the plants on fire. The fires +can and *will* spread ;) -Options +regrass ------- -:-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. - -tidlers -======= -Toggle between all possible positions where the idlers count can be placed. +Regrows grass. Not much to it ;) -twaterlvl -========= -Toggle between displaying/not displaying liquid depth as numbers. +weather +------- +Prints the current weather map by default. -job -=== -Command for general job query and manipulation. +Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Options: - * no extra options - Print details of the current job. The job can be selected - in a workshop, or the unit/jobs screen. - * list - Print details of all jobs in the selected workshop. - * item-material - Replace the exact material - id in the job item. - * item-type - Replace the exact item type id in - the job item. - -job-material -============ -Alter the material of the selected job. - -Invoked as: job-material - -Intended to be used as a keybinding: - * In 'q' mode, when a job is highlighted within a workshop or furnace, - changes the material of the job. Only inorganic materials can be used - in this mode. - * In 'b' mode, during selection of building components positions the cursor - over the first available choice with the matching material. - -job-duplicate -============= -Duplicate the selected job in a workshop: - * In 'q' mode, when a job is highlighted within a workshop or furnace building, - instantly duplicates the job. - -liquids -======= -Allows adding magma, water and obsidian to the game. It replaces the normal -dfhack command line and can't be used from a hotkey. Settings will be remembered -as long as dfhack runs. Intended for use in combination with the command -liquids-here (which can be bound to a hotkey). -For more information, refer to the command's internal help. + :snow: make it snow everywhere. + :rain: make it rain. + :clear: clear the sky. -.. note:: - - Spawning and deleting liquids can F up pathing data and - temperatures (creating heat traps). You've been warned. -liquids-here -============ -Run the liquid spawner with the current/last settings made in liquids (if no -settings in liquids were made it paints a point of 7/7 magma by default). +Map inspection +============== -Intended to be used as keybinding. Requires an active in-game cursor. +cursecheck +---------- +Checks a single map tile or the whole map/world for cursed creatures (ghosts, +vampires, necromancers, werebeasts, zombies). -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. There are a few good ones though. +With an active in-game cursor only the selected tile will be observed. +Without a cursor the whole map will be checked. -.. admonition:: Example +By default cursed creatures will be only counted in case you just want to find +out if you have any of them running around in your fort. Dead and passive +creatures (ghosts who were put to rest, killed vampires, ...) are ignored. +Undead skeletons, corpses, bodyparts and the like are all thrown into the curse +category "zombie". Anonymous zombies and resurrected body parts will show +as "unnamed creature". - You are in fort game mode, managing your fortress and paused. - You switch to the arena game mode, *assume control of a creature* and then - switch to adventure game mode(1). - You just lost a fortress and gained an adventurer. - You could also do this. - You are in fort game mode, managing your fortress and paused at the esc menu. - You switch to the adventure game mode, then use Dfusion to *assume control of a creature* and then - save or retire. - You just created a returnable mountain home and gained an adventurer. +Options: + :detail: Print full name, date of birth, date of curse and some status + info (some vampires might use fake identities in-game, though). + :nick: Set the type of curse as nickname (does not always show up + in-game, some vamps don't like nicknames). + :all: Include dead and passive cursed creatures (can result in a quite + long list after having FUN with necromancers). + :verbose: Print all curse tags (if you really want to know it all). -I take no responsibility of anything that happens as a result of using this tool +Examples: -extirpate -========= -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. + ``cursecheck detail all`` + Give detailed info about all cursed creatures including deceased ones (no + in-game cursor). + ``cursecheck nick`` + Give a nickname all living/active cursed creatures on the map(no in-game + cursor). -Options -------- -:shrubs: affect all shrubs on the map -:trees: affect all trees on the map -:all: affect every plant! +.. note:: -grow -==== -Makes all saplings present on the map grow into trees (almost) instantly. + * If you do a full search (with the option "all") former ghosts will show up + with the cursetype "unknown" because their ghostly flag is not set + anymore. But if you happen to find a living/active creature with cursetype + "unknown" please report that in the dfhack thread on the modding forum or + per irc. This is likely to happen with mods which introduce new types + of curses, for example. -immolate -======== -Very similar to extirpate, but additionally sets the plants on fire. The fires -can and *will* spread ;) +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. probe -===== +----- Can be used to determine tile properties like temperature. prospect -======== +-------- Prints a big list of all the present minerals and plants. By default, only the visible part of the map is scanned. -Options -------- -:all: Scan the whole map, as if it was revealed. -:value: Show material value in the output. Most useful for gems. -:hell: Show the Z range of HFS tubes. Implies 'all'. +Options: + + :all: Scan the whole map, as if it was revealed. + :value: Show material value in the output. Most useful for gems. + :hell: Show the Z range of HFS tubes. Implies 'all'. Pre-embark estimate -------------------- +................... + 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. -Options -------- -:all: processes all tiles, even hidden ones. - -regrass -======= -Regrows grass. Not much to it ;) - -rename -====== -Allows renaming various things. +Options: -Options -------- -:rename squad "name": Rename squad by index to 'name'. -:rename hotkey \"name\": 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 unit-profession "custom profession": Change proffession name of the - highlighted unit/creature. -:rename building "name": Set a custom name for the selected building. - The building must be one of stockpile, workshop, furnace, trap, - siege engine or an activity zone. + :all: processes all tiles, even hidden ones. 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. If you really want @@ -738,167 +623,325 @@ Reveal also works in adventure mode, but any of its effects are negated once you move. When you use it this way, you don't need to run 'unreveal'. unreveal -======== +-------- Reverts the effects of 'reveal'. revtoggle -========= +--------- Switches between 'reveal' and 'unreveal'. revflood -======== +-------- This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor. revforget -========= +--------- When you use reveal, it saves information about what was/wasn't visible before revealing everything. Unreveal uses this information to hide things again. This command throws away the information. For example, use in cases where you abandoned with the fort revealed and no longer want the data. -lair -==== -This command allows you to mark the map as 'monster lair', preventing item -scatter on abandon. When invoked as 'lair reset', it does the opposite. +showmood +-------- +Shows all items needed for the currently active strange mood. -Unlike reveal, this command doesn't save the information about tiles - you -won't be able to restore state of real monster lairs using 'lair reset'. -Options -------- -:lair: Mark the map as monster lair -:lair reset: Mark the map as ordinary (not lair) +Designations +============ -seedwatch -========= -Tool for turning cooking of seeds and plants on/off depending on how much you -have of them. +burrow +------ +Miscellaneous burrow control. Allows manipulating burrows and automated burrow +expansion while digging. -See 'seedwatch help' for detailed description. +Options: -showmood -======== -Shows all items needed for the currently active strange mood. + **enable feature ...** + Enable features of the plugin. + **disable feature ...** + Disable features of the plugin. + **clear-unit burrow burrow ...** + Remove all units from the burrows. + **clear-tiles burrow burrow ...** + Remove all tiles from the burrows. + **set-units target-burrow src-burrow ...** + Clear target, and adds units from source burrows. + **add-units target-burrow src-burrow ...** + Add units from the source burrows to the target. + **remove-units target-burrow src-burrow ...** + Remove units in source burrows from the target. + **set-tiles target-burrow src-burrow ...** + Clear target and adds tiles from the source burrows. + **add-tiles target-burrow src-burrow ...** + Add tiles from the source burrows to the target. + **remove-tiles target-burrow src-burrow ...** + Remove tiles in source burrows from the target. + + For these three options, in place of a source burrow it is + possible to use one of the following keywords: ABOVE_GROUND, + SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED + +Features: + + :auto-grow: When a wall inside a burrow with a name ending in '+' is dug + out, the burrow is extended to newly-revealed adjacent walls. + This final '+' may be omitted in burrow name args of commands above. + Digging 1-wide corridors with the miner inside the burrow is SLOW. -copystock -========== -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. +digv +---- +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). -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). +digvx +----- +A permanent alias for 'digv x'. -All the data resides in the 'stonesense' directory. For detailed instructions, -see stonesense/README.txt +digl +---- +Designates layer stone for digging. Requires an active in-game cursor placed +over a layer stone tile. With the 'x' option, it will traverse z-levels +(putting stairs between the same-material tiles). With the 'undo' option it +will remove the dig designation instead (if you realize that digging out a 50 +z-level deep layer was not such a good idea after all). -Compatible with Windows > XP SP3 and most modern Linux distributions. +diglx +----- +A permanent alias for 'digl x'. -Older versions, support and extra graphics can be found in the bay12 forum -thread: http://www.bay12forums.com/smf/index.php?topic=43260.0 +digexp +------ +This command can be used for exploratory mining. -Some additional resources: -http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository +See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining -tiletypes -========= -Can be used for painting map tiles and is an interactive command, much like -liquids. +There are two variables that can be set: pattern and filter. -The tool works with two set of options and a brush. The brush determines which -tiles will be processed. First set of options is the filter, which can exclude -some of the tiles from the brush by looking at the tile properties. The second -set of options is the paint - this determines how the selected tiles are -changed. +Patterns: -Both paint and filter can have many different properties including things like -general shape (WALL, FLOOR, etc.), general material (SOIL, STONE, MINERAL, -etc.), state of 'designated', 'hidden' and 'light' flags. + :diag5: diagonals separated by 5 tiles + :diag5r: diag5 rotated 90 degrees + :ladder: A 'ladder' pattern + :ladderr: ladder rotated 90 degrees + :clear: Just remove all dig designations + :cross: A cross, exactly in the middle of the map. -The properties of filter and paint can be partially defined. This means that -you can for example do something like this: +Filters: -:: + :all: designate whole z-level + :hidden: designate only hidden tiles of z-level (default) + :designated: Take current designation and apply pattern to it. - filter material STONE - filter shape FORTIFICATION - paint shape FLOOR +After you have a pattern set, you can use 'expdig' to apply it again. -This will turn all stone fortifications into floors, preserving the material. +Examples: -Or this: -:: + designate the diagonal 5 patter over all hidden tiles: + * expdig diag5 hidden + apply last used pattern and filter: + * expdig + Take current designations and replace them with the ladder pattern: + * expdig ladder designated - filter shape FLOOR - filter material MINERAL - paint shape WALL +digcircle +--------- +A command for easy designation of filled and hollow circles. +It has several types of options. -Turning mineral vein floors back into walls. +Shape: -The tool also allows tweaking some tile flags: + :hollow: Set the circle to hollow (default) + :filled: Set the circle to filled + :#: Diameter in tiles (default = 0, does nothing) -Or this: +Action: -:: + :set: Set designation (default) + :unset: Unset current designation + :invert: Invert designations already present - paint hidden 1 - paint hidden 0 +Designation types: -This will hide previously revealed tiles (or show hidden with the 0 option). + :dig: Normal digging designation (default) + :ramp: Ramp digging + :ustair: Staircase up + :dstair: Staircase down + :xstair: Staircase up/down + :chan: Dig channel -Any paint or filter option (or the entire paint or filter) can be disabled entirely by using the ANY keyword: +After you have set the options, the command called with no options +repeats with the last selected parameters. -:: +Examples: - paint hidden ANY - paint shape ANY - filter material any - filter shape any - filter any +* 'digcircle filled 3' = Dig a filled circle with radius = 3. +* 'digcircle' = Do it again. -You can use several different brushes for painting tiles: - * Point. (point) - * Rectangular range. (range) - * A column ranging from current cursor to the first solid tile above. (column) - * DF map block - 16x16 tiles, in a regular grid. (block) + +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. + +alltraffic +---------- +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: + + 'alltraffic N' - Set traffic to 'normal' for all tiles. + +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. + + +Cleanup and garbage disposal +============================ + +clean +----- +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. + +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. + +autodump +-------- +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. + +Options: + + :destroy: Destroy instead of dumping. Doesn't require a cursor. + :destroy-here: Destroy items only under the cursor. + :visible: Only process items that are not hidden. + :hidden: Only process hidden items. + :forbidden: Only process forbidden items (default: only unforbidden). + +autodump-destroy-here +--------------------- +Destroy items marked for dumping under cursor. Identical to autodump +destroy-here, but intended for use as keybinding. + +autodump-destroy-item +--------------------- +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. + +cleanowned +---------- +Confiscates items owned by dwarfs. By default, owned food on the floor +and rotten items are confistacted and dumped. + +Options: + + :all: confiscate all owned items + :scattered: confiscated and dump all items scattered on the floor + :x: confiscate/dump items with wear level 'x' and more + :X: confiscate/dump items with wear level 'X' and more + :dryrun: a dry run. combine with other options to see what will happen + without it actually happening. + +Example: + + ``cleanowned scattered X`` + This will confiscate rotten and dropped food, garbage on the floors and any + worn items with 'X' damage and above. - range 10 10 1 -This will change the brush to a rectangle spanning 10x10 tiles on one z-level. -The range starts at the position of the cursor and goes to the east, south and -up. -For more details, see the 'help' command while using this. +Bugfixes +======== -tiletypes-commands -================== -Runs tiletypes commands, separated by ;. This makes it possible to change -tiletypes modes from a hotkey. +drybuckets +---------- +This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye. -tiletypes-here -============== -Apply the current tiletypes options at the in-game cursor position, including -the brush. Can be used from a hotkey. +fixdiplomats +------------ +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. -tiletypes-here-point -==================== -Apply the current tiletypes options at the in-game cursor position to a single -tile. Can be used from a hotkey. +fixmerchants +------------ +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. + +fixveins +-------- +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. tweak -===== +----- Contains various tweaks for minor bugs (currently just one). -Options -------- +Options: + :clear-missing: Remove the missing status from the selected unit. This allows engraving slabs for ghostly, but not yet found, creatures. @@ -944,136 +987,139 @@ Options the contents separately from the container. This forcefully skips child reagents. -tubefill -======== -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). -digv -==== -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). +Mode switch and reclaim +======================= -digvx -===== -A permanent alias for 'digv x'. +lair +---- +This command allows you to mark the map as 'monster lair', preventing item +scatter on abandon. When invoked as 'lair reset', it does the opposite. -digl -==== -Designates layer stone for digging. Requires an active in-game cursor placed -over a layer stone tile. With the 'x' option, it will traverse z-levels -(putting stairs between the same-material tiles). With the 'undo' option it -will remove the dig designation instead (if you realize that digging out a 50 -z-level deep layer was not such a good idea after all). +Unlike reveal, this command doesn't save the information about tiles - you +won't be able to restore state of real monster lairs using 'lair reset'. -diglx -===== -A permanent alias for 'digl x'. +Options: -digexp -====== -This command can be used for exploratory mining. + :lair: Mark the map as monster lair + :lair reset: Mark the map as ordinary (not lair) -See: http://df.magmawiki.com/index.php/DF2010:Exploratory_mining +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. There are a few good ones though. -There are two variables that can be set: pattern and filter. +.. admonition:: Example -Patterns: ---------- -:diag5: diagonals separated by 5 tiles -:diag5r: diag5 rotated 90 degrees -:ladder: A 'ladder' pattern -:ladderr: ladder rotated 90 degrees -:clear: Just remove all dig designations -:cross: A cross, exactly in the middle of the map. + You are in fort game mode, managing your fortress and paused. + You switch to the arena game mode, *assume control of a creature* and then + switch to adventure game mode(1). + You just lost a fortress and gained an adventurer. + You could also do this. + You are in fort game mode, managing your fortress and paused at the esc menu. + You switch to the adventure game mode, then use Dfusion to *assume control of a creature* and then + save or retire. + You just created a returnable mountain home and gained an adventurer. -Filters: --------- -:all: designate whole z-level -:hidden: designate only hidden tiles of z-level (default) -:designated: Take current designation and apply pattern to it. -After you have a pattern set, you can use 'expdig' to apply it again. +I take no responsibility of anything that happens as a result of using this tool -Examples: ---------- -designate the diagonal 5 patter over all hidden tiles: - * expdig diag5 hidden -apply last used pattern and filter: - * expdig -Take current designations and replace them with the ladder pattern: - * expdig ladder designated -digcircle -========= -A command for easy designation of filled and hollow circles. -It has several types of options. +Visualizer and data export +========================== -Shape: --------- -:hollow: Set the circle to hollow (default) -:filled: Set the circle to filled -:#: Diameter in tiles (default = 0, does nothing) +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). -Action: -------- -:set: Set designation (default) -:unset: Unset current designation -:invert: Invert designations already present +All the data resides in the 'stonesense' directory. For detailed instructions, +see stonesense/README.txt -Designation types: ------------------- -:dig: Normal digging designation (default) -:ramp: Ramp digging -:ustair: Staircase up -:dstair: Staircase down -:xstair: Staircase up/down -:chan: Dig channel +Compatible with Windows > XP SP3 and most modern Linux distributions. -After you have set the options, the command called with no options -repeats with the last selected parameters. +Older versions, support and extra graphics can be found in the bay12 forum +thread: http://www.bay12forums.com/smf/index.php?topic=43260.0 -Examples: +Some additional resources: +http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository + +mapexport --------- -* 'digcircle filled 3' = Dig a filled circle with radius = 3. -* 'digcircle' = Do it again. +Export the current loaded map as a file. This will be eventually usable +with visualizers. -weather -======= -Prints the current weather map by default. +dwarfexport +----------= +Export dwarves to RuneSmith-compatible XML. -Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. + +Job management +============== + +job +--- +Command for general job query and manipulation. Options: --------- -:snow: make it snow everywhere. -:rain: make it rain. -:clear: clear the sky. + *no extra options* + Print details of the current job. The job can be selected + in a workshop, or the unit/jobs screen. + **list** + Print details of all jobs in the selected workshop. + **item-material ** + Replace the exact material id in the job item. + **item-type ** + Replace the exact item type id in the job item. + +job-material +------------ +Alter the material of the selected job. + +Invoked as:: + + job-material + +Intended to be used as a keybinding: + + * In 'q' mode, when a job is highlighted within a workshop or furnace, + changes the material of the job. Only inorganic materials can be used + in this mode. + * In 'b' mode, during selection of building components positions the cursor + over the first available choice with the matching material. + +job-duplicate +------------- +Duplicate the selected job in a workshop: + * In 'q' mode, when a job is highlighted within a workshop or furnace building, + instantly duplicates the job. workflow -======== +-------- Manage control of repeat jobs. -Usage ------ -``workflow enable [option...], workflow disable [option...]`` +Usage: + + ``workflow enable [option...], workflow disable [option...]`` If no options are specified, enables or disables the plugin. Otherwise, enables or disables any of the following options: - drybuckets: Automatically empty abandoned water buckets. - auto-melt: Resume melt jobs when there are objects to melt. -``workflow jobs`` + ``workflow jobs`` List workflow-controlled jobs (if in a workshop, filtered by it). -``workflow list`` + ``workflow list`` List active constraints, and their job counts. -``workflow count [cnt-gap], workflow amount [cnt-gap]`` + ``workflow count [cnt-gap], workflow amount [cnt-gap]`` Set a constraint. The first form counts each stack as only 1 item. -``workflow unlimit `` + ``workflow unlimit `` Delete a constraint. Function --------- +........ + 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. @@ -1086,7 +1132,8 @@ the frequency of jobs being toggled. Constraint examples -------------------- +................... + Keep metal bolts within 900-1000, and wood/bone within 150-200. :: @@ -1127,73 +1174,76 @@ Make sure there are always 80-100 units of dimple dye. on the Mill Plants job to MUSHROOM_CUP_DIMPLE using the 'job item-material' command. -mapexport -========= -Export the current loaded map as a file. This will be eventually usable -with visualizers. -dwarfexport -=========== -Export dwarves to RuneSmith-compatible XML. +Fortress activity management +============================ + +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. zone -==== +---- Helps a bit with managing activity zones (pens, pastures and pits) and cages. Options: --------- -:set: Set zone or cage under cursor as default for future assigns. -:assign: Assign unit(s) to the pen or pit marked with the 'set' command. + + :set: Set zone or cage under cursor as default for future assigns. + :assign: Assign unit(s) to the pen or pit marked with the 'set' command. If no filters are set a unit must be selected in the in-game ui. Can also be followed by a valid zone id which will be set instead. -:unassign: Unassign selected creature from it's zone. -:nick: Mass-assign nicknames, must be followed by the name you want + :unassign: Unassign selected creature from it's zone. + :nick: Mass-assign nicknames, must be followed by the name you want to set. -:remnick: Mass-remove nicknames. -:tocages: Assign unit(s) to cages inside a pasture. -:uinfo: Print info about unit(s). If no filters are set a unit must + :remnick: Mass-remove nicknames. + :tocages: Assign unit(s) to cages inside a pasture. + :uinfo: Print info about unit(s). If no filters are set a unit must be selected in the in-game ui. -:zinfo: Print info about zone(s). If no filters are set zones under + :zinfo: Print info about zone(s). If no filters are set zones under the cursor are listed. -:verbose: Print some more info. -:filters: Print list of valid filter options. -:examples: Print some usage examples. -:not: Negates the next filter keyword. + :verbose: Print some more info. + :filters: Print list of valid filter options. + :examples: Print some usage examples. + :not: Negates the next filter keyword. Filters: --------- -:all: Process all units (to be used with additional filters). -:count: Must be followed by a number. Process only n units (to be used - with additional filters). -:unassigned: Not assigned to zone, chain or built cage. -:minage: Minimum age. Must be followed by number. -:maxage: Maximum age. Must be followed by number. -:race: Must be followed by a race RAW ID (e.g. BIRD_TURKEY, ALPACA, - etc). Negatable. -:caged: In a built cage. Negatable. -:own: From own civilization. Negatable. -:merchant: Is a merchant / belongs to a merchant. Should only be used for - pitting, not for stealing animals (slaughter should work). -:war: Trained war creature. Negatable. -:hunting: Trained hunting creature. Negatable. -:tamed: Creature is tame. Negatable. -:trained: Creature is trained. Finds war/hunting creatures as well as - creatures who have a training level greater than 'domesticated'. - If you want to specifically search for war/hunting creatures use - 'war' or 'hunting' Negatable. -:trainablewar: Creature can be trained for war (and is not already trained for - war/hunt). Negatable. -:trainablehunt: Creature can be trained for hunting (and is not already trained - for war/hunt). Negatable. -:male: Creature is male. Negatable. -:female: Creature is female. Negatable. -:egglayer: Race lays eggs. Negatable. -:grazer: Race is a grazer. Negatable. -:milkable: Race is milkable. Negatable. + + :all: Process all units (to be used with additional filters). + :count: Must be followed by a number. Process only n units (to be used + with additional filters). + :unassigned: Not assigned to zone, chain or built cage. + :minage: Minimum age. Must be followed by number. + :maxage: Maximum age. Must be followed by number. + :race: Must be followed by a race RAW ID (e.g. BIRD_TURKEY, ALPACA, + etc). Negatable. + :caged: In a built cage. Negatable. + :own: From own civilization. Negatable. + :merchant: Is a merchant / belongs to a merchant. Should only be used for + pitting, not for stealing animals (slaughter should work). + :war: Trained war creature. Negatable. + :hunting: Trained hunting creature. Negatable. + :tamed: Creature is tame. Negatable. + :trained: Creature is trained. Finds war/hunting creatures as well as + creatures who have a training level greater than 'domesticated'. + If you want to specifically search for war/hunting creatures use + 'war' or 'hunting' Negatable. + :trainablewar: Creature can be trained for war (and is not already trained for + war/hunt). Negatable. + :trainablehunt: Creature can be trained for hunting (and is not already trained + for war/hunt). Negatable. + :male: Creature is male. Negatable. + :female: Creature is female. Negatable. + :egglayer: Race lays eggs. Negatable. + :grazer: Race is a grazer. Negatable. + :milkable: Race is milkable. Negatable. Usage with single units ------------------------ +....................... + One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -1202,7 +1252,8 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way. Usage with filters ------------------- +.................. + All filters can be used together with the 'assign' command. Restrictions: It's not possible to assign units who are inside built cages @@ -1223,14 +1274,16 @@ are not properly added to your own stocks; slaughtering them should work). Most filters can be negated (e.g. 'not grazer' -> race is not a grazer). Mass-renaming -------------- +............. + Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions. Cage zones ----------- +.......... + Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -1241,7 +1294,8 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters. Examples --------- +........ + ``zone assign all own ALPACA minage 3 maxage 10`` Assign all own alpacas who are between 3 and 10 years old to the selected pasture. @@ -1264,7 +1318,7 @@ Examples on the current default zone. autonestbox -=========== +----------- Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -1276,15 +1330,15 @@ nestbox zones when they revert to wild. When called without options autonestbox will instantly run once. Options: --------- -:start: Start running every X frames (df simulation ticks). - Default: X=6000, which would be every 60 seconds at 100fps. -:stop: Stop running automatically. -:sleep: Must be followed by number X. Changes the timer to sleep X - frames between runs. + + :start: Start running every X frames (df simulation ticks). + Default: X=6000, which would be every 60 seconds at 100fps. + :stop: Stop running automatically. + :sleep: Must be followed by number X. Changes the timer to sleep X + frames between runs. autobutcher -=========== +----------- Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed. @@ -1303,41 +1357,41 @@ If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults. Options: --------- -:start: Start running every X frames (df simulation ticks). - Default: X=6000, which would be every 60 seconds at 100fps. -:stop: Stop running automatically. -:sleep: Must be followed by number X. Changes the timer to sleep - X frames between runs. -:watch R: Start watching a race. R can be a valid race RAW id (ALPACA, - BIRD_TURKEY, etc) or a list of ids seperated by spaces or - the keyword 'all' which affects all races on your current - watchlist. -:unwatch R: Stop watching race(s). The current target settings will be - remembered. R can be a list of ids or the keyword 'all'. -:forget R: Stop watching race(s) and forget it's/their target settings. - R can be a list of ids or the keyword 'all'. -:autowatch: Automatically adds all new races (animals you buy from merchants, - tame yourself or get from migrants) to the watch list using - default target count. -:noautowatch: Stop auto-adding new races to the watchlist. -:list: Print the current status and watchlist. -:list_export: Print status and watchlist in a format which can be used - to import them to another savegame (see notes). -:target fk mk fa ma R: Set target count for specified race(s). - fk = number of female kids, - mk = number of male kids, - fa = number of female adults, - ma = number of female adults. - R can be a list of ids or the keyword 'all' or 'new'. - R = 'all': change target count for all races on watchlist - and set the new default for the future. R = 'new': don't touch - current settings on the watchlist, only set the new default - for future entries. -:example: Print some usage examples. + + :start: Start running every X frames (df simulation ticks). + Default: X=6000, which would be every 60 seconds at 100fps. + :stop: Stop running automatically. + :sleep: Must be followed by number X. Changes the timer to sleep + X frames between runs. + :watch R: Start watching a race. R can be a valid race RAW id (ALPACA, + BIRD_TURKEY, etc) or a list of ids seperated by spaces or + the keyword 'all' which affects all races on your current + watchlist. + :unwatch R: Stop watching race(s). The current target settings will be + remembered. R can be a list of ids or the keyword 'all'. + :forget R: Stop watching race(s) and forget it's/their target settings. + R can be a list of ids or the keyword 'all'. + :autowatch: Automatically adds all new races (animals you buy from merchants, + tame yourself or get from migrants) to the watch list using + default target count. + :noautowatch: Stop auto-adding new races to the watchlist. + :list: Print the current status and watchlist. + :list_export: Print status and watchlist in a format which can be used + to import them to another savegame (see notes). + :target fk mk fa ma R: Set target count for specified race(s). + fk = number of female kids, + mk = number of male kids, + fa = number of female adults, + ma = number of female adults. + R can be a list of ids or the keyword 'all' or 'new'. + R = 'all': change target count for all races on watchlist + and set the new default for the future. R = 'new': don't touch + current settings on the watchlist, only set the new default + for future entries. + :example: Print some usage examples. Examples: ---------- + You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -1369,8 +1423,8 @@ add some new races with 'watch'. If you simply want to stop it completely use autobutcher unwatch ALPACA CAT -Note: ------ +**Note:** + Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export: @@ -1384,7 +1438,7 @@ another savegame you can use the command list_export: autolabor -========= +--------- Automatically manage dwarf labors. When enabled, autolabor periodically checks your dwarves and enables or @@ -1398,6 +1452,30 @@ also tries to have dwarves specialize in specific skills. For detailed usage information, see 'help autolabor'. +Other +===== + +catsplosion +----------- +Makes cats just *multiply*. It is not a good idea to run this more than once or +twice. + +dfusion +------- +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 + +Confirmed working DFusion plugins: + +:simple_embark: allows changing the number of dwarves available on embark. + +.. note:: + + * Some of the DFusion plugins aren't completely ported yet. This can lead to crashes. + * 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. + ======= Scripts @@ -1413,19 +1491,6 @@ scripts that are obscure, developer-oriented, or should be used as keybindings. Some notable scripts: -quicksave -========= - -If called in dwarf mode, makes DF immediately auto-save the game by setting a flag -normally used in seasonal auto-save. - -setfps -====== - -Run ``setfps `` to set the FPS cap at runtime, in case you want to watch -combat in slow motion or something :) - - fix/* ===== @@ -1462,6 +1527,17 @@ gui/* Scripts that implement dialogs inserted into the main game window are put in this directory. +quicksave +========= + +If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save. + +setfps +====== + +Run ``setfps `` to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :) growcrops ========= @@ -1684,10 +1760,12 @@ Exiting from the siege engine script via ESC reverts the view to the state prior the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main menu. -**DISCLAIMER**: Siege engines are a very interesting feature, but currently nearly useless -because they haven't been updated since 2D and can only aim in four directions. This is an -attempt to bring them more up to date until Toady has time to work on it. Actual improvements, -e.g. like making siegers bring their own, are something only Toady can do. +.. admonition:: DISCLAIMER + + Siege engines are a very interesting feature, but currently nearly useless + because they haven't been updated since 2D and can only aim in four directions. This is an + attempt to bring them more up to date until Toady has time to work on it. Actual improvements, + e.g. like making siegers bring their own, are something only Toady can do. ========= @@ -1723,20 +1801,24 @@ The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma. -**ISSUE**: Since this building is a machine, and machine collapse -code cannot be modified, it would collapse over true open space. -As a loophole, down stair provides support to machines, while -being passable, so use them. +.. admonition:: ISSUE + + Since this building is a machine, and machine collapse + code cannot be modified, it would collapse over true open space. + As a loophole, down stair provides support to machines, while + being passable, so use them. After constructing the building itself, machines can be connected to the edge tiles that look like gear boxes. Their exact position is extracted from the workshop raws. -**ISSUE**: Like with collapse above, part of the code involved in -machine connection cannot be modified. As a result, the workshop -can only immediately connect to machine components built AFTER it. -This also means that engines cannot be chained without intermediate -short axles that can be built later than both of the engines. +.. admonition:: ISSUE + + Like with collapse above, part of the code involved in + machine connection cannot be modified. As a result, the workshop + can only immediately connect to machine components built AFTER it. + This also means that engines cannot be chained without intermediate + short axles that can be built later than both of the engines. Operation --------- diff --git a/Readme.html b/Readme.html index 977c4177d..be6856fb6 100644 --- a/Readme.html +++ b/Readme.html @@ -318,7 +318,7 @@ ul.auto-toc {

DFHack Readme

-

Introduction

+

Introduction

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,250 +326,192 @@ access DF memory and allow for easier development of new tools.

Contents

-

Getting DFHack

+

Getting DFHack

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

-

Compatibility

+

Compatibility

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, versions 0.34.08 - 0.34.11 are supported. If you need DFHack @@ -578,7 +520,7 @@ for older versions, look for older releases.

It is possible to use the Windows DFHack under wine/OSX.

-

Installation/Removal

+

Installation/Removal

Installing DFhack involves copying files into your DF folder. Copy the files from a release archive so that:

@@ -600,7 +542,7 @@ remove the other DFHack files file created in your DF folder.

-

Using DFHack

+

Using DFHack

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 @@ -624,7 +566,7 @@ they are re-created every time it is loaded.

Most of the commands come from plugins. Those reside in 'hack/plugins/'.

-

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 - stderr.log and stdout.log. You can look at those and possibly find out what's happening. @@ -633,13 +575,13 @@ the issues tracker on github, contact me ( -

The init file

+

The init file

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.

-

Setting keybindings

+

Setting keybindings

To set keybindings, use the built-in keybinding command. Like any other command it can be used at any time from the console, but it is also meaningful in the DFHack init file.

@@ -684,17 +626,107 @@ for context foo/bar/baz, possible matches are
-

Commands

+

Commands

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.

+
+

Game progress

+
+

die

+

Instantly kills DF without saving.

+
+
+

forcepause

+

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'
    • +
+
+
+
+

nopause

+

Disables pausing (both manual and automatic) with the exception of pause forced +by 'reveal hell'. This is nice for digging under rivers.

+
+
+

fastdwarf

+

Makes your minions move at ludicrous speeds.

+
+
    +
  • Activate with 'fastdwarf 1'
    • +
  • Deactivate with 'fastdwarf 0'
    • +
+
+
+
+
+

Game interface

+
+

follow

+

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.

+
+
+

tidlers

+

Toggle between all possible positions where the idlers count can be placed.

+
+
+

twaterlvl

+

Toggle between displaying/not displaying liquid depth as numbers.

+
+
+

copystock

+

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.

+
+
+

rename

+

Allows renaming various things.

+

Options:

+
+ +++ + + + + + + + + + + + + + + + + +
rename squad <index> "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 unit "nickname":
 Rename a unit/creature highlighted in the DF user +interface.
rename unit-profession "custom profession":
 Change proffession name of the +highlighted unit/creature.
rename building "name":
 Set a custom name for the selected building. +The building must be one of stockpile, workshop, furnace, trap, +siege engine or an activity zone.
+
+
+
+
+

Adventure mode

-

adv-bodyswap

+

adv-bodyswap

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.

-
-

Usage

+

Usage:

  • When viewing unit details, body-swaps into that unit.
    • @@ -702,12 +734,11 @@ properly.

-
-

advtools

+

advtools

A package of different adventure mode tools (currently just one)

-
-

Usage

+

Usage:

+
@@ -723,10 +754,13 @@ on item type and being in shop.
+
+
+

Map modification

-

changelayer

+

changelayer

Changes material of the geology layer under cursor to the specified inorganic RAW material. Can have impact on all surrounding regions, not only your embark! By default changing stone to soil and vice versa is not allowed. By default @@ -737,8 +771,8 @@ as well, though. Mineral veins and gem clusters will stay on the map. Use 'changevein' for them.

tl;dr: You will end up with changing quite big areas in one go, especially if you use it in lower z levels. Use with care.

-
-

Options

+

Options:

+
@@ -770,9 +804,9 @@ soil.
-
-
-

Examples:

+ +

Examples:

+
changelayer GRANITE
Convert layer at cursor position into granite.
@@ -781,6 +815,7 @@ soil.
changelayer MARBLE all_biomes all_layers
Convert all layers of all biomes which are not soil into marble.
+

Note

    @@ -799,22 +834,21 @@ You did save your game, right?
-
-

changevein

+

changevein

Changes material of the vein under cursor to the specified inorganic RAW material. Only affects tiles within the current 16x16 block - for veins and large clusters, you will need to use this command multiple times.

-
-

Example:

+

Example:

+
changevein NATIVE_PLATINUM
Convert vein at cursor position into platinum ore.
-
+
-

changeitem

+

changeitem

Allows changing item material and base quality. By default the item currently selected in the UI will be changed (you can select items in the 'k' list or inside containers/inventory). By default change is only allowed if materials @@ -824,8 +858,8 @@ with 'force'. Note that some attributes will not be touched, possibly resulting in weirdness. To get an idea how the RAW id should look like, check some items with 'info'. Using 'force' might create items which are not touched by crafters/haulers.

-
-

Options

+

Options:

+
@@ -842,749 +876,83 @@ crafters/haulers.

-
-
-

Examples:

+ +

Examples:

+
changeitem m INORGANIC:GRANITE here
Change material of all items under the cursor to granite.
changeitem q 5
Change currently selected item to masterpiece quality.
+
-
-
-

cursecheck

-

Checks a single map tile or the whole map/world for cursed creatures (ghosts, -vampires, necromancers, werebeasts, zombies).

-

With an active in-game cursor only the selected tile will be observed. -Without a cursor the whole map will be checked.

-

By default cursed creatures will be only counted in case you just want to find -out if you have any of them running around in your fort. Dead and passive -creatures (ghosts who were put to rest, killed vampires, ...) are ignored. -Undead skeletons, corpses, bodyparts and the like are all thrown into the curse -category "zombie". Anonymous zombies and resurrected body parts will show -as "unnamed creature".

-
-

Options

+
+

colonies

+

Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.

+

Options:

+
- - - - - - - +
detail:Print full name, date of birth, date of curse and some status -info (some vampires might use fake identities in-game, though).
nick:Set the type of curse as nickname (does not always show up -in-game, some vamps don't like nicknames).
all:Include dead and passive cursed creatures (can result in a quite -long list after having FUN with necromancers).
verbose:Print all curse tags (if you really want to know it all).
bees:turn colonies into honey bee colonies
+
-
-

Examples:

-
-
cursecheck detail all
-
Give detailed info about all cursed creatures including deceased ones (no -in-game cursor).
-
cursecheck nick
-
Give a nickname all living/active cursed creatures on the map(no in-game -cursor).
-
-
-

Note

-
    -
  • If you do a full search (with the option "all") former ghosts will show up -with the cursetype "unknown" because their ghostly flag is not set -anymore. But if you happen to find a living/active creature with cursetype -"unknown" please report that in the dfhack thread on the modding forum or -per irc. This is likely to happen with mods which introduce new types -of curses, for example.
    • -
-
-
-
-
-

follow

-

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.

+
+

deramp (by zilpin)

+

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).

-
-

forcepause

-

Forces DF to pause. This is useful when your FPS drops below 1 and you lose -control of the game.

-
+
+

feature

+

Enables management of map features.

    -
  • Activate with 'forcepause 1'
    • -
  • Deactivate with 'forcepause 0'
    • +
  • Discovering a magma feature (magma pool, volcano, magma sea, or curious +underground structure) permits magma workshops and furnaces to be built.
    • +
  • Discovering a cavern layer causes plants (trees, shrubs, and grass) from +that cavern to grow within your fortress.
-
-
-
-

nopause

-

Disables pausing (both manual and automatic) with the exception of pause forced -by 'reveal hell'. This is nice for digging under rivers.

-
-
-

die

-

Instantly kills DF without saving.

-
-
-

autodump

-

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.

-
-

Options

+

Options:

+
- - - - - + - + - +
destroy:Destroy instead of dumping. Doesn't require a cursor.
destroy-here:Destroy items only under the cursor.
visible:Only process items that are not hidden.
list:Lists all map features in your current embark by index.
hidden:Only process hidden items.
show X:Marks the selected map feature as discovered.
forbidden:Only process forbidden items (default: only unforbidden).
hide X:Marks the selected map feature as undiscovered.
+
+
+

liquids

+

Allows adding magma, water and obsidian to the game. It replaces the normal +dfhack command line and can't be used from a hotkey. Settings will be remembered +as long as dfhack runs. Intended for use in combination with the command +liquids-here (which can be bound to a hotkey).

+

For more information, refer to the command's internal help.

+
+

Note

+

Spawning and deleting liquids can F up pathing data and +temperatures (creating heat traps). You've been warned.

-
-

autodump-destroy-here

-

Destroy items marked for dumping under cursor. Identical to autodump -destroy-here, but intended for use as keybinding.

-
-
-

autodump-destroy-item

-

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.

-
-

burrow

-

Miscellaneous burrow control. Allows manipulating burrows and automated burrow -expansion while digging.

-
-

Options

- --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
enable feature ...:
 
disable feature ...:
 Enable or Disable features of the plugin.
clear-unit burrow burrow ...:
 
clear-tiles burrow burrow ...:
 Removes all units or tiles from the burrows.
set-units target-burrow src-burrow ...:
 
add-units target-burrow src-burrow ...:
 
remove-units target-burrow src-burrow ...:
 Adds or removes units in source -burrows to/from the target burrow. Set is equivalent to clear and add.
set-tiles target-burrow src-burrow ...:
 
add-tiles target-burrow src-burrow ...:
 
remove-tiles target-burrow src-burrow ...:
 Adds or removes tiles in source -burrows to/from the target burrow. In place of a source burrow it is -possible to use one of the following keywords: ABOVE_GROUND, -SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED
-
-
-

Features

- --- - - - -
auto-grow:When a wall inside a burrow with a name ending in '+' is dug -out, the burrow is extended to newly-revealed adjacent walls. -This final '+' may be omitted in burrow name args of commands above. -Digging 1-wide corridors with the miner inside the burrow is SLOW.
-
-
-
-

catsplosion

-

Makes cats just multiply. It is not a good idea to run this more than once or -twice.

-
-
-

clean

-

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.

-
-

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

-

Confiscates items owned by dwarfs. By default, owned food on the floor -and rotten items are confistacted and dumped.

-
-

Options

- --- - - - - - - - - - - - -
all:confiscate all owned items
scattered:confiscated and dump all items scattered on the floor
x:confiscate/dump items with wear level 'x' and more
X:confiscate/dump items with wear level 'X' and more
dryrun:a dry run. combine with other options to see what will happen -without it actually happening.
-
-
-

Example:

-

cleanowned scattered X : This will confiscate rotten and dropped food, garbage on the floors and any worn items with 'X' damage and above.

-
-
-
-

colonies

-

Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.

-
-

Options

- --- - - - -
bees:turn colonies into honey bee colonies
-
-
-
-

deramp (by zilpin)

-

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).

-
-
-

dfusion

-

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

-
-

Confirmed working DFusion plugins:

- --- - - - -
simple_embark:allows changing the number of dwarves available on embark.
-
-

Note

-
    -
  • Some of the DFusion plugins aren't completely ported yet. This can lead to crashes.
    • -
  • 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.
    • -
-
-
-
-
-

drybuckets

-

This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.

-
-
-

fastdwarf

-

Makes your minions move at ludicrous speeds.

-
-
    -
  • Activate with 'fastdwarf 1'
    • -
  • Deactivate with 'fastdwarf 0'
    • -
-
-
-
-

feature

-

Enables management of map features.

-
    -
  • Discovering a magma feature (magma pool, volcano, magma sea, or curious -underground structure) permits magma workshops and furnaces to be built.
    • -
  • Discovering a cavern layer causes plants (trees, shrubs, and grass) from -that cavern to grow within your fortress.
    • -
-
-

Options

- --- - - - - - - - -
list:Lists all map features in your current embark by index.
show X:Marks the selected map feature as discovered.
hide X:Marks the selected map feature as undiscovered.
-
-
-
-

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.

-
-
-
-

alltraffic

-

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:

-

'alltraffic N' - Set traffic to 'normal' for all tiles.

-
-
-
-

fixdiplomats

-

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.

-
-
-

fixmerchants

-

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.

-
-
-

fixveins

-

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.

-
-
-

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.

-
-
-

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.

-
-
-
-

tidlers

-

Toggle between all possible positions where the idlers count can be placed.

-
-
-

twaterlvl

-

Toggle between displaying/not displaying liquid depth as numbers.

-
-
-

job

-

Command for general job query and manipulation.

-
-
Options:
-
    -
  • no extra options - Print details of the current job. The job can be selected -in a workshop, or the unit/jobs screen.
    • -
  • list - Print details of all jobs in the selected workshop.
    • -
  • item-material <item-idx> <material[:subtoken]> - Replace the exact material -id in the job item.
    • -
  • item-type <item-idx> <type[:subtype]> - Replace the exact item type id in -the job item.
    • -
-
-
-
-
-

job-material

-

Alter the material of the selected job.

-

Invoked as: job-material <inorganic-token>

-
-
Intended to be used as a keybinding:
-
    -
  • In 'q' mode, when a job is highlighted within a workshop or furnace, -changes the material of the job. Only inorganic materials can be used -in this mode.
    • -
  • In 'b' mode, during selection of building components positions the cursor -over the first available choice with the matching material.
    • -
-
-
-
-
-

job-duplicate

-
-
Duplicate the selected job in a workshop:
-
    -
  • In 'q' mode, when a job is highlighted within a workshop or furnace building, -instantly duplicates the job.
    • -
-
-
-
-
-

liquids

-

Allows adding magma, water and obsidian to the game. It replaces the normal -dfhack command line and can't be used from a hotkey. Settings will be remembered -as long as dfhack runs. Intended for use in combination with the command -liquids-here (which can be bound to a hotkey).

-

For more information, refer to the command's internal help.

-
-

Note

-

Spawning and deleting liquids can F up pathing data and -temperatures (creating heat traps). You've been warned.

-
-
-
-

liquids-here

-

Run the liquid spawner with the current/last settings made in liquids (if no -settings in liquids were made it paints a point of 7/7 magma by default).

-

Intended to be used as keybinding. Requires an active in-game cursor.

-
-
-

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. There are a few good ones though.

-
-

Example

-

You are in fort game mode, managing your fortress and paused. -You switch to the arena game mode, assume control of a creature and then -switch to adventure game mode(1). -You just lost a fortress and gained an adventurer. -You could also do this. -You are in fort game mode, managing your fortress and paused at the esc menu. -You switch to the adventure game mode, then use Dfusion to assume control of a creature and then -save or retire. -You just created a returnable mountain home and gained an adventurer.

-
-

I take no responsibility of anything that happens as a result of using this tool

-
-
-

extirpate

-

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.

-
-

Options

- --- - - - - - - - -
shrubs:affect all shrubs on the map
trees:affect all trees on the map
all:affect every plant!
-
-
-
-

grow

-

Makes all saplings present on the map grow into trees (almost) instantly.

-
-
-

immolate

-

Very similar to extirpate, but additionally sets the plants on fire. The fires -can and will spread ;)

-
-
-

probe

-

Can be used to determine tile properties like temperature.

-
-
-

prospect

-

Prints a big list of all the present minerals and plants. By default, only -the visible part of the map is scanned.

-
-

Options

- --- - - - - - - - -
all:Scan the whole map, as if it was revealed.
value:Show material value in the output. Most useful for gems.
hell:Show the Z range of HFS tubes. Implies 'all'.
-
-
-

Pre-embark estimate

-

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.

-
-
-

Options

- --- - - - -
all:processes all tiles, even hidden ones.
-
-
-
-

regrass

-

Regrows grass. Not much to it ;)

-
-
-

rename

-

Allows renaming various things.

-
-

Options

- --- - - - - - - - - - - - - - - - - -
rename squad <index> "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 unit "nickname":
 Rename a unit/creature highlighted in the DF user -interface.
rename unit-profession "custom profession":
 Change proffession name of the -highlighted unit/creature.
rename building "name":
 Set a custom name for the selected building. -The building must be one of stockpile, workshop, furnace, trap, -siege engine or an activity zone.
-
-
-
-

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. If you really want -to unpause with hell revealed, use 'reveal demons'.

-

Reveal also works in adventure mode, but any of its effects are negated once -you move. When you use it this way, you don't need to run 'unreveal'.

-
-
-

unreveal

-

Reverts the effects of 'reveal'.

-
-
-

revtoggle

-

Switches between 'reveal' and 'unreveal'.

-
-
-

revflood

-

This command will hide the whole map and then reveal all the tiles that have -a path to the in-game cursor.

-
-
-

revforget

-

When you use reveal, it saves information about what was/wasn't visible before -revealing everything. Unreveal uses this information to hide things again. -This command throws away the information. For example, use in cases where -you abandoned with the fort revealed and no longer want the data.

-
-
-

lair

-

This command allows you to mark the map as 'monster lair', preventing item -scatter on abandon. When invoked as 'lair reset', it does the opposite.

-

Unlike reveal, this command doesn't save the information about tiles - you -won't be able to restore state of real monster lairs using 'lair reset'.

-
-

Options

- --- - - - - - -
lair:Mark the map as monster lair
lair reset:Mark the map as ordinary (not lair)
-
-
-
-

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.

-
-
-

showmood

-

Shows all items needed for the currently active strange mood.

-
-
-

copystock

-

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.

-
-
-

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).

-

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.

-

Older versions, support and extra graphics can be found in the bay12 forum -thread: http://www.bay12forums.com/smf/index.php?topic=43260.0

-

Some additional resources: -http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

+
+

liquids-here

+

Run the liquid spawner with the current/last settings made in liquids (if no +settings in liquids were made it paints a point of 7/7 magma by default).

+

Intended to be used as keybinding. Requires an active in-game cursor.

-

tiletypes

+

tiletypes

Can be used for painting map tiles and is an interactive command, much like liquids.

The tool works with two set of options and a brush. The brush determines which @@ -1645,107 +1013,280 @@ up.

For more details, see the 'help' command while using this.

-

tiletypes-commands

+

tiletypes-commands

Runs tiletypes commands, separated by ;. This makes it possible to change tiletypes modes from a hotkey.

-

tiletypes-here

+

tiletypes-here

Apply the current tiletypes options at the in-game cursor position, including the brush. Can be used from a hotkey.

-

tiletypes-here-point

+

tiletypes-here-point

Apply the current tiletypes options at the in-game cursor position to a single tile. Can be used from a hotkey.

-
-

tweak

-

Contains various tweaks for minor bugs (currently just one).

-
-

Options

+
+

tubefill

+

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).

+
+
+

extirpate

+

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.

+

Options:

+
- + - + - + - + +
clear-missing:Remove the missing status from the selected unit. -This allows engraving slabs for ghostly, but not yet -found, creatures.
shrubs:affect all shrubs on the map
clear-ghostly:Remove the ghostly status from the selected unit and mark -it as dead. This allows getting rid of bugged ghosts -which do not show up in the engraving slab menu at all, -even after using clear-missing. It works, but is -potentially very dangerous - so use with care. Probably -(almost certainly) it does not have the same effects like -a proper burial. You've been warned.
trees:affect all trees on the map
fixmigrant:Remove the resident/merchant flag from the selected unit. -Intended to fix bugged migrants/traders who stay at the -map edge and don't enter your fort. Only works for -dwarves (or generally the player's race in modded games). -Do NOT abuse this for 'real' caravan merchants (if you -really want to kidnap them, use 'tweak makeown' instead, -otherwise they will have their clothes set to forbidden etc).
all:affect every plant!
makeown:Force selected unit to become a member of your fort. -Can be abused to grab caravan merchants and escorts, even if -they don't belong to the player's race. Foreign sentients -(humans, elves) can be put to work, but you can't assign rooms -to them and they don't show up in DwarfTherapist because the -game treats them like pets. Grabbing draft animals from -a caravan can result in weirdness (animals go insane or berserk -and are not flagged as tame), but you are allowed to mark them -for slaughter. Grabbing wagons results in some funny spam, then -they are scuttled.
+
+
+
+

grow

+

Makes all saplings present on the map grow into trees (almost) instantly.

+
+
+

immolate

+

Very similar to extirpate, but additionally sets the plants on fire. The fires +can and will spread ;)

+
+
+

regrass

+

Regrows grass. Not much to it ;)

+
+
+

weather

+

Prints the current weather map by default.

+

Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.

+

Options:

+
+ +++ + - + - + - - + +
snow:make it snow everywhere.
stable-cursor:Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode.
rain:make it rain.
patrol-duty:Makes Train orders not count as patrol duty to stop unhappy thoughts. -Does NOT fix the problem when soldiers go off-duty (i.e. civilian).
clear:clear the sky.
readable-build-plate:
 Fixes rendering of creature weight limits in pressure plate build menu.
+
+
+
+
+

Map inspection

+
+

cursecheck

+

Checks a single map tile or the whole map/world for cursed creatures (ghosts, +vampires, necromancers, werebeasts, zombies).

+

With an active in-game cursor only the selected tile will be observed. +Without a cursor the whole map will be checked.

+

By default cursed creatures will be only counted in case you just want to find +out if you have any of them running around in your fort. Dead and passive +creatures (ghosts who were put to rest, killed vampires, ...) are ignored. +Undead skeletons, corpses, bodyparts and the like are all thrown into the curse +category "zombie". Anonymous zombies and resurrected body parts will show +as "unnamed creature".

+

Options:

+
+ +++ + - + - + - + - - + +
detail:Print full name, date of birth, date of curse and some status +info (some vampires might use fake identities in-game, though).
stable-temp:Fixes performance bug 6012 by squashing jitter in temperature updates. -In very item-heavy forts with big stockpiles this can improve FPS by 50-100%
nick:Set the type of curse as nickname (does not always show up +in-game, some vamps don't like nicknames).
fast-heat:Further improves temperature update performance by ensuring that 1 degree -of item temperature is crossed in no more than specified number of frames -when updating from the environment temperature. This reduces the time it -takes for stable-temp to stop updates again when equilibrium is disturbed.
all:Include dead and passive cursed creatures (can result in a quite +long list after having FUN with necromancers).
fix-dimensions:Fixes subtracting small amount of thread/cloth/liquid from a stack -by splitting the stack and subtracting from the remaining single item. -This is a necessary addition to the binary patch in bug 808.
verbose:Print all curse tags (if you really want to know it all).
advmode-contained:
 Works around bug 6202, i.e. custom reactions with container inputs -in advmode. The issue is that the screen tries to force you to select -the contents separately from the container. This forcefully skips child -reagents.
+
+

Examples:

+
+
+
cursecheck detail all
+
Give detailed info about all cursed creatures including deceased ones (no +in-game cursor).
+
cursecheck nick
+
Give a nickname all living/active cursed creatures on the map(no in-game +cursor).
+
+
+
+

Note

+
    +
  • If you do a full search (with the option "all") former ghosts will show up +with the cursetype "unknown" because their ghostly flag is not set +anymore. But if you happen to find a living/active creature with cursetype +"unknown" please report that in the dfhack thread on the modding forum or +per irc. This is likely to happen with mods which introduce new types +of curses, for example.
    • +
+
+
+
+

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.

+
+
+

probe

+

Can be used to determine tile properties like temperature.

+
+
+

prospect

+

Prints a big list of all the present minerals and plants. By default, only +the visible part of the map is scanned.

+

Options:

+
+ +++ + + + + + + + +
all:Scan the whole map, as if it was revealed.
value:Show material value in the output. Most useful for gems.
hell:Show the Z range of HFS tubes. Implies 'all'.
+
+
+

Pre-embark estimate

+

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.

+

Options:

+
+ +++ + + + +
all:processes all tiles, even hidden ones.
+
+
+
+
+

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. If you really want +to unpause with hell revealed, use 'reveal demons'.

+

Reveal also works in adventure mode, but any of its effects are negated once +you move. When you use it this way, you don't need to run 'unreveal'.

+
+
+

unreveal

+

Reverts the effects of 'reveal'.

+
+
+

revtoggle

+

Switches between 'reveal' and 'unreveal'.

+
+
+

revflood

+

This command will hide the whole map and then reveal all the tiles that have +a path to the in-game cursor.

+
+
+

revforget

+

When you use reveal, it saves information about what was/wasn't visible before +revealing everything. Unreveal uses this information to hide things again. +This command throws away the information. For example, use in cases where +you abandoned with the fort revealed and no longer want the data.

+
+
+

showmood

+

Shows all items needed for the currently active strange mood.

+
+
+
+

Designations

+
+

burrow

+

Miscellaneous burrow control. Allows manipulating burrows and automated burrow +expansion while digging.

+

Options:

+
+
+
enable feature ...
+
Enable features of the plugin.
+
disable feature ...
+
Disable features of the plugin.
+
clear-unit burrow burrow ...
+
Remove all units from the burrows.
+
clear-tiles burrow burrow ...
+
Remove all tiles from the burrows.
+
set-units target-burrow src-burrow ...
+
Clear target, and adds units from source burrows.
+
add-units target-burrow src-burrow ...
+
Add units from the source burrows to the target.
+
remove-units target-burrow src-burrow ...
+
Remove units in source burrows from the target.
+
set-tiles target-burrow src-burrow ...
+
Clear target and adds tiles from the source burrows.
+
add-tiles target-burrow src-burrow ...
+
Add tiles from the source burrows to the target.
+
remove-tiles target-burrow src-burrow ...
+

Remove tiles in source burrows from the target.

+

For these three options, in place of a source burrow it is +possible to use one of the following keywords: ABOVE_GROUND, +SUBTERRANEAN, INSIDE, OUTSIDE, LIGHT, DARK, HIDDEN, REVEALED

+
+
+
+

Features:

+
+ +++ +
auto-grow:When a wall inside a burrow with a name ending in '+' is dug +out, the burrow is extended to newly-revealed adjacent walls. +This final '+' may be omitted in burrow name args of commands above. +Digging 1-wide corridors with the miner inside the burrow is SLOW.
-
-
-
-

tubefill

-

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).

+
-

digv

+

digv

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).

-

digvx

+

digvx

A permanent alias for 'digv x'.

-

digl

+

digl

Designates layer stone for digging. Requires an active in-game cursor placed over a layer stone tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles). With the 'undo' option it @@ -1753,16 +1294,16 @@ will remove the dig designation instead (if you realize that digging out a 50 z-level deep layer was not such a good idea after all).

-

diglx

+

diglx

A permanent alias for 'digl x'.

-

digexp

+

digexp

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.

-
-

Patterns:

+

Patterns:

+
@@ -1781,9 +1322,9 @@ z-level deep layer was not such a good idea after all).

-
-
-

Filters:

+ +

Filters:

+
@@ -1796,10 +1337,10 @@ z-level deep layer was not such a good idea after all).

+

After you have a pattern set, you can use 'expdig' to apply it again.

-
-
-

Examples:

+

Examples:

+
designate the diagonal 5 patter over all hidden tiles:
    @@ -1817,14 +1358,14 @@ z-level deep layer was not such a good idea after all).

-
+
-

digcircle

+

digcircle

A command for easy designation of filled and hollow circles. It has several types of options.

-
-

Shape:

+

Shape:

+
@@ -1837,78 +1378,470 @@ It has several types of options.

+
+

Action:

+
+ +++ + + + + + + + +
set:Set designation (default)
unset:Unset current designation
invert:Invert designations already present
+
+

Designation types:

+
+ +++ + + + + + + + + + + + + + +
dig:Normal digging designation (default)
ramp:Ramp digging
ustair:Staircase up
dstair:Staircase down
xstair:Staircase up/down
chan:Dig channel
+
+

After you have set the options, the command called with no options +repeats with the last selected parameters.

+

Examples:

+
    +
  • 'digcircle filled 3' = Dig a filled circle with radius = 3.
    • +
  • 'digcircle' = Do it again.
    • +
+
+
+

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.
+
+
+

alltraffic

+

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:

+
+'alltraffic N' - Set traffic to 'normal' for all tiles.
+
+
+

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.

+
+
+
+

Cleanup and garbage disposal

+
+

clean

+

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.

+

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.

+
+
+

autodump

+

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.

+

Options:

+
+ +++ + + + + + + + + + + + +
destroy:Destroy instead of dumping. Doesn't require a cursor.
destroy-here:Destroy items only under the cursor.
visible:Only process items that are not hidden.
hidden:Only process hidden items.
forbidden:Only process forbidden items (default: only unforbidden).
+
+
+
+

autodump-destroy-here

+

Destroy items marked for dumping under cursor. Identical to autodump +destroy-here, but intended for use as keybinding.

+
+
+

autodump-destroy-item

+

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.

+
+
+

cleanowned

+

Confiscates items owned by dwarfs. By default, owned food on the floor +and rotten items are confistacted and dumped.

+

Options:

+
+ +++ + + + + + + + + + + + +
all:confiscate all owned items
scattered:confiscated and dump all items scattered on the floor
x:confiscate/dump items with wear level 'x' and more
X:confiscate/dump items with wear level 'X' and more
dryrun:a dry run. combine with other options to see what will happen +without it actually happening.
+
+

Example:

+
+
+
cleanowned scattered X
+
This will confiscate rotten and dropped food, garbage on the floors and any +worn items with 'X' damage and above.
+
+
+
+
+
+

Bugfixes

+
+

drybuckets

+

This utility removes water from all buckets in your fortress, allowing them to be safely used for making lye.

+
+
+

fixdiplomats

+

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.

+
+
+

fixmerchants

+

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.

+
+
+

fixveins

+

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.

-
-

Action:

+
+

tweak

+

Contains various tweaks for minor bugs (currently just one).

+

Options:

- + - + - + - -
set:Set designation (default)
clear-missing:Remove the missing status from the selected unit. +This allows engraving slabs for ghostly, but not yet +found, creatures.
unset:Unset current designation
clear-ghostly:Remove the ghostly status from the selected unit and mark +it as dead. This allows getting rid of bugged ghosts +which do not show up in the engraving slab menu at all, +even after using clear-missing. It works, but is +potentially very dangerous - so use with care. Probably +(almost certainly) it does not have the same effects like +a proper burial. You've been warned.
invert:Invert designations already present
fixmigrant:Remove the resident/merchant flag from the selected unit. +Intended to fix bugged migrants/traders who stay at the +map edge and don't enter your fort. Only works for +dwarves (or generally the player's race in modded games). +Do NOT abuse this for 'real' caravan merchants (if you +really want to kidnap them, use 'tweak makeown' instead, +otherwise they will have their clothes set to forbidden etc).
-
-
-

Designation types:

- --- - + - + - + - + + - + - + + + + + +
dig:Normal digging designation (default)
makeown:Force selected unit to become a member of your fort. +Can be abused to grab caravan merchants and escorts, even if +they don't belong to the player's race. Foreign sentients +(humans, elves) can be put to work, but you can't assign rooms +to them and they don't show up in DwarfTherapist because the +game treats them like pets. Grabbing draft animals from +a caravan can result in weirdness (animals go insane or berserk +and are not flagged as tame), but you are allowed to mark them +for slaughter. Grabbing wagons results in some funny spam, then +they are scuttled.
ramp:Ramp digging
stable-cursor:Saves the exact cursor position between t/q/k/d/etc menus of dwarfmode.
ustair:Staircase up
patrol-duty:Makes Train orders not count as patrol duty to stop unhappy thoughts. +Does NOT fix the problem when soldiers go off-duty (i.e. civilian).
dstair:Staircase down
readable-build-plate:
 Fixes rendering of creature weight limits in pressure plate build menu.
xstair:Staircase up/down
stable-temp:Fixes performance bug 6012 by squashing jitter in temperature updates. +In very item-heavy forts with big stockpiles this can improve FPS by 50-100%
chan:Dig channel
fast-heat:Further improves temperature update performance by ensuring that 1 degree +of item temperature is crossed in no more than specified number of frames +when updating from the environment temperature. This reduces the time it +takes for stable-temp to stop updates again when equilibrium is disturbed.
fix-dimensions:Fixes subtracting small amount of thread/cloth/liquid from a stack +by splitting the stack and subtracting from the remaining single item. +This is a necessary addition to the binary patch in bug 808.
advmode-contained:
 Works around bug 6202, i.e. custom reactions with container inputs +in advmode. The issue is that the screen tries to force you to select +the contents separately from the container. This forcefully skips child +reagents.
-

After you have set the options, the command called with no options -repeats with the last selected parameters.

-
-

Examples:

-
    -
  • 'digcircle filled 3' = Dig a filled circle with radius = 3.
    • -
  • 'digcircle' = Do it again.
    • -
-
-
-

weather

-

Prints the current weather map by default.

-

Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.

-
-

Options:

+
+

Mode switch and reclaim

+
+

lair

+

This command allows you to mark the map as 'monster lair', preventing item +scatter on abandon. When invoked as 'lair reset', it does the opposite.

+

Unlike reveal, this command doesn't save the information about tiles - you +won't be able to restore state of real monster lairs using 'lair reset'.

+

Options:

+
- - - + - +
snow:make it snow everywhere.
rain:make it rain.
lair:Mark the map as monster lair
clear:clear the sky.
lair reset:Mark the map as ordinary (not lair)
+
+
+
+

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. There are a few good ones though.

+
+

Example

+

You are in fort game mode, managing your fortress and paused. +You switch to the arena game mode, assume control of a creature and then +switch to adventure game mode(1). +You just lost a fortress and gained an adventurer. +You could also do this. +You are in fort game mode, managing your fortress and paused at the esc menu. +You switch to the adventure game mode, then use Dfusion to assume control of a creature and then +save or retire. +You just created a returnable mountain home and gained an adventurer.

+
+

I take no responsibility of anything that happens as a result of using this tool

+
+
+
+

Visualizer and data export

+
+

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).

+

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.

+

Older versions, support and extra graphics can be found in the bay12 forum +thread: http://www.bay12forums.com/smf/index.php?topic=43260.0

+

Some additional resources: +http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository

+
+
+

mapexport

+

Export the current loaded map as a file. This will be eventually usable +with visualizers.

+

dwarfexport +----------= +Export dwarves to RuneSmith-compatible XML.

+
+
+
+

Job management

+
+

job

+

Command for general job query and manipulation.

+
+
Options:
+
+
no extra options
+
Print details of the current job. The job can be selected +in a workshop, or the unit/jobs screen.
+
list
+
Print details of all jobs in the selected workshop.
+
item-material <item-idx> <material[:subtoken]>
+
Replace the exact material id in the job item.
+
item-type <item-idx> <type[:subtype]>
+
Replace the exact item type id in the job item.
+
+
+
+
+
+

job-material

+

Alter the material of the selected job.

+

Invoked as:

+
+job-material <inorganic-token>
+
+

Intended to be used as a keybinding:

+
+
    +
  • In 'q' mode, when a job is highlighted within a workshop or furnace, +changes the material of the job. Only inorganic materials can be used +in this mode.
    • +
  • In 'b' mode, during selection of building components positions the cursor +over the first available choice with the matching material.
    • +
+
+
+

job-duplicate

+
+
Duplicate the selected job in a workshop:
+
    +
  • In 'q' mode, when a job is highlighted within a workshop or furnace building, +instantly duplicates the job.
    • +
+
+
-

workflow

+

workflow

Manage control of repeat jobs.

-
-

Usage

+

Usage:

+
workflow enable [option...], workflow disable [option...]

If no options are specified, enables or disables the plugin. @@ -1927,9 +1860,9 @@ Otherwise, enables or disables any of the following options:

workflow unlimit <constraint-spec>
Delete a constraint.
-
+
-

Function

+

Function

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.

@@ -1940,7 +1873,7 @@ the amount has to drop before jobs are resumed; this is intended to reduce the frequency of jobs being toggled.

-

Constraint examples

+

Constraint examples

Keep metal bolts within 900-1000, and wood/bone within 150-200.

 workflow amount AMMO:ITEM_AMMO_BOLTS/METAL 1000 100
@@ -1977,20 +1910,20 @@ command.
-
-

mapexport

-

Export the current loaded map as a file. This will be eventually usable -with visualizers.

-
-

dwarfexport

-

Export dwarves to RuneSmith-compatible XML.

+
+

Fortress activity management

+
+

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.

-

zone

+

zone

Helps a bit with managing activity zones (pens, pastures and pits) and cages.

-
-

Options:

+

Options:

+
@@ -2027,9 +1960,9 @@ the cursor are listed.
-
-
-

Filters:

+ +

Filters:

+
@@ -2084,9 +2017,9 @@ for war/hunt). Negatable.
-
+
-

Usage with single units

+

Usage with single units

One convenient way to use the zone tool is to bind the command 'zone assign' to a hotkey, maybe also the command 'zone set'. Place the in-game cursor over a pen/pasture or pit, use 'zone set' to mark it. Then you can select units @@ -2095,7 +2028,7 @@ and use 'zone assign' to assign them to their new home. Allows pitting your own dwarves, by the way.

-

Usage with filters

+

Usage with filters

All filters can be used together with the 'assign' command.

Restrictions: It's not possible to assign units who are inside built cages or chained because in most cases that won't be desirable anyways. @@ -2113,14 +2046,14 @@ are not properly added to your own stocks; slaughtering them should work).

Most filters can be negated (e.g. 'not grazer' -> race is not a grazer).

-

Mass-renaming

+

Mass-renaming

Using the 'nick' command you can set the same nickname for multiple units. If used without 'assign', 'all' or 'count' it will rename all units in the current default target zone. Combined with 'assign', 'all' or 'count' (and further optional filters) it will rename units matching the filter conditions.

-

Cage zones

+

Cage zones

Using the 'tocages' command you can assign units to a set of cages, for example a room next to your butcher shop(s). They will be spread evenly among available cages to optimize hauling to and butchering from them. For this to work you need @@ -2130,8 +2063,8 @@ all cages you want to use. Then use 'zone set' (like with 'assign') and use would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.

-
-

Examples

+
+

Examples

zone assign all own ALPACA minage 3 maxage 10
Assign all own alpacas who are between 3 and 10 years old to the selected @@ -2157,7 +2090,7 @@ on the current default zone.
-

autonestbox

+

autonestbox

Assigns unpastured female egg-layers to nestbox zones. Requires that you create pen/pasture zones above nestboxes. If the pen is bigger than 1x1 the nestbox must be in the top left corner. Only 1 unit will be assigned per pen, regardless @@ -2167,8 +2100,8 @@ to a 1x1 pasture is not a good idea. Only tame and domesticated own units are processed since pasturing half-trained wild egglayers could destroy your neat nestbox zones when they revert to wild. When called without options autonestbox will instantly run once.

-
-

Options:

+

Options:

+
@@ -2183,10 +2116,10 @@ frames between runs.
-
+
-

autobutcher

+

autobutcher

Assigns lifestock for slaughter once it reaches a specific count. Requires that you add the target race(s) to a watch list. Only tame units will be processed.

Named units will be completely ignored (to protect specific animals from @@ -2199,8 +2132,8 @@ units or with 'zone nick' to mass-rename units in pastures and cages).

Once you have too much kids, the youngest will be butchered first. If you don't set any target count the following default will be used: 1 male kid, 5 female kids, 1 male adult, 5 female adults.

-
-

Options:

+

Options:

+
@@ -2251,9 +2184,8 @@ for future entries.
-
-
-

Examples:

+ +

Examples:

You want to keep max 7 kids (4 female, 3 male) and max 3 adults (2 female, 1 male) of the race alpaca. Once the kids grow up the oldest adults will get slaughtered. Excess kids will get slaughtered starting with the youngest @@ -2282,9 +2214,7 @@ add some new races with 'watch'. If you simply want to stop it completely use 

 autobutcher unwatch ALPACA CAT
-
-
-

Note:

+

Note:

Settings and watchlist are stored in the savegame, so that you can have different settings for each world. If you want to copy your watchlist to another savegame you can use the command list_export:

@@ -2296,9 +2226,8 @@ Load the savegame where you want to copy the settings to, run the batch file (fr autobutcher.bat
-
-

autolabor

+

autolabor

Automatically manage dwarf labors.

When enabled, autolabor periodically checks your dwarves and enables or disables labors. It tries to keep as many dwarves as possible busy but @@ -2311,8 +2240,39 @@ while it is enabled.

For detailed usage information, see 'help autolabor'.

+
+

Other

+
+

catsplosion

+

Makes cats just multiply. It is not a good idea to run this more than once or +twice.

+
+
+

dfusion

+

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

+

Confirmed working DFusion plugins:

+ +++ + + + +
simple_embark:allows changing the number of dwarves available on embark.
+
+

Note

+
    +
  • Some of the DFusion plugins aren't completely ported yet. This can lead to crashes.
    • +
  • 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.
    • +
+
+
+
+
-

Scripts

+

Scripts

Lua or ruby scripts placed in the hack/scripts/ directory are considered for execution as if they were native DFHack commands. They are listed at the end of the 'ls' command output.

@@ -2320,18 +2280,8 @@ of the 'ls' command output.

only be listed by ls if called as 'ls -a'. This is intended as a way to hide scripts that are obscure, developer-oriented, or should be used as keybindings.

Some notable scripts:

-
-

quicksave

-

If called in dwarf mode, makes DF immediately auto-save the game by setting a flag -normally used in seasonal auto-save.

-
-
-

setfps

-

Run setfps <number> to set the FPS cap at runtime, in case you want to watch -combat in slow motion or something :)

-
-

fix/*

+

fix/*

Scripts in this subdirectory fix various bugs and issues, some of them obscure.

  • fix/dead-units

    @@ -2357,12 +2307,22 @@ caused by autodump bugs or other hacking mishaps.

-

gui/*

+

gui/*

Scripts that implement dialogs inserted into the main game window are put in this directory.

+
+

quicksave

+

If called in dwarf mode, makes DF immediately auto-save the game by setting a flag +normally used in seasonal auto-save.

+
+
+

setfps

+

Run setfps <number> to set the FPS cap at runtime, in case you want to watch +combat in slow motion or something :)

+
-

growcrops

+

growcrops

Instantly grow seeds inside farming plots.

With no argument, this command list the various seed types currently in use in your farming plots. @@ -2374,7 +2334,7 @@ growcrops plump 40

-

removebadthoughts

+

removebadthoughts

This script remove negative thoughts from your dwarves. Very useful against tantrum spirals.

With a selected unit in 'v' mode, will clear this unit's mind, otherwise @@ -2387,7 +2347,7 @@ you unpause.

it removed.

-

slayrace

+

slayrace

Kills any unit of a given race.

With no argument, lists the available races.

With the special argument 'him', targets only the selected creature.

@@ -2413,7 +2373,7 @@ slayrace elve magma
-

magmasource

+

magmasource

Create an infinite magma source on a tile.

This script registers a map tile as a magma source, and every 12 game ticks that tile receives 1 new unit of flowing magma.

@@ -2429,11 +2389,11 @@ To remove all placed sources, call magmasource stop
-

In-game interface tools

+

In-game interface tools

These tools work by displaying dialogs or overlays in the game window, and are mostly implemented by lua scripts.

-

Dwarf Manipulator

+

Dwarf Manipulator

Implemented by the manipulator plugin. To activate, open the unit screen and press 'l'.

This tool implements a Dwarf Therapist-like interface within the game UI. The @@ -2467,14 +2427,14 @@ cursor onto that cell instead of toggling it.

Pressing ESC normally returns to the unit screen, but Shift-ESC would exit directly to the main dwarf mode screen.

-
-

Liquids

+
+

Liquids

Implemented by the gui/liquids script. To use, bind to a key and activate in the 'k' mode.

While active, use the suggested keys to switch the usual liquids parameters, and Enter to select the target area and apply changes.

-

Mechanisms

+

Mechanisms

Implemented by the gui/mechanims script. To use, bind to a key and activate in the 'q' mode.

Lists mechanisms connected to the building, and their links. Navigating the list centers the view on the relevant linked buildings.

@@ -2483,14 +2443,14 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.

-

Power Meter

+

Power Meter

Front-end to the power-meter plugin implemented by the gui/power-meter script. Bind to a key and activate after selecting Pressure Plate in the build menu.

The script follows the general look and feel of the regular pressure plate build configuration page, but configures parameters relevant to the modded power meter building.

-
-

Rename

+
+

Rename

Backed by the rename plugin, the gui/rename script allows entering the desired name via a simple dialog in the game ui.

    @@ -2506,14 +2466,14 @@ It is also possible to rename zones from the 'i' menu.

    The building or unit are automatically assumed when in relevant ui state.

-

Room List

+

Room List

Implemented by the gui/room-list script. To use, bind to a key and activate in the 'q' mode, either immediately or after opening the assign owner page.

The script lists other rooms owned by the same owner, or by the unit selected in the assign list, and allows unassigning them.

-

Siege Engine

+

Siege Engine

Front-end to the siege-engine plugin implemented by the gui/siege-engine script. Bind to a key and activate after selecting a siege engine in 'q' mode.

The main mode displays the current target, selected ammo item type, linked stockpiles and @@ -2530,21 +2490,24 @@ DF, or select another area manually.

Exiting from the siege engine script via ESC reverts the view to the state prior to starting the script. Shift-ESC retains the current viewport, and also exits from the 'q' mode to main menu.

-

DISCLAIMER: Siege engines are a very interesting feature, but currently nearly useless +

+

DISCLAIMER

+

Siege engines are a very interesting feature, but currently nearly useless because they haven't been updated since 2D and can only aim in four directions. This is an attempt to bring them more up to date until Toady has time to work on it. Actual improvements, e.g. like making siegers bring their own, are something only Toady can do.

+
-

RAW hacks

+

RAW hacks

These plugins detect certain structures in RAWs, and enhance them in various ways.

-

Steam Engine

+

Steam Engine

The steam-engine plugin detects custom workshops with STEAM_ENGINE in their token, and turns them into real steam engines.

-

Rationale

+

Rationale

The vanilla game contains only water wheels and windmills as sources of power, but windmills give relatively little power, and water wheels require flowing water, which must either be a real river and thus immovable and @@ -2555,25 +2518,31 @@ it can be done just by combining existing features of the game engine in a new way with some glue code and a bit of custom logic.

-

Construction

+

Construction

The workshop needs water as its input, which it takes via a passable floor tile below it, like usual magma workshops do. The magma version also needs magma.

-

ISSUE: Since this building is a machine, and machine collapse +

+

ISSUE

+

Since this building is a machine, and machine collapse code cannot be modified, it would collapse over true open space. As a loophole, down stair provides support to machines, while being passable, so use them.

+

After constructing the building itself, machines can be connected to the edge tiles that look like gear boxes. Their exact position is extracted from the workshop raws.

-

ISSUE: Like with collapse above, part of the code involved in +

+

ISSUE

+

Like with collapse above, part of the code involved in machine connection cannot be modified. As a result, the workshop can only immediately connect to machine components built AFTER it. This also means that engines cannot be chained without intermediate short axles that can be built later than both of the engines.

+
-

Operation

+

Operation

In order to operate the engine, queue the Stoke Boiler job (optionally on repeat). A furnace operator will come, possibly bringing a bar of fuel, and perform it. As a result, a "boiling water" item will appear @@ -2598,7 +2567,7 @@ decrease it by further 4%, and also decrease the whole steam use rate by 10%.

-

Explosions

+

Explosions

The engine must be constructed using barrel, pipe and piston from fire-safe, or in the magma version magma-safe metals.

During operation weak parts get gradually worn out, and @@ -2607,7 +2576,7 @@ toppled during operation by a building destroyer, or a tantruming dwarf.

-

Save files

+

Save files

It should be safe to load and view engine-using fortresses from a DF version without DFHack installed, except that in such case the engines won't work. However actually making modifications @@ -2618,7 +2587,7 @@ being generated.

-

Add Spatter

+

Add Spatter

This plugin makes reactions with names starting with SPATTER_ADD_ produce contaminants on the items instead of improvements.

Intended to give some use to all those poisons that can be bought from caravans.