TKosfeld / slp-parser-js

Parse slp files and compute stats

Introduction

This is the official .slp file parsing library. It parses a .slp file into structured data and can be used to compute stats. There are already many built-in stats that are computed by the library but the data provided can also be used to compute your own stats.

Quick-Start

Requirements

• node – https://nodejs.org/en/download/

Writing a simple script

1. Create a fresh directory on your disk
2. Inside this new directory, create a file called script.js
3. Fill the script.js file with the following contents:

const { default: SlippiGame } = require('slp-parser-js');

const game = new SlippiGame("test.slp");

// Get game settings – stage, characters, etc
const settings = game.getSettings();
console.log(settings);

// Get metadata - start time, platform played on, etc
const metadata = game.getMetadata();
console.log(metadata);

// Get computed stats - openings / kill, conversions, etc
const stats = game.getStats();
console.log(stats);

// Get frames – animation state, inputs, etc
// This is used to compute your own stats or get more frame-specific info (advanced)
const frames = game.getFrames();
console.log(frames[0].players); // Print frame when timer starts counting down

4. Copy a .slp file into the directory and call it test.slp
5. Browse to the directory from the command line and run the command: npm install slp-parser-js. This should create a node_modules directory in the folder.
6. Run the command: node script.js. This will run the script above and will print data about the test.slp file