Page Comparison

...

service

Configuration for the service’s backend

• httpPort (number; default 800)

  • insecure webserver port for all pages provided by the service

  • requires restart

• httpsPort (number; default 801)

  • secure (HTTPS) webserver port for the same pages. Everything is served on both ports simultaneously.

  • requires restart

• oscPort (number; default 9003) [requires restart]

  • port that the service listens on for incoming OSC. Needs to match Playback and Igloo Control Panel’s OSC outport ports.

  • requires restart

• computerName (string; default empty) [requires restart]

  • name for the machine, shown only in ICE Igloo Control Panel’s discovery page.

  • requires restart

ice

Configuration for interactions with Igloo Core Engine

• udpPort (number; default 10001)

  • port on which to send UDP messages to Igloo Core Engine

  • requires restart

controllers

Configuration for outgoing messages from the game engine page.

• clients (array of strings; default ['localhost:9007', 'localhost:9008']

  • Hosts to send ximu/euler OSC to (Unity/Unreal).

• controllerServicePort (number; default 10000).

  • Port that Igloo Controller Service is running on. (For movement/controller emulation messages).

sources

Configuration for behaviour of the sources app (Sources tab in Igloo Control Panel).

...

Configuration for keyboard/mouse casting app (Mouse tab in ICE Igloo Control Panel).

• behaviour ("ice" or "web"; default "ice")

  • Destination of keyboard/mouse events from the cast app - ICE Igloo Core Engine or Igloo Web.

  • requires restart

youTube

Configuration for Warper Suite Igloo Control Panel’s YouTube app.
Position/scale are used to position the Capture channel somewhere other than the middle of the screen. The channel’s position is reset whenever a new video is provided (to prevent 16:9 videos appearing initially with 360 settings).

...

Configuration for Igloo Web/ICE’s Igloo Core Engine’s built-in WebView file browser.

...

• p (string; default empty)

  • ‘project’ URL parameter provided to any spacewalk instances on pageload

  • updated by the spacewalk app when a user explicitly visits a new project using the bookmarklet

• env (string; default empty)

  • ‘environment’ URL parameter provided to any spacewalk instances on pageload

  • updated by the spacewalk app when a user explicitly visits a new environment using the bookmarklet

• useQA (boolean; default false)

  • whether to use QA or production environment for spacewalk instances

projectorControl

Configuration for projector control capabilities of the backend. Set the target port and desired OSC message(s) here.

...

Open Stage Control configuration. See the documentation for the app for more details.

• launch (boolean; default false)

  • whether to start bundled open stage control instance with the service

  • requires restart

• port (number; default 803 802)

  • port for bundled open stage control instance

  • requires restart

• theme (string; default <install directory>/open-stage-control/igloo.css)

  • path to open stage control theme

  • requires restart

• session (string; default <install directory>/open-stage-control/default_session.json)

  • path to open stage control session

  • requires restart

• parameters (array of strings; default [])

  • extra command line parameters to pass to bundled open stage control

  • these parameters are passed by default: --no-gui --read-only --port <configured port> --theme <configured theme> --load <configured session>

  • requires restart

skybox

• apiKey (string; default empty)

  • BlockadeLabs API key.

streetview

• apiKey (string; default empty)

  • Google Maps API key.

matterport

• apiKey (string; default empty)

  • Matterport API key

• useEmbedSdk (boolean; default false)

  • For debugging; use Matterport embed SDK instead of default bundle SDK.

• oAuthUrl (string; default https://auth.igloo.vision/matterport/)

  • URL for Igloo Matterport Service oAuth proxy.

• homePort (number; default 9011)

  • Igloo Home port; legacy.

• homeTimeMinutes (number; default 5)

  • Time before returning to Igloo Home when opened with a specific URL; legacy.

annotation

controlPanel

...

• defaultColour (string; default black).

  • Starting colour of pen tool on annotation page.

• defaultFontSize (number; default 90).

  • Starting font size of text tool on annotation page.

• defaultStrokeWidth (number; default 6).

  • Starting stroke width of pen tool on annotation page.

• eraserMenuPos (vector2; default {x: 0, y: 90}).

  • Position of top left corner of eraser menu on annotation page (in %).

• sidebarPos(vector2; default {x: 0, y: 12}).

  • Position of top left corner of sidebar menu on annotation page (in %).

• toolMenuPos(vector2; default {x: 0, y: 0}).

  • Position of top left corner of tools menu on annotation page (in %).

• clearAllPos(vector2; default {x: 0, y: 80}).

  • Position of top left corner of clear-all menu on annotation page (in %).

controlPanel

Igloo Control Panel browser configuration. See Igloo Control Panel browsers for more details.

• tabs (array of strings; default ["default"])

  • tab identifiers to display in ICE Igloo Control Panel instances connected to this service.
    Identifiers must be configured; see below

• apps (array of strings; default ["matterport", "streetview", "warping", "default"])

  • list of app identifiers to display in ICE Igloo Control Panel instances connected to this service.
    Identifiers must be configured; see below

• _defaultOverrides (object<BrowserIdentifier, Partial<BrowserDeclaration>Partial<BrowserDeclaration>>)

  • override default properties of pre-set browsers; see below

ICE Control Panel browsers

Tabs and applications shown by ICE Control Panel instances connected to a service are configured by that service. This section describes available pre-set browsers, defaults, and custom browser configuration. See above for the related configuration keys in config.json.

Any configured browser can be used as an app or a tab.

...

• • -set

...

• "cast" - Cursor Control

• "gameEngine" - Game Control

• "apps" - Apps

• "canvasShare" - Canvas Share

• "matterport" - /wiki/spaces/ITD/pages/1910571025 control page

• "streetview" - /wiki/spaces/ITD/pages/2636414983 control page

• "icedrop" - ICE Drop

• "openStageControl"

Defaults

The "default" identifier for apps and tabs displays the recommended selection. This can change between versions, so new apps and tabs are automatically shown when using this setting.
Current defaults:

• Tabs: ["cast", "gameEngine", "apps"]

• Apps: ["matterport, streetview", "icedrop"]

...

• • browsers

...

coming soon; page will be updated

Overriding pre-set browser properties

coming soon; page will be updated

...

Default config.json

This is created by the service as required. You don’t need to manually create it, or manually add keys (as explained above)

{
  "service": {
    "httpPort": 800,
    "httpsPort": 801,
    "oscPort": 9003,
    "computerName": ""
  },
  "ice": {
    "udpPort": 10001
  },
  "controllers": {
    "clients": [
      "localhost:9007",
      "localhost:9008"
    ],
    "controllerServicePort": 10000
  },
  "sources": {
    "ignoreList": [
      "IGLOOHOME"
    ]
  },
  "cast": {
    "behaviour": "ice"
  },
  "youTube": {
    "captureName": "YouTube",
    "scale": 1,
    "position": [
      0.5,
      0.5
    ]
  },
  "fileBrowser": {
    "contentFolderPaths": [
      "C:\\igloo\\Content\\"
    ]
  },
  "icedrop": {
    "directory": "C:\\content\\icedrop"
  },
  "spacewalk": {
    "p": "",
    "env": "",
    "useQA": false
  },
  "projectorControl": {
    "port": 9016,
    "on": [
      "/deviceControl/projectors/on"
    ],
    "off": [
      "/deviceControl/projectors/off"
    ]
  },
  "controlPanel": {
    "tabs": [
      "default"
    ],
    "apps": [
      "matterport",
      "streetview",
      "warping",
      "default"
    ],
    "_defaultOverrides": {}
  },
  "openStageControl": {
    "launch": false,
    "port": 802,
    "theme": "C:\\dev\\igloo-core-service\\dist\\open-stage-control\\igloo.css",
    "session": "C:\\dev\\igloo-core-service\\dist\\open-stage-control\\default_session.json",
    "parameters": []
  },
  "skybox": {
    "apiKey": ""
  },
  "streetview": {
    "apiKey": ""
  },
  "matterport": {
    "apiKey": "",
    "useEmbedSdk": false,
    "oAuthUrl": "https://auth.igloo.vision/matterport/",
    "homePort": 9011,
    "homeTimeMinutes": 5
  },
  "annotation": {
    "defaultColour": "black",
    "defaultFontSize": 90,
    "defaultStrokeWidth": 6,
    "eraserMenuPos": {
      "x": 0,
      "y": 90
    },
    "sidebarPos": {
      "x": 0,
      "y": 12
    },
    "toolMenuPos": {
      "x": 0,
      "y": 0
    },
    "clearAllPos": {
      "x": 0,
      "y": 80
    }
  }
}