MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack fork
6,455 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
lethosor f874fac500 Consolidate licenses of other dependencies 2015-10-03 13:42:03 -04: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 Replace translate_socket_error() implementations with DescribeError() 2015-10-03 10:37:48 -04:00
dfhack-config dfstatus: Allow sections and metal bars to be customized 2015-09-03 15:02:08 -04:00
docs Fix Sphinx error when using Python 2 2015-10-02 21:34:08 -04:00
library Pass virtual_identity by reference 2015-10-03 09:27:24 -04:00
package Add hack/libs to DYLD_LIBRARY_PATH on OS X 2015-08-25 14:17:45 -04:00
plugins Replace translate_socket_error() implementations with DescribeError() 2015-10-03 10:37:48 -04:00
reversing Properly handle the variety of exception handlers that MSVC 2010 generates 2012-03-03 14:14:31 -06:00
scripts Suggest --init flag in missing-submodule messages 2015-10-02 16:59:50 -04:00
travis Add linter to check scripts are in readme, pass it 2015-09-23 15:25:41 +10:00
.gitignore Autogenerate include-all.rst for scripts so that script documentation can be entirely encapsulated in lua files without updating anything else. 2015-09-27 02:45:11 -04:00
.gitmodules Fix .gitmodules. 2015-09-21 20:38:31 -04:00
.travis.yml Clean up .travis.yml 2015-09-26 20:05:32 -04:00
CMakeLists.txt Consolidate licenses of other dependencies 2015-10-03 13:42:03 -04:00
LICENSE Consolidate licenses of other dependencies 2015-10-03 13:42:03 -04:00
NEWS Add a function to find viewscreens (or parents) of a given type 2015-10-02 21:50:55 -04:00
README.html Final documentation changes 2015-09-26 16:50:02 +10:00
README.rst Consolidate binpatch docs. Closes #546 2015-09-26 12:28:09 +10:00
dfhack.init-example Comment out roses-init (shouldn't be run from dfhack.init). 2015-09-26 18:06:24 -04: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 `plugins/workflow` or `plugins/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 <scripts/modtools>`
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 <license>`, contributions are welcome.


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

.. _`docs folder`: ./docs

User Manual:

.. toctree::
   :maxdepth: 2

   docs/Core
   docs/Plugins
   docs/Scripts

Other Contents:

.. toctree::
   :maxdepth: 1

   docs/Authors
   docs/Licenses
   docs/Changelog

For Developers:

.. toctree::
   :maxdepth: 1

   docs/Contributing
   docs/Compile
   docs/Lua API
   library/xml/SYNTAX
   docs/Binpatches