Editing Spark

[[Category:API]]

[[Category:Community Projects]]

''For other uses, see [[IgniteBot_(disambiguation)| IgniteBot (disambiguation) ]].''

Spark is a Windows desktop program that can record, process, and upload EchoVR data from either a local EchoVR client or an Oculus Quest on the same network. For a full description and list of features, go to https://ignitevr.gg/spark, or join the IgniteVR Discord server.

None of your game data is uploaded to Ignite servers unless you choose to.

== Installation ==

Spark supports only Windows computers, but it can be used for both Rift and Quest EchoVR clients.

== Setup ==

=== Oculus Rift or Quest+Link ===

# Make sure you have the API enabled in the EchoVR game settings.

# Run Spark and EchoVR at the same time. It does not matter which is launched first.

=== Oculus Quest ===

# Make sure you have the API enabled in the EchoVR game settings.

Once you have complete the steps above, you should see data appear in Spark automatically. When in the lobby, only the Server Location will change, but in a match player names and events should start appearing.

== Troubleshooting ==

==== Spark says Not Connected in the top left corner ====

# Make sure to enable API in your game settings in VR.

# If you just enabled the API in the game settings and you're on Quest, try rebooting your Quest first.

# Verify that you're on the same network as your Quest.

# Some routers disable access to other devices on the network. If you can, try connecting your PC and Quest to a hotspot to test if that's the issue.

# Make sure you're in a public or private match.

----

==== Unknown error while loading the game ====

This is an EchoVR bug. There is no single solution to fixing it, but here are some solutions that have worked in the past:

* Make sure the "Use anonymous mode for Spectatorstream/Spectate Me" box is checked.

* Go to Settings->Beta->Restart Oculus in the Oculus desktop app

* Reinstall EchoVR on your PC

----

==== Find Quest IP fails ====

----

* TTS only works with Discord Login, so make sure that's connected first.

----

* Even if you have the box checked in the settings window, stats only upload in public matches and when you have Discord Login enabled using the Personal access code.

== Main Features ==

* '''Server Location'''

** Estimated location of the current server.

* '''Session ID and Atlas links'''

** Copy the link to let people join your match directly, or use the Discord invite system.

** Allows you to have complete stat history of your matches.

* '''Replay recording'''

* '''"Spectate Me"'''

** Automatically launches a spectator on your PC to join the public matches you are playing in on your Quest.

== Detailed Feature Explanations ==

=== Spectate Me ===

The Spectate Me feature allows you to view your pubs from a spectator perspective automatically.  

* Two devices that can run EchoVR

** Either a Quest and PC, or two PCs.

You can customize the camera settings at the bottom of the General tab in the settings window to either follow you, use sideline camera, or follow some other player by name.

==== As Quest Player: ====

# Set up Spark for normal Quest usage as detailed above

# Make sure you have EchoVR installed on your PC using the Oculus Desktop app.

# A button should appear in the right sidebar of Spark called "Spectate Me"

# Once you join a match on your Quest, EchoVR will launch as a spectator in your public match on your PC. If you get kicked out of your match when the spectator joins, make sure to either check the "Use anonymous mode for Spectate Me" in the Spark settings or log into the Oculus desktop app with a separate Oculus account.

==== As a PCVR Player: ====

===== You will need: =====

* Two PCs capable of running EchoVR on the same network

* Spark installed on both PCs

* API enabled in the game settings on both PCs

** You can use Spark to enable the API setting

===== Setup =====

'''On your playing PC (the one with your headset):'''

# Launch the game normally and join a private/public match or lobby

# Launch Spark

# The IP Address in Spark should be set to 127.0.0.1 (or click the Local PC button)

'''On your Spectating PC:'''

# If the playing PC is in a match/lobby and has Spark running, then Spark should say "Connected" at this point.

# Click "Spectate Me"

If all is well, then your spectator will follow you into pubs and privates.

=== EchoVR Speaker System ===

[[File:Echo Speaker System.png|thumb|Screenshot of the ESS within Spark]]

The EchoVR Speaker System (ESS) is a project by iblowatsports that has been embedded into the Spark window. Check out the source here: https://github.com/iblowatsports/Echo-VR-Speaker-System<br>

This is a system to take any audio stream (usually music) and make it sound like it is being played from "speakers" in a stadium outside of the Arena when you are playing. This is positional audio that adds realistic echo/reverberations as well as taking into account the geometry of the Arena itself so that it feels as though you are hearing your music from a stadium surrounding you.

* The Echo Speaker System installer will automatically download and open the installer of Virtual Audio Cable if you do not have it installed

* After installing VAC, make sure to restart your PC

[[File:Nv highlights.png|thumb|The NVIDIA Highlights clips reviewing screen]]

If you have a PC with an NVIDIA graphics card, you can use Spark to automatically activate a feature like ShadowPlay called NVIDIA Highlights. Spark sends a signal to Highlights to save a clip when certain events happen, like goals or saves. Clips are automatically saved to a temporary directory, but you can then go through all the clips that were saved by the system to save only the good ones permanently. Since the feature isn't provided by EchoVR directly, NVIDIA Highlights is only able to capture the main display, and not just the EchoVR window.

To get NVIDIA Highlights working, make sure:

# You have GeForce Experience installed and set up.

# You have enabled the feature in Spark's settings.

# You have enabled Desktop Capture in the NVIDIA recording overlay under "Privacy control" at the very bottom of the settings menu in the overlay (ALT+Z)

=== OBS Replay Buffer integration ===

Spark can automatically save the replay buffer feature within OBS. This allows you to automatically record clips on certain events even if you don't have an NVIDIA GPU.

[[File:Stats_tabs.png|thumb|The possible tabs on a metrics.ignitevr.gg player page]]

You must be signed into Spark with Discord (top left) to be able to use any of these features.

==== Upload personal public match stats ====

==== Opt-in to detailed Ignite stats ====

Once you have played at least one game with Spark connected, you should be able to check the "Opt-in to detailed website stats" box in Spark. This will enable additional stats such as estimated height, handedness, and time of day played.

==== Upload Tablet Stats ====

The "Upload Tablet Stats" button shows you a window with all of the Oculus accounts that have played EchoVR on your computer. You can click to upload each profile once, or check the box to automatically upload them after every game. This data includes information such as full games played, w/l ratio, and the date of the first time you started playing EchoVR. You must have launched EchoVR logged into your desired Oculus account at least once for this feature to work.

=== Creating Matches in a Specific Region ===

Creating private matches in specific regions is only supported for PC because the Quest version of the game doesn't have full deeplinking support.

However, there is a workaround: