This guide will consist of 4 sections. Once completed, you will have successfully imported the Vivox SDK into your project and can start your implementation!
Section 1: Log into the Unity Hub
Make sure you are logged into your Unity Engine instance with the following steps:
Step 1: Open Unity Hub and Select "Sign in", in the top left corner
Step 2: Log into Unity ID in the browser windows that appears.
Note: If you do not have an account, please select the "create one" link and follow the steps provided.
Step 3: Select the Open Unity Hub button!
Note: Some devices may automatically open Unity Hub depending on your system preferences.
You should now be logged in!
Section 2: Check Your Engine Version
Ensure the editor version of your project is Unity LTS or newer. See here for which engine versions apply.
Section 3: Connect Your Unity Project to Services
If your project is not already connected to services, follow these steps to do so. This is required to import the Vivox SDK.
Step 1: Open Project Settings
Step 2: Select Services
Step 3: Select your organization
Step 4: Select Create Project Id
Now you will have spawned a project ID and can continue!
Section 4: Link Vivox to Your Unity Project
Step 1: Go to https://unity.com/solutions/gaming-services and log in with your unity account.
Step 2: Select your project from the dropdown menu
Step 3: Click Multiplayer
Step 4: Select Vivox from the second column.
NOTE: Vivox requires you to have a credit card on file. If you have not added a credit card to your Unity Account yet, you will be prompted to do so here. If you do not have a credit card on file you will not be able to continue the integration. Vivox is free if you remain under the billing threshold, we only request the card so we are able to bill you if exceed your permitted limit. To learn more see our Vivox FAQs page.
Step 5: Click Setup Guide and make sure select engine is set to Unity. (Unreal/Core will be listed in an upcoming guide).
Step 6: You can skip this step, if you have already follow the steps under Section 3.
Step 7: Select the Overview panel from the left side of the screen and ensure that Vivox is set to "Vivox on". Next, select About & Support on the left side of the screen.
Step 8: In the About & Support panel, select Download the Package on the right side of the screen.
Step 9: Copy the code snippet in the window that appears and save it, to paste it in a later step in this guide.
Step 10: Go to your Unity Project Folder on your computer and open the packages folder.
Note: If you do not know where you saved your project, you can go to the Unity Hub, click the three dots next to your project name and select reveal in finder.
Step 11: Open the manifest.json with a text editor or IDE.
Step 12: Add the line you copied earlier to the end of the list of dependencies. Make sure to add a comma to the dependency above the one you just added like you see below.
Step 13: Open your project back up and allow the dependencies to resolve. Once the loading bar disappears, you can continue to Step 12.
Step 14: Click on Edit and Select Project Settings
Step 15: Check if your credentials have been created!
NOTE: DO NOT SHARE YOUR ISSUER OR KEY WITH ANYONE NOT WORKING ON YOUR PROJECT OR WHO IS NOT A UNITY EMPLOYEE WHO IS PRIVATELY ASSISTING YOU WITH AN ISSUE YOU REQUESTED ASSISTANCE ON.
*your screen will have the filled out info here. Information is redacted for security purposes in this guide.
Now Vivox should be successfully imported into your project, and you can begin implementing Vivox features into your game and/or application!
To get started with your implementation, please see the Unity Quick Start Guide located in the Vivox documentation.