History

smontlouis 2ba720e059 chore(release): prepare runtime packages 0.1.0		2026-08-17 18:15:45 +02:00
..
src	feat(runtime): unify React and ESM avatar exports	2026-08-17 17:27:20 +02:00
LICENSE	chore(release): prepare runtime packages 0.1.0	2026-08-17 18:15:45 +02:00
package.json	chore(release): prepare runtime packages 0.1.0	2026-08-17 18:15:45 +02:00
README.md	chore(release): prepare runtime packages 0.1.0	2026-08-17 18:15:45 +02:00
tsconfig.build.json	feat(runtime): unify React and ESM avatar exports	2026-08-17 17:27:20 +02:00
tsconfig.json	feat(runtime): unify React and ESM avatar exports	2026-08-17 17:27:20 +02:00
vite.config.ts	feat(runtime): unify React and ESM avatar exports	2026-08-17 17:27:20 +02:00

README.md

@bible-strong/avatar-web

DOM renderer for Bible Strong procedural avatars. It uses @bible-strong/avatar-core for schema validation, playback and rendering, without requiring React.

pnpm add @bible-strong/avatar-web

import { createAvatar } from '@bible-strong/avatar-web'
import definition from './cloudee.avatar.json'

const avatar = createAvatar('#avatar', {
  definition,
  defaultAnimation: 'idle',
})

avatar.play('happy')
avatar.pause()
avatar.stop()

For a browser project without a bundler, load an ESM build through an import map or CDN and fetch the definition JSON before calling createAvatar.

The package follows Semantic Versioning. While it remains below 1.0.0, breaking API changes increment the minor version and fixes increment the patch version.