Grid Cartographer Pro
XML Export Reference Manual
Last Updated: July 1st, 2013
- Document Structure
- Element Reference
- Color Table
- Ground Table
- Marker Table
- Door Table
- Usage Restrictions
Starting with version 1.3.4, users of Grid Cartographer Pro can export maps in an XML based file format for use in game development and other visualization applications.
The purpose of this document is to provide a reference manual for the specific elements and values used in the exported document.
The exported XML document uses the following layout of elements.
Click to go to the relevant section below.
< map >
This is the root container element of the document.
< export >
Provides information about the export process. It has the following attributes.
|from||The version number of Grid Cartographer used to export the document. Usually this takes the form v1.X.X with an optional lower case suffix for bug fix revisions. However, this is an arbitrary string and no specific format is guaranteed.|
|date||The date of export in YYYY-MM-DD format.|
|time||The (local) time of export in HH:MM:SS format.|
|origin||Either "tl" or "bl" which, respectively, specify either a top-left or bottom-left grid origin.|
< region >
This is the container element for the exported floors. Only one region is currently supported.
< floor >
A floor in the region. Contains the tiles and notes you've created.
|index||The number of the floor. Negative values are basements, zero is the ground floor and positive values are the floors above.|
NOTE: A completely empty floor will not be exported. Take care to use the index attribute to correctly identify the floor.
< tiles >
Container for tiles on this floor. If no tiles are present then this element is omitted.
< bounds >
Defines the maximum bound of tiles on this floor.
|x0||The x co-ordinate of the left-most occupied tile on this floor.|
|y0||The y co-ordinate of the top or bottom most occupied tile on this floor as defined by the co-ordinate space specified by the "origin" attribute of the <export> element.|
|width||The number of tiles in each row.|
|height||The number of rows from y0 to the last occupied row on this floor.|
< row >
Contains one row on this floor.
|y||The y co-ordinate of the row in the co-ordinate space specified by the "origin" attribute of the <export> element.|
NOTE: A completely empty row will not be exported. Take care to use the y attribute to correctly identify the row position.
< t >
A single floor tile. Tiles are defined according to this model:
Marker / Custom Tile
The ground tile is rendered below the marker/custom tile in the editor.
A choice of eight colors can be independently applied to both walls and the marker or custom tile. See the color table for more information.
|g||The ground tile used. See the ground table for more information.|
|u||If set then a custom tile marker was used. This is a value from 0 to 255 corresponding to a tile on the custom tile set using the formula: value = column + ( row * 16 ).|
|m||The marker used. See the marker table for more information.|
|c||The color of the marker or custom tile. See the color table for more information.|
|r||The type of wall or door on the right edge of the tile. See the door table for more information.|
|b||The type of wall or door on the bottom edge of the tile. See the door table for more information.|
|rc||The color of the right edge wall or door. See the color table for more information.|
|bc||The color of the bottom edge wall or door. See the color table for more information.|
|d||If set to '1' signifies this tile is 'dark'.|
NOTE: All attributes are optional and if missing should be interpreted as zero.
< notes >
Container element for notes on this floor. If no notes were created then this element is omitted.
< note >
Multiple notes can be added to the floor, one line at a time. This element represents one of those lines. Notes are not stored in an ordered fashion, even those assigned to the same location may appear seperately.
|x||The x co-ordinate of the note.|
|y||The y co-ordinate of the note in the co-ordinate space specified by the "origin" attribute of the <export> element.|
The text itself is stored in a CDATA element inside the note element.
HINT: The target application is free to parse note text in any way it chooses. One example is combining the 'message' marker in a tile with note text to create a message engraved into a floor. Another might be to specify the co-ordinates of the door that a floor switch should open.
Colors specified by the <t> element above.
HINT: The specification of color merely corresponds to how Grid Cartographer renders an element within the editor. You are free to interpret these values to signify any proprietary meaning, or specific color, in the target application.
Ground types specified by the <t> element above.
HINT: The specification of ground type merely corresponds to how Grid Cartographer renders an element within the editor. You are free to interpret these values to signify any proprietary meaning in the target application.
Built-in marker types specified by the <t> element above.
HINT: The specification of marker type merely corresponds to how Grid Cartographer renders an element within the editor. You are free to interpret these values to signify any proprietary meaning in the target application.
Built-in door and wall types specified by the <t> element above.
|5||One Way Door (Left or Up)|
|6||One Way Hidden Door (Left or Up)|
|7||One Way Wall (Left or Up)|
|8||One Way Door (Right or Down)|
|9||One Way Hidden Door (Right or Down)|
|10||One Way Wall (Right or Down)|
|12||Empty Door Frame|
No restrictions (beyond those applied by your own local laws, etc.) are placed on usage of exported data from Grid Cartographer. You are free to use exported data for any purpose, including commercial use.
No acknowledgement that Grid Cartographer was used is required, but would be appreciated :-)