Inspect and control Rive runtime behavior from VS Code.

RiveTelemetry connects Rive runtimes, including Flutter and JavaScript apps, to a local VS Code panel over WebSocket for real-time inspection and control.

Features

Inspect live Rive State Machine inputs
Control boolean, number, and trigger inputs from VS Code
Inspect ViewModel telemetry
Mutate supported ViewModel properties
Support multiple Rive runtimes with runtimeId and label
Preserve last-known telemetry when the app disconnects
Clear retained telemetry manually from the panel

Quick Start

Install the extension

Install the packaged extension from this directory:

code --install-extension rive-telemetry-0.3.1.vsix

Then open the command palette and run:

RiveTelemetry: Open Panel

The extension starts a local WebSocket server at:

ws://localhost:8080

Flutter

Add the Flutter bridge package to your app:

dependencies:
  rive_telemetry: ^0.3.1

Wrap your rendered Rive widget and pass the loaded state machine:

RiveDebugger(
  stateMachine: stateMachine,
  stateMachineName: 'State Machine 1',
  child: rive.RiveWidget(controller: controller),
)

For local validation, you can opt in explicitly and provide stable runtime identity fields:

RiveDebugger(
  enabled: true,
  source: 'my-flutter-app',
  runtimeId: 'main-rive',
  label: 'Main Rive',
  stateMachineName: 'State Machine 1',
  stateMachine: stateMachine,
  child: rive.RiveWidget(controller: controller),
)

Telemetry is disabled in Flutter release builds by default unless enabled is set to true.

JavaScript

Add the JavaScript bridge package to your app:

npm install @rimotli-tech/rive-telemetry

Start telemetry after your Rive runtime is available:

import { RiveTelemetry } from '@rimotli-tech/rive-telemetry';

const telemetry = new RiveTelemetry({
  rive,
  runtimeId: 'main-rive',
  label: 'Main Rive',
  stateMachineName: 'State Machine 1',
});

telemetry.start();

ViewModel telemetry

If your Rive file uses data binding, pass the loaded ViewModelInstance and ViewModel name to inspect and mutate supported properties from the panel.

RiveDebugger(
  enabled: true,
  stateMachineName: 'State Machine 1',
  stateMachine: stateMachine,
  viewModelName: 'CatViewModel',
  viewModelInstance: viewModelInstance,
  child: rive.RiveWidget(controller: controller),
)

Supported mutable ViewModel property types are number, boolean, string, color, enum, and trigger.

Protocol

Flutter and JavaScript clients send JSON telemetry over WebSocket. Current clients send protocolVersion: 1; the extension also accepts older payloads without that field.

Development

Install dependencies and compile the extension:

npm install
npm run compile

Run a type check without emitting files:

npm run check

Package the Marketplace VSIX:

npx --yes @vscode/vsce package

The extension package is scoped by .vscodeignore so the VSIX includes only runtime files, the README, license, icon, compiled output, and production dependencies.