Link Search Menu Expand Document
COLIBRI VR

Installation

Required steps

  1. Install the Unity game engine.
  2. Use the Unity package manager to add the package from COLIBRI VR’s Git page. If you do not have Git, you can simply download the package from Git and manually add it into Unity using the package manager.

There’s a tutorial for this!

The video tutorial for installing the package from GitHub can be found here.

Optional steps: linked external tools

Using the toolkit’s graphical user interface, several external tools can be used from within Unity as part of COLIBRI VR’s processing pipeline (see this section of the Processing page for more details). These tools have to be installed separately. For simplicity, we recommend downloading the pre-built binaries.

  • To perform sparse and dense 3D reconstruction from photographs:
    Install COLMAP.

  • To convert mesh file formats and perform mesh simplification:
    Install Blender.

  • To apply mesh retopology methods:
    Install Instant Meshes.

There’s a tutorial for this!

The video tutorial for linking the package to external tools can be found here.

Frequently asked questions

Can I run COLIBRI VR on any operating system?

COLIBRI VR should work on any operating system supported by the Unity game engine, and the linked external tools provide binaries for Windows, Mac OS X, and Linux. That being said, we have only tested the project on Windows 10, so feel free to provide feedback on this matter.

Do I need a special setup to run COLIBRI VR?

A CUDA-enabled GPU is required if you wish to perform dense reconstruction via COLMAP, but is not necessary otherwise.

Additionally, it is important to note that the processing/rendering pipeline is often performance-intensive in terms of GPU memory. Make sure to monitor memory during troubleshooting.

Is the project affiliated with any or all of the linked external tools?

No, these tools are not affiliated in any way with COLIBRI VR. The word linked here simply means that the toolkit implements dedicated classes and interface elements for using these tools from within Unity, by way of underlying command-line calls.