Skip to main content

Parser for osr files and lzma replay streams for osu!

Project description

PyPi version

osrparse, a python parser for osu! replays

This is a parser for the .osr format for osu! replay files, as described by the wiki.


To install, simply:

pip install osrparse


Please see the full documentation for a comprehensive guide: A quickstart follows below for the impatient, but you should read the full documentation if you are at all confused.


from osrparse import Replay, parse_replay_data
# parse from a path
replay = Replay.from_path("path/to/osr.osr")

# or from an opened file object
with open("path/to/osr.osr") as f:
    replay = Replay.from_file(f)

# or from a string
with open("path/to/osr.osr") as f:
    replay_string =
replay = Replay.from_string(replay_string)

# a replay has various attributes
r = replay
print(r.mode, r.game_version, r.beatmap_hash, r.username,
    r.replay_hash, r.count_300, r.count_100, r.count_50,
    r.count_geki, r.count_miss, r.score, r.max_combo, r.perfect,
    r.mods, r.life_bar_graph, r.timestamp, r.replay_data,
    r.replay_id, r.rng_seed)

# parse the replay data from api v1's /get_replay endpoint
lzma_string = retrieve_from_api()
replay_data = parse_replay_data(lzma_string)
# replay_data is a list of ReplayEvents

# write a replay back to a path

# or to an opened file object
with open("path/to/osr.osr") as f:

# or to a string
packed = replay.pack()

# edited attributes are saved
replay.username = "fake username"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osrparse-7.0.0.tar.gz (11.0 kB view hashes)

Uploaded Source

Built Distribution

osrparse-7.0.0-py3-none-any.whl (9.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page