MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack fork
6,523 Commits
1 Branch
0 Tags
40 MiB
C++ 77.6%
Lua 11.9%
C 8.9%
CMake 0.9%
Python 0.4%
Other 0.2%
 
 
 
 
 
 
Go to file
PeridexisErrant 5643119c71 Get docs building online 
Readthedocs runs the build command in the directory conf.py is found,
and to work correctly that has to be the root directory.
 		2015-10-29 14:26:37 +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 Get docs building online 2015-10-29 14:26:37 +11:00
library type: Provide more useful information (script paths, plugin names) 2015-10-27 17:34:32 -04:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins Indicate development builds 2015-10-24 14:52:00 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Tweak plugins docs 2015-10-29 12:46:31 +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
conf.py Get docs building online 2015-10-29 14:26:37 +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.