Metadata-Version: 1.0
Name: carball
Version: 0.4.0
Summary: Rocket League replay parsing and analysis.
Home-page: https://github.com/SaltieRL/ReplayAnalysis
Author: Matthew Mage, Harry Xie, David Turner
Author-email: sciguymjm@gmail.com
License: Apache 2.0
Description: # carball
        Various tools for decompiling / analyzing Rocket League replays.
        
        ## Requirements
        
        - Python 3.5+
        - Windows, Mac or Linux
        
        ## Install
        
        `pip install carball`
        
        ## Examples / Usage
        
        Decompile and analyze a replay:
        ```Python
        import carball
        
        manager = carball.analyze_replay_file('9EB5E5814D73F55B51A1BD9664D4CBF3.replay', 
                                              '9EB5E5814D73F55B51A1BD9664D4CBF3.json', 
                                              overwrite=True)
        proto_game = manager.protobuf_game
        
        ```
        
        Just decompile a replay to a JSON object:
        
        ```Python
        import carball
        
        _json = carball.decompile_replay('9EB5E5814D73F55B51A1BD9664D4CBF3.replay', 
                                        '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(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)
        
Keywords: rocket-league
Platform: UNKNOWN
