Contents

• Getting Started
• Setup Your Domain
• Install The Cavrnus Plugin
• Load the project into Unreal
• Bring your UE Project onto The Shared Reality Platform
• Test the project

Getting Started

Cavrnus Metaverse Connector is your quickest path to inject multi-person presence into your latest virtual environment project. Your team will be navigating, editing, and communicating within a synchronized virtual space in no time. First define a Cavrnus domain, install the plugin on your Unreal project, and invite your team to join the Cavrnus space you create. It’s that simple.

You can even connect users of our Cavrnus desktop space (built in Unity) to your Unreal project space. For more information on how to configure the Cavrnus desktop application, refer to the Cavrnus home page.

‍

‍↑ Back to Contents

Setup Your Domain

To begin, contact your friendly neighborhood Cavrnus team to setup a domain with your own custom URL.

‍This is the domain you will invite your team to join you in the Cavrnus virtual space.

1. Send an evaluation agreement
2. Select a custom URL
3. Assign owner
4. Add users

Get support

If you are experiencing an issue after following the instructions below, contact your Cavrnus support team for help with the Cavrnus Metaverse Connector.

‍Support email: support@cavrnus.com

‍

‍

‍

‍↑ Back to Contents

Install the Cavrnus Plugin

Download the appropriate Unreal plugin.

Go to the client spaces page for your Cavrnus URL. (https://your_company.cavrn.us/client/spaces)

Click the user profile on the top right of the screen to access the list of client downloads.

Site administrators can also find the plugins on the account administration page for your Cavrnus URL.
(https://your_company.cavrn.us/admin/spaces)

On the resource panel on the left, scroll down to the “Tools” section.

Click the link for the corresponding Unreal Engine version for your project.

- Cavrnus MC for Unreal Engine 5.1

- Cavrnus MC for Unreal Engine 5.2

Unzip the contents of the downloaded file to your Unreal project.

1. If there is not already a “Plugins” folder in your local Unreal project directory, create one now.
2. Place the contents of the Cavrnus Connector zip file into that new “Plugins” folder.
   e.g., C:\<Project_Directory>\Plugins\CavrnusConnector\
3. ‍Alternatively, the plugin could be placed in the Unreal Engine program files directory by unzipping the contents in the Marketplace folder under “Plugins”.
   e.g., C:\Program Files\Epic Games\UE_5.x\Engine\Plugins\Marketplace\
   NOTE: You may experience problems packaging the Beta release in this configuration. For assistance, contact support@cavrnus.com.

‍

‍

↑ Back to Contents

Load the Project into Unreal

If the project was already loaded when the plugin was installed in step 2, it may be necessary to reload the project.

Unreal Engine may give a warning about updating modules.

Select “Update” to confirm the update.

If the Cavrnus plugin version is out of sync with the version of Unreal Editor your project was built for, you may receive a warning about Incompatible versions.

For example, if you attempt to load the Cavrnus plugin for version 5.1.0 in a project that was built for Unreal Editor 5.2.1, you may see the following dialog box.
‍

Simply click “Yes” to continue forward.

Unreal may also prompt you to rebuild the following modules to synchronize the plugin versions.

Simply click “Yes” to continue forward.

If rebuilding these modules does not clear the conflict, try downloading the correct version of the plugin corresponding to your project UE version.

‍

↑ Back to Contents

Bring your project into shared reality

On the World Settings panel in the UE interface, expand the Game Mode roll-out.

Set the GameMode Override property to “BP_CavrnusGM”.

The project is now on the Shared Reality Platform!

‍

↑ Back to Contents

Test the Project

1. Click the Play In Editor button to play the level in the active level editor viewport

‍

‍

‍

‍

‍

2. The Cavrnus login screen appears within the PIE viewport:

3. Set the Cavrnus URL to your custom URL, and confirm the domain in the domain field.

4. Fill in the Email and Password field with your login credentials.

5. Click Sign in.

6. In the Spaces selection menu, click “Create New” to add a new space to the list and give your space a name.

7. Your Unreal project will be loaded into the new empty space.

8. Publish the content in the space to Cavrnus server.