-
-
- job -
- job-material -
- job-duplicate -
- stockflow -
- workflow
-
-
- Function -
- Constraint format -
- Constraint examples +
- Job management -
- Fortress activity management
-
-
- seedwatch -
- zone
-
-
- Usage with single units -
- Usage with filters -
- Mass-renaming -
- Cage zones -
- Examples +
- Fortress activity management -
- Other -
- Scripts
-
-
- fix/* -
- gui/* -
- binpatch -
- create-items -
- digfort -
- drain-aquifer -
- deathcause -
- dfstatus -
- embark -
- exterminate -
- growcrops -
- lever -
- locate-ore -
- lua -
- masspit -
- multicmd -
- quicksave -
- remove-stress -
- setfps -
- siren -
- soundsense-season -
- source -
- superdwarf -
- stripcaged -
- teleport -
- undump-buildings +
- Scripts
-
+
- fix/* +
- gui/* +
- binpatch +
- create-items +
- digfort +
- drain-aquifer +
- deathcause +
- dfstatus +
- embark +
- exterminate +
- fortplan +
- growcrops +
- hfs-pit +
- lever +
- locate-ore +
- lua +
- masspit +
- multicmd +
- position +
- putontable +
- quicksave +
- remove-stress +
- setfps +
- siren +
- soundsense-season +
- source +
- superdwarf +
- stripcaged +
- teleport +
- undump-buildings
- - modtools -
- In-game interface tools
-
-
- Dwarf Manipulator -
- Search -
- AutoMaterial -
- Stockpile Automation -
- Track Stop Menu -
- gui/advfort -
- gui/assign-rack -
- gui/choose-weapons -
- gui/clone-uniform -
- gui/companion-order -
- gui/gm-editor -
- Hotkeys -
- Hotkeys -
- Stockpile Automation -
- Stockpile Automation -
- gui/liquids -
- gui/mechanisms -
- gui/mod-manager -
- gui/rename -
- gui/room-list -
- gui/guide-path -
- gui/workflow -
- gui/workshop-job +
- modtools +
- In-game interface tools
-
+
- Dwarf Manipulator +
- Search +
- AutoMaterial +
- Stockpile Automation +
- Track Stop Menu +
- gui/advfort +
- gui/assign-rack +
- gui/choose-weapons +
- gui/clone-uniform +
- gui/companion-order +
- gui/gm-editor +
- Hotkeys +
- Hotkeys +
- Stockpile Automation +
- Stockpile Automation +
- gui/liquids +
- gui/mechanisms +
- gui/mod-manager +
- gui/rename +
- gui/room-list +
- gui/guide-path +
- gui/workflow +
- gui/workshop-job
- - Behavior Mods
-
-
- Siege Engine
-
-
- Rationale -
- Configuration UI +
- Behavior Mods
@@ -850,6 +855,8 @@ by moving the view manually.
stockpile settings management
+Save and load stockpile settings. See the gui/stockpiles for an in-game GUI to +this plugin.
+copystock
Copies the parameters of the currently highlighted stockpile to the custom @@ -2200,11 +2207,38 @@ worlds, or when you want a map of every site when there are several hundred.
+blueprint
+Exports a portion of your fortress into QuickFort style blueprint files.:
++blueprint <x> <y> <z> <name> [dig] [build] [place] [query] +
+Options:
++
++ + + x,y,z: Size of map area to export +name: Name of export files +dig: Export dig commands to "<name>-dig.csv" +build: Export build commands to "<name>-build.csv" +place: Export stockpile commands to "<name>-place.csv" +query: Export query commands to "<name>-query.csv" +If only region and name are given, all exports are performed.
+-Job management
+Job management
-job
+job
Command for general job query and manipulation.
Options:
-
@@ -2220,7 +2254,7 @@ in a workshop, or the unit/jobs screen.
-job-material
+job-material
Alter the material of the selected job.
Invoked as:
@@ -2236,7 +2270,7 @@ over the first available choice with the matching material.
-job-duplicate
+job-duplicate
Duplicate the selected job in a workshop:
- In 'q' mode, when a job is highlighted within a workshop or furnace building, @@ -2244,7 +2278,7 @@ instantly duplicates the job.
-stockflow
+stockflow
Allows the fortress bookkeeper to queue jobs through the manager, based on space or items available in stockpiles.
Usage:
@@ -2272,7 +2306,7 @@ number of identical orders already in the queue. waiting for the bookkeeper.-workflow
+workflow
Manage control of repeat jobs.
Usage:
-
@@ -2302,7 +2336,7 @@ this list can be copied to a file, and then reloaded using the
- Delete all constraints.
-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.
@@ -2315,7 +2349,7 @@ the frequency of jobs being toggled. in the game UI.-Constraint format
+Constraint format
The contstraint spec consists of 4 parts, separated with '/' characters:
ITEM[:SUBTYPE]/[GENERIC_MAT,...]/[SPECIFIC_MAT:...]/[LOCAL,<quality>] @@ -2344,7 +2378,7 @@ be used to ignore imported items or items below a certain quality.
-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 @@ -2393,9 +2427,9 @@ workflow count CRAFTS///LOCAL,EXCEPTIONAL 100 90
-Fortress activity management
+Fortress activity management
-seedwatch
+seedwatch
Watches the numbers of seeds available and enables/disables seed and plant cooking.
Each plant type can be assigned a limit. If their number falls below that limit, the plants and seeds of that type will be excluded from cookery. @@ -2430,7 +2464,7 @@ You have to reactivate with 'seedwatch start' after you load the game.
-zone
+zone
Helps a bit with managing activity zones (pens, pastures and pits) and cages.
Options:
@@ -2525,7 +2559,7 @@ 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 @@ -2534,7 +2568,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. @@ -2552,14 +2586,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 @@ -2570,7 +2604,7 @@ would make no sense, but can be used together with 'nick' or 'remnick' and all the usual filters.
-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 @@ -2623,7 +2657,7 @@ 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 @@ -2729,7 +2763,7 @@ autobutcher.bat
-Other
+Other
-catsplosion
+catsplosion
Makes cats just multiply. It is not a good idea to run this more than once or twice.
-dfusion
+dfusion
This is the DFusion lua plugin system by Warmist, running as a DFHack plugin. There are two parts to this plugin: an interactive script that shows a text based menu and lua modules. Some of the functionality of is intentionaly left out of the menu:
@@ -2872,7 +2906,7 @@ twice. -embark-tools
+embark-tools
A collection of embark-related tools.
Usage:
@@ -2888,7 +2922,7 @@ embark-tools enable/disable tool [tool]...
-petcapRemover
+petcapRemover
This plugin allows you to remove or raise the pet population cap. In vanilla DF, pets will not reproduce unless the population is below 50 and the number of children of that species is below a certain percentage. This plugin allows removing the second restriction and removing or raising the first. Pets still require PET or PET_EXOTIC tags in order to reproduce. Type help petcapRemover for exact usage. In order to make population more stable and avoid sudden population booms as you go below the raised population cap, this plugin counts pregnancies toward the new population cap. It can still go over, but only in the case of multiple births.
- petcapRemover @@ -2902,7 +2936,7 @@ embark-tools enable/disable tool [tool]...
-misery
+misery
When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).
Usage:
@@ -2924,7 +2958,7 @@ embark-tools enable/disable tool [tool]...
-strangemood
+strangemood
Creates a strange mood job the same way the game itself normally does it.
Options:
@@ -2946,13 +2980,13 @@ Valid values are "miner", "carpenter", "engraver",
Known limitations: if the selected unit is currently performing a job, the mood will not be started.
-log-region
+log-region
When enabled in dfhack.init, each time a fort is loaded identifying information will be written to the gamelog. Assists in parsing the file if you switch between forts, and adds information for story-building.
-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.
@@ -2961,7 +2995,7 @@ 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:
-fix/*
+fix/*
Scripts in this subdirectory fix various bugs and issues, some of them obscure.
fix/blood-del
@@ -3007,17 +3041,33 @@ state however, use tweak stable-t
-gui/*
+gui/*
Scripts that implement dialogs inserted into the main game window are put in this directory.
gui/hack-wish
A graphical interface for creating items.
+gui/stockpiles
+Load and save stockpile settings from the 'q' menu. +Usage:
+ ++
+gui/stockpiles -save to save the current stockpile +gui/stockpiles -load to load settings into the current stockpile +gui/stockpiles -dir <path> set the default directory to save settings into +gui/stockpiles -help to see this message
+
Don't forget to enable stockpiles and create the stocksettings directory in +the DF folder before trying to use this plugin.
-binpatch
+binpatch
Checks, applies or removes binary patches directly in memory at runtime:
binpatch check/apply/remove <patchname> @@ -3027,7 +3077,7 @@ script uses hack/patches/<df-v the version appropriate for the currently loaded executable.-create-items
+create-items
Spawn arbitrary items under the cursor.
The first argument gives the item category, the second gives the material, and the optionnal third gives the number of items to create (defaults to 20).
@@ -3049,7 +3099,7 @@ create-items bar adamantine-digfort
+digfort
A script to designate an area for digging according to a plan in csv format.
This script, inspired from quickfort, can designate an area for digging. Your plan should be stored in a .csv file like this:
@@ -3071,25 +3121,25 @@ as an offset for the pattern: instead of starting at the cursor, it will start Dwarf Fortress.exe is found).-deathcause
+deathcause
Focus a body part ingame, and this script will display the cause of death of the creature. Also works when selecting units from the 'u'nitlist viewscreen.
-dfstatus
+dfstatus
Show a quick overview of critical stock quantities, including food, dirnks, wood, and various bars.
-+exterminate
+exterminate
Kills any unit of a given race.
With no argument, lists the available races and count eligible targets.
With the special argument him, targets only the selected creature.
@@ -3120,8 +3170,35 @@ exterminate him exterminate elve magma+fortplan
+Usage: fortplan [filename]
+Designates furniture for building according to a .csv file with +quickfort-style syntax. Companion to digfort.
+The first line of the file must contain the following:
++#build start(X; Y; <start location description>)
+...where X and Y are the offset from the top-left corner of the file's area +where the in-game cursor should be located, and <start location description> +is an optional description of where that is. You may also leave a description +of the contents of the file itself following the closing parenthesis on the +same line.
+The syntax of the file itself is similar to digfort or quickfort. At present, +only buildings constructed of an item with the same name as the building +are supported. All other characters are ignored. For example:
++,,d,`,` +,f,,t,` +,s,b,c,
+This section of a file would designate for construction a door and some +furniture inside a bedroom: specifically, clockwise from top left, a cabinet, +a table, a chair, a bed, and a statue.
+All of the building designation uses Planning Mode, so you do not need to +have the items available to construct all the buildings when you run +fortplan with the .csv file.
+-+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. @@ -3132,8 +3209,20 @@ harvested. You can change the number with a 2nd argument.
growcrops plump 40+hfs-pit
+Creates a pit to the underworld at the cursor.
+Takes three arguments: diameter of the pit in tiles, whether to wall off +the pit, and whether to insert stairs. If no arguments are given, the default +is "hfs-pit 1 0 0", ie single-tile wide with no walls or stairs.
++hfs-pit 4 0 1 +hfs-pit 2 1 0
+First example is a four-across pit with stairs but no walls; second is a +two-across pit with stairs but no walls.
+-lever
+lever
Allow manipulation of in-game levers from the dfhack console.
Can list levers, including state and links, with:
@@ -3147,7 +3236,7 @@ lever pull 42 --now
-locate-ore
+locate-ore
Scan the map for metal ores.
Finds and designate for digging one tile of a specific metal ore. Only works for native metal ores, does not handle reaction stuff (eg STEEL).
@@ -3160,7 +3249,7 @@ locate-ore iron-lua
+lua
There are the following ways to invoke this command:
lua (without any parameters)
@@ -3179,14 +3268,14 @@ directory. If the filename is not supplied, it loads "dfhack.lua".
-masspit
+masspit
Designate all creatures in cages on top of a pit/pond activity zone for pitting. Works best with an animal stockpile on top of the zone.
Works with a zone number as argument (eg Activity Zone #6 -> masspit 6) or with the game cursor on top of the area.
-+multicmd
+multicmd
Run multiple dfhack commands. The argument is split around the character ; and all parts are run sequencially as independent dfhack commands. Useful for hotkeys.
@@ -3195,22 +3284,32 @@ dfhack commands. Useful for hotkeys. multicmd locate-ore iron ; digv++position
+Reports the current time: date, clock time, month, and season. Also reports +location: z-level, cursor position, window size, and mouse location.
++putontable
+Makes item appear on the table, like in adventure mode shops. Arguments: '-a' +or '--all' for all items.
+-quicksave
+quicksave
If called in dwarf mode, makes DF immediately auto-save the game by setting a flag normally used in seasonal auto-save.
-remove-stress
+remove-stress
Sets stress to -1,000,000; the normal range is 0 to 500,000 with very stable or very stressed dwarves taking on negative or greater values respectively. Applies to the selected unit, or use "remove-stress -all" to apply to all units.
-setfps
+setfps
Run setfps <number> to set the FPS cap at runtime, in case you want to watch combat in slow motion or something :)
-siren
+siren
Wakes up sleeping units, cancels breaks and stops parties either everywhere, or in the burrows given as arguments. In return, adds bad thoughts about noise, tiredness and lack of protection. Also, the units with interrupted @@ -3218,7 +3317,7 @@ breaks will go on break again a lot sooner. The script is intended for emergencies, e.g. when a siege appears, and all your military is partying.
-soundsense-season
+soundsense-season
It is a well known issue that Soundsense cannot detect the correct current season when a savegame is loaded and has to play random season music until a season switch occurs.
@@ -3227,7 +3326,7 @@ to gamelog.txt on every map load to fix this. For best results call the script from dfhack.init.-source
+source
Create an infinite magma or water source or drain on a tile.
This script registers a map tile as a liquid source, and every 12 game ticks that tile receives or remove 1 new unit of flow based on the configuration.
@@ -3249,7 +3348,7 @@ source add water 0 - water drain-superdwarf
+superdwarf
Similar to fastdwarf, per-creature.
To make any creature superfast, target it ingame using 'v' and:
@@ -3259,7 +3358,7 @@ superdwarf add
This plugin also shortens the 'sleeping' and 'on break' periods of targets.
-stripcaged
+stripcaged
For dumping items inside cages. Will mark selected items for dumping, then a dwarf may come and actually dump it. See also autodump.
With the items argument, only dumps items laying in the cage, excluding @@ -3277,7 +3376,7 @@ stripcaged weapons 25321 34228
-modtools
+modtools
These scripts are mostly useful for raw modders and scripters. They all have standard arguments: arguments are of the form tool -argName1 argVal1 -argName2 argVal2. This is equivalent to tool -argName2 argVal2 -argName1 argVal1. It is not necessary to provide a value to an argument name: tool -argName3 is fine. Supplying the same argument name multiple times will result in an error. Argument names are preceded with a dash. The -help argument will print a descriptive usage string describing the nature of the arguments. For multiple word argument values, brackets must be used: tool -argName4 [ sadf1 sadf2 sadf3 ]. In order to allow passing literal braces as part of the argument, backslashes are used: tool -argName4 [ \] asdf \foo ] sets argName4 to \] asdf foo. The *-trigger scripts have a similar policy with backslashes.
add-syndrome
@@ -3349,7 +3448,7 @@ teleport -unit 1234 -x 56 -y 115 -z 26 - teleports unit 1234 to 56,115,26
-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.
@@ -3364,7 +3463,7 @@ guideline because it arguably just fixes small usability bugs in the game UI.-Dwarf Manipulator
+Dwarf Manipulator
Implemented by the 'manipulator' plugin.
To activate, open the unit screen and press 'l'.
@@ -3405,7 +3504,7 @@ cursor onto that cell instead of toggling it.
directly to the main dwarf mode screen.
-Search
+Search
Implemented by the 'search' plugin.
The search plugin adds search to the Stocks, Animals, Trading, Stockpile, Noble (assignment candidates), Military (position candidates), Burrows @@ -3436,7 +3535,7 @@ only fat or tallow by forbidding fats, then searching for fat/tallow, and using Permit Fats again while the list is filtered.
-AutoMaterial
+AutoMaterial
Implemented by the 'automaterial' plugin.
This makes building constructions (walls, floors, fortifications, etc) a little bit easier by saving you from having to trawl through long lists of materials each time @@ -3464,7 +3563,7 @@ materials, it returns you back to this screen. If you use this along with severa enabled materials, you should be able to place complex constructions more conveniently.
-Stockpile Automation
+Stockpile Automation
Enable the automelt or autotrade plugins in your dfhack.init with:
enable automelt @@ -3475,7 +3574,7 @@ When automelt is enabled for a stockpile, any meltable items placed in it will b When autotrade is enabled for a stockpile, any items placed in it will be designated to be taken to the Trade Depot whenever merchants are on the map.
-gui/advfort
+gui/advfort
This script allows to perform jobs in adventure mode. For more complete help press '?' while script is running. It's most confortable to use this as a keybinding. (e.g. keybinding set Ctrl-T gui/advfort). Possible arguments:
@@ -3508,7 +3607,7 @@ implies -a-gui/assign-rack
+gui/assign-rack
Bind to a key (the example config uses P), and activate when viewing a weapon rack in the 'q' mode.
@@ -3532,7 +3631,7 @@ the intended user. In order to aid in the choice, it shows the number
of currently assigned racks for every valid squad.
-gui/choose-weapons
+gui/choose-weapons
Bind to a key (the example config uses Ctrl-W), and activate in the Equip->View/Customize page of the military screen.
Depending on the cursor location, it rewrites all 'individual choice weapon' entries @@ -3543,14 +3642,14 @@ only that entry, and does it even if it is not 'individual choice'.
and may lead to inappropriate weapons being selected.-gui/clone-uniform
+gui/clone-uniform
Bind to a key (the example config uses Ctrl-C), and activate in the Uniforms page of the military screen with the cursor in the leftmost list.
When invoked, the script duplicates the currently selected uniform template, and selects the newly created copy.
-gui/companion-order
+gui/companion-order
A script to issue orders for companions. Select companions with lower case chars, issue orders with upper case. Must be in look or talk mode to issue command on tile.
@@ -3566,7 +3665,7 @@ case. Must be in look or talk mode to issue command on tile.
-gui/gm-editor
+gui/gm-editor
There are three ways to open this editor:
- using gui/gm-editor command/keybinding - opens editor on what is selected @@ -3581,7 +3680,7 @@ the same as version above. in-game help.
-Hotkeys
+Hotkeys
Opens an in-game screen showing DFHack keybindings that are valid in the current mode.
Type hotkeys into the DFHack console to open the screen, or bind the command to a @@ -3591,7 +3690,7 @@ keybinding add Ctrl-F1 hotkeys
-Hotkeys
+Hotkeys
Opens an in-game screen showing DFHack keybindings that are valid in the current mode.
Type hotkeys into the DFHack console to open the screen, or bind the command to a @@ -3600,7 +3699,7 @@ globally active hotkey in dfhack.init, e.g.:
keybinding add Ctrl-F1 hotkeys-Stockpile Automation
+Stockpile Automation
- Enable the autodump plugin in your dfhack.init with
- enable autodump @@ -3609,7 +3708,7 @@ globally active hotkey in dfhack.init, e.g.: Any items placed in this stockpile will be designated to be dumped.
-Stockpile Automation
+Stockpile Automation
- Enable the automelt plugin in your dfhack.init with
- enable automelt @@ -3618,7 +3717,7 @@ Any items placed in this stockpile will be designated to be dumped. Any items placed in this stockpile will be designated to be melted.
-gui/liquids
+gui/liquids
To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.
This script is a gui front-end to the liquids plugin and works similar to it, @@ -3638,7 +3737,7 @@ rivers power water wheels even when full and technically not flowing.
After setting up the desired operations using the described keys, use Enter to apply them.
-gui/mechanisms
+gui/mechanisms
To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.
Lists mechanisms connected to the building, and their links. Navigating the list centers @@ -3648,13 +3747,13 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter re-entering the mechanisms ui.
-gui/mod-manager
+gui/mod-manager
A way to simply install and remove small mods. It looks for specially formatted mods in df subfolder 'mods'. Mods are not included, for example mods see: github mini mod repository
-gui/rename
+gui/rename
Backed by the rename plugin, this script allows entering the desired name via a simple dialog in the game ui.
-
@@ -3677,7 +3776,7 @@ their species string.
unit profession change to Ctrl-Shift-T.
-gui/room-list
+gui/room-list
To use, bind to a key (the example config uses Alt-R) and activate in the 'q' mode, either immediately or after opening the assign owner page.
@@ -3685,7 +3784,7 @@ either immediately or after opening the assign owner page.
list, and allows unassigning them.
-gui/guide-path
+gui/guide-path
Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with the cursor over a Guide order.
@@ -3693,7 +3792,7 @@ the cursor over a Guide order.
computes it when the order is executed for the first time.
-gui/workflow
+gui/workflow
Bind to a key (the example config uses Alt-W), and activate with a job selected in a workshop in the 'q' mode.
@@ -3740,7 +3839,7 @@ the current stock value. The bright green dashed line is the target
limit (maximum) and the dark green line is that minus the gap (minimum).
-gui/workshop-job
+gui/workshop-job
Bind to a key (the example config uses Alt-A), and activate with a job selected in a workshop in the 'q' mode.
@@ -3777,7 +3876,7 @@ you have to unset the material first.
-Behavior Mods
+Behavior Mods
These plugins, when activated via configuration UI or by detecting certain structures in RAWs, modify the game engine behavior concerning the target objects to add features not otherwise present.
@@ -3788,20 +3887,20 @@ technical challenge, and do not represent any long-term plans to produce more similar modifications of the game.-Siege Engine
+Siege Engine
The siege-engine plugin enables siege engines to be linked to stockpiles, and aimed at an arbitrary rectangular area across Z levels, instead of the original four directions. Also, catapults can be ordered to load arbitrary objects, not just stones.
-Rationale
+Rationale
Siege engines are a very interesting feature, but sadly almost useless in the current state 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.
-Configuration UI
+Configuration UI
The configuration front-end to the plugin is implemented by the gui/siege-engine script. Bind it to a key (the example config uses Alt-A) and activate after selecting a siege engine in 'q' mode.
@@ -3824,7 +3923,7 @@ menu.-Power Meter
+Power Meter
The power-meter plugin implements a modified pressure plate that detects power being supplied to gear boxes built in the four adjacent N/S/W/E tiles.
The configuration front-end is implemented by the gui/power-meter script. Bind it to a @@ -3835,11 +3934,11 @@ in the build menu.
configuration page, but configures parameters relevant to the modded power meter building.-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 @@ -3850,7 +3949,7 @@ 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.
@@ -3874,7 +3973,7 @@ 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 @@ -3905,7 +4004,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 @@ -3914,7 +4013,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 @@ -3925,7 +4024,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. The produced contaminants are immune to being washed away by water or destroyed by diff --git a/Readme.rst b/Readme.rst index 609a98dcd..87cd92126 100644 --- a/Readme.rst +++ b/Readme.rst @@ -1477,6 +1477,23 @@ Options: :maps: Exports all seventeen detailed maps :all: Equivalent to calling all of the above, in that order +blueprint +--------- +Exports a portion of your fortress into QuickFort style blueprint files.:: + + blueprint
[dig] [build] [place] [query] + +Options: + +:x,y,z: Size of map area to export +:name: Name of export files +:dig: Export dig commands to " -dig.csv" +:build: Export build commands to " -build.csv" +:place: Export stockpile commands to " -place.csv" +:query: Export query commands to " -query.csv" + +If only region and name are given, all exports are performed. + Job management ==============
- Siege Engine