dfhack/index.rst

37 lines
1011 B
ReStructuredText

##################################
2015-09-22 01:42:15 -06:00
Welcome to DFHack's documentation!
##################################
2015-09-22 01:42:15 -06:00
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>`
2023-01-15 00:56:30 -07:00
* `quickstart`
* `Getting help <support>`
* :source:`Source code <>`
(**important:** read `building-dfhack-index` before attempting to build from source.)
User Manual
===========
2015-09-22 01:42:15 -06:00
.. toctree::
:maxdepth: 2
/docs/Introduction
2023-01-15 00:56:30 -07:00
/docs/Quickstart
/docs/Installing
/docs/Core
/docs/Tools
/docs/guides/index
2022-11-30 04:59:26 -07:00
/docs/dev/index
2022-11-30 04:34:40 -07:00
/docs/about/index