Synopsis

Triumph.js is an open source achievements and rewards library written in TypeScript.

Motivation

The purpose of this library is to provide a simple way to implement achievements and rewards in your app.

Installation

NPM

$ npm install @lcluber/triumphjs

Yarn

$ yarn add @lcluber/triumphjs

Usage

ES6

import { Achievements, Rewards } from '@lcluber/triumphjs';

REWARDS = new Rewards();
REWARDS.add('dbg', 'DOUBLE guns!', 'Start with double gun', 'fighter-jet');
REWARDS.add('emp', 'EMP Boost', 'EMP are 20% bigger','bomb');

ACHIEVEMENTS = new Achievements();

let subAchv = new Achievements();
subAchv.add( "a", "Score novice", "Score 1 000 000 points", 1000000, null, 'crown', null);
subAchv.add( "b", "Score hobbyist", "Score 10 000 000 points", 10000000, null, 'crown', null);
subAchv.add( "c", "Score adventurer", "Score 20 000 000 points", 20000000, null, 'crown', REWARDS.getByName('emp'));

ACHIEVEMENTS.add("pgm", "PGM", "Make high scores", 0, subAchv, 'crown', null);

let subAchv2 = new Achievements();
subAchv2.add( "a", "Survivor novice", "Survive 1 minute", 1, null, 'heartbeat', null);
subAchv2.add( "b", "Survivor hobbyist", "Survive 2 minutes", 2, null, 'heartbeat', null);
subAchv2.add( "c", "Survivor adventurer", "Survive 3 minutes", 3, null, 'heartbeat', REWARDS.getByName('dbg');

ACHIEVEMENTS.add("svv", "Immortal", "Survive as long as possible", 0, subAchv2, 'heartbeat', null);

// activate achievements.
ACHIEVEMENTS.try("svv", 1, 1549104204008); // Activate a previously earned achievement with a timestamp
let msg = ACHIEVEMENTS.try("svv", 3, null); // Test achievement "svv" with the value "3" and return the title of the biggest level earned with this value.

// Check if reward is earned
let reward = REWARDS.getByName('dbg').isActive();

// Export flat array for easy persistence
let userAchvs = ACHIEVEMENTS.export();

// Update achievements with previous Export
userAchvs.forEach(function(uAchv) {
  if (ACHIEVEMENTS.get(uAchv.name)) {
    ACHIEVEMENTS.try(uAchv.name, uAchv.value, uAchv.date);
  }
});

ES5

<script src="node-modules/@lcluber/triumphjs/dist/triumph.iife.min.js"></script>

REWARDS = new Triumph.Rewards();
REWARDS.add('dbg', 'DOUBLE guns!', 'Start with double gun', 'fighter-jet');
REWARDS.add('emp', 'EMP Boost', 'EMP are 20% bigger','bomb');

ACHIEVEMENTS = new Triumph.Achievements();

var subAchv = new Triumph.Achievements();
subAchv.add( "a", "Score novice", "Score 1 000 000 points", 1000000, null, 'crown', null);
subAchv.add( "b", "Score hobbyist", "Score 10 000 000 points", 10000000, null, 'crown', null);
subAchv.add( "c", "Score adventurer", "Score 20 000 000 points", 20000000, null, 'crown', REWARDS.getByName('emp'));

ACHIEVEMENTS.add("pgm", "PGM", "Make high scores", 0, subAchv, 'crown', null);

var subAchv2 = new Triumph.Achievements();
subAchv2.add( "a", "Survivor novice", "Survive 1 minute", 1, null, 'heartbeat', null);
subAchv2.add( "b", "Survivor hobbyist", "Survive 2 minutes", 2, null, 'heartbeat', null);
subAchv2.add( "c", "Survivor adventurer", "Survive 3 minutes", 3, null, 'heartbeat', REWARDS.getByName('dbg');

ACHIEVEMENTS.add("svv", "Immortal", "Survive as long as possible", 0, subAchv2, 'heartbeat', null);

// activate achievements.
ACHIEVEMENTS.try("svv", 1, 1549104204008); // Activate a previously earned achievement with a timestamp
var msg = ACHIEVEMENTS.try("svv", 3, null); // Test achievement "svv" with the value "3" and return the title of the biggest level earned with this value.

// Check if reward is earned
var reward = REWARDS.getByName('dbg').isActive();

// Export flat array for easy persistence
var userAchvs = ACHIEVEMENTS.export();

// Update achievements with previous Export
userAchvs.forEach(function(uAchv) {
  if (ACHIEVEMENTS.get(uAchv.name)) {
    ACHIEVEMENTS.try(uAchv.name, uAchv.value, uAchv.date);
  }
});

Demo

See an example on this awesome game.

API Reference

Achievements.add( name: string,
                  title: string,
                  description: string,
                  value: number,
                  children: Achievements | null,
                  image: string,
                  reward: Reward
                ): boolean {}
Achievements.try(name: string, value: number, timestamp: number): string {}
Achievements.export(name:string): Array<Pick<Achievement, 'name' | 'value' | 'date'>>|false {}
Achievements.get(name: string): Achievement | null {}
Achievements.getPoints(): number {}
Achievements.getTotalPoints(): number {}
Achievements.length(): number {}

Rewards.add(  name: string,
              title: string,
              description: string,
              group: string
              image: string
            ): boolean {}
Rewards.get(): Reward[] {}
Rewards.getByName(name: string): Reward | undefined {}
Rewards.getByGroup(group: string): Reward | null {}
Rewards.isRewardActive(name: string): Reward | null {}
Rewards.isGroupActive(group: string): Reward | null {}
Rewards.length(): number {}

Tests

No tests to run yet

Contributors

Triumph.js is still in early development and I would be glad to get all the help you can provide for this project. To contribute you can clone the project on GitHub and See NOTICE.md for detailed installation walkthrough.

License

MIT License

Copyright (c) 2019 Ludovic CLUBER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.