Game Element (Data)

From HLKitWiki
Revision as of 02:16, 20 February 2009 by Rob (Talk | contribs) (Example)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Context: HL KitKit Reference … Definition File Reference 

The "game" Element

The game system information section defines the name of the game system, the manufacturer, and copyright information. The XML element name is "game" and the complete list of attributes is below.

game Text – Name of the game system. Maximum length is 50 characters.
publisher Text – Name of the manufacturer or publisher of the game system. Maximum length is 50 characters.
website Text – URL of the publisher’s web-site. Maximum length is 100 characters.
copyright (Optional) Text – Appropriate copyright and trademark declaration for the game system and data files. Maximum length is 250 characters. Default: Empty.
legaloutput Text – This is shortened legal text that is inserted at the bottom of all character sheet output. You must provide appropriate copyright and trademark declarations.
manualroot (Optional) Text – Specifies the name of the file to be used as the User Manual for the game system, which is accessible via the Configure Hero form and the Help menu within HL. This should generally be an HTML file. Default: "docs\manual.htm".
editorroot (Optional) Text – Specifies the name of the file used as the manual for working with the Editor when you data files are loaded. Within the Editor, this manual is accessible via the Help menu. This should generally be an HTML file. Default: "docs\editor.htm".

Example

The following example demonstrates what a "game" element might look like. All default values are assumed for omitted optional attributes.

<game
  name="Sample Game Systems"
  publisher="Game Company"
  website="www.gamecompany.com"
  copyright="Copyright 2008 by Game Company. Game XYZ is a trademark of Game Company."
  legaloutput="Copyright 2008 by Game Company.">
  </game>