@character-foundry/charx

CharX format reader/writer with JPEG+ZIP hybrid support for AI character cards.

Installation

npm install @character-foundry/charx

Features

• Read CharX - Extract card.json and assets from ZIP
• Write CharX - Create CharX archives
• JPEG+ZIP hybrids - Support for Risu's hybrid format
• Multi-asset support - Icons, backgrounds, expressions

Quick Start

import { readCharx, writeCharx, isCharxHybrid } from '@character-foundry/charx';

// Read CharX file
const { card, assets, spec } = readCharx(buffer);
console.log(card.data.name);

// Write CharX file
const charxBuffer = writeCharx(card, assets, {
  spec: 'v3',
  compressionLevel: 6,
});

// Check for JPEG+ZIP hybrid
if (isCharxHybrid(buffer)) {
  // Handle hybrid format
}

Documentation

See docs/charx.md for full API documentation.

License

MIT