beatsaber-leaderboard-parser
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

Beat Saber Local Leaderboard Parser

This module parses local leaderboard files for Beat Saber.

Usage

Install the npm package.

npm install beatsaber-leaderboard-parser

Import

// index.ts
import * as fs from 'fs';
import * as path from 'path';
import { BeatSaber, BeatsaberLeaderboardParser } from 'beatsaber leaderboard parser`

const scores = fs.readFileSync(path.join(__dirname, 'scores.json')).toString();

// Use Parser Directly
const beatSaberData = BeatsaberLeaderboardParser.ParseFile(JSON.parse(scores));
beatSaberData.players;
beatSaberData.songs;

// Use BeatSaber helper class
const beatSaber = BeatSaber.FromFile(scores)
beatSaber.songs();
beatSaber.songsByNumberOfPlayers();
beatSaber.songsByMostRecentlyPlayed();
beatSaber.players();
beatSaber.playersByFirstPlaces();
beatSaber.playersByFullCombos();
beatSaber.playersByNumberOfScores();

Readme

Keywords

none

Package Sidebar

Install

npm i beatsaber-leaderboard-parser

Weekly Downloads

6

Version

0.1.2

License

MIT

Unpacked Size

49 kB

Total Files

20

Last publish

Collaborators

  • hoovercj