Skip to content

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rocket League Replay Parser

rl-replay is a small command-line parser for Rocket League .replay files. It extracts the match summary used by Sprocket: match metadata, teams and scores, players and headline stats, winner, and goals.

Install

Download a platform archive from the latest GitHub Release, unpack it, and put the rl-replay executable somewhere on your PATH.

Release archives currently target:

Platform Archive target
Linux x86_64 x86_64-unknown-linux-gnu
macOS Intel x86_64-apple-darwin
macOS Apple Silicon aarch64-apple-darwin
Windows x86_64 x86_64-pc-windows-msvc

The binaries are currently unsigned. macOS may require approving the binary in System Settings after the first launch.

Usage

Parse one replay and print a JSON summary:

rl-replay path/to/match.replay

Write the summary to a file instead:

rl-replay path/to/match.replay --output summary.json

Parse several replays in one process. Batch mode prints a JSON array in the same order as the input paths:

rl-replay --batch path/to/one.replay path/to/two.replay > summaries.json

The --output option also works with batch mode:

rl-replay --batch --output summaries.json path/to/*.replay

Without --batch, exactly one input path is required. A missing or malformed replay causes a non-zero exit status and identifies the file that failed.

Build from source

Rust and Cargo are only needed when building from source or contributing:

cargo build --release
cargo test

The resulting executable is target/release/rl-replay.

Releases

Releases are built by GitHub Actions when a version tag is pushed. To publish a new release from a checkout with permission to the repository:

git tag v0.2.0
git push origin v0.2.0

The workflow runs the test suite, builds each supported target, creates a platform archive, and attaches the archives to the GitHub Release.

Validation

The comparison against the predecessor parser is recorded in BENCHMARK.md. The current corpus comparison covers 32 replay fixtures with exact agreement on all fields emitted by this CLI.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages