Rocket League replay parsing and analysis.
Project description
# carball
Various tools for decompiling / analyzing Rocket League replays.
## Requirements
- Python 3.6+
- Windows, Mac or Linux
## Install
`pip install carball`
`python init.py`
## Examples / Usage
Decompile and analyze a replay:
```Python
import carball
manager = carball.analyze_replay_file('9EB5E5814D73F55B51A1BD9664D4CBF3.replay',
output_path='9EB5E5814D73F55B51A1BD9664D4CBF3.json',
overwrite=True)
proto_game = manager.get_protobuf_data()
```
Just decompile a replay to a JSON object:
```Python
import carball
_json = carball.decompile_replay('9EB5E5814D73F55B51A1BD9664D4CBF3.replay',
output_path='9EB5E5814D73F55B51A1BD9664D4CBF3.json',
overwrite=True)
```
Analyze a JSON game object:
```Python
import carball
import os
import gzip
from carball.json_parser.game import Game
from carball.analysis.analysis_manager import AnalysisManager
# _json is a JSON game object (from decompile_replay)
game = Game()
game.initialize(loaded_json=_json)
analysis = AnalysisManager(game)
analysis.create_analysis()
# write proto out to a file
# read api/*.proto for info on the object properties
with open(os.path.join('output.pts'), 'wb') as fo:
analysis.write_proto_out_to_file(fo)
# write pandas dataframe out as a gzipped numpy array
with gzip.open(os.path.join('output.gzip'), 'wb') as fo:
analysis.write_pandas_out_to_file(fo)
```
## Pipeline
![pipeline is in Parserformat.png](Parser%20format.png)
If you want to add a new stat it is best to do it in the advanced stats section of the pipeline.
You should look at:
[Stat base classes](carball/analysis/stats/stats.py)
[Where you add a new stat](carball/analysis/stats/stats_list.py)
If you want to see the output format of the stats created you can look [here](api)
Compile the proto files by running in this directory
`setup.bat` (Windows) or `setup.sh` (Linux/mac)
[![Build Status](https://travis-ci.org/SaltieRL/carball.svg?branch=master)](https://travis-ci.org/SaltieRL/carball)
[![codecov](https://codecov.io/gh/SaltieRL/carball/branch/master/graph/badge.svg)](https://codecov.io/gh/SaltieRL/carball)
## Tips
Linux set `python3.6` as `python`:
```Python3
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.6 1
```
This assumes you already have 3.6 installed.
Linux Error (Potential):
`PermissionError: [Errno 13] Permission denied: 'carball/rattletrap/rattletrap-6.2.2-linux'`
Fix:
`chmod +x "carball/rattletrap/rattletrap-6.2.2-linux"`
Various tools for decompiling / analyzing Rocket League replays.
## Requirements
- Python 3.6+
- Windows, Mac or Linux
## Install
`pip install carball`
`python init.py`
## Examples / Usage
Decompile and analyze a replay:
```Python
import carball
manager = carball.analyze_replay_file('9EB5E5814D73F55B51A1BD9664D4CBF3.replay',
output_path='9EB5E5814D73F55B51A1BD9664D4CBF3.json',
overwrite=True)
proto_game = manager.get_protobuf_data()
```
Just decompile a replay to a JSON object:
```Python
import carball
_json = carball.decompile_replay('9EB5E5814D73F55B51A1BD9664D4CBF3.replay',
output_path='9EB5E5814D73F55B51A1BD9664D4CBF3.json',
overwrite=True)
```
Analyze a JSON game object:
```Python
import carball
import os
import gzip
from carball.json_parser.game import Game
from carball.analysis.analysis_manager import AnalysisManager
# _json is a JSON game object (from decompile_replay)
game = Game()
game.initialize(loaded_json=_json)
analysis = AnalysisManager(game)
analysis.create_analysis()
# write proto out to a file
# read api/*.proto for info on the object properties
with open(os.path.join('output.pts'), 'wb') as fo:
analysis.write_proto_out_to_file(fo)
# write pandas dataframe out as a gzipped numpy array
with gzip.open(os.path.join('output.gzip'), 'wb') as fo:
analysis.write_pandas_out_to_file(fo)
```
## Pipeline
![pipeline is in Parserformat.png](Parser%20format.png)
If you want to add a new stat it is best to do it in the advanced stats section of the pipeline.
You should look at:
[Stat base classes](carball/analysis/stats/stats.py)
[Where you add a new stat](carball/analysis/stats/stats_list.py)
If you want to see the output format of the stats created you can look [here](api)
Compile the proto files by running in this directory
`setup.bat` (Windows) or `setup.sh` (Linux/mac)
[![Build Status](https://travis-ci.org/SaltieRL/carball.svg?branch=master)](https://travis-ci.org/SaltieRL/carball)
[![codecov](https://codecov.io/gh/SaltieRL/carball/branch/master/graph/badge.svg)](https://codecov.io/gh/SaltieRL/carball)
## Tips
Linux set `python3.6` as `python`:
```Python3
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.6 1
```
This assumes you already have 3.6 installed.
Linux Error (Potential):
`PermissionError: [Errno 13] Permission denied: 'carball/rattletrap/rattletrap-6.2.2-linux'`
Fix:
`chmod +x "carball/rattletrap/rattletrap-6.2.2-linux"`
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
carball-0.6.15.tar.gz
(4.7 MB
view hashes)