/
v2.0 Installation Instructions

Private & Confidential

v2.0 Installation Instructions

This guide will walk you through adding the required components to a scene to enable your Unity project for Igloo compatibility.

Refer to the Reference for a more in-depth look at the components that make up the Igloo camera toolkit, and how it can be customised for certain use cases.

If you are new to Unity, we recommend exploring some of Unity's interactive tutorials to familiarise yourself with the Unity interface and concepts before continuing. More information on Unity can be found at their Learn Site.

If you’ve not yet downloaded this version, you can do so from https://camerapackages.igloovisiondesign.com/pages/unitydownloads.html

 

Project Setup

Package Import

To import the v2 version of the Igloo Toolkit, please use Unity’s Package Manager.

You can find it under Window → Package Manager

 

image-20240418-150015.png
Location of Package Manager in Unity Editor

Open the Package Manager, and click the Plus button in the top left hand corner of the window,, then select Install Package from tarball…

image-20240418-150157.png
Install from tarball location

A browser window will open. Navigate to your Igloo Toolkit downloaded files which have been obtained from our Downloads page. Select the com.igloo.toolkit-2.x.x.tgz file, and press the Open button

image-20240418-150457.png
Selecting com.igloo.toolkit-2.0.0.tgz from the desktop

The package will then begin to import and unity will start to compile.

image-20240418-151010.png
Tarball package importing

Once installed, the package manager will look like this.

image-20240418-151744.png

Input Settings

The Igloo camera package requires some custom Input settings to be compatible with an Xbox controller. This can be done one of two ways;

Note - The next step is important, you will encounter errors in play mode if you do not apply the following settings.

The IglooPlayer system requires two custom Input Axes, a custom tag, and 2 custom layers to be defined in the Unity project settings.

These can be appended to your existing settings automatically by selecting Tools → Igloo > Apply Igloo Settings from the Unity Editor.

image-20250303-133802.png

You will then get a popup asking which style of installation you would like:
As the Igloo Toolkit needs at least one additional package to work with Igloo Core Engine (Klak Spout) you have the option to install only that via Essential Packages, or All Packages where it will install NDI and OSC for full functionality.

image-20250303-133917.png

Installing No Packages will mean that your build can only work “direct to screen” using Igloo’s True Perspective system.

It may take Unity a second or two to figure out what has just happened, so it’s best to click onto something else then click back on the Unity Editor (Or press the Windows Key, then select the editor again) which forces Unity to re-compile.

You’ll then get a small notification regarding the additional packages that have been added to the package manager. This popup can be closed without issue.

You are now ready to add the Igloo Manager to the scene.

 

Related content

(c) Igloo Vision 2020