Choose your starting point.

ParamRig connects sound, drawings, layouts, scenes and web projects through rigs: named values and the properties they drive. You can use a complete tool in the application or install a public engine in your own project.

Use a tool

Open Sound, Vector and Layout, 3D or Web directly. Domains load when opened. Existing /r/:rigId links continue to identify their documents.

The tool pages show examples and capabilities. Local data explains browser storage, project files and the lightweight library index.

Integrate an engine

The SDK overview lists independent packages for Audio, Sound Labs, browser playback, Vector and Scene, plus Core contracts and optional React controls. Every guide includes installation, supported environments, resource ownership and a runnable example.

An SDK contains its engine and public APIs. Complete editors remain part of the application. Separate packages reduce installation dependencies; sub-entries reduce the code a bundler includes.

Connect a running website

Install @paramrig/web in the project being tuned, describe its controls in .paramrig/manifest.json, and open it in the local workbench. Approving writes a batch of values and comments. Your agent reads it, applies the changes and returns its resulting revision.

The Web SDK documents the contract. Connect a project shows the round trip. The connected workspace requires the local file service; the static hosted application cannot access a repository on its own.

Build a rig

A rig can travel inside an audio, vector or scene document, or be registered with an application module. Rigs, controls and animation describe those contracts.

For a local checkout or a selective application distribution, follow Run it locally.

Current boundaries

There is no account, cloud synchronization, native installer or offline module manager. Browser data belongs to its origin; export portable project files to keep a separate copy. Numeric animation tracks, format imports and exports retain their existing documented limits.

Start here

• Run it locallyDocker Compose, the ports it takes, and the optional web profile.

Rigs

• What a rig isA manifest, a renderer and module registration.
• ControlsThe value contract every control keeps, and the eleven families.
• AnimationTracks, keys, easing, and the seven ways to drive a number.

Documents

• Binding a drawingThe properties of a vector element a control can write to.
• Binding a sceneThe paths a control can write to in a 3D document.
• Files and exportWhat each editor writes, and what an export does not carry.
• Local dataWhat the browser keeps, and how to take it away.

SDKs

• Choose a packageIndependent engines and optional controls.
• CoreContracts, validation, bindings and animated values.
• AudioPatches, synthesis, modulation and block rendering.
• Sound LabsSeeded generation, variation, fusion and catalogs.
• Browser audioIndependent AudioWorklet players and host-owned transport.
• VectorDrawing and layout documents, bindings, SVG rendering and exports.
• Scene3D documents, scene instances and an optional browser viewer.
• React controlsControlled parameter inputs and an extensible registry.

Connected projects

• The web SDKManifest, bindings, adapters, and the batch your agent answers.
• The workspaceSelecting, commenting, drawing, reviewing, and what a failure says.
• How the loop closesThe same round trip, told once with pictures.