Skip to content

Commit

Permalink
move update instructions, add basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PeridexisErrant committed Nov 2, 2015
1 parent dc76bf4 commit d448f6a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#DF-structures

DF-structures is the core information on which
[DFHack](https://github.com/DFHack/dfhack) depends.

For information on how to understand this format,
see [./SYNTAX.rst](./SYNTAX.rst). For how to update
for a new version of DF, see
[./how-to-update.rst](./how-to-update.rst)

Originally dfhack used a file called ``Memory.xml``
to describe data structures of the game. It explicitly
listed addresses of known global variables, and offsets
within structures to fields, not unlike the ini files
used by Dwarf Therapist.

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

This format instead represents data structure layout
purely 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.
File renamed without changes.

0 comments on commit d448f6a

Please sign in to comment.