Category: How To Guides

Mission X: Setup Guide

Introduction This is a short guide on how to properly set up MissionX via SynthesisVR. Important Note: MissionX has 2 different versions 1. MissionX for Quest Install this version if you are going to play the game on the Meta Quest headsets. 2. MissionX Use this version if you are using an other headsets such as the HTC Focus 3 or Pico Headsets. Step 1: License the game How to License Content: https://synthesisvr.com/knowledge-base/licensing-games/ Step 2: Install the game on the headsets How to Install/Uninstall/Update Licensed Content on your Standalone Headset: https://synthesisvr.com/knowledge-base/manage-standalone-content/ Step 3: Install the game on the dedicated game server Not sure what a dedicated game server is? View this article: https://synthesisvr.com/knowledge-base/game-server-automation/ You’ll also have to install the game on your dedicated server PC, this can be done from the Access point by going to “Content Events” tab. If it is not there, You will now find the game is installing under the “Content Events” tab in the Access Point of your game server computer Step 4: Assign the game to the dedicated server You will also have to assign the game to the “Dedicated server games” list, the process is mentioned in the Standalone server article: https://synthesisvr.com/knowledge-base/game-server-automation/ Step 5: First time start-up – Start the application and configure the game manually Starting the game on the game server manually We recommend starting the game manually for the “Non Quest” version of the game, on the server the first time, so that you can log in with your arcade credentials for the game ( you can select the Auto login and remember password options so that the process can be automated ) . To start the game manually, Your Credentials & Extra Settings The credentials can be found by going to Administration–>Games, Categories, Licenses–> Find the game, click on it and go to the “Extra Settings” tab, there you’ll have your MissionX account info as well as some helpful plugins and automations for the game. Something that we recommend is to use the “Instant game start” option that is at the bottom, as this will allow the game to start immediately rather than wait for the players to connect before the game begins. Start the game inside the headset, manually After all of your headsets have connected to the lobby, you can close the game manually in each of the headsets, and on the game server. Step 6: Launch the game using the Local Manager from this point on Not sure how to launch games? How to Launch Games: https://synthesisvr.com/knowledge-base/local-manager-launching-games/ After this is done, and you’ve successfully joined the lobby, you can now close the game on the HMDs and the server, and run it properly from the Local manager launcher. The server should automatically log you in, while the headsets should automatically join the lobby.

Quark XR – Automatic VR Streaming – The Guide

Heads up: if you want to know more about the past and the present, please jump on our “A brief history of VR Streaming” blog post. Prerequisite: 1. Login to your account, head to the Content Store, and search for “streaming”: 2. On the next popup, pick the PCVR stations that will be used for streaming and click the Install button: 3. Run MobileFuel and install QuarkXR on the actual HMD: Note – if this is the first time you are using Synthesis on the specific HMD, you first have to install SynthesisVR. Following the Synthesis installation – put on the HMD and under the HMD’s own environment, start the “SynthesisVR” application. On Meta Quest 1/2, the app will be located under the “Unknown Sources”. On Pico, the app is next to your other applications and games. On Focus 3, the Synthesis app is under “Apps >> 2D”. Upon starting the app, you’ll see a “Please Wait” message – this indicates the system is synchronizing the game trailers and images, and depending on how much content you have pre-installed, it could take between 1-10 minutes. 4. Go to “Your Arcade” page, make sure there is a green dot for the VR station created for the HMD (if it’s not coming up for you, Log out from my.synthesisvr.com and log back in) and Enable the Kiosk Mode: 5. Pair to / Unpair from a VR Station (make sure both stations have green dots):

How to change the Access Point web port

The Access Point’s local API port now can be changed to any port higher than 1000. The way Synthesis consumes the default 8080 port allows sharing it with other processes, but certain third-party software and apps are not adopting the same level of openness and demand port 8080 exclusively for them. Default Access Point local API port: 8080 Accepted value: between 1000 to 65535 Changing the port is supported as of Access Point version 3.19.2 Upon changing the port, send a Refresh command to all your VR stations. The Access Point will restart and use the new port. The first time a new port is in use, the Access Point will request Admin Permission.

Goods Management Add-On – Integrating Merchandise, Food, and Drink Sales 

This guide will go over the setup of the GOODS CONFIGURATION and the process of using goods to sell merchandise, add ons and so much more. Since our goal is to provide you with a flexible and customizable Goods section, you will see that there are no pre-set categories or items. That being said you can organize and add items as per your needs and set up everything the way it will fit you best. 1. Adding categories, sub-categories, and items. From the Advanced Settings of the Administration Section, click on Goods under the Extras tab: To add a new item, click on the 3 dot menu on the top right and then click on the Add Item button, which would bring up the Add/Edit Item popup. Fill in the appropriate sections as per the below: 1. TITLE – here you should add the name of the product you want to add, for example, Bottled Water. If you will offer different sizes of the specific item you will need to add each of them, for exampleBottled Water 16.9 Fl oz (500 ml) and Bottled Water 8 Fl oz (240 ml)2. AVAILABLE IN ARCADES – when you click on it , you will be able to select your arcade from the drop-down menu. If you have more than one arcade you can set up different menu items for each of them, or set them all to share the same items. To add a second arcade, click on Available in Arcades again, and the second location will appear, and so on.3. CATEGORY PATH – you can use this section to create your menu structure. To add the first category, click on Category Path, below it you will see a text box, where you can fill in the category name. This will be your main category. If you click on Category Path again, a second text box will appear right after the first one. The second box will be a subcategory of the first one.Lets say that you will offer 3 types of items: Beverages, Snacks, Sweets. Those will be your 3 main categories, each of them can have its own subcategories for example: Each subcategory can have its own subcategories, this will allow you to create a more complex menu structure if needed.4. COST – this will be the price of the item.5. ENABLE QUANTITY TRACKING – If you select yes, you will be able to track the available quantity of the item that you have on stock in your arcade. In this case, if the remaining quantity is 0, the arcade operator will not be able to sell this item. After an item that has quantity tracking enabled is created, you will need to assign the proper quantity which you have on stock. This will be shown later in the tutorial.In case you select no, the arcade operator will be able to add this item to the client’s order, no matter if the item has stock or not. Under the Advanced Tab: 1. AVAILABLE ONLY FOR REGISTERED CUSTOMERS:In some cases, you may what to have special limited items that would be available only for registered/regular customers. If you select yes, the arcade operator will be able to sell the item to only such customers.2. ADD POINTS TO CUSTOMER:3. ADD BALANCE TO CUSTOMER: Once you’ve added a few items and you refresh the page, you should see something similar to the below: You can click on any item to edit it if you need to make changes from the above. ASSIGNING QUANTITY TO AN ITEM:When one item is added with Enabled Quantity Tracking, by default is with quantity 0. To assigning quantity find the item and click on the plus button next to it: You will see the following pop up:Enter the proper quantity and click on add. The pop-up then will close itself and the quantity will be added to the selected item. 2. Selling Goods Head over to the Your Arcade Section, click on the 3 dot menu in the top right and click on Sell Goods, which will bring up the following pop: To add the item to the customer’s order, simply click on it. And the item will be shown in the bottom part of the pop-up. If this item is with enabled Quantity Tracking, the total remaining stock will be deducted with 1 automatically once you click on it. If you want to remove some items from the order, just click on the red minus next to the item. In case that this item is with Quantity Tracking enabled, the total available quantity will be increased accordingly.If the arcade operator adds by mistake a higher quantity from an item, or the client changes his mind, when the red minus next to the item is clicked, the count will be deducted with one for every click. Let’s say that initially there were 3 Bottled Water items added, and this needs to be adjusted to 1, the employee should click twice the minus sign.In the customer field, you can search for already registered customers, leave it empty for guests, or click on Add to add newly registered customers.PAYMENT.You can do cash payment, card payment, or split payment.From the Payment Type drop-down, you will need to select the proper payment. Let’s say that the customer wants to do a split payment $10 cash and $10.5 on his card. Select Cash, mark $10 and click Add Payment. You will notice that the rest of the amount will be automatically recalculated and will be populated. Now just select the POS terminal from the drop-down and click Add Payment Once the customer fully paid his order, the Complete Order button will appear. When clicked the order will be processed and the pop-up will close itself.If the customer is already registered and has CC on file, this will be also shown as a payment option, the same goes for if the customer has an available balance. 3. Reports  To access Goods Reports, you can access that from the

Booking Add-On – Selecting Game on Booking Widget

Have you ever wanted the ability for your customers to choose a game when they book a session? Now you can! This comes in handy when you have a virtual reality escape game experience where customers can only play one escape game for a certain amount of time, choosing the game will inform the operator which game the customer group wants to play and the operator can be prepared and make the necessary arrangement for this experience. Setup – Step 1 Please make sure Your experience supports this feature. If you are not familiar with how to create an experience, please check this knowledge base article. Once you have created the desired experience, On the Experience – Advanced Tab: make sure to Enable Yes on Enable game selection for the booking widgets option as shown below: Setup – Step 2 and 3 Create a Business Rule that will only have one assigned game category as well as the maximum number of games to 1 as shown below: For more information on how to setup Business Rules please click here. For more information about setting up Game Categories please click here. End Result Upon booking a session the game will be automatically selected for the operator so he/she can launch it.

Loop through a list of titles on a predefined period

1. Create a new experience type 2. Assign it to the stations that would be in use 3. Create a new game category and assign all the games that are part of the playlist 4. Create a business rule that combines the new experience type and the game categories 5. Download and extract the following archive in the exact same folder on all your VR stations: https://svrstorage.s3.amazonaws.com/software/playlist_scripts.zip 6. Edit the basic_playlist.bat file in a text editor. Keep the first 2 lines and then add a line of that type for each of the games: curl.exe http://localhost:8080/control/startGame/<GAME_ID> You can find the game ids by going to games.synthesisvr.com/all >> lookup the game and get the id: Between the games, add the line for delaying the event. A 10 minutes delay is defined the following way: timeout /t 600 /nobreak > NUL Once you are done editing the file, don’t forget to get it copied on all the other stations. 7. Create a new Command Call rule and specify the path to the basic_playlist.bat file, as well the experience type: 8. Click the Refresh button on your stations – this will sync the new settings locally on the PC. 9. Start a session for the new experience type. Selecting a game is unnecessary, as that is now handled by the basic_playlist.bat script.

VR Session Manager – Timeline View

Overview To switch between The Station View and the Timeline View, click on the “Timeline View” switch at the top. Note that this is a local switch and would need to be set on each of the devices that access the Your Arcade page. ​Station View: ​Timeline View: ​On the left side of the Timeline View, you’ll see all of your stations listed sorted alphabetically. ​ On the left of each station is a button that will bring up station specific settings (including things like Wake-on-LAN, Station Shut Down, etc). If the station is detected as connected the color of the button will be green. Offline or is a virtual station it will show as purple. On the right side of the section will be an icon of the headset in use on that station as well as controller battery percentage. Along the top of the Timeline View, you’ll find the different experience types you offer. You can, of course, click on each to show those stations the experience type is attached to and any bookings that use those stations. In addition, you can also click between the tabs using the Alt+[number} to switch. You can also change between them using Alt+ the left or right arrow to cycle between each experience type. ​ Below the Experience Type tabs on the left side is the Walkin Mode toggle and the time display. Walkin mode will be explained a little further down in this guide. Clicking on the time display will adjust how you want your time to display in the Timeline. If you click on, for example, 15 the Timeline will show time broken out into 15 minute increments. Clicking 30 will show the time broken down into 30 minute increments, etc. This will be remembered for the next time you open the Your Arcade page. Underneath the Experience Type tabs on the right are the buttons to allow you to page through your days. This helps you see previous or upcoming reservations without having to go to the Reservations section. ​ And, of course, the main section of the Timeline View shows the sessions/reservations all broken out by station and time. Colors are determined randomly and assigned a unique color for each session so it’s easy to identify which sessions are together and which are separate. Hovering over each session block will give you details on that particular session. Clicking on a session (or clicking on the View button in the popup details) will bring up the session summary which will be discussed later. ​ ​  Scheduling: Future Reservation: Somewhere along the Timeline, ideally close to the time you want to schedule, right click on one of the station’s timeline (again, ideally one of the stations you want to schedule for, but not a requirement). This will bring up the schedule menu. Click on the Schedule button. You can click on the X button or press Escape on your keyboard to get out of this menu. ​ After you click on Schedule and once you start moving the mouse, you will be able to start putting in the session reservation. Depending on which direction you move your mouse (left and right along the Timeline) from the point you right clicked, you will be either adding time forward or time backward. Meaning that if, for example, you right clicked at 4pm and you moved the mouse to the right, you’d be adding time for after 4pm (starting at 4pm) and if you move the mouse to the left you will be adding time prior to 4pm (ending at 4pm). If you move your mouse up or down along the Timeline, you will be able to add/remove stations within the session. Once you’ve got a basic setup of what you want to schedule (don’t worry about being precise, you can refine later along this process), you will get the next set of options for scheduling. If everything looks good to you, click on the Schedule button at the top and that will bring up the Sell Ticket popup to complete the booking (again, you can continue to edit in that popup). ​ In the bottom of this initial popup, you will have the option to pick a specific duration based on your Experience Types and Work/Business Rules. The left side will choose a duration that starts at the time on the left side, and the right side will create a duration that starts at the time on the right side of your selection. ​ If you’re booking from the “All” tab, you will be given all Experience Types and times within those Experience Types (so long as you’re scheduling within the Work/Business Rules of those Experience Types). ​ If you’re booking something for today, you will be given additional options to Snap Left and Snap Right. Snap Left will let you “snap” the booking to start at the end of the next session booked on that/those station(s) or immediately if you have no prior bookings. Snap Right will only be visible if you have booking on that particular station(s) and will “snap” to the beginning of the next session. Note that if you have cleaning times set in your Work/Business Rules, those will be taken into account as well. ​ Final tweaks that can be applied to the booking before you go to the next step include the ability to remove a station from the booking by clicking on the red minus sign in the booking and adding a station by clicking on the big gray + button on the booking. Additionally, if you hover over the session and you see your cursor change to a plus sign, if you hold down the mouse button while the plus sign is showing you can drag the session to the right or left to change the start time. Once you have got all your things you wanted to set up done and you’ve clicked the “Schedule” button, this will bring up the

Content Licensing: How To License Games

For game licensing, head over to the Your Games page: or From there click on the “Content Store” tab and you’ll see all the games available for licensing. ​On the left side you can either use the filters by clicking on them (green is selected, white is not selected). Or you can search by entering the name or part of the name in the top field and then pressing Enter on the keyboard.​ When you hover over a game, you will be given two options, the first, “Visit Page” will take you to the game page on games.synthesisvr.com in a new tab which will give you details about the game, including info on pricing, system requirements, etc. Clicking on License will open up a new portion on the same screen on the right side. On that new tab, the first thing you have to do is ti check the box next to the “I understand that, once subscribed, Licensing affects all stations in the arcade regardless if the game is installed via third party.” Once. you’ve agreed to this, then the License Now button becomes available. Once you’re ready, click on that button to license the game. Once you’ve licensed the game, you will be presented with one of 2 options. If the game is delivered through Steam, you will be presented with the following choice for installation: ​ Click on the stations you want the game installed on and click on “Install”. The game should then be licensed and downloaded on the selected stations. ​ On the stations you are installing the game to, you would need to do one more step. When the install is initiated, you will need to click on the Next button on this screen: ​ Accept any agreements that pop up after and installation should begin after that. If, for some reason, the game doesn’t install, please check your library and locate the game and see if it’s stuck on “Installing”. If that’s the case (and it doesn’t show up in the Steam Downloads section, you will need to cancel the install by right clicking and choosing Cancel and then exiting Steam. Once you restart, you can attempt to initiating the install again remotely or find the game again in your library, right clicking and then choosing install and you should see the prompt above. If there are still issues, please send us an email with details to info@synthesisvr.com. If the game is delivered through our CDN, the popup will show all stations detected as online and allows you to choose per station where to install the game both in terms of which station as well as what drive (if you have multiple drives installed on your system): ​ Once you’ve chosen the stations and drive locations, you can click the “Install” button below all the stations and the game will begin to install on those stations. ​ If you check your Access Point app and click on the Content Events button, you should see the game being installed: ​ If that is not the case, please refresh your Access Point app via the Refresh button and you should see the Content Events button and the game in there. You can start it manually if it hasn’t started.  The need to do this manually is rare, but is more reliable than Steam installs. Once a game is installed (via the auto methods above), you will then be prompted to add to a category. Select the categories you want and click on the “Add [GAME} to [X] Categories” button at the bottom. ​ If you’ve only installed the game on some, but not all, stations and want to go back and install remotely, then find the game again using the search feature and click on “License” when you hover over the game icon. You’ll now see a button that says “Install [GAME} and when you click on it, you will be presented with the same choices as above for installing on stations. ​ If you want to change a game from Usage to FIxed Fee, then find the game again using the search feature and click on “License” when you hover over the game and you will be presented with choosing between Usage and Fixed Fee. ​ Click on the Fixed Fee and you will be asked how many licenses you need for that. Choose the number of licenses and then click on Add To Cart. Remember, this is a floating license so you man not need as many fixed fee licenses as you have stations unless you expect the game to be played a lot on all your stations at the same time. ​ Once you’ve added the right number to your cart, the cart option will appear above the game and you can click on “Checkout” if all seems correct. Your card will be charged the amount shown on the screen. This amount will be a prorated amount for the remainder of the month. If we’re close to the end of the month, you will see the prorated amount as well as the upcoming month added together. ​ If the game is already installed, nothing more needs to be done. If it’s not installed, then the process is exactly the same as described above.

SynthesisVR Log

For troubleshooting purposes and support related issues SynthesisVR log files provide a necessary insight on what could be the issue or for support team to better decipher a certain problem or track an activity. In cases like this knowing how to access to log file and sending it over to support is very important. To access log file – On your right bottom taskbar you will find a SynthesisVR icon as shown below: Clicking on the Load 1000 Lines to bring up the most recent entries. You can then copy all the text into a text file and send that or just paste it into an email for support.