osu_reader

A c++17 library for consuming osu files with alrightish testing for the positive cases.

Usage

#include <osu_reader/beatmap.h>
auto parser = osu::Beatmap_parser{};
parser.slider_paths = true;

const auto bm_optional = parser.from_file("path/to/beatmap.osu");
// Alternatively: parser.from_string(beatmap_string);
if(!bm_optional) handler_for_beatmap_not_found_or_however_you_deal_with_this_case();
else{
    const auto beatmap = *bm_optional;
    print(beatmap.title);
}

#include <osu_reader/replay.h>
auto parser = osu::Replay_reader{};
parser.parse_frames = true; // Requires xz (LZMA)
// .value() throws on access if loading failed
const auto replay = parser.from_file("path/to/replay.osr").value();
print(replay.player_name);

Failing to parse files, i.e. the file couldn't be opened or the beatmap version couldn't be read, are handled by returning an empty optional. This also applies for malformed replay files. For beatmaps, other errors such as being unable to read a specific value are ignored altogether and the value will be in its default state.

You can find more usage examples in the tests directory.

Installation

Recommended usage is to add the library as a submodule or clone it into a subdirectory of your project and to consume it with cmake by calling add_subdirectory(osu_reader). You can then add it to your application with target_link_libraries(yourApplication PRIVATE osuReader::osuReader).
Maybe it will be added to other package managers in the future if it is more mature.
Note that the xz submodule is required to parse replay frames and is enabled by default. It can be disabled with the ENABLE_LZMA option in CMake. You can recursively download submodules with git submodule update --init --recursive, though note that this will automatically initialise other submodules that are not necessary to use the library.

Running the tests requires Catch2. Installing it via vcpkg is supported, although it is now also shipped with the project as a submodule.

Python Bindings

This library supports usage in python. Simply install it by running python setup.py install in the project main directory. Note that it requires the pybind11 and xz submodules by default. You can run its tests with python setup.py test.

import pyshosu

parser = pyshosu.Beatmap_parser()
parser.slider_paths = True

bm = parser.from_file("path/to/beatmap.osu")
print(bm.title)

reader = pyshosu.Replay_reader()
reader.parse_frames = True

r = reader.from_file("path/to/replay.osr")
print(r.player_name)

You can see more examples in the tests file.

Completeness

Implemented

• .osu format (Mostly, missing colours and hit extras)
• .osr format (Not thoroughly tested yet)
• Slider curve computation

Planned

• osu!.db (maybe)
• Matching replay clicks to hitobjects etc
• Stack notes

If there's anything missing you need, open an issue and I'll push it on the priority list.

Licence

MIT