@ -314,7 +314,7 @@ ul.auto-toc {
< div class = "section" id = "introduction" >
< div class = "section" id = "introduction" >
< h1 > < a class = "toc-backref" href = "#id 1 "> Introduction< / a > < / h1 >
< h1 > < a class = "toc-backref" href = "#id 3 "> 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 using this library. The library is a work in progress, so things
tools using this library. The library is a work in progress, so things
might change as more tools are written for it.< / p >
might change as more tools are written for it.< / p >
@ -323,61 +323,70 @@ 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 1 "> Introduction< / a > < / li >
< li > < a class = "reference internal" href = "#introduction" id = "id 3 "> Introduction< / a > < / li >
< li > < a class = "reference internal" href = "#getting-dfhack" id = "id 2 "> Getting DFHack< / a > < / li >
< li > < a class = "reference internal" href = "#getting-dfhack" id = "id 4 "> Getting DFHack< / a > < / li >
< li > < a class = "reference internal" href = "#compatibility" id = "id 3 "> Compatibility< / a > < ul >
< li > < a class = "reference internal" href = "#compatibility" id = "id 5 "> Compatibility< / a > < ul >
< li > < a class = "reference internal" href = "#windows" id = "id 4 "> Windows< / a > < / li >
< li > < a class = "reference internal" href = "#windows" id = "id 6 "> Windows< / a > < / li >
< li > < a class = "reference internal" href = "#linux" id = "id 5 "> Linux< / a > < ul >
< li > < a class = "reference internal" href = "#linux" id = "id 7 "> Linux< / a > < ul >
< li > < a class = "reference internal" href = "#native-linux-df" id = "id 6 "> Native linux DF< / a > < / li >
< li > < a class = "reference internal" href = "#native-linux-df" id = "id 8 "> Native linux DF< / a > < / li >
< li > < a class = "reference internal" href = "#windows-df-under-wine" id = "id 7 "> Windows DF under wine< / a > < / li >
< li > < a class = "reference internal" href = "#windows-df-under-wine" id = "id 9 "> Windows DF under wine< / a > < / li >
< / ul >
< / ul >
< / li >
< / li >
< / ul >
< / ul >
< / li >
< / li >
< li > < a class = "reference internal" href = "#tools" id = "id8" > Tools< / a > < ul >
< li > < a class = "reference internal" href = "#tools" id = "id10" > Tools< / a > < ul >
< li > < a class = "reference internal" href = "#dfattachtest" id = "id9" > dfattachtest< / a > < / li >
< li > < a class = "reference internal" href = "#dfattachtest" id = "id11" > dfattachtest< / a > < / li >
< li > < a class = "reference internal" href = "#dfautodump" id = "id10" > dfautodump< / a > < / li >
< li > < a class = "reference internal" href = "#dfautodump" id = "id12" > dfautodump< / a > < ul >
< li > < a class = "reference internal" href = "#dfcleanmap" id = "id11" > dfcleanmap< / a > < / li >
< li > < a class = "reference internal" href = "#options" id = "id13" > Options:< / a > < / li >
< li > < a class = "reference internal" href = "#dfcleanowned" id = "id12" > dfcleanowned< / a > < / li >
< / ul >
< li > < a class = "reference internal" href = "#dfcleartask" id = "id13" > dfcleartask< / a > < / li >
< / li >
< li > < a class = "reference internal" href = "#dfderamp-by-zilpin" id = "id14" > dfderamp (by zilpin)< / a > < / li >
< li > < a class = "reference internal" href = "#dfcleanmap" id = "id14" > dfcleanmap< / a > < / li >
< li > < a class = "reference internal" href = "#dfdoffsets" id = "id15" > dfdoffsets< / a > < / li >
< li > < a class = "reference internal" href = "#dfcleanowned" id = "id15" > dfcleanowned< / a > < ul >
< li > < a class = "reference internal" href = "#dfexpbench" id = "id16" > dfexpbench< / a > < / li >
< li > < a class = "reference internal" href = "#id1" id = "id16" > Options:< / a > < / li >
< li > < a class = "reference internal" href = "#dfflows" id = "id17" > dfflows< / a > < / li >
< / ul >
< li > < a class = "reference internal" href = "#dfincremental" id = "id18" > dfincremental< / a > < / li >
< / li >
< li > < a class = "reference internal" href = "#dflair" id = "id19" > dflair< / a > < / li >
< li > < a class = "reference internal" href = "#dfcleartask" id = "id17" > dfcleartask< / a > < / li >
< li > < a class = "reference internal" href = "#dfliquids" id = "id20" > dfliquids< / a > < / li >
< li > < a class = "reference internal" href = "#dfderamp-by-zilpin" id = "id18" > dfderamp (by zilpin)< / a > < / li >
< li > < a class = "reference internal" href = "#dfmode" id = "id21" > dfmode< / a > < / li >
< li > < a class = "reference internal" href = "#dfdoffsets" id = "id19" > dfdoffsets< / a > < / li >
< li > < a class = "reference internal" href = "#dfpause" id = "id22" > dfpause< / a > < / li >
< li > < a class = "reference internal" href = "#dfexpbench" id = "id20" > dfexpbench< / a > < / li >
< li > < a class = "reference internal" href = "#dfposition" id = "id23" > dfposition< / a > < / li >
< li > < a class = "reference internal" href = "#dfflows" id = "id21" > dfflows< / a > < / li >
< li > < a class = "reference internal" href = "#dfprobe" id = "id24" > dfprobe< / a > < / li >
< li > < a class = "reference internal" href = "#dfincremental" id = "id22" > dfincremental< / a > < / li >
< li > < a class = "reference internal" href = "#dfprospector" id = "id25" > dfprospector< / a > < / li >
< li > < a class = "reference internal" href = "#dflair" id = "id23" > dflair< / a > < / li >
< li > < a class = "reference internal" href = "#dfreveal" id = "id26" > dfreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfliquids" id = "id24" > dfliquids< / a > < / li >
< li > < a class = "reference internal" href = "#dfunreveal" id = "id27" > dfunreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfmode" id = "id25" > dfmode< / a > < / li >
< li > < a class = "reference internal" href = "#dfsuspend" id = "id28" > dfsuspend< / a > < / li >
< li > < a class = "reference internal" href = "#dfpause" id = "id26" > dfpause< / a > < / li >
< li > < a class = "reference internal" href = "#dftubefill" id = "id29" > dftubefill< / a > < / li >
< li > < a class = "reference internal" href = "#dfposition" id = "id27" > dfposition< / a > < / li >
< li > < a class = "reference internal" href = "#dfunstuck" id = "id30" > dfunstuck< / a > < / li >
< li > < a class = "reference internal" href = "#dfprobe" id = "id28" > dfprobe< / a > < / li >
< li > < a class = "reference internal" href = "#dfvdig" id = "id31" > dfvdig< / a > < / li >
< li > < a class = "reference internal" href = "#dfprospector" id = "id29" > dfprospector< / a > < ul >
< li > < a class = "reference internal" href = "#dfveinlook" id = "id32" > dfveinlook< / a > < / li >
< li > < a class = "reference internal" href = "#id2" id = "id30" > Options:< / a > < / li >
< li > < a class = "reference internal" href = "#dfweather" id = "id33" > dfweather< / a > < / li >
< / ul >
< li > < a class = "reference internal" href = "#your-tool-here" id = "id34" > Your tool here< / a > < / li >
< / li >
< li > < a class = "reference internal" href = "#dfreveal" id = "id31" > dfreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfunreveal" id = "id32" > dfunreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfsuspend" id = "id33" > dfsuspend< / a > < / li >
< li > < a class = "reference internal" href = "#dftubefill" id = "id34" > dftubefill< / a > < / li >
< li > < a class = "reference internal" href = "#dfunstuck" id = "id35" > dfunstuck< / a > < / li >
< li > < a class = "reference internal" href = "#dfvdig" id = "id36" > dfvdig< / a > < / li >
< li > < a class = "reference internal" href = "#dfveinlook" id = "id37" > dfveinlook< / a > < / li >
< li > < a class = "reference internal" href = "#dfweather" id = "id38" > dfweather< / a > < / li >
< li > < a class = "reference internal" href = "#your-tool-here" id = "id39" > Your tool here< / a > < / li >
< / ul >
< / ul >
< / li >
< / li >
< / ul >
< / ul >
< / div >
< / div >
< / div >
< / div >
< div class = "section" id = "getting-dfhack" >
< div class = "section" id = "getting-dfhack" >
< h1 > < a class = "toc-backref" href = "#id2" > Getting DFHack< / a > < / h1 >
< h1 > < a class = "toc-backref" href = "#id 4 "> 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 >
< / div >
< / div >
< div class = "section" id = "compatibility" >
< div class = "section" id = "compatibility" >
< h1 > < a class = "toc-backref" href = "#id 3 "> Compatibility< / a > < / h1 >
< h1 > < a class = "toc-backref" href = "#id 5 "> Compatibility< / a > < / h1 >
< p > DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.< / p >
< p > DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.< / p >
< p > OSX is not supported due to lack of developers with a Mac.< / p >
< p > OSX is not supported due to lack of developers with a Mac.< / p >
< p > Currently supported Dwarf Fortress versions are Windows and Linux.< / p >
< p > Currently supported Dwarf Fortress versions are Windows and Linux.< / p >
< div class = "section" id = "windows" >
< div class = "section" id = "windows" >
< h2 > < a class = "toc-backref" href = "#id 4 "> Windows< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 6 "> Windows< / a > < / h2 >
< div class = "note" >
< div class = "note" >
< p class = "first admonition-title" > Note< / p >
< p class = "first admonition-title" > Note< / p >
< p class = "last" > Windows 2000 is currently < em > not supported< / em > due to missing OS
< p class = "last" > Windows 2000 is currently < em > not supported< / em > due to missing OS
@ -388,76 +397,77 @@ fix it :)</p>
< p > 0.31.04 - 0.31.25 SDL< / p >
< p > 0.31.04 - 0.31.25 SDL< / p >
< / div >
< / div >
< div class = "section" id = "linux" >
< div class = "section" id = "linux" >
< h2 > < a class = "toc-backref" href = "#id 5 "> Linux< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 7 "> Linux< / a > < / h2 >
< div class = "section" id = "native-linux-df" >
< div class = "section" id = "native-linux-df" >
< h3 > < a class = "toc-backref" href = "#id 6 "> Native linux DF< / a > < / h3 >
< h3 > < a class = "toc-backref" href = "#id 8 "> Native linux DF< / a > < / h3 >
< p > 0.31.05 - 0.31.19 : spotty support (some things might not work)< / p >
< p > 0.31.05 - 0.31.24 : spotty support (some things might not work)< / p >
< p > 0.31.22 - 0.31.2 5: full support< / p >
< p > 0.31.25: full support< / p >
< / div >
< / div >
< div class = "section" id = "windows-df-under-wine" >
< div class = "section" id = "windows-df-under-wine" >
< h3 > < a class = "toc-backref" href = "#id 7 "> Windows DF under wine< / a > < / h3 >
< h3 > < a class = "toc-backref" href = "#id 9 "> Windows DF under wine< / a > < / h3 >
< p > 0.31.01 - 0.31.03 legacy< / p >
< p > 0.31.01 - 0.31.03 legacy< / p >
< p > 0.31.04 - 0.31.25 SDL< / p >
< p > 0.31.04 - 0.31.25 SDL< / p >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "section" id = "tools" >
< div class = "section" id = "tools" >
< h1 > < a class = "toc-backref" href = "#id 8 "> Tools< / a > < / h1 >
< h1 > < a class = "toc-backref" href = "#id 10 "> Tools< / a > < / h1 >
< p > All the DFHack tools are terminal programs. This might seem strange to Windows
< p > All the DFHack tools are terminal programs. This might seem strange to Windows
users, but these are meant mostly as examples for developers. Still, they can
users, but these are meant mostly as examples for developers. Still, they can
be useful and are cross-platform just like the library itself.< / p >
be useful and are cross-platform just like the library itself.< / p >
< div class = "section" id = "dfattachtest" >
< div class = "section" id = "dfattachtest" >
< h2 > < a class = "toc-backref" href = "#id 9 "> dfattachtest< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 11 "> dfattachtest< / a > < / h2 >
< p > Test of the process attach/detach mechanism.< / p >
< p > Test of the process attach/detach mechanism.< / p >
< / div >
< / div >
< div class = "section" id = "dfautodump" >
< div class = "section" id = "dfautodump" >
< h2 > < a class = "toc-backref" href = "#id1 0 "> dfautodump< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 2 "> dfautodump< / 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 >
< p > Options:< / p >
< div class = "section" id = "options" >
< blockquote >
< h3 > < a class = "toc-backref" href = "#id13" > Options:< / a > < / h3 >
< ul class = "simple" >
< table class = "docutils option-list" frame = "void" rules = "none" >
< li > -d Destroy instead of dumping. Doesn't require a cursor.< / li >
< col class = "option" / >
< / ul >
< col class = "description" / >
< / blockquote >
< tbody valign = "top" >
< tr > < td class = "option-group" >
< kbd > < span class = "option" > -d< / span > < / kbd > < / td >
< td > Destroy instead of dumping. Doesn't require a cursor.< / td > < / tr >
< / tbody >
< / table >
< / div >
< / div >
< / div >
< div class = "section" id = "dfcleanmap" >
< div class = "section" id = "dfcleanmap" >
< h2 > < a class = "toc-backref" href = "#id11" > dfcleanmap< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 4 "> dfcleanmap< / 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.
Only exception is mud. It leaves mud alone.< / p >
Only exception is mud. It leaves mud alone.< / p >
< / div >
< / div >
< div class = "section" id = "dfcleanowned" >
< div class = "section" id = "dfcleanowned" >
< h2 > < a class = "toc-backref" href = "#id1 2 "> dfcleanowned< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 5 "> dfcleanowned< / a > < / h2 >
< p > Removes the ownership flag from items.
< p > Removes the ownership flag from items.
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 >
< table border = "1" class = "docutils" >
< div class = "section" id = "id1" >
< colgroup >
< h3 > < a class = "toc-backref" href = "#id16" > Options:< / a > < / h3 >
< col width = "6%" / >
< table class = "docutils option-list" frame = "void" rules = "none" >
< col width = "94%" / >
< col class = "option" / >
< / colgroup >
< col class = "description" / >
< thead valign = "bottom" >
< tr > < th class = "head" > Option< / th >
< th class = "head" > Effect< / th >
< / tr >
< / thead >
< tbody valign = "top" >
< tbody valign = "top" >
< tr > < td > -a< / td >
< tr > < td class = "option-group" >
< td> confiscate all owned items < / td >
< kbd > < span class = "option" > -a< / span > < / kbd > < / td >
< / tr >
< td > confiscate all owned items< / td > < / tr >
< tr > < td > -l< / td >
< tr > < td class = "option-group" >
< td> confiscated and dump all items scattered on the floor < / td >
< kbd> < span class = "option" > -l< / span > < / kbd > < / td >
< / tr >
< td > confiscated and dump all items scattered on the floor< / td > < / tr >
< tr > < td > -x< / td >
< tr > < td class = "option-group" >
< td> confiscate/dump items with wear level 'x' and more < / td >
< kbd> < span class = "option" > -x< / span > < / kbd > < / td >
< / tr >
< td > confiscate/dump items with wear level 'x' and more< / td > < / tr >
< tr > < td > -X< / td >
< tr > < td class = "option-group" >
< td> confiscate/dump items with wear level 'X' and more < / td >
< kbd> < span class = "option" > -X< / span > < / kbd > < / td >
< / tr >
< td > confiscate/dump items with wear level 'X' and more< / td > < / tr >
< tr > < td > -d< / td >
< tr > < td class = "option-group" >
< td> a dry run. combine with other options to see what will happen without it actually happening. < / td >
< kbd> < span class = "option" > -d< / span > < / kbd > < / td >
< / tr >
< td > a dry run. combine with other options to see what will happen without it actually happening.< / td > < / tr >
< / tbody >
< / tbody >
< / table >
< / table >
< dl class = "docutils" >
< dl class = "docutils" >
@ -469,38 +479,39 @@ By default, owned food on the floor and rotten items are confistacted and dumped
< / dd >
< / dd >
< / dl >
< / dl >
< / div >
< / div >
< / div >
< div class = "section" id = "dfcleartask" >
< div class = "section" id = "dfcleartask" >
< h2 > < a class = "toc-backref" href = "#id1 3 "> dfcleartask< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 7 "> dfcleartask< / a > < / h2 >
< p > Items marked for a job can get stuck during a abandon/reclaim. This tool aims to fix that.
< p > Items marked for a job can get stuck during a abandon/reclaim. This tool aims to fix that.
Best used immediately after a reclaim. Not thoroughly tested, use at your own risk.< / p >
Best used immediately after a reclaim. Not thoroughly tested, use at your own risk.< / p >
< / div >
< / div >
< div class = "section" id = "dfderamp-by-zilpin" >
< div class = "section" id = "dfderamp-by-zilpin" >
< h2 > < a class = "toc-backref" href = "#id1 4 "> dfderamp (by zilpin)< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 8 "> dfderamp (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 = "dfdoffsets" >
< div class = "section" id = "dfdoffsets" >
< h2 > < a class = "toc-backref" href = "#id1 5 "> dfdoffsets< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id1 9 "> dfdoffsets< / a > < / h2 >
< p > Dumps the offsets for the currently running DF version into the terminal.< / p >
< p > Dumps the offsets for the currently running DF version into the terminal.< / p >
< / div >
< / div >
< div class = "section" id = "dfexpbench" >
< div class = "section" id = "dfexpbench" >
< h2 > < a class = "toc-backref" href = "#id 16 "> dfexpbench< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 20 "> dfexpbench< / a > < / h2 >
< p > Just a simple benchmark of the data export speed.< / p >
< p > Just a simple benchmark of the data export speed.< / p >
< / div >
< / div >
< div class = "section" id = "dfflows" >
< div class = "section" id = "dfflows" >
< h2 > < a class = "toc-backref" href = "#id 17 "> dfflows< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 2 1"> dfflows< / a > < / h2 >
< p > A tool for checking how many liquid tiles are actively checked for flows.< / p >
< p > A tool for checking how many liquid tiles are actively checked for flows.< / p >
< / div >
< / div >
< div class = "section" id = "dfincremental" >
< div class = "section" id = "dfincremental" >
< h2 > < a class = "toc-backref" href = "#id 18 "> dfincremental< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 22 "> dfincremental< / a > < / h2 >
< p > A simple memory search tool for DF. Requires arcane knowledge ;)< / p >
< p > A simple memory search tool for DF. Requires arcane knowledge ;)< / p >
< / div >
< / div >
< div class = "section" id = "dflair" >
< div class = "section" id = "dflair" >
< h2 > < a class = "toc-backref" href = "#id 19 "> dflair< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 23 "> dflair< / a > < / h2 >
< p > Marks all of the map as a lair, preventing item scatter on abandon/reclaim.< / p >
< p > Marks all of the map as a lair, preventing item scatter on abandon/reclaim.< / p >
< / div >
< / div >
< div class = "section" id = "dfliquids" >
< div class = "section" id = "dfliquids" >
< h2 > < a class = "toc-backref" href = "#id2 0 "> dfliquids< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id2 4 "> dfliquids< / a > < / h2 >
< p > A command prompt for liquid creation and manipulation (the Moses
< p > A command prompt for liquid creation and manipulation (the Moses
effect included!) Also allows painting obsidian walls directly.< / p >
effect included!) Also allows painting obsidian walls directly.< / p >
< div class = "note" >
< div class = "note" >
@ -510,7 +521,7 @@ temperatures (creating heat traps). You've been warned.</p>
< / div >
< / div >
< / div >
< / div >
< div class = "section" id = "dfmode" >
< div class = "section" id = "dfmode" >
< h2 > < a class = "toc-backref" href = "#id2 1 "> dfmode< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id2 5 "> dfmode< / a > < / h2 >
< p > This tool lets you change the game mode directly. Not all combinations are good for every situation and most of them will produce undesirable results.
< p > This tool lets you 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" >
@ -522,63 +533,73 @@ 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 = "dfpause" >
< div class = "section" id = "dfpause" >
< h2 > < a class = "toc-backref" href = "#id2 2 "> dfpause< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id2 6 "> dfpause< / 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 = "dfposition" >
< div class = "section" id = "dfposition" >
< h2 > < a class = "toc-backref" href = "#id2 3 "> dfposition< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id2 7 "> dfposition< / a > < / h2 >
< p > Prints the game mode, current DF window properties and cursor position in both local and world coordinates.< / p >
< p > Prints the game mode, current DF window properties and cursor position in both local and world coordinates.< / p >
< / div >
< / div >
< div class = "section" id = "dfprobe" >
< div class = "section" id = "dfprobe" >
< h2 > < a class = "toc-backref" href = "#id2 4 "> dfprobe< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id2 8 "> dfprobe< / 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 = "dfprospector" >
< div class = "section" id = "dfprospector" >
< h2 > < a class = "toc-backref" href = "#id25" > dfprospector< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id29" > dfprospector< / a > < / h2 >
< p > Lists all available minerals on the map and how much of them there is.
< p > Lists all available minerals on the map and how much of them there is.< / p >
It has one parameter:
< div class = "section" id = "id2" >
* -a processes all tiles, even hidden ones.< / p >
< h3 > < a class = "toc-backref" href = "#id30" > Options:< / a > < / h3 >
< table class = "docutils option-list" frame = "void" rules = "none" >
< col class = "option" / >
< col class = "description" / >
< tbody valign = "top" >
< tr > < td class = "option-group" >
< kbd > < span class = "option" > -a< / span > < / kbd > < / td >
< td > processes all tiles, even hidden ones.< / td > < / tr >
< / tbody >
< / table >
< p > On windows, it's possible to run dfprsopector-all.bat to process all the tiles without messing with terminal windows.< / p >
< p > On windows, it's possible to run dfprsopector-all.bat to process all the tiles without messing with terminal windows.< / p >
< / div >
< / div >
< / div >
< div class = "section" id = "dfreveal" >
< div class = "section" id = "dfreveal" >
< h2 > < a class = "toc-backref" href = "#id26" > dfreveal< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 31 "> dfreveal< / a > < / h2 >
< p > Reveals the whole map, waits for input and hides it again. If you close
< p > Reveals the whole map, waits for input and hides it again. If you close
the tool while it waits, the map remains revealed.< / p >
the tool while it waits, the map remains revealed.< / p >
< / div >
< / div >
< div class = "section" id = "dfunreveal" >
< div class = "section" id = "dfunreveal" >
< h2 > < a class = "toc-backref" href = "#id27" > dfunreveal< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 3 2"> dfunreveal< / a > < / h2 >
< p > Hides everything and then only reveals the part of the map accessible from the position of DF's cursor. Place the cursor in open space that you want to keep revealed - this should include the surface world.
< p > Hides everything and then only reveals the part of the map accessible from the position of DF's cursor. Place the cursor in open space that you want to keep revealed - this should include the surface world.
Can be used to fix maps stuck revealed or hide parts of the fortress blocked off by walls.< / p >
Can be used to fix maps stuck revealed or hide parts of the fortress blocked off by walls.< / p >
< / div >
< / div >
< div class = "section" id = "dfsuspend" >
< div class = "section" id = "dfsuspend" >
< h2 > < a class = "toc-backref" href = "#id 28 "> dfsuspend< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 33 "> dfsuspend< / a > < / h2 >
< p > Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.< / p >
< p > Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.< / p >
< / div >
< / div >
< div class = "section" id = "dftubefill" >
< div class = "section" id = "dftubefill" >
< h2 > < a class = "toc-backref" href = "#id 29 "> dftubefill< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id 34 "> dftubefill< / a > < / h2 >
< p > Fills all the 'candy stores' with 'delicious candy'. No need to fear the clowns. Don't use if you haven't seen the hidden fun stuff
< p > Fills all the 'candy stores' with 'delicious candy'. No need to fear the clowns. Don't use if you haven't seen the hidden fun stuff
yet ;)< / p >
yet ;)< / p >
< / div >
< / div >
< div class = "section" id = "dfunstuck" >
< div class = "section" id = "dfunstuck" >
< h2 > < a class = "toc-backref" href = "#id3 0 "> dfunstuck< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id3 5 "> dfunstuck< / a > < / h2 >
< p > Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.< / p >
< p > Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.< / p >
< / div >
< / div >
< div class = "section" id = "dfvdig" >
< div class = "section" id = "dfvdig" >
< h2 > < a class = "toc-backref" href = "#id3 1 "> dfvdig< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id3 6 "> dfvdig< / a > < / h2 >
< p > Designates a whole vein for digging. Point the cursor at a vein and run this thing :)
< p > Designates a whole vein for digging. Point the cursor at a vein and run this thing :)
Running 'dfXvdig' on Windows or using the '-x' parameter will dig stairs between z-levels to follow the veins.< / p >
Running 'dfXvdig' on Windows or using the '-x' parameter will dig stairs between z-levels to follow the veins.< / p >
< / div >
< / div >
< div class = "section" id = "dfveinlook" >
< div class = "section" id = "dfveinlook" >
< h2 > < a class = "toc-backref" href = "#id3 2 "> dfveinlook< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id3 7 "> dfveinlook< / a > < / h2 >
< p > Simplistic map viewer for linux. Mostly a debug/development thing.< / p >
< p > Simplistic map viewer for linux. Mostly a debug/development thing.< / p >
< / div >
< / div >
< div class = "section" id = "dfweather" >
< div class = "section" id = "dfweather" >
< h2 > < a class = "toc-backref" href = "#id3 3 "> dfweather< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id3 8 "> dfweather< / a > < / h2 >
< p > Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Fill those ponds without mucking around with dfliquids
< p > Lets you change the current weather to 'clear sky', 'rainy' or 'snowing'. Fill those ponds without mucking around with dfliquids
:D Rain can also stop brush fires.< / p >
:D Rain can also stop brush fires.< / p >
< / div >
< / div >
< div class = "section" id = "your-tool-here" >
< div class = "section" id = "your-tool-here" >
< h2 > < a class = "toc-backref" href = "#id3 4 "> Your tool here< / a > < / h2 >
< h2 > < a class = "toc-backref" href = "#id3 9 "> Your tool here< / a > < / h2 >
< p > Write one ;)< / p >
< p > Write one ;)< / p >
< / div >
< / div >
< / div >
< / div >