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

• Quickstart guide

• Getting help

• Source code

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

User Manual

• Introduction and overview
  • Getting started
  • Getting help
• Quickstart guide
  • What is DFHack?
  • What can I do with DFHack tools?
  • How can I figure out which commands to run?
  • What if I don’t want to be tempted by god-mode tools?
  • How do DFHack in-game windows work?
  • Where do I go next?
• Installing
  • Requirements
  • Downloading DFHack
  • Installing DFHack
  • Uninstalling DFHack
  • Upgrading DFHack
• DFHack Core
  • Command implementation
  • Using DFHack commands
  • Configuration files
  • Commandline options
  • Environment variables
  • Core preferences
  • Performance monitoring
• 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 modding guide
  • Quickfort blueprint library
  • Quickfort blueprint creation guide
• DFHack development guide
  • DFHack development overview
  • Building DFHack
  • How to contribute to DFHack
  • DFHack documentation system
  • DFHack API concepts
  • DFHack Lua API Reference
  • DFHack overlay dev guide
  • DF data definitions (DF-structures)
  • DFHack Data Identity System
  • Memory research
  • Patching the DF binary
  • DFHack remote interface
  • Development changelog
• About DFHack
  • List of authors
  • Licenses
  • Removed tools
  • Changelog