dfhack fork
 
 
 
 
 
 
Go to file
Carter Bray 3b9d37abe5 Suppress integer conversion warnings inside protobuf source 2016-07-31 17:01:52 -07:00
CMake/Modules Support linking against an external tinyxml if EXTERNAL_TINYXML is set 2016-06-29 17:53:16 -04:00
build Merge remote-tracking branch 'NCommander/vs2015' into develop 2016-07-29 15:30:32 -04:00
depends Suppress integer conversion warnings inside protobuf source 2016-07-31 17:01:52 -07:00
dfhack-config Add default script-paths.txt 2016-03-31 23:00:25 -04:00
docs Merge remote-tracking branch 'NCommander/dwarfvet' into develop 2016-07-29 16:25:53 -04:00
library Merge remote-tracking branch 'NCommander/dwarfvet' into develop 2016-07-29 16:25:53 -04:00
package Download non-broken libstdc++ on OS X 2016-07-27 21:43:38 -04:00
plugins Merge remote-tracking branch 'NCommander/dwarfvet' into develop 2016-07-29 16:25:53 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts@b1e7544d87 Update scripts (find-offsets) 2016-07-29 19:12:14 -04:00
travis Rename script-in-readme to script-docs 2016-07-26 22:51:42 -04: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 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 Automatically detect architecture based on Visual Studio generator 2016-07-31 17:01:47 -07: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 Merge remote-tracking branch 'NCommander/dwarfvet' into develop 2016-07-29 16:25:53 -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.