Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

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.

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)

  1. If you’d like to avoid version control altogether, download the project zip as shown below from the Cavrnus Collab Viewer Git Repo.

image-20240913-221654.png

Opening the Cavrnus CVT Project

  1. Now that you have the project downloaded, navigate to your downloaded/cloned project’s root folder.

  2. Select your project’s .uproject file to begin building.

  3. Select OK to rebuild module(s) and/or regenerate solution files if it’s a C++ project.

  4. Open project.

image-20240916-152915.png

  1. Now that the project is open, locate the CavrnusSpatialConnector Actor in the Level Outliner of the L_Cavrnized_CVT_Level. In order to run, enter server and space information. Please refer to Configure the Cavrnus Spatial Connector (Unreal Engine) for more information!

  2. With your Cavrnus Spatial Connector properly filled out, you may run the level

But what if you already have an established project that needs instant collaboration features? Lets go through process below of adding the plugins to your project.

Adding Cavrnus Collab Viewer to Existing Project

  1. Navigate to your Cavrnus Collab Viewer Git Repo local instance project’s root folder.

  2. Copy/paste both the CavrnusCVT + CavrnusConnector plugins into your project’s Plugins folder. If your project doesn’t have the Plugins folder, create it and then add the plugins.

    1. For more information on Unreal Engine Plugins visit Working with Plugins in Unreal Engine.

image-20240906-004400.pngimage-20240906-004411.png

  1. Now you are ready to build the project. Select the .uproject file to begin building.

image-20240916-151021.png

  1. Select OK to rebuild module(s) and/or regenerate solution files if it’s a C++ project.

image-20240916-151603.png

  1. Open project.

  2. The L_Cavrnized_CVT_Level is the default editor level, but creating a new level is easy!

    1. Create a new new level as you normally would: File > New Level

    2. Save your level.

  3. With your level now created, navigate to CavrnusCVT > Setup Level for Cavrnus & CVT. This automatically adds all of the necessary actors to the level.

image-20240906-004521.png

  1. Notice the actors added to the level, both of which are auto-configured.

image-20240906-004703.png

  1. Select the CavrnusSpatialConnector Actor. The CavrnusSpatialConnector Actor has several key fields you must fill out with your information.

    1. Refer to the Spatial Connector for Unreal Engine setup guide for in-depth help.

At this point, your project as all of the capabilities of Cavrnus and CVT!

  • No labels