score.js
A small javascript module to add levels, checkpoints and badges to a linear score.
See the demo or read an introduction
Quick usage
var score = ; // set scorescore; // increase score by 1score; // increase score by 10score; // decrease score by 1score; // get scorecardscore;
scorecard returns...
score:123 // current total score title:"Gorilla" // current title quote:"You're a true soldier" // current quote level:2 // current level levelscore:23 // current level score leveltotal:200 // current level total levelprogress:1151 // percentage % totalprogress:3445 // percentage % levelup: false // did we just level up? totallevels:10 // total levels prestige:0 // prestige level see below
lib/score.js
comes with 10 levels as default. lib/score-basic.js
comes with none. The default levels can be replaced with custom levels using the setup below.
Setup
var score = persistant:true // uses localStorage - default: true {...} // callback when levelling up levels: // custom levels "checkmark": 0 "status": "noob" "quote": "You're just a little newbie" "checkmark": 500 "status": "champion" "quote": "You're halfway there" "checkmark": 1000 "status": "legend" "quote": "You made it!" ;
Multipliers
Handy when you want to give your user double or triple points for a given duration.
// multiply all increments and decrements by 2 from now onscore; // multiply all increments and decrements by 3 for the next 5 secondsscore; // multiply all increments and decrements by 4 for the next 5 seconds // with a callbackscore;
Prestige levels
To provide an infinite score, you can allow your players to reset their score after completing all levels.
score;
This resets the score to 0
and increments scorecard.prestige
. This only works if scorecard.totalprogress
is 100%.
License
The MIT License
Copyright (c) 2010-2014 Nic Mulvaney
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.
Written by Mulhoon 2014. Please report any issues or suggestions.