dfhack

dfhack fork

Go to file

lethosor c44ac8ec6e Improve handling of fatal errors and errors in dfhack.lua * Several fatal errors that occurred during core initialization didn't stop initialization or set 'errorstate' properly, which caused update hooks and other code to crash later. This has been fixed and should address crashes like the one mentioned in #470. * Errors when loading dfhack.lua now cause Lua::Open() to fail, which triggers a fatal error in Core::Init() * Failure to initialize the console no longer results in a call to fatal() (since it didn't actually stop initialization previously)		2015-10-17 21:18:04 -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	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	Update Lua API.rst	2015-10-17 15:45:49 -04:00
library	Improve handling of fatal errors and errors in dfhack.lua	2015-10-17 21:18:04 -04:00
package	Add hack/libs to DYLD_LIBRARY_PATH on OS X	2015-08-25 14:17:45 -04:00
plugins	Improve handling of fatal errors and errors in dfhack.lua	2015-10-17 21:18:04 -04:00
reversing	Properly handle the variety of exception handlers that MSVC 2010 generates	2012-03-03 14:14:31 -06:00
scripts	Fix whitespace	2015-10-13 21:31:14 -04:00
travis	travis/all.py: Avoid actually building DFHack	2015-10-13 21:31:37 -04: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	travis: Increase number of parallel builds	2015-10-03 16:08:13 -04:00
CMakeLists.txt	Require MSVC 2010 on Windows	2015-10-13 16:25:38 -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