Baballonia

Baballonia is a cross-platform, hardware-agnostic VR eye and face tracking application.

---

Installation

Windows

Head to the Releases tab and download the latest installer. Follow the instructions in the wizard to install.

You may be prompted to download the .NET runtime for desktop apps, install it if needs be.

MacOS & Linux

Baballonia does not currently have an installer for MacOS or Linux. You will need to follow our build instructions and run it from source.

NixOS (Flakes)

You can run Baballonia with just nix run github:Project-Babble/Baballonia

---

Use

VRChat

To use Baballonia with VRChat, you will need to use VRCFaceTracking with its VRCFaceTracking module.

You will need to download and install the latest version of VRCFaceTracking which can be found on Steam

Once you have the program installed, you will need to install our module from the registry.

More information can be found on the VRCFT Docs

Alternatively, we also support VRC Native Eyelook. Note that this is not as expressive as VRCFT, and doesn't support lower face tracking, but it does support almost all Avatars.

Resonite / ChilloutVR

TBD - Existing mods should be compatible with Baballonia's lower face tracking.

Supported Hardware

Baballonia supports many kinds of hardware for eye and face tracking:

Device	Eyes	Face	Notes
Official Babble Face Tracker	❌	✅
DIY and 3rd party Babble Trackers	❌	✅
Vive Facial Tracker	❌	✅	Linux Only
DIY EyetrackVR	✅	❌
Bigscreen Beyond 2e	✅	❌
Vive Pro Eye	✅	❌	Requires Revision
Varjo Aero	✅	❌	Requires the Varjo Streamer
HP Reverb G2 Omnicept	✅	❌	Requires BrokenEye
Pimax Crystal	✅	❌	Requires BrokenEye

---

Build Instructions

If you want to build from source, clone this repo, its submodules and open the .sln/.csproj files in an editor of your choice. This has been tested and built on Visual Studio 2022 and Rider, but it should work with other IDEs.

The Desktop App

To build the desktop app, you'll want to build and load the following projects:

• Baballonia.OpenCVCapture
• Baballonia.SerialCameraCapture
• HyperText.Avalonia
• Baballonia
• Baballonia.SDK
• Baballonia.Desktop
• Optionally, Baballonia.Tests

Trainer instructions

In order to use the trainer, you must first a) download its dependencies or b) build them yourself. You can accomplish this by:

• a) Run the fetch_internal.ps1 script once after a clone. This will download and place the _internal.zip file into your Baballonia.Desktop project
• b) Run pyinstaller on the trainermin.py file, zip up its internal directory contents into an archive called _internal.zip and place it in the Baballonia.Desktop project

Linux notes

libtesseract 4 is deprecated in newer repositories, but is needed to build.

The Mobile App

• Baballonia.OpenCVCapture
• Baballonia.IPCameraCapture
• HyperText.Avalonia
• Baballonia
• Baballonia.SDK
• Baballonia.Android OR Baballonia.iOS
• Optionally, Baballonia.Tests

To build the mobile app(s), you'll want to build and load the following projects:

The VRCFaceTrackingModule

To build the VRCFaceTracking module, you'll want to build and load the following projects:

• VRCFaceTracking.Core
• VRCFaceTracking.SDK
• VRCFaceTracking.Baballonia