cute-cube

Framework-agnostic sprite character with named animation states, built on PixiJS. Optional Vue 3 and React bindings are published as subpath exports.

Preview

Install

Install cute-cube and its required peer dependency pixi.js. Add Vue or React only if you use those bindings.

npm

npm install cute-cube pixi.js

Optional peers:

npm install cute-cube pixi.js vue
# or
npm install cute-cube pixi.js react react-dom

Yarn (Classic / Berry)

yarn add cute-cube pixi.js

Optional peers:

yarn add cute-cube pixi.js vue
# or
yarn add cute-cube pixi.js react react-dom

pnpm

pnpm add cute-cube pixi.js

Optional peers:

pnpm add cute-cube pixi.js vue
# or
pnpm add cute-cube pixi.js react react-dom

Bun

bun add cute-cube pixi.js

Optional peers:

bun add cute-cube pixi.js vue
# or
bun add cute-cube pixi.js react react-dom

Usage

Core API:

import { CharacterPlayer, createDefaultManifest } from "cute-cube";

Vue (CharacterView component):

import { CharacterView } from "cute-cube/vue";

React (CharacterView component):

import { CharacterView } from "cute-cube/react";

See src/index.ts and the demo/ app for concrete examples.