robidasdavid / demo-viewer

Game data capturer and 3D Replayer for Echo Arena Games

DESCRIPTION

The EchoVR Replay Viewer is able to play back data from an EchoVR Arena game that was saved through the public API into a replay file by presenting it in a 3D replaying software. The Replay Viewer can read files saved in the .echoreplay format. A description of how to create files in this format is below.

INSTALLATION

Oculus Store Version (CURRENTLY NOT AN OPTION FOR NEW DOWNLOADS)

The Oculus Store version will get automatic updates. Install via the Oculus Store page:

https://www.oculus.com/experiences/rift/3228453177179864

GitHub Release

To install, extract the zip to a folder and run the .exe file. To run in VR mode, run the .exe with the -useVR command-line argument.

Capturer (legacy, now Spark)

1. Download the Game-Capturer.zip in builds/ to your computer and unzip to a folder.
2. Edit file path and file name as well as execution arguments. Click start and stop capture to start and stop capture respectively.

USAGE

Loading Files

To load a file, click on the menu icon on the right side of the screen (shortcut: tilde). This menu contains a list of .echoreplay files in the folder that Spark saves files to by default (C:\Users\[USERNAME]\Documents\Spark\replays\). At the top of this menu, there is an input field, where any file path can be entered if the replay is stored somewhere else on your computer.

To save your own replays, download Spark!

File Association:

File association is supported with the replay viewer, to make it easier for you to load downloaded files, you can associate .echoreplay files with ReplayViewer.exe by double clicking a .echoreplay file. When Windows brings up the "How do you want to echoreplay files from now on?" window, click "More apps", scroll down and select "Look for another app on this PC". Navigate to where you unzipped the application (GitHub Release), or to C:\Program Files\Oculus\Software\Software\franzco-echodata\Replay Viewer.exe (Oculus Store), and select "ReplayViewer.exe". Once you have done this, you can open .echoreplay files just by opening a file directly from File Explorer.

If you do not do this and you want to open files downloaded from the internet, you will have to copy the entire file location and file name of the file you want to view, and paste it into the field after launching the app. Files recorded with Spark will save to a folder readable by the Replay Viewer and will not require this process to view.

Controls:

Keyboard

• WASD - camera movement
• Q/E - descend/ascend
• Shift - camera speed boost
• Mouse Wheel - adjust camera movement speed

XBOX Controller:

• Left Stick - camera forward/back movement
• Right Stick - camera pitch/yaw
• Left Bumper/Right Bumper - descend/ascend
• A Button - Play/Pause, resets back to 1x play if rewinding/fast forwarding
• B Button - Clear drawings on screen
• Y Button - Show last score details
• Select/Left Action Button - Enable/disable goal animations (default is enabled)
• DPad Left - Rewind (1x - 10x)
• DPad Right - Fast forward (1x - 10x)
• Left Trigger - Quick Scrub/Slow-Mo backwards, analog controlled on the trigger to adjust speed (less trigger pull = slower, full pull = 1.5x). Will revert to playing if replay was playing before trigger was used, can toggle whether to play or pause while scrubbing/slow-mo playing with A
• Right Trigger - Quick Scrub/Slow-Mo forwards, analog controlled on the trigger to adjust speed (less trigger pull = slower, full pull = 1.5x). Will revert to playing if replay was playing before trigger was used, can toggle whether to play or pause while scrubbing/slow-mo playing with A

.echoreplay File Format

To record .echoreplay files without writing your own software, you can use Spark (download)

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 timestamp, the tab character, and the full JSON data from the game's API

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.

QUESTIONS

If you have questions, join the discord server for this project at https://discord.gg/srWMCnD

demo-viewer's Issues

App crash on player respawn with active follow cam

When the players respawn in/are teleported to the locker room eg. after a goal or on round start, and I am following one with the follow cam (independent of the mode POV, Orbit, Follow) the app crashes in the following seconds after the respawn.

This occurs around 9/10 times, probably even more frequently. Sometimes it didn't happen or I didn't wait long enough after the respawn.

This does not seem to happen when the follow cam follows the disc.

Feature suggestion: Allow playback control for currently loaded file after taking host

In multiplayer you can make yourself host of the room. It would be great if after taking host I could control playback of the currently loaded file (which is on my friends PC and not on mine.)

Viewer crashes at end of the replay file

After last frame, throws indexoutofbounds exception

Extremely bad performance

The performance of this app has gotten incredible bad over the last half year/8 months. I used to run fine, now after loading any file, no matter how small, I only get 1 frame every 2-3 seconds. And that's before I actually start the replay. This is unusable.
It also uses up all my memory.

I do know my laptop is not very powerful, but it used to run perfectly fine.

---

My Specs:

• Core i3-8130U
• Intel UHD Graphics 620
• 8 GB RAM
• Replay Viewer v1.10.3 (Oculus store version)

Multiplayer connecting is buggy

When we tried to review a recording yesterday I connected to the room of my friend. However, I could not see any players or anything and in the bottom left it said "Live. Connected to: ", with no file name shown as it would usually.

With some playing around I was able to connect and see the players. I think what we did was to connect first before the host loaded a file. A third teammate was still not able to connect.

Another bug was that while I was connected and could see the players and everything, the goal laser animation was playing on a loop which was quite distracting. (orange lasers if that's important)

(this was on v1.10.3)

---

I will leave a comment when I find a way to reproduce this reliably.