diff --git a/COMPILE.rst b/COMPILE.rst index 82544b9d4..bb5bc1e3a 100644 --- a/COMPILE.rst +++ b/COMPILE.rst @@ -111,6 +111,17 @@ dfhack has a few build targets: * ``make`` will build everything. * ``make expbench`` will build the expbench testing program and the library. +* Some of the utilities and the doxygen documentation won't be + normally built. You can enable them by specifying some extra + CMake variables:: + + BUILD_DFHACK_DOCUMENTATION - generate the documentation (really bad) + BUILD_DFHACK_EXAMPLES - build tools from tools/examples + BUILD_DFHACK_PLAYGROUND - build tools from tools/playground + + Example:: + + cmake .. -DBUILD_DFHACK_EXAMPLES=ON Build types =========== diff --git a/Compile.html b/Compile.html index 1e4180548..06ab65b9d 100644 --- a/Compile.html +++ b/Compile.html @@ -425,11 +425,27 @@ compiler.
dfhack has a few build targets:
-If you're only after the library run make dfhack.
+make will build everything.
+make expbench will build the expbench testing program and the +library.
+Some of the utilities and the doxygen documentation won't be +normally built. You can enable them by specifying some extra +CMake variables:
++BUILD_DFHACK_DOCUMENTATION - generate the documentation (really bad) +BUILD_DFHACK_EXAMPLES - build tools from tools/examples +BUILD_DFHACK_PLAYGROUND - build tools from tools/playground ++
Example:
++cmake .. -DBUILD_DFHACK_EXAMPLES=ON ++
0.31.04 - 0.31.12 native. There are missing offsets but Map tools should be OK. Linux support is a bit lacking, I'm working on it. All supported Windows versions -running in wine can be used with DFHack.
+running in wine can be used with native DFHack binaries.Cleans all the splatter that get scattered all over the map. Only exception is mud. It leaves mud alone.
Just a simple benchmark of the data export speed.
-A command prompt for liquid creation and manipulation (the Moses effect included!) Also allows painting obsidian walls directly.
Reveals the whole map, waits for input and hides it again. If you close the tool while it waits, the map remains revealed.
Test of the process suspend/resume mechanism.
-Designates a whole vein for digging. Point the cursor at a vein and run this thing :)
Test of the process attach/detach mechanism.
+Test of the process suspend/resume mechanism.
+Just a simple benchmark of the data export speed.
+Dumps the offsets for the currently running DF version into the terminal.
+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.
@@ -475,17 +485,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.
@@ -495,7 +505,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 @@ -533,7 +543,7 @@ server, it allows accelerating the reading of map blocks.
pretty fast, but needs quite a bit of care to not break.The file with memory offset definitions used by dfhack can be found in the output folder.