2012-09-29 22:44:00 -06:00
<?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" / >
2014-12-01 14:13:31 -07:00
< meta name = "generator" content = "Docutils 0.12: http://docutils.sourceforge.net/" / >
2012-09-29 22:44:00 -06:00
< title > Building DFHACK< / title >
< style type = "text/css" >
/*
:Author: David Goodger (goodger@python.org)
2014-12-01 14:13:31 -07:00
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
2012-09-29 22:44:00 -06:00
: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 }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* 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,
2014-12-01 14:13:31 -07:00
div.warning p.admonition-title, .code .error {
2012-09-29 22:44:00 -06:00
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: inherit }
/* 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 }
2014-12-01 14:13:31 -07:00
pre.literal-block, pre.doctest-block, pre.math, pre.code {
2012-09-29 22:44:00 -06:00
margin-left: 2em ;
margin-right: 2em }
2014-12-01 14:13:31 -07:00
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
2012-09-29 22:44:00 -06:00
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 }
2014-12-01 14:13:31 -07:00
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
2012-09-29 22:44:00 -06:00
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" id = "building-dfhack" >
< h1 class = "title" > Building DFHACK< / h1 >
< div class = "contents topic" id = "contents" >
< p class = "topic-title first" > Contents< / p >
< ul class = "simple" >
< li > < a class = "reference internal" href = "#linux" id = "id4" > Linux< / a > < ul >
< li > < a class = "reference internal" href = "#how-to-get-the-code" id = "id5" > How to get the code< / a > < / li >
< li > < a class = "reference internal" href = "#dependencies" id = "id6" > Dependencies< / a > < / li >
< li > < a class = "reference internal" href = "#build" id = "id7" > Build< / a > < / li >
2014-02-14 10:06:33 -07:00
< li > < a class = "reference internal" href = "#fixing-the-libstdc-version-bug" id = "id8" > Fixing the libstdc++ version bug< / a > < / li >
2012-09-29 22:44:00 -06:00
< / ul >
< / li >
2014-02-14 10:06:33 -07:00
< li > < a class = "reference internal" href = "#mac-os-x" id = "id9" > Mac OS X< / a > < ul >
< li > < a class = "reference internal" href = "#snow-leopard-changes" id = "id10" > Snow Leopard Changes< / a > < / li >
2013-04-24 08:13:27 -06:00
< / ul >
< / li >
2014-02-14 10:06:33 -07:00
< li > < a class = "reference internal" href = "#windows" id = "id11" > Windows< / a > < ul >
< li > < a class = "reference internal" href = "#id1" id = "id12" > How to get the code< / a > < / li >
< li > < a class = "reference internal" href = "#id2" id = "id13" > Dependencies< / a > < / li >
< li > < a class = "reference internal" href = "#id3" id = "id14" > Build< / a > < / li >
2012-09-29 22:44:00 -06:00
< / ul >
< / li >
2014-02-14 10:06:33 -07:00
< li > < a class = "reference internal" href = "#build-types" id = "id15" > Build types< / a > < / li >
< li > < a class = "reference internal" href = "#using-the-library-as-a-developer" id = "id16" > Using the library as a developer< / a > < ul >
< li > < a class = "reference internal" href = "#df-data-structure-definitions" id = "id17" > DF data structure definitions< / a > < / li >
< li > < a class = "reference internal" href = "#remote-access-interface" id = "id18" > Remote access interface< / a > < / li >
< li > < a class = "reference internal" href = "#contributing-to-dfhack" id = "id19" > Contributing to DFHack< / a > < ul >
< li > < a class = "reference internal" href = "#coding-style" id = "id20" > Coding style< / a > < / li >
< li > < a class = "reference internal" href = "#how-to-get-new-code-into-dfhack" id = "id21" > How to get new code into DFHack< / a > < / li >
< li > < a class = "reference internal" href = "#memory-research" id = "id22" > Memory research< / a > < / li >
2012-09-29 22:44:00 -06:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "section" id = "linux" >
< h1 > < a class = "toc-backref" href = "#id4" > Linux< / a > < / h1 >
< p > On Linux, DFHack acts as a library that shadows parts of the SDL API using LD_PRELOAD.< / p >
< div class = "section" id = "how-to-get-the-code" >
< h2 > < a class = "toc-backref" href = "#id5" > How to get the code< / a > < / h2 >
< p > DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git.
Having a 'git' package installed is the minimal requirement, but some sort of git gui or git integration for your favorite text editor/IDE will certainly help.< / p >
2014-08-06 12:55:22 -06:00
< p > The code resides here: < a class = "reference external" href = "https://github.com/DFHack/dfhack" > https://github.com/DFHack/dfhack< / a > < / p >
2012-09-29 22:44:00 -06:00
< p > If you just want to compile DFHack or work on it by contributing patches, it's quite enough to clone from the read-only address:< / p >
< pre class = "literal-block" >
2014-08-06 12:55:22 -06:00
git clone git://github.com/DFHack/dfhack.git
2012-09-29 22:44:00 -06:00
cd dfhack
git submodule init
git submodule update
< / pre >
< p > If you want to get really involved with the development, create an account on github, make a clone there and then use that as your remote repository instead. Detailed instructions are beyond the scope of this document. If you need help, join us on IRC (#dfhack channel on freenode).< / p >
< / div >
< div class = "section" id = "dependencies" >
< h2 > < a class = "toc-backref" href = "#id6" > Dependencies< / a > < / h2 >
< p > DFHack is meant to be installed into an existing DF folder, so get one ready.< / p >
< p > For building, you need a 32-bit version of GCC. For example, to build DFHack on
2014-08-29 15:00:08 -06:00
a 64-bit distribution like Arch, you'll need the multilib development tools and libraries.
Alternatively, you might be able to use < tt class = "docutils literal" > lxc< / tt > to
< a class = "reference external" href = "http://www.bay12forums.com/smf/index.php?topic=139553.msg5435310#msg5435310" > create a virtual 32-bit environment< / a > .< / p >
2012-09-29 22:44:00 -06:00
< p > Before you can build anything, you'll also need < tt class = "docutils literal" > cmake< / tt > . It is advisable to also get
< tt class = "docutils literal" > ccmake< / tt > on distributions that split the cmake package into multiple parts.< / p >
< p > For the code generation parts, you need perl and the XML::LibXML and XML::LibXSLT perl packages.
You should be able to find them in your distro repositories (on Arch linux 'perl-xml-libxml' and 'perl-xml-libxslt').< / p >
2014-08-29 15:00:08 -06:00
< p > To build Stonesense, you'll also need OpenGL headers.< / p >
2012-09-29 22:44:00 -06:00
< / div >
< div class = "section" id = "build" >
< h2 > < a class = "toc-backref" href = "#id7" > Build< / a > < / h2 >
< p > Building is fairly straightforward. Enter the < tt class = "docutils literal" > build< / tt > folder and start the build like this:< / p >
< pre class = "literal-block" >
cd build
cmake .. -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=/home/user/DF
make install
< / pre >
< p > Obviously, replace the install path with path to your DF. This will build the library
along with the normal set of plugins and install them into your DF folder.< / p >
< p > Alternatively, you can use ccmake instead of cmake:< / p >
< pre class = "literal-block" >
cd build
ccmake ..
make install
< / pre >
< p > This will show a curses-based interface that lets you set all of the
extra options.< / p >
< p > You can also use a cmake-friendly IDE like KDevelop 4 or the cmake-gui
program.< / p >
< / div >
2014-02-14 10:06:33 -07:00
< div class = "section" id = "fixing-the-libstdc-version-bug" >
< h2 > < a class = "toc-backref" href = "#id8" > Fixing the libstdc++ version bug< / a > < / h2 >
< p > When compiling dfhack yourself, it builds against your system libc.
When Dwarf Fortress runs, it uses a libstdc++ shipped with the binary, which
is usually way older, and incompatible with your dfhack. This manifests with
the error message:< / p >
< pre class = "literal-block" >
./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version
`GLIBCXX_3.4.15' not found (required by ./hack/libdfhack.so)
< / pre >
< p > To fix this, simply remove the libstdc++ shipped with DF, it will fall back
to your system lib and everything will work fine:< / p >
< pre class = "literal-block" >
cd /path/to/DF/
rm libs/libstdc++.so.6
< / pre >
< / div >
2012-09-29 22:44:00 -06:00
< / div >
2012-10-20 07:06:33 -06:00
< div class = "section" id = "mac-os-x" >
2014-02-14 10:06:33 -07:00
< h1 > < a class = "toc-backref" href = "#id9" > Mac OS X< / a > < / h1 >
2013-04-24 08:13:27 -06:00
< p > If you are building on 10.6, please read the subsection below titled " Snow Leopard Changes" FIRST.< / p >
2012-10-20 07:06:33 -06:00
< ol class = "arabic" >
< li > < p class = "first" > Download and unpack a copy of the latest DF< / p >
< / li >
< li > < p class = "first" > Install Xcode from Mac App Store< / p >
< / li >
< li > < p class = "first" > Open Xcode, go to Preferences > Downloads, and install the Command Line Tools.< / p >
< / li >
2014-04-12 07:21:10 -06:00
< li > < p class = "first" > Install dependencies< / p >
< blockquote >
< p > Option 1: Using MacPorts:< / p >
< blockquote >
< ul class = "simple" >
< li > < a class = "reference external" href = "http://www.macports.org/" > Install MacPorts< / a > < / li >
< li > Run < tt class = "docutils literal" > sudo port install gcc45 +universal cmake +universal < span class = "pre" > git-core< / span > +universal< / tt >
This will take some time—maybe hours, depending on your machine.< / li >
2012-10-20 07:06:33 -06:00
< / ul >
2014-04-12 07:21:10 -06:00
< p > At some point during this process, it may ask you to install a Java environment; let it do so.< / p >
< / blockquote >
< p > Option 2: Using Homebrew:< / p >
< blockquote >
< ul class = "simple" >
< li > < a class = "reference external" href = "http://brew.sh/" > Install Homebrew< / a > and run:< / li >
< li > < tt class = "docutils literal" > brew install git< / tt > < / li >
< li > < tt class = "docutils literal" > brew install cmake< / tt > < / li >
< li > < tt class = "docutils literal" > brew install gcc45 < span class = "pre" > --enable-multilib< / span > < / tt > < / li >
< / ul >
< / blockquote >
< / blockquote >
2012-10-20 07:06:33 -06:00
< / li >
< li > < p class = "first" > Install perl dependencies< / p >
< blockquote >
< ol class = "arabic" >
< li > < p class = "first" > < tt class = "docutils literal" > sudo cpan< / tt > < / p >
< p > If this is the first time you've run cpan, you will need to go through the setup
process. Just stick with the defaults for everything and you'll be fine.< / p >
< / li >
< li > < p class = "first" > < tt class = "docutils literal" > install < span class = "pre" > XML::LibXML< / span > < / tt > < / p >
< / li >
< li > < p class = "first" > < tt class = "docutils literal" > install < span class = "pre" > XML::LibXSLT< / span > < / tt > < / p >
< / li >
< / ol >
< / blockquote >
< / li >
< li > < p class = "first" > Get the dfhack source:< / p >
< pre class = "literal-block" >
2014-08-29 15:00:08 -06:00
git clone git://github.com/DFHack/dfhack.git
2012-10-20 07:06:33 -06:00
cd dfhack
git submodule init
git submodule update
< / pre >
< / li >
2014-04-12 07:21:10 -06:00
< li > < p class = "first" > Set environment variables:< / p >
< / li >
< / ol >
< blockquote >
< p > Macports:< / p >
< pre class = "literal-block" >
export CC=/opt/local/bin/gcc-mp-4.5
export CXX=/opt/local/bin/g++-mp-4.5
< / pre >
< p > Homebrew:< / p >
< pre class = "literal-block" >
export CC=/usr/local/bin/gcc-4.5
export CXX=/usr/local/bin/g++-4.5
< / pre >
< / blockquote >
< ol class = "arabic" start = "8" >
2012-10-20 07:06:33 -06:00
< li > < p class = "first" > Build dfhack:< / p >
< pre class = "literal-block" >
mkdir build-osx
cd build-osx
cmake .. -DCMAKE_BUILD_TYPE:string=Release -DCMAKE_INSTALL_PREFIX=/path/to/DF/directory
make
make install
< / pre >
< / li >
< / ol >
2013-04-24 08:13:27 -06:00
< div class = "section" id = "snow-leopard-changes" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id10" > Snow Leopard Changes< / a > < / h2 >
2013-04-24 08:13:27 -06:00
< ol class = "arabic" >
< li > < dl class = "first docutils" >
< dt > Add a step 6.2a (before Install XML::LibXSLT)::< / dt >
< dd > < p class = "first last" > In a separate Terminal window or tab, run:
< tt class = "docutils literal" > sudo ln < span class = "pre" > -s< / span > /usr/include/libxml2/libxml /usr/include/libxml< / tt > < / p >
< / dd >
< / dl >
< / li >
< li > < dl class = "first docutils" >
< dt > Add a step 7a (before building)::< / dt >
< dd > < dl class = "first last docutils" >
< dt > In < dfhack directory> /library/LuaTypes.cpp, change line 467 to< / dt >
< dd > < p class = "first last" > < tt class = "docutils literal" > int len = < span class = "pre" > strlen((char*)ptr);< / span > < / tt > < / p >
< / dd >
< / dl >
< / dd >
< / dl >
< / li >
< / ol >
< / div >
2012-10-20 07:06:33 -06:00
< / div >
2012-09-29 22:44:00 -06:00
< div class = "section" id = "windows" >
2014-02-14 10:06:33 -07:00
< h1 > < a class = "toc-backref" href = "#id11" > Windows< / a > < / h1 >
2012-09-29 22:44:00 -06:00
< p > On Windows, DFHack replaces the SDL library distributed with DF.< / p >
< div class = "section" id = "id1" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id12" > How to get the code< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > DFHack doesn't have any kind of system of code snapshots in place, so you will have to get code from the github repository using git.
You will need some sort of Windows port of git, or a GUI. Some examples:< / p >
< blockquote >
< ul class = "simple" >
2014-08-06 12:55:22 -06:00
< li > < a class = "reference external" href = "http://msysgit.github.io/" > http://msysgit.github.io/< / a > - this is a command line version of git for windows. Most tutorials on git usage will apply.< / li >
2012-09-29 22:44:00 -06:00
< li > < a class = "reference external" href = "http://code.google.com/p/tortoisegit/" > http://code.google.com/p/tortoisegit/< / a > - this puts a pretty, graphical face on top of msysgit :)< / li >
< / ul >
< / blockquote >
2014-08-06 12:55:22 -06:00
< p > The code resides here: < a class = "reference external" href = "https://github.com/DFHack/dfhack" > https://github.com/DFHack/dfhack< / a > < / p >
2012-09-29 22:44:00 -06:00
< p > If you just want to compile DFHack or work on it by contributing patches, it's quite enough to clone from the read-only address:< / p >
< pre class = "literal-block" >
2014-08-06 12:55:22 -06:00
git clone git://github.com/DFHack/dfhack.git
2012-09-29 22:44:00 -06:00
cd dfhack
git submodule init
git submodule update
< / pre >
< p > The tortoisegit GUI should have the equivalent options included.< / p >
< p > If you want to get really involved with the development, create an account on github, make a clone there and then use that as your remote repository instead. Detailed instructions are beyond the scope of this document. If you need help, join us on IRC (#dfhack channel on freenode).< / p >
< / div >
< div class = "section" id = "id2" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id13" > Dependencies< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > First, you need < tt class = "docutils literal" > cmake< / tt > . Get the win32 installer version from the official
site: < a class = "reference external" href = "http://www.cmake.org/cmake/resources/software.html" > http://www.cmake.org/cmake/resources/software.html< / a > < / p >
< p > It has the usual installer wizard. Make sure you let it add its binary folder
to your binary search PATH so the tool can be later run from anywhere.< / p >
< p > You'll need a copy of Microsoft Visual C++ 2010. The Express version is sufficient.
Grab it from Microsoft's site.< / p >
2014-02-14 10:06:33 -07:00
< p > You'll also need the Visual Studio 2010 SP1 update.< / p >
2014-08-06 12:55:22 -06:00
< p > For the code generation parts, you'll need perl with XML::LibXML and XML::LibXSLT. Strawberry Perl works nicely for this: http://strawberryperl.com/< / p >
2012-09-29 22:44:00 -06:00
< p > If you already have a different version of perl (for example the one from cygwin), you can run into some trouble. Either remove the other perl install from PATH, or install libxml and libxslt for it instead. Strawberry perl works though and has all the required packages.< / p >
< / div >
< div class = "section" id = "id3" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id14" > Build< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > There are several different batch files in the < tt class = "docutils literal" > build< / tt > folder along with a script that's used for picking the DF path.< / p >
< p > First, run set_df_path.vbs and point the dialog that pops up at your DF folder that you want to use for development.
Next, run one of the scripts with < tt class = "docutils literal" > generate< / tt > prefix. These create the MSVC solution file(s):< / p >
< ul class = "simple" >
< li > < tt class = "docutils literal" > all< / tt > will create a solution with everything enabled (and the kitchen sink).< / li >
< li > < tt class = "docutils literal" > gui< / tt > will pop up the cmake gui and let you pick and choose what to build. This is probably what you want most of the time. Set the options you are interested in, then hit configure, then generate. More options can appear after the configure step.< / li >
< li > < tt class = "docutils literal" > minimal< / tt > will create a minimal solution with just the bare necessities - the main library and standard plugins.< / li >
< / ul >
< p > Then you can either open the solution with MSVC or use one of the msbuild scripts:< / p >
< ul class = "simple" >
< li > Scripts with < tt class = "docutils literal" > build< / tt > prefix will only build.< / li >
< li > Scripts with < tt class = "docutils literal" > install< / tt > prefix will build DFHack and install it to the previously selected DF path.< / li >
< li > Scripts with < tt class = "docutils literal" > package< / tt > prefix will build and create a .zip package of DFHack.< / li >
< / ul >
< p > When you open the solution in MSVC, make sure you never use the Debug builds. Those aren't
binary-compatible with DF. If you try to use a debug build with DF, you'll only get crashes.
So pick either Release or RelWithDebInfo build and build the INSTALL target.< / p >
< p > The < tt class = "docutils literal" > debug< / tt > scripts actually do RelWithDebInfo builds.< / p >
< / div >
< / div >
< div class = "section" id = "build-types" >
2014-02-14 10:06:33 -07:00
< h1 > < a class = "toc-backref" href = "#id15" > Build types< / a > < / h1 >
2012-09-29 22:44:00 -06:00
< p > < tt class = "docutils literal" > cmake< / tt > allows you to pick a build type by changing this
variable: < tt class = "docutils literal" > CMAKE_BUILD_TYPE< / tt > < / p >
< pre class = "literal-block" >
cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE
< / pre >
< p > Without specifying a build type or 'None', cmake uses the
< tt class = "docutils literal" > CMAKE_CXX_FLAGS< / tt > variable for building.< / p >
< p > Valid and useful build types include 'Release', 'Debug' and
'RelWithDebInfo'. 'Debug' is not available on Windows.< / p >
< / div >
< div class = "section" id = "using-the-library-as-a-developer" >
2014-02-14 10:06:33 -07:00
< h1 > < a class = "toc-backref" href = "#id16" > Using the library as a developer< / a > < / h1 >
2012-09-29 22:44:00 -06:00
< p > Currently, the most direct way to use the library is to write a plugin that can be loaded by it.
All the plugins can be found in the 'plugins' folder. There's no in-depth documentation
on how to write one yet, but it should be easy enough to copy one and just follow the pattern.< / p >
< p > Other than through plugins, it is possible to use DFHack via remote access interface, or by writing Lua scripts.< / p >
< p > The most important parts of DFHack are the Core, Console, Modules and Plugins.< / p >
< ul class = "simple" >
< li > Core acts as the centerpiece of DFHack - it acts as a filter between DF and SDL and synchronizes the various plugins with DF.< / li >
< li > Console is a thread-safe console that can be used to invoke commands exported by Plugins.< / li >
< li > Modules actually describe the way to access information in DF's memory. You can get them from the Core. Most modules are split into two parts: high-level and low-level. Higl-level is mostly method calls, low-level publicly visible pointers to DF's data structures.< / li >
< li > Plugins are the tools that use all the other stuff to make things happen. A plugin can have a list of commands that it exports and an onupdate function that will be called each DF game tick.< / li >
< / ul >
< p > Rudimentary API documentation can be built using doxygen (see build options with < tt class = "docutils literal" > ccmake< / tt > or < tt class = "docutils literal" > < span class = "pre" > cmake-gui< / span > < / tt > ).< / p >
< p > DFHack consists of variously licensed code, but invariably weak copyleft.
The main license is zlib/libpng, some bits are MIT licensed, and some are BSD licensed.< / p >
< p > Feel free to add your own extensions and plugins. Contributing back to
the dfhack repository is welcome and the right thing to do :)< / p >
< div class = "section" id = "df-data-structure-definitions" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id17" > DF data structure definitions< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > DFHack uses information about the game data structures, represented via xml files in the library/xml/ submodule.< / p >
< p > Data structure layouts are described in files following the df.*.xml name pattern. This information is transformed by a perl script into C++ headers describing the structures, and associated metadata for the Lua wrapper. These headers and data are then compiled into the DFHack libraries, thus necessitating a compatibility break every time layouts change; in return it significantly boosts the efficiency and capabilities of DFHack code.< / p >
< p > Global object addresses are stored in symbols.xml, which is copied to the dfhack release package and loaded as data at runtime.< / p >
< / div >
< div class = "section" id = "remote-access-interface" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id18" > Remote access interface< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > DFHack supports remote access by exchanging Google protobuf messages via a TCP socket. Both the core and plugins can define remotely accessible methods. The < tt class = "docutils literal" > < span class = "pre" > dfhack-run< / span > < / tt > command uses this interface to invoke ordinary console commands.< / p >
< p > Currently the supported set of requests is limited, because the developers don't know what exactly is most useful.< / p >
< p > Protocol client implementations exist for Java and C#.< / p >
< / div >
< div class = "section" id = "contributing-to-dfhack" >
2014-02-14 10:06:33 -07:00
< h2 > < a class = "toc-backref" href = "#id19" > Contributing to DFHack< / a > < / h2 >
2012-09-29 22:44:00 -06:00
< p > Several things should be kept in mind when contributing to DFHack.< / p >
< div class = "section" id = "coding-style" >
2014-02-14 10:06:33 -07:00
< h3 > < a class = "toc-backref" href = "#id20" > Coding style< / a > < / h3 >
2012-09-29 22:44:00 -06:00
< 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" >
2014-02-14 10:06:33 -07:00
< h3 > < a class = "toc-backref" href = "#id21" > How to get new code into DFHack< / a > < / h3 >
2012-09-29 22:44:00 -06:00
< 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
2014-08-06 12:55:22 -06:00
don't know what, check out < a class = "reference external" href = "http://github.com/DFHack/dfhack/issues" > http://github.com/DFHack/dfhack/issues< / a > --
2012-09-29 22:44:00 -06:00
this is also a good place to dump new ideas and/or bugs that need
fixing.< / p >
< / div >
< div class = "section" id = "memory-research" >
2014-02-14 10:06:33 -07:00
< h3 > < a class = "toc-backref" href = "#id22" > Memory research< / a > < / h3 >
2012-09-29 22:44:00 -06:00
< p > If you want to do memory research, you'll need some tools and some knowledge.
In general, you'll need a good memory viewer and optionally something
to look at machine code without getting crazy :)< / p >
< p > Good windows tools include:< / p >
< ul class = "simple" >
< li > Cheat Engine< / li >
2014-08-06 12:55:22 -06:00
< li > IDA Pro 5.0 (freely available for non-commercial use)< / li >
2012-09-29 22:44:00 -06:00
< / ul >
< p > Good linux tools:< / p >
< ul class = "simple" >
< li > angavrilov's df-structures gui (visit us on IRC for details).< / li >
< li > edb (Evan's Debugger)< / li >
2014-08-06 12:55:22 -06:00
< li > IDA Pro 5.0 running under Wine< / li >
2012-09-29 22:44:00 -06:00
< li > Some of the tools residing in the < tt class = "docutils literal" > legacy< / tt > dfhack branch.< / li >
< / ul >
< p > Using publicly known information and analyzing the game's data is preferred.< / p >
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
