osu-parser

A parser for Nodejs that converts osu files into javascript objects. Feel free to give it a try and post issues to help me improve it ;)

• Installation
• Usage
• The resulting object
• Methods
  • parseFile(filepath, callback)
  • parseStream(stream, callback)
  • parseContent(content)
• TODO
• Changelog

Installation

npm install osu-parser

Usage

  var parser = require('osu-parser');

  parser.parseFile('path/to/map.osu', function (err, beatmap) {
    console.log(beatmap);
  });

The resulting object

Simple key/value entries like this...

...
PreviewTime: 42860
...

...are directly reachable as properties :

console.log(beatmap['PreviewTime']);
// prints 42860

Additionnal beatmap properties :

TimingPoint properties

HitObject properties

Slider specific properties

Spinner specific properties

Methods

parseFile(filepath, callback)

Parse the given file. The callback returns (error, beatmap).

  var parser = require('osu-parser');

  parser.parseFile('path/to/map.osu', function (err, beatmap) {
    console.log(beatmap);
  });

parseStream(stream, callback)

Parse a stream containing a file content. The callback returns (error, beatmap).

  var parser = require('osu-parser');
  var fs     = require('fs');
  var stream = fs.createReadStream('path/to/map.osu');

  parser.parseStream(stream, function (err, beatmap) {
    console.log(beatmap);
  });

parseContent(content)

Parse the content of a file as a string or a buffer.

  var parser  = require('osu-parser');
  var fs      = require('fs');
  var content = fs.readFileSync('path/to/map.osu');

  var beatmap = parser.parseContent(content);

TODO

• translate the samplesetId of timing points
• parse events
• make tests more reliable
• add a synchronous version of parseFile
• make it usable in a browser ? (not sure that would be useful)
• ...

0.3.3

• fix slider calculations failing if it starts before the first timing point

0.3.2

• Fix slider duration calculated with the wrong timing point
• Timing points now inherit the previous beatLength if it's negative

0.3.0

• streams are now read without lazy
• add duration and endTime to sliders
• timingPoint fix : change useCustomSamples (boolean) for customSampleIndex (integer)

0.2.0

• map length now starts from the very beginning and not from the first timingpoint
• timingSignature, sampleSetId and sampleVolume now parsed into Integers
• beatLength now parsed into float
• maxCombo calculated
• fix background filename not found if not quoted
• add breakTimes array
• green timing points now have a bpm inherited from the previous timing point
• if slider endPosition can not be calculated, it's set to the position of the last point
• pass-through endPosition calculated using bezier algorithm if more than 3 points

0.1.1

• bpm (string or integer) replaced by bpmMin and bpmMax (integers)

0.1.0

• fix number of slider edge sounds that could be wrong
• parse object additions
• parse sounds and additions on the edges of sliders
• parse integer strings
• get bezier endpoint coordinates
• points coordinates are now arrays of type [x,y]
• replace hitobject.x and hitobject.y by hitobject.position ([x,y])
• split tags into beatmap.tagsArray

0.0.5

• removed objectType and soundType properties from hitobjects as it's useless for the final user
• add velocity to timingPoints if beatLength is negative
• removed booleans whistle, finish and clap and add soundTypes array instead
• add repeatCount, pixelLength, curveType and pointsList to slider objects
• add edgeSounds to slider objects which contain a list of soundTypes arrays

0.0.4

• objectType bitwise flag enum is used to identify hitobjects
• add booleans whistle, finish, clap and newCombo to hitobjects

0.0.3

• add fileFormat property containing the osu file version (v7, v12...)
• parsing of timing points
• basic parsing of hit objects

0.0.2

• add parsing tests involving osu files from v7 to v12
• fix circles not recognized in v11 files

0.0.1

• first stable version with basic parsing