Skip to content

Setting up

This chapter walks you through installing ViveEngine, activating license, and verifying everything works.

What you'll need

  • Operating system: Windows 10/11 or macOS 14.4+ (Sonoma)
  • Administrator access: Driver installation requires admin rights
  • Internet connection: License activation needs online access
  • A license: Free developer license or paid business license

Setup steps

Four steps to get started:

  1. Install the engine — Get ViveEngine on the system
  2. Verify and activate — Check installation and enable processing with a license
  3. Download SDK — Get SDK to build apps with ViveEngine
  4. Try it out — See the engine in action

What gets installed

ViveEngine adds several components to the system:

Component Purpose
Background services Manage audio processing pipelines and handle API requests
Audio driver HAL plugin (macOS) or APO (Windows) intercepts audio
CLI tools ViveEngineAdm for installation management, vive-ctl for engine control

Info

The engine does not intercept audio and remains idle until you enable it via RPC or CLI.

After setup

Once installed, you can:

  • Build apps that control the engine via RPC
  • Write custom plugins and load them into the engine
  • Configure processing and plugins from command-line

Ready to start?

First up: