dfhack fork
 
 
 
 
 
 
Go to file
Kelly Kinkade a04ed641b7 SPACES not TABS 2016-10-25 17:03:45 -05:00
CMake/Modules Support linking against an external tinyxml if EXTERNAL_TINYXML is set 2016-06-29 17:53:16 -04:00
build Add generate-MSVC-release.bat (with devel/dev_plugins disabled) 2016-02-28 11:15:30 -05:00
depends Support linking against an external tinyxml if EXTERNAL_TINYXML is set 2016-06-29 17:53:16 -04:00
dfhack-config Add default script-paths.txt 2016-03-31 23:00:25 -04:00
docs Update various references to scripts/ and mention old git issues in Compile.rst 2016-06-29 19:38:15 -04:00
library Merge branch 'develop' of https://github.com/dfhack/dfhack into develop 2016-07-06 21:00:20 -04:00
package Reset terminal color on exit 2016-05-14 19:39:10 -04:00
plugins SPACES not TABS 2016-10-25 17:03:45 -05:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts@b9f223612b Update NEWS and submodules 2016-07-06 20:59:49 -04:00
travis Improve handling of in-script documentation 2016-06-15 18:28:54 +10:00
.gitignore Clean up, update .gitignore 2015-11-29 18:39:48 -05:00
.gitmodules Re-add the scripts submodule, with a different internal name 2016-06-29 19:07:45 -04:00
.travis.yml Update various references to scripts/ and mention old git issues in Compile.rst 2016-06-29 19:38:15 -04:00
.ycm_extra_conf.py Enable ycmd for project 2016-01-26 20:37:27 -05:00
CMakeLists.txt Turn off prerelease flag 2016-07-06 21:27:54 -04:00
Contributing.rst Improve handling of in-script documentation 2016-06-15 18:28:54 +10:00
LICENSE.rst Further clarify Core; move plugins out; other fixes 2015-11-06 11:44:43 +11:00
NEWS.rst Update NEWS and submodules 2016-07-06 20:59:49 -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 Update various references to scripts/ and mention old git issues in Compile.rst 2016-06-29 19:38:15 -04:00
dfhack.init-example Removing stockflow and workflow from the example dfhack.init 2016-05-14 23:44:25 -06:00
index.rst Move Contributing.rst for Github banner link 2016-06-15 18:28:54 +10: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.