cards
@motioneffector/cards
A TypeScript library for parsing and writing Character Card V3 and Lorebook data.
Features
- Multi-format Support - PNG, JSON, and CHARX container formats
- Version Compatibility - Read V1/V2/V3 cards, write V3 format
- Decorator Parsing - Parse and serialize V3 lorebook decorators
- Lorebook Handling - Embedded and standalone lorebook support
- Repair & Recovery - Best-effort recovery of malformed cards
- Validation - Permissive and strict validation modes
- Zero Dependencies - No external libraries, no supply chain risk
Quick Start
import { readCard, writeCardToPng } from '@motioneffector/cards'
// Read from any format (PNG, JSON, or CHARX)
const card = readCard(fileBytes)
// Access card data
console.log(card.data.name)
console.log(card.data.description)
// Write to PNG format
const pngBytes = writeCardToPng(card, imagePngBytes)
// Parse lorebook decorators
import { parseDecorators } from '@motioneffector/cards'
const { decorators, content } = parseDecorators(entry.content)
Testing & Validation
- Comprehensive test suite - 312 unit tests covering core functionality
- Fuzz tested - Randomized input testing to catch edge cases
- Strict TypeScript - Full type coverage with no
anytypes - Zero dependencies - No supply chain risk
License
MIT © motioneffector