Update README

This commit is contained in:
dfgHiatus committed 2025-10-21 13:20:25 -05:00
1 parent f941f91a92
commit af5c15673a
2 files changed
+40 -29

No files matched your search

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

+40 -29
View File
@@ -1,60 +1,66 @@
![Baballonia Promo](BaballoniaPromo.png)
# Baballonia
**Baballonia** is a cross-platform, hardware-agnostic VR eye and face tracking application.
---
## Installation
### Windows
Head to the [Releases](https://github.com/Project-Babble/Baballonia/releases/latest) tab and download the latest installer. Follow the instructions in the wizard to install.
Head to the releases tab and [download the latest installer](https://github.com/Project-Babble/Baballonia/releases/latest).
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.
Baballonia currently does not have an installer for macOS or Linux. You will need to follow our build instructions and run it from source.
Baballonia *can* be run through Wine, as documented on the [Linux VR Adventures Wiki](https://lvra.gitlab.io/docs/other/bigscreen-beyond-driver/#bigscreen-beyond-2e-eyetracking-via-baballonia-under-linux).
#### NixOS (Flakes)
You can run Baballonia with just ``nix run github:Project-Babble/Baballonia``
Simply run Baballonia with ``nix run github:Project-Babble/Baballonia``
---
## Use
## Platform Compatibility
### VRChat
To use Baballonia with VRChat, you will need to use VRCFaceTracking with its VRCFaceTracking module.
#### VRCFaceTracking
You will need to download and install the latest version of VRCFaceTracking which can be found on [Steam](https://store.steampowered.com/app/3329480/VRCFaceTracking/)
To use Baballonia with VRChat, you will need to use VRCFaceTracking with the `VRCFT-Babble` module.
Once you have the program installed, you will need to install our module from the registry.
1. Download and install the latest version of VRCFaceTracking from [Steam](https://store.steampowered.com/app/3329480/VRCFaceTracking/).
1. Install the `VRCFT-Babble` module within VRCFaceTracking.
1. Use Baballonia to set the module mode (eyes, face or both). Restart VRCFaceTracking to see your changes.
More information can be found on the [VRCFT Docs](https://docs.vrcft.io/docs/vrcft-software/vrcft\#module-registry)
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.
#### VRC Native Eyelook
Alternatively, Baballonia also supports [VRC Native Eyelook](https://docs.vrchat.com/docs/osc-eye-tracking).
While this doesn't support lower face tracking, it supports (almost) all VRChat Avatars.
### Resonite / ChilloutVR
TBD - Existing mods should be compatible with Baballonia's lower face tracking.
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 | :x: | ✅ | |
| DIY and 3rd party Babble Trackers | :x: | ✅ | |
| Vive Facial Tracker | :x: | ✅ | Linux Only |
| DIY EyetrackVR | ✅ | :x: | |
| Bigscreen Beyond 2e | ✅ | :x: | |
| Vive Pro Eye | ✅ | :x: | Requires [Revision](https://github.com/Blue-Doggo/ReVision) |
| Varjo Aero | ✅ | :x: | Requires the Varjo Streamer |
| HP Reverb G2 Omnicept | ✅ | :x: | Requires [BrokenEye](https://github.com/ghostiam/BrokenEye) |
| Pimax Crystal | ✅ | :x: | Requires [BrokenEye](https://github.com/ghostiam/BrokenEye) |
| Device | Eyes | Face | Notes |
|-----------------------------------| ----- | ----- |-------------------------------------------------------------|
| Official Babble Face Tracker | :x: | ✅ | |
| DIY and 3rd party Babble Trackers | :x: | ✅ | |
| Vive Facial Tracker | :x: | ✅ | Linux Only, WIP |
| DIY EyetrackVR | ✅ | :x: | |
| Bigscreen Beyond 2E | ✅ | :x: | |
| Vive Pro Eye | ✅ | :x: | Requires [Revision](https://github.com/Blue-Doggo/ReVision) |
| Varjo Aero | ✅ | :x: | Requires the Varjo Streamer |
| HP Reverb G2 Omnicept | ✅ | :x: | Requires [BrokenEye](https://github.com/ghostiam/BrokenEye) |
| Pimax Crystal | ✅ | :x: | Requires [BrokenEye](https://github.com/ghostiam/BrokenEye) |
---
@@ -64,7 +70,7 @@ If you want to build from source, clone this repo, its submodules and open the `
### The Desktop App
To build the desktop app, you'll want to build and load the following projects:
To build the desktop app, build and load the following projects:
- `Baballonia.OpenCVCapture`
- `Baballonia.SerialCameraCapture`
@@ -74,7 +80,9 @@ To build the desktop app, you'll want to build and load the following projects:
- `Baballonia.Desktop`
- Optionally, `Baballonia.Tests`
#### Trainer instructions
Run `Baballonia.Desktop`.
#### Windows Notes - 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
@@ -86,16 +94,17 @@ In order to use the trainer, you must first a) download its dependencies or b) b
### The Mobile App
To build the Android mobile app, build and load the following projects:
- `Baballonia.OpenCVCapture`
- `Baballonia.IPCameraCapture`
- `HyperText.Avalonia`
- `Baballonia`
- `Baballonia.SDK`
- `Baballonia.Android` OR `Baballonia.iOS`
- `Baballonia.Android`
- Optionally, `Baballonia.Tests`
To build the mobile app(s), you'll want to build and load the following projects:
`Baballonia.Android` will produce an APK you can install on an Android device (and Quest HMD).
### The VRCFaceTrackingModule
@@ -105,3 +114,5 @@ To build the VRCFaceTracking module, you'll want to build and load the following
- `VRCFaceTracking.SDK`
- `VRCFaceTracking.Baballonia`
`VRCFaceTracking.Baballonia` will produce a `.zip` module you can install, as well as the module DLL.