Highscores
Library to facilitate the process of creating score-based webxdc games.
It can handle multiple scoreboards at the same time.
Install
npm install @webxdc/highscores
Usage
Quick overview of the API:
import "@webxdc/highscores";
await window.highscores.init();
const score = window.highscores.getScore();
console.log(`your score: ${score}`);
window.highscores.setScore(score + 100);
const scoreboard = window.highscores.getHighScores();
scoreboard.forEach((player) => {
console.log(`${player.pos}. ${player.name} - ${player.score}`);
});
The webxdc.js
lib also needs to be included in your index.html
:
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<script src="webxdc.js"></script>
<script type="module">
import "@webxdc/highscores";
</script>
</head>
<body>
...
</body>
</html>
Check dist/highscores.d.ts file for documentation of the available API.
For a full example check the example/index.html file.