# Welcome to DFHack’s documentation!

DFHack is a memory editing library for Dwarf Fortress 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

- Downloads

- Installation guide

- Getting help

- Source code

    (important: read Compiling DFHack before attempting to build from source.)

## User Manual

- Introduction and overview
  - Getting started
  - Getting help
- Installing DFHack
  - Requirements
  - Downloading DFHack
  - Installing DFHack
  - Uninstalling DFHack
  - Upgrading DFHack
  - Pre-packaged DFHack installations
  - Linux packages
- DFHack Core
  - Command implementation
  - Using DFHack commands
  - Configuration files
  - Environment variables
  - Miscellaneous notes
- DFHack tools
  - What tools are and how they work
  - Finding the tool you need
  - DFHack tools by game mode
  - DFHack tools by theme
  - DFHack tools by what they affect
  - All DFHack tools alphabetically
- User guides
  - DFHack config file examples
  - DFHack modding guide
  - Quickfort blueprint library
  - Quickfort blueprint creation guide
  - Quickfort keystroke alias reference
- DFHack development guide
  - DFHack development overview
  - How to contribute to DFHack
  - Compiling DFHack
  - Development changelog
  - DFHack Lua API
  - DFHack remote interface
  - DFHack API reference
  - DFHack documentation system
  - DF data definitions (DF-structures)
  - Memory research
  - Patching the DF binary
- About DFHack
  - Changelog
  - List of authors
  - Licenses
  - Removed tools