dfhack fork
 
 
 
 
 
 
Go to file
Lethosor a4e173270e Merge pull request #768 from TheBloke/compile_doc_improve
Compile.rst: major updates to Windows and OSX sections;
2015-12-19 10:58:36 -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 Improve Json::get() slightly 2015-11-27 16:45:26 -05:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs Windows: soften the recommendation on Chocolatey to a 'preferred', also some improvements on the Chocolatey description re behaviour when software is already installed. And an update to the Manual Dependencies section. 2015-12-19 14:17:39 +00:00
library update xml 2015-12-18 23:09:27 -05:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins Merge branch 'develop' of https://github.com/dfhack/dfhack into develop 2015-12-18 18:42:39 -05:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Add prerelease build flag and warning script 2015-12-11 20:27:46 -05:00
travis Add script to check Authors.rst 2015-11-26 13:17:18 -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
CMakeLists.txt Add prerelease build flag and warning script 2015-12-11 20:27:46 -05:00
LICENSE.rst Further clarify Core; move plugins out; other fixes 2015-11-06 11:44:43 +11:00
NEWS.rst Update version to r5 2015-11-27 16:45:39 -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 Disable stockflow and show warning in example init 2015-12-04 23:13:12 -05: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.