osu! Replay Parser

The ultimate osu! replay (.osr) parsing package that supports both osu! standard and osu!mania. It parses each replay frame in a clearly formatted object.

Installation

• Install the package from npm npm install osureplayparser --save

Usage

• It's best if you take a look at the example in the tests

const osuReplayParser = require('osureplayparser');

const replayPath = "./path/to/your/replay.osr";
const replay = osuReplayParser.parseReplay(replayPath);

console.log(replay);

Documentation

The replay object returned is very simple, however it differentiates for both osu! and mania.

Base Replay Data

Here is the base data of what you'll get with every replay. You have all data that was parsed from the original package: node-osr plus some added stuff.

{
  "gameMode": 3,
  "gameVersion": 20150414,
  "beatmapMD5": "c486f38146e0a14057ed1e3d3908c0c8",
  "playerName": "Swan",
  "replayMD5": "aed34df46c7c4a0f955edca59ca52fe1",
  "number_300s": 1384,
  "number_100s": 11,
  "number_50s": 6,
  "gekis": 1417,
  "katus": 89,
  "misses": 9,
  "score": 906808,
  "max_combo": 1161,
  "perfect_combo": 0,
  "mods": 0,
  "life_bar": "",
  "timestamp": "0001-01-01T00:00:00.000Z",
  "replay_length": 13625,
  "replay_data": [],
  "raw_replay_data": "0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0,0|256|1|0...."

Replay Data

The replay data object for mania and the other game modes are different. It should be self-explanatory and easy to read.

osu! Standard Replay Data Example

"replay_data": [
  {
    "timeSinceLastAction": 11,
    "x": 108.4803,
    "y": 187.5656,
    "keyPressedBitwise": 10,
    "keysPressed": {
      "K1": false,
      "K2": true,
      "M1": false,
      "M2": false
    }
  },
]

osu!mania Replay Data Example

As you can see, you get the exact keys pressed for keys 1-10. This works on every key mode. Regardless of whether or not the mode has more keys, you'll still receive 10 in the object, however they will always be false.

"replay_data": [
  {
    "timeSinceLastAction": 2,
    "x": 13,
    "y": 18.88889,
    "keyPressedBitwise": 0,
    "keysPressed": {
      "Key1": true,
      "Key2": false,
      "Key3": true,
      "Key4": true,
      "Key5": false,
      "Key6": false,
      "Key7": false,
      "Key8": false,
      "Key9": false,
      "Key10": false
    }
  },
]

Credits

The base of this replay parser was originally written by vignedev. Here is the original called node-osr. I have only expanded upon it and further parsed the replay data, so most of the credit goes to him.

LICENSE

All the code in this repository is licensed under MIT