This is a rewrite of (rodw/age)[https://github.com/rodw/age] from coffeescript to TypeScript. Mostly it is the same but with some notable changes:
- Renamed all methods from snake_case to camelCase
- Achievement Rules are evaluated on event received rather than on
getPlayerAchievments
- Achieved Achievements are also added to the
player.history
- Transient rules are not yet implemented
- History entries are objects with a timestamp Date, and Achievements have an
achieved
Date - Methods return values rather than replying on Node style callbacks with errors
npm install @chromeq/age
For a detailed example of how to use the AGE framework, visit the base project example docs.
Clients must:
- Initialise the GameEngine and register players. Further Docs
import { GameEngine } from '@chromeq/age';
// Create a new instance of the gamification engine
const engine = new GameEngine();
// Register the "player" -- any object that contains at least an `id`
const player = { id: 123 };
engine.addPlayer(player);
- Define achievement rules which define conditions that players must meet in order to earn the corresponding achievement. Further Docs
const rule = new AchievementRule({
key: 'SessionCount',
multiplicity: 1,
transient: false,
predicate: (player, engine) => {
return sessionCount > 3; // Any logic required to evaluate to `boolean`
},
});
// Add the achievemt rule to the engine -- Can also be defined first and provided to the GameEngine constructor
engine.addAchievementRule(rule);
- Publish events that represent actions or events that add to a player's event history.
// Add an event that happens -- Also has alias `trigger`, `triggerEvent`, `dispatch` or `dispatchEvent`
engine.addEvent(player, 'SessionCount'); // TODO: Add extra data to the event
- Subscribe to events or achievements
// Subscribe to `'achievement-achieved'` or `'event-occurred'` -- Also has alias `listen`, `addListner` or `addEventListner`
engine.on('event-occurred', async (player, event) => {
// Useful to "chain" events and you can call `engine.addEvent` again here
console.log('EVENT OCCURRED', player, event);
});
engine.on('achievement-achieved', async (player, achievement) => {
// Congrats 🎉 - Show the appropriate UI or save state
console.log('ACHIEVEMENT ACHIEVED', player, achievement);
});