dfhack fork
 
 
 
 
 
 
Go to file
lethosor 9d706854bc Add r1 NEWS.rst section header 2016-04-24 17:36:32 -04:00
CMake/Modules Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
build Add generate-MSVC-release.bat (with devel/dev_plugins disabled) 2016-02-28 11:15:30 -05:00
depends Also exclude libprotoc when cross-compiling (unused) 2016-01-18 09:22:08 -05:00
dfhack-config Add default script-paths.txt 2016-03-31 23:00:25 -04:00
docs Fix typos and missing links in docs 2016-04-15 16:28:41 +10:00
library Expose new unit functions to lua and add some basic safety checks 2016-04-23 21:52:50 -04: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-04-23 20:33:25 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Merge pull request #742 from PeridexisErrant/ls-cleanup 2016-04-17 17:59:22 -04:00
travis Un-break script doc checker 2016-04-15 16:51:24 +10:00
.gitignore Clean up, update .gitignore 2015-11-29 18:39:48 -05:00
.gitmodules Remove df2mc plugin (obsolete) 2015-11-17 11:13:20 +09:30
.travis.yml run sphinx-build in parallel 2016-04-12 20:09:27 -04:00
.ycm_extra_conf.py Enable ycmd for project 2016-01-26 20:37:27 -05:00
CMakeLists.txt Bump to r1 in CMakeLists.txt 2016-04-23 22:02:39 -04:00
LICENSE.rst Further clarify Core; move plugins out; other fixes 2015-11-06 11:44:43 +11:00
NEWS.rst Add r1 NEWS.rst section header 2016-04-24 17:36:32 -04:00
README.html Fix html redirection to the docs 2016-04-11 09:30:05 +10:00
README.md Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
conf.py Tweak developer docs 2016-04-11 09:30:05 +10:00
dfhack.init-example Merge pull request #754 from PeridexisErrant/better-gamelog 2016-03-13 08:27:11 -04: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.