4.1 KiB
4.1 KiB
DrawCraft — instructions for agents
DrawCraft is a clean-room, open-source, Rust-native vector illustration app targeting Adobe Illustrator parity (and beyond). It runs natively on macOS, Windows and Linux, and on the web via WASM. Siblings: ../photocraft (Photoshop-class) and ../printcraft (Acrobat-class); same conventions.
Start every session here
- Read
plan/STATUS.md(current milestone, next task), then the task inplan/execution-plan.md§3 and the relevantplan/architecture.mdsection. Behaviour reference:plan/illustrator/*.md. - Follow the autonomous operation protocol (
plan/execution-plan.md§7): orient → plan → implement + test → verify → record → commit. Don't stop to ask unless §7 lists the decision as the user's.
plan/ is gitignored (local only).
Non-negotiables
- Clean-room. Never read, disassemble or copy anything inside the Illustrator bundle (names/listings only). Never copy Adobe icons, artwork, presets or wording beyond feature names. Behaviour comes from public docs and black-box observation of the running app with synthetic documents only (screenshots by window id, stored under
plan/illustrator/screenshots/, never committed). Never copy GPL/AGPL code (Inkscape, lib2geom…). - Assets: no Adobe iconography or images — ever (absolute rule, from the project owner).
- Never add, copy, trace, redraw-from, embed or ship any icon, image, artwork, cursor, preset, swatch/brush/symbol/pattern/style library, ICC profile or screenshot from Adobe products or from any other source whose licence doesn't allow it.
- Every image, icon, font or other asset must be one of:
- original work created for DrawCraft by a contributor (who licenses it MIT OR Apache-2.0);
- OSI open source;
- public domain / CC0;
- Creative Commons with redistribution allowed.
- Every asset file must have a row in
ASSETS.md(path, author, source URL, licence, notes). Put licence texts next to the assets (e.g.assets/fonts/OFL-*.txt) and summarize them inNOTICE. cargo xtask assets(run bycargo xtask ci) fails on any unattributed asset.- Prefer art generated in code for defaults (swatches, brushes, symbols, patterns, cursors). If the provenance of an asset is unclear, don't add it.
- Reference screenshots of Illustrator stay local under the gitignored
plan/and are never committed, published or used as assets.
- Everything is a command. User-visible behaviour = a command in
crates/engine/src/cmd/*(id, label, menu path, shortcut, params doc,enabled,run) + tests. Tools emit commands (Begin/Preview/Commit). UI-only commands live incrates/ui-egui/src/menus.rs(UI_COMMANDS). The control channel and MCP reach all of them. - Layering is enforced by
cargo xtask layers. Nothing below L6 depends on egui/eframe/winit/rfd. - The UI is thin: panels read engine state and act through
app.run(id, params). Colours come fromtheme::Tokens. - Rust only (no handwritten JS/TS). Never break wasm (
cargo xtask wasm). - Quality gates before every commit:
cargo xtask ci(fmt, clippy -D warnings, tests, layers, wasm). One task id per commit (M2.1: pen tool).
Running and looking at the app
cargo run --release -p drawcraft -- --control 7979 [file.svg|file.drawcraft]- Drive it: JSON lines on
127.0.0.1:7979, e.g.{"id":1,"method":"engine.execute","params":{"command":"shape.rectangle","params":{"x":10,"y":10,"width":100,"height":50}}}then{"id":2,"method":"ui.screenshot","params":{"path":"/tmp/shot.png"}}. Methods:crates/ui-egui/src/control.rs. - For UI work, look at the result (take
ui.screenshot, read the PNG) and compare withplan/illustrator/02-ui-ux.md/10-observed-ui.md. - MCP:
drawcraft-cli mcp(seedocs/mcp.md). - Shell gotcha:
mv/cpare aliased interactive here — use/bin/mv -f//bin/cp -f. - Parallel agents: separate
CARGO_TARGET_DIRper agent; edit only the crates you own; write manifests atomically.
Roadmap
ROADMAP.md (committed) tracks status, milestones and time-to-parity estimates. Update it whenever a milestone task lands.