v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

v0.31:XML dump

From Dwarf Fortress Wiki
Revision as of 21:13, 24 July 2010 by Bryan Derksen (talk | contribs) (this is pretty incomplete right now, I just started by culling examples out of a pocket world's history. Probably lots of rare cases that I haven't seen.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

An XML dump of a world's history can be generated from Legends mode.

The XML file this produces is currently not well-formed, lacking a root element that encapsulates the other contents of the dump. Some XML manipulation programs may need to have this taken into account to handle the file properly.

The XML dump consists of the following elements:

regions

Each dump contains one <regions> element, which contains a large number of <region> elements. Each <region> element has the following attributes stored as elements within it:

  • id - a reference number used to identify the region elsewhere
  • name - the name of the region (eg, "the colorless desert" or "the perplexing forests"). The names are all lower-case.
  • type - the type of region. Types include:
    • Ocean
    • Hills
    • Desert
    • Forest
    • Mountains
    • Glacier

underground_regions

Similar to the <regions> element. The <underground_region> elements contain the following:

  • id - reference number used to identify the region
  • type - can be:
    • cavern
    • magma
    • underworld
  • depth

Note that underground regions don't have names.

sites

Each <site> element contains the following:

  • id - reference number
  • name
  • type
    • city
    • tree city
    • cave
    • dwarf fortress
  • coords - an X, Y coordinate giving the location of the site on the world map.

structures

Each site may contain a <structures> tag.

historical_figures

The <historical_figure> elements contain only the very most basic information:

  • id
  • name

Other information such as birth and death dates are stored in the historical_events element.

entity_populations

Each <entity_population> element contains only a single tag, giving an id number.

entities

Each <entity> element contains an id tag, and may also contain a name tag.

historical_events

The <historical_event> element is the most complex. Each contains:

  • id - a reference number
  • year - the year in which the event took place
  • seconds72 -
  • type - a label indicating what sort of event this is.

The other elements of the historical_event will depend on the contents of the type element. Types include:

change hf state

  • state - tells what state the historical figure is changing to.
    • wandering
    • scouting
    • settled
    • hunting
    • refugee
  • hfid - ID number of the historical figure whose state is changing
  • site_id
  • subregion_id
  • feature_layer_id
  • coords

add hf site link

  • site_id

remove hf site link

  • site_id

add hf hf link

  • hfid
  • hfid_target

hf travel

  • group_hfid
  • site_id
  • subregion_id
  • feature_layer_id
  • coords

May also include a <return/> tag.

change hf job

  • hfid
  • site_id
  • subregion_id
  • feature_layer_id

hf new pet

  • group_hfid
  • site_id
  • subregion_id
  • feature_layer_id
  • coords

hf wounded

  • woundee_hfid
  • wounder_hfid
  • site_id
  • subregion_id
  • feature_layer_id

creature devoured

  • site_id
  • subregion_id
  • feature_layer_id

hf died

  • hfid - the historical figure who died
  • slayer_hfid - the historical figure who slew him
  • slayer_item_id - -1 if no notable item was used
  • slayer_shooter_item_id - -1 if no notable item was used
  • site_id - -1 if not killed at a site
  • subregion_id
  • feature_layer_id
  • cause - causes include:
    • shot
    • struck
    • dragonfire

hf simple battle event

  • subtype
    • attacked
    • scuffle
    • confront
    • ambushed
    • 2 lost after receiving wounds
  • group_1_hfid
  • group_2_hfid
  • site_id
  • subregion_id
  • feature_layer_id

field battle

  • attacker_civ_id
  • defender_civ_id
  • subregion_id
  • feature_layer_id
  • coords
  • attacker_general_hfid
  • defender_general_hfid

created structure

  • civ_id
  • site_civ_id
  • site_id
  • structure_id

hf razed structure

  • hist_fig_id
  • site_id
  • structure_id

historical_event_collections

historical_eras

Each <historical_era> element contains a name and a start_year element.