Viscereality Companion mark
Altered States of Viscereality Companion desktop operator surface

Start Here

Docs Home

Sussex-focused public entry point for the Windows companion app, with broader multi-study tooling planned after the current Sussex collaboration release is stable.

Viscereality Companion

Viscereality Companion is the Windows-side access point for researchers, labs, and collaborators who want to use Viscereality without hand-building Quest tooling or digging through runtime code. The goal is one place to connect the headset, install the right build, verify live telemetry, run the study workflow, and keep operator control on Windows.

Install The App Sussex Fix Pilot Run A Sussex Session Companion Overview Viscereality Project Site Troubleshooting

Current Public Focus

  • the current release is being hardened for the collaboration with Hugo Critchley's lab at Sussex
  • the packaged Sussex release already bundles the approved Sussex APK, device profile, study shell, and operator diagnostics
  • the Sussex shell includes editable experiment-session conditions so the operator can choose between the current profile bundle and the fixed-radius, no-orbit profile bundle
  • the app opens directly into Sussex University experiment mode so a researcher can stay on one guided Windows workflow
  • broader general-purpose multi-study tooling comes after the Sussex-first release path is stable

What The Windows Companion Already Handles

  • the WPF operator app
  • USB and Wi-Fi ADB connection from Windows
  • install and launch for the bundled Sussex APK or another supplied study APK
  • live Quest, LSL, and twin-state monitoring
  • study shells that lock the operator UI to a specific protocol
  • runtime-config staging and saved profile workflows from the desktop side
  • release assets that let another machine install the same researcher-facing setup

Use This Repo When You Need To

  • install the study build directly from Windows
  • stage device and runtime settings without opening the Quest-side project
  • launch the participant-facing runtime and confirm the foreground package
  • watch quest_monitor, LSL, twin-state, and operator diagnostics during a run
  • keep researchers on a one-stop GUI instead of a pile of separate lab utilities
  • package a study-specific operator surface for a lab workflow

If This Is Your First Session

Use these three pages in order:

  1. Download the Windows app or launcher path you were given.
  2. First Session to connect the Quest, install the study APK, and launch it.
  3. Study Shells if your team gave you a dedicated operator surface such as Sussex.

Choose Your Path

Companion Overview

Public-facing overview of what the companion app is for, who it is for, and where the Sussex-first release sits in the broader roadmap.

Install The Launcher

Preferred path for researchers and operators. The current public installer is a Sussex-focused packaged release that already bundles the study build and opens in the dedicated study shell.

Sussex Fix Pilot

Assigned operators can install the isolated pilot package and follow the participant-session validation workflow without changing the public release.

First Sussex Session

Connect Quest, approve USB debugging, install the Sussex APK, switch to Wi-Fi ADB, and launch Sussex in one pass.

Dedicated Study Shell

Understand what the Sussex package pins, hides, and bundles so researchers stay on the safe operator path.

Sussex Conditions

Inspect and share the active experiment-session choices that combine visual and breathing profiles.

Runtime Config

Use the grouped runtime editor to stage tracked desktop-side changes without dropping into the Quest project.

Build From Source

Use this only if you are validating or changing the repo itself, and remember to pull the Git LFS APK mirror.

Need A Custom Adaptation?

If you need a lab-specific study shell, a custom operator workflow, different telemetry plumbing, packaging for a new protocol, or changes to the participant-facing Viscereality build itself, I am open to commissioned adaptation work around both the Viscereality system and this Windows companion.

Contact Via Mesmer Prism Source Repo

Read These First

Project Scope

This repo is public and focused on the Windows companion, documentation, packaging, and study-shell delivery. The participant-facing Quest runtime is part of the broader Viscereality system but stays separate from this public operator repo. If you need the outward-facing project context, go to viscereality.org. If you need the public-facing companion overview, use the Mesmer Prism companion page.