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

| Top |

An Example Game Collection with 1 Game Item

<?xml version="1.0" encoding="UTF-8"?>
<collection type="GCgames" items="1" version="1.4.3">
 <information>
  <maxId>1</maxId>
 </information>
 <item
  id="1"
  ean="014633098563"
  name="Left 4 Dead"
  boxpic="BoxArt/Left4Dead.jpg"
  backpic="BackBoxArt/Left4DeadBack.jpg"
  platform="Xbox 360"
  players="1"
  editor="Electronic Arts"
  developer="Valve"
  released="November 17, 2008"
  web="http://www.amazon.com/exec/obidos/tg/stores/detail/-/videogames/B000QY9C90/058-3645202-9681409##Amazon (US)"
  rating="10"
  case="1"
  manual="1"
  added="07/06/2009"
  completion="35.2"
  location="Game Bookshelf"
  executable="No Executable"
  screenshot1="ScreenShot/Left4Dead_ScreenShot_1.jpg"
  screenshot2="ScreenShot/Left4Dead_ScreenShot_2.jpg"
  borrower="none"
  lendDate="18/06/2009"
  favourite="1"
 >
  <description>Amazon.com Product Description
 
  Set in a modern day survival-horror universe, the co-operative gameplay of Left 4 Dead (L4D).</description>
  <comments>Left 4 Dead 2 comes out Holiday 2009!</comments>
  <secrets>Playing in Co-op makes this game 200x more fun!</secrets>
  <genre>
   <line>
    <col>Action</col>
   </line>
   <line>
    <col>Comedy</col>
   </line>
   <line>
    <col>Horror</col>
   </line>
  </genre>
  <code>
   <line>
    <col>Left Right Left Right Up Down X B A Y</col>
    <col>At Game Screen. Full Health</col>
   </line>
   <line>
    <col>Left Right Left Right Up Down X B A Left</col>
    <col>At Game Screen. Unlimited Ammo</col>
   </line>
  </code >
  <unlockable>
   <line>
    <col>NO-ONE LEFT BEHIND</col>
    <col>Beat a campaign with all 4 Survivors.</col>
   </line>
   <line>
    <col>HELPING HAND</col>
    <col>Revive 50 incapacitated Survivors.</col>
   </line>
  </unlockable>
  <borrowings>
   <line>
    <col>Nobody</col>
    <col>01/06/2009</col>
    <col>07/06/2009</col>
   </line>
   <line>
    <col>Unknown</col>
    <col>07/06/2009</col>
    <col>14/06/2009</col>
   </line>
   <line>
    <col>John</col>
    <col>14/06/2009</col>
    <col>21/06/2009</col>
   </line>
  </borrowings>
  <tags>
   <line>
    <col>Game of the Year</col>
   </line>
   <line>
    <col>Players Choice 2008</col>
   </line>
   <line>
    <col>Movie of the Year</col>
   </line>
  </tags>
 </item>
</collection>

NOTE Due to DokuWiki limitations the </code > tag should read as </code> (no spaces).

 
en/schemas/gcgames.txt · Last modified: 04/02/2010 06:56 by 82.242.222.234



Should you have a problem using GCstar, you can open a bug report or request some support on GCstar forums.