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
• Source code (important: read Compiling DFHack before attempting to build from source)
• Bay 12 forums thread
• Bug tracker

User Manual

• Introduction and Overview
  • Getting started
  • Troubleshooting
• Installing DFHack
  • Requirements
  • Downloading DFHack
  • Installing DFHack
  • Uninstalling DFHack
  • Upgrading DFHack
  • Pre-packaged DFHack installations
• DFHack Core
  • Command Implementation
  • Using DFHack Commands
  • Built-in Commands
  • Init Files
  • Environment variables
  • Miscellaneous Notes
• DFHack Plugins
  • Data inspection and visualizers
  • Bugfixes
  • UI Upgrades
  • Job and Fortress management
  • Map modification
  • Mods and Cheating
  • Lua API
• DFHack Scripts
  • Basic Scripts
  • Development Scripts
  • Bugfixing Scripts
  • GUI Scripts
  • Scripts for Modders
• About DFHack
  • Changelog
  • List of Authors
  • Licenses
  • Removed tools
• 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