GCgames

This page documents the GCgames Schema

Data Definition

| Top |

Each GCgames collection is a standard XML Document defined as

<?xml version="1.0" encoding="UTF-8"?>
  <!--Collection Element-->
    <!--Information Element-->
    <!--1 Or More Item Elements-->
  <!--End Collection Element-->

Collection Element

The collection type is declared as:

  <collection type="GCgames" items="1" version="1.4.3">
    <!--Information Element--->
    <!--1 or More Item Elements-->
  </collection>

Collection Attributes

Key	Type	Description
type	text	The Collection Type. For a GCGames collection this should be “GCgames”
items	number	The Number of Items associated with this collection
version	double/number	The Version of GCStar that created this collection

Information Element

As the above comment implies between the <collection> tag there is an Information Element which is defined as such:

 <information>
  <!--Information elements-->
 </information>

Information Elements

Key	Type	Description
maxID	number	The ID Attribute of the last Item Element

Item Element

Finally the collection then consists of 1 or more Items as defined below:

<item
  id=""  ean=""  name=""
  boxpic=""  backpic=""  platform=""
  players=""  editor=""  developer=""
  released=""  web=""  rating=""
  case=""  manual=""  added=""
  completion=""  location=""  executable=""
  screenshot1=""  screenshot2=""  borrower=""
  lendDate=""  favourite=""
>
  <!--Item Elements-->
</item


 Item Attributes


	
		 Key          Type             Description 
	
	
		id           number           Unique ID for this item to this collection
	
	
		ean          number           ??? (Perhaps the ISBN?)
	
	
		name         text             Name of the Game
	
	
		boxpic       image/text       FQP or Relative Path to Box Picture
	
	
		backpic      image/text       FQP or Relative Path to Box Back Picture
	
	
		platform     text             Platform Name
	
	
		players      number           Number of Players
	
	
		editor       text             Editor (??? Perhaps the Publisher?)
	
	
		developer    text             Developer
	
	
		released     date/text        Release Date in Unknown format (Appears to be free form, program sometimes uses DD/MM/YYYY format?)
	
	
		web          text             Web Page Link (not editable from program? but if manually added appears to enable ‘Web page’ Button)
	
	
		rating       number           Integer in the range 0-10 representing number of stars. (See NOTES)
	
	
		case         boolean/number   Case Check Box. 0 unchecked 1 checked
	
	
		manual       boolean/number   Instructions Manual Check Box. 0 unchecked 1 checked
	
	
		added        date/text        Add Date (dated added to collection). Free form/(DD/MM/YYYY) See NOTES.
	
	
		completion   double/number    Completion Percentage, Double value
	
	
		location     text             Location of the Item
	
	
		executable   text             FQP to the game executable
	
	
		screenshot1  image/text       FQP or Relative Path to Screen Shot 1 Image
	
	
		screenshot2  image/text       FQP or Relative Path to Screen Shot 2 Image
	
	
		borrower     iteration/text   Current Borrower Name (See NOTES)
	
	
		lendDate     date/text        Lend Date (date lent to borrower) Free form, program defaults DD/MM/YYYY
	
	
		favourite    boolean/number   Favourite Tag Check Box. 0 unchecked 1 checked
	



NOTES 

	 Rating 
		 Doubles (EX a rating of 8.5) are treated as whole numbers rounded up. Negative values are treated as a zero rating. A rating of 10+ is treated as 10.
	 Add Date 
		 Free form date format, however ‘Select’ will insert a date in DD/MM/YYYY format.
	 Completion 
		 Double values are rounded up to the nearest Tenth (.1)
	 borrower 
		 This Borrower is cross referenced to the borrowers attribute of GCstar.conf





Item Elements


	
		 Key          Type                                     Description 
	
	
		description  text                                     Game Description Field from the General tab. 
	
	
		comments     text                                     Comments Field from the Details Tab. 
	
	
		secrets      text                                     Secrets Field from the Tips Tab.
	
	
		genre        genre object           Genre Listing on the General Tab.
	
	
		code         code object             Code Listing on the Tips Tab.
	
	
		unlockable   unlockable object Unlockables listing on the Tips Tab.
	
	
		borrowings   borrowings object Lending History on the Lending Tab.
	
	
		tags         tags object             Tags Listing from the Tags Tab.

Example