Page Comparison

...

plugin for Unreal has already been installed in this project. For guidance on how to add the CSC-Unreal plugin for your new projects, or to upgrade your plugin to a newer version, see the documentation under “Cavrnus for Administrators”.

Cfm tabs page
tabsPageTitle Unreal colorPalettes Default an.spaceKey CSM color #0052CC id ikr0f7bi4g backgroundColorPalette Default
Installing the Cavrnus Plugin (Unreal Engine) As with any Unreal plugin, adding the The Cavrnus Spatial Connector is a simple 3 step process: Drop the latest version of the CSC plugin into the Plugins folder of your project files. Image Removed Load the project in Unreal Editor and enable the CSC plugin in the Plugins Manager Image Removed Restart the Unreal Editor as indicated.
Tip

Initial Cavrnus Setup

4. The first time the project is opened with the enabled plugin, the Cavrnus Spatial Connector dialog box may display to guide the initial setup.

Image Removed

• Set up your Space - Adds an instance of the CavrnusSpatialConnector to the current map.

• Web Console - Open the Cavrnus Web Console in the default browser.

• Visit Documentation - Open the online documentation in the default browser. (You’re already here!)

• Show when Unreal Editor Starts - Toggle this checkbox off to

• Dismiss - Close the dialog.

Click Set up your Space to add an instance of the CavrnusSpatialConnector to the current map.

Testing the Demo

To get an idea of what this demonstration will do, load the preconfigured map called “Cavrnized_CarConfigurator”.

1. In the Content Browser, under Content/Maps, double-click the “Cavrnized_CarConfigurator” level.

2. In the outliner, scroll down to the “Cavrnus” folder and click the CavrnusSpatialConnector actor.

3. In the Details panel, configure the settings for the CavrnusSpatialConnector on the Details panel:

   1. Domain Name: cav.dev.cavrn.us

   2. Auth Method: Guest Join Auto

   3. Guest Join Username: <Enter any name here>

   4. Space Join Method: Automatic

   5. Automatic Space Join ID: Reference a valid 24-character Space ID from the Web Console. (NOTE: Refer to the documentation on how to create a new Space and retrieve the Space ID).

Image Added

5. Click the Play-In-Editor (PIE) button to run the level. (or press Alt-P)

6. Once the Space is connected, you can click any color button to change the color of the car.

7. Click the “Stop Simulation” button to stop PIE. (or press the Escape key).

8. Click the PIE button again to start the simulation.

   1. Note that when the Space loads, the car will return to the last color you selected the last time you were loaded into the Space.

Initial Cavrnus Setup

9. In the Content Browser, under the “Maps” folder, open the CarConfigurateScene level.

10. Add the CavrnusSpatialConnector instance to the level from the Cavrnus menu on the Unreal Editor Menu bar.

    1. Note that you only need one instance of CavrnusSpatialConnector for a given level.

6. As described in the Setup Your Scene guide, configure the settings for the CavrnusSpatialConnector on the Details panel:

   1. Domain Name: cav.dev.cavrn.us

   2. Auth Method: Guest Join Auto

   3. Guest Join Username: <Enter any name here>

   4. Space Join Method: Automatic

   5. Automatic Space Join ID: Reference a valid 24-character Space ID from the Web Console. (e.g. 65d51cde823bca2e0f0bc79c)NOTE: Refer to the documentation on how to create a new Space and retrieve the Space ID).

Verify

Heads Up Display (HUD) Class

7. This project uses a custom game mode called “BP_MouseDragGameMode”CarConfigGM”.

   1. From the World Settings panel, expand the Game Mode rollout.

   2. In the “GameMode Override” field, note the entry says “BP_MouseDragGameMode”CarConfigGM”.

8. This project also uses a custom Default Pawn HUD Class “BP_HUD_MouseGrabPawn”CarConfig”.

   1. In the World Settings panelContent Browser, under Game Mode, expand the Selected GameMode rolloutContent/Widgets, open the Widget Blueprint “WB_CarConfig”.

   2. Note that the Default Pawn HUD Class references “BP_MouseGrabPawn”HUD_CarConfig”.

   3. Click the “Browse to Asset in Content Browser” button next to the field.

9. Open the “BP_HUD_MouseGrabPawn” CarConfig” blueprint from the Content Browser.

10. Under the Component panel in the blueprint editor, note the following components:

    1. SyncTransform_Character

       1. Property Name: Transform

    2. NameTagWidget

    3. CavrnusProperties Container

Add Sync Components to Chess Pieces

7. For each asset in the hierarchy that requires transform synchronization, add the following components

   1. Sync Transform

      1. Set the Property field to “Transform”. Note that this property is case-sensitive.

   2. CavrnusPropertiesContainer

      1. Set the Container Name field to “Pieces/Dark_Pieces/<asset_name>”, where “asset_name” refers to the name of the object as it appears in the Outliner.

OK, Let’s Add a Custom Avatar for Fun

Alright, the Cavrnus Spatial Connector comes with a default Avatar, but if you wanna be a bit fun you can Add a Custom Avatar. In this case we’ve already found a fun 3rd party Floating Orb Avatar. Like in the Developer Guide, we’ll start by just giving it a Sync Transform component, like we did the Chess Pieces.

Then, in the Cavrnus Spatial Connector, we will set the Remote User Avatar to be this.

And now we’re actually done!

Final Product

With the Sync Transform components added, the Avatars and Chess Pieces will move in a synchronized way for both users. This, combined with Voice and Video, will let you play a chess game with whomever else launches this scene!