openpencil/packages/docs/it/reference/file-format.md
Danila Poyarkov 16033c4c56 Revert mermaid plugin (crashes VitePress dev), use tables instead
vitepress-plugin-mermaid patches vitepress's client app entry,
which breaks ESM module resolution and renders all pages blank.
Replace mermaid diagrams with offset/content tables and pipeline
code blocks that render correctly.
2026-03-08 14:33:56 +03:00

2.8 KiB

File Format

.fig File Structure

A .fig file is a ZIP archive containing a Kiwi-encoded binary message:

Offset Content
0 Magic header fig-kiwi (8 bytes)
8 Version (4 bytes, uint32 LE)
12 Schema length (4 bytes, uint32 LE)
16 Compressed Kiwi schema
Message length (4 bytes, uint32 LE)
Compressed Kiwi message — NodeChange[] (entire document)
Blob data — images, vector networks, fonts

Import Pipeline

.fig file → parse header → decompress Zstd → decode Kiwi schema
  → decode message → NodeChange[] → build SceneGraph
  → resolve blob refs → render on canvas

Export Pipeline

SceneGraph → NodeChange[] → Kiwi encode → compress (Zstd/deflate)
  → build ZIP (header + schema + message + thumbnail.png)
  → write .fig file

Export uses S (Save) and S (Save As) with native OS dialogs on the desktop app. The exported file includes a thumbnail.png required by Figma for file preview.

Compression uses Zstd via Tauri Rust command on desktop, with deflate fallback in the browser.

Kiwi Binary Codec

The codec handles Figma's 194-definition Kiwi schema with NodeChange as the central type (~390 fields). Key components:

Module Purpose
kiwi-schema Kiwi parser (from evanw/kiwi), patched for ESM and sparse field IDs
codec.ts Encode/decode messages using the Kiwi schema
protocol.ts Wire format parsing and message type detection
schema.ts 194 message/enum/struct definitions

Sparse Field IDs

Figma's schema uses non-contiguous field IDs (e.g. 1, 2, 5, 10 with gaps). The kiwi-schema parser handles this correctly.

Compression

.fig files use Zstd compression for both the schema and message payloads. Decompression uses the fzstd library. For export, Zstd compression is offloaded to a Tauri Rust command on the desktop app (better performance, correct frame headers). In the browser, deflate via fflate is used as a fallback.

Supported Formats

Format Import Export
.fig (Figma)
.svg Planned Planned
.png Planned Planned
.pdf Planned

Clipboard Format

Copy/paste uses the same Kiwi binary encoding:

  1. Copy — encode selected NodeChange[] to Kiwi binary, compress, write to clipboard as application/x-figma-design MIME type
  2. Paste — read clipboard, decompress, decode Kiwi binary, create nodes in scene graph

Encoding happens synchronously in the copy event handler (not async Clipboard API) for browser compatibility. This enables bidirectional clipboard between OpenPencil and Figma.