From 7829e12e854c67be36aeb0ef61e78156e75c0b98 Mon Sep 17 00:00:00 2001 From: Petr Mrázek Date: Sun, 8 May 2011 10:45:37 +0200 Subject: Added a bunch of batch scripts for running tools, updated readme, bumped version number. --- Readme.html | 150 ++++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 106 insertions(+), 44 deletions(-) (limited to 'Readme.html') diff --git a/Readme.html b/Readme.html index 75083c2d..8b625c2e 100644 --- a/Readme.html +++ b/Readme.html @@ -336,28 +336,31 @@ allow for easier development of new tools.

  • Tools
  • @@ -407,38 +410,97 @@ be useful and are cross-platform just like the library itself.

    dfattachtest

    Test of the process attach/detach mechanism.

    +
    +

    dfautodump

    +

    Automated item dumping tool. All loose items on the floor marked +for dumping are insta-dumped to the position of the in-game cursor.

    +

    Cursor must be placed on a floor tile. Instadumped items may not +show up in the cursor description list until you save/reload.

    +

    Options:

    +
    + +
    +
    -

    dfcleanmap

    +

    dfcleanmap

    Cleans all the splatter that get scattered all over the map. Only exception is mud. It leaves mud alone.

    +
    +

    dfcleanowned

    +

    Removes the ownership flag from items. +By default, owned food on the floor and rotten items are confistacted and dumped.

    + ++++ + + + + + + + + + + + + + + + + + + + + + + +
    OptionEffect
    -aconfiscate all owned items
    -lconfiscated and dump all items scattered on the floor
    -xconfiscate/dump items with wear level 'x' and more
    -Xconfiscate/dump items with wear level 'X' and more
    -da dry run. combine with other options to see what will happen without it actually happening.
    +
    +
    On Windows:
    +
      +
    • dfremovelitter.bat runs the tool with -lx
    • +
    • dfconfiscate.bat runs the tool with -a
    • +
    +
    +
    +
    +
    +

    dfcleartask

    +

    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.

    +
    -

    dfderamp (by zilpin)

    +

    dfderamp (by zilpin)

    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).

    -

    dfdoffsets

    +

    dfdoffsets

    Dumps the offsets for the currently running DF version into the terminal.

    -

    dfexpbench

    +

    dfexpbench

    Just a simple benchmark of the data export speed.

    -

    dfflows

    +

    dfflows

    A tool for checking how many liquid tiles are actively checked for flows.

    -

    dfincremental

    +

    dfincremental

    A simple memory search tool for DF. Requires arcane knowledge ;)

    -

    dflair

    +

    dflair

    Marks all of the map as a lair, preventing item scatter on abandon/reclaim.

    -

    dfliquids

    +

    dfliquids

    A command prompt for liquid creation and manipulation (the Moses effect included!) Also allows painting obsidian walls directly.

    @@ -448,7 +510,7 @@ temperatures (creating heat traps). You've been warned.

    -

    dfmode

    +

    dfmode

    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.

    @@ -460,63 +522,63 @@ You just lost a fortress and gained an adventurer.

    I take no responsibility of anything that happens as a result of using this tool :P

    -

    dfpause

    +

    dfpause

    Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.

    -

    dfposition

    +

    dfposition

    Prints the game mode, current DF window properties and cursor position in both local and world coordinates.

    -

    dfprobe

    +

    dfprobe

    Can be used to determine tile properties like temperature.

    -

    dfprospector

    +

    dfprospector

    Lists all available minerals on the map and how much of them there is. It has one parameter: * -a processes all tiles, even hidden ones.

    On windows, it's possible to run dfprsopector-all.bat to process all the tiles without messing with terminal windows.

    -

    dfreveal

    +

    dfreveal

    Reveals the whole map, waits for input and hides it again. If you close the tool while it waits, the map remains revealed.

    -

    dfunreveal

    +

    dfunreveal

    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.

    -

    dfsuspend

    +

    dfsuspend

    Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.

    -

    dftubefill

    +

    dftubefill

    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 ;)

    -

    dfunstuck

    +

    dfunstuck

    Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.

    -

    dfvdig

    +

    dfvdig

    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.

    -

    dfveinlook

    +

    dfveinlook

    Simplistic map viewer for linux. Mostly a debug/development thing.

    -

    dfweather

    +

    dfweather

    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.

    -

    Your tool here

    +

    Your tool here

    Write one ;)

    -- cgit v1.2.1