dfhack fork
 
 
 
 
 
 
Go to file
PeridexisErrant a37ae8dbd2 Improve travis checks for branch, script docs
The change to pr-check-base avoids failing builds which should pass
because the GH API is limited.  It'll still work almost all of the time,
but no longer fail builds which previously passed and then pushed more
commits.  Closes #694.
2015-10-28 10:07:02 +11: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 Travis: Build DFHack 2015-10-03 15:58:41 -04:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
library Use TCSADRAIN when disabling raw mode as well 2015-10-14 15:58:27 -04:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins Fix TiletypeMaterial/tiletype_material comparison 2015-10-10 13:06:14 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Fix digfort docs 2015-10-26 11:06:57 +11:00
travis Improve travis checks for branch, script docs 2015-10-28 10:07:02 +11:00
.gitignore Tweak docs building 2015-10-25 10:14:09 +11:00
.gitmodules Fix .gitmodules. 2015-09-21 20:38:31 -04:00
.travis.yml travis: Increase number of parallel builds 2015-10-03 16:08:13 -04:00
CMakeLists.txt Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
LICENSE.rst Allow Sphinx-doc to work with or without cmake 2015-10-23 12:34:54 +11:00
NEWS.rst Format future news 2015-10-24 22:57:08 +11:00
README.html Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
README.md Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11:00
dfhack.init-example Comment out roses-init (shouldn't be run from dfhack.init). 2015-09-26 18:06:24 -04:00
index.rst Split GitHub README from Sphinx index 2015-10-28 10:06:28 +11: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.