From be75883ac515c08644927807e94e12f7e1eb6767 Mon Sep 17 00:00:00 2001
From: expwnent
-
-
@@ -395,8 +396,8 @@ Alternatively, you might be able to use lxc to
create a virtual 32-bit environment.
Before you can build anything, you'll also need cmake. It is advisable to also get ccmake on distributions that split the cmake package into multiple parts.
-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').
+You also need perl and the XML::LibXML and XML::LibXSLT perl packages (for the code generation parts). +You should be able to find them in your distro repositories (on Arch linux 'perl-xml-libxml' and 'perl-xml-libxslt') or through cpan.
To build Stonesense, you'll also need OpenGL headers.
If you have issues building on OS X Yosemite (or above), try definining the following environment variable:
++export MACOSX_DEPLOYMENT_TARGET=10.9+
On Windows, DFHack replaces the SDL library distributed with DF.
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:
@@ -567,7 +574,7 @@ git submodule updateIf 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).
First, you need cmake. Get the win32 installer version from the official site: http://www.cmake.org/cmake/resources/software.html
It has the usual installer wizard. Make sure you let it add its binary folder @@ -579,7 +586,7 @@ Grab it from Microsoft's site.
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.
There are several different batch files in the build folder along with a script that's used for picking the DF path.
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 generate prefix. These create the MSVC solution file(s):
@@ -601,7 +608,7 @@ So pick either Release or RelWithDebInfo build and build the INSTALL target.cmake allows you to pick a build type by changing this variable: CMAKE_BUILD_TYPE
@@ -613,7 +620,7 @@ cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE 'RelWithDebInfo'. 'Debug' is not available on Windows.
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.
@@ -631,13 +638,13 @@ The main license is zlib/libpng, some bits are MIT licensed, and some are BSD liFeel free to add your own extensions and plugins. Contributing back to the dfhack repository is welcome and the right thing to do :)
DFHack uses information about the game data structures, represented via xml files in the library/xml/ submodule.
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.
Global object addresses are stored in symbols.xml, which is copied to the dfhack release package and loaded as data at runtime.
DFHack supports remote access by exchanging Google protobuf messages via a TCP socket. Both the core and plugins can define remotely accessible methods. The dfhack-run command uses this interface to invoke ordinary console commands.
Currently the supported set of requests is limited, because the developers don't know what exactly is most useful.
Protocol client implementations exist for Java and C#.
diff --git a/Contributors.html b/Contributors.html index 702f40b1a..970da8a8d 100644 --- a/Contributors.html +++ b/Contributors.html @@ -343,85 +343,361 @@ ul.auto-toc {If you belong here and are missing, please add yourself and send me (peterix) a pull request :-)
The following is a list of people who have contributed to DFHack.
-And those are the cool people who made stonesense.
-Name | +Github | +|
---|---|---|
Petr Mrázek | +peterix | +peterix@gmail.com | +
Alexander Gavrilov | +angavrilov | +angavrilov@gmail.com | +
doomchild | +doomchild | +lee.crabtree@gmail.com | +
Quietust | +quietust | +quietust@gmail.com | +
jj | +jjyg | +john-git@ofjj.net | +
Warmist | +warmist | +warmist@gmail.com | +
Robert Heinrich | +rh73 | +robertheinrich73@googlemail.com | +
simon | ++ | simon@banquise.net | +
Kelly Martin | +ab9rf | +kelly.lynn.martin@gmail.com | +
mizipzor | +mizipzor | +mizipzor@gmail.com | +
Simon Jackson | +sizeak | +sizeak@hotmail.com | +
belal | +jimhester | +jimbelal@gmail.com | +
RusAnon | +RusAnon | +rusanon@dollchan.ru | +
Raoul XQ | +raoulxq | +raoulxq@gmail.com | +
Matthew Cline | ++ | zelgadis@sourceforge.net | +
Mike Stewart | +thewonderidiot | +thewonderidiot@gmail.com | +
Timothy Collett | +danaris | +tcollett+github@topazgryphon.org | +
RossM | ++ | Ross@Gnome | +
Tom Prince | ++ | tom.prince@ualberta.net | +
Jared Adams | ++ | jaxad0127@gmail.com | +
expwnent | +expwnent | ++ |
Erik Youngren | +Artanis | +artanis.00@gmail.com | +
Espen Wiborg | ++ | espen.wiborg@telio.no | +
Tim Walberg | +twalberg | +twalberg@comcast.net | +
Mikko Juola | +Noeda | +mikko.juola@kolumbus.fi | +
rampaging-poet | ++ | yrudoingthis@hotmail.com | +
U-glouglou\simon | ++ | simon@glouglou | +
Clayton Hughes | ++ | clayton.hughes@gmail.com | +
zilpin | +zilpin | +ziLpin@gmail.com | +
Will Rogers | +wjrogers | +wjrogers@gmail.com | +
NMLittle | +nmlittle | +nmlittle@gmail.com | +
root | ++ | + |
reverb | ++ | + |
Zhentar | +Zhentar | +Zhentar@gmail.com | +
Valentin Ochs | +Cat-Ion | +a@0au.de | +
Priit Laes | +plaes | +plaes@plaes.org | +
kmartin | ++ | + |
Neil Little | ++ | + |
rout | ++ | rout.mail+github@gmail.com | +
rofl0r | +rofl0r | +retnyg@gmx.net | +
harlanplayford | +playfordh | +harlanplayford@gmail.com | +
John Shade | +gsvslto | +gsvslto@gmail.com | +
sami | ++ | + |
potato | ++ | + |
feng1st | ++ | nf_xp@hotmail.com | +
comestible | +nickrart | +nickolas.g.russell@gmail.com | +
Rumrusher | +rumrusher | +Anuleakage@yahoo.com | +
Rinin | +Rinin | +RininS@Gmail.com | +
Raoul van Putten | ++ | + |
John Beisley | +huin | +greatred@gmail.com | +
Feng | ++ | nf_xp@hotmail.com | +
Donald Ruegsegger | +hashaash | +druegsegger@gmail.com | +
Caldfir | +caldfir | +caldfir@hotmail.com | +
Antalia | +tamarakorr | +tamarakorr@gmail.com | +
Angus Mezick | +amezick | +amezick@gmail.com | +
Japa | +JapaMala | +japa.mala.illo@gmail.com | +
Putnam | +Putnam3145 | ++ |
Lethosor | +lethosor | ++ |
PeridexisErrant | +PeridexisErrant | +PeridexisErrant@gmail.com | +
Eswald | +eswald | ++ |
Ramblurr | +Ramblurr | ++ |
MithrilTuxedo | +MithrilTuxedo | ++ |
AndreasPK | +AndreasPK | ++ |
Chris Dombroski | +cdombroski | ++ |
Ben Lubar | +BenLubar | ++ |
miffedmap | +miffedmap | ++ |
scamtank | +scamtank | ++ |
Mason11987 | +Mason11987 | ++ |
James Logsdon | +jlogsdon | ++ |
melkor217 | +melkor217 | ++ |
And these are the cool people who made Stonesense.
+Name | +Github | +|
---|---|---|
Kris Parker | +kaypy | ++ |
Japa | +JapaMala | +japa.mala.illo@gmail.com | +
Jonas Ask | ++ | jonask84@gmail.com | +
Petr Mrázek | +peterix | +peterix@gmail.com> | +
Caldfir | +caldfir | +aitken.tim@gmail.com | +
8Z | +8Z | +git8z@ya.ru | +
Alexander Gavrilov | +angavrilov | +angavrilov@gmail.com | +
Timothy Collett | +danaris | +tcollett+github@topazgryphon.org | +
Lethosor | +lethosor | ++ |
Eswald | +eswald | ++ |
PeridexisErrant | +PeridexisErrant | +PeridexisErrant@gmail.com | +