@ -318,7 +318,7 @@ ul.auto-toc {
< div class = "section" id = "introduction" > < div class = "section" id = "introduction" >
< h1 > < a class = "toc-backref" href = "#id 8 "> Introduction< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id 7 "> Introduction< / a > < / h1 >
< p > DFHack is a Dwarf Fortress memory access library and a set of basic< p > DFHack is a Dwarf Fortress memory access library and a set of basic
tools that use it. Tools come in the form of plugins or (not yet)
tools that use it. Tools come in the form of plugins or (not yet)
external tools. It is an attempt to unite the various ways tools
external tools. It is an attempt to unite the various ways tools
@ -326,68 +326,70 @@ access DF memory and allow for easier development of new tools.</p>
< div class = "contents topic" id = "contents" > < div class = "contents topic" id = "contents" >
< p class = "topic-title first" > Contents< / p > < p class = "topic-title first" > Contents< / p >
< ul class = "simple" > < ul class = "simple" >
< li > < a class = "reference internal" href = "#introduction" id = "id 8 "> Introduction< / a > < / li > < li > < a class = "reference internal" href = "#introduction" id = "id 7 "> Introduction< / a > < / li >
< li > < a class = "reference internal" href = "#getting-dfhack" id = "id 9 "> Getting DFHack< / a > < / li > < li > < a class = "reference internal" href = "#getting-dfhack" id = "id 8 "> Getting DFHack< / a > < / li >
< li > < a class = "reference internal" href = "#compatibility" id = "id 10 "> Compatibility< / a > < / li > < li > < a class = "reference internal" href = "#compatibility" id = "id 9 "> Compatibility< / a > < / li >
< li > < a class = "reference internal" href = "#installation-removal" id = "id1 1 "> Installation/Removal< / a > < / li > < li > < a class = "reference internal" href = "#installation-removal" id = "id1 0 "> Installation/Removal< / a > < / li >
< li > < a class = "reference internal" href = "#using-dfhack" id = "id1 2 "> Using DFHack< / a > < / li > < li > < a class = "reference internal" href = "#using-dfhack" id = "id1 1 "> Using DFHack< / a > < / li >
< li > < a class = "reference internal" href = "#something-doesn-t-work-help" id = "id1 3 "> Something doesn't work, help!< / a > < / li > < li > < a class = "reference internal" href = "#something-doesn-t-work-help" id = "id1 2 "> Something doesn't work, help!< / a > < / li >
< li > < a class = "reference internal" href = "#commands" id = "id1 4 "> Commands< / a > < ul > < li > < a class = "reference internal" href = "#commands" id = "id1 3 "> Commands< / a > < ul >
< li > < a class = "reference internal" href = "#autodump" id = "id1 5 "> autodump< / a > < ul > < li > < a class = "reference internal" href = "#autodump" id = "id1 4 "> autodump< / a > < ul >
< li > < a class = "reference internal" href = "#options" id = "id1 6 "> Options< / a > < / li > < li > < a class = "reference internal" href = "#options" id = "id1 5 "> Options< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#cleanmap" id = "id1 7 "> cleanmap< / a > < / li > < li > < a class = "reference internal" href = "#cleanmap" id = "id1 6 "> cleanmap< / a > < / li >
< li > < a class = "reference internal" href = "#cleanowned" id = "id1 8 "> cleanowned< / a > < ul > < li > < a class = "reference internal" href = "#cleanowned" id = "id1 7 "> cleanowned< / a > < ul >
< li > < a class = "reference internal" href = "#id1" id = "id1 9 "> Options< / a > < / li > < li > < a class = "reference internal" href = "#id1" id = "id1 8 "> Options< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#colonies" id = "id 20 "> colonies< / a > < ul > < li > < a class = "reference internal" href = "#colonies" id = "id 19 "> colonies< / a > < ul >
< li > < a class = "reference internal" href = "#id2" id = "id2 1 "> Options< / a > < / li > < li > < a class = "reference internal" href = "#id2" id = "id2 0 "> Options< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#deramp-by-zilpin" id = "id2 2 "> deramp (by zilpin)< / a > < / li > < li > < a class = "reference internal" href = "#deramp-by-zilpin" id = "id2 1 "> deramp (by zilpin)< / a > < / li >
< li > < a class = "reference internal" href = "#dfusion" id = "id2 3 "> dfusion< / a > < ul > < li > < a class = "reference internal" href = "#dfusion" id = "id2 2 "> dfusion< / a > < ul >
< li > < a class = "reference internal" href = "#confirmed-working-dfusion-plugins" id = "id2 4 "> Confirmed working DFusion plugins:< / a > < / li > < li > < a class = "reference internal" href = "#confirmed-working-dfusion-plugins" id = "id2 3 "> Confirmed working DFusion plugins:< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#flows" id = "id2 5 "> flows< / a > < / li > < li > < a class = "reference internal" href = "#flows" id = "id2 4 "> flows< / a > < / li >
< li > < a class = "reference internal" href = "#grow" id = "id2 6 "> grow< / a > < / li > < li > < a class = "reference internal" href = "#grow" id = "id2 5 "> grow< / a > < / li >
< li > < a class = "reference internal" href = "#extirpate" id = "id2 7 "> extirpate< / a > < ul > < li > < a class = "reference internal" href = "#extirpate" id = "id2 6 "> extirpate< / a > < ul >
< li > < a class = "reference internal" href = "#id3" id = "id2 8 "> Options< / a > < / li > < li > < a class = "reference internal" href = "#id3" id = "id2 7 "> Options< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#immolate" id = "id2 9 "> immolate< / a > < / li > < li > < a class = "reference internal" href = "#immolate" id = "id2 8 "> immolate< / a > < / li >
< li > < a class = "reference internal" href = "#liquids" id = "id 30 "> liquids< / a > < / li > < li > < a class = "reference internal" href = "#liquids" id = "id 29 "> liquids< / a > < / li >
< li > < a class = "reference internal" href = "#mode" id = "id3 1 "> mode< / a > < / li > < li > < a class = "reference internal" href = "#mode" id = "id3 0 "> mode< / a > < / li >
< li > < a class = "reference internal" href = "#forcepause" id = "id3 2 "> forcepause< / a > < / li > < li > < a class = "reference internal" href = "#forcepause" id = "id3 1 "> forcepause< / a > < / li >
< li > < a class = "reference internal" href = "#die" id = "id3 3 "> die< / a > < / li > < li > < a class = "reference internal" href = "#die" id = "id3 2 "> die< / a > < / li >
< li > < a class = "reference internal" href = "#probe" id = "id3 4 "> probe< / a > < / li > < li > < a class = "reference internal" href = "#probe" id = "id3 3 "> probe< / a > < / li >
< li > < a class = "reference internal" href = "#prospector" id = "id3 5 "> prospector< / a > < ul > < li > < a class = "reference internal" href = "#prospector" id = "id3 4 "> prospector< / a > < ul >
< li > < a class = "reference internal" href = "#id4" id = "id3 6 "> Options< / a > < / li > < li > < a class = "reference internal" href = "#id4" id = "id3 5 "> Options< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#reveal" id = "id3 7 "> reveal< / a > < / li > < li > < a class = "reference internal" href = "#reveal" id = "id3 6 "> reveal< / a > < / li >
< li > < a class = "reference internal" href = "#unreveal" id = "id3 8 "> unreveal< / a > < / li > < li > < a class = "reference internal" href = "#unreveal" id = "id3 7 "> unreveal< / a > < / li >
< li > < a class = "reference internal" href = "#revtoggle" id = "id3 9 "> revtoggle< / a > < / li > < li > < a class = "reference internal" href = "#revtoggle" id = "id3 8 "> revtoggle< / a > < / li >
< li > < a class = "reference internal" href = "#revflood" id = "id 40 "> revflood< / a > < / li > < li > < a class = "reference internal" href = "#revflood" id = "id 39 "> revflood< / a > < / li >
< li > < a class = "reference internal" href = "#ssense-stonesense" id = "id4 1 "> ssense / stonesense< / a > < / li > < li > < a class = "reference internal" href = "#ssense-stonesense" id = "id4 0 "> ssense / stonesense< / a > < / li >
< li > < a class = "reference internal" href = "#tubefill" id = "id4 2 "> tubefill< / a > < / li > < li > < a class = "reference internal" href = "#tubefill" id = "id4 1 "> tubefill< / a > < / li >
< li > < a class = "reference internal" href = "#vdig" id = "id4 3 "> vdig< / a > < / li > < li > < a class = "reference internal" href = "#vdig" id = "id4 2 "> vdig< / a > < / li >
< li > < a class = "reference internal" href = "#vdigx" id = "id4 4 "> vdigx< / a > < / li > < li > < a class = "reference internal" href = "#vdigx" id = "id4 3 "> vdigx< / a > < / li >
< li > < a class = "reference internal" href = "#expdig" id = "id4 5 "> expdig< / a > < ul > < li > < a class = "reference internal" href = "#expdig" id = "id4 4 "> expdig< / a > < ul >
< li > < a class = "reference internal" href = "#patterns" id = "id4 6 "> Patterns:< / a > < / li > < li > < a class = "reference internal" href = "#patterns" id = "id4 5 "> Patterns:< / a > < / li >
< li > < a class = "reference internal" href = "#filters" id = "id4 7 "> Filters:< / a > < / li > < li > < a class = "reference internal" href = "#filters" id = "id4 6 "> Filters:< / a > < / li >
< li > < a class = "reference internal" href = "#examples" id = "id4 8 "> Examples:< / a > < / li > < li > < a class = "reference internal" href = "#examples" id = "id4 7 "> Examples:< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#digcircle" id = "id49" > digcircle< / a > < ul > < li > < a class = "reference internal" href = "#digcircle" id = "id48" > digcircle< / a > < ul >
< li > < a class = "reference internal" href = "#id5" id = "id50" > Options:< / a > < / li > < li > < a class = "reference internal" href = "#shape" id = "id49" > Shape:< / a > < / li >
< li > < a class = "reference internal" href = "#id6" id = "id51" > Examples:< / a > < / li > < li > < a class = "reference internal" href = "#action" id = "id50" > Action:< / a > < / li >
< li > < a class = "reference internal" href = "#designation-types" id = "id51" > Designation types:< / a > < / li >
< li > < a class = "reference internal" href = "#id5" id = "id52" > Examples:< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< li > < a class = "reference internal" href = "#weather" id = "id5 2 "> weather< / a > < ul > < li > < a class = "reference internal" href = "#weather" id = "id5 3 "> weather< / a > < ul >
< li > < a class = "reference internal" href = "#id 7" id = "id53 "> Options:< / a > < / li > < li > < a class = "reference internal" href = "#id 6" id = "id54 "> Options:< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< / ul > < / ul >
@ -396,14 +398,14 @@ access DF memory and allow for easier development of new tools.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "getting-dfhack" > < div class = "section" id = "getting-dfhack" >
< h1 > < a class = "toc-backref" href = "#id 9 "> Getting DFHack< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id 8 "> Getting DFHack< / a > < / h1 >
< p > The project is currently hosted on < a class = "reference external" href = "http://www.github.com/" > github< / a > , for both source and< p > The project is currently hosted on < a class = "reference external" href = "http://www.github.com/" > github< / a > , for both source and
binaries at < a class = "reference external" href = "http://github.com/peterix/dfhack" > http://github.com/peterix/dfhack< / a > < / p >
binaries at < a class = "reference external" href = "http://github.com/peterix/dfhack" > http://github.com/peterix/dfhack< / a > < / p >
< p > Releases can be downloaded from here: < a class = "reference external" href = "https://github.com/peterix/dfhack/downloads" > https://github.com/peterix/dfhack/downloads< / a > < / p > < p > Releases can be downloaded from here: < a class = "reference external" href = "https://github.com/peterix/dfhack/downloads" > https://github.com/peterix/dfhack/downloads< / a > < / p >
< p > All new releases are announced in the bay12 thread: < a class = "reference external" href = "http://tinyurl.com/dfhack-ng" > http://tinyurl.com/dfhack-ng< / a > < / p > < p > All new releases are announced in the bay12 thread: < a class = "reference external" href = "http://tinyurl.com/dfhack-ng" > http://tinyurl.com/dfhack-ng< / a > < / p >
< / div > < / div >
< div class = "section" id = "compatibility" > < div class = "section" id = "compatibility" >
< h1 > < a class = "toc-backref" href = "#id 10 "> Compatibility< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id 9 "> Compatibility< / a > < / h1 >
< p > DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.< p > DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.
OSX is not supported due to lack of developers with a Mac.< / p >
OSX is not supported due to lack of developers with a Mac.< / p >
< p > Currently, only the 31.25 version is supported. If you need DFHack< p > Currently, only the 31.25 version is supported. If you need DFHack
@ -412,7 +414,7 @@ for older versions, look for older releases.</p>
< p > It is possible to use the Windows DFHack under wine/OSX.< / p > < p > It is possible to use the Windows DFHack under wine/OSX.< / p >
< / div > < / div >
< div class = "section" id = "installation-removal" > < div class = "section" id = "installation-removal" >
< h1 > < a class = "toc-backref" href = "#id1 1 "> Installation/Removal< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id1 0 "> Installation/Removal< / a > < / h1 >
< p > Installing DFhack involves copying files into your DF folder.< p > Installing DFhack involves copying files into your DF folder.
Copy the files from a release archive so that:< / p >
Copy the files from a release archive so that:< / p >
< blockquote > < blockquote >
@ -438,7 +440,7 @@ Copy the files from a release archive so that:</p>
< p > If it refuses to load, check the stderr.log file created in your DF folder.< / p > < p > If it refuses to load, check the stderr.log file created in your DF folder.< / p >
< / div > < / div >
< div class = "section" id = "using-dfhack" > < div class = "section" id = "using-dfhack" >
< h1 > < a class = "toc-backref" href = "#id1 2 "> Using DFHack< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id1 1 "> Using DFHack< / a > < / h1 >
< p > DFHack basically extends what DF can do with something similar to a quake console. On Windows, this is a separate command line window. On linux, the terminal used to launch the dfhack script is taken over (so, make sure you start from a terminal).< p > DFHack basically extends what DF can do with something similar to a quake console. On Windows, this is a separate command line window. On linux, the terminal used to launch the dfhack script is taken over (so, make sure you start from a terminal).
Basic interaction with dfhack involves entering commands into the console. For some basic instroduction, use the 'help' command. To list all possible commands, use the 'ls' command.
Basic interaction with dfhack involves entering commands into the console. For some basic instroduction, use the 'help' command. To list all possible commands, use the 'ls' command.
Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.< / p >
Many commands have their own help or detailed description. You can use 'command help' or 'command ?' to show that.< / p >
@ -448,21 +450,21 @@ Some commands can't be used from hotkeys - this includes interactive commands li
< p > Most of the commands come from plugins. Those reside in 'DF/plugins/'.< / p > < p > Most of the commands come from plugins. Those reside in 'DF/plugins/'.< / p >
< / div > < / div >
< div class = "section" id = "something-doesn-t-work-help" > < div class = "section" id = "something-doesn-t-work-help" >
< h1 > < a class = "toc-backref" href = "#id1 3 "> Something doesn't work, help!< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id1 2 "> Something doesn't work, help!< / a > < / h1 >
< p > First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening.< p > First, don't panic :) Second, dfhack keeps a few log files in DF's folder - stderr.log and stdout.log. You can look at those and possibly find out what's happening.
If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (< a class = "reference external" href = "mailto:peterix@gmail.com" > peterix@ gmail.com< / a > ) or visit the #dfhack IRC channel on freenode.< / p >
If you found a bug, you can either report it in the bay12 DFHack thread, the issues tracker on github, contact me (< a class = "reference external" href = "mailto:peterix@gmail.com" > peterix@ gmail.com< / a > ) or visit the #dfhack IRC channel on freenode.< / p >
< / div > < / div >
< div class = "section" id = "commands" > < div class = "section" id = "commands" >
< h1 > < a class = "toc-backref" href = "#id1 4 "> Commands< / a > < / h1 > < h1 > < a class = "toc-backref" href = "#id1 3 "> Commands< / a > < / h1 >
< p > Almost all the commands have a 'help'/'?' option that will give you further help without having to look at this document.< / p > < p > Almost all the commands have a 'help'/'?' option that will give you further help without having to look at this document.< / p >
< div class = "section" id = "autodump" > < div class = "section" id = "autodump" >
< h2 > < a class = "toc-backref" href = "#id1 5 "> autodump< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 4 "> autodump< / a > < / h2 >
< p > Automated item dumping tool. All loose items on the floor marked< p > Automated item dumping tool. All loose items on the floor marked
for dumping are insta-dumped to the position of the in-game cursor.< / p >
for dumping are insta-dumped to the position of the in-game cursor.< / p >
< p > Cursor must be placed on a floor tile. Instadumped items may not< p > Cursor must be placed on a floor tile. Instadumped items may not
show up in the cursor description list until you save/reload.< / p >
show up in the cursor description list until you save/reload.< / p >
< div class = "section" id = "options" > < div class = "section" id = "options" >
< h3 > < a class = "toc-backref" href = "#id1 6 "> Options< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id1 5 "> Options< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -474,16 +476,16 @@ show up in the cursor description list until you save/reload.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "cleanmap" > < div class = "section" id = "cleanmap" >
< h2 > < a class = "toc-backref" href = "#id1 7 "> cleanmap< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 6 "> cleanmap< / a > < / h2 >
< p > Cleans all the splatter that get scattered all over the map.< p > Cleans all the splatter that get scattered all over the map.
By default, it leaves mud and snow alone.< / p >
By default, it leaves mud and snow alone.< / p >
< / div > < / div >
< div class = "section" id = "cleanowned" > < div class = "section" id = "cleanowned" >
< h2 > < a class = "toc-backref" href = "#id1 8 "> cleanowned< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 7 "> cleanowned< / a > < / h2 >
< p > Confiscates items owned by dwarfs.< p > Confiscates items owned by dwarfs.
By default, owned food on the floor and rotten items are confistacted and dumped.< / p >
By default, owned food on the floor and rotten items are confistacted and dumped.< / p >
< div class = "section" id = "id1" > < div class = "section" id = "id1" >
< h3 > < a class = "toc-backref" href = "#id1 9 "> Options< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id1 8 "> Options< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -503,10 +505,10 @@ By default, owned food on the floor and rotten items are confistacted and dumped
< / div > < / div >
< / div > < / div >
< div class = "section" id = "colonies" > < div class = "section" id = "colonies" >
< h2 > < a class = "toc-backref" href = "#id 20 "> colonies< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 19 "> colonies< / a > < / h2 >
< p > Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.< / p > < p > Allows listing all the vermin colonies on the map and optionally turning them into honey bee colonies.< / p >
< div class = "section" id = "id2" > < div class = "section" id = "id2" >
< h3 > < a class = "toc-backref" href = "#id2 1 "> Options< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id2 0 "> Options< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -518,16 +520,16 @@ By default, owned food on the floor and rotten items are confistacted and dumped
< / div > < / div >
< / div > < / div >
< div class = "section" id = "deramp-by-zilpin" > < div class = "section" id = "deramp-by-zilpin" >
< h2 > < a class = "toc-backref" href = "#id2 2 "> deramp (by zilpin)< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 1 "> deramp (by zilpin)< / a > < / h2 >
< p > Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.< p > Removes all ramps designated for removal from the map. This is useful for replicating the old channel digging designation.
It also removes any and all 'down ramps' that can remain after a cave-in (you don't have to designate anything for that to happen).< / p >
It also removes any and all 'down ramps' that can remain after a cave-in (you don't have to designate anything for that to happen).< / p >
< / div > < / div >
< div class = "section" id = "dfusion" > < div class = "section" id = "dfusion" >
< h2 > < a class = "toc-backref" href = "#id2 3 "> dfusion< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 2 "> dfusion< / a > < / h2 >
< p > This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.< / p > < p > This is the DFusion lua plugin system by warmist/darius, running as a DFHack plugin.< / p >
< p > See the bay12 thread for details: < a class = "reference external" href = "http://www.bay12forums.com/smf/index.php?topic=69682.15" > http://www.bay12forums.com/smf/index.php?topic=69682.15< / a > < / p > < p > See the bay12 thread for details: < a class = "reference external" href = "http://www.bay12forums.com/smf/index.php?topic=69682.15" > http://www.bay12forums.com/smf/index.php?topic=69682.15< / a > < / p >
< div class = "section" id = "confirmed-working-dfusion-plugins" > < div class = "section" id = "confirmed-working-dfusion-plugins" >
< h3 > < a class = "toc-backref" href = "#id2 4 "> Confirmed working DFusion plugins:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id2 3 "> Confirmed working DFusion plugins:< / a > < / h3 >
< p > :simple_embark:allows changing the number of dwarves available on embark.< / p > < p > :simple_embark:allows changing the number of dwarves available on embark.< / p >
< div class = "note" > < div class = "note" >
< p class = "first admonition-title" > Note< / p > < p class = "first admonition-title" > Note< / p >
@ -540,19 +542,19 @@ It also removes any and all 'down ramps' that can remain after a cave-in (you do
< / div > < / div >
< / div > < / div >
< div class = "section" id = "flows" > < div class = "section" id = "flows" >
< h2 > < a class = "toc-backref" href = "#id2 5 "> flows< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 4 "> flows< / a > < / h2 >
< p > A tool for checking how many tiles contain flowing liquids. If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map.< / p > < p > A tool for checking how many tiles contain flowing liquids. If you suspect that your magma sea leaks into HFS, you can use this tool to be sure without revealing the map.< / p >
< / div > < / div >
< div class = "section" id = "grow" > < div class = "section" id = "grow" >
< h2 > < a class = "toc-backref" href = "#id2 6 "> grow< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 5 "> grow< / a > < / h2 >
< p > Makes all saplings present on the map grow into trees (almost) instantly.< / p > < p > Makes all saplings present on the map grow into trees (almost) instantly.< / p >
< / div > < / div >
< div class = "section" id = "extirpate" > < div class = "section" id = "extirpate" >
< h2 > < a class = "toc-backref" href = "#id2 7 "> extirpate< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 6 "> extirpate< / a > < / h2 >
< p > A tool for getting rid of trees and shrubs. By default, it only kills a tree/shrub under the cursor.< p > A tool for getting rid of trees and shrubs. By default, it only kills a tree/shrub under the cursor.
The plants are turned into ashes instantly.< / p >
The plants are turned into ashes instantly.< / p >
< div class = "section" id = "id3" > < div class = "section" id = "id3" >
< h3 > < a class = "toc-backref" href = "#id2 8 "> Options< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id2 7 "> Options< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -568,11 +570,11 @@ The plants are turned into ashes instantly.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "immolate" > < div class = "section" id = "immolate" >
< h2 > < a class = "toc-backref" href = "#id2 9 "> immolate< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 8 "> immolate< / a > < / h2 >
< p > Very similar to extirpate, but additionally sets the plants on fire. The fires can and < em > will< / em > spread ;)< / p > < p > Very similar to extirpate, but additionally sets the plants on fire. The fires can and < em > will< / em > spread ;)< / p >
< / div > < / div >
< div class = "section" id = "liquids" > < div class = "section" id = "liquids" >
< h2 > < a class = "toc-backref" href = "#id 30 "> liquids< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 29 "> liquids< / a > < / h2 >
< p > Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey.< p > Allows adding magma, water and obsidian to the game. It replaces the normal dfhack command line and can't be used from a hotkey.
For more information, refer to the command's internal help.< / p >
For more information, refer to the command's internal help.< / p >
< div class = "note" > < div class = "note" >
@ -582,7 +584,7 @@ temperatures (creating heat traps). You've been warned.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "mode" > < div class = "section" id = "mode" >
< h2 > < a class = "toc-backref" href = "#id3 1 "> mode< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 0 "> mode< / a > < / h2 >
< p > This command lets you see and change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results.< p > This command lets you see and change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results.
There are a few good ones though.< / p >
There are a few good ones though.< / p >
< div class = "admonition-example admonition" > < div class = "admonition-example admonition" >
@ -594,22 +596,22 @@ You just lost a fortress and gained an adventurer.</p>
< p > I take no responsibility of anything that happens as a result of using this tool :P< / p > < p > I take no responsibility of anything that happens as a result of using this tool :P< / p >
< / div > < / div >
< div class = "section" id = "forcepause" > < div class = "section" id = "forcepause" >
< h2 > < a class = "toc-backref" href = "#id3 2 "> forcepause< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 1 "> forcepause< / a > < / h2 >
< p > Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.< / p > < p > Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.< / p >
< / div > < / div >
< div class = "section" id = "die" > < div class = "section" id = "die" >
< h2 > < a class = "toc-backref" href = "#id3 3 "> die< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 2 "> die< / a > < / h2 >
< p > Instantly kills DF without saving.< / p > < p > Instantly kills DF without saving.< / p >
< / div > < / div >
< div class = "section" id = "probe" > < div class = "section" id = "probe" >
< h2 > < a class = "toc-backref" href = "#id3 4 "> probe< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 3 "> probe< / a > < / h2 >
< p > Can be used to determine tile properties like temperature.< / p > < p > Can be used to determine tile properties like temperature.< / p >
< / div > < / div >
< div class = "section" id = "prospector" > < div class = "section" id = "prospector" >
< h2 > < a class = "toc-backref" href = "#id3 5 "> prospector< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 4 "> prospector< / a > < / h2 >
< p > Lists all available minerals on the map and how much of them there is. By default, only processes the already discovered part of the map.< / p > < p > Lists all available minerals on the map and how much of them there is. By default, only processes the already discovered part of the map.< / p >
< div class = "section" id = "id4" > < div class = "section" id = "id4" >
< h3 > < a class = "toc-backref" href = "#id3 6 "> Options< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id3 5 "> Options< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -621,23 +623,23 @@ You just lost a fortress and gained an adventurer.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "reveal" > < div class = "section" id = "reveal" >
< h2 > < a class = "toc-backref" href = "#id3 7 "> reveal< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 6 "> reveal< / a > < / h2 >
< p > This reveals the map. By default, HFS will remain hidden so that the demons don't spawn. You can use 'reveal hell' to reveal everything. With hell revealed, you won't be able to unpause until you hide the map again.< / p > < p > This reveals the map. By default, HFS will remain hidden so that the demons don't spawn. You can use 'reveal hell' to reveal everything. With hell revealed, you won't be able to unpause until you hide the map again.< / p >
< / div > < / div >
< div class = "section" id = "unreveal" > < div class = "section" id = "unreveal" >
< h2 > < a class = "toc-backref" href = "#id3 8 "> unreveal< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 7 "> unreveal< / a > < / h2 >
< p > Reverts the effects of 'reveal'.< / p > < p > Reverts the effects of 'reveal'.< / p >
< / div > < / div >
< div class = "section" id = "revtoggle" > < div class = "section" id = "revtoggle" >
< h2 > < a class = "toc-backref" href = "#id3 9 "> revtoggle< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 8 "> revtoggle< / a > < / h2 >
< p > Switches between 'reveal' and 'unreveal'.< / p > < p > Switches between 'reveal' and 'unreveal'.< / p >
< / div > < / div >
< div class = "section" id = "revflood" > < div class = "section" id = "revflood" >
< h2 > < a class = "toc-backref" href = "#id 40 "> revflood< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 39 "> revflood< / a > < / h2 >
< p > This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.< / p > < p > This command will hide the whole map and then reveal all the tiles that have a path to the in-game cursor.< / p >
< / div > < / div >
< div class = "section" id = "ssense-stonesense" > < div class = "section" id = "ssense-stonesense" >
< h2 > < a class = "toc-backref" href = "#id4 1 "> ssense / stonesense< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id4 0 "> ssense / stonesense< / a > < / h2 >
< p > An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).< / p > < p > An isometric visualizer that runs in a second window. This requires working graphics acceleration and at least a dual core CPU (otherwise it will slow down DF).< / p >
< p > Unfortunately currently fails to run on Windows XP and most Linux distributions.< / p > < p > Unfortunately currently fails to run on Windows XP and most Linux distributions.< / p >
< p > All the data resides in the 'stonesense' directory.< / p > < p > All the data resides in the 'stonesense' directory.< / p >
@ -647,24 +649,24 @@ You just lost a fortress and gained an adventurer.</p>
< a class = "reference external" href = "http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository" > http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository< / a > < / p > < a class = "reference external" href = "http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository" > http://df.magmawiki.com/index.php/Utility:Stonesense/Content_repository< / a > < / p >
< / div > < / div >
< div class = "section" id = "tubefill" > < div class = "section" id = "tubefill" >
< h2 > < a class = "toc-backref" href = "#id4 2 "> tubefill< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id4 1 "> tubefill< / a > < / h2 >
< p > Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).< / p > < p > Fills all the adamantine veins again. Veins that were empty will be filled in too, but might still trigger a demon invasion (this is a known bug).< / p >
< / div > < / div >
< div class = "section" id = "vdig" > < div class = "section" id = "vdig" >
< h2 > < a class = "toc-backref" href = "#id4 3 "> vdig< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id4 2 "> vdig< / a > < / h2 >
< p > Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).< / p > < p > Designates a whole vein for digging. Requires an active in-game cursor placed over a vein tile. With the 'x' option, it will traverse z-levels (putting stairs between the same-material tiles).< / p >
< / div > < / div >
< div class = "section" id = "vdigx" > < div class = "section" id = "vdigx" >
< h2 > < a class = "toc-backref" href = "#id4 4 "> vdigx< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id4 3 "> vdigx< / a > < / h2 >
< p > A permanent alias for 'vdig x'.< / p > < p > A permanent alias for 'vdig x'.< / p >
< / div > < / div >
< div class = "section" id = "expdig" > < div class = "section" id = "expdig" >
< h2 > < a class = "toc-backref" href = "#id4 5 "> expdig< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id4 4 "> expdig< / a > < / h2 >
< p > This command can be used for exploratory mining.< / p > < p > This command can be used for exploratory mining.< / p >
< p > See: < a class = "reference external" href = "http://df.magmawiki.com/index.php/DF2010:Exploratory_mining" > http://df.magmawiki.com/index.php/DF2010:Exploratory_mining< / a > < / p > < p > See: < a class = "reference external" href = "http://df.magmawiki.com/index.php/DF2010:Exploratory_mining" > http://df.magmawiki.com/index.php/DF2010:Exploratory_mining< / a > < / p >
< p > There are two variables that can be set: pattern and filter.< / p > < p > There are two variables that can be set: pattern and filter.< / p >
< div class = "section" id = "patterns" > < div class = "section" id = "patterns" >
< h3 > < a class = "toc-backref" href = "#id4 6 "> Patterns:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id4 5 "> Patterns:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -681,7 +683,7 @@ You just lost a fortress and gained an adventurer.</p>
< / table > < / table >
< / div > < / div >
< div class = "section" id = "filters" > < div class = "section" id = "filters" >
< h3 > < a class = "toc-backref" href = "#id4 7 "> Filters:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id4 6 "> Filters:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -697,7 +699,7 @@ You just lost a fortress and gained an adventurer.</p>
< p > After you have a pattern set, you can use 'expdig' to apply it again.< / p > < p > After you have a pattern set, you can use 'expdig' to apply it again.< / p >
< / div > < / div >
< div class = "section" id = "examples" > < div class = "section" id = "examples" >
< h3 > < a class = "toc-backref" href = "#id4 8 "> Examples:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id4 7 "> Examples:< / a > < / h3 >
< ul class = "simple" > < ul class = "simple" >
< li > 'expdig diag5 hidden' = designate the diagonal 5 patter over all hidden tiles.< / li > < li > 'expdig diag5 hidden' = designate the diagonal 5 patter over all hidden tiles.< / li >
< li > 'expdig' = apply last used pattern and filter.< / li > < li > 'expdig' = apply last used pattern and filter.< / li >
@ -706,10 +708,11 @@ You just lost a fortress and gained an adventurer.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "digcircle" > < div class = "section" id = "digcircle" >
< h2 > < a class = "toc-backref" href = "#id49" > digcircle< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id48" > digcircle< / a > < / h2 >
< p > A command for easy designation of filled and hollow circles.< / p > < p > A command for easy designation of filled and hollow circles.
< div class = "section" id = "id5" > It has several types of options.< / p >
< h3 > < a class = "toc-backref" href = "#id50" > Options:< / a > < / h3 > < div class = "section" id = "shape" >
< h3 > < a class = "toc-backref" href = "#id49" > Shape:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
@ -718,19 +721,51 @@ You just lost a fortress and gained an adventurer.</p>
< / tr > < / tr >
< tr class = "field" > < th class = "field-name" > filled:< / th > < td class = "field-body" > Set the circle to filled< / td > < tr class = "field" > < th class = "field-name" > filled:< / th > < td class = "field-body" > Set the circle to filled< / td >
< / tr > < / tr >
< tr class = "field" > < th class = "field-name" > #:< / th > < td class = "field-body" > Diameter in tiles (default = 0, does nothing)< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "action" >
< h3 > < a class = "toc-backref" href = "#id50" > Action:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field" > < th class = "field-name" > set:< / th > < td class = "field-body" > Set designation (default)< / td > < tr class = "field" > < th class = "field-name" > set:< / th > < td class = "field-body" > Set designation (default)< / td >
< / tr > < / tr >
< tr class = "field" > < th class = "field-name" > unset:< / th > < td class = "field-body" > Unset current designation< / td > < tr class = "field" > < th class = "field-name" > unset:< / th > < td class = "field-body" > Unset current designation< / td >
< / tr > < / tr >
< tr class = "field" > < th class = "field-name" > #:< / th > < td class = "field-body" > Radius in tiles (default = 0)< / td > < tr class = "field" > < th class = "field-name" > invert:< / th > < td class = "field-body" > Invert designations already present< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div class = "section" id = "designation-types" >
< h3 > < a class = "toc-backref" href = "#id51" > Designation types:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field" > < th class = "field-name" > dig:< / th > < td class = "field-body" > Normal digging designation (default)< / td >
< / tr >
< tr class = "field" > < th class = "field-name" > ramp:< / th > < td class = "field-body" > Ramp digging< / td >
< / tr >
< tr class = "field" > < th class = "field-name" > ustair:< / th > < td class = "field-body" > Staircase up< / td >
< / tr >
< tr class = "field" > < th class = "field-name" > dstair:< / th > < td class = "field-body" > Staircase down< / td >
< / tr >
< tr class = "field" > < th class = "field-name" > xstair:< / th > < td class = "field-body" > Staircase up/down< / td >
< / tr >
< tr class = "field" > < th class = "field-name" > chan:< / th > < td class = "field-body" > Dig channel< / td >
< / tr > < / tr >
< / tbody > < / tbody >
< / table > < / table >
< p > After you have set the options, the command called with no options< p > After you have set the options, the command called with no options
repeats with the last selected parameters.< / p >
repeats with the last selected parameters.< / p >
< / div > < / div >
< div class = "section" id = "id6" > < div class = "section" id = "id 5 ">
< h3 > < a class = "toc-backref" href = "#id51" > Examples:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id5 2 "> Examples:< / a > < / h3 >
< ul class = "simple" > < ul class = "simple" >
< li > 'digcircle filled 3' = Dig a filled circle with radius = 3.< / li > < li > 'digcircle filled 3' = Dig a filled circle with radius = 3.< / li >
< li > 'digcircle' = Do it again.< / li > < li > 'digcircle' = Do it again.< / li >
@ -738,11 +773,11 @@ repeats with the last selected parameters.</p>
< / div > < / div >
< / div > < / div >
< div class = "section" id = "weather" > < div class = "section" id = "weather" >
< h2 > < a class = "toc-backref" href = "#id5 2 "> weather< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id5 3 "> weather< / a > < / h2 >
< p > Prints the current weather map by default.< / p > < p > Prints the current weather map by default.< / p >
< p > Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.< / p > < p > Also lets you change the current weather to 'clear sky', 'rainy' or 'snowing'.< / p >
< div class = "section" id = "id 7 "> < div class = "section" id = "id 6 ">
< h3 > < a class = "toc-backref" href = "#id5 3 "> Options:< / a > < / h3 > < h3 > < a class = "toc-backref" href = "#id5 4 "> Options:< / a > < / h3 >
< table class = "docutils field-list" frame = "void" rules = "none" > < table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / > < col class = "field-name" / >
< col class = "field-body" / > < col class = "field-body" / >
Petr Mrázek