Installation

Install Packages

# Core library
pnpm add @elucim/core react react-dom

# DSL package (optional — for JSON-based authoring)
# @elucim/core is a peer dependency, install it alongside
pnpm add @elucim/dsl @elucim/core react react-dom

# Editor (optional — visual canvas editor)
# Requires both @elucim/core and @elucim/dsl as peer dependencies
pnpm add @elucim/editor @elucim/core @elucim/dsl react react-dom

KaTeX (for LaTeX rendering)

If you plan to use the <LaTeX> component or the DSL latex node type, serve the KaTeX CSS with your app and add it to your HTML:

<link rel="stylesheet" href="/vendor/katex/katex.min.css" />

The Elucim docs and demo vendor this file locally to avoid CDN/runtime privacy warnings. In your own app, copy katex/dist/katex.min.css and the adjacent fonts/ folder into your public assets.

TypeScript

Elucim is written in TypeScript and ships full type definitions. No extra @types/ packages needed.

Monorepo / Workspace Setup

If you’re working in a monorepo with pnpm workspaces:

pnpm-workspace.yaml

packages:
  - packages/*

packages/my-app/package.json

{
  "dependencies": {
    "@elucim/core": "workspace:*",
    "@elucim/dsl": "workspace:*"
  }
}

Next Steps

Head to the Quick Start to build your first animated scene.