With the CSC plugin enabled, there are two ways to setup your scene.
Insert the CavrnusSpatialConnector actor in the level.
Manually implement calls to the Cavrnus API Functions.
CavrnusSpatialConnector class
The CavrnusSpatialConnector is a specialized actor class that collects all of the required configuration elements into one convenient location.
Add an instance of the CavrnusSpatialConnector to your level by selecting it from the Cavrnus menu at the top of the Unreal Editor interface.
Select the CavrnusSpatialConnector instance in the level Outliner.
From the Details panel, configure all of your connection settings for this project:
CSC ConfigurationAs with any Unreal plugin, adding the Cavrnus Spatial Connector is a simple 3 step process:
My Server:
This is the domain you registered with Cavrnus when you configured your account. Enter your company’s URL in this field. (e.g.
an authorized team member in your domain.
Guests can join automatically with no authentication. This is recommended for delivering an experience to a wide audience, without the need for creating and managing a large number of temporary accounts.
Guests can only join spaces which have been configured to allow guests to join. (See
These “guest accounts” can be used by multiple people simultaneously, but they do have a limited lifespan and will be deleted after the duration expires.
Guest Login Method: Select a method to identify the Guest user with a name while in the Space.
By selecting “Enter Name Below”, you can specify a name directly that will apply to all guests in the Space.
Select “Prompt to Enter Name” to trigger a prompt when the Guest first enters the space. Note that this requires a Blueprint Widget to be selected as the prompt that will display. A default widget is provided with the Cavrnus Plugin files, but you can also create your own custom design.
| Note |
|---|
Guest |
Member Login Method: Select a method to identify the user as a Member with login credentials to verify access permissions to a Space.
Select “Prompt Member to
.
| Note |
|---|
Remember to delete login credentials from the CSC component when committing a project to a public |
The more common way of getting Members into your Application is by spawning a Login Menu with Login Manual. This lets them type in their own credentials and log in as themselves. As before, you can redo the Login Menu as you see fit and spawn your version instead.
We also give you the option to save your Authentication Token locally on your device.
Joining a Space you can find the steps to do so here: /wiki/spaces/IKB/pages/815269529 fetched in the Web Console the “…” next to your Space and Copying the ID.
on the Join ID at the bottom of the Space thumbnail in the Spaces section of the Cavrnus Management Console.
You can then Paste
Alternatively you can simply present Users with a list of all the spaces they are currently allowed to join and let them pick one
. Select “Spaces List” to trigger a prompt when the team member first enters the space. Note that this requires a Blueprint Widget to be selected as the prompt that will display. A default widget is provided with the Cavrnus Plugin files, but you can also create your own custom design.
| Info |
|---|
Note: A Cavrnus Space will often be filled with Properties pointing to specific paths within your application. Therefore, allowing users to just open any Space could result in them bringing down a Journal that is meant to be for a different application. Example: One of your users has access to a Car Configurator Application which connects to the “Car Config” Space. They also have access to a Conference Room Application. Allowing them to join the “Car Config” Space from the Conference Room Application would give them a bunch of car-related Properties which their Application wouldn’t know what to do with |
Space UI
Once your users connect to a Space they may want to see some menus appear. The Cavrnus Spatial Connector allows you to specify which UI to show both while the Space is Loading and once it is ready. We provide a few defaults (a Loading graphic, a Users Menu, and a Voice/Video Menu) You can modify/replace these and add your own at will. Loading Menus will, of course, be destroyed once the Space is connected.
Avatars in Cavrnus are driven by the same Properties logic that governs the rest of the Space. As such, any Avatar you want to use will need to script or some other way of Binding/handling the “transform” Property to show though, our systems These any you want (, , etc).
To use a customized Avatar, simply drag & drop it into the Cavrnus Spatial Connector.
To send your Co-Presence to other users, select the Local User’s rig and hit Cavrnus->Set Selected Object As Local User.
This will automatically add a CavrnusLocalUserFlag to your character and a SyncTransform component to send your position across the wire. As with remote avatars you can send and receive as many custom properties as you would like. However, ensure that the Property Names match between the Local Rig and the Remote Avatar. If you are sending a property named “position” and their Remote User Avatar is listening for one named “transform”, you’re gonna have a bad time.
Spawnable Objects
If you want to spawn prefabs into your Scene at runtime, you will need to add themRight hand socket
Laser state/color
and more …
Default Pawn Class
Just as any Unreal Engine project, you can define different pawns for the local and remote users. The local avatar is defined in the standard location in Unreal Editor, the Default Pawn Class in the GameMode.
To synchronize a user’s local position to display in other team member’s views, the local player pawn must have a SyncTransform_Character component to post it’s transform matrix to the Journal.
In the image above, the default BP_CavrnusPawn blueprint has been derived to create a custom character pawn. The SyncTransform_Character component is inherited from the parent and can be uniquely configured. Other Cavrnus components include the SyncLaserComponent, SyncPawnColor, and the NameTagWidget components, which appears above the character in the viewport. Each of these are necessary for synchronizing specific properties in the character, and are available in the Cavrnus Spatial Connector plugin folder.
Remote Avatar Class
The Remote Avatar Class is assigned in the CavrnusSpatialConnector instance placed in the level. This can use the same Character blueprint as the local user, or use a custom pawn.
Space UI
The Cavrnus Spatial Connector gives you complete control to customize the UI, both while the Space is Loading and once it is ready. The CSC plugin files include several default widgets to get you started, either to use directly or as a template to create your own:
Loading Screen graphic
Users Menu
Voice/Video Controls Menu
| Info |
|---|
Spawned menus, such as Loading Screens, will spawn at startup and will then be destroyed once the Space is connected. |
Spawnable Objects
Blueprints can be spawned into the Scene at runtime to further customize the Cavrnus experience. These can be added to the Spawnable Objects list at the bottom of the
CavrnusSpatialConnector instance.
The Unique Id is what is stored in the Journal as the thing being spawned.
Next Steps
At this point, hitting Play in Unity should Authenticate the user and place them in a Space, with all of the relevant UI being spawned in with them!
Now you can start synchronizing the various things inside your project!
You can do this by adding ourThe use-case is that objects placed in the scene with this unique identifier can be swapped out with new, modified blueprints. The properties stored in the Journal would then be applied to this new blueprint as though it were the original.
ON THIS PAGE
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Tip |
|---|
Next StepsYour level is now connected to a Cavrnus Space. If you run Play-In-Editor, the level will load into that space and you will be able to see the connection in the Session Analyzer. You’ll have Voice & Video capability, and see a user list with all of the other users in the Space. However, in the Session Analyzer you will only see the user logged in. You won’t see any property updates associated with your level. Next, we will add No-Code Collaboration Components to automatically synchronize an object's Properties. That way they can be synchronized across multiple connections. Alternatively, you can read up on more advanced techniques in our Developer Guide, or make calls directly using our API Reference. |