Get Started
The recommended Unity version is 2021.3.28.
No other version is ensured to work, and using other versions could cause error.
All fields have Tooltips. This means you can hover over any of the fields if you are feeling confused or helpless.
All scripts also have HelpUrls assigned. Click the question mark on the top of the script to navigate to the section for it.
Help is also available in the FlowVR Discord Server.
Start by importing the latest .zip in Releases and import it into your project.
Make sure your project contains NO Photon SDKs. The .zip you will import contains Photon Fusion and Photon Voice already for easy use.
Navigate to Assets > Resources > FlowVR
Drop the FlowVRManager.prefab into your scene
This is the FlowVRManager.
Here you can modify the settings of the Player, Rooms, and Connecting.
To allow FlowVR to make connections with Photon, click the Navigate to Photon Settings button as shown below.
To retrieve the App Id Fusion and App Id Voice values, navigate to your Photon Dashboard and create a Photon Fusion 2 and Photon Voice app.
Copy the App Ids from the Photon Dashboard, and assign values to App Id Fusion, App Id Voice, and Fixed Region
.
A list of regions for Fusion 2 can be found here.
Assign the Head, Left Hand, and Right Hand fields to GameObjects in your scene. This can be objects on a rig, static objects, or anything you want. The head and hands on the network player will follow the positions and rotations of these fields.
You can change these values, but it's probably better to keep them as they are.
Default Color is the color the Player will default to if they don't have one saved, or ran into a error configuring theirs.
Default Name is the string that will be built off to construct a username with if the Player doesn't have one saved, or ran into a error configuring theirs.
Max Player Count is the amount of people that can connect to a single room.
Default Queue is the queue the Player will join if there was a error when passing a custom queue to JoinRandomRoom() or JoinPrivateRoom()
You should not switch the values of Runner and Voice and Player Prefab, unless you know what your doing.
Connect On Awake decides if the game will automatically put the player into a lobby or not when the game starts.
The wiki contains other sections about how to customize your player, how data is saved, and how to join rooms.
To view a sample scene of FlowVR and how to use it, navigate to FlowVR > Sample > FlowVR Sample,