dfhack/index.rst

##################################
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>`
* `Getting help <support>`
* :source:`Source code <>`
    (**important:** read `compile` before attempting to build from source.)

User Manual
===========

.. toctree::
   :maxdepth: 2

   /docs/Introduction
   /docs/Installing
   /docs/Core
   /docs/Tools
   /docs/guides/index
   /docs/index-dev
   /docs/index-about
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline. 2015-10-27 17:06:28 -06:00			`##################################`
Standard basic sphinx setup 2015-09-22 01:42:15 -06:00			`Welcome to DFHack's documentation!`
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline. 2015-10-27 17:06:28 -06:00			`##################################`
Standard basic sphinx setup 2015-09-22 01:42:15 -06:00
Update intro, fix bay12 link, shorten index, add quick links section 2020-07-11 21:50:51 -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.`
Clean up other docs to match Some deduplication in Scripts and Plugins, links in NEWS, add content and link to files in index. 2015-11-05 06:59:48 -07:00
Update intro, fix bay12 link, shorten index, add quick links section 2020-07-11 21:50:51 -06:00			`.. _quick-links:`
Clean up other docs to match Some deduplication in Scripts and Plugins, links in NEWS, add content and link to files in index. 2015-11-05 06:59:48 -07:00
Update intro, fix bay12 link, shorten index, add quick links section 2020-07-11 21:50:51 -06:00			`Quick Links`
			`===========`
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable. 2015-09-22 07:30:22 -06:00
Update intro, fix bay12 link, shorten index, add quick links section 2020-07-11 21:50:51 -06:00			* `Downloads <https://www.github.com/DFHack/dfhack/releases>`_
			* `Installation guide <installing>`
get rid of tool TOC, use genindex also add a stub role for dfhack-tag 2022-07-22 10:56:23 -06:00			* `Getting help <support>`
			* :source:`Source code <>`
			(important: read `compile` before attempting to build from source.)
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable. 2015-09-22 07:30:22 -06:00
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline. 2015-10-27 17:06:28 -06:00			`User Manual`
			`===========`
Standard basic sphinx setup 2015-09-22 01:42:15 -06:00
			`.. toctree::`
			`:maxdepth: 2`

Fix compile, intro, scripts - script-syntax.py now exits with 1 instead of silently catching the error if lua or ruby are missing - index paths are absolute (from the repo root) - less strong suggestion for third-party packs - re-added lua-example and test-perlin doc - corrected and clarified Compile some more 2015-11-05 22:58:58 -07:00			`/docs/Introduction`
Move installation docs to a separate document and expand 2020-07-18 01:16:52 -06:00			`/docs/Installing`
Fix compile, intro, scripts - script-syntax.py now exits with 1 instead of silently catching the error if lua or ruby are missing - index paths are absolute (from the repo root) - less strong suggestion for third-party packs - re-added lua-example and test-perlin doc - corrected and clarified Compile some more 2015-11-05 22:58:58 -07:00			`/docs/Core`
organize tags by group, add more info about tools 2022-08-16 00:14:50 -06:00			`/docs/Tools`
Add user guides section to main toctree 2020-10-01 20:17:53 -06:00			`/docs/guides/index`
Move general dev info to a separate doc (Dev-intro) 2020-07-08 20:52:20 -06:00			`/docs/index-dev`
get rid of tool TOC, use genindex also add a stub role for dfhack-tag 2022-07-22 10:56:23 -06:00			`/docs/index-about`