UOX3 Data definitions

UOX3 uses a consistent manner in which all text data is described.  Data follows the format:

• KEY  TYPE ID
• {
• TAG =value(,...)
• }

Comments are distinguished by the identifier "//". Any text following the identifier on the line is ignored  KEY is a description to the server on what function the following section serves.  TYPE is the subject that the description acts on (describes the "type" of the section).  And ID is a unique identifier for that section of type TYPE.  Unknown keys/types are ignored by the server. 

Tags are markers identifying different data elements to the server for a given section.  Unknown tags are ignored.  A tag can be multi valued. If multi valued, the separate value items are marked by the "," separator.  If no value is required, then the = is not present.  A @ in the value, indicates the value represents a section ID (The section type is dependent on the tag itself)

KEYs -- Valid keys recognized by the server

• DATA - Identifies the following section as a data section.  Used primarily to describe data items by the shard operator to the server (scp files), and is also present in the saved world files.
• EDIT - Identifies the following section as an edit section.  This instructs the server to update the data section of type TYPE, with id ID, with the enclosed tag values). This key is only present in world save files.
• ADD - Identifies the following section as an add section.  Present only in world save files, this key instructs the server to add the following section to the world.  It identifies the section has been added to the world, after the last transaction save.
• DELETE - Identifies the following section as a delete section.  Present only in world save files, this key instructs the server to delete the following section from the world.  It identifies the section has been deleted from the world since the last transaction save.

TYPEs -- Valid types recognized by the server

• CONFIGURATION

  Configuration sections inform the server basic operation information. Unlike many sections, the ID 's are not user defined, but strictly interpreted by the server.  The following  valid IDS for this section type are:

  • NETWORK

    TAG	#VALUES	Allowed values	Note

   

  • DIRECTORY

    TAG	#VALUES	Allowed values	Note

   

  • SHARD

    TAG	#VALUES	Allowed values	Note

• CATEGORY

  TAG	#VALUES	Allowed values	Note

• NPC

  TAG	#VALUES	Allowed values	Note
  NAME	1	User defined or id of a namelist section	Used to specify the name of the creature. If  @ is present, the value identifies the ID of a NAMELIST section
  TITLE	1	User defined
  ID	2	LBR character id, nonlbr character id	This is a multi value tag.  The first value represents the id of a character, used for third dawn and LBR clients. The optional second value is the secondary id of a character, used as the character id for pre-lbr clients.
  SKIN	1	User defined or id of a skinlist section	Single value tag, used to specify an absolute skin color for the character. IF @ is present, then the value represents the ID of a SKINLIST section
  HAIRCOLOR	1	Color id
  BEARDCOLOR	1	MATCH  or color id for beard	If MATCH,  the hair color is used.
  SAYCOLOR	1	Color id	specifies the color of any speech the npc is capable of.
  EMOTECOLOR	1	Color id	specifies the color of any emotes the npc is capable of.
  DIRECTION	1	N,S,E,W,NE,SW,NW,SE	Initial direction of the NPC
  BACKPACK	0		pecifies whether the npc is carrying a backpack in which to hold items.
  GOLD	2	minimum amount of gold, maximum amount of gold	used to specify how much gold the npc carries within it's backpack.
  ITEM  (can be repeated)	2	id of the item, color id or id of colorlist section (if @).	Multi value tag, containing the item id,  color id (if @, color picked from  colorlist section ,Used to specify which items are equipped to the npc when it is spawned.
  PACKITEM	3	item id, amount, probability	// Multi value tag, containing the item id,   amount of the item, and probability it is present. Used to specify whether there are any items within the npc's pack, assuming it has one.
  STATS	6		// Multi value tag, representing the following: strength of the npc, hit points this can receive, dexterity of the npc, stamina of the npc, intelligence , and mana.
  KARMA	2		Multi value tag, to represent the minimum and maximum given to the slayer of the npc
  FAME	2		Multi value tag, to represent the minimum and maximum given to the slayer of the npcl.
  CARVE	VARIABLE	item id or section if of CARVE section(if @)

   

• NPCLIST

  TAG	#VALUES	Allowed values	Note
  NPC	2	id ,weight

• ITEMLIST

  TAG	#VALUES	Allowed values	Note
  ITEM	2	id ,weigth

• ITEM

  TAG	#VALUES	Allowed values	Note

• COLORLIST

  TAG	#VALUES	Allowed values	Note

• SPAWNLIST

  TAG	#VALUES	Allowed values	Note

• LOOTLIST

  TAG	#VALUES	Allowed values	Note

• NPCLIST

  TAG	#VALUES	Allowed values	Note

• SHOPLIST

  TAG	#VALUES	Allowed values	Note

• SKINLIST

  TAG	#VALUES	Allowed values	Note

• UNDEADLIST

  TAG	#VALUES	Allowed values	Note

• ORELIST

  TAG	#VALUES	Allowed values	Note

• MIDILIST

  TAG	#VALUES	Allowed values	Note

• SCRIPTLIST

  TAG	#VALUES	Allowed values	Note

• MURDERER

  TAG	#VALUES	Allowed values	Note

• HOUSE

  TAG	#VALUES	Allowed values	Note

• SPIRITSPEAK

  TAG	#VALUES	Allowed values	Note