diff --git a/README.rst b/README.rst index cc4686bde..64c86da0d 100644 --- a/README.rst +++ b/README.rst @@ -134,6 +134,19 @@ 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. +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. + +.. admonition:: Example + + You are in fort game mode (0 game mode), managing your fortress (0 control mode) and paused. + You switch to the arena game mode, *assume control of a creature* and the switch to adventure game mode(1). + 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 + Your tool here ============== Write one ;) diff --git a/Readme.html b/Readme.html index 40689908c..a90aa873d 100644 --- a/Readme.html +++ b/Readme.html @@ -349,26 +349,27 @@ allow for easier development of new tools.
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.
+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.
+Example
+You are in fort game mode (0 game mode), managing your fortress (0 control mode) and paused. +You switch to the arena game mode, assume control of a creature and the switch to adventure game mode(1). +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
+The library is compilable under Linux with GCC and under Windows with MinGW32 and MSVC compilers. It is using the cmake build system. See COMPILE for details.
@@ -502,17 +515,17 @@ the dfhack repository is welcome and the right thing to do :) code does have a lot of comments though (and getting better all the time).Several things should be kept in mind when contributing to DFHack.
DFhack uses ANSI formatting and four spaces as indentation. Line endings are UNIX. The files use UTF-8 encoding. Code not following this won't make me happy, because I'll have to fix it. There's a good chance I'll make you fix it ;)
You can send patches or make a clone of the github repo and ask me on the IRC channel to pull your code in. I'll review it and see if there are any problems. I'll fix them if they are minor.
@@ -522,7 +535,7 @@ this is also a good place to dump new ideas and/or bugs that need fixing.Tools live in the tools/ folder. There, they are split into three categories.
DFHack uses modules to partition sets of features into manageable chunks. A module can have both client and server side.
Client side is the part that goes into the main library and is @@ -560,7 +573,7 @@ server, it allows accelerating the reading of map blocks.
pretty fast, but needs quite a bit of care to not break.The files with memory offset definitions used by dfhack can be found in the data folder.