8bitology API - Achievements

Overview

Like applications, achievements are usually registered via the website. Once an achievement is registered it can be used within a game. When an achievement is registered a secret achievement id is emailed to the developer for future reference.

Achievement Usage

This secret achievement id should be embedded within the game to trigger the reaching of an achievement using the achievement_setvalue function. Achievements can be given either a boolean (true or false) or a numeric value. An example of a boolean achievement could be 'Became a 10th Level Wizard'. An example of a numeric achievement could be 'Percentage of Game Completion' or simply 'High Score'.

If your game wants to list achievements, they can be fetched with the achievement_alllist function.

Achievement Management API functions.

function: achievement_add
parameters: <secretuid>, <secretaid>, <name>
response: <secretrid> or <error>, email sent
description: Add a new achievement.

function: achievement_delete
parameters: <secretuid>, <secretrid>
response: true or false
description: Remove an achievement.

General Achievement Management API functions.

function: achievement_alllist
parameters: <secretuid>, <aid>, <offset>, <limit>
response: list of <name>, <value>, <votes>
description: Lists all achievements for an app.

function: achievement_setvalue
parameters: <secretuid>, <rid>, <value>
response: true or false
description: Set selfs achievement value (*usually updated by a app).

function: achievement_votedown
parameters: <secretuid>, <uid>, <rid>
response: true or false
description: Vote an achievement down.

function: achievement_voteup
parameters: <secretuid>, <uid>, <rid>
response: true or false
description: Vote an achievement up.