diff options
| author | Petr Mrázek | 2011-03-13 19:38:32 +0100 |
|---|---|---|
| committer | Petr Mrázek | 2011-03-13 19:38:32 +0100 |
| commit | cb86f5299366afeb85cd12a8f4bce76f051d0699 (patch) | |
| tree | 19cc50255367e57761467cfa418c13e1e8099a9f /Readme.html | |
| parent | b6d02768b4bc12dec6bd036f075208d2b1f52a12 (diff) | |
| download | dfhack-cb86f5299366afeb85cd12a8f4bce76f051d0699.tar.gz dfhack-cb86f5299366afeb85cd12a8f4bce76f051d0699.tar.bz2 dfhack-cb86f5299366afeb85cd12a8f4bce76f051d0699.tar.xz | |
minor liquids bugfix, added typedef for planecoord so that stonesense builds. Build system bits. Doxygen bits.
Diffstat (limited to 'Readme.html')
| -rw-r--r-- | Readme.html | 145 |
1 files changed, 5 insertions, 140 deletions
diff --git a/Readme.html b/Readme.html index 0c8c7af3..670d13f1 100644 --- a/Readme.html +++ b/Readme.html @@ -353,23 +353,6 @@ allow for easier development of new tools.</p> <li><a class="reference internal" href="#your-tool-here" id="id24">Your tool here</a></li> </ul> </li> -<li><a class="reference internal" href="#using-the-library-as-a-developer" id="id25">Using the library as a developer</a><ul> -<li><a class="reference internal" href="#contributing-to-dfhack" id="id26">Contributing to DFHack</a><ul> -<li><a class="reference internal" href="#coding-style" id="id27">Coding style</a></li> -<li><a class="reference internal" href="#how-to-get-new-code-into-dfhack" id="id28">How to get new code into DFHack</a></li> -<li><a class="reference internal" href="#layout-for-tools" id="id29">Layout for tools</a></li> -<li><a class="reference internal" href="#modules-what-are-they" id="id30">Modules - what are they?</a></li> -<li><a class="reference internal" href="#dependencies" id="id31">Dependencies</a><ul> -<li><a class="reference internal" href="#current-internal-dependencies" id="id32">Current internal dependencies</a></li> -<li><a class="reference internal" href="#current-external-dependencies" id="id33">Current external dependencies</a></li> -<li><a class="reference internal" href="#build-time-dependencies" id="id34">Build-time dependencies</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -<li><a class="reference internal" href="#memory-offset-definitions" id="id35">Memory offset definitions</a></li> </ul> </div> </div> @@ -397,14 +380,14 @@ in AUR and the arch-games repository.</p> functionality. If you know how to easily suspend processes, you can fix it :)</p> </div> -<p>0.31.01 - 0.31.03 legacy -0.31.04 - 0.31.21 SDL -There are missing offsets but Map tools should be OK. Wait for updates...</p> +<p>0.31.01 - 0.31.03 legacy</p> +<p>0.31.04 - 0.31.21 SDL</p> +<p>You need have the MSVC 2010 <a class="reference external" href="http://www.microsoft.com/downloads/en/details.aspx?FamilyID=a7b7a05e-6de6-4d3a-a423-37bf0912db84">redistributable</a> package installed! The tools will fail to run otherwise.</p> </div> <div class="section" id="linux"> <h2><a class="toc-backref" href="#id6">Linux</a></h2> -<p>0.31.05 - 0.31.19 native. -There are missing offsets but Map tools should be OK. Linux support is +<p>0.31.05 - 0.31.19 native.</p> +<p>There are missing offsets but Map tools should be OK. Linux support is a bit lacking, I'm working on it. Slowly. All supported Windows versions running in wine can be used with native DFHack binaries.</p> </div> @@ -503,124 +486,6 @@ You just lost a fortress and gained an adventurer.</p> <p>Write one ;)</p> </div> </div> -<div class="section" id="using-the-library-as-a-developer"> -<h1><a class="toc-backref" href="#id25">Using the library as a developer</a></h1> -<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.</p> -<p>DFHack is using the zlib/libpng license. This makes it easy to link to -it, use it in-source or add your own extensions. Contributing back to -the dfhack repository is welcome and the right thing to do :)</p> -<p>At the time of writing there's no API reference or documentation. The -code does have a lot of comments though (and getting better all the -time).</p> -<div class="section" id="contributing-to-dfhack"> -<h2><a class="toc-backref" href="#id26">Contributing to DFHack</a></h2> -<p>Several things should be kept in mind when contributing to DFHack.</p> -<div class="section" id="coding-style"> -<h3><a class="toc-backref" href="#id27">Coding style</a></h3> -<p>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 <em>you</em> fix it ;)</p> -</div> -<div class="section" id="how-to-get-new-code-into-dfhack"> -<h3><a class="toc-backref" href="#id28">How to get new code into DFHack</a></h3> -<p>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.</p> -<p>Fixes are higher in priority. If you want to work on something, but -don't know what, check out <a class="reference external" href="http://github.com/peterix/dfhack/issues">http://github.com/peterix/dfhack/issues</a> -- -this is also a good place to dump new ideas and/or bugs that need -fixing.</p> -</div> -<div class="section" id="layout-for-tools"> -<h3><a class="toc-backref" href="#id29">Layout for tools</a></h3> -<p>Tools live in the tools/ folder. There, they are split into three -categories.</p> -<dl class="docutils"> -<dt>distributed</dt> -<dd>these tools get distributed with binary releases and are installed -by doing 'make install' on linux. They are supposed to be stable -and supported. Experimental, useless, buggy or untested stuff -doesn't belong here.</dd> -<dt>examples</dt> -<dd>examples are tools that aren't very useful, but show how DF and -DFHack work. They should use only DFHack API functions. No actual -hacking or 'magic offsets' are allowed.</dd> -<dt>playground</dt> -<dd>This is a catch-all folder for tools that aren't ready to be -examples or be distributed in binary releases. All new tools should -start here. They can contain actual hacking, magic values and other -nasty business.</dd> -</dl> -</div> -<div class="section" id="modules-what-are-they"> -<h3><a class="toc-backref" href="#id30">Modules - what are they?</a></h3> -<p>DFHack uses modules to partition sets of features into manageable -chunks. A module can have both client and server side.</p> -<p>Client side is the part that goes into the main library and is -generally written in C++. It is exposed to the users of DFHack.</p> -<p>Server side is used inside DF and serves to accelerate the client -modules. This is written mostly in C style.</p> -<p>There's a Core module that shouldn't be changed, because it defines the -basic commands like reading and writing raw data. The client parts for -the Core module are the various implementations of the Process -interface.</p> -<p>A good example of a module is Maps. Named the same in both client and -server, it allows accelerating the reading of map blocks.</p> -<p>Communication between modules happens by using shared memory. This is -pretty fast, but needs quite a bit of care to not break.</p> -</div> -<div class="section" id="dependencies"> -<h3><a class="toc-backref" href="#id31">Dependencies</a></h3> -<dl class="docutils"> -<dt>Internal</dt> -<dd>either part of the codebase or statically linked.</dd> -<dt>External</dt> -<dd>linked as dynamic loaded libraries (.dll, .so, etc.)</dd> -</dl> -<p>If you want to add dependencies, think twice about it. All internal -dependencies for core dfhack should be either public domain or require -attribution at most. External dependencies for tools can be either -that, or any Free Software licenses.</p> -<div class="section" id="current-internal-dependencies"> -<h4><a class="toc-backref" href="#id32">Current internal dependencies</a></h4> -<dl class="docutils"> -<dt>tinyxml</dt> -<dd>used by core dfhack to read offset definitions from Memory.xml</dd> -<dt>md5</dt> -<dd>an implementation of the MD5 hash algorithm. Used for identifying -DF binaries on Linux.</dd> -<dt>argstream</dt> -<dd>Allows reading terminal application arguments. GPL!</dd> -</dl> -</div> -<div class="section" id="current-external-dependencies"> -<h4><a class="toc-backref" href="#id33">Current external dependencies</a></h4> -<dl class="docutils"> -<dt>wide-character ncurses</dt> -<dd>used for the veinlook tool on Linux.</dd> -<dt>x11 libraries</dt> -<dd>used for sending key events on linux</dd> -</dl> -</div> -<div class="section" id="build-time-dependencies"> -<h4><a class="toc-backref" href="#id34">Build-time dependencies</a></h4> -<dl class="docutils"> -<dt>cmake</dt> -<dd>you need cmake to generate the build system and some configuration -headers</dd> -</dl> -</div> -</div> -</div> -</div> -<div class="section" id="memory-offset-definitions"> -<h1><a class="toc-backref" href="#id35">Memory offset definitions</a></h1> -<p>The files with memory offset definitions used by dfhack can be found in the -data folder.</p> -</div> </div> </body> </html> |
