dfhack fork
 
 
 
 
 
 
Go to file
PeridexisErrant a3803d340e Build docs in place; copy inputs so users can build
Building the docs now works the same way, no matter when it happens - in
a cloned repo or distributed version.

This means all the relative links keep working; and that users or
downstream distributors can rebuild the docs with extra scripts or .rst
files in place.

Finally, it eliminates a large number of potential bugs which only occur
in one build environment and are difficult to reproduce.

Also add headings and this work to future news.
2015-10-24 22:19:52 +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 Build docs in place; copy inputs so users can build 2015-10-24 22:19:52 +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 Explain script type at top of listing 2015-10-24 17:41:21 +11:00
travis Updated docs linter for scripts 2015-10-24 17:00:54 +11: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 Build docs in place; copy inputs so users can build 2015-10-24 22:19:52 +11:00
LICENSE.rst Allow Sphinx-doc to work with or without cmake 2015-10-23 12:34:54 +11:00
NEWS.rst Build docs in place; copy inputs so users can build 2015-10-24 22:19:52 +11:00
README.html Final documentation changes 2015-09-26 16:50:02 +10:00
README.rst Allow Sphinx-doc to work with or without cmake 2015-10-23 12:34:54 +11: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 `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 `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
   LICENSE
   NEWS

For Developers:

.. toctree::
   :maxdepth: 1

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