@twick/visualizer

A visualization library built on top of @twick/2d for creating interactive visualizations and animations.

Overview

This package provides advanced visualization capabilities for creating interactive animations, effects, and visual elements in video editing applications. Built on top of a 2D graphics engine, it offers powerful tools for creating professional visual content.

Installation

``bash
npm install @twick/visualizer


or


pnpm add @twick/visualizer
`

Note: All required dependencies (@twick/media-utils) are automatically installed with @twick/visualizer.

Quick Start

`typescript
import {
createVisualization,
addAnimation,
renderScene
} from '@twick/visualizer';

// Create a new visualization
const viz = createVisualization({
width: 1920,
height: 1080,
duration: 10
});

// Add animations and effects
addAnimation(viz, {
type: 'fade',
startTime: 0,
duration: 2
});

// Render the scene
const output = await renderScene(viz);
`

Key Features

- Interactive Visualizations: Create dynamic visual content
- Animation Engine: Powerful animation system with keyframes
- Effect Library: Built-in effects and transitions
- Performance Optimized: Efficient rendering for real-time applications
- Extensible: Plugin system for custom effects
- 2D Graphics: Full 2D graphics capabilities

Development

$3

`bash
pnpm install
`

$3

`bash
pnpm build
`

$3

`bash
pnpm dev
`

API Reference

$3

- createVisualization: Create a new visualization instance
- addAnimation: Add animations to the scene
- renderScene: Render the visualization to output
- addEffect: Apply visual effects
- exportAnimation: Export animations in various formats

$3

- VisualizationConfig: Configuration for visualizations
- AnimationOptions: Animation configuration options
- EffectConfig: Effect configuration interface
- RenderOptions`: Rendering options

For complete API documentation, refer to the generated documentation.

Browser Support

This package requires a browser environment with support for:
- WebGL or Canvas 2D
- Modern JavaScript features (ES2020+)
- RequestAnimationFrame API

Documentation

For complete documentation, refer to the project documentation site.

License

This package is licensed under the Sustainable Use License (SUL) Version 1.0.

- Free for use in commercial and non-commercial apps
- Can be modified and self-hosted
- Cannot be sold, rebranded, or distributed as a standalone SDK

For commercial licensing inquiries, contact: contact@kifferai.com

For full license terms, see the main LICENSE.md file in the project root.