Developers

Docs

How to run Synocular and bring gaze into your own software. Most people only need the first box.

Getting started

To start using Synocular:

  • Run the Windows installer supplied with each tracker. Trackers are planned for spring 2027. Partners on a paid evaluation, once evaluations open, receive the software under the evaluation agreement. It installs the desktop client and drivers.
  • Plug in your sensor bar, launch the client, and run the nine- or sixteen-point calibration.

Requirements: a Windows PC (x64) with a USB 3.0 port. The sensor bar comes with its tripod and cabling.

Integrate gaze into your software

Synocular exposes gaze in two ways:

  • Native API: call Synocular.Native directly from .NET / C# for the most direct access (this is how the example games are built).
  • JSON-RPC daemon: run synocular_daemon.exe and talk to it over TCP from any language.
DocWhat it specifies
WIRE_PROTOCOL.mdThe JSON-RPC TCP wire format, schema v1.1, the public commitment
API_SURFACE.mdThe public C++ / native API surface
SESSION_BUNDLE.mdThe recording format, bundle version 1.2

The documents are supplied with the SDK. These formats are versioned: each change is published as a new version.

SDKs & examples

The SDK comes with runnable reference clients:

  • Python: synocular_client.py, a pure-stdlib reference client for the wire protocol, plus runnable demos.
  • C# / .NET: seven gaze-controlled games built directly on Synocular.Native, each showing an interaction technique: dwell-to-select; continuous gaze positioning; smooth-pursuit selection, which matches the eye’s movement to a moving target and so works without calibration (Fireflies); continuous 2-D gaze control (Neon Sentinel); gaze-driven route finding (Rivet Rumble); intent from what is being looked at (Lantern Keep); and zone targeting with gaze-reactive defence (Iron Gaze).

Most examples also run without hardware (the daemon supports --no-tracking). The SDK is free to use with a Synocular tracker. Building the engine into a product you sell needs a licence: see For product makers.

Documentation map

You want to…Go to
Just run the trackerInstaller (above)
Stream gaze liveWIRE_PROTOCOL.md + the Python client
Call the native APIAPI_SURFACE.md + the C# examples
Read recorded sessionsSESSION_BUNDLE.md
Convert recordings to BIDS / EyeLink / Tobiisynocular-export

Support

Questions about integrating Synocular, or a feature you need: contact@synocular.com.

Scroll to Top