492 lines
15 KiB
HTML
492 lines
15 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
|
|
<title></title>
|
|
<style type="text/css">
|
|
|
|
/*
|
|
:Author: David Goodger (goodger@python.org)
|
|
:Id: $Id: html4css1.css 6253 2010-03-02 00:24:53Z milde $
|
|
:Copyright: This stylesheet has been placed in the public domain.
|
|
|
|
Default cascading style sheet for the HTML output of Docutils.
|
|
|
|
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
|
customize this style sheet.
|
|
*/
|
|
|
|
/* used to remove borders from tables and images */
|
|
.borderless, table.borderless td, table.borderless th {
|
|
border: 0 }
|
|
|
|
table.borderless td, table.borderless th {
|
|
/* Override padding for "table.docutils td" with "! important".
|
|
The right padding separates the table cells. */
|
|
padding: 0 0.5em 0 0 ! important }
|
|
|
|
.first {
|
|
/* Override more specific margin styles with "! important". */
|
|
margin-top: 0 ! important }
|
|
|
|
.last, .with-subtitle {
|
|
margin-bottom: 0 ! important }
|
|
|
|
.hidden {
|
|
display: none }
|
|
|
|
a.toc-backref {
|
|
text-decoration: none ;
|
|
color: black }
|
|
|
|
blockquote.epigraph {
|
|
margin: 2em 5em ; }
|
|
|
|
dl.docutils dd {
|
|
margin-bottom: 0.5em }
|
|
|
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
|
dl.docutils dt {
|
|
font-weight: bold }
|
|
*/
|
|
|
|
div.abstract {
|
|
margin: 2em 5em }
|
|
|
|
div.abstract p.topic-title {
|
|
font-weight: bold ;
|
|
text-align: center }
|
|
|
|
div.admonition, div.attention, div.caution, div.danger, div.error,
|
|
div.hint, div.important, div.note, div.tip, div.warning {
|
|
margin: 2em ;
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.admonition p.admonition-title, div.hint p.admonition-title,
|
|
div.important p.admonition-title, div.note p.admonition-title,
|
|
div.tip p.admonition-title {
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
div.attention p.admonition-title, div.caution p.admonition-title,
|
|
div.danger p.admonition-title, div.error p.admonition-title,
|
|
div.warning p.admonition-title {
|
|
color: red ;
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
/* Uncomment (and remove this text!) to get reduced vertical space in
|
|
compound paragraphs.
|
|
div.compound .compound-first, div.compound .compound-middle {
|
|
margin-bottom: 0.5em }
|
|
|
|
div.compound .compound-last, div.compound .compound-middle {
|
|
margin-top: 0.5em }
|
|
*/
|
|
|
|
div.dedication {
|
|
margin: 2em 5em ;
|
|
text-align: center ;
|
|
font-style: italic }
|
|
|
|
div.dedication p.topic-title {
|
|
font-weight: bold ;
|
|
font-style: normal }
|
|
|
|
div.figure {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
div.footer, div.header {
|
|
clear: both;
|
|
font-size: smaller }
|
|
|
|
div.line-block {
|
|
display: block ;
|
|
margin-top: 1em ;
|
|
margin-bottom: 1em }
|
|
|
|
div.line-block div.line-block {
|
|
margin-top: 0 ;
|
|
margin-bottom: 0 ;
|
|
margin-left: 1.5em }
|
|
|
|
div.sidebar {
|
|
margin: 0 0 0.5em 1em ;
|
|
border: medium outset ;
|
|
padding: 1em ;
|
|
background-color: #ffffee ;
|
|
width: 40% ;
|
|
float: right ;
|
|
clear: right }
|
|
|
|
div.sidebar p.rubric {
|
|
font-family: sans-serif ;
|
|
font-size: medium }
|
|
|
|
div.system-messages {
|
|
margin: 5em }
|
|
|
|
div.system-messages h1 {
|
|
color: red }
|
|
|
|
div.system-message {
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.system-message p.system-message-title {
|
|
color: red ;
|
|
font-weight: bold }
|
|
|
|
div.topic {
|
|
margin: 2em }
|
|
|
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
|
margin-top: 0.4em }
|
|
|
|
h1.title {
|
|
text-align: center }
|
|
|
|
h2.subtitle {
|
|
text-align: center }
|
|
|
|
hr.docutils {
|
|
width: 75% }
|
|
|
|
img.align-left, .figure.align-left, object.align-left {
|
|
clear: left ;
|
|
float: left ;
|
|
margin-right: 1em }
|
|
|
|
img.align-right, .figure.align-right, object.align-right {
|
|
clear: right ;
|
|
float: right ;
|
|
margin-left: 1em }
|
|
|
|
img.align-center, .figure.align-center, object.align-center {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
.align-left {
|
|
text-align: left }
|
|
|
|
.align-center {
|
|
clear: both ;
|
|
text-align: center }
|
|
|
|
.align-right {
|
|
text-align: right }
|
|
|
|
/* reset inner alignment in figures */
|
|
div.align-right {
|
|
text-align: left }
|
|
|
|
/* div.align-center * { */
|
|
/* text-align: left } */
|
|
|
|
ol.simple, ul.simple {
|
|
margin-bottom: 1em }
|
|
|
|
ol.arabic {
|
|
list-style: decimal }
|
|
|
|
ol.loweralpha {
|
|
list-style: lower-alpha }
|
|
|
|
ol.upperalpha {
|
|
list-style: upper-alpha }
|
|
|
|
ol.lowerroman {
|
|
list-style: lower-roman }
|
|
|
|
ol.upperroman {
|
|
list-style: upper-roman }
|
|
|
|
p.attribution {
|
|
text-align: right ;
|
|
margin-left: 50% }
|
|
|
|
p.caption {
|
|
font-style: italic }
|
|
|
|
p.credits {
|
|
font-style: italic ;
|
|
font-size: smaller }
|
|
|
|
p.label {
|
|
white-space: nowrap }
|
|
|
|
p.rubric {
|
|
font-weight: bold ;
|
|
font-size: larger ;
|
|
color: maroon ;
|
|
text-align: center }
|
|
|
|
p.sidebar-title {
|
|
font-family: sans-serif ;
|
|
font-weight: bold ;
|
|
font-size: larger }
|
|
|
|
p.sidebar-subtitle {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
p.topic-title {
|
|
font-weight: bold }
|
|
|
|
pre.address {
|
|
margin-bottom: 0 ;
|
|
margin-top: 0 ;
|
|
font: inherit }
|
|
|
|
pre.literal-block, pre.doctest-block {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
span.classifier {
|
|
font-family: sans-serif ;
|
|
font-style: oblique }
|
|
|
|
span.classifier-delimiter {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
span.interpreted {
|
|
font-family: sans-serif }
|
|
|
|
span.option {
|
|
white-space: nowrap }
|
|
|
|
span.pre {
|
|
white-space: pre }
|
|
|
|
span.problematic {
|
|
color: red }
|
|
|
|
span.section-subtitle {
|
|
/* font-size relative to parent (h1..h6 element) */
|
|
font-size: 80% }
|
|
|
|
table.citation {
|
|
border-left: solid 1px gray;
|
|
margin-left: 1px }
|
|
|
|
table.docinfo {
|
|
margin: 2em 4em }
|
|
|
|
table.docutils {
|
|
margin-top: 0.5em ;
|
|
margin-bottom: 0.5em }
|
|
|
|
table.footnote {
|
|
border-left: solid 1px black;
|
|
margin-left: 1px }
|
|
|
|
table.docutils td, table.docutils th,
|
|
table.docinfo td, table.docinfo th {
|
|
padding-left: 0.5em ;
|
|
padding-right: 0.5em ;
|
|
vertical-align: top }
|
|
|
|
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
|
font-weight: bold ;
|
|
text-align: left ;
|
|
white-space: nowrap ;
|
|
padding-left: 0 }
|
|
|
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
|
font-size: 100% }
|
|
|
|
ul.auto-toc {
|
|
list-style-type: none }
|
|
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="document">
|
|
|
|
|
|
<div class="section" id="introduction">
|
|
<h1><a class="toc-backref" href="#id1">Introduction</a></h1>
|
|
<p>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.</p>
|
|
<p>It is an attempt to unite the various ways tools access DF memory and
|
|
allow for easier development of new tools.</p>
|
|
<div class="contents topic" id="contents">
|
|
<p class="topic-title first">Contents</p>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
|
|
<li><a class="reference internal" href="#getting-dfhack" id="id2">Getting DFHack</a><ul>
|
|
<li><a class="reference internal" href="#packages" id="id3">Packages</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#compatibility" id="id4">Compatibility</a><ul>
|
|
<li><a class="reference internal" href="#windows" id="id5">Windows</a></li>
|
|
<li><a class="reference internal" href="#linux" id="id6">Linux</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#tools" id="id7">Tools</a><ul>
|
|
<li><a class="reference internal" href="#dfcleanmap" id="id8">dfcleanmap</a></li>
|
|
<li><a class="reference internal" href="#dfliquids" id="id9">dfliquids</a></li>
|
|
<li><a class="reference internal" href="#dfposition" id="id10">dfposition</a></li>
|
|
<li><a class="reference internal" href="#dfprospector" id="id11">dfprospector</a></li>
|
|
<li><a class="reference internal" href="#dfprobe" id="id12">dfprobe</a></li>
|
|
<li><a class="reference internal" href="#dfreveal" id="id13">dfreveal</a></li>
|
|
<li><a class="reference internal" href="#dfunstuck" id="id14">dfunstuck</a></li>
|
|
<li><a class="reference internal" href="#dfvdig" id="id15">dfvdig</a></li>
|
|
<li><a class="reference internal" href="#dfflows" id="id16">dfflows</a></li>
|
|
<li><a class="reference internal" href="#dfattachtest" id="id17">dfattachtest</a></li>
|
|
<li><a class="reference internal" href="#dfsuspend" id="id18">dfsuspend</a></li>
|
|
<li><a class="reference internal" href="#dfexpbench" id="id19">dfexpbench</a></li>
|
|
<li><a class="reference internal" href="#dfdoffsets" id="id20">dfdoffsets</a></li>
|
|
<li><a class="reference internal" href="#dfcleartask" id="id21">dfcleartask</a></li>
|
|
<li><a class="reference internal" href="#dfweather" id="id22">dfweather</a></li>
|
|
<li><a class="reference internal" href="#dfmode" id="id23">dfmode</a></li>
|
|
<li><a class="reference internal" href="#your-tool-here" id="id24">Your tool here</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="getting-dfhack">
|
|
<h1><a class="toc-backref" href="#id2">Getting DFHack</a></h1>
|
|
<p>The project is currently hosted on <a class="reference external" href="http://www.github.com/">github</a>, for both source and
|
|
binaries at <a class="reference external" href="http://github.com/peterix/dfhack">http://github.com/peterix/dfhack</a></p>
|
|
<div class="section" id="packages">
|
|
<h2><a class="toc-backref" href="#id3">Packages</a></h2>
|
|
<p>The library and tools are packaged for Archlinux and are available both
|
|
in AUR and the arch-games repository.</p>
|
|
<p>The package name is dfhack-git :)</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="compatibility">
|
|
<h1><a class="toc-backref" href="#id4">Compatibility</a></h1>
|
|
<p>DFHack works on Windows XP, Vista, 7 or any modern Linux distribution.</p>
|
|
<p>OSX is not supported due to lack of developers with a Mac.</p>
|
|
<p>Currently supported Dwarf Fortress versions are Windows and Linux.</p>
|
|
<div class="section" id="windows">
|
|
<h2><a class="toc-backref" href="#id5">Windows</a></h2>
|
|
<div class="note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Windows 2000 is currently <em>not supported</em> due to missing OS
|
|
functionality. If you know how to easily suspend processes, you can
|
|
fix it :)</p>
|
|
</div>
|
|
<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.</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>
|
|
</div>
|
|
<div class="section" id="tools">
|
|
<h1><a class="toc-backref" href="#id7">Tools</a></h1>
|
|
<p>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.</p>
|
|
<div class="section" id="dfcleanmap">
|
|
<h2><a class="toc-backref" href="#id8">dfcleanmap</a></h2>
|
|
<p>Cleans all the splatter that get scattered all over the map.
|
|
Only exception is mud. It leaves mud alone.</p>
|
|
</div>
|
|
<div class="section" id="dfliquids">
|
|
<h2><a class="toc-backref" href="#id9">dfliquids</a></h2>
|
|
<p>A command prompt for liquid creation and manipulation (the Moses
|
|
effect included!) Also allows painting obsidian walls directly.</p>
|
|
<div class="note">
|
|
<p class="first admonition-title">Note</p>
|
|
<p class="last">Spawning and deleting liquids can F up pathing data and
|
|
temperatures (creating heat traps). You've been warned.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dfposition">
|
|
<h2><a class="toc-backref" href="#id10">dfposition</a></h2>
|
|
<p>Prints the current DF window properties and cursor position.</p>
|
|
</div>
|
|
<div class="section" id="dfprospector">
|
|
<h2><a class="toc-backref" href="#id11">dfprospector</a></h2>
|
|
<p>Lists all available minerals on the map and how much of them there is.</p>
|
|
</div>
|
|
<div class="section" id="dfprobe">
|
|
<h2><a class="toc-backref" href="#id12">dfprobe</a></h2>
|
|
<p>Can be used to determine tile properties.</p>
|
|
</div>
|
|
<div class="section" id="dfreveal">
|
|
<h2><a class="toc-backref" href="#id13">dfreveal</a></h2>
|
|
<p>Reveals the whole map, waits for input and hides it again. If you close
|
|
the tool while it waits, the map remains revealed.</p>
|
|
</div>
|
|
<div class="section" id="dfunstuck">
|
|
<h2><a class="toc-backref" href="#id14">dfunstuck</a></h2>
|
|
<p>Use if you prematurely close any of the tools and DF appears to be
|
|
stuck.</p>
|
|
</div>
|
|
<div class="section" id="dfvdig">
|
|
<h2><a class="toc-backref" href="#id15">dfvdig</a></h2>
|
|
<p>Designates a whole vein for digging. Point the cursor at a vein and run
|
|
this thing :)</p>
|
|
</div>
|
|
<div class="section" id="dfflows">
|
|
<h2><a class="toc-backref" href="#id16">dfflows</a></h2>
|
|
<p>A tool for checking how many liquid tiles are actively checked for
|
|
flows.</p>
|
|
</div>
|
|
<div class="section" id="dfattachtest">
|
|
<h2><a class="toc-backref" href="#id17">dfattachtest</a></h2>
|
|
<p>Test of the process attach/detach mechanism.</p>
|
|
</div>
|
|
<div class="section" id="dfsuspend">
|
|
<h2><a class="toc-backref" href="#id18">dfsuspend</a></h2>
|
|
<p>Test of the process suspend/resume mechanism.</p>
|
|
</div>
|
|
<div class="section" id="dfexpbench">
|
|
<h2><a class="toc-backref" href="#id19">dfexpbench</a></h2>
|
|
<p>Just a simple benchmark of the data export speed.</p>
|
|
</div>
|
|
<div class="section" id="dfdoffsets">
|
|
<h2><a class="toc-backref" href="#id20">dfdoffsets</a></h2>
|
|
<p>Dumps the offsets for the currently running DF version into the terminal.</p>
|
|
</div>
|
|
<div class="section" id="dfcleartask">
|
|
<h2><a class="toc-backref" href="#id21">dfcleartask</a></h2>
|
|
<p>Solves the problem of unusable items after reclaim by clearing the 'in_job' bit of all items.</p>
|
|
</div>
|
|
<div class="section" id="dfweather">
|
|
<h2><a class="toc-backref" href="#id22">dfweather</a></h2>
|
|
<p>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.</p>
|
|
</div>
|
|
<div class="section" id="dfmode">
|
|
<h2><a class="toc-backref" href="#id23">dfmode</a></h2>
|
|
<p>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.</p>
|
|
<div class="admonition-example admonition">
|
|
<p class="first admonition-title">Example</p>
|
|
<p class="last">You are in fort game mode (0 game mode), managing your fortress (0 control mode) and paused.
|
|
You switch to the arena game mode, <em>assume control of a creature</em> and the switch to adventure game mode(1).
|
|
You just lost a fortress and gained an adventurer.</p>
|
|
</div>
|
|
<p>I take no responsibility of anything that happens as a result of using this tool :P</p>
|
|
</div>
|
|
<div class="section" id="your-tool-here">
|
|
<h2><a class="toc-backref" href="#id24">Your tool here</a></h2>
|
|
<p>Write one ;)</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|