zylom RSS modules
v2.5, Tue, January 9, 2007; by Jean-Pierre Deckers
RSS modules that adds elements at both the <channel> as the <item> level, as used for the zylom games
Copyright
Copyright © 2004-2007 by Zylom.
Permission to use, copy, modify and distribute the zylom RSS module specification and its accompanying documentation for any purpose and without fee is hereby granted in perpetuity, provided that the above copyright notice and this paragraph appear in all copies. The copyright holders make no representation about the suitability of the specification for any purpose. It is provided "as is" without expressed or implied warranty.
This copyright applies to the zylom RSS module specification and accompanying documentation and does not extend to the RSS format itself. Please contact Jean-Pierre for more info.
Change Notes
09/01/07 by EH -- v2.5, added standard pubDate element with the game launchdate to both the web- and deluxefeed
28/06/06 by JPD -- v2.4, added category & categoryid to deluxe feeds as well.
30/05/06 by JPD -- v2.3, added optional longdescription and advantages to deluxe feed. Added downloadscript and downloadlink for javascript download-dialog.
31/03/05 by JPD -- v2.2, added skinnedgameid to the webgames feed.
10/11/04 by JPD -- v2.1, added optional help and longdescription to webfeed.
07/07/04 by JPD -- v2.0, added deluxegameid to webgames feed, added a new deluxegames-feed
25/03/04 by JPD -- v1.2, added category & categoryid
23/03/04 by JPD -- v1.1, added gameid
15/03/04 by JPD -- v1.0, RFC, Initial proposal.
Description
To allow partners to construct their own pages, while still maintaining the flexibility of the gamelist and realtime player-numbers, zylom has implemented XML-feeds, based upon the RSS 2.0 - specification. This documents describes the zylom RSS module-extension.
Note: Partners are strongly encouraged to cache the feed according to the ttl-parameter!
Zylom has defined 2 different feeds, a webgames-feed and a deluxe games-feed.
Namespace declaration
xmlns:zylom="http://www.zylomgames.com/rss/"
Model - Webgames
- <channel> elements:
- <zylom:javascript> : defines the javascript call to use for opening the popup. A link for a game has to be opened using this javascript!
- <zylom:totalplayers> : total number of players in the games.
- <item> elements:
- <zylom:gameid> : unique id per game
- <zylom:skinnedgameid> : unique id per game in a specific language
- <zylom:categoryid> : categoryid for the game. The category-tag is also set, but partner are strongly encouraged to use the categoryid for internal use.
- <zylom:shortdescription> : short(er) description for a game, around 100 characters max.
- <zylom:largeimage> : large image for the game. Required attributes are url, width and height.
- <zylom:smallimage> : small image for the game. Required attributes are url, width and height.
- <zylom:players> : number of players in the game.
- <zylom:help> : small helptext for the game (optional element, v2.1)
- <zylom:longdescription> : full HTML-formatted description for the game (optional element, v2.1)
- <zylom:deluxegameid> : id of the deluxe version(s) of the webgame (optional element)
Example - Webgames
Here's an RSS file that implements all the elements of the zylom webgames module.
Model - Deluxe games
- <channel> elements:
- <zylom:downloadscript> : location of the javascript required to have javascript-download dialogs.
- <item> elements:
- <zylom:deluxegameid> : deluxe game id, not unique (more than 1 deluxe version might exist of the same game). Used for binding with webgames.
- <zylom:downloadgameid> : unqiue id for the deluxe game
- <zylom:categoryid> : categoryid for the game. The category-tag is also set, but partner are strongly encouraged to use the categoryid for internal use.
- <zylom:downloadlink> : link for javascript-download dialog. Use standard link-element for linking directly to .exe
- <zylom:registerlink> : link to the buy-page Depricated, do not use!
- <zylom:infolink> : link to an overview page, with more information about the game
- <zylom:price> : local price (formatted)
- <zylom:largeimage> : large image for the game. Required attributes are url, width and height.
- <zylom:smallimage> : small image for the game. Required attributes are url, width and height.
- <zylom:longdescription> : longer description for the game (optional element, v2.3)
- <zylom:advantages> : container for <zylom:advantage>-items (optional element, v2.3)
- <zylom:advantage> : advantage description of deluxe version (optional element, v2.3)
Example - Deluxe games
Here's an RSS file that implements all the elements of the zylom webgames module.