OsuParsers 
Library for parsing files associated with osu! written in C#
Feel free to use it and report any issues you might run into.
Cuz, you know, i might have broke something in the last few commits ;)
Navigation
Installation
Download latest version of parser from releases, then add the dll into your project references/dependencies.
Or you can just install NuGet package.
Package Manager
PM> Install-Package OsuParsers.NET CLI
> dotnet add package OsuParsersBuilding and Requirements
- You need a desktop platform that can compile .NET 4.6.1 or higher.
- Clone the repository
git clone https://github.com/mrflashstudio/OsuParsers - And then you can build the project in your IDE.
Usage
Beatmap parser
using OsuParsers.Beatmaps;
using OsuParsers.Decoders;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
Beatmap beatmap = BeatmapDecoder.Decode(@"beatmapPath.osu");
//printing beatmap's title
System.Console.WriteLine(beatmap.MetadataSection.TitleUnicode);
}
}
}Storyboard parser
using OsuParsers.Decoders;
using OsuParsers.Storyboards;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
Storyboard storyboard = StoryboardDecoder.Decode(@"storyboardPath.osb");
//getting first object of foreground layer
IStoryboardObject object = storyboard.ForegroundLayer[0];
}
}
}Replay parser
using OsuParsers.Decoders;
using OsuParsers.Replays;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
Replay replay = ReplayDecoder.Decode(@"replayPath.osr");
//printing player's nickname
System.Console.WriteLine(replay.PlayerName);
}
}
}Database parser
using OsuParsers.Decoders;
using OsuParsers.Database;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
//parsing all available databases
OsuDatabase osuDb = DatabaseDecoder.DecodeOsu(@"osuDbPath.db");
CollectionDatabase collectionDb = DatabaseDecoder.DecodeCollection(@"collectionDbPath.db");
ScoresDatabase scoresDb = DatabaseDecoder.DecodeScores(@"scoresDbPath.db");
PresenceDatabase presenceDb = DatabaseDecoder.DecodePresence(@"presenceDbPath.db");
//printing player's nickname
System.Console.WriteLine(osuDb.PlayerName);
//printing collection count
System.Console.WriteLine(collectionDb.CollectionCount);
//printing beatmap's md5 hash of first score
System.Console.WriteLine(scoresDb.Scores[0].Item1);
//printing first player's nickname
System.Console.WriteLine(presenceDb.Players[0].Username);
}
}
}Beatmap writer
using OsuParsers.Beatmaps;
using OsuParsers.Decoders;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
//getting console output text as the song's new title
string newTitle = System.Console.ReadLine();
//parsing beatmap
Beatmap beatmap = BeatmapDecoder.Decode(@"pathToBeatmap.osu")
//changing song title
beatmap.MetadataSection.Title = newTitle;
//writing beatmap to file
beatmap.Save(@"pathToNewBeatmap.osu");
}
}
}Storyboard writer
using OsuParsers.Decoders;
using OsuParsers.Storyboards;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
//getting console output text as the object's new filepath
string newFilePath = System.Console.ReadLine();
//parsing storyboard
Storyboard storyboard = StoryboardDecoder.Decode(@"pathToStoryboard.osb")
//changing filepath of the first storyboard object in background layer
storyboard.BackgroundLayer[0].FilePath = newFilePath;
//writing storyboard to file
beatmap.Save(@"pathToNewStoryboard.osb");
}
}
}Replay writer
using OsuParsers.Decoders;
using OsuParsers.Replays;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
//getting console output text as the new player's name
string newPlayerName = System.Console.ReadLine();
//parsing replay
Replay replay = ReplayDecoder.Decode(@"pathToReplay.osr")
//changing player name
replay.PlayerName = newPlayerName;
//writing replay to file
replay.Save(@"pathToNewReplay.osr");
}
}
}Database writer
using OsuParsers.Database;
using OsuParsers.Decoders;
using OsuParsers.Enums;
namespace SomeNamespace
{
class Program
{
public static void Main(string[] args)
{
//parsing osu database
OsuDatabase db = DatabaseDecoder.DecodeOsu(@"pathToOsuDb.db")
//changing permissions
db.Permissions = Permissions.Supporter;
//writing database to file
db.Save(@"pathToNewOsuDb.db");
}
}
}Documentation
For detailed description of available methods and fields, see documentation.