/
Cavrnus Connector Settings (Unreal Engine)

Cavrnus Connector Settings (Unreal Engine)

When the Cavrnus Spatial Connector (CSC) plugin is enabled the Cavrnus Configuration Panel will be shown.

Clicking the Settings button is a shortcut to the Project Settings → Plugins → Cavrnus Connector Settings

The CSC plugin Settings are for the Project and are what is used with a distributed project (running in PIE) or with a Packaged Application (EXE).

image-20250908-155855.png
The Cavrnus Connector Settings panel and its default settings

  1. Sign-in Options

    1. Enable Connect on Start to automatically connect to the desired Cavrnus Platform instance on startup of PIE or packaged application.

      1. If you need to delay the member or guest connection to the Platform based on the flow of the experience or application, uncheck Connect on Start and use the supplied Blueprint or C++ calls to initialize the Cavrnus plugin and connect.

    2. Enable Save User Auth Token if you want a user’s Domain and login credentials to be cached on their local system for frequent, easier start to your Project.

    3. Server Domain entry allows you to hard-code the Cavrnus Platform instance that your Project will connect to (e.g. mycompany.cavrn.us or onpremise.yourcompany.com)

      1. If this field is blank, the User will be prompted to enter the Domain at runtime.

    4. Use the Authentication Method drop-down to easily set up the type of user that will be joining; Member, Guest, or Custom

      image-20250908-161650.png
      Selecting the Authentication Method

    5. Member is for Team Members that have been added via the Cavrnus Platform Management Console

    6. Guest is for allowing Guests to join an experience by entering a Join ID at runtime or a Join ID hardcoded into the Project

    7. Custom is for developers that would like to develop their own authentication method

  2. Member Section (visible when Authentication Method is set to Join as Member)

    1. Use the Member Login Method to set up the type of Member login you will use; Enter Member Credentials, Prompt Member to Login, or Custom

      image-20250908-173851.png
      Member Login Method

      1. Enter Member Credentials is used to hard-code the Login Email and Login Password used for authentication. This is not typical.

        1. If the Email and Password fields are blank, the Plugin will revert to prompting the user for these at runtime.

      2. Prompt Member to Login will use the defined Menu Widget for Member Login Menu to prompt the user to enter their credentials

      3. Custom is for developers that would like to develop their own login method.

        1. This is not for using a custom or preexisting widget, which can be specified in the Menu Widget section.

  3. Guest Section (visible when Authentication Method is set to Join as Guest)

    1. Use the Guest Login Method drop-down to select the method for entering guest names or tags; Enter Name Below, Prompt to Enter Name, or Custom

      image-20250908-174005.png
      Guest Login Method

      1. Use Enter Name Below to hard-code the Guest Name or tag.

        1. If the Guest Name field is blank, the Plugin will revert to prompting the guest to enter their name

      2. Prompt to Enter Name will use the defined Menu Widget for Guest Join Menu to have the guest users enter their name or screen-name at runtime

      3. Custom is for developers that would like to develop their own guest identification method

        1. This is not for using a custom or preexisting widget, which can be specified in the Menu Widget section.

  4. Space Section

    1. Use the Space Join Method drop-down to select the Space joining method between; Enter Join ID, Space List Menu, Prompt User for Join ID, or Custom

      image-20250908-174119.png
      Space Join Method

      1. Use Enter Join ID to hardcode a Space’s Join ID into the provided field.

        1. You can either use the Space’s automatically generated Join ID (a 24-byte hexadecimal number) or create an easier to use and share alphanumeric Custom Join ID

          1. Use the Cavrnus Platform Management Console to find or create a Space’s Join ID.

            image-20250908-174754.png



  5. AI Integration

    1. This field is where your Company’s OpenAI API Key can be entered for using the Cavrnus Platform’s AI Bot features. Please reach out to us for help with this and the Platform’s new MCP Agential AI capabilities.

  6. Manu Widgets

    1. These are the Widget Blueprints that are used for user authentication and login, space selection and joining, space loading feedback and more.

    2. The default settings are the Widget Blueprints that are provided with the Plugin. Developers are welcome to customize them or integrate them into existing UI.

    3. Change the selected widgets to any existing or custom widgets that should be used by the plugin for each of the functions.

    4. Widgets To Load is the base on-screen UI for the Cavrnus Plugin and can be modified, replaced, disabled, or integrated into your custom UI.

Initialize Cavrnus from any Blueprint

We provide Blueprint calls that will connect you to the Cavrnus Platform. The simplest of these is Initialize Cavrnus Authentication Process.

image-20250409-193650.png

You can type your server into the Server input option. Calling the above will prompt your users to log in, and will then present them with a list of available spaces to join.

If you want to force them to Authenticate as a particular User, or to join a particular Space, you can instead use the call to initialize with Preset Data.

image-20250409-193924.png
The above data will still require them to log in themselves, but will always make them join “my-space-id”.

Finally, if you want the user to join as a Guest (aka they won’t have a specific account with Cavrnus), versions of both of these calls exist for Guests.

image-20250409-194254.png
This setup will create a temporary user named “Demo User” and place them in “my-space-id”

Note: A Cavrnus Space will often be filled with Properties pointing to specific paths within your application. Therefore, allowing users to just open any Space could result in them bringing down a Journal that is meant to be for a different application.

Example: One of your users has access to a Car Configurator Application which connects to the “Car Config” Space. They also have access to a Conference Room Application. Allowing them to join the “Car Config” Space from the Conference Room Application would give them a bunch of car-related Properties which their Application wouldn’t know what to do with.

Info: Members vs Guests

Members are authorized users who have login credential on your domain. This method is recommended for controlling access to private or sensitive information.

  • Member accounts are persistent, and can either be given access to all Spaces, or to specific Spaces individually. When selecting “Join as Member”, there are two options for entering login credentials.

Guests can join automatically with no authentication. This is recommended for delivering an experience to a wide audience, without the need for creating and managing a large number of temporary accounts.

  • Guests can only join spaces which have been configured to allow guests to join. (See: Creating and Managing Spaces).

  • Guests can only access a Space through a hyperlink that has been provided to them.

  • These “guest accounts” can be used by multiple people simultaneously, but they do have a limited lifespan and will be deleted after the duration expires.

ON THIS PAGE

 

Next Steps

That’s the only change required to your level in order to connect it to a Cavrnus Space.

Next, we’ll configure the Connector to add login credentials, and specify which to which Cavrnus Space the level should connect.

Alternatively, you can read up on more advanced techniques in our Developer Guide, or make calls directly using our API Reference.