StringTune/Docs

Start Here

Installation

Install the package and understand the minimal setup sequence.

Installation

Install the package

Bash
npm install @fiddle-digital/string-tune

Minimal setup

TypeScript
import StringTune, { StringProgress } from '@fiddle-digital/string-tune';

const stringTune = StringTune.getInstance();

stringTune.use(StringProgress);
stringTune.start(60);

What start() does

start() initializes the registered runtime, prepares the current DOM objects, and starts the frame loop.

If you call use(...), register modules before start() unless you have a specific reason to hot-attach behavior later.

  • Create one shared instance through StringTune.getInstance().
  • Register only the modules you actually need.
  • Keep setup in a client-only lifecycle boundary when working in SSR frameworks.
  • Treat module registration as part of app bootstrap, not page-local ad hoc code.

Next steps