| Info |
|---|
All plugin content can be found at the Cavrnus CVT Git Repo and will be referenced throughout this guide. |
Getting Started
Accessing the project is simple. The Cavrnus
...
Collab Viewer Git Repo provides a fully-featured UnrealEngine 5.3.2 project that includes a working example of the Unreal CVT project combined with both the CavrnusConnector Plugin and CavrnusCVT Plugin.
...
1. Access Cavrnus CVT Repo
...
You can either use the sample project as a foundation for your next project, or use the provided plugins directly in your own project.
Access Cavrnus Collab Viewer Git Repo
Method 1: Clone Repo with Git
Clone the Cavrnus Collab Viewer Git Repo using your preferred Git client. Using Git will ensure you have easy and up-to-date access to releases of the plugins.
Method 2: Download Repo (No Version Control Needed)
If you’d like to avoid version control altogether,
...
Once cloned
...
...
download the project zip as shown below from the Cavrnus Collab Viewer Git Repo.
Opening the Cavrnus CVT Project
Now that you have the project downloaded, navigate to your downloaded/cloned project’s root folder.
Select your project’s .uproject file to begin building.
Select OK to rebuild module(s) and/or regenerate solution files if it’s a C++ project.
Open project.
...
Use CavrnusCVT menu option in TopRibbon
...
Select Setup Level
Now that the project is open, locate the CavrnusSpatialConnector Actor in the Level Outliner of the L_Cavrnized_CVT_Level.
In the project outliner, select the “CavrnusSpatialConnector” actor at the root level.
From here you can enter server and space information.
Refer to Configure the Cavrnus Spatial Connector (Unreal Engine) for more information!
With your Cavrnus Spatial Connector properly filled out, you may run the level
Already have an established project?
Lets go through the steps to easily add Cavrnus CVT collaboration.
Adding Cavrnus Collab Viewer to Existing Project
Navigate to your Cavrnus Collab Viewer Git Repo local instance project’s root folder.
Copy/paste both the CavrnusCVT and CavrnusConnector plugins into your project’s Plugins folder.
If your project doesn’t have the Plugins folder, create it and then add the plugins.
Alternatively you can simply copy the entire Plugins folder from the cavrnus-collab-viewer Git repo.
For more information on Unreal Engine Plugins visit Working with Plugins in Unreal Engine.
Now you are ready to build the project. Select the .uproject file to begin building.
If you are prompted to rebuild any Cavrnus plugin modules, click “Yes” to rebuild them.
(You could also generate solution files if it’s a C++ project and build from your favorite IDE!)
Open your project.
Unreal Engine will open to your default editor level. If you have “Show Plugin Content” enabled in the settings, you will see the CavrnusSpatialConnector in the Content Browser folder tree. Here, you will have access to a reference level in the CavrnusSpatialConnector plugin if you need it.
To setup Cavrnus Collab Viewer in your level, navigate to the Cavrnus Collab Viewer menu. Select Setup Level for Cavrnus Collab Viewer from the menu.
Notice in the Outliner that two new actors have been added.
These are the actors that manage the connection and behaviors for Cavrnus Spatial Connector and the Cavrnus Collab Viewer, respectively.
Select the CavrnusSpatialConnector Actor. The CavrnusSpatialConnector Actor has several key fields you must fill out with your information.
Refer to the Spatial Connector for Unreal Engine setup guide for in-depth help.
| Tip |
|---|
At this point, your project has all of the capabilities of Cavrnus and CVT! |