# @character-foundry/character-foundry 中文文档

规范地址：https://npmcn.com/package/%40character-foundry/character-foundry/

版本：0\.6\.0
npm 元数据更新时间：2026-10-09T23:54:04.541Z
中文译文更新时间：2026-11-09T10:40:39.125Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40character-foundry/character-foundry
原文对照：https://npmcn.com/package/%40character-foundry/character-foundry/?lang=original
项目主页：https://github.com/character-foundry/character-foundry#readme
源码仓库：https://github.com/character-foundry/character-foundry

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.6 MB，104 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，react-hook-form ^7\.0\.0，@hookform/resolvers ^3\.0\.0
- 首次发布：2025-12-14T23:33:41.108Z
- 最新版本发布：2026-10-09T23:54:04.242Z
- 近 30 天下载量：3042（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 40 个）

## 中文简介

AI 字符卡格式通用类型Script库

## 安装

```sh
npm install @character-foundry/character-foundry
```

也可以使用：`pnpm add @character-foundry/character-foundry`、`yarn add @character-foundry/character-foundry`、`bun add @character-foundry/character-foundry`

## README

# @ charrater- foundry/ charrater- foundry

[![npm version](https://img.shields.io/npm/v/@character-foundry/character-foundry.svg)](https://www.npmjs.com/package/@character-foundry/character-foundry) [![npm downloads](https://img.shields.io/npm/dm/@character-foundry/character-foundry.svg)](https://www.npmjs.com/package/@character-foundry/character-foundry)

通用TypeScript库用于读取,写作,并转换AI字符卡格式.

## 安装

```bash
# Stable release
npm install @character-foundry/character-foundry

# Development release (latest features, may be unstable)
npm install @character-foundry/character-foundry@dev
```

## 快速启动

```typescript
import { parseCard } from '@character-foundry/character-foundry/loader';
import { exportCard } from '@character-foundry/character-foundry/exporter';

// Load any format (PNG, CharX, Voxta, JSON)
const { card, assets, format } = parseCard(buffer);
console.log(card.data.name);

// Export to different format
const pngBuffer = exportCard(card, assets, { format: 'png' });
```

## 支持的格式

| 格式 | 读取 | 写入 |
| --- | --- | --- |
| PNG (泰文卡 v2/v3) (英语) | ✅ | ✅ |
| CharX (里苏语) | ✅ | ✅ |
| Voxta (.voxpkg) (英语) | ✅ | ✅ |
| 原始 JSON 语录 | ✅ | ✅ |
| 独立目录 | ✅ | ✅ |

## 子路径导入

所有功能都可以通过子路径导出:

```typescript
// Core functionality
import { parseCard } from '@character-foundry/character-foundry/loader';
import { exportCard, checkExportLoss } from '@character-foundry/character-foundry/exporter';

// Schemas and validation
import { CCv3DataSchema, isV3Card, parseV3Card } from '@character-foundry/character-foundry/schemas';

// Format-specific
import { readVoxta, mergeCharacterEdits } from '@character-foundry/character-foundry/voxta';
import { readCharX, writeCharX } from '@character-foundry/character-foundry/charx';
import { readPng, writePng } from '@character-foundry/character-foundry/png';

// Utilities
import { countTokens } from '@character-foundry/character-foundry/tokenizers';
import { ccv2ToCCv3, ccv3ToCCv2Wrapped } from '@character-foundry/character-foundry/normalizer';
import { parseLorebook, serializeLorebook } from '@character-foundry/character-foundry/lorebook';
```

## 可用的子路径

| 子路径 | 说明 |
| --- | --- |
| `/loader` | 带有格式检测的通用剖面卡( ) |
| `/exporter` | 通用导出卡( ) 并检测损失 |
| `/schemas` | CCv2, CCv3, Voxta 类型 + Zod 验证 |
| `/core` | 二等公用事业、ZIP、基地64、安保 |
| `/png` | PNG 块处理、元数据嵌入 |
| `/charx` | CharX 格式, JPEG+ZIP 混合 |
| `/voxta` | 多特征软件包,情景 |
| `/lorebook` | Lorebook 解析和转换 |
| `/normalizer` | V2 → V3 转换 |
| `/tokenizers` | GPT-4/LLAMA 符号计数 |
| `/media` | 图像格式检测, 缩略图 |
| `/image-utils` | 图像 URL 提取、 SSRF 保护 |
| `/federation` | 活动Pub联合会(实验) |
| `/app-framework` | 使用自动格式的 Schema 驱动 UI |

## 运行时间验证

```typescript
import { CCv3DataSchema, isV3Card, safeParse } from '@character-foundry/character-foundry/schemas';

// Type guard
if (isV3Card(data)) {
  console.log(data.data.name);
}

// Safe parse with error details
const result = safeParse(CCv3DataSchema, data);
if (!result.success) {
  console.error(`${result.error} at ${result.field}`);
}
```

## CLI 工具

对于命令行的使用,安装 CLI 包 :

```bash
npm install -g @character-foundry/cli
cf detect card.png
cf info card.png
cf export card.png --to charx
```

## 文档

-   [GitHub 仓库](https://github.com/character-foundry/character-foundry)
-   [更改日志](https://github.com/character-foundry/character-foundry/blob/master/CHANGELOG.md)

## 许可证

麻省理工学院

## 常见问题

### @character-foundry/character-foundry 是什么？

AI 字符卡格式通用类型Script库

### 如何安装 @character-foundry/character-foundry？

在项目目录运行 npm install @character-foundry/character-foundry，或使用 pnpm add / yarn add / bun add。

### @character-foundry/character-foundry 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @character-foundry/character-foundry 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @character-foundry/character-foundry 可以商用吗？

@character-foundry/character-foundry 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @character-foundry/character-foundry 的下载量有多少？

根据 npm 官方下载统计，@character-foundry/character-foundry 在 2026/10/10 – 2026/11/08 这 30 天内被下载 3,042 次，日均约 101 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @character-foundry/character-foundry 还在维护吗？

最新版本 0\.6\.0 发布于 2026/10/10（30 天前）；至今共发布 40 个版本，其中过去 12 个月发布了 40 个；首次发布于 2025/12/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。