The command line tool (synthesiscmd.exe) provides an easy way to integrate core SynthesisVR functionalities into third party applications and usage flows.
Command Line Arguments:
| Command | Accepted Values | Description |
|---|
| -action | startsession
endsession
startgame | Specify command action |
| -experience | [ID] | Any of your SynthesisVRExperience Type ids |
| -duration | [MINUTES] | A duration value defined under your Business Rules |
| -gameid | [Game ID] | The game IDs are visible upon visiting the game page under games.synthesisvr.com |
| -wait | true
false (default) | If true, upon completion of the command, the tool will wait for an user input before close |
Examples:
Starting Beat Saber for 15 minutes on the Immersive experience type
"C:\SynthesisVR Exclusive Content\4527\synthesiscmd.exe" -action=startsession -experience=1 -duration=15 -gameid=1131
Starting Tales of the Rocks for 30 minutes on the Immersive experience type
"C:\SynthesisVR Exclusive Content\4527\synthesiscmd.exe" -action=startsession -experience=1 -duration=30 -gameid=4418
Ending the session before the actual end time
"C:\SynthesisVR Exclusive Content\4527\synthesiscmd.exe" -action=endsession
Change the game during a running session
"C:\SynthesisVR Exclusive Content\4527\synthesiscmd.exe" -action=startgame -gameid=1131
Few more notes:
- The tool logs to the following file: %localappdata%\SynthesisVR\app\synthesisvr-cmd.log
- It will not work if SynthesisVR isn't running or doesn't have an active subscription
US
