* 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>
213 lines
8.6 KiB
Markdown
213 lines
8.6 KiB
Markdown
<p align="center">
|
|
<img src="./electron/icon.png" alt="OpenPencil" width="120" />
|
|
</p>
|
|
|
|
<h1 align="center">OpenPencil</h1>
|
|
|
|
<p align="center">
|
|
<strong>KI-natives Open-Source-Designwerkzeug. Design-as-Code.</strong><br />
|
|
Vom Prompt zur Canvas-UI. Multi-Agenten-Orchestrierung. Eingebauter MCP-Server. Codegenerierung.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="./README.md">English</a> · <a href="./README.zh.md">简体中文</a> · <a href="./README.zh-TW.md">繁體中文</a> · <a href="./README.ja.md">日本語</a> · <a href="./README.ko.md">한국어</a> · <a href="./README.fr.md">Français</a> · <a href="./README.es.md">Español</a> · <a href="./README.de.md"><b>Deutsch</b></a> · <a href="./README.pt.md">Português</a> · <a href="./README.ru.md">Русский</a> · <a href="./README.hi.md">हिन्दी</a> · <a href="./README.tr.md">Türkçe</a> · <a href="./README.th.md">ไทย</a> · <a href="./README.vi.md">Tiếng Việt</a> · <a href="./README.id.md">Bahasa Indonesia</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/ZSeven-W/openpencil/stargazers"><img src="https://img.shields.io/github/stars/ZSeven-W/openpencil?style=flat" alt="Stars" /></a>
|
|
<a href="https://github.com/ZSeven-W/openpencil/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ZSeven-W/openpencil" alt="License" /></a>
|
|
<a href="https://github.com/ZSeven-W/openpencil/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/ZSeven-W/openpencil/ci.yml?branch=main&label=CI" alt="CI" /></a>
|
|
<a href="https://discord.gg/KwXp6BJD"><img src="https://img.shields.io/discord/1476517942949580952?label=Discord&logo=discord&logoColor=white" alt="Discord" /></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#schnellstart">Schnellstart</a> ·
|
|
<a href="#ki-natives-design">KI</a> ·
|
|
<a href="#funktionen">Funktionen</a> ·
|
|
<a href="https://discord.gg/KwXp6BJD">Discord</a> ·
|
|
<a href="#mitwirken">Mitwirken</a>
|
|
</p>
|
|
|
|
<br />
|
|
|
|
<p align="center">
|
|
<a href="https://oss.ioa.tech/zseven/openpencil/a46e24733239ce24de36702342201033.mp4">
|
|
<img src="./screenshot/op-cover.png" alt="OpenPencil — click to watch demo" width="100%" />
|
|
</a>
|
|
</p>
|
|
<p align="center"><sub>Auf das Bild klicken, um das Demo-Video anzusehen</sub></p>
|
|
|
|
<br />
|
|
|
|
## Schnellstart
|
|
|
|
```bash
|
|
# Abhängigkeiten installieren
|
|
bun install
|
|
|
|
# Entwicklungsserver auf http://localhost:3000 starten
|
|
bun --bun run dev
|
|
```
|
|
|
|
Oder als Desktop-App ausführen:
|
|
|
|
```bash
|
|
bun run electron:dev
|
|
```
|
|
|
|
> **Voraussetzungen:** [Bun](https://bun.sh/) >= 1.0 und [Node.js](https://nodejs.org/) >= 18
|
|
|
|
## KI-natives Design
|
|
|
|
OpenPencil wurde von Grund auf mit KI im Kern aufgebaut — nicht als Plugin, sondern als zentraler Arbeitsablauf.
|
|
|
|
**Vom Prompt zur UI**
|
|
- **Text-zu-Design** — eine Seite beschreiben und sie wird in Echtzeit mit Streaming-Animation auf der Canvas generiert
|
|
- **Orchestrierer** — zerlegt komplexe Seiten in räumliche Teilaufgaben zur parallelen Generierung
|
|
- **Design-Modifikation** — Elemente auswählen und Änderungen in natürlicher Sprache beschreiben
|
|
- **Bildeingabe** — Screenshots oder Mockups als Referenz für referenzbasiertes Design anhängen
|
|
|
|
**Multi-Agenten-Unterstützung**
|
|
|
|
| Agent | Einrichtung |
|
|
| --- | --- |
|
|
| **Claude Code** | Keine Konfiguration — verwendet Claude Agent SDK mit lokalem OAuth |
|
|
| **Codex CLI** | In den Agenteneinstellungen verbinden (`Cmd+,`) |
|
|
| **OpenCode** | In den Agenteneinstellungen verbinden (`Cmd+,`) |
|
|
|
|
**MCP-Server**
|
|
- Eingebauter MCP-Server — Ein-Klick-Installation in Claude Code / Codex / Gemini / OpenCode / Kiro CLIs
|
|
- Design-Automatisierung vom Terminal aus: `.op`-Dateien über jeden MCP-kompatiblen Agenten lesen, erstellen und bearbeiten
|
|
|
|
**Codegenerierung**
|
|
- React + Tailwind CSS
|
|
- HTML + CSS
|
|
- CSS Variables aus Design-Tokens
|
|
|
|
## Funktionen
|
|
|
|
**Canvas und Zeichnen**
|
|
- Unendliche Canvas mit Pan, Zoom, intelligenten Ausrichtungshilfslinien und Einrasten
|
|
- Rechteck, Ellipse, Linie, Polygon, Stift (Bezier), Frame, Text
|
|
- Boolesche Operationen — Vereinigung, Subtraktion, Schnittmenge mit kontextbezogener Werkzeugleiste
|
|
- Icon-Auswahl (Iconify) und Bildimport (PNG/JPEG/SVG/WebP/GIF)
|
|
- Auto-Layout — vertikal/horizontal mit Gap, Padding, Justify, Align
|
|
- Mehrseitige Dokumente mit Tab-Navigation
|
|
|
|
**Designsystem**
|
|
- Designvariablen — Farb-, Zahl- und Text-Tokens mit `$variable`-Referenzen
|
|
- Multi-Theme-Unterstützung — mehrere Achsen, jeweils mit Varianten (Hell/Dunkel, Kompakt/Komfortabel)
|
|
- Komponentensystem — wiederverwendbare Komponenten mit Instanzen und Überschreibungen
|
|
- CSS-Synchronisierung — automatisch generierte benutzerdefinierte Eigenschaften, `var(--name)` in der Code-Ausgabe
|
|
|
|
**Figma-Import**
|
|
- `.fig`-Dateien importieren mit erhaltenem Layout, Füllungen, Konturen, Effekten, Text, Bildern und Vektoren
|
|
|
|
**Desktop-App**
|
|
- Natives macOS, Windows und Linux über Electron
|
|
- Automatische Aktualisierung über GitHub Releases
|
|
- Natives Anwendungsmenü und Dateidialoge
|
|
|
|
## Technologie-Stack
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| **Frontend** | React 19 · TanStack Start · Tailwind CSS v4 · shadcn/ui |
|
|
| **Canvas** | Fabric.js v7 |
|
|
| **Zustand** | Zustand v5 |
|
|
| **Server** | Nitro |
|
|
| **Desktop** | Electron 35 |
|
|
| **KI** | Anthropic SDK · Claude Agent SDK · OpenCode SDK |
|
|
| **Laufzeit** | Bun · Vite 7 |
|
|
| **Dateiformat** | `.op` — JSON-basiert, menschenlesbar, Git-freundlich |
|
|
|
|
## Projektstruktur
|
|
|
|
```text
|
|
src/
|
|
canvas/ Fabric.js-Engine — Zeichnen, Synchronisierung, Layout, Hilfslinien, Stiftwerkzeug
|
|
components/ React-UI — Editor, Panels, gemeinsame Dialoge, Icons
|
|
services/ai/ KI-Chat, Orchestrierer, Designgenerierung, Streaming
|
|
services/figma/ Figma-.fig-Binär-Importpipeline
|
|
services/codegen React+Tailwind- und HTML+CSS-Codegeneratoren
|
|
stores/ Zustand — Canvas, Dokument, Seiten, Verlauf, KI, Einstellungen
|
|
variables/ Design-Token-Auflösung und Referenzverwaltung
|
|
mcp/ MCP-Server-Tools für externe CLI-Integration
|
|
uikit/ Wiederverwendbares Komponenten-Kit-System
|
|
server/
|
|
api/ai/ Nitro-API — Streaming-Chat, Generierung, Validierung
|
|
utils/ Claude CLI, OpenCode, Codex-Client-Wrapper
|
|
electron/
|
|
main.ts Fenster, Nitro-Fork, natives Menü, Auto-Updater
|
|
preload.ts IPC-Brücke
|
|
```
|
|
|
|
## Tastaturkürzel
|
|
|
|
| Taste | Aktion | | Taste | Aktion |
|
|
| --- | --- | --- | --- | --- |
|
|
| `V` | Auswählen | | `Cmd+S` | Speichern |
|
|
| `R` | Rechteck | | `Cmd+Z` | Rückgängig |
|
|
| `O` | Ellipse | | `Cmd+Shift+Z` | Wiederholen |
|
|
| `L` | Linie | | `Cmd+C/X/V/D` | Kopieren/Ausschneiden/Einfügen/Duplizieren |
|
|
| `T` | Text | | `Cmd+G` | Gruppieren |
|
|
| `F` | Frame | | `Cmd+Shift+G` | Gruppierung aufheben |
|
|
| `P` | Stiftwerkzeug | | `Cmd+Shift+E` | Exportieren |
|
|
| `H` | Hand (Pan) | | `Cmd+Shift+C` | Code-Panel |
|
|
| `Del` | Löschen | | `Cmd+Shift+V` | Variablen-Panel |
|
|
| `[ / ]` | Reihenfolge ändern | | `Cmd+J` | KI-Chat |
|
|
| Pfeiltasten | 1px verschieben | | `Cmd+,` | Agenteneinstellungen |
|
|
| `Cmd+Alt+U` | Boolesche Vereinigung | | `Cmd+Alt+S` | Boolesche Subtraktion |
|
|
| `Cmd+Alt+I` | Boolesche Schnittmenge | | | |
|
|
|
|
## Skripte
|
|
|
|
```bash
|
|
bun --bun run dev # Entwicklungsserver (Port 3000)
|
|
bun --bun run build # Produktions-Build
|
|
bun --bun run test # Tests ausführen (Vitest)
|
|
npx tsc --noEmit # Typprüfung
|
|
bun run electron:dev # Electron-Entwicklung
|
|
bun run electron:build # Electron-Paketierung
|
|
```
|
|
|
|
## Mitwirken
|
|
|
|
Beiträge sind willkommen! Siehe [CLAUDE.md](./CLAUDE.md) für Architekturdetails und Code-Stil.
|
|
|
|
1. Forken und klonen
|
|
2. Branch erstellen: `git checkout -b feat/my-feature`
|
|
3. Prüfungen ausführen: `npx tsc --noEmit && bun --bun run test`
|
|
4. Mit [Conventional Commits](https://www.conventionalcommits.org/) committen: `feat(canvas): add rotation snapping`
|
|
5. Pull Request gegen `main` öffnen
|
|
|
|
## Roadmap
|
|
|
|
- [x] Designvariablen & Tokens mit CSS-Synchronisierung
|
|
- [x] Komponentensystem (Instanzen & Überschreibungen)
|
|
- [x] KI-Designgenerierung mit Orchestrierer
|
|
- [x] MCP-Server-Integration
|
|
- [x] Mehrseitige Unterstützung
|
|
- [x] Figma-`.fig`-Import
|
|
- [x] Boolesche Operationen (Vereinigung, Subtraktion, Schnittmenge)
|
|
- [ ] Kollaboratives Bearbeiten
|
|
- [ ] Plugin-System
|
|
|
|
## Mitwirkende
|
|
|
|
<a href="https://github.com/ZSeven-W/openpencil/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=ZSeven-W/openpencil" alt="Contributors" />
|
|
</a>
|
|
|
|
## Community
|
|
|
|
<a href="https://discord.gg/KwXp6BJD">
|
|
<img src="./public/logo-discord.svg" alt="Discord" width="16" />
|
|
<strong> Unserem Discord beitreten</strong>
|
|
</a>
|
|
— Fragen stellen, Designs teilen, Funktionen vorschlagen.
|
|
|
|
## Lizenz
|
|
|
|
[MIT](./LICENSE) — Copyright (c) 2026 ZSeven-W
|