Installation

string-tune-3d is not a standalone runtime. It sits on top of StringTune and needs a rendering backend.

Required packages

npm i @fiddle-digital/string-tune string-tune-3d three

What each package does

• @fiddle-digital/string-tune provides the module system, DOM scanning, frame loop, and object lifecycle.
• string-tune-3d provides the 3D module, scene runtime, synchronizers, registries, and provider contract.
• three is the default renderer backend used by ThreeJSProvider.

Version rule

string-tune-3d declares @fiddle-digital/string-tune as a peer dependency. Keep those packages aligned so the module base classes and runtime hooks match.

Minimum setup shape

import StringTune from '@fiddle-digital/string-tune';
import { String3D, ThreeJSProvider } from 'string-tune-3d';
import * as THREE from 'three';

String3D.setProvider(new ThreeJSProvider(THREE));

const stringTune = StringTune.getInstance();
stringTune.use(String3D);
stringTune.start(60);

Browser expectations

• You need a browser environment with WebGL support.
• CSS custom properties are part of the normal authoring flow.
• Typed CSS property registration is optional. The module guards that feature and still runs when it is unavailable.