MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack fork
6,409 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 780a9f3677 Internal links and link targets, formatted tables 
* Enabled internal links; a phrase in backticks is linked to the
corresponding link target and turns into the corresponding title.
* Linked all existing references in Scripts.rst
* Created corresponding link targets
* Fixed formatting of some tables of arguments.
 		2015-09-26 12:28:03 +10: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 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 Internal links and link targets, formatted tables 2015-09-26 12:28:03 +10:00
library Update XML. 2015-09-25 19:43:14 -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 Whitespace, syntax. 2015-09-25 19:13:22 -04:00
travis Add linter to check scripts are in readme, pass it 2015-09-23 15:25:41 +10:00
.gitignore Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
.gitmodules Fix .gitmodules. 2015-09-21 20:38:31 -04:00
.travis.yml Update travis. 2015-09-25 19:15:21 -04:00
CMakeLists.txt BUILD_DOCS should be a visible CMake option. 2015-09-25 19:43:40 -04:00
LICENSE Replace jsonxx with jsoncpp 2015-07-29 15:50:33 -04:00
NEWS NEWS markup for titles; changelog entries linkable 2015-09-23 15:44:00 +10:00
README.html Add top-level redirect page for the docs 2015-09-23 10:17:25 +10:00
README.rst Include changelog and licenses in generated docs 2015-09-23 11:03:26 +10:00
dfhack-icon.png Ubuntu packaging magic, forgotten header files, an icon. 2011-03-19 23:26:32 +01:00
dfhack.init-example Include all Roses' scripts. 2015-09-25 17:41:25 -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 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!


User Manual:

.. toctree::
   :maxdepth: 2

   docs/Readme
   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