Configure the Cavrnus Spatial Connector (Unreal Engine)

This is the domain you registered with Cavrnus when you configured your account. Enter your company’s URL in this field. (e.g. “CompanyName.cavrn.us” )

Specify whether Guests can join a space anonymously using a hyperlink, or if a login is required by 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.

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.

Members are authorized users who have login credential on your domain. This method is recommended for controlling access to private or sensitive information.

Member accounts are persistent, and can either be given access to all Spaces, or to specific Spaces individually. When selecting “Join as Member”, there are two options for entering login credentials.

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 Login” 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.

This method is useful for automated testing and for delivering bespoke applications to specific individuals. However, be mindful as this involves adding your password in plain text to your project.

If you have not yet created a Space for your users to join, create one now.

Once a User is authenticated, you can immediately place them inside a pre-defined Space. To do this, select Automatic as your Space Join Method. You must then get the ID of the Space you wish them to join. This ID can be copied by clicking on the Join ID at the bottom of the Space thumbnail in the Spaces section of the Cavrnus Management Console.

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.