Knowledge Base Directory

Installing the Cavrnus SDK

Installing the Cavrnus SDK and Cavrnus Unity Package for Windows and macOS.

Installing the Cavrnus SDK

Installing the Cavrnus SDK and Cavrnus Unity Package for Windows and macOS.

Contents

‍

‍↑ Back to Contents

Installing the Cavrnus SDK on macOS

Here is how to Install the Cavrnus SDK on macOS devices.

Prerequisites.

You will need:

  1. You will need access to the web
  2. Cavrnus account.
  3. You will also need to have Cavrnus installed.
  4. Please confirm that your Cavrnus Production build version and SDK version are the same and current.

OVERVIEW

GUIDE

1. Download the Cavrnus SDK from the web via your Account Administration settings, ‘[yourdomain].cavrn.us//admin/workspaces'. Log in and select ‘Cavrnus SDK’ from the 'Tools’ section in the left panel. Unzip the file in the location of your choice.

2. Click here to download Unity Hub: https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.dmg.

3. Then install Unity for your Mac device. Please ensure that the selected Unity version is compatible with your installed Cavrnus version by referring to screenshshot here.

Type image caption here (optional

4. Switch back to the Unity Hub, then select the ‘Installs’ tab. Then, Click the ‘Locate’ button in the upper right hand corner and locate the installed Unity application in step 3.

5. Navigate to Projects and select ‘New Project’ to create a new 3D Sample Scene (URP) project. Be sure the Unity Editor selected for the project is the same version installed in step 4.

6. Within Unity on the Toolbar, find and open ‘Window’ and then select 'Package Manager'.

7. Change the Packages to ‘Unity Registry’.

8. Install the ‘FBX Exporter’.

9. Remove 'Version Control'.

‍

10. Navigate back to the Toolbar and open ‘Assets’, then select ‘Import Package' and click 'Custom Package’. In your Finder, locate the previously unzipped Cavrnus SDK in Step 2 and select the Unity folder to import the ‘UnityHoloPlugin’ file.

11. Back in the Unity Editor, continue to import all contents of the Cavrnus Unity Package per import window prompt.

12. Your setup of the Cavrnus Unity Package is complete! Now, in your Unity Editor Toolbar, you will see a new ‘Cavrnus’ tab. Click the ‘Cavrnus’ tab to select and use the 'Cavrnus Editor’.

Congrats on setting up the Cavrnus Unity Package for macOS! If you prefer to have the Cavrnus Editor in view, drag the panel into your project workspace to arrange in a way that makes the most sense for your context.

THINGS TO NOTE

  • You must have a Unity Developer account to accurately follow these steps.
  • For the easiest experience, we recommend installing Unity through Unity Hub.
  • Ensure that the Unity Editor version you are installing is matches the SDK version.
  • Be sure to update Cavrnus and your macOS device to the their latest versions, respectively.

TROUBLESHOOTING

If your Mac is saying that the ‘Unity package that was downloaded from the internet cannot be verified’ and wont allow you to open the package. You will have to open the package via the Finder’s context menu to open it.

Steps

  1. Open the Finder.
  2. Locate the Unity file in question.
  3. Right click on the file and select ‘Open’ in the file’s context menu.
  4. Confirm that you want to open the file by clicking ‘Open’ in the popup window.

‍

‍

‍

‍↑ Back to Contents

Installing the Cavrnus SDK on Windows

Here is how to Install the Cavrnus SDK on Windows devices.

Prerequisites.

You will need:

  1. You will need access to the web
  2. Cavrnus account.
  3. You will also need to have Cavrnus installed.
  4. Please confirm that your Cavrnus Production build version and SDK version are the same and current.

OVERVIEW

GUIDE

1. Download the Cavrnus SDK from the web via your Account Administration settings, ‘[yourdomain].cavrn.us//admin/workspaces'. Log in and select ‘Cavrnus SDK’ from the 'Tools’ section in the left panel. Unzip the file in the location of your choice.

2. Click here to download Unity Hub: https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.dmg.

3. Then install Unity for your Mac device. Please ensure that the selected Unity version is compatible with your installed Cavrnus version by referring to screenshshot here.

4. Switch back to the Unity Hub, then select the ‘Installs’ tab. Then, Click the ‘Locate’ button in the upper right hand corner and locate the installed Unity editor application downloaded in step 3.

5. Navigate to Projects and select ‘New Project’ to create a new 3D Sample Scene (URP) project. Be sure the Unity Editor selected for the project is using the Unity editor installed in step 4.

6. Within Unity on the Toolbar, find and open ‘Window’ and then select 'Package Manager'

7. Change the Packages to ‘Unity Registry’.

‍

8. Install the ‘FBX Exporter’.

9. Remove 'Version Control'.

10. Navigate back to the Toolbar and open ‘Assets’, then select ‘Import Package' and click 'Custom Package’. In your Finder, locate the previously unzipped Cavrnus SDK in Step 2 and select the Unity folder to import the ‘UnityHoloPlugin’ file.

11. Back in the Unity Editor, continue to import all contents of the Cavrnus Unity Package per import window prompt.

12. Your setup of the Cavrnus Unity Package is complete! Now, in your Unity Editor Toolbar, you will see a new ‘Cavrnus’ tab. Click the ‘Cavrnus’ tab to select and use the 'Cavrnus Editor’.

Congrats on setting up the Cavrnus Unity Package for Windows! If you prefer to have the Cavrnus Editor in view, drag the panel into your project workspace to arrange in a way that makes the most sense for your context.

THINGS TO NOTE

  • You must have a Unity Developer account to accurately follow these steps.
  • For the easiest experience, we recommend installing the Unity Editor through Unity Hub.
  • Ensure that the Unity Editor version you are installing matches the SDK version.
  • Be sure to update Cavrnus and your Windows OS device to the their latest versions, respectively