dfhack fork
 
 
 
 
 
 
Go to file
lethosor 2d23a848cc git-describe: Add git xml information 2016-02-01 10:30:53 -05:00
CMake/Modules Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
build Bash script to build dfhack according to the instructions in Compile.rst. 2015-01-05 16:02:13 -05:00
depends Also exclude libprotoc when cross-compiling (unused) 2016-01-18 09:22:08 -05:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs exportlegends-related documentation updates 2016-01-16 11:34:12 -05:00
library git-describe: Add git xml information 2016-02-01 10:30:53 -05:00
package Rename libstdc++ automatically in Linux launcher script 2016-01-18 09:21:31 -05:00
plugins Merge branch 'develop' of https://github.com/DFHack/dfhack into develop 2016-02-01 20:01:00 +05:30
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Add ban-cooking milk. See #795. 2016-01-18 15:29:49 -06:00
travis Improve linter disabling somewhat 2016-02-01 09:39:40 -05:00
.gitignore Clean up, update .gitignore 2015-11-29 18:39:48 -05:00
.gitmodules Fix .gitmodules. 2015-09-21 20:38:31 -04:00
.travis.yml travis: build docs 2015-12-19 10:55:35 -05:00
.ycm_extra_conf.py Enable ycmd for project 2016-01-26 20:37:27 -05:00
CMakeLists.txt Enable ycmd for project 2016-01-26 20:37:27 -05:00
LICENSE.rst Further clarify Core; move plugins out; other fixes 2015-11-06 11:44:43 +11:00
NEWS.rst buildingplan: Support floodgates, grates, bars 2016-01-31 14:50:07 -05:00
README.html Move index back to root 2015-11-07 19:42:18 -05:00
README.md Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
conf.py Move index back to root 2015-11-07 19:42:18 -05:00
dfhack.init-example New autogems plugin, automatically cutting rough gems. 2016-01-08 23:18:41 -07:00
index.rst Move index back to root 2015-11-07 19:42:18 -05:00

README.md

#DFHack Readme

[Build Status] (https://travis-ci.org/DFHack/dfhack) [Documentation Status] (https://dfhack.readthedocs.org) [License] (https://en.wikipedia.org/wiki/Zlib_License) [Github Issues] (https://github.com/DFHack/dfhack/issues) [Open Pulls] (https://github.com/DFHack/dfhack/pulls)

DFHack is a Dwarf Fortress memory access library, distributed with scripts and plugins implementing a wide variety of useful functions and tools.

The full documentation is available online here, from the README.html page in the DFHack distribution, or as raw text in the ./docs folder. If you're an end-user, modder, or interested in contributing to DFHack - go read those docs.

If that's unclear or you need more help, try [the Bay12 forums thread] (http://www.bay12forums.com/smf/index.php?topic=139553) or the #dfhack IRC channel on freenode.