@ -336,28 +336,31 @@ allow for easier development of new tools.</p>
< / li > < / li >
< li > < a class = "reference internal" href = "#tools" id = "id8" > Tools< / a > < ul > < li > < a class = "reference internal" href = "#tools" id = "id8" > Tools< / a > < ul >
< li > < a class = "reference internal" href = "#dfattachtest" id = "id9" > dfattachtest< / a > < / li > < li > < a class = "reference internal" href = "#dfattachtest" id = "id9" > dfattachtest< / a > < / li >
< li > < a class = "reference internal" href = "#dfcleanmap" id = "id10" > dfcleanmap< / a > < / li > < li > < a class = "reference internal" href = "#dfautodump" id = "id10" > dfautodump< / a > < / li >
< li > < a class = "reference internal" href = "#dfderamp-by-zilpin" id = "id11" > dfderamp (by zilpin)< / a > < / li > < li > < a class = "reference internal" href = "#dfcleanmap" id = "id11" > dfcleanmap< / a > < / li >
< li > < a class = "reference internal" href = "#dfdoffsets" id = "id12" > dfdoffsets< / a > < / li > < li > < a class = "reference internal" href = "#dfcleanowned" id = "id12" > dfcleanowned< / a > < / li >
< li > < a class = "reference internal" href = "#dfexpbench" id = "id13" > dfexpbench< / a > < / li > < li > < a class = "reference internal" href = "#dfcleartask" id = "id13" > dfcleartask< / a > < / li >
< li > < a class = "reference internal" href = "#dfflows" id = "id14" > dfflows< / a > < / li > < li > < a class = "reference internal" href = "#dfderamp-by-zilpin" id = "id14" > dfderamp (by zilpin)< / a > < / li >
< li > < a class = "reference internal" href = "#dfincremental" id = "id15" > dfincremental< / a > < / li > < li > < a class = "reference internal" href = "#dfdoffsets" id = "id15" > dfdoffsets< / a > < / li >
< li > < a class = "reference internal" href = "#dflair" id = "id16" > dflair< / a > < / li > < li > < a class = "reference internal" href = "#dfexpbench" id = "id16" > dfexpbench< / a > < / li >
< li > < a class = "reference internal" href = "#dfliquids" id = "id17" > dfliquids< / a > < / li > < li > < a class = "reference internal" href = "#dfflows" id = "id17" > dfflows< / a > < / li >
< li > < a class = "reference internal" href = "#dfmode" id = "id18" > dfmode< / a > < / li > < li > < a class = "reference internal" href = "#dfincremental" id = "id18" > dfincremental< / a > < / li >
< li > < a class = "reference internal" href = "#dfpause" id = "id19" > dfpause< / a > < / li > < li > < a class = "reference internal" href = "#dflair" id = "id19" > dflair< / a > < / li >
< li > < a class = "reference internal" href = "#dfposition" id = "id20" > dfposition< / a > < / li > < li > < a class = "reference internal" href = "#dfliquids" id = "id20" > dfliquids< / a > < / li >
< li > < a class = "reference internal" href = "#dfprobe" id = "id21" > dfprobe< / a > < / li > < li > < a class = "reference internal" href = "#dfmode" id = "id21" > dfmode< / a > < / li >
< li > < a class = "reference internal" href = "#dfprospector" id = "id22" > dfprospector< / a > < / li > < li > < a class = "reference internal" href = "#dfpause" id = "id22" > dfpause< / a > < / li >
< li > < a class = "reference internal" href = "#dfreveal" id = "id23" > dfreveal< / a > < / li > < li > < a class = "reference internal" href = "#dfposition" id = "id23" > dfposition< / a > < / li >
< li > < a class = "reference internal" href = "#dfunreveal" id = "id24" > dfunreveal< / a > < / li > < li > < a class = "reference internal" href = "#dfprobe" id = "id24" > dfprobe< / a > < / li >
< li > < a class = "reference internal" href = "#dfsuspend" id = "id25" > dfsuspend< / a > < / li > < li > < a class = "reference internal" href = "#dfprospector" id = "id25" > dfprospector< / a > < / li >
< li > < a class = "reference internal" href = "#dftubefill" id = "id26" > dftubefill< / a > < / li > < li > < a class = "reference internal" href = "#dfreveal" id = "id26" > dfreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfunstuck" id = "id27" > dfunstuck< / a > < / li > < li > < a class = "reference internal" href = "#dfunreveal" id = "id27" > dfunreveal< / a > < / li >
< li > < a class = "reference internal" href = "#dfvdig" id = "id28" > dfvdig< / a > < / li > < li > < a class = "reference internal" href = "#dfsuspend" id = "id28" > dfsuspend< / a > < / li >
< li > < a class = "reference internal" href = "#dfveinlook" id = "id29" > dfveinlook< / a > < / li > < li > < a class = "reference internal" href = "#dftubefill" id = "id29" > dftubefill< / a > < / li >
< li > < a class = "reference internal" href = "#dfweather" id = "id30" > dfweather< / a > < / li > < li > < a class = "reference internal" href = "#dfunstuck" id = "id30" > dfunstuck< / a > < / li >
< li > < a class = "reference internal" href = "#your-tool-here" id = "id31" > Your tool here< / a > < / li > < li > < a class = "reference internal" href = "#dfvdig" id = "id31" > dfvdig< / a > < / li >
< li > < a class = "reference internal" href = "#dfveinlook" id = "id32" > dfveinlook< / a > < / li >
< li > < a class = "reference internal" href = "#dfweather" id = "id33" > dfweather< / a > < / li >
< li > < a class = "reference internal" href = "#your-tool-here" id = "id34" > Your tool here< / a > < / li >
< / ul > < / ul >
< / li > < / li >
< / ul > < / ul >
@ -407,38 +410,97 @@ be useful and are cross-platform just like the library itself.</p>
< h2 > < a class = "toc-backref" href = "#id9" > dfattachtest< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id9" > 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" >
< h2 > < a class = "toc-backref" href = "#id10" > dfautodump< / a > < / h2 >
< 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 >
< 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 >
< p > Options:< / p >
< blockquote >
< ul class = "simple" >
< li > -d Destroy instead of dumping. Doesn't require a cursor.< / li >
< / ul >
< / blockquote >
< / div >
< div class = "section" id = "dfcleanmap" > < div class = "section" id = "dfcleanmap" >
< h2 > < a class = "toc-backref" href = "#id10" > dfcleanmap< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 1 "> 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" >
< h2 > < a class = "toc-backref" href = "#id12" > dfcleanowned< / a > < / h2 >
< p > Removes the ownership flag from items.
By default, owned food on the floor and rotten items are confistacted and dumped.< / p >
< table border = "1" class = "docutils" >
< colgroup >
< col width = "6%" / >
< col width = "94%" / >
< / colgroup >
< thead valign = "bottom" >
< tr > < th class = "head" > Option< / th >
< th class = "head" > Effect< / th >
< / tr >
< / thead >
< tbody valign = "top" >
< tr > < td > -a< / td >
< td > confiscate all owned items< / td >
< / tr >
< tr > < td > -l< / td >
< td > confiscated and dump all items scattered on the floor< / td >
< / tr >
< tr > < td > -x< / td >
< td > confiscate/dump items with wear level 'x' and more< / td >
< / tr >
< tr > < td > -X< / td >
< td > confiscate/dump items with wear level 'X' and more< / td >
< / tr >
< tr > < td > -d< / td >
< td > a dry run. combine with other options to see what will happen without it actually happening.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "docutils" >
< dt > On Windows:< / dt >
< dd > < ul class = "first last simple" >
< li > dfremovelitter.bat runs the tool with -lx< / li >
< li > dfconfiscate.bat runs the tool with -a< / li >
< / ul >
< / dd >
< / dl >
< / div >
< div class = "section" id = "dfcleartask" >
< h2 > < a class = "toc-backref" href = "#id13" > dfcleartask< / a > < / h2 >
< 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 >
< / div >
< div class = "section" id = "dfderamp-by-zilpin" > < div class = "section" id = "dfderamp-by-zilpin" >
< h2 > < a class = "toc-backref" href = "#id11" > dfderamp (by zilpin)< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 4 "> 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 = "#id12" > dfdoffsets< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 5 "> 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 = "#id13" > dfexpbench< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 6 "> 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 = "#id14" > dfflows< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 7 "> 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 = "#id15" > dfincremental< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 8 "> 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 = "#id16" > dflair< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id1 9 "> 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 = "#id17" > dfliquids< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 20 "> 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" >
@ -448,7 +510,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 = "#id 18 "> dfmode< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 2 1"> 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" >
@ -460,63 +522,63 @@ 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 = "#id 19 "> dfpause< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 22 "> 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 0 "> dfposition< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 3 "> 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 1 "> dfprobe< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 4 "> 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 = "#id2 2 "> dfprospector< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 5 "> 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.
It has one parameter:
It has one parameter:
* -a processes all tiles, even hidden ones.< / p >
* -a processes all tiles, even hidden ones.< / p >
< 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 class = "section" id = "dfreveal" > < div class = "section" id = "dfreveal" >
< h2 > < a class = "toc-backref" href = "#id2 3 "> dfreveal< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 6 "> 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 = "#id2 4 "> dfunreveal< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 7 "> 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 = "#id2 5 "> dfsuspend< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 8 "> 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 = "#id2 6 "> dftubefill< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id2 9 "> 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 = "#id 27 "> dfunstuck< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 30 "> 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 = "#id 28 "> dfvdig< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 31 "> 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 = "#id 29 "> dfveinlook< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id 3 2"> 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 0 "> dfweather< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 3 "> 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 1 "> Your tool here< / a > < / h2 > < h2 > < a class = "toc-backref" href = "#id3 4 "> Your tool here< / a > < / h2 >
< p > Write one ;)< / p > < p > Write one ;)< / p >
< / div > < / div >
< / div > < / div >
Petr Mrázek