Game Server Automation – Set Up A Dedicated Multiplayer Game Server Computer
Introduction “Game Server Automation” is a purchasable add-on for Synthesis VR Essential Access and Synthesis VR Ultimate. Modules & Add-Ons are purchasable features that increase the functionality and capability of the Synthesis VR platform. The “Game Server Automation” add-on allows you to operate a dedicated, multi-player game server computer. Additional Notes: What Is A Game Server? A game server is a specialized computer that is designed to host multiplayer online games. It plays a crucial role in facilitating communication and interaction between players in a game. Game servers are responsible for managing various aspects of the gaming experience, such as multiplayer connectivity, game logic, data storage, player communication, scalability etc. In summary, a game server is the backbone of a multiplayer online game, managing player interactions, game logic, and data storage to provide a seamless and enjoyable gaming experience. What is a Synthesis VR Game Server? A game server is a computer in your network that has a special version of the Synthesis VR Access Point application. This is special version is achieved by installing the Synthesis VR Access Point, unsubscribing the computer from the “Essential Activation” module, and then subscribing the computer to the “Game Server Automation” Add-On. Why Do I Need The “Game Server Automation” Add-On Many of our free roam titles and premium games require a server instance. That instance is running on a separate computer, that cannot be used for any actual gameplay. The “Game Server Automation” module is specifically designed to monitor the games and automatically start the game server instance when you need it. This computer: Task 1: Installing A Synthesis VR Game Server Step 1: Pre-Requirements Step 2: Install the Synthesis VR Access Point Step 3: Unsubscribe This Computer From The Essential Activation Module By default, a newly installed instance of the Synthesis VR Access Point on a computer tells the Synthesis VR System that this computer will be used as a VR gaming station. We need to inform the Synthesis system that this will not be a VR gaming station. This is done by unsubscribing to the “Essential Activation” module. Step 4: Subscribe This Computer To The Game Server Automation Module Step 5: Refresh Your Station Refreshing the station will confirm your changes, and the Synthesis VR Access Point will now say “Dedicated Gaming Server”. *You might have to refresh a few times Task 2: Assigning Games To Utilize The Game Server Step 1: License A Game That Requires A Game Server Step 2: Install That Game On The Game Server Step 3: Assign The Game To The Game Server Hold on! You are not finished yet. In order for Synthesis VR to utilize the Game Server for a given game, you must “assign” that game to the game server. Method A – Using The Web Terminal To Assign Games To The Game Server Method B – Using The Local Manager Application To Assign Games To The Game Server
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.
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
Booking Add-On – upon successful booking, redirect to a confirmation page
In case you want to track your website conversion through third party widgets or code (like Google Analytics or Facebook Pixel), you’ll have to redirect your website visitors to a page on your website that has the necessary code. To do the redirect, please add the following code under the “Add HTML before the BODY tag closure” setting of your Booking Widget: <script> window.onSVR_SuccessfulBooking = function(bookingData){ try { var passData = new Object(); bookingData.email = window.svr.selection.email; var redirectUrl = ‘https://yourdomain.com/thankyou?id=’ + btoa(unescape(encodeURIComponent(JSON.stringify(bookingData)))); window.top.location.href = redirectUrl; } catch (err) { alert(err); } } </script> Don’t forget to replace yourdomain.com with your actual domain name, as well as ensure that you have a “thankyou” page.
Synthesis VR API – Booking Widget
API As explained, the booking widget just utilizes the API and gives a ready to use example. However, in many cases, that may not be enough and as you may want to better match your website design, integrate your own payment processor, use a different language and so on. What usually would be enough is to open the widget page, copy all the source code in your own site and start editing the HTML / Javascript. However, this still may not be sufficient for some of you, so here comes the direct API integration. If you are not a developer and you don’t have such on hand, please stick to the widget. The next would just confuse you unnecessary. API CALL – AVAILABILITY URL = https://api.synthesisvr.com/ Method = GET Resource = /web/<public_key>/availability Accepted parameters: Parameter Format Description people Integer the number of VR stations you wants to book experience Integer the id of the experience type. If not provided, SynthesisVR would use the first experience type that is assigned on the widget date String ; YYYY- MM-DD A date that isn’t in the past duration Integer a duration that exists under your work hour rules customer_token String (optional) A token obtained via the /web/<public_key>/customers/auth API call JSON Response: Name Type Description balance String Shows the balance for the given customer_token or $0.00 if no balance is available coupons Array Shows the available vouchers against the given customer_token. Some vouchers may not appear if they are not allowed for the desired “people” ; “experience” ; “date” and “duration” parameters dows Integer Array From 0 to 6. Points to the days of the week when reservations can be booked. 0 = Monday ; 6 = Sunday special_days Array If a day of the week is disabled via the dows parameter, but there are exceptions. stations Key – Object pairs The key refers to experience type id. Check the “Experience Type Object” for the object values. times Key – Object pairs Represents the daily availability. Check the “Availability Object” for detailed description. Experience Type Object: Name Type Description book_all Boolean This reservations requests to book all stations. descr Text Description of the experience type durations Integer Array Available durations in minutes pcs String Array The SynthesisVR IDs of the VR stations pos Integer If there are multiple experience types – the position of the current one stations Integer The total number of PCs under this experience type title String Title of the experience type Availability Object: Name Type Description cost Float The final cost to be charged per station endTimePre Timestamp – ISO 8601 A timestamp object pointing to when the session would end moreOptions Key – Object pairs Additional paid options for the current object precost Float The cost per station before discounts startTime String The startTimePre parameter in a human readable format startTimePre Timestamp – ISO 8601 A timestamp object pointing to when the session would start stations Integer The number of available (free) stations. value Time String – format HH:MM The “time” value to be used with the /web/<public_key>/book API call API CALL – VALIDATE EMAIL URL = https://api.synthesisvr.com/ Method = POST Resource = /web/<public_key>/customers/validateEmail Accepted parameters: Parameter Format Description email String (optional) Email string to validate JSON Response: Name Type Description status Boolean True = there is a customer with such email address. You could proceed to authentication. False = no such customer exists. You could proceed with a signup process API CALL – CUSTOMER AUTHENTICATION URL = https://api.synthesisvr.com/ Method = POST Resource = /web/<public_key>/customers/auth Accepted parameters: Parameter Format Description email String Email string to authenticate password String (optional) Password related to the given email service String (optional) The name of an authentication service. Example: “facebook” serviceString String (optional) The value to be authenticated for the given service string. JSON Response: Name Type Description cc String Last 4 digits of the CC associated with the account (e.g. XXXX1234) msg String Text description of the API call result name String Customer name pm String “0” = No payment method and no CC data collection is needed status Integer 1 = Authenticated ; 0 = Invalid credentials token String A string to be used with the AVAILABILITY and BOOK API calls API CALL – CUSTOMER CREATION URL = https://api.synthesisvr.com/ Method = POST Resource = /web/<public_key>/customers/create Accepted parameters: Parameter Format Description email String Email string to authenticate password String (optional) Password related to the given email service String (optional) The name of an authentication service. Example: “facebook” serviceString String (optional) The value to be authenticated for the given service string. name String Full customer’s name additional JSON key-value pairs Additional information to keep per customer. Example: {“birthday”:”1st April, 1985″,”phone”:”12135559999″} The API response is the same JSON as for: /web/<public_key>/customers/auth API CALL – CUSTOMER UPDATE CC URL = https://api.synthesisvr.com/ Method = POST Resource = /web/<public_key>/customers/updateCC Accepted parameters: Parameter Format Description customer_token String The token obtained from an “auth” or “create” API call json JSON key-value pairs The complete CC data. See below for field description. Note: the key-value pairs may vary between the payment processors JSON Response: Name Type Description status Integer 1 = Success ; 0 = Failure, use “msg” to lookup the error msg String Text description of the error. PayPal Here – JSON object: Name Type Description credit_card Integer 1 = Success ; 0 = Failure, use “msg” to lookup the error security_digits String Text description of the error. exp_date1 Integer CC expiration Month exp_date2 Integer CC expiration Year first_name String First Name last_name String Last Name cardholder_address String Address of the CC owner cardholder_city String City cardholder_country String Country cardholder_state String State cardholder_zip String ZIP code cardholder_phone String Phone number API CALL – CUSTOMER ASSIGN VOUCHER URL = https://api.synthesisvr.com/ Method = POST Resource = /web/<public_key>/customers/assignVoucher Accepted parameters: Parameter Format Description customer_token String The token obtained from an “auth” or “create” API call code String The voucher / coupon code JSON Response: Name Type Description status Integer 1 = Success ; 0 = Failure, use “msg” to lookup
Booking Add-On – disable opening / closing hours from booking
Due to multiple reasons (as example, having a lot of foot traffic), you may want to hide periods of the day from your booking widgets. To avoid creating new experience type with different hours and extra logic that may complicate your setup, you can simply extend the booking widget with some custom code. To make it even easier for you, we already built that code and simplified it to the possible minimum. You may want to hide times based on day of the week or based on experience type (or both together). For that purpose, you have to build your logic and few lines of javascript code. Considering the days of week are: Monday => 1 Tuesday => 2 Wednesday => 3 Thursday => 4 Friday => 5 Saturday => 6 Sunday => 7 If you want to hide options from the widgets for only Monday + Thursday + Sunday, then you’ll have to use the following combination: 1,4,7 If it is to apply for Monday to Thursday, then use: 1,2,3,4 Next, you need your experience type ID (can be found on the Experience Types management page). Let say you work with the default “Immersive” experience type => 1 Then, your rule will looks like this: 1_1,4,7 => the _ character is used as a separator between the experience type and the days of the week 1 => in this case, you don’t have any specified days, so we assume your rule apply everyday *_1,2,3,4 => applies for ALL experience types between Monday ot Thursday Note: you can’t list multiple experience types separated by comma. You have to create multiple rules instead. You can use asterisk (*) to apply the rule for all your experience types What the actual code looks like: Default line (no changes on it): window.svr.hideTimes = new Object(); [‘hide_before’,’hide_after’].forEach(function(i){ window.svr.hideTimes[i] = new Object(); }); Your rules: window.svr.hideTimes[“hide_before”][“*_1,2,3,4”] = “13:00”; window.svr.hideTimes[“hide_before”][“1”] = “14:00”; window.svr.hideTimes[“hide_after”][“*”] = “20:00″; All your rules have to be enclosed in a <script> tag. You also have to load the actual custom logic: <script src=”//api.synthesisvr.com/widgetPlugins/skipTimeOptions.js” crossorigin=”anonymous”></script> Examples 1) If you don’t want to accept bookings before 1pm and after 8pm: <script> window.svr.hideTimes = new Object(); [‘hide_before’,’hide_after’].forEach(function(i){ window.svr.hideTimes[i] = new Object(); }); window.svr.hideTimes[“hide_before”][“*”] = “13:00”; window.svr.hideTimes[“hide_after”][“*”] = “20:00″; </script> <script src=”//api.synthesisvr.com/widgetPlugins/skipTimeOptions.js” crossorigin=”anonymous”></script> Example 2) To skip late booking (after 6pm) for the Immersive experience type during the busy days (Friday to Sunday): <script> window.svr.hideTimes = new Object(); [‘hide_before’,’hide_after’].forEach(function(i){ window.svr.hideTimes[i] = new Object(); }); window.svr.hideTimes[“hide_after”][“*_5,6,7”] = “18:00″; </script> <script src=”//api.synthesisvr.com/widgetPlugins/skipTimeOptions.js” crossorigin=”anonymous”></script> You need to append the final code to the “Add HTML before the BODY tag closure” option under the Booking Widget settings (the Edit button).
Booking Add-On – Booking Widget Setup
This Documentation will provide a step by step guide to setting up your booking widget, integrating it in to your WordPress website and other advanced configurations. On your left menu click Administration Click Advanced Settings – Web Widgets as shown below This takes you to the Widgets Page. On the Booking Widgets TAB – Click the + sign to create a new web widget. This will open up a pop up menu to create a new widget. Widgets Pop Up Settings 1. Title – A Suitable title for your widget 2. Predefined Template – Select Template Version 5 from the drop down menu as shown below 3. Click the Experience Type+ buttonSelect the correct Experience from the dropdown menu this widget is going to apply. You can have multiple Experiences on the same widget. Make sure to click Experience Types+ button to add more experience. 4. Take Out Time Options+ (Optional) By default the booking will show all your time slots. Example: You have a 15, 30, 45 and 60 minutes duration on your Booking Rules for VR Experience. Online you only want to show the 30,45 and 60 minutes option and do not want customers booking 15 minutes, then you can use this Take Out Time Options+ and not show the 15 minutes duration as shown below. 5. Waiver Template (Optional)If you want your customers to select a waiver before checkout select the correct Waiver Template from the drop down as shown below: 6. About Field – (Optional)Here you can add text explaining the booking widgets or conditions. 7. Payment moduleSynthesis VR can integrate multiple merchant processors for free. Here you can select the correct Payment module that is to applied for taking customers’ payment online. **This module has to be setup prior to selecting from the drop down. 8. Collect More Information About Your Customers+ (Optional)By default only Email, Password and Full Name is entered when a customer is making a booking online. If you want to collect more information you can use this button to add multiple fields. All fields are default text inputs, but limitations can be set as shown below.**For more customization options check the booking customization section. 9.Booking Confirmation Points+ (Optional)You can create points that the customer would check off using this. For example, something like “I agree to come 15 minutes prior to my session start”. This checkbox would be required to be checked off. 10. Add HTML to the HEAD and BODY tag (Optional)These fields are used to customize various options on your widget settings. Using this you can pretty much customize and enhance various options according to your own individual requirements. **This is clearly explained in the customization section with multiple examples as use case scenarios.11. Customer can pay in your locationIf you want your customers to pay at your Arcade instead of ONLINE, select YES, If the customer has to Pay ONLINE, select NO 12. Disable enforcing account registrationIf you want to enforce customers to register before checkout. This option will be OBSOLETE if ONLINE PAYMENT OPTION is selected, customer will have to create a profile before checking out. 13.Arcade Image (Optional)Upload your logo or image of choosing for the widget 14. External CSS URL (Optional)Synthesis VR supports external styling using CSS. Please input URL to enable external styling. 15. Time FormatAs shown below, which format of time you want to use in your widget. AM/PM or Military style Time. 16. Pre-selected duration upon loading the widget (Optional)If you want a certain duration to load by default based on your booking duration, input the duration in minutes as shown below. This will load the 30 minutes duration by default on the booking page. 17. Earlier Possible Time After (Optional)This is an extremely valuable field for events and party bookings. For special events and parties if you require a certain duration then use this field.Type Digit and Type of Duration as shown below. This will require a 24 hour notice before they can make a reservation online. This will prevent same day reservations and have to be used carefully. Once you have setup everything please click the Save Changes button.
VR Session Manager – Session Tags
Real life usage case If you don’t yet have any employees, you definitely would have to hire some as your business grows. Then, you would create them “Operator” SynthesisVR accounts, as you wouldn’t want them to have full control over your setup. With this, certain functionalities would be limited. To name few: As we are all humans, your employees would do mistakes from time to time and you would be the one that would supervise and take care to “fix” their mistakes. In the regular case, your employees would let you a reservation comment, so you can take care for it. With the business growth, you may end up having 20, 30, 100+ reservations per day and it may become difficult and time consuming to check the comments one by one. However, if your staff add a comment and add a label to the reservation, you would be able to take care significantly faster. We are sure you would be able to think of more usage cases and we are eager to hear them. How to create Tags 3. Select your location, Give a Title that is relevant and select a color and Save Adding A Tag to an existing Reservation
Experience Types Add-On – Work Hours – By Game
The purpose of this Rule is to allow your arcade to act more like a traditional arcade where someone pays to play a game until a certain criteria is reached. For example, they play until they “die”, or play just a single round. Once the criteria is reached (set within the Game Categories section explained here), the session ends. Then click on the “Add/Edit Operation Settings” button under your experiences: To remove a line item in this section, click on the red “x” to the right of it.