Experience Types Add-On – Custom VR Session Types
Introduction “Experience Add-On” is a purchasable add-on for Synthesis VR Essential Access . Modules & Add-Ons are purchasable features that increase the functionality and capability of the Synthesis VR platform. The “Experience Add-On” allows you to create and manage custom VR Session Types.. Additional Notes: 14. The minimum number of stations that can be booked for the particular experience can be defined using Minimum number of stations in a session. 15. The maximum number of stations that can be booked for the particular experience can be defined using Maximum number of stations in a session. 16. Difference in minutes on the calendar allows you to decide the time difference in between the booking slots. 17. If this Experience Type is for all stations, then choose “Yes” from the “Complete Stations Booking” drop down menu. This will be most useful for walk in sessions for a full venue and will save a few steps. This would also be good for online bookings for full venue reservations. If this is for individual stations or anything less than the full venue booking, then choose “No” from the drop down menu. 18. Once you’ve entered in all the necessary (and optional) sections, you will see that the “Save” button is now solid and clickable. Click that to save, otherwise your edits will be lost. If you want to exit and start over click the tiny “x” button in the top right of the window or click the “Hide” button at the bottom of the window.
Voice Chat Service
The “voice chat” is an out-of-the-box feature of SynthesisVR and requires zero configuration. It bridges the input audio from all stations related to the same reservation/session and puts them into a “conference call” where they can communicate with each other and you can communicate with them. How do I enable the Voice Chat? In the Settings of the Access Point App on each of your stations, choose select the “Enable Voice Services” item and that will start a new background task: This will then launch the Voice Chat service and the interface. If you open the interface, you can change the microphone and headphone if necessary: That’s mostly it. Going forward, people within the same session will be able to hear each other regardless of whether they are in a multiplayer game or not.Customers, from within the VR interface, can also turn this off (or back on) for their individual station if they don’t want to be part of the conversation.From the V3.x interface:From the V4.x interface: Using the Voice Chat to talk to your customers All the Voice functionalities are based on the related Voice Over IP (VoIP) protocols and work via:1) Browser2) Third party apps for Windows ; Linux ; Android ; iOS3) Standalone VoIP devices4) Regular phones with ATA adapters Configuring a third party app Although all apps will have a different interface, they have a couple common configuration parameters. Lets use the Zoiper app as an example (available for all 4 major OS).1) Install Zoiper (https://www.zoiper.com/)2) Go to “Settings >> Create a new account”3) Select “SIP” as “Account type” and click on “Next”4) Fill the following credentials:a. User / user@host => 1000@192.168.1.105 (replace 192.168.1.105 with the local IP of the PC where you installed the SynthesisVR’s “VR Main Server” mode )b. Password => 3420c. Domain / Outbound proxy => [KEEP IT EMPTY]5) On the next screen, enable the “Skip auto-detection” option and click on “Next” and then click on “Close”.For Windows, we recommend the MicroSIP app (https://www.microsip.org/downloads):Example MicroSIP account configuration: What numbers I can dial? Each of your VR stations has an individual and unique “phone number”. If a station number is 10001:1) Dial 99910001 to reach to the individual station alone. To do that, you don’t need an active session in place.2) Dial 88710001 to reach to the conference call and talk with all the players in a session. The full conference session number is displayed on the “Your Arcade” page of your Dashboard and clicking on the gear icon in the top right of a station: Additional notes:1) The 1000 number is reserved for the Operator’s account. Its password is 3420.2) If you have the “VR Main Server” and “VR Station” modes both installed on the same PC, you may experience chunky audio with that particular station.3) If a customer mutes the Voice Chat, you are still able to call into that individual station and have a conversation.4) Third party firewalls and Antivirus software may block the audio. Please ensure the following network ports are not blocked (don’t forget to check your router as well):a. VR Main Server – TCP – 8021 ; 7443 ; 5066 ; 5060 ; 8020b. VR Main Server – UDP – 16384-32768c. VR Station – UDP – 5020 ; 4000-5000
Reading Sessions & Goods Data Through API
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the “customers” permission. 2. The customers data is available in both – JSON and XLSX formats. HTTP GET Request: The result is suitable for automation in third party tools and backends. https://api.synthesisvr.com/data/<ENDPOINT>/<API_KEY>/<TYPE>/<RANGE>/<SEARCH CRITERIA> Example: https://api.synthesisvr.com/data/sessions/11111111-1111-1111-1111-111111111111/json/1 day/date=2019-07-12 ENDPOINT = sessions OR goods TYPE = json OR xlsx RANGE = indicates how many days should be returned after the main date (which can be set through the search criteria). The range value consist of an integer value (1) and a period string (hour ; day ; month ; year). Combinations are possible as well: 1 month 5 days 2 months 3 days 1 day 8 hours SEARCH CRITERIA = a space separated string. Support the following options: date=[YYYY-MM-DD] — specifies the start date for the RANGE value (mandatory in the common case) date>[YYYY-MM-DD] — equal or great than the specified date date<[YYYY-MM-DD] — equal or less than the specified date crdate=[YYYY-MM-DD] — search by creation date today — considers the current date upcoming — any reservation that isn’t yet used skip_api — ignore all sessions created through the API (i.e. skip all sessions booked online) api_only — return only the online session customer:[ID] — obtain results for a specific customer account label:[ID] — obtain results based on a label(tag) ID uuid:[UUID] — lookup a specific session by its SynthesisVR Session ID externaluuid:[UUID] — lookup one or more sessions by an external UUID (supplied to Synthesis at creation time) [free text] — can be used to search based on customer name, email address, phone number and other specific information. It doesn’t require a prefix as with the options above. comments — extract the comments data (only for JSON exports) phone — include the customer phone number to the export Note: Anything described above as [something] have to be replaced with the actual value you are looking for.
Reading Customers Data Through API
1. Create a new API rule (similarly to https://synthesisvr.com/knowledge-base/reading-leaderboard-through-api/) or edit an existing one and assign the “customers” permission. 2. The customers data is available in both – JSON and CSV (comma separated) formats. 3. You can call search queries and fetch JSON results ———————— JSON: The result is suitable for automation in third party tools and backends. To obtain the JSON data, prepare the following URL: (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/json Example: https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/json ———————— JSON SEARCH: To obtain the JSON data, prepare the following URL: (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/search/<SEARCH> Example: https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/search/email@domain.com ———————— CSV: As long the JSON provides all the customer information, the CSV can be formatted to a file, ready for manual important into a third party systems (e.g. email lists). The request URL will be of the type: (HTTP GET) https://api.synthesisvr.com/data/customers/<API_KEY>/csv/<PARAMETERS> Example: https://api.synthesisvr.com/data/customers/11111111-1111-1111-1111-111111111111/csv/fullname,email,phone The output file will be ordered according to your web request. Possible parameters: id = the Synthesis account id email = customer’s email address in lowercase fullname = capitalized customer’s name phone = self explanatory balance = any customer balance held by Synthesis widget = the widget used by the customer to subscribe sessions = the number of sessions for the current customer (combines previous and upcoming) regdate < or = or > = extract customers based on date of registration. The date format is YYYY-MM-DD [ANY custom field] = the identifier of the custom fields defined for the location To request more parameters, please shoot us an email to info@synthesisvr.com ———————— Profile Update (2022-11-18): You can update customer profiles by performing HTTP POST request against the following URL: (HTTP POST) https://api.synthesisvr.com/data/customers/<API_KEY>/<CUSTOMER_ID> All the new data should be in JSON format. The final JSON object is stringified and included in the request’s BODY with the “values” parameter. Example raw HTTP POST request: POST /data/customers/11111111-1111-1111-1111-111111111111/123456789 HTTP/1.1 Host: api.synthesisvr.com Content-Type: application/x-www-form-urlencoded Content-Length: 43 values=%7B%22language%22%3A%22english%22%7D You can include as many JSON key-value pairs as needed.
Synthesis VR Setup – Add More Stations To Your Location
Follow the instructions here for installing the Access Point: https://synthesisvr.com/knowledge-base/synthesis-vr-installation/ Once your Access Point(s) are installed, head to Administration >> Arcade Setup >>Billing Be sure to select the proper subscription in the Essential section that is found in the “Add” tab. If subscribing more stations to a trial, be sure to select the SynthesisVR Trail subscription option. Once you select the subscription you want, be sure to select the correct stations and make sure the total on the right is correct (if adding to a trail, make sure it shows $0.00). Scroll down to the bottom and click on the Subscribe Now button. Once your station(s) have been subscribed, you’ll need to head to the VR Devices section found here. You’ll need to click on the Edit button to open up the station information and add (or remove) the Experience Types you want to have this station be part of. This is also where you can assign a 3D Environment and Edit the Station Name (Title). Your new station is now ready to launch sessions for the assigned experiences!
Game Categories – Organize Your Content
Synthesis VR game categories allow you to choose which games are available for customers to choose from. They also can act as filters as you will see below. By default SynthesisVR will include all downloaded games as available game options during sessions. Once a game category is setup and assigned, only those games will be available. To create a game category navigate to Administration>> Business Setup >> Games, Categories, Licenses. Followed by clicking on the Categories tab: To create a new category, click on the large New Category button. This will bring up a new game category window. To add games to the Game Category, you can either double click on the games displayed in the left column or drag them from the left column to the right space. Note that the list on the left can be searched using the search field at the top (and additionally, this list only displays games discovered to be installed on your stations). If you are building a Game Category of all your games, you can simply click on the “Assign all your installed games”: To organize the order your games displayed in you simply need to click and drag the games within the right hand list. Alternatively, if you want them in alphabetical order you can click on the “Sort Alphabetically” button. Once done, click on the Save button at the bottom. At this time, you have only created a game category and it is not connected to anything else. To have it shown to customers, you need to assign the Game Category to one or more of your Work Rules. You can refer to this article for Work Rules within Operation Settings: https://synthesisvr.com/knowledge-base/work-rules-by-duration/ Note that you can also reach the Work Rule by clicking on it where it shows it is Assigned in the Categories section: When you are in the Work Rule, head to the Games tab and simply click on the Assign Game Categories + button to add more Game Categories or click on the red x to remove game Categories. Using the drop down on each Game Category allows you to choose which one will show. Note that the order the Game Categories show in this section is the order they will display for the customer in the headset. Enforced vs Optional If you create an Available Games – Enforced Game Category, then when you assign the Game Category will show in every session that the Game Category is assigned to. If you create a Restricted Access – Enforced Game Category, then when you assign this Game Category to a Work Rule, all games in this Game Category will be hidden in any other Game Categories are assigned to that Work Rule. This is most helpful if you want to create different Work Rules with the same Game Categories as your other Work Rules, but don’t want to go through and create different Game Categories to remove individual games and you can just add this Restricted Game Category to the Work Rule. If you create an Available Games – Optional Game Category and assign it to a Work Rule, than you are able, on a station by station basis, decide to include that category or not in the session. Note that at the start of a session, the Available Games – Optional categories will be selected by default and must be UNCHECKED to have them not show. If you create a Restricted Access – Optional Game Category and assign it to a Work Rule then you are able, again on a station by station basis, decide to essentially hide the games in this Game Category from a specific station. Note that at the start of a session, the Restricted Access – Optional categories will be unselected by default and must be CHECKED to hide games in this category. In the below image, the “Easy” Game Category is set to Available Games – Optional and the Medium is set to Restricted Access – Optional. Again, each station can have different options chosen at the start of a session. You can also assign games directly from the game itself. From the Your Games tab in the Games, Categories, Licenses section click on any game and go to the Categories tab: From there you can Enable or Disable a Game Category that a game is assigned to. Once finished, click on the Save button at the bottom. Note that a Game Category must have at least one game assigned to it prior to using this method. You can use the drop down number on the right of an Enabled Game Category to assign where in the list the game should show up.
Reading Leaderboard Through API
To programatically read the leaderboard data collected by SynthesisVR, please follow the steps: 1. Login into SynthesisVR with your administrator account and navigate to: 2. Head to the API & Webhooks tab and click on the + button on the top right: Make sure the leaderboard permission is assigned.If the “Strict Access” option is enabled, you will be able to access the collected data ONLY from an IP address associated with your location. 3. Prepare the following URL: Example: Upon refreshing the Widgets page, you’ll be able to locate your API key: Game ID — keep it to 0 (zero) if you want to fetch information about all the collected games. Based on that response, you’ll be able to see and use specific game idsDuration — any combination of <number> + <period>. Examples: The API response data is formatted as JSON and have the following structure: The “score” object itself contains:info = raw data extracted from the game (differ between the games)score = SVR attempt to recognize and extract the score from the info objectcustomer = the customer associated with the SynthesisVR session. In a multi-station session, the data don’t necessary correlate with the actual player.utcepoch = the UTC epoch when the leaderboard record is logged (you can look up the exact date/time in any programming language ; online example: https://www.epochconverter.com/)
Setting up and Customizing Waivers
SynthesisVR supports custom waiver forms which can also be used as customer registration forms as well. By using SynthesisVR waiver forms you save money from subscribing to 3rd party waiver forms and with inbuilt customer registration you can track all your customers. How to customize waiver form: Head to Administration >> PRO >> Online & Email Settings >> Web Templates The following templates have to be modified: waiver_text waiver_parents_text Both of these are HTML formatted and would need to be edited accordingly. Please reach out to us for help with this if needed. To add your logo in the waiver form edit this template: logo The logo needs to be a publicly accessible image. Please let us know if you need hosting help. How to access the waiver for your customers: Click Dashboard on your admin panel You will see a Waiver Form button. Clicking this will open a pop up. You can copy this link on a tablet or any smart device and use it for client registration as well Note that if you need to have the waiver access outside of your arcade, please check this link: https://synthesisvr.com/knowledge-base/online-waivers/
Access Point 3.9 – Release Notes
Version: 3.9 Release Date: 5th June, 2019 Download | Version 3.9 Critical Bug Fix: The 2D Launcher may hung upon restart of SteamVR versions 1.4+ The PC identifier may not make it up to the pc settings, resulting in specific CDN games not working properly New “Access Point” Functionalities: Version 4.0 Beta 1 – new VR Interface Version 4.0 Beta 1 – support for “Game Plugins” Fruit Ninja VR – CDN Support New Module: “Standalone Game Server” – purposed for Free Roam games Version 4 – New “Web Administration” Functionalities: Configure “Game Plugins” Install existing plugins How To Activate Version 4 Install an existing Game Plugin
Troubleshooting: Synthesis VR dashboard not displaying
Behavior: Synthesis VR dashboard is not displaying when the STEAMVR home button is pressed as shown below: Determine Synthesis VR client app is up to date with the current version on synthesisvr.com/download Determine if Synthesis VR Access Point APP and SteamVR are launched and Synthesis VR App is displaying “In a good state” on the bottom of it. Click The 3 line button on SteamVR and then click Settings Please make sure Advanced Settings is set to Show Click Dashboard on the Settings Menu Please Enable VR Dashboard on System Button to On Please see the below image for reference If the above settings are all enabled and setup correctly and still no Synthesis VR dashboard please do the following:1. Restart the pc. If the issue is not resolved.1. Verify your graphics card drivers are up to date.2. Verify that the graphics card is assigned as the primary graphics card if you also have an integrated graphics card.3. If the issue begins after a driver update. Roll the driver back to the previous one. If nothing resolves the issue please email info@synthesisvr.com for support.