forked from DFHack/df-structures
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move update instructions, add basic readme
- Loading branch information
1 parent
dc76bf4
commit d448f6a
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.