dfhack/index.rst

36 lines
1.0 KiB
ReStructuredText

##################################
Welcome to DFHack's documentation!
##################################
DFHack is a memory editing library for `Dwarf Fortress <https://www.bay12games.com/dwarves/>`_
that provides a unified, cross-platform environment where tools can be developed
to extend the game. The default distribution contains a variety of tools, including
bugfixes, interface improvements, automation tools, modding tools, and more.
There are also a variety of third-party tools available.
.. _quick-links:
Quick Links
===========
* `Downloads <https://www.github.com/DFHack/dfhack/releases>`_
* `Installation guide <installing>`
* `Source code <https://www.github.com/DFHack/dfhack>`_
(**important:** read `compile` before attempting to build from source)
* `Bay 12 forums thread <https://dfhack.org/bay12>`_
* `Bug tracker <https://www.github.com/DFHack/dfhack/issues>`_
User Manual
===========
.. toctree::
:maxdepth: 2
/docs/Introduction
/docs/Installing
/docs/Core
/docs/Plugins
/docs/Scripts
/docs/index-about
/docs/index-dev