Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfausak/rattletrap
:car: Parse and generate Rocket League replays.
https://github.com/tfausak/rattletrap
haskell
Last synced: 2 days ago
JSON representation
:car: Parse and generate Rocket League replays.
- Host: GitHub
- URL: https://github.com/tfausak/rattletrap
- Owner: tfausak
- License: mit
- Created: 2016-09-28T22:01:59.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T13:41:18.000Z (6 months ago)
- Last Synced: 2024-05-19T14:42:42.832Z (6 months ago)
- Topics: haskell
- Language: Haskell
- Homepage: https://hackage.haskell.org/package/rattletrap
- Size: 71.4 MB
- Stars: 146
- Watchers: 6
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-esports - Rattletrap - A Haskell library for parsing and generating Rocket League replays. (Libraries / Data parsing and analysis)
README
# [Rattletrap](https://github.com/tfausak/rattletrap)
[](https://github.com/tfausak/rattletrap/actions/workflows/ci.yml)
[](https://hackage.haskell.org/package/rattletrap)
Rattletrap parses and generates [Rocket League][] replays. Parsing replays can
be used to analyze data in order to collect high-level statistics like players
and points, or low-level details like positions and cameras. Generating replays
can be used to modify replays in order to force everyone into the same car or
change the map a game was played on.
Rattletrap supports every version of Rocket League up to [2.45][], which was
released on 2024-10-22. If a replay can be played by the Rocket League client,
it can be parsed by Rattletrap. (If not, that's a bug. Please report it!)
## Install
Rattletrap is a command-line application. You should only use it if you're
comfortable running things in terminals or command prompts. Otherwise consider
using another tool like [Ball Chasing][].
The best way to get Rattletrap is by downloading [the latest release][] for
your platform.
Rattletrap is written in [Haskell][]. If you'd like to use a program written in
a different language, consider one of the following:
- (C#)
- (Rust)
- (C++)
## Replays
Rocket League saves your replays in a folder that depends on your operating
system.
- Windows:
- `%UserProfile%/Documents/My Games/Rocket League/TAGame/Demos`
- For example: `C:/Users/Taylor/Documents/My Games/Rocket League/TAGame/Demos`
- macOS:
- `$HOME/Library/Application Support/Rocket League/TAGame/Demos`
- For example: `/Users/taylor/Library/Application Support/Rocket League/TAGame/Demos`
- Linux:
- `$HOME/.local/share/Rocket League/TAGame/Demos`
- For example: `/home/taylor/.local/share/Rocket League/TAGame/Demos`
## Interface
Rattletrap is a command line application.
``` sh
$ rattletrap --help
```
```
rattletrap version 12.0.0
-c --compact minify JSON output
-f --fast only encode or decode the header
-h --help show the help
-i FILE|URL --input=FILE|URL input file or URL
-m MODE --mode=MODE decode or encode
-o FILE --output=FILE output file
--schema output the schema
--skip-crc skip the CRC
-v --version show the version
```
By default Rattletrap will try to determine the appropriate mode (either decode
or encode) based on the file extensions of the input or output. You can
override this behavior by passing `--mode` (or `-m`) with either `decode` or
`encode`.
Input extension | Output extension | Mode
--- | --- | ---
`.replay` | anything | `decode` (parse)
`.json` | anything | `encode` (generate)
anything | `.replay` | `encode` (generate)
anything | `.json` | `decode` (parse)
anything | anything | `decode` (parse)
## Parse
Rattletrap can parse (decode) Rocket League replays and output them as JSON.
``` sh
$ rattletrap --input http://example.com/input.replay --output output.json
# or
$ rattletrap -i input.replay -o output.json
# or
$ rattletrap < input.replay > output.json
```
The input argument can either be a local path or a URL.
By default the JSON is pretty-printed. To minify the JSON, pass `--compact` (or
`-c`) to Rattletrap. Even when the JSON is minified, it's extremely large. The
output can be up to 100 times larger than the input. For example, a 1.5 MB
replay turns into 31 MB of minified JSON or 159 MB of pretty-printed JSON.
## Generate
Rattletrap can also generate (encode) Rocket League replays from JSON files.
``` sh
$ rattletrap --input http://example.com/input.json --output output.replay
# or
$ rattletrap -i input.json -o output.replay
# or
$ rattletrap --mode encode < input.json > output.replay
```
The input argument can either be a local path or a URL.
If the JSON was generated by Rattletrap, the output replay will be bit-for-bit
identical to the input replay.
## Modify
By inserting another program between parsing and generating, Rattletrap can be
used to modify replays.
``` sh
$ rattletrap -i input.replay |
modify-replay-json |
rattletrap -o output.replay
```
[Rattletrap]: https://github.com/tfausak/rattletrap
[Rocket League]: https://www.rocketleague.com
[2.45]: https://www.rocketleague.com/en/news/patch-notes-v2-45
[Ball Chasing]: https://ballchasing.com
[the latest release]: https://github.com/tfausak/rattletrap/releases/latest