mirror of
https://github.com/storytold/deckcraft.git
synced 2026-10-24 10:37:03 -06:00
Brandon Thomas
c354f02279
# Conflicts: # apps/deckcraft-cli/src/main.rs # crates/engine/src/cmd/file.rs # crates/engine/src/lib.rs # crates/mcp/src/tests.rs # crates/mcp/src/tools.rs # crates/ui-egui/src/dialogs.rs
3.8 KiB
3.8 KiB
Control protocol
Start the app with --control <port>. The server listens on 127.0.0.1 only and speaks JSON
lines: one request object per line, one reply per line.
{"id": 1, "method": "engine.execute", "params": {"command": "shape.insert", "params": {"preset": "roundRect", "rect": [100, 100, 240, 120], "text": "Hello"}}}
{"id": 1, "ok": true, "result": {"id": 258}}
Coordinates are slide points (1/72 inch; a 16:9 slide is 960 × 540) unless noted.
| Method | Params | What it does |
|---|---|---|
engine.execute / ui.menu.invoke / command |
{command, params} |
Run any command (see engine.commands; deckcraft-cli describe COMMAND documents one) |
engine.commands |
— | Every command: id, label, menu path, shortcut, params doc, enabled / disabled reason |
document.inspect |
— | Slides, sections, layouts, shapes, selection |
ui.inspect |
— | UI state, active tool, window/canvas/slide rects, dialog, home (the File tab open over a presentation), backstage (its page, also the start screen), slide show state (grid, zoomArm, zoom, blank, presenterPaused, presenterSecs, notesPx, custom, goto; cells while See All Slides is open), documents, perf (fps, render ms) |
ui.tool.select |
{tool, preset?} |
select, text, shape + preset, any preset name, curve, freeform, scribble, pen, highlighter, eraser |
ui.pointer |
{events: [{kind: down|drag|up|move|doubleclick|tripleclick|contextclick, x, y, mods?}], mods?} |
Drive the active tool in slide points through the same code path as the mouse (contextclick: the right-button press that selects before the context menu) |
ui.key / ui.text |
{key, shift?, alt?, cmd?} / {text} |
Keyboard input (also drives a running slide show: digits then Enter go to that slide, G is See All Slides, Z arms zoom, T pauses the presenter timer, R resets it, [ and ] change notes size, Esc clears a slide number, the grid and zoom before it leaves the show) |
ui.ime |
{preedit, active?: [start, end]} / {commit} |
An input method's composition through egui, as a real one arrives: shown in place on the slide or in a focused field; {"preedit": ""} cancels |
ui.move / ui.click / ui.drag |
screen points | Real egui pointer input — reaches every widget, menu and pane |
ui.set |
{tab?, view?, pane?, notes?, zoom?, brightness?, ruler?, gridlines?, guides?, …} |
UI state (returns the full state) |
ui.dialog.open / ui.dialog.close |
{id, fields?} |
Open or close a dialog by id; fields pre-fills its fields (About: {"tab": "contributors"} or "models") |
ui.screenshot |
{path?} |
PNG of the whole window (base64 when no path) |
ui.render |
{path?, slide?, scale?} |
Render a slide headlessly |
ui.resize / ui.focus |
Window control | |
show.start / show.end |
{from?: slide index, custom?: name, reading?} |
Slide show. custom plays that custom show from its first slide and does not change Set Up. With no from and no custom, playback starts at the first slide of the show order |
app.open / app.save / app.export / app.quit |
{path, …} |
Files (export takes the file.export params, e.g. {"path": "deck.pdf", "layout": "handouts", "perPage": 3}) |
show.start / show.end |
{from?: slide index, presenter?, reading?} |
Slide show |
app.open / app.save / app.export / app.quit |
{path, …} |
Files (export takes the file.export params, e.g. {"path": "deck.pdf", "layout": "handouts", "perPage": 3} or {"path": "deck.gif", "width": "large", "secondsPerSlide": 3, "loop": false}) |
The MCP server (deckcraft-cli mcp, see mcp.md) wraps the same methods for Claude
and other agents; deckcraft-cli app --method METHOD [PARAMS] sends one request from a shell.