dfhack fork
 
 
 
 
 
 
Go to file
lethosor 8ae513042f Fix mismatched backquotes in History.rst 2016-10-24 10:06:55 -04:00
CMake Distribute a gunzip.pl script 2016-10-15 12:09:04 -04:00
build Move set_df_path.vbs into the directories where it's actually useful. 2016-10-21 10:26:20 +05:30
depends Distribute a gunzip.pl script 2016-10-15 12:09:04 -04:00
dfhack-config Add default script-paths.txt 2016-03-31 23:00:25 -04:00
docs Fix mismatched backquotes in History.rst 2016-10-24 10:06:55 -04:00
library Update scripts, xml 2016-10-19 09:53:51 -04:00
package Make DFHack libraries take priority on Linux 2016-10-22 13:04:15 -04:00
plugins Fix memview x64 address display 2016-10-24 10:06:41 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts@b285334a8a Update scripts, xml 2016-10-19 09:53:51 -04:00
travis Fix script-docs.py error with missing opening token 2016-08-11 11:57:42 -04:00
.gitignore Ignore df_path. again. 2016-10-19 20:00:56 +05:30
.gitmodules Re-add the scripts submodule, with a different internal name 2016-06-29 19:07:45 -04:00
.travis.yml Rename script-in-readme to script-docs 2016-07-26 22:51:42 -04:00
.ycm_extra_conf.py Enable ycmd for project 2016-01-26 20:37:27 -05:00
CMakeLists.txt Bump version in CMakeLists.txt 2016-10-15 17:27:08 -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 Add, use, and require auto docs for all keybindings 2016-10-20 18:33:31 +11: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 Fix Python 2 compatibility 2016-10-23 18:28:41 -04:00
dfhack.init-example Add gui/manager-quantity keybinding 2016-08-25 12:14:44 -04: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.