@ -3,7 +3,7 @@
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" > < html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head > < head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / > < meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< meta name = "generator" content = "Docutils 0.1 2 : http://docutils.sourceforge.net/" / > < meta name = "generator" content = "Docutils 0.1 1 : http://docutils.sourceforge.net/" / >
< title > DFHack Readme< / title > < title > DFHack Readme< / title >
< style type = "text/css" > < style type = "text/css" >
@ -519,79 +519,80 @@ access DF memory and allow for easier development of new tools.</p>
< li > < a class = "reference internal" href = "#other" id = "id126" > Other< / a > < ul > < li > < a class = "reference internal" href = "#other" id = "id126" > Other< / a > < ul >
< li > < a class = "reference internal" href = "#catsplosion" id = "id127" > catsplosion< / a > < / li > < li > < a class = "reference internal" href = "#catsplosion" id = "id127" > catsplosion< / a > < / li >
< li > < a class = "reference internal" href = "#dfusion" id = "id128" > dfusion< / a > < / li > < li > < a class = "reference internal" href = "#dfusion" id = "id128" > dfusion< / a > < / li >
< li > < a class = "reference internal" href = "#misery" id = "id129" > misery< / a > < / li > < li > < a class = "reference internal" href = "#embark-tools" id = "id129" > embark-tools< / a > < / li >
< li > < a class = "reference internal" href = "#strangemood" id = "id130" > strangemood< / a > < / li > < li > < a class = "reference internal" href = "#misery" id = "id130" > misery< / a > < / li >
< li > < a class = "reference internal" href = "#log-region" id = "id131" > log-region< / a > < / li > < li > < a class = "reference internal" href = "#strangemood" id = "id131" > strangemood< / a > < / li >
< li > < a class = "reference internal" href = "#log-region" id = "id132" > log-region< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#scripts" id = "id13 2 "> Scripts< / a > < ul > < li > < a class = "reference internal" href = "#scripts" id = "id13 3 "> Scripts< / a > < ul >
< li > < a class = "reference internal" href = "#fix" id = "id13 3 "> fix/*< / a > < / li > < li > < a class = "reference internal" href = "#fix" id = "id13 4 "> fix/*< / a > < / li >
< li > < a class = "reference internal" href = "#gui" id = "id13 4 "> gui/*< / a > < / li > < li > < a class = "reference internal" href = "#gui" id = "id13 5 "> gui/*< / a > < / li >
< li > < a class = "reference internal" href = "#binpatch" id = "id13 5 "> binpatch< / a > < / li > < li > < a class = "reference internal" href = "#binpatch" id = "id13 6 "> binpatch< / a > < / li >
< li > < a class = "reference internal" href = "#quicksave" id = "id13 6 "> quicksave< / a > < / li > < li > < a class = "reference internal" href = "#quicksave" id = "id13 7 "> quicksave< / a > < / li >
< li > < a class = "reference internal" href = "#setfps" id = "id13 7 "> setfps< / a > < / li > < li > < a class = "reference internal" href = "#setfps" id = "id13 8 "> setfps< / a > < / li >
< li > < a class = "reference internal" href = "#siren" id = "id13 8 "> siren< / a > < / li > < li > < a class = "reference internal" href = "#siren" id = "id13 9 "> siren< / a > < / li >
< li > < a class = "reference internal" href = "#growcrops" id = "id1 39 "> growcrops< / a > < / li > < li > < a class = "reference internal" href = "#growcrops" id = "id1 40 "> growcrops< / a > < / li >
< li > < a class = "reference internal" href = "#removebadthoughts" id = "id14 0 "> removebadthoughts< / a > < / li > < li > < a class = "reference internal" href = "#removebadthoughts" id = "id14 1 "> removebadthoughts< / a > < / li >
< li > < a class = "reference internal" href = "#exterminate" id = "id14 1 "> exterminate< / a > < / li > < li > < a class = "reference internal" href = "#exterminate" id = "id14 2 "> exterminate< / a > < / li >
< li > < a class = "reference internal" href = "#source" id = "id14 2 "> source< / a > < / li > < li > < a class = "reference internal" href = "#source" id = "id14 3 "> source< / a > < / li >
< li > < a class = "reference internal" href = "#masspit" id = "id14 3 "> masspit< / a > < / li > < li > < a class = "reference internal" href = "#masspit" id = "id14 4 "> masspit< / a > < / li >
< li > < a class = "reference internal" href = "#digfort" id = "id14 4 "> digfort< / a > < / li > < li > < a class = "reference internal" href = "#digfort" id = "id14 5 "> digfort< / a > < / li >
< li > < a class = "reference internal" href = "#invasion-now" id = "id14 5 "> invasion-now< / a > < / li > < li > < a class = "reference internal" href = "#invasion-now" id = "id14 6 "> invasion-now< / a > < / li >
< li > < a class = "reference internal" href = "#digmat" id = "id14 6 "> digmat< / a > < / li > < li > < a class = "reference internal" href = "#digmat" id = "id14 7 "> digmat< / a > < / li >
< li > < a class = "reference internal" href = "#superdwarf" id = "id14 7 "> superdwarf< / a > < / li > < li > < a class = "reference internal" href = "#superdwarf" id = "id14 8 "> superdwarf< / a > < / li >
< li > < a class = "reference internal" href = "#drainaquifer" id = "id14 8 "> drainaquifer< / a > < / li > < li > < a class = "reference internal" href = "#drainaquifer" id = "id14 9 "> drainaquifer< / a > < / li >
< li > < a class = "reference internal" href = "#deathcause" id = "id1 49 "> deathcause< / a > < / li > < li > < a class = "reference internal" href = "#deathcause" id = "id1 50 "> deathcause< / a > < / li >
< li > < a class = "reference internal" href = "#lua" id = "id15 0 "> lua< / a > < / li > < li > < a class = "reference internal" href = "#lua" id = "id15 1 "> lua< / a > < / li >
< li > < a class = "reference internal" href = "#embark" id = "id15 1 "> embark< / a > < / li > < li > < a class = "reference internal" href = "#embark" id = "id15 2 "> embark< / a > < / li >
< li > < a class = "reference internal" href = "#lever" id = "id15 2 "> lever< / a > < / li > < li > < a class = "reference internal" href = "#lever" id = "id15 3 "> lever< / a > < / li >
< li > < a class = "reference internal" href = "#stripcaged" id = "id15 3 "> stripcaged< / a > < / li > < li > < a class = "reference internal" href = "#stripcaged" id = "id15 4 "> stripcaged< / a > < / li >
< li > < a class = "reference internal" href = "#undump-buildings" id = "id15 4 "> undump-buildings< / a > < / li > < li > < a class = "reference internal" href = "#undump-buildings" id = "id15 5 "> undump-buildings< / a > < / li >
< li > < a class = "reference internal" href = "#create-items" id = "id15 5 "> create-items< / a > < / li > < li > < a class = "reference internal" href = "#create-items" id = "id15 6 "> create-items< / a > < / li >
< li > < a class = "reference internal" href = "#locate-ore" id = "id15 6 "> locate-ore< / a > < / li > < li > < a class = "reference internal" href = "#locate-ore" id = "id15 7 "> locate-ore< / a > < / li >
< li > < a class = "reference internal" href = "#soundsense-season" id = "id15 7 "> soundsense-season< / a > < / li > < li > < a class = "reference internal" href = "#soundsense-season" id = "id15 8 "> soundsense-season< / a > < / li >
< li > < a class = "reference internal" href = "#multicmd" id = "id15 8 "> multicmd< / a > < / li > < li > < a class = "reference internal" href = "#multicmd" id = "id15 9 "> multicmd< / a > < / li >
< li > < a class = "reference internal" href = "#dfstatus" id = "id1 59 "> dfstatus< / a > < / li > < li > < a class = "reference internal" href = "#dfstatus" id = "id1 60 "> dfstatus< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#in-game-interface-tools" id = "id16 0 "> In-game interface tools< / a > < ul > < li > < a class = "reference internal" href = "#in-game-interface-tools" id = "id16 1 "> In-game interface tools< / a > < ul >
< li > < a class = "reference internal" href = "#dwarf-manipulator" id = "id16 1 "> Dwarf Manipulator< / a > < / li > < li > < a class = "reference internal" href = "#dwarf-manipulator" id = "id16 2 "> Dwarf Manipulator< / a > < / li >
< li > < a class = "reference internal" href = "#search" id = "id16 2 "> Search< / a > < / li > < li > < a class = "reference internal" href = "#search" id = "id16 3 "> Search< / a > < / li >
< li > < a class = "reference internal" href = "#automaterial" id = "id16 3 "> AutoMaterial< / a > < / li > < li > < a class = "reference internal" href = "#automaterial" id = "id16 4 "> AutoMaterial< / a > < / li >
< li > < a class = "reference internal" href = "#gui-liquids" id = "id16 4 "> gui/liquids< / a > < / li > < li > < a class = "reference internal" href = "#gui-liquids" id = "id16 5 "> gui/liquids< / a > < / li >
< li > < a class = "reference internal" href = "#gui-mechanisms" id = "id16 5 "> gui/mechanisms< / a > < / li > < li > < a class = "reference internal" href = "#gui-mechanisms" id = "id16 6 "> gui/mechanisms< / a > < / li >
< li > < a class = "reference internal" href = "#gui-rename" id = "id16 6 "> gui/rename< / a > < / li > < li > < a class = "reference internal" href = "#gui-rename" id = "id16 7 "> gui/rename< / a > < / li >
< li > < a class = "reference internal" href = "#gui-room-list" id = "id16 7 "> gui/room-list< / a > < / li > < li > < a class = "reference internal" href = "#gui-room-list" id = "id16 8 "> gui/room-list< / a > < / li >
< li > < a class = "reference internal" href = "#gui-choose-weapons" id = "id16 8 "> gui/choose-weapons< / a > < / li > < li > < a class = "reference internal" href = "#gui-choose-weapons" id = "id16 9 "> gui/choose-weapons< / a > < / li >
< li > < a class = "reference internal" href = "#gui-clone-uniform" id = "id1 69 "> gui/clone-uniform< / a > < / li > < li > < a class = "reference internal" href = "#gui-clone-uniform" id = "id1 70 "> gui/clone-uniform< / a > < / li >
< li > < a class = "reference internal" href = "#gui-guide-path" id = "id17 0 "> gui/guide-path< / a > < / li > < li > < a class = "reference internal" href = "#gui-guide-path" id = "id17 1 "> gui/guide-path< / a > < / li >
< li > < a class = "reference internal" href = "#gui-workshop-job" id = "id17 1 "> gui/workshop-job< / a > < / li > < li > < a class = "reference internal" href = "#gui-workshop-job" id = "id17 2 "> gui/workshop-job< / a > < / li >
< li > < a class = "reference internal" href = "#gui-workflow" id = "id17 2 "> gui/workflow< / a > < / li > < li > < a class = "reference internal" href = "#gui-workflow" id = "id17 3 "> gui/workflow< / a > < / li >
< li > < a class = "reference internal" href = "#gui-assign-rack" id = "id17 3 "> gui/assign-rack< / a > < / li > < li > < a class = "reference internal" href = "#gui-assign-rack" id = "id17 4 "> gui/assign-rack< / a > < / li >
< li > < a class = "reference internal" href = "#gui-advfort" id = "id17 4 "> gui/advfort< / a > < / li > < li > < a class = "reference internal" href = "#gui-advfort" id = "id17 5 "> gui/advfort< / a > < / li >
< li > < a class = "reference internal" href = "#gui-companion-order" id = "id17 5 "> gui/companion-order< / a > < / li > < li > < a class = "reference internal" href = "#gui-companion-order" id = "id17 6 "> gui/companion-order< / a > < / li >
< li > < a class = "reference internal" href = "#gui-gm-editor" id = "id17 6 "> gui/gm-editor< / a > < / li > < li > < a class = "reference internal" href = "#gui-gm-editor" id = "id17 7 "> gui/gm-editor< / a > < / li >
< li > < a class = "reference internal" href = "#gui-mod-manager" id = "id17 7 "> gui/mod-manager< / a > < / li > < li > < a class = "reference internal" href = "#gui-mod-manager" id = "id17 8 "> gui/mod-manager< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#behavior-mods" id = "id17 8 "> Behavior Mods< / a > < ul > < li > < a class = "reference internal" href = "#behavior-mods" id = "id17 9 "> Behavior Mods< / a > < ul >
< li > < a class = "reference internal" href = "#siege-engine" id = "id1 79 "> Siege Engine< / a > < ul > < li > < a class = "reference internal" href = "#siege-engine" id = "id1 80 "> Siege Engine< / a > < ul >
< li > < a class = "reference internal" href = "#rationale" id = "id18 0 "> Rationale< / a > < / li > < li > < a class = "reference internal" href = "#rationale" id = "id18 1 "> Rationale< / a > < / li >
< li > < a class = "reference internal" href = "#configuration-ui" id = "id18 1 "> Configuration UI< / a > < / li > < li > < a class = "reference internal" href = "#configuration-ui" id = "id18 2 "> Configuration UI< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#power-meter" id = "id18 2 "> Power Meter< / a > < / li > < li > < a class = "reference internal" href = "#power-meter" id = "id18 3 "> Power Meter< / a > < / li >
< li > < a class = "reference internal" href = "#steam-engine" id = "id18 3 "> Steam Engine< / a > < ul > < li > < a class = "reference internal" href = "#steam-engine" id = "id18 4 "> Steam Engine< / a > < ul >
< li > < a class = "reference internal" href = "#id1" id = "id18 4 "> Rationale< / a > < / li > < li > < a class = "reference internal" href = "#id1" id = "id18 5 "> Rationale< / a > < / li >
< li > < a class = "reference internal" href = "#construction" id = "id18 5 "> Construction< / a > < / li > < li > < a class = "reference internal" href = "#construction" id = "id18 6 "> Construction< / a > < / li >
< li > < a class = "reference internal" href = "#operation" id = "id18 6 "> Operation< / a > < / li > < li > < a class = "reference internal" href = "#operation" id = "id18 7 "> Operation< / a > < / li >
< li > < a class = "reference internal" href = "#explosions" id = "id18 7 "> Explosions< / a > < / li > < li > < a class = "reference internal" href = "#explosions" id = "id18 8 "> Explosions< / a > < / li >
< li > < a class = "reference internal" href = "#save-files" id = "id18 8 "> Save files< / a > < / li > < li > < a class = "reference internal" href = "#save-files" id = "id18 9 "> Save files< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#add-spatter" id = "id1 8 9"> Add Spatter< / a > < / li > < li > < a class = "reference internal" href = "#add-spatter" id = "id1 90 "> Add Spatter< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< / ul > < / ul >
@ -2957,8 +2958,23 @@ twice.</p>
< / ul > < / ul >
< / div > < / div >
< / div > < / div >
< div class = "section" id = "embark-tools" >
< h3 > < a class = "toc-backref" href = "#id129" > embark-tools< / a > < / h3 >
< p > A collection of embark-related tools.< / p >
< p > Usage:< / p >
< pre class = "literal-block" >
embark-tools enable/disable tool [tool]...
< / pre >
< p > Tools:< / p >
< ul class = "simple" >
< li > < tt class = "docutils literal" > anywhere< / tt > : Allows embarking anywhere (including sites, mountain-only biomes, and oceans). Use with caution.< / li >
< li > < tt class = "docutils literal" > nano< / tt > : An implementation of nano embark - allows resizing below 2x2 when enabled.< / li >
< li > < tt class = "docutils literal" > sand< / tt > : Displays an indicator when sand is present in the currently-selected area, similar to the default clay/stone indicators.< / li >
< li > < tt class = "docutils literal" > sticky< / tt > : Maintains the selected local area while navigating the world map< / li >
< / ul >
< / div >
< div class = "section" id = "misery" > < div class = "section" id = "misery" >
< h3 > < a class = "toc-backref" href = "#id129" > misery< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id1 30 "> misery< / a > < / h3 >
< p > When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).< / p > < p > When enabled, every new negative dwarven thought will be multiplied by a factor (2 by default).< / p >
< p > Usage:< / p > < p > Usage:< / p >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
@ -2980,7 +2996,7 @@ twice.</p>
< / table > < / table >
< / div > < / div >
< div class = "section" id = "strangemood" > < div class = "section" id = "strangemood" >
< h3 > < a class = "toc-backref" href = "#id13 0 "> strangemood< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id13 1 "> strangemood< / a > < / h3 >
< p > Creates a strange mood job the same way the game itself normally does it.< / p > < p > Creates a strange mood job the same way the game itself normally does it.< / p >
< p > Options:< / p > < p > Options:< / p >
< blockquote > < blockquote >
@ -3004,13 +3020,13 @@ Valid values are "miner", "carpenter", "engraver",
< p > Known limitations: if the selected unit is currently performing a job, the mood will not be started.< / p > < p > Known limitations: if the selected unit is currently performing a job, the mood will not be started.< / p >
< / div > < / div >
< div class = "section" id = "log-region" > < div class = "section" id = "log-region" >
< h3 > < a class = "toc-backref" href = "#id13 1 "> log-region< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id13 2 "> log-region< / a > < / h3 >
< p > 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.< / p > < p > 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.< / p >
< / div > < / div >
< / div > < / div >
< / div > < / div >
< div class = "section" id = "scripts" > < div class = "section" id = "scripts" >
< h1 > < a class = "toc-backref" href = "#id13 2 "> Scripts< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id13 3 "> Scripts< / a > < / h1 >
< p > Lua or ruby scripts placed in the hack/scripts/ directory are considered for< p > 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
execution as if they were native DFHack commands. They are listed at the end
of the 'ls' command output.< / p >
of the 'ls' command output.< / p >
@ -3019,7 +3035,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.< / p >
scripts that are obscure, developer-oriented, or should be used as keybindings.< / p >
< p > Some notable scripts:< / p > < p > Some notable scripts:< / p >
< div class = "section" id = "fix" > < div class = "section" id = "fix" >
< h2 > < a class = "toc-backref" href = "#id13 3 "> fix/*< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 4 "> fix/*< / a > < / h2 >
< p > Scripts in this subdirectory fix various bugs and issues, some of them obscure.< / p > < p > Scripts in this subdirectory fix various bugs and issues, some of them obscure.< / p >
< ul > < ul >
< li > < p class = "first" > fix/dead-units< / p > < li > < p class = "first" > fix/dead-units< / p >
@ -3056,12 +3072,12 @@ hopefully avoid jamming it again, and unsuspends them.</p>
< / ul > < / ul >
< / div > < / div >
< div class = "section" id = "gui" > < div class = "section" id = "gui" >
< h2 > < a class = "toc-backref" href = "#id13 4 "> gui/*< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 5 "> gui/*< / a > < / h2 >
< p > Scripts that implement dialogs inserted into the main game window are put in this< p > Scripts that implement dialogs inserted into the main game window are put in this
directory.< / p >
directory.< / p >
< / div > < / div >
< div class = "section" id = "binpatch" > < div class = "section" id = "binpatch" >
< h2 > < a class = "toc-backref" href = "#id13 5 "> binpatch< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 6 "> binpatch< / a > < / h2 >
< p > Checks, applies or removes binary patches directly in memory at runtime:< / p > < p > Checks, applies or removes binary patches directly in memory at runtime:< / p >
< pre class = "literal-block" > < pre class = "literal-block" >
binpatch check/apply/remove < patchname>
binpatch check/apply/remove < patchname>
@ -3071,17 +3087,17 @@ script uses <tt class="docutils literal"><span class="pre">hack/patches/<df-v
the version appropriate for the currently loaded executable.< / p >
the version appropriate for the currently loaded executable.< / p >
< / div > < / div >
< div class = "section" id = "quicksave" > < div class = "section" id = "quicksave" >
< h2 > < a class = "toc-backref" href = "#id13 6 "> quicksave< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 7 "> quicksave< / a > < / h2 >
< p > If called in dwarf mode, makes DF immediately auto-save the game by setting a flag< p > If called in dwarf mode, makes DF immediately auto-save the game by setting a flag
normally used in seasonal auto-save.< / p >
normally used in seasonal auto-save.< / p >
< / div > < / div >
< div class = "section" id = "setfps" > < div class = "section" id = "setfps" >
< h2 > < a class = "toc-backref" href = "#id13 7 "> setfps< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 8 "> setfps< / a > < / h2 >
< p > Run < tt class = "docutils literal" > setfps < number> < / tt > to set the FPS cap at runtime, in case you want to watch< p > Run < tt class = "docutils literal" > setfps < number> < / tt > to set the FPS cap at runtime, in case you want to watch
combat in slow motion or something :)< / p >
combat in slow motion or something :)< / p >
< / div > < / div >
< div class = "section" id = "siren" > < div class = "section" id = "siren" >
< h2 > < a class = "toc-backref" href = "#id13 8 "> siren< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id13 9 "> siren< / a > < / h2 >
< p > Wakes up sleeping units, cancels breaks and stops parties either everywhere,< p > Wakes up sleeping units, cancels breaks and stops parties either everywhere,
or in the burrows given as arguments. In return, adds bad thoughts about
or in the burrows given as arguments. In return, adds bad thoughts about
noise, tiredness and lack of protection. Also, the units with interrupted
noise, tiredness and lack of protection. Also, the units with interrupted
@ -3089,7 +3105,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.< / p >
emergencies, e.g. when a siege appears, and all your military is partying.< / p >
< / div > < / div >
< div class = "section" id = "growcrops" > < div class = "section" id = "growcrops" >
< h2 > < a class = "toc-backref" href = "#id1 39 "> growcrops< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 40 "> growcrops< / a > < / h2 >
< p > Instantly grow seeds inside farming plots.< / p > < p > Instantly grow seeds inside farming plots.< / p >
< p > With no argument, this command list the various seed types currently in< p > With no argument, this command list the various seed types currently in
use in your farming plots.
use in your farming plots.
@ -3101,7 +3117,7 @@ growcrops plump 40
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "removebadthoughts" > < div class = "section" id = "removebadthoughts" >
< h2 > < a class = "toc-backref" href = "#id14 0 "> removebadthoughts< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 1 "> removebadthoughts< / a > < / h2 >
< p > This script remove negative thoughts from your dwarves. Very useful against< p > This script remove negative thoughts from your dwarves. Very useful against
tantrum spirals.< / p >
tantrum spirals.< / p >
< p > The script can target a single creature, when used with the < tt class = "docutils literal" > him< / tt > argument,< p > The script can target a single creature, when used with the < tt class = "docutils literal" > him< / tt > argument,
@ -3115,7 +3131,7 @@ but in the short term your dwarves will get much more joyful.</p>
quickly after you unpause.< / p >
quickly after you unpause.< / p >
< / div > < / div >
< div class = "section" id = "exterminate" > < div class = "section" id = "exterminate" >
< h2 > < a class = "toc-backref" href = "#id14 1 "> exterminate< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 2 "> exterminate< / a > < / h2 >
< p > Kills any unit of a given race.< / p > < p > Kills any unit of a given race.< / p >
< p > With no argument, lists the available races and count eligible targets.< / p > < p > With no argument, lists the available races and count eligible targets.< / p >
< p > With the special argument < tt class = "docutils literal" > him< / tt > , targets only the selected creature.< / p > < p > With the special argument < tt class = "docutils literal" > him< / tt > , targets only the selected creature.< / p >
@ -3147,7 +3163,7 @@ exterminate elve magma
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "source" > < div class = "section" id = "source" >
< h2 > < a class = "toc-backref" href = "#id14 2 "> source< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 3 "> source< / a > < / h2 >
< p > Create an infinite magma or water source or drain on a tile.< / p > < p > Create an infinite magma or water source or drain on a tile.< / p >
< p > This script registers a map tile as a liquid source, and every 12 game ticks< p > 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.< / p >
that tile receives or remove 1 new unit of flow based on the configuration.< / p >
@ -3169,14 +3185,14 @@ source add water 0 - water drain
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "masspit" > < div class = "section" id = "masspit" >
< h2 > < a class = "toc-backref" href = "#id14 3 "> masspit< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 4 "> masspit< / a > < / h2 >
< p > Designate all creatures in cages on top of a pit/pond activity zone for pitting.< p > 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.< / p >
Works best with an animal stockpile on top of the zone.< / p >
< p > Works with a zone number as argument (eg < tt class = "docutils literal" > Activity Zone #6< / tt > -> < tt class = "docutils literal" > masspit 6< / tt > )< p > Works with a zone number as argument (eg < tt class = "docutils literal" > Activity Zone #6< / tt > -> < tt class = "docutils literal" > masspit 6< / tt > )
or with the game cursor on top of the area.< / p >
or with the game cursor on top of the area.< / p >
< / div > < / div >
< div class = "section" id = "digfort" > < div class = "section" id = "digfort" >
< h2 > < a class = "toc-backref" href = "#id14 4 "> digfort< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 5 "> digfort< / a > < / h2 >
< p > A script to designate an area for digging according to a plan in csv format.< / p > < p > A script to designate an area for digging according to a plan in csv format.< / p >
< p > This script, inspired from quickfort, can designate an area for digging.< p > This script, inspired from quickfort, can designate an area for digging.
Your plan should be stored in a .csv file like this:< / p >
Your plan should be stored in a .csv file like this:< / p >
@ -3198,7 +3214,7 @@ as an offset for the pattern: instead of starting at the cursor, it will start
Dwarf Fortress.exe is found).< / p >
Dwarf Fortress.exe is found).< / p >
< / div > < / div >
< div class = "section" id = "invasion-now" > < div class = "section" id = "invasion-now" >
< h2 > < a class = "toc-backref" href = "#id14 5 "> invasion-now< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 6 "> invasion-now< / a > < / h2 >
< p > Triggers an invasion, or several in the near future.< / p > < p > Triggers an invasion, or several in the near future.< / p >
< p > < cite > invasion-now civName< / cite > trigger an invasion from the civilization with the id civName, starting in about ten ticks< / p > < p > < cite > invasion-now civName< / cite > trigger an invasion from the civilization with the id civName, starting in about ten ticks< / p >
< p > < cite > invasion-now civName start< / cite > trigger an invasion from civName in a number of ticks between 10*start and 11*start-1 (inclusive)< / p > < p > < cite > invasion-now civName start< / cite > trigger an invasion from civName in a number of ticks between 10*start and 11*start-1 (inclusive)< / p >
@ -3206,7 +3222,7 @@ Dwarf Fortress.exe is found).</p>
< p > Probably fails if the start time of a triggered invasion is later than the start of the next year.< / p > < p > Probably fails if the start time of a triggered invasion is later than the start of the next year.< / p >
< / div > < / div >
< div class = "section" id = "digmat" > < div class = "section" id = "digmat" >
< h2 > < a class = "toc-backref" href = "#id14 6 "> digmat< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 7 "> digmat< / a > < / h2 >
< p > Designates a tile for digging. Monitors the tile, and when it is dug out, add< p > Designates a tile for digging. Monitors the tile, and when it is dug out, add
surrounding discovered tiles of the same material for digging. Similar to 'digv',
surrounding discovered tiles of the same material for digging. Similar to 'digv',
but less cheaty. Works for stone layers, soil layers, veins, etc.< / p >
but less cheaty. Works for stone layers, soil layers, veins, etc.< / p >
@ -3215,7 +3231,7 @@ same designation for future digging (eg dig up/downstairs). When digging stairs,
also designate tiles on z-1 and z+1 when they are discovered.< / p >
also designate tiles on z-1 and z+1 when they are discovered.< / p >
< / div > < / div >
< div class = "section" id = "superdwarf" > < div class = "section" id = "superdwarf" >
< h2 > < a class = "toc-backref" href = "#id14 7 "> superdwarf< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 8 "> superdwarf< / a > < / h2 >
< p > Similar to fastdwarf, per-creature.< / p > < p > Similar to fastdwarf, per-creature.< / p >
< p > To make any creature superfast, target it ingame using 'v' and:< / p > < p > To make any creature superfast, target it ingame using 'v' and:< / p >
< pre class = "literal-block" > < pre class = "literal-block" >
@ -3225,17 +3241,17 @@ superdwarf add
< p > This plugin also shortens the 'sleeping' and 'on break' periods of targets.< / p > < p > This plugin also shortens the 'sleeping' and 'on break' periods of targets.< / p >
< / div > < / div >
< div class = "section" id = "drainaquifer" > < div class = "section" id = "drainaquifer" >
< h2 > < a class = "toc-backref" href = "#id14 8 "> drainaquifer< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id14 9 "> drainaquifer< / a > < / h2 >
< p > Remove all 'aquifer' tag from the map blocks. Irreversible.< / p > < p > Remove all 'aquifer' tag from the map blocks. Irreversible.< / p >
< / div > < / div >
< div class = "section" id = "deathcause" > < div class = "section" id = "deathcause" >
< h2 > < a class = "toc-backref" href = "#id1 49 "> deathcause< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 50 "> deathcause< / a > < / h2 >
< p > Focus a body part ingame, and this script will display the cause of death of< p > Focus a body part ingame, and this script will display the cause of death of
the creature.
the creature.
Also works when selecting units from the 'u'nitlist viewscreen.< / p >
Also works when selecting units from the 'u'nitlist viewscreen.< / p >
< / div > < / div >
< div class = "section" id = "lua" > < div class = "section" id = "lua" >
< h2 > < a class = "toc-backref" href = "#id15 0 "> lua< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 1 "> lua< / a > < / h2 >
< p > There are the following ways to invoke this command:< / p > < p > There are the following ways to invoke this command:< / p >
< ol class = "arabic" > < ol class = "arabic" >
< li > < p class = "first" > < tt class = "docutils literal" > lua< / tt > (without any parameters)< / p > < li > < p class = "first" > < tt class = "docutils literal" > lua< / tt > (without any parameters)< / p >
@ -3254,11 +3270,11 @@ directory. If the filename is not supplied, it loads "dfhack.lua".</p>
< / ol > < / ol >
< / div > < / div >
< div class = "section" id = "embark" > < div class = "section" id = "embark" >
< h2 > < a class = "toc-backref" href = "#id15 1 "> embark< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 2 "> embark< / a > < / h2 >
< p > Allows to embark anywhere. Currently windows only.< / p > < p > Allows to embark anywhere. Currently windows only.< / p >
< / div > < / div >
< div class = "section" id = "lever" > < div class = "section" id = "lever" >
< h2 > < a class = "toc-backref" href = "#id15 2 "> lever< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 3 "> lever< / a > < / h2 >
< p > Allow manipulation of in-game levers from the dfhack console.< / p > < p > Allow manipulation of in-game levers from the dfhack console.< / p >
< p > Can list levers, including state and links, with:< / p > < p > Can list levers, including state and links, with:< / p >
< pre class = "literal-block" > < pre class = "literal-block" >
@ -3272,7 +3288,7 @@ lever pull 42 --now
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "stripcaged" > < div class = "section" id = "stripcaged" >
< h2 > < a class = "toc-backref" href = "#id15 3 "> stripcaged< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 4 "> stripcaged< / a > < / h2 >
< p > For dumping items inside cages. Will mark selected items for dumping, then< p > For dumping items inside cages. Will mark selected items for dumping, then
a dwarf may come and actually dump it. See also < tt class = "docutils literal" > autodump< / tt > .< / p >
a dwarf may come and actually dump it. See also < tt class = "docutils literal" > autodump< / tt > .< / p >
< p > With the < tt class = "docutils literal" > items< / tt > argument, only dumps items laying in the cage, excluding< p > With the < tt class = "docutils literal" > items< / tt > argument, only dumps items laying in the cage, excluding
@ -3290,11 +3306,11 @@ stripcaged weapons 25321 34228
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "undump-buildings" > < div class = "section" id = "undump-buildings" >
< h2 > < a class = "toc-backref" href = "#id15 4 "> undump-buildings< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 5 "> undump-buildings< / a > < / h2 >
< p > Undesignates building base materials for dumping.< / p > < p > Undesignates building base materials for dumping.< / p >
< / div > < / div >
< div class = "section" id = "create-items" > < div class = "section" id = "create-items" >
< h2 > < a class = "toc-backref" href = "#id15 5 "> create-items< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 6 "> create-items< / a > < / h2 >
< p > Spawn arbitrary items under the cursor.< / p > < p > Spawn arbitrary items under the cursor.< / p >
< p > The first argument gives the item category, the second gives the material,< p > 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).< / p >
and the optionnal third gives the number of items to create (defaults to 20).< / p >
@ -3316,7 +3332,7 @@ create-items bar adamantine
< / pre > < / pre >
< / div > < / div >
< div class = "section" id = "locate-ore" > < div class = "section" id = "locate-ore" >
< h2 > < a class = "toc-backref" href = "#id15 6 "> locate-ore< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 7 "> locate-ore< / a > < / h2 >
< p > Scan the map for metal ores.< / p > < p > Scan the map for metal ores.< / p >
< p > Finds and designate for digging one tile of a specific metal ore.< p > 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).< / p >
Only works for native metal ores, does not handle reaction stuff (eg STEEL).< / p >
@ -3329,7 +3345,7 @@ locate-ore iron</dd>
< / dl > < / dl >
< / div > < / div >
< div class = "section" id = "soundsense-season" > < div class = "section" id = "soundsense-season" >
< h2 > < a class = "toc-backref" href = "#id15 7 "> soundsense-season< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 8 "> soundsense-season< / a > < / h2 >
< p > It is a well known issue that Soundsense cannot detect the correct< p > It is a well known issue that Soundsense cannot detect the correct
current season when a savegame is loaded and has to play random
current season when a savegame is loaded and has to play random
season music until a season switch occurs.< / p >
season music until a season switch occurs.< / p >
@ -3338,7 +3354,7 @@ to gamelog.txt on every map load to fix this. For best results
call the script from < tt class = "docutils literal" > dfhack.init< / tt > .< / p >
call the script from < tt class = "docutils literal" > dfhack.init< / tt > .< / p >
< / div > < / div >
< div class = "section" id = "multicmd" > < div class = "section" id = "multicmd" >
< h2 > < a class = "toc-backref" href = "#id15 8 "> multicmd< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id15 9 "> multicmd< / a > < / h2 >
< p > Run multiple dfhack commands. The argument is split around the< p > Run multiple dfhack commands. The argument is split around the
character ; and all parts are run sequencially as independent
character ; and all parts are run sequencially as independent
dfhack commands. Useful for hotkeys.< / p >
dfhack commands. Useful for hotkeys.< / p >
@ -3348,12 +3364,12 @@ dfhack commands. Useful for hotkeys.</p>
< / dl > < / dl >
< / div > < / div >
< div class = "section" id = "dfstatus" > < div class = "section" id = "dfstatus" >
< h2 > < a class = "toc-backref" href = "#id1 59 "> dfstatus< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 60 "> dfstatus< / a > < / h2 >
< p > Show a quick overview of critical stock quantities, including food, dirnks, wood, and various bars.< / p > < p > Show a quick overview of critical stock quantities, including food, dirnks, wood, and various bars.< / p >
< / div > < / div >
< / div > < / div >
< div class = "section" id = "in-game-interface-tools" > < div class = "section" id = "in-game-interface-tools" >
< h1 > < a class = "toc-backref" href = "#id16 0 "> In-game interface tools< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id16 1 "> In-game interface tools< / a > < / h1 >
< p > These tools work by displaying dialogs or overlays in the game window, and< p > These tools work by displaying dialogs or overlays in the game window, and
are mostly implemented by lua scripts.< / p >
are mostly implemented by lua scripts.< / p >
< div class = "note" > < div class = "note" >
@ -3368,7 +3384,7 @@ guideline because it arguably just fixes small usability bugs in the game UI.</p
you must enable the plugins which provide them.< / p >
you must enable the plugins which provide them.< / p >
< / div > < / div >
< div class = "section" id = "dwarf-manipulator" > < div class = "section" id = "dwarf-manipulator" >
< h2 > < a class = "toc-backref" href = "#id16 1 "> Dwarf Manipulator< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 2 "> Dwarf Manipulator< / a > < / h2 >
< p > Implemented by the 'manipulator' plugin.< / p > < p > Implemented by the 'manipulator' plugin.< / p >
< p > To activate, open the unit screen and press 'l'.< / p > < p > To activate, open the unit screen and press 'l'.< / p >
< img alt = "images/manipulator.png" src = "images/manipulator.png" / > < img alt = "images/manipulator.png" src = "images/manipulator.png" / >
@ -3409,7 +3425,7 @@ cursor onto that cell instead of toggling it.</li>
directly to the main dwarf mode screen.< / p >
directly to the main dwarf mode screen.< / p >
< / div > < / div >
< div class = "section" id = "search" > < div class = "section" id = "search" >
< h2 > < a class = "toc-backref" href = "#id16 2 "> Search< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 3 "> Search< / a > < / h2 >
< p > Implemented by the 'search' plugin.< / p > < p > Implemented by the 'search' plugin.< / p >
< p > The search plugin adds search to the Stocks, Animals, Trading, Stockpile,< p > The search plugin adds search to the Stocks, Animals, Trading, Stockpile,
Noble (assignment candidates), Military (position candidates), Burrows
Noble (assignment candidates), Military (position candidates), Burrows
@ -3440,7 +3456,7 @@ only fat or tallow by forbidding fats, then searching for fat/tallow, and
using Permit Fats again while the list is filtered.< / p >
using Permit Fats again while the list is filtered.< / p >
< / div > < / div >
< div class = "section" id = "automaterial" > < div class = "section" id = "automaterial" >
< h2 > < a class = "toc-backref" href = "#id16 3 "> AutoMaterial< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 4 "> AutoMaterial< / a > < / h2 >
< p > Implemented by the 'automaterial' plugin.< / p > < p > Implemented by the 'automaterial' plugin.< / p >
< p > This makes building constructions (walls, floors, fortifications, etc) a little bit< p > 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
easier by saving you from having to trawl through long lists of materials each time
@ -3468,7 +3484,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.< / p >
enabled materials, you should be able to place complex constructions more conveniently.< / p >
< / div > < / div >
< div class = "section" id = "gui-liquids" > < div class = "section" id = "gui-liquids" >
< h2 > < a class = "toc-backref" href = "#id16 4 "> gui/liquids< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 5 "> gui/liquids< / a > < / h2 >
< p > To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.< / p > < p > To use, bind to a key (the example config uses Alt-L) and activate in the 'k' mode.< / p >
< img alt = "images/liquids.png" src = "images/liquids.png" / > < img alt = "images/liquids.png" src = "images/liquids.png" / >
< p > This script is a gui front-end to the liquids plugin and works similar to it,< p > This script is a gui front-end to the liquids plugin and works similar to it,
@ -3488,7 +3504,7 @@ rivers power water wheels even when full and technically not flowing.</p>
< p > After setting up the desired operations using the described keys, use < tt class = "docutils literal" > Enter< / tt > to apply them.< / p > < p > After setting up the desired operations using the described keys, use < tt class = "docutils literal" > Enter< / tt > to apply them.< / p >
< / div > < / div >
< div class = "section" id = "gui-mechanisms" > < div class = "section" id = "gui-mechanisms" >
< h2 > < a class = "toc-backref" href = "#id16 5 "> gui/mechanisms< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 6 "> gui/mechanisms< / a > < / h2 >
< p > To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.< / p > < p > To use, bind to a key (the example config uses Ctrl-M) and activate in the 'q' mode.< / p >
< img alt = "images/mechanisms.png" src = "images/mechanisms.png" / > < img alt = "images/mechanisms.png" src = "images/mechanisms.png" / >
< p > Lists mechanisms connected to the building, and their links. Navigating the list centers< p > Lists mechanisms connected to the building, and their links. Navigating the list centers
@ -3498,7 +3514,7 @@ focus on the current one. Shift-Enter has an effect equivalent to pressing Enter
re-entering the mechanisms ui.< / p >
re-entering the mechanisms ui.< / p >
< / div > < / div >
< div class = "section" id = "gui-rename" > < div class = "section" id = "gui-rename" >
< h2 > < a class = "toc-backref" href = "#id16 6 "> gui/rename< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 7 "> gui/rename< / a > < / h2 >
< p > Backed by the rename plugin, this script allows entering the desired name< p > Backed by the rename plugin, this script allows entering the desired name
via a simple dialog in the game ui.< / p >
via a simple dialog in the game ui.< / p >
< ul > < ul >
@ -3521,7 +3537,7 @@ their species string.</p>
unit profession change to Ctrl-Shift-T.< / p >
unit profession change to Ctrl-Shift-T.< / p >
< / div > < / div >
< div class = "section" id = "gui-room-list" > < div class = "section" id = "gui-room-list" >
< h2 > < a class = "toc-backref" href = "#id16 7 "> gui/room-list< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 8 "> gui/room-list< / a > < / h2 >
< p > To use, bind to a key (the example config uses Alt-R) and activate in the 'q' mode,< p > 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.< / p >
either immediately or after opening the assign owner page.< / p >
< img alt = "images/room-list.png" src = "images/room-list.png" / > < img alt = "images/room-list.png" src = "images/room-list.png" / >
@ -3529,7 +3545,7 @@ either immediately or after opening the assign owner page.</p>
list, and allows unassigning them.< / p >
list, and allows unassigning them.< / p >
< / div > < / div >
< div class = "section" id = "gui-choose-weapons" > < div class = "section" id = "gui-choose-weapons" >
< h2 > < a class = "toc-backref" href = "#id16 8 "> gui/choose-weapons< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id16 9 "> gui/choose-weapons< / a > < / h2 >
< p > Bind to a key (the example config uses Ctrl-W), and activate in the Equip-> View/Customize< p > Bind to a key (the example config uses Ctrl-W), and activate in the Equip-> View/Customize
page of the military screen.< / p >
page of the military screen.< / p >
< p > Depending on the cursor location, it rewrites all 'individual choice weapon' entries< p > Depending on the cursor location, it rewrites all 'individual choice weapon' entries
@ -3540,14 +3556,14 @@ only that entry, and does it even if it is not 'individual choice'.</p>
and may lead to inappropriate weapons being selected.< / p >
and may lead to inappropriate weapons being selected.< / p >
< / div > < / div >
< div class = "section" id = "gui-clone-uniform" > < div class = "section" id = "gui-clone-uniform" >
< h2 > < a class = "toc-backref" href = "#id1 69 "> gui/clone-uniform< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 70 "> gui/clone-uniform< / a > < / h2 >
< p > Bind to a key (the example config uses Ctrl-C), and activate in the Uniforms< p > 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.< / p >
page of the military screen with the cursor in the leftmost list.< / p >
< p > When invoked, the script duplicates the currently selected uniform template,< p > When invoked, the script duplicates the currently selected uniform template,
and selects the newly created copy.< / p >
and selects the newly created copy.< / p >
< / div > < / div >
< div class = "section" id = "gui-guide-path" > < div class = "section" id = "gui-guide-path" >
< h2 > < a class = "toc-backref" href = "#id17 0 "> gui/guide-path< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 1 "> gui/guide-path< / a > < / h2 >
< p > Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with< p > Bind to a key (the example config uses Alt-P), and activate in the Hauling menu with
the cursor over a Guide order.< / p >
the cursor over a Guide order.< / p >
< img alt = "images/guide-path.png" src = "images/guide-path.png" / > < img alt = "images/guide-path.png" src = "images/guide-path.png" / >
@ -3555,7 +3571,7 @@ the cursor over a Guide order.</p>
computes it when the order is executed for the first time.< / p >
computes it when the order is executed for the first time.< / p >
< / div > < / div >
< div class = "section" id = "gui-workshop-job" > < div class = "section" id = "gui-workshop-job" >
< h2 > < a class = "toc-backref" href = "#id17 1 "> gui/workshop-job< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 2 "> gui/workshop-job< / a > < / h2 >
< p > Bind to a key (the example config uses Alt-A), and activate with a job selected in< p > Bind to a key (the example config uses Alt-A), and activate with a job selected in
a workshop in the 'q' mode.< / p >
a workshop in the 'q' mode.< / p >
< img alt = "images/workshop-job.png" src = "images/workshop-job.png" / > < img alt = "images/workshop-job.png" src = "images/workshop-job.png" / >
@ -3591,7 +3607,7 @@ and then try to change the input item type, now it won't let you select <em>plan
you have to unset the material first.< / p >
you have to unset the material first.< / p >
< / div > < / div >
< div class = "section" id = "gui-workflow" > < div class = "section" id = "gui-workflow" >
< h2 > < a class = "toc-backref" href = "#id17 2 "> gui/workflow< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 3 "> gui/workflow< / a > < / h2 >
< p > Bind to a key (the example config uses Alt-W), and activate with a job selected< p > Bind to a key (the example config uses Alt-W), and activate with a job selected
in a workshop in the 'q' mode.< / p >
in a workshop in the 'q' mode.< / p >
< img alt = "images/workflow.png" src = "images/workflow.png" / > < img alt = "images/workflow.png" src = "images/workflow.png" / >
@ -3638,7 +3654,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).< / p >
limit (maximum) and the dark green line is that minus the gap (minimum).< / p >
< / div > < / div >
< div class = "section" id = "gui-assign-rack" > < div class = "section" id = "gui-assign-rack" >
< h2 > < a class = "toc-backref" href = "#id17 3 "> gui/assign-rack< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 4 "> gui/assign-rack< / a > < / h2 >
< p > Bind to a key (the example config uses P), and activate when viewing a weapon< p > Bind to a key (the example config uses P), and activate when viewing a weapon
rack in the 'q' mode.< / p >
rack in the 'q' mode.< / p >
< img alt = "images/assign-rack.png" src = "images/assign-rack.png" / > < img alt = "images/assign-rack.png" src = "images/assign-rack.png" / >
@ -3662,7 +3678,7 @@ the intended user. In order to aid in the choice, it shows the number
of currently assigned racks for every valid squad.< / p >
of currently assigned racks for every valid squad.< / p >
< / div > < / div >
< div class = "section" id = "gui-advfort" > < div class = "section" id = "gui-advfort" >
< h2 > < a class = "toc-backref" href = "#id17 4 "> gui/advfort< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 5 "> gui/advfort< / a > < / h2 >
< p > This script allows to perform jobs in adventure mode. For more complete help< p > 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
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:< / p >
keybinding. (e.g. keybinding set Ctrl-T gui/advfort). Possible arguments:< / p >
@ -3681,7 +3697,7 @@ implies -a</li>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "gui-companion-order" > < div class = "section" id = "gui-companion-order" >
< h2 > < a class = "toc-backref" href = "#id17 5 "> gui/companion-order< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 6 "> gui/companion-order< / a > < / h2 >
< p > A script to issue orders for companions. Select companions with lower case chars, issue orders with upper< p > 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.< / p >
case. Must be in look or talk mode to issue command on tile.< / p >
< img alt = "images/companion-order.png" src = "images/companion-order.png" / > < img alt = "images/companion-order.png" src = "images/companion-order.png" / >
@ -3697,7 +3713,7 @@ case. Must be in look or talk mode to issue command on tile.</p>
< / ul > < / ul >
< / div > < / div >
< div class = "section" id = "gui-gm-editor" > < div class = "section" id = "gui-gm-editor" >
< h2 > < a class = "toc-backref" href = "#id17 6 "> gui/gm-editor< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 7 "> gui/gm-editor< / a > < / h2 >
< p > There are three ways to open this editor:< / p > < p > There are three ways to open this editor:< / p >
< ul class = "simple" > < ul class = "simple" >
< li > using gui/gm-editor command/keybinding - opens editor on what is selected< li > using gui/gm-editor command/keybinding - opens editor on what is selected
@ -3712,14 +3728,14 @@ the same as version above.</li>
in-game help.< / p >
in-game help.< / p >
< / div > < / div >
< div class = "section" id = "gui-mod-manager" > < div class = "section" id = "gui-mod-manager" >
< h2 > < a class = "toc-backref" href = "#id17 7 "> gui/mod-manager< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id17 8 "> gui/mod-manager< / a > < / h2 >
< p > A way to simply install and remove small mods. It looks for specially formatted mods in< p > 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: < a class = "reference external" href = "https://github.com/warmist/df-mini-mods" > github mini mod repository< / a > < / p >
df subfolder 'mods'. Mods are not included, for example mods see: < a class = "reference external" href = "https://github.com/warmist/df-mini-mods" > github mini mod repository< / a > < / p >
< img alt = "images/mod-manager.png" src = "images/mod-manager.png" / > < img alt = "images/mod-manager.png" src = "images/mod-manager.png" / >
< / div > < / div >
< / div > < / div >
< div class = "section" id = "behavior-mods" > < div class = "section" id = "behavior-mods" >
< h1 > < a class = "toc-backref" href = "#id17 8 "> Behavior Mods< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id17 9 "> Behavior Mods< / a > < / h1 >
< p > These plugins, when activated via configuration UI or by detecting certain< p > These plugins, when activated via configuration UI or by detecting certain
structures in RAWs, modify the game engine behavior concerning the target
structures in RAWs, modify the game engine behavior concerning the target
objects to add features not otherwise present.< / p >
objects to add features not otherwise present.< / p >
@ -3730,20 +3746,20 @@ technical challenge, and do not represent any long-term plans to produce more
similar modifications of the game.< / p >
similar modifications of the game.< / p >
< / div > < / div >
< div class = "section" id = "siege-engine" > < div class = "section" id = "siege-engine" >
< h2 > < a class = "toc-backref" href = "#id1 79 "> Siege Engine< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 80 "> Siege Engine< / a > < / h2 >
< p > The siege-engine plugin enables siege engines to be linked to stockpiles, and< p > 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
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
four directions. Also, catapults can be ordered to load arbitrary objects, not
just stones.< / p >
just stones.< / p >
< div class = "section" id = "rationale" > < div class = "section" id = "rationale" >
< h3 > < a class = "toc-backref" href = "#id18 0 "> Rationale< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 1 "> Rationale< / a > < / h3 >
< p > Siege engines are a very interesting feature, but sadly almost useless in the current state< p > 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
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,
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.< / p >
e.g. like making siegers bring their own, are something only Toady can do.< / p >
< / div > < / div >
< div class = "section" id = "configuration-ui" > < div class = "section" id = "configuration-ui" >
< h3 > < a class = "toc-backref" href = "#id18 1 "> Configuration UI< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 2 "> Configuration UI< / a > < / h3 >
< p > The configuration front-end to the plugin is implemented by the gui/siege-engine< p > 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
script. Bind it to a key (the example config uses Alt-A) and activate after selecting
a siege engine in 'q' mode.< / p >
a siege engine in 'q' mode.< / p >
@ -3766,7 +3782,7 @@ menu.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "power-meter" > < div class = "section" id = "power-meter" >
< h2 > < a class = "toc-backref" href = "#id18 2 "> Power Meter< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id18 3 "> Power Meter< / a > < / h2 >
< p > The power-meter plugin implements a modified pressure plate that detects power being< p > 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.< / p >
supplied to gear boxes built in the four adjacent N/S/W/E tiles.< / p >
< p > The configuration front-end is implemented by the gui/power-meter script. Bind it to a< p > The configuration front-end is implemented by the gui/power-meter script. Bind it to a
@ -3777,11 +3793,11 @@ in the build menu.</p>
configuration page, but configures parameters relevant to the modded power meter building.< / p >
configuration page, but configures parameters relevant to the modded power meter building.< / p >
< / div > < / div >
< div class = "section" id = "steam-engine" > < div class = "section" id = "steam-engine" >
< h2 > < a class = "toc-backref" href = "#id18 3 "> Steam Engine< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id18 4 "> Steam Engine< / a > < / h2 >
< p > The steam-engine plugin detects custom workshops with STEAM_ENGINE in< p > The steam-engine plugin detects custom workshops with STEAM_ENGINE in
their token, and turns them into real steam engines.< / p >
their token, and turns them into real steam engines.< / p >
< div class = "section" id = "id1" > < div class = "section" id = "id1" >
< h3 > < a class = "toc-backref" href = "#id18 4 "> Rationale< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 5 "> Rationale< / a > < / h3 >
< p > The vanilla game contains only water wheels and windmills as sources of< p > The vanilla game contains only water wheels and windmills as sources of
power, but windmills give relatively little power, and water wheels require
power, but windmills give relatively little power, and water wheels require
flowing water, which must either be a real river and thus immovable and
flowing water, which must either be a real river and thus immovable and
@ -3792,7 +3808,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.< / p >
in a new way with some glue code and a bit of custom logic.< / p >
< / div > < / div >
< div class = "section" id = "construction" > < div class = "section" id = "construction" >
< h3 > < a class = "toc-backref" href = "#id18 5 "> Construction< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 6 "> Construction< / a > < / h3 >
< p > The workshop needs water as its input, which it takes via a< p > The workshop needs water as its input, which it takes via a
passable floor tile below it, like usual magma workshops do.
passable floor tile below it, like usual magma workshops do.
The magma version also needs magma.< / p >
The magma version also needs magma.< / p >
@ -3816,7 +3832,7 @@ short axles that can be built later than both of the engines.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "operation" > < div class = "section" id = "operation" >
< h3 > < a class = "toc-backref" href = "#id18 6 "> Operation< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 7 "> Operation< / a > < / h3 >
< p > In order to operate the engine, queue the Stoke Boiler job (optionally< p > 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,
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
and perform it. As a result, a " boiling water" item will appear
@ -3847,7 +3863,7 @@ decrease it by further 4%, and also decrease the whole steam
use rate by 10%.< / p >
use rate by 10%.< / p >
< / div > < / div >
< div class = "section" id = "explosions" > < div class = "section" id = "explosions" >
< h3 > < a class = "toc-backref" href = "#id18 7 "> Explosions< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 8 "> Explosions< / a > < / h3 >
< p > The engine must be constructed using barrel, pipe and piston< p > The engine must be constructed using barrel, pipe and piston
from fire-safe, or in the magma version magma-safe metals.< / p >
from fire-safe, or in the magma version magma-safe metals.< / p >
< p > During operation weak parts get gradually worn out, and< p > During operation weak parts get gradually worn out, and
@ -3856,7 +3872,7 @@ toppled during operation by a building destroyer, or a
tantruming dwarf.< / p >
tantruming dwarf.< / p >
< / div > < / div >
< div class = "section" id = "save-files" > < div class = "section" id = "save-files" >
< h3 > < a class = "toc-backref" href = "#id18 8 "> Save files< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id18 9 "> Save files< / a > < / h3 >
< p > It should be safe to load and view engine-using fortresses< p > It should be safe to load and view engine-using fortresses
from a DF version without DFHack installed, except that in such
from a DF version without DFHack installed, except that in such
case the engines won't work. However actually making modifications
case the engines won't work. However actually making modifications
@ -3867,7 +3883,7 @@ being generated.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "add-spatter" > < div class = "section" id = "add-spatter" >
< h2 > < a class = "toc-backref" href = "#id1 8 9"> Add Spatter< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 90 "> Add Spatter< / a > < / h2 >
< p > This plugin makes reactions with names starting with < tt class = "docutils literal" > SPATTER_ADD_< / tt > < p > This plugin makes reactions with names starting with < tt class = "docutils literal" > SPATTER_ADD_< / tt >
produce contaminants on the items instead of improvements. The produced
produce contaminants on the items instead of improvements. The produced
contaminants are immune to being washed away by water or destroyed by
contaminants are immune to being washed away by water or destroyed by
Alexander Gavrilov