openpencil/README.zh-TW.md
Kayshen Xu ca1b5370ae
V0.3.0 (#24)
* feat(boolean-operations): implement boolean operations in the editor

- Added a new BooleanToolbar component for union, subtract, and intersect operations.
- Integrated boolean operations into the layer context menu and keyboard shortcuts.
- Enhanced the editor layout to include the boolean toolbar for improved user interaction.
- Updated internationalization support with new translation keys for boolean operations.
- Bumped version to 0.3.0 to reflect the addition of these features.

* refactor(editor): update editor layout and panels for improved functionality

- Replaced the PropertyPanel with a new RightPanel that includes both Property and Code panels.
- Removed the CodePanel from the main editor layout and integrated it into the RightPanel.
- Updated keyboard shortcuts to switch the right panel to the code tab.
- Enhanced the LayerPanel with a resizable width feature for better user experience.
- Added internationalization support for new right panel labels and code panel features.
- Introduced new code generation capabilities for various frameworks in the CodePanel.
- Improved overall layout structure for better responsiveness and usability.

* feat(electron): implement .op file association and enhance file handling

- Added support for .op file association in electron-builder, allowing OpenPencil documents to be opened directly from the file system.
- Implemented IPC handlers for opening and reading .op files, ensuring proper loading of document content.
- Enhanced the main process to handle file opening events on macOS and single-instance locking on Windows/Linux.
- Updated the renderer to listen for file open events and load documents accordingly.
- Improved README to reflect new file association feature.

* fix(canvas): improve layout accuracy for AI-generated designs

- Unify lineHeight default via canonical defaultLineHeight() function
- Unify text measurement by removing duplicate estimators in generation-utils
- Fix optical centering formula to scale proportionally with fontSize
- Round layout positions to whole pixels to prevent sub-pixel artifacts
- Recursively sanitize nested x/y in streaming layout containers
- Fix input trailing icon alignment using fill_container instead of space_between

* feat(canvas): right-align agent badge and add breathing glow border

- Agent badge now right-aligned to frame's right edge instead of after label
- Added breathing glow border around agent-owned frames during generation
- Glow border uses same color and lifecycle as the agent badge
- Removed unused BADGE_GAP constant and useDocumentStore import

* feat(code-panel): enhance tab scrolling functionality and add scrollbar utility

- Introduced left and right scroll buttons for tab navigation in the CodePanel, improving user experience for navigating long tab lists.
- Added a custom utility to hide scrollbars for a cleaner interface.
- Updated styles for better responsiveness and usability in the CodePanel layout.

* fix(docs): update Discord invite links in multiple README files

- Replaced outdated Discord invite links with the new link across all language-specific README files.
- Ensured consistency in the documentation for community engagement.

* feat(code-panel): enhance system prompt for responsive design

- Updated the ENHANCE_SYSTEM_PROMPT to emphasize the importance of responsive design in code rewriting.
- Added detailed guidelines for converting fixed pixel widths to relative units and using responsive Tailwind breakpoints.
- Ensured that the output remains visually faithful on desktop while adapting gracefully across screen sizes.

* feat(docs): add WeChat group information to README.zh.md and include group image

- Introduced a new section in the Chinese README to provide details about the WeChat group for community engagement.
- Added an image representing the WeChat group for better visibility and user interaction.

* feat(electron): enhance theme management and title bar overlay for Windows/Linux

- Updated the `setTheme` method in the Electron API to accept custom colors for the title bar overlay, improving theme synchronization across platforms.
- Adjusted title bar overlay colors for Windows and Linux to ensure proper visibility and aesthetics.
- Enhanced the top bar component to read computed CSS colors and apply them dynamically, ensuring a consistent user interface.
- Improved handling of theme changes in the application to support background and foreground color customization.

* fix(screenshot): update screenshot image for improved clarity and quality

* fix(docs): update WeChat group image path in README.zh.md for consistency

* fix(ai): fix post-generation validation pipeline and text centering

- Fix Agent SDK validation: save temp screenshots inside project dir
  (.openpencil-tmp/) so Claude Code plan mode can read them, instead
  of /tmp/ which is outside the project sandbox
- Enrich validation tree dump with fill colors, stroke, fontSize,
  fontWeight, textAlign, cornerRadius, opacity for comprehensive
  visual analysis
- Add multi-round validation with quality scoring (threshold 8/10),
  500ms stabilization delay between rounds
- Add detailed debug logging to applyValidationFixes showing which
  nodes were found/skipped and property changes
- Fix canvas sync needsTextbox check to also account for textAlign
  (matching isFixedWidthText in factory), preventing IText↔Textbox
  thrashing on every sync tick
- Auto-center text in vertical+center layouts by expanding to full
  container width and injecting textAlign:'center'
- Force Textbox for non-left-aligned text so textAlign is respected
  (IText ignores width and computes its own)

* fix(canvas): use precise text width estimation for fit-content layout

Remove the 14% safety factor from text width estimation when computing
fit-content/natural-width text dimensions. IText auto-computes its own
width and ignores our setting, so the safety margin only inflated the
layout allocation, making text appear left-shifted within its container.

* fix(canvas): center fit-content text in horizontal layouts

For text nodes with fit-content width in horizontal layouts, set
textAlign:'center' to compensate for width estimation inaccuracy.
The estimated box is typically wider than the actual rendered text,
causing left-aligned text to appear visually shifted. Centering
distributes the estimation error evenly on both sides.

* feat(ai): show validation details in checklist panel

- Accumulate validation log (screenshot, analysis, fixes) instead of
  overwriting status messages, so the full process is visible
- Preserve step thinking content in buildFinalStepTags (was discarded)
- Add details field to pipeline items and render in checklist UI
- Each validation step now shows: screenshot captured, issues found,
  quality score, fixes applied

* feat(ai): add visual reference pipeline types and integration hooks

- Add DesignSystem and VisualReference types to ai-types
- Add 'visual-ref' mode to AIDesignRequest and SubTask.htmlReference
- Detect visual-ref candidates in chat handlers (landing pages, websites)
- Wire visual-ref mode in design-generator and orchestrator
- Inject HTML reference snippets into sub-agent prompts

* feat(ai): add modular design principles for sub-agent context

- Add design-principles module with topic files: color, typography,
  spacing, composition, components
- Selectively load relevant principles based on prompt content
- Inject design principles into sub-agent system prompts

* feat(ai): implement visual reference pipeline

- Add design-system-generator: generates color/typography/spacing tokens
- Add design-code-generator: generates HTML/CSS from design system
- Add html-renderer: renders HTML to screenshot via html2canvas
- Add visual-ref-orchestrator: coordinates the full pipeline
  (design system → HTML code → screenshot → enrich subtasks)
- Add html2canvas dependency for client-side HTML rendering

* feat(mcp): default filePath to live canvas and fix cross-platform issues

- Default all MCP tool filePath to live://canvas when omitted, so tools
  operate on the real-time canvas instead of stale files
- Remove filePath from required params in all tool schemas (21 interfaces)
- Fix mcp-server-manager.ts using process.cwd() which fails in Electron
  production on Linux — now checks ELECTRON_RESOURCES_PATH first
- Fix stopMcpHttpServer using SIGTERM on Windows — use taskkill instead
- Force new children reference in applyExternalDocument to ensure canvas
  sync subscriber always detects MCP-pushed document updates

* feat(mcp): enhance design prompt with semantic roles, CJK typography, and layout rules

Add comprehensive design knowledge to MCP design prompt for better
AI-generated designs: design type detection (mobile vs desktop), full
semantic role reference with context-aware defaults, CJK typography
rules, expanded text/layout/form guidelines, and detailed post-processing
documentation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* feat(ai): implement intent classification for chat handlers

- Replace hardcoded keyword matching with a lightweight LLM call to classify user intent in chat messages.
- Introduce a new function `classifyIntent` to determine if the request is for design generation or conversation.
- Update design request handling in `useChatHandlers` to utilize the new classification method.
- Enhance design prompt documentation to reflect changes in design type detection based on intent rather than keywords.

* fix(ai): handle string qualityScore in validation response parsing

The LLM sometimes returns qualityScore as a string (e.g. "8" instead of 8),
causing it to fall through to 0. Also hide misleading "quality: 0/10" display
when the score couldn't be determined, and log raw response for debugging.

* fix(ai): increase validation timeout to 90s and fix quality score parsing

Agent SDK validation requires spawning a process, reading the image, and
analyzing it — 30s was consistently timing out. Also handle string
qualityScore values from LLM responses and hide misleading 0/10 display.

* fix(ai): fix validation timeout and response parsing

- Increase validation timeout from 30s to 180s (Agent SDK needs time
  for subprocess spawn + OAuth auth + multi-turn image reading)
- Strip <tool_use> XML blocks from Agent SDK response before extracting
  JSON — the tool call XML was confusing the regex, causing qualityScore
  to parse as 0 despite valid JSON being present
- Handle string qualityScore values and hide misleading "quality: 0/10"
- Revert unnecessary direct API key approach for validation

* fix(ai): prevent node ID collisions between generations

When generating new content on a canvas with existing nodes, AI-generated
IDs (e.g. brand-spacer) would collide with previous generations. Now
captures pre-existing node IDs at generation start and checks against
them during upsert sanitization. Remapped IDs are tracked in
generationRemappedIds so progressive streaming updates can still find
their nodes.

* fix(ai): require styleGuide in orchestrator plan and fix validation detail icons

- Add fallback default styleGuide when orchestrator LLM omits it
- Strengthen prompt to mark styleGuide as REQUIRED
- Replace emoji icons in validation details with [done]/[pending]/[error]
  markers for consistent styling with the checklist design system

* feat(server): add port file plugin for server instance discovery

- Introduce a new Nitro plugin that writes a port file on server startup to allow the MCP server to discover the running instance, whether it's a development server or Electron.
- Implement error handling in the Electron main process for writing the port file, logging any failures.
- Update Vite configuration to include additional external dependencies in the rollup configuration.

* feat(electron): implement IPC for retrieving pending file paths

- Added a new IPC handler `file:getPending` to retrieve and clear the pending file path when the React app mounts.
- Updated the Electron API to include `getPendingFile` for renderer access.
- Enhanced the `useElectronMenu` hook to load any pending file on application startup.
- Updated UI components to reflect changes in file handling and improved user experience.

* fix(panels): replace emoji icons with styled icons in validation checklist

- Parse [done]/[pending]/[error] prefixes in detail lines and render as
  styled circle icons matching the parent checklist design system
- Replace remaining emoji markers in design-validation.ts with text prefixes
- Fix isApplied detection to recognize new [done] Applied marker

* refactor(electron): update settings path to use platform-standard app data directory

- Changed the settings file path to utilize Electron's user data directory for better cross-platform compatibility.
- Updated the settings writing function to ensure the user data directory is created if it doesn't exist.
- Added comments to clarify the storage location for different operating systems.
- Implemented a fixed partition for localStorage/cookies to maintain data across server port changes.

* feat(ai): enhance validation with pre-checks, structural fixes, and border detection

- Add design-pre-validation.ts: pure code checks before LLM validation
  - Invisible container detection (same fill as parent → auto-add border)
  - Sibling consistency (majority-rule for height/cornerRadius)
- Add structural fixes to validation: addChild/removeNode operations
  - Icon injection via lookupIconByName with server fallback
  - autoFixParentLayout with child count guard to prevent layout breakage
- Add strokeColor/strokeWidth to safe fix properties for border fixes
- Simplify intent classification: all design requests use visual-ref pipeline
- Fix checklist: "Found N issues" now shows [done] instead of [pending]
- Fix qualityScore: only update when > 0 to preserve valid round scores

* fix(ai): cherry-pick safe validation improvements, drop aggressive pre-checks

Keep: stroke tree dump bug fix (object not array), qualityScore=0 false
positive detection, fit_content→fixed safety guard, empty path removal,
type-specific sibling consistency, repeated fix filtering, screenshot
extraction to design-screenshot.ts.

Drop: detectForcedFixedHeight (destroyed input/button heights),
MAX_VALIDATION_ROUNDS 5 (too many rounds), removal of quality threshold
early stop, section regeneration phase.

---------

Co-authored-by: Fini <fini.yang@gmail.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-08 11:55:35 +08:00

7.8 KiB
Raw Blame History

OpenPencil

OpenPencil

AI 原生開源設計工具。設計即程式碼。
從提示詞到畫布 UI。多智能體編排。內建 MCP 伺服器。程式碼生成。

English · 简体中文 · 繁體中文 · 日本語 · 한국어 · Français · Español · Deutsch · Português · Русский · हिन्दी · Türkçe · ไทย · Tiếng Việt · Bahasa Indonesia

Stars License CI Discord

快速開始 · AI · 功能特色 · Discord · 參與貢獻

快速開始

# 安裝相依套件
bun install

# 在 http://localhost:3000 啟動開發伺服器
bun --bun run dev

或以桌面應用程式形式執行:

bun run electron:dev

前置條件: Bun >= 1.0 以及 Node.js >= 18

AI 原生設計

OpenPencil 從底層就圍繞 AI 構建——不是作為外掛程式,而是作為核心工作流程。

提示詞生成 UI

  • 文字轉設計 — 描述一個頁面,即時以串流動畫在畫布上生成
  • 編排器 — 將複雜頁面分解為空間子任務,支援並行生成
  • 設計修改 — 選取元素後,以自然語言描述變更
  • 視覺輸入 — 附加截圖或線框圖作為參考進行設計

多智能體支援

智能體 設定方式
Claude Code 無需設定 — 使用 Claude Agent SDK 本地 OAuth
Codex CLI 在 Agent 設定中連接(Cmd+,
OpenCode 在 Agent 設定中連接(Cmd+,

MCP 伺服器

  • 內建 MCP 伺服器 — 一鍵安裝至 Claude Code / Codex / Gemini / OpenCode / Kiro CLI
  • 從終端機進行設計自動化:透過任意 MCP 相容的智能體讀取、建立和修改 .op 檔案

程式碼生成

  • React + Tailwind CSS
  • HTML + CSS
  • 從設計令牌生成 CSS Variables

功能特色

畫布與繪圖

  • 無限畫布,支援平移、縮放、智慧對齊參考線和吸附
  • 矩形、橢圓、直線、多邊形、鋼筆貝茲曲線、Frame、文字
  • 布林運算 — 聯合、減去、交集,搭配上下文工具列
  • 圖示選擇器Iconify和圖片匯入PNG/JPEG/SVG/WebP/GIF
  • 自動版面配置 — 垂直/水平方向,支援間距、內邊距、主軸對齊、交叉軸對齊
  • 多頁面文件,支援分頁導覽

設計系統

  • 設計變數 — 顏色、數字、字串令牌,支援 $variable 參照
  • 多主題支援 — 多個主題軸,每個軸有多個變體(亮色/暗色、緊湊/舒適)
  • 元件系統 — 可重複使用元件,支援實體和覆寫
  • CSS 同步 — 自動生成自訂屬性,程式碼輸出中使用 var(--name)

Figma 匯入

  • 匯入 .fig 檔案,保留版面配置、填色、筆觸、效果、文字、圖片和向量圖形

桌面應用程式

  • 透過 Electron 支援原生 macOS、Windows 和 Linux
  • 從 GitHub Releases 自動更新
  • 原生應用程式選單和檔案對話框

技術堆疊

前端 React 19 · TanStack Start · Tailwind CSS v4 · shadcn/ui
畫布 Fabric.js v7
狀態管理 Zustand v5
伺服器 Nitro
桌面端 Electron 35
AI Anthropic SDK · Claude Agent SDK · OpenCode SDK
執行環境 Bun · Vite 7
檔案格式 .op — 基於 JSON人類可讀對 Git 友好

專案結構

src/
  canvas/          Fabric.js 引擎 — 繪圖、同步、版面配置、參考線、鋼筆工具
  components/      React UI — 編輯器、面板、共用對話框、圖示
  services/ai/     AI 聊天、編排器、設計生成、串流處理
  services/figma/  Figma .fig 二進位檔案匯入管線
  services/codegen React+Tailwind 和 HTML+CSS 程式碼生成器
  stores/          Zustand — 畫布、文件、頁面、歷程、AI、設定
  variables/       設計令牌解析與參照管理
  mcp/             供外部 CLI 整合使用的 MCP 伺服器工具
  uikit/           可重複使用元件套件系統
server/
  api/ai/          Nitro API — 串流聊天、生成、驗證
  utils/           Claude CLI、OpenCode、Codex 客戶端封裝
electron/
  main.ts          視窗、Nitro 子處理序、原生選單、自動更新
  preload.ts       IPC 橋接

鍵盤快捷鍵

按鍵 操作 按鍵 操作
V 選取 Cmd+S 儲存
R 矩形 Cmd+Z 復原
O 橢圓 Cmd+Shift+Z 重做
L 直線 Cmd+C/X/V/D 複製/剪下/貼上/重複
T 文字 Cmd+G 群組
F Frame Cmd+Shift+G 解散群組
P 鋼筆工具 Cmd+Shift+E 匯出
H 手形(平移) Cmd+Shift+C 程式碼面板
Del 刪除 Cmd+Shift+V 變數面板
[ / ] 調整圖層順序 Cmd+J AI 聊天
方向鍵 微移 1px Cmd+, 智能體設定
Cmd+Alt+U 布林聯合 Cmd+Alt+S 布林減去
Cmd+Alt+I 布林交集

指令碼命令

bun --bun run dev          # 開發伺服器(連接埠 3000
bun --bun run build        # 正式版建置
bun --bun run test         # 執行測試Vitest
npx tsc --noEmit           # 型別檢查
bun run electron:dev       # Electron 開發模式
bun run electron:build     # Electron 封裝

參與貢獻

歡迎貢獻!請查閱 CLAUDE.md 了解架構細節和程式碼風格。

  1. Fork 並複製存放庫
  2. 建立分支:git checkout -b feat/my-feature
  3. 執行檢查:npx tsc --noEmit && bun --bun run test
  4. 使用 Conventional Commits 提交:feat(canvas): add rotation snapping
  5. main 分支發起 PR

路線圖

  • 設計變數與令牌,支援 CSS 同步
  • 元件系統(實體與覆寫)
  • 帶編排器的 AI 設計生成
  • MCP 伺服器整合
  • 多頁面支援
  • Figma .fig 匯入
  • 布林運算(聯集、減去、交集)
  • 協同編輯
  • 外掛程式系統

貢獻者

Contributors

社群

Discord 加入我們的 Discord — 提問、分享設計、提出功能建議。

授權條款

MIT — Copyright (c) 2026 ZSeven-W