create-hypercolor

Scaffolder for Hypercolor effect workspaces.

One command gives you a ready-to-run Bun workspace with hypercolor wired up, a starter effect, and the full authoring loop for build, validate, and install.

Quick start

bun create hypercolor my-effects --template canvas

The scaffolder prompts you for any omitted template or first-effect option. For audio-reactive starter boilerplate:

bun create hypercolor my-effects --template canvas --first aurora --audio

Then:

cd my-effects
bun run build

To develop against a local Hypercolor engine checkout instead of the published SDK, point the workspace's hypercolor dependency at it:

bun create hypercolor my-effects --template canvas \
    --sdk-spec "file:../hypercolor/sdk/packages/core"

Templates

| Template | What you get | | -------- | ----------------------------------------------- | | canvas | TypeScript effect with a Canvas2D draw function | | shader | TypeScript effect with a GLSL fragment shader | | face | A device-face layout for sensor dashboards | | html | A raw LightScript HTML effect, no TypeScript |

Options

create-hypercolor-effect [name] [options]

  --template <type>       Starter template: canvas, shader, face, html
  --first <effect-name>   Name of the first effect (default: my-effect)
  --audio                 Include audio-reactive starter boilerplate
  --no-git                Skip git init
  --no-install            Skip bun install
  --sdk-spec <spec>       Override the workspace's hypercolor dependency spec.
                          Defaults to the published caret range (^<version>).
                          Use file:../hypercolor/sdk/packages/core to develop
                          against a local engine checkout.
                          (HYPERCOLOR_SDK_PACKAGE_SPEC env var also works).

Adding more effects

Once a workspace exists, scaffold additional effects with the workspace CLI:

bunx hypercolor add ember --template canvas
bunx hypercolor add skyline --template shader --audio
bunx hypercolor add flicker --template html

Prerequisites

• Bun 1.2 or newer

Documentation

See Setup and Dev Workflow for the full guide.

License

Apache-2.0