Volity Wiki: Volity Metadata Terms

These are the terms which exist in the Volity vocabulary of metadata. (For other metadata vocabularies used in Volity files, see Dublin Core and game metadata terms.)

The namespace of these terms is http://volity.org/protocol/metadata. We recommend that you use volity: as the XML namespace prefix, but this is not required.

Vocabulary

For both UI and resource files:

description-url: The URL of a web page containing more information about the UI.
version: A number describing the UI or resource. (The actual UI package which contains this metadata. This is not the version of the ruleset or the referee.)
requires-ecmascript-api: The version specification of the ECMAScript API which this UI requires.
requires-resource: A resource URI which this file requires. (Yes, resource files may require other resource files.) This may be followed by a fragment giving the version specification which is required.

For UI files:

ruleset: The ruleset URI. This may be followed by a fragment giving the version specification which this UI requires. If the UI supports multiple rulesets, there should be multiple ruleset metadata lines (each with its own version spec).
seat-color: A color to associate with one seat. This should be a string of the form seatid #color, where seatid is a seat ID and color is a three- or six-digit hex string. (Thus: "red #F00" or "italy#80FF00".) You should provide one seat-color entry for each seat (if it makes sense to color-code seats at all). Colors should be maximally saturated; white and black colors should be pure.

For resource files:

provides-resource: The resource URI. This may be followed by a fragment giving the version number which this resource provides.

Sample SVG Metadata Element

  <metadata
    xmlns:volity="http://volity.org/protocol/metadata">
    <volity:description-url>http://volity.org/games/glotz/ui/credits.html</volity:description-url>
    <volity:ruleset>http://volity.org/games/glotz#2.5,3-4</volity:ruleset>
    <volity:version>1.5.0</volity:version>
    <volity:requires-ecmascript-api>5</volity:requires-ecmascript-api>
  </metadata>