dfhack fork
 
 
 
 
 
 
Go to file
PeridexisErrant bc5f7f329a Add top-level redirect page for the docs
Because otherwise the pretty docs are buried and that doesn't help
anyone.
2015-09-23 10:17:25 +10:00
CMake/Modules Purge html files, add docutils cmake module 2012-09-29 03:06:39 +02:00
build Bash script to build dfhack according to the instructions in Compile.rst. 2015-01-05 16:02:13 -05:00
depends Add some JSON helper functions 2015-07-29 20:09:55 -04:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs Clean up in dev-oriented docs 2015-09-23 00:06:56 +10:00
library Fix a few issues with init file variations 2015-09-21 18:57:58 -04:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins search: Fix crash when disabling a stockpile category 2015-09-21 19:25:20 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Fix indentation in Vjek scripts. 2015-09-21 18:25:16 -04:00
travis pr-check-base: Show more information about HTTP errors 2015-09-21 19:02:23 -04:00
.gitignore Misc changes for better structure 2015-09-22 18:42:15 +10:00
.gitmodules Use DFHack fork of lethosor-scripts 2015-09-14 16:56:09 -04:00
.travis.yml Misc changes for better structure 2015-09-22 18:42:15 +10:00
CMakeLists.txt Add a framework for including 3rd-party script repos 2015-08-06 21:50:01 -04:00
LICENSE Replace jsonxx with jsoncpp 2015-07-29 15:50:33 -04:00
Makefile Misc changes for better structure 2015-09-22 18:42:15 +10:00
NEWS search: Fix crash when disabling a stockpile category 2015-09-21 19:25:20 -04:00
README.html Add top-level redirect page for the docs 2015-09-23 10:17:25 +10:00
README.rst Split readme into files for scripts, plugins, and base 2015-09-22 23:30:22 +10:00
conf.py Misc changes for better structure 2015-09-22 18:42:15 +10:00
dfhack-icon.png Ubuntu packaging magic, forgotten header files, an icon. 2011-03-19 23:26:32 +01:00
dfhack.init-example Merge remote-tracking branch 'sethwoodworth/patch-1' into develop 2015-08-10 23:41:58 -04:00
make-docs.bat Misc changes for better structure 2015-09-22 18:42:15 +10:00

README.rst

Welcome to DFHack's documentation!
==================================

Introduction
============
DFHack is a Dwarf Fortress memory access library, distributed with scripts
and plugins implementing a wide variety of useful functions and tools.

For users, it provides a significant suite of bugfixes and interface
enhancements by default, and more can be enabled.  There are also many tools
(such as ``workflow`` or ``autodump``) which can make life easier.  You can
even add third-party scripts and plugins to do almost anything!

For modders, DFHack makes many things possible.  Custom reactions, new
interactions, magic creature abilities, and more can be set through scripts
and custom raws.  Non-standard DFHack scripts and inits can be stored in the
raw directory, making raws or saves fully self-contained for distribution -
or for coexistence in a single DF install, even with incompatible components.

For developers, DFHack unites the various ways tools access DF memory and
allows easier development of new tools.  As an open-source project under
various copyleft licences, contributions are welcome.


Documentation
=============
DFHack documentation is generated by Sphinx.  Check out the table of contents
below, or the sources in the docs folder!

TODO: make this work on Github!


Contents for users:

.. toctree::
   :maxdepth: 2

   docs/Readme
   docs/Plugins
   docs/Scripts

Contents for developers:

.. toctree::
   :maxdepth: 1

   docs/Contributing
   docs/Compile
   docs/Lua API
   docs/Authors