DecodersDocumentation.md

Navigation

• Methods
  • BeatmapDecoder's methods
    • Decode(string path)
    • Decode(IEnumerable<string> lines)
    • Decode(Stream stream)
  • StoryboardDecoder's methods
    • Decode(string path)
    • Decode(IEnumerable<string> lines)
    • Decode(Stream stream)
  • ReplayDecoder's methods
    • Decode(string path)
    • Decode(Stream stream)
  • DatabaseDecoder's methods
    • DecodeOsu(string path)
    • DecodeOsu(Stream stream)
    • DecodeCollection(string path)
    • DecodeCollection(Stream stream)
    • DecodeScores(string path)
    • DecodeScores(Stream stream)
    • DecodePresence(string path)
    • DecodePresence(Stream stream)

Also, see use cases in the Usage section of readme.

Methods

BeatmapDecoder's methods

BeatmapDecoder.Decode(string path)

Parses the given .osu file, then returns parsed Beatmap.

Beatmap beatmap = BeatmapDecoder.Decode(@"pathToBeatmap.osu");

BeatmapDecoder.Decode(IEnumerable<string> lines)

Parses the given array containing beatmap data, then returns parsed Beatmap.

Beatmap beatmap = BeatmapDecoder.Decode(File.ReadAllLines(@"pathToBeatmap.osu"));

BeatmapDecoder.Decode(Stream stream)

Parses the given stream containing beatmap data, then returns parsed Beatmap.

Beatmap beatmap = BeatmapDecoder.Decode(new FileStream(@"pathToBeatmap.osu", FileMode.Open, FileAccess.Read));

StoryboardDecoder's methods

StoryboardDecoder.Decode(string path)

Parses the given .osb file, then returns parsed Storyboard.

Storyboard storyboard = StoryboardDecoder.Decode(@"pathToStoryboard.osb");

StoryboardDecoder.Decode(IEnumerable<string> lines)

Parses the given array containing storyboard data, then returns parsed Storyboard.

Storyboard storyboard = StoryboardDecoder.Decode(File.ReadAllLines(@"pathToStoryboard.osb"));

StoryboardDecoder.Decode(Stream stream)

Parses the given stream containing storyboard data, then returns parsed Storyboard.

Storyboard storyboard = StoryboardDecoder.Decode(new FileStream(@"pathToStoryboard.osb", FileMode.Open, FileAccess.Read));

ReplayDecoder's methods

ReplayDecoder.Decode(string path)

Parses the given .osr file, then returns the parsed Replay.

Replay replay = ReplayDecoder.Decode(@"pathToReplay.osr");

ReplayDecoder.Decode(Stream stream)

Parses the given stream containing replay data, then returns the parsed Replay.

Replay replay = ReplayDecoder.Decode(new FileStream(@"pathToReplay.osr", FileMode.Open, FileAccess.Read));

DatabaseDecoder's methods

DatabaseDecoder.DecodeOsu(string path)

Parses the given osu!.db file, then returns parsed OsuDatabase.

OsuDatabase osuDatabase = DatabaseDecoder.DecodeOsu(@"pathToOsuDatabase.osb");

DatabaseDecoder.DecodeOsu(Stream stream)

Parses the given stream containing osu!.db data, then returns parsed OsuDatabase.

OsuDatabase osuDatabase = DatabaseDecoder.DecodeOsu(new FileStream(@"pathToOsuDatabase.osb", FileMode.Open, FileAccess.Read));

DatabaseDecoder.DecodeCollection(string path)

Parses the given collection.db file, then returns parsed CollectionDatabase.

CollectionDatabase collectionDatabase = DatabaseDecoder.DecodeCollection(@"pathToCollectionDb.db");

DatabaseDecoder.DecodeCollection(Stream stream)

Parses the given stream containing collection.db data, then returns parsed CollectionDatabase.

CollectionDatabase collectionDatabase = DatabaseDecoder.DecodeCollection(new FileStream(@"pathToCollectionDb.db", FileMode.Open, FileAccess.Read));

DatabaseDecoder.DecodeScores(string path)

Parses the given stream containing scores.db data, then returns parsed ScoresDatabase.

ScoresDatabase scoresDatabase = DatabaseDecoder.DecodeScores(@"pathToScoresDb.db");

DatabaseDecoder.DecodeScores(Stream stream)

Parses the given scores.db file, then returns parsed ScoresDatabase.

ScoresDatabase scoresDatabase = DatabaseDecoder.DecodeScores(new FileStream(@"pathToScoresDb.db", FileMode.Open, FileAccess.Read));

DatabaseDecoder.DecodePresence(string path)

Parses the given presence.db file, then returns the parsed PresenceDatabase.

PresenceDatabase presenceDatabase = DatabaseDecoder.DecodePresence(@"pathToPresenceDb.db");

DatabaseDecoder.DecodePresence(Stream stream)

Parses the given stream containing presence.db data, then returns the parsed PresenceDatabase.

PresenceDatabase presenceDatabase = DatabaseDecoder.DecodePresence(new FileStream(@"pathToPresenceDb.db", FileMode.Open, FileAccess.Read));