@character-foundry/loader
v0.1.10
Published
Universal character card loader - detects format and parses any card type
Downloads
641
Maintainers
Readme
@character-foundry/loader
Universal character card loader with automatic format detection.
Installation
npm install @character-foundry/loaderFeatures
- Auto-detection - PNG, CharX, Voxta, JSON formats
- Normalization - Always returns CCv3 format
- Asset extraction - Images, audio, and other assets
- Lorebook parsing - Standalone lorebook support
Quick Start
import { parseCard, parseLorebook, parse } from '@character-foundry/loader';
// Load any character card format
const result = parseCard(buffer);
// result.card: CCv3Data (always normalized to v3)
// result.assets: ExtractedAsset[]
// result.containerFormat: 'png' | 'charx' | 'voxta' | 'json'
// result.spec: 'chara_card_v2' | 'chara_card_v3'
console.log(result.card.data.name);
// Parse standalone lorebook
const { book, originalFormat } = parseLorebook(jsonBuffer);
// Universal parse (cards or lorebooks)
const parsed = parse(buffer);
if (parsed.type === 'card') {
console.log(parsed.card.data.name);
} else {
console.log(parsed.book.name);
}Documentation
See docs/loader.md for full API documentation.
License
MIT
