Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Tree
rootCavrnus Knowledge Base
expandCollapseAlltrue
startDepth1

Cfm tabs page
tabsPageTitleUnity
colorPalettesDefault
an.spaceKeyCSM
primaryTabtrue
color#0052CC
idcbvv9jvyeeh
backgroundColorPaletteDefault
headerStyleFilled

Let’s apply the No-Code Collaboration Sync Components to a real world example.

Starting Project

We are going to begin with a simple single-player Chess scene. It has pieces and a table. The pieces can be grabbed and moved by the local user.

Note: The pieces to not have Physics on them (see: https://cavrnus.atlassian.net/wiki/spaces/CSM/pages/828178434/Sync+Property+Components#Sync-Components-and-Physics).

There is also a Reset button which will place all the pieces back to their original positions.

Beyond the ability to move pieces there is no special game logic present.

image-20240223-103833.png

Initial Cavrnus Setup

As described in the Setup Your Scene guide, we will setup our Scene for Cavrnus using the dropdown button.

image-20240223-103934.png

Then, as described in that same page, we will set the Cavrnus Spatial Connector to use our server, Login to our account automatically, and Automatically Join a “Chess” space we created in the web.

image-20240223-104226.png

Add Sync Components to Chess Pieces

Next we will simply select all the pieces and Add Component Sync Transform in the Inspector.

image-20240223-104545.png

And we’re done! That’s it!

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.

image-20240223-104859.png

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

image-20240223-105008.png

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!

image-20240223-105311.png
Cfm tabs page
tabsPageTitleUnreal
colorPalettesDefault
an.spaceKeyCSM
primaryTabfalse
color#0052CC
id0g6urfsukn8g
backgroundColorPaletteDefault
headerStyleFilled

Let’s apply the No-Code Collaboration Sync Components to a real world example.

Starting Project

We are going to begin with a simple single-player Chess scene. It has pieces and a table. The pieces can be grabbed and moved by the local user.

Note: The pieces do not have Physics on them (see: https://cavrnus.atlassian.net/wiki/spaces/CSM/pages/828178434/Sync+Property+Components#Sync-Components-and-Physics).

There is also a Reset button which will place all the pieces back to their original positions.

Beyond the ability to move pieces there is no special game logic present.

image-20240301-182247.png

Installing the Cavrnus Plugin

As with any Unreal plugin, adding the Cavrnus Spatial Connector is a simple 3 step process:

  1. Drop the latest version of the CSC plugin into the Plugins folder of your project files.

image-20240301-182718.png
  1. Load the project in Unreal Editor and enable the CSC plugin in the Plugins Manager

image-20240301-183111.png
  1. Restart the Unreal Editor as indicated.

Initial Cavrnus Setup

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

image-20240301-183902.png
  • Click the “Setup your Space” button to add Set up your Space - Adds an instance of the CavrnusSpatialConnector to the current map.

    • Clear the “Show when Unreal Editor starts?” checkbox to prevent this dialog from displaying the next time the project loads.

  • To add an instance of the Cavrnthe Cavrnus 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.

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

    1. Alternatively, you can add the CavrnusSpatialConnector instance to the level from the Cavrnus menu on the Unreal Editor Menu bar.

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

image-20240301-202250.pngImage Added

  1. As described in the Setup Your Scene guide, we will setup our Scene for Cavrnus using the dropdown

button.image-20240223-103934.pngImage RemovedThen
  1. buttoThen, as described in that same page, we will set the Cavrnus Spatial Connector to use our server, Login to our account automatically, and Automatically Join a “Chess” space we created in the web.

image-20240223-104226.png

Add Sync Components to Chess Pieces

Next we will simply select all the pieces and Add Component Sync Transform in the Inspector.

image-20240223-104545.png

And we’re done! That’s it!

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.

image-20240223-104859.png

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

image-20240223-105008.png

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!

image-20240223-105311.png