Skip to main content

Installation

scenography is published to npm under the @scenography scope. three is a peer dependency of the engine, so you install it yourself and control its version.

pnpm add @scenography/scene @scenography/engine @scenography/react three

Engine only (no framework)​

pnpm add @scenography/scene @scenography/engine three

Element plugins​

The kernel ships no scene elements — each one is its own plugin package, so you only install what your gallery uses. Add the elements you need:

pnpm add @scenography/plugin-wall @scenography/plugin-artwork \
         @scenography/plugin-floor @scenography/plugin-fpc

Other elements follow the same pattern: @scenography/plugin-{water,sky,audio,light,model,video} and the system plugins @scenography/plugin-{focus,cardboard}. Register each plugin's data half in defineScene and its runtime half in the gallery — see the Quick start.

Optional packages​

# Set-dressing props (cube, …)
pnpm add @scenography/props

# DOM overlay / HUD, plus the ready-made widgets and defaultPreset.
# daisyUI + Tailwind are optional peers, only needed for the styled widgets —
# custom components need neither.
pnpm add @scenography/overlay @scenography/overlay-presets

Requirements​

  • A bundler that understands ESM (Vite, etc.).
  • three >= 0.160.
  • React >= 18 if you use @scenography/react.

Next: the Quick start.