|
PUArcade Module Development Guidelines |
|
Tuesday, 02 December 2008 |
|
If you develop modules for PUArcade, here are a few suggestions so that you maintain compatibility with all the built in PUArcade features. 1. Permissions. Permissions are set on a folder level. Please be sure that your module checks for a users permissions before showing games. You don't want your module displaying games that a user doesn't have rights to access. 2. Publishing. Games, folders, contests, and scores can be published, or unpublished. Please be sure that your module checks for publishing status before displaying any of these things. You don't want your module to show unpublished games, right? 3. Leaderboard. PUArcade includes a function to get the leaderboard for use in modules. Please use this function. It allows you to take advantage of leaderboard caching, including paying attention to the cache refresh interval set in configuration. It also makes sure that your module will have the same results as the component. 4. Functions. Remember that all internal functions of PUArcade are likely to change. Unless we specifically indicate that a function is public (like the leaderboard one above) you should assume that the function could change at any time. This would, of course, break your module. 5. Links. Use SEF friendly URLS (sefreltoabs). Include a gameid, folderid, etc in every link. This makes SEF much more friendly.
If you have any questions about how exactly to do these things, post a question over in the 3rd party forums . |
|
Last Updated ( Tuesday, 02 December 2008 )
|