rattletrap: Parse and generate Rocket League replays.

Versions [RSS]	0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.2.0, 0.3.0, 0.4.0, 0.4.1, 1.0.0, 2.0.0, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.1.4, 2.1.5, 2.2.0, 2.2.1, 2.2.2, 2.2.3, 2.2.4, 2.3.0, 2.3.1, 2.4.0, 2.5.0, 2.5.1, 2.5.2, 3.0.0, 3.1.0, 3.1.1, 3.1.2, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.0.5, 4.0.6, 4.0.7, 4.0.8, 4.0.9, 4.1.0, 4.1.1, 4.1.2, 5.0.0, 5.0.1, 6.0.0, 6.0.1, 6.0.2, 6.1.0, 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.3.0, 6.3.1, 6.3.2, 6.4.0, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 8.0.0, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.0.9, 9.0.10, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.1.4, 9.2.0, 9.3.0, 9.3.1, 9.3.2, 9.3.3, 9.4.0, 9.4.1, 10.0.0, 10.0.6, 10.0.7, 11.0.0, 11.0.1, 11.1.0, 11.1.1, 11.2.0, 11.2.1, 11.2.3, 11.2.4, 11.2.5, 11.2.6, 11.2.7, 11.2.8, 11.2.9, 11.2.10, 11.2.11, 11.2.12, 11.2.13, 11.2.14, 12.0.0, 12.0.1, 12.0.2, 12.0.3, 12.1.0, 12.1.1, 12.1.2, 12.1.3, 13.0.1, 13.0.2, 13.0.3, 13.1.0, 14.0.0, 14.1.0, 14.1.1
Change log	CHANGELOG.markdown
Dependencies	aeson (>=1.4.2 && <1.5), aeson-pretty (>=0.8.7 && <0.9), base (>=4.11.1 && <4.12 \|\| >=4.12.0 && <4.13), binary (>=0.8.6 && <0.9), binary-bits (>=0.5 && <0.6), bytestring (>=0.10.8 && <0.11), containers (>=0.6.0 && <0.7), filepath (>=1.4.2 && <1.5), http-client (>=0.6.4 && <0.7), http-client-tls (>=0.3.5 && <0.4), rattletrap, scientific (>=0.3.6 && <0.4), template-haskell (>=2.13.0 && <2.14 \|\| >=2.14.0 && <2.15), text (>=1.2.3 && <1.3), transformers (>=0.5.6 && <0.6) [details]
License	MIT
Author
Maintainer	Taylor Fausak
Category	Game
Source repo	head: git clone https://github.com/tfausak/rattletrap
Uploaded	by fozworth at 2019-05-27T14:36:40Z
Distributions	LTSHaskell:14.1.1, Stackage:14.1.1
Reverse Dependencies	1 direct, 0 indirect [details]
Executables	rattletrap
Downloads	66245 total (21 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2019-05-27 [all 1 reports]

Readme for rattletrap-7.0.2

[back to package description]

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 1.62, also known as the "esports shop update". 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!)

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. Rattletrap is written in Haskell. If you'd like to use a program written in a different language, consider @jjbott's C# parser or @nickbabcock's Rust parser.

Install

Get Rattletrap by downloading and unpacking the latest release for your platform.

To build Rattletrap from source, install Stack. Then run stack --resolver nightly install rattletrap.

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.

> rattletrap --help
rattletrap.EXE version 7.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
  -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.

> 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.

> 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.

> rattletrap -i input.replay |
  modify-replay-json |
  rattletrap -o output.replay