# @genart-dev/format 中文文档

规范地址：https://npmcn.com/package/%40genart-dev/format/

版本：0\.7\.0
npm 元数据更新时间：2026-03-18T23:00:39.915Z
中文译文更新时间：2026-11-16T03:01:55.889Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：346 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-02-22T23:04:39.430Z
- 最新版本发布：2026-03-18T23:00:39.765Z
- 近 30 天下载量：2129（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

.genart 格式的文件格式类型、解析器和画布预设

## 安装

```sh
npm install @genart-dev/format
```

也可以使用：`pnpm add @genart-dev/format`、`yarn add @genart-dev/format`、`bun add @genart-dev/format`

## README

# @ genart-dev/format (帮助)

文件格式类型、解析器和画布预设 `.genart` 财务报告和审定财务报表 `.genart-workspace` 格式.

部分 [格纳特.德夫](https://genart.dev/) ——有MCP服务器的基因艺术平台,桌面应用,以及IDE扩展.

## 安装

```bash
npm install @genart-dev/format
```

零从属.

## 使用量

```typescript
import {
  parseGenart,
  serializeGenart,
  parseWorkspace,
  serializeWorkspace,
  CANVAS_PRESETS,
  resolvePreset,
  convertLegacySketch,
} from "@genart-dev/format";

// Parse and validate a .genart file
const sketch = parseGenart(JSON.parse(fileContents));

// Serialize back to formatted JSON
const json = serializeGenart(sketch);

// Parse a .genart-workspace file
const workspace = parseWorkspace(JSON.parse(workspaceContents));

// Resolve a canvas preset to dimensions
const { width, height } = resolvePreset("square-1200"); // → 1200×1200

// Convert a legacy .js sketch file to .genart
const converted = convertLegacySketch(legacyJsSource);
```

## 这个 `.genart` 格式

每个 `.genart` file 是单个JSON文档——一个自成一体,可共享的草图:

```json
{
  "genart": "1.1",
  "id": "orchestrated-opposition",
  "title": "Orchestrated Opposition",
  "created": "2025-01-15T10:30:00Z",
  "modified": "2025-01-15T12:00:00Z",
  "renderer": { "type": "p5", "version": "1.x" },
  "canvas": { "preset": "square-1200", "width": 1200, "height": 1200 },
  "parameters": [
    { "key": "margin", "label": "Margin", "min": 30, "max": 120, "step": 5, "default": 60 }
  ],
  "colors": [
    { "key": "color1", "label": "Primary", "default": "#1a1a1a" }
  ],
  "state": {
    "seed": 12345,
    "params": { "margin": 60 },
    "colorPalette": ["#1a1a1a"]
  },
  "algorithm": "function sketch(p, state) { ... }"
}
```

**所需字段**数字 : `genart`, (中文(简体) ), `id`, (中文(简体) ), `title`, (中文(简体) ), `created`, (中文(简体) ), `modified`, (中文(简体) ), `renderer`, (中文(简体) ), `canvas`, (中文(简体) ), `parameters`, (中文(简体) ), `colors`, (中文(简体) ), `state`, (中文(简体) ), `algorithm`

**可选字段**数字 : `subtitle`, (中文(简体) ), `agent`, (中文(简体) ), `model`, (中文(简体) ), `skills`, (中文(简体) ), `philosophy`, (中文(简体) ), `tabs`, (中文(简体) ), `themes`, (中文(简体) ), `snapshots`

### 渲染器

这个 `renderer.type` 字段指定哪个引擎执行算法 :

| 类型 | 算法语言 | 运行时间 |
| --- | --- | --- |
| `p5` | JavaScript (p5 | 页:1 |
| `three` | JavaScript (Tree.js 场景构建器) | 3个J |
| `glsl` | GLSL (碎片阴影) | 网络GL2 |
| `canvas2d` | Java 脚本( Canvas 2D API) | 土著 |
| `svg` | Java脚本( SVG 生成器) | 土著 |

V1.0 文件中没有 `renderer` 字段,解析器默认为 `{ "type": "p5" }`。 。 。 .

## 这个 `.genart-workspace` 格式

多幅素描在无限的画布上共存. A 类 `.genart-workspace` 文件是空间布局表 :

```json
{
  "genart-workspace": "1.0",
  "id": "typography-explorations",
  "title": "Typography Explorations",
  "created": "2025-01-15T10:30:00Z",
  "modified": "2025-01-15T12:00:00Z",
  "viewport": { "x": 0, "y": 0, "zoom": 0.5 },
  "sketches": [
    { "file": "orchestrated-opposition.genart", "position": { "x": 0, "y": 0 } },
    { "file": "cadenced-fields.genart", "position": { "x": 1400, "y": 0 } }
  ]
}
```

个人 `.genart` 文件仍然是可移植的、可共享的单位。 工作空间为轻量级空间元数据——文件引用和画布位置.

## 相机预设

18个内置预设5个类别:

| 类别 | 预设 |
| --- | --- |
| 平方边 | 600, 1200, 2400, 4096 (英语) |
| 风景 | HD 1920×1080, 2K, 超宽 21: 9, 4K UHD |
| 外观 | 电话:390x844,平板768x1024,海报:2400x3600 |
| 打印 (300 DPI) | A4, A3, 美国字母 |
| 社会 | Instagram 10802, Twitter/X 1200x675, 开源图 1200x630 |

## API 参考

### 类型

| 类型 | 说明 |
| --- | --- |
| `SketchDefinition` | 完成 `.genart` 文件结构 |
| `WorkspaceDefinition` | 完成 `.genart-workspace` 文件结构 |
| `RendererType` | `"p5" | "three" | "glsl" | "canvas2d" | "svg"` |
| `RendererSpec` | 渲染器引擎 + 可选版本限制 |
| `CanvasSpec` | 宽度、高度、像素密度、可选预设 |
| `CanvasPreset` | 命名预设( id, 标签, 类别, 宽度, 高度) |
| `ParamDef` | 数字参数定义( 键、 标签、 分、 最大、 步骤、 默认) |
| `ColorDef` | 颜色槽定义( 键、 标签、 默认十六进制) |
| `ThemeDef` | 已命名的调色板( 名称 + 颜色阵列) |
| `TabDef` | 参数分组标签( id, 标签) |
| `SketchState` | 运行时状态(种子、参数、颜色Palette) |
| `Snapshot` | 使用可选缩略图保存的状态快照 |
| `WorkspaceSketchRef` | 用画布位置绘制引用 |
| `WorkspaceGroup` | 已命名的草图组 |

### 职能

| 函数 | 说明 |
| --- | --- |
| `parseGenart(json)` | 解析并验证 a `.genart` JSON 对象 |
| `serializeGenart(sketch)` | 序列化 a `SketchDefinition` 用于格式化的 JSON |
| `parseWorkspace(json)` | 解析并验证 a `.genart-workspace` JSON 对象 |
| `serializeWorkspace(workspace)` | 序列化 a `WorkspaceDefinition` 用于格式化的 JSON |
| `convertLegacySketch(source)` | 转换遗产 `.js` 草图文件到 `SketchDefinition` |
| `extractLegacyInfo(source)` | 在不完全转换的情况下从遗留草图中提取元数据 |
| `resolvePreset(preset)` | 抬头看 `{ width, height }` 用于预设的ID |
| `CANVAS_PRESETS` | 所有18个内置画布预设的阵列 |

## 规格

这个 `specs/` 目录中包含有效和无效的具体实例 `.genart` 财务报告和审定财务报表 `.genart-workspace` 文档。 见 [规格/README.md](https://npmcn.com/package/%40genart-dev/format/specs/README.md) 全部名单.

## 相关软件包

| 软件包 | 目的 |
| --- | --- |
| [`@genart-dev/core`](https://github.com/genart-dev/core) | 适配器+技能登记册(取决于格式) |
| [`@genart-dev/mcp-server`](https://github.com/genart-dev/mcp-server) | 33个工具 MCP 服务器 + CLI(依赖核心) |

## 支助

问题、错误或反馈—— [支持@ genart.dev](mailto:support@genart.dev) 或者说 [打开一个问题](https://github.com/genart-dev/format/issues)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @genart-dev/format 是什么？

\.genart 格式的文件格式类型、解析器和画布预设

### 如何安装 @genart-dev/format？

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

### @genart-dev/format 支持 TypeScript 吗？

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

### @genart-dev/format 支持 ESM 还是 CommonJS？

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

### @genart-dev/format 可以商用吗？

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

### @genart-dev/format 的下载量有多少？

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

### @genart-dev/format 还在维护吗？

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

