Guide for running Unity in Continuum - uic-evl/omicron-unity GitHub Wiki

Last revision: 16 June 2023

Currently Supported Unity Versions:

  • 2022.2.20f1

Introduction

The purpose of this guide is to provide an overview of using the Unity3D game engine on the Continuum display wall systems (both the main and the 3D walls) at the Electronic Visualization Laboratory (EVL) at the University of Illinois Chicago (UIC) using more recent version of Unity3D (CAVE2 support may follow).

Note: This currently uses an experimental branch of module-omicron while the master branch maintains support for the CAVE2(TM) Hybrid-Reality Environment under Unity 2019.2.11 and GetReal3D 4.0.5 (as of July 2023).

The overall goal of this branch is to simply the configuration needed to run a 3D stereoscopic and motion tracked application on the Continuum 3D wall.

Quick Start Guide

In general, the setup is designed to be as simple as dropping the required prefabs and player controllers into any Unity project, set the proper configuration file, and build the standalone application. Once built as a standalone, the core settings are still configurable given the configuration files or the in-game Alt-F11 debug menu.

New Unity Project

  1. Create a new project (tested using Unity 2022.2.20f1)

    • Using 3D Core Template
  2. Unity Editor:

  3. To test with 3D/tracking in Unity Editor:

    • Open module-omicron/config.cfg

    • Move 'continuum3d.cfg' to top of file

    • Using Example Project 'Cube World Example (Continuum3D)'

      • module-omicron/Continuum/Scenes/Cube World Example (Continuum3D).unity

Existing Unity Project

  1. Add the following prefabs into your scene:
    • module-omicron/Continuum/Prefabs/CAVE2-Manager.prefab
    • module-omicron/Continuum/Prefabs/CAVE2-PlayerController.prefab
      • Note these are Prefab Variants of the 'CAVE2' CAVE2-Manager/CAVE2-PlayerControllers and mostly the same with a few minor changes.
      • It is recommended at this time not to rename these two objects

Building a Standalone Executable

  1. Build a standalone as normal

  2. Copy config files

    • module-omicron/config.cfg
    • module-omicron/Configs folder
    • Copy into [Product Name]_data folder
  3. Make sure '[Product Name]_data/config.cfg' has the correct config file listed on top

General Notes

  • Alt-F11 can be used to open the 'Debug Manager Window' where many of the config parameters can be changed at runtime. Changes here will not update the config file.

  • If tracking fails and the Tracking System in the Debug Manager Window reports a 'Failed to Connect' try changing the DataPort number (sometimes if the same port is used in the Editor - even if it's not Playing, will still block that port).