##################################
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/Support
   /docs/Core
   /docs/guides/index
   /docs/index-about
   /docs/index-dev

Tools
=====

DFHack commands, plugins, and scripts are grouped by tags to make it easier to
find groups of related tools.

.. note::
    In order to avoid user confusion, as a matter of policy all GUI tools
    display the word :guilabel:`DFHack` on the screen somewhere while active.

    When that is not appropriate because they merely add keybinding hints to
    existing DF screens, they deliberately use red instead of green for the key.

.. toctree::
   :maxdepth: 1

   /docs/Tags
   /docs/index-tools