.echoreplay File Format: Difference between revisions
(restored from backup) |
No edit summary |
||
| Line 1: | Line 1: | ||
[[Category:API]] | [[Category:API]] | ||
The <code>.echoreplay</code> file format is a container for nearly raw API data from EchoVR. It is designed to be as simple as possible while retaining all information provided by the API. | The <code>.echoreplay</code> file format is a container for nearly raw API data from EchoVR. It is designed to be as simple as possible while retaining all information provided by the API. | ||
| Line 12: | Line 11: | ||
| [[Spark]] || Records <code>.echoreplay</code> files from game data. | | [[Spark]] || Records <code>.echoreplay</code> files from game data. | ||
|} | |} | ||
To record <code>.echoreplay</code> files without writing your own software, you can use the [[Spark]], but the format is designed to be simple enough to let people read and write their own replay files. | To record <code>.echoreplay</code> files without writing your own software, you can use the [[Spark]], but the format is designed to be simple enough to let people read and write their own replay files. | ||
| Line 20: | Line 18: | ||
* One line per API request. | * One line per API request. | ||
* Each line contains the a timestamp, the ''tab'' character, and the full JSON data from the game's API | * Each line contains the a timestamp, the ''tab'' character, and the full JSON data from the game's API | ||
* Optionally, the JSON data for player bone data is included at the end of the line, separated by another tab character. | |||
Due to the high efficiency of zip compression, binary formats such as <code>.milk</code> (once modified to include all the data necessary for replays) provide only marginal or no benefits over the compressed <code>.echoreplay</code>. These formats also require modification for every API change from the game, unlike <code>.echoreplay</code>. | Due to the high efficiency of zip compression, binary formats such as <code>.milk</code> (once modified to include all the data necessary for replays) provide only marginal or no benefits over the compressed <code>.echoreplay</code>. These formats also require modification for every API change from the game, unlike <code>.echoreplay</code>. | ||
Latest revision as of 18:35, 14 December 2022
The .echoreplay file format is a container for nearly raw API data from EchoVR. It is designed to be as simple as possible while retaining all information provided by the API.
Programs that can interact with .echoreplay files:
| Program | Functionality |
|---|---|
| Replay Viewer | Reads the file and visualizes the match. |
| Spark | Records .echoreplay files from game data.
|
To record .echoreplay files without writing your own software, you can use the Spark, but the format is designed to be simple enough to let people read and write their own replay files.
The .echoreplay file format is a complete storage format for time-series EchoVR API request data. There are two versions of this format - compressed and uncompressed, both with the same file extension. The compressed version is simple the uncompressed file in a renamed .zip file.
The format for the uncompressed file is as follows:
- One line per API request.
- Each line contains the a timestamp, the tab character, and the full JSON data from the game's API
- Optionally, the JSON data for player bone data is included at the end of the line, separated by another tab character.
Due to the high efficiency of zip compression, binary formats such as .milk (once modified to include all the data necessary for replays) provide only marginal or no benefits over the compressed .echoreplay. These formats also require modification for every API change from the game, unlike .echoreplay.
