Repository files navigation

DF-structures is the core information on whichDFHack depends.

For information on how to understand this format,see./SYNTAX.rst. For how to updatefor a new version of DF, seenew-release-processing.rst

Originally dfhack used a file calledMemory.xmlto describe data structures of the game. It explicitlylisted addresses of known global variables, and offsetswithin structures to fields, not unlike the ini filesused by Dwarf Therapist.

However, as the number of known fields and objects grow,maintaining the explicit offset lists quickly becomesdifficult, error prone, and inefficient.

This format instead represents data structure layoutpurely via listing all fields in the correct order,exactly like a structure definition does in the C++language itself. There is still a file with numeric data,but it only contains absolute addresses of global objects.