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/core @scenography/engine @scenography/react three

Engine only (no framework)​

pnpm add @scenography/core @scenography/engine three

Optional packages​

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

# DOM overlay / HUD. daisyUI + Tailwind are optional peers, only needed for
# the prefab widgets — custom components need neither.
pnpm add @scenography/overlay

Requirements​

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

Next: the Quick start.