diff --git a/CMakeLists.txt b/CMakeLists.txt index 398d8dfb8..173ea571d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -18,7 +18,7 @@ SET(DFHACK_CONSISTENCY 1) set(CPACK_PACKAGE_VERSION_MAJOR "0") set(CPACK_PACKAGE_VERSION_MINOR "5") set(CPACK_PACKAGE_VERSION_PATCH "15") -set(DFHACK_REVISION "dev1") +set(DFHACK_REVISION "1") set(DFHACK_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}") set(CPACK_PACKAGE_VERSION ${DFHACK_VERSION}) diff --git a/README.rst b/README.rst index 05d841353..b6dfdcd90 100644 --- a/README.rst +++ b/README.rst @@ -23,10 +23,11 @@ binaries at http://github.com/peterix/dfhack Compatibility ============= DFHack works on Windows XP, Vista, 7 or any modern Linux distribution. - OSX is not supported due to lack of developers with a Mac. -Currently supported Dwarf Fortress versions are Windows and Linux. +In general, the older DF release you use, the less features will work. +DFHack development is always focused on the latest DF version. Go too +far into the past, and only the most basic tools will work. Windows ======= @@ -125,6 +126,26 @@ dfincremental ============= A simple memory search tool for DF. Requires arcane knowledge ;) +dfgrow +====== +Makes all saplings present on the map grow into trees (almost) instantly. + +dfimmolate +========== +A tool for getting rid of trees and shrubs. By default, it only kills a tree/shrub under the cursor. + +Options: +-------- +-s affect all shrubs on the map +-t affect all trees on the map +-i instead of just instaburning plants to ashes, produce fire. WILL KILL FPS! + +The windows binary releases contain many .bat files that can run the tool with different parameters. + +dfstatus (by enjia2000) +======================= +Runs next to DF and shows some vital statistics of the fort, including food and booze. + dflair ====== Marks all of the map as a lair, preventing item scatter on abandon/reclaim. @@ -172,7 +193,8 @@ Options: -------- -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. +On windows, it's possible to run dfprospector-all.bat to process all the tiles without messing with terminal windows. +Also on Windos, dfprospector-text.bat will print the output into a file and then show it in a notepad program (whatever opens .txt by default). dfreveal ======== @@ -204,7 +226,7 @@ Running 'dfXvdig' on Windows or using the '-x' parameter will dig stairs between dfveinlook ========== -Simplistic map viewer for linux. Mostly a debug/development thing. +Simplistic map viewer. Mostly a debug/development thing. Now supported on Windows too! dfweather =========== diff --git a/Readme.html b/Readme.html index 8ac641fa2..f218df35f 100644 --- a/Readme.html +++ b/Readme.html @@ -314,7 +314,7 @@ ul.auto-toc {
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 might change as more tools are written for it.
@@ -323,70 +323,78 @@ allow for easier development of new tools.Contents
The project is currently hosted on github, for both source and binaries at http://github.com/peterix/dfhack
DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.
-OSX is not supported due to lack of developers with a Mac.
-Currently supported Dwarf Fortress versions are Windows and Linux.
+DFHack works on Windows XP, Vista, 7 or any modern Linux distribution. +OSX is not supported due to lack of developers with a Mac.
+In general, the older DF release you use, the less features will work. +DFHack development is always focused on the latest DF version. Go too +far into the past, and only the most basic tools will work.
Note
Windows 2000 is currently not supported due to missing OS @@ -397,36 +405,36 @@ fix it :)
0.31.04 - 0.31.25 SDL
0.31.05 - 0.31.24: spotty support (some things might not work)
0.31.25: full support
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 be useful and are cross-platform just like the library itself.
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.
+-s | +affect all shrubs on the map |
+-t | +affect all trees on the map |
+-i | +instead of just instaburning plants to ashes, produce fire. WILL KILL FPS! |
The windows binary releases contain many .bat files that can run the tool with different parameters.
+Runs next to DF and shows some vital statistics of the fort, including food and booze.
+A command prompt for liquid creation and manipulation (the Moses effect included!) Also allows painting obsidian walls directly.
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.
I take no responsibility of anything that happens as a result of using this tool :P
Forces DF to pause. This is useful when your FPS drops below 1 and you lose control of the game.
Prints the game mode, current DF window properties and cursor position in both local and world coordinates.
Lists all available minerals on the map and how much of them there is.
-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.
+On windows, it's possible to run dfprospector-all.bat to process all the tiles without messing with terminal windows. +Also on Windos, dfprospector-text.bat will print the output into a file and then show it in a notepad program (whatever opens .txt by default).
Reveals the whole map, waits for input and hides it again. If you close the tool while it waits, the map remains revealed.
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.
Test of the process suspend/resume mechanism. If this doesn't work as expected, it's not safe to use DFHack.
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 ;)
Use if you prematurely close any of the tools and DF appears to be stuck. Mostly only needed on Windows.
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.
Simplistic map viewer for linux. Mostly a debug/development thing.
+Simplistic map viewer. Mostly a debug/development thing. Now supported on Windows too!