Skip to content

The truly free, open-source, local-first, cross-platform CapCut replacement. Scriptable through a JSON-RPC API & MCP.

docs: remove stale references left behind by the engine migration

Jareerb69864782736
diff --git a/desktop/README.md b/desktop/README.md
index ec14f52c..2ab61ae7 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -14,6 +14,7 @@ npm install
npm run app # tauri dev - builds the Rust host and opens the window
npm run app:build # production bundle (msi/nsis on Windows)
npm run typecheck # tsc --noEmit
+npm test # vitest - the engine-mirror and IPC-registry suites
```
`npm run dev` alone serves the UI in a browser, which is useful for pure layout
@@ -26,26 +27,49 @@ src/
App.tsx editor shell: panel grid, window state, keyboard map
components/
TitleBar.tsx custom title bar - the window is undecorated
+ StartScreen.tsx launch screen: new project, recents, template gallery
Icon.tsx the whole icon set, plus the standard IconButton
Panel.tsx Panel / Bar / Divider / Empty - all shared chrome
Menu.tsx dropdown menus (title bar)
ContextMenu.tsx right-click menus (portal, edge-clamped)
Resizer.tsx draggable panel dividers
- MediaBin.tsx import and list media; items are drag sources
- Preview.tsx program monitor - a <video> element, for now
+ MediaBin.tsx the library: media, text, transitions, effects, templates
+ Preview.tsx program monitor: live approximation + the engine's true still
TimelinePanel.tsx toolbar, track headers, and the timeline canvas
- Inspector.tsx properties of the selection
+ RightPanel.tsx the selection's tab strip, hosting the panels below
+ Inspector.tsx properties of the selection (read-only)
+ AdjustPanel.tsx volume, fades, speed, transform
+ FiltersPanel.tsx the clip's audio filter chain
+ EffectsPanel.tsx the clip's video effect chain and incoming transition
+ TextPanel.tsx title styling and custom fonts
+ ExportDialog.tsx render settings, progress, title rasterisation
+ SettingsDialog.tsx transcriber setup
+ SaveTemplateDialog.tsx names and saves the open project as a template
+ TemplateThumb.tsx a template's poster, shared by gallery and library
+ ConfirmDialog.tsx the are-you-sure sheet for destructive actions
+ ErrorNotice.tsx inline error strip
+ controls.tsx sliders and fields shared by the panels
lib/
engine.ts the ONLY file that calls invoke(). Typed IPC boundary.
editor.ts type mirrors of the engine model, selectors, gesture echo
transport.ts the playback clock (follows the engine's position events)
effects.ts video effect & transition catalogue -> ffmpeg chains + live previews
filters.ts audio filter catalogue -> ffmpeg chains
- persist.ts tolerant relay.json reader/writer
+ text.ts title styles and bundled fonts
+ assets.ts filmstrips and waveforms, cached in the project folder
+ rasterize.ts titles -> full-frame PNGs at export time
+ theme.ts light / dark, and the canvas palette reads
time.ts display formatting. No time arithmetic lives in the UI.
+ settings.ts localStorage preferences
styles.css Tailwind entry point, tokens, and the `surface` utility
src-tauri/
src/lib.rs Tauri commands: engine types in, JSON out. Nothing else.
+ src/editor_api.rs the engine-owned editing session (open / apply / undo / save)
+ src/export.rs transition resolution, timeline build, render, preview_frame
+ src/playback.rs audio decode, mix, and the transport clock
+ src/projects.rs project folders on disk and the recents list
+ src/templates.rs template bundles: save, list, instantiate, delete
+ src/transcribe.rs whisper-cli discovery, models, transcription
```
## Rules that keep this fast
@@ -85,8 +109,10 @@ src-tauri/
2. Register it in `generate_handler![..]`.
3. Add the matching type and wrapper to `src/lib/engine.ts`.
-The IPC boundary is JSON, so nothing checks steps 1 and 3 against each other.
-Keep them adjacent in the same commit.
+The IPC boundary is JSON, so the compiler cannot check steps 1 and 3 against
+each other - `src/lib/ipc-registry.test.ts` does: `npm test` fails on a
+registered command with no wrapper, a wrapper naming an unregistered command,
+or an `invoke` call anywhere outside `lib/engine.ts`.
## Not decided yet
diff --git a/desktop/docs/decisions/0004-audio-preview-in-the-webview.md b/desktop/docs/decisions/0004-audio-preview-in-the-webview.md
index a325b187..2c85a508 100644
--- a/desktop/docs/decisions/0004-audio-preview-in-the-webview.md
+++ b/desktop/docs/decisions/0004-audio-preview-in-the-webview.md
@@ -9,9 +9,10 @@
> **Superseded in part by [0005](0005-audio-playback-in-the-engine.md):**
> audio playback now lives in the engine - decoded, mixed and clocked in
> `src-tauri/src/playback.rs`, with the UI following the engine's position
-> events. What remains true here is the *video* half: the monitor picture is
-> still the webview's `<video>` element, muted, until the engine can present
-> frames.
+> events. `lib/audio.ts` and the blob-URL fallback described below were
+> deleted with that move, exactly as "What replaces it" planned. What remains
+> true here is the *video* half: the monitor picture is still the webview's
+> `<video>` element, muted, until the engine can present frames.
## Decision
Playback preview - both the picture in the monitor and the sound - uses the
diff --git a/desktop/src-tauri/src/editor_api.rs b/desktop/src-tauri/src/editor_api.rs
index 6817e324..5879b822 100644
--- a/desktop/src-tauri/src/editor_api.rs
+++ b/desktop/src-tauri/src/editor_api.rs
@@ -3,8 +3,8 @@
//! One session at a time, held in managed state: open a project and the
//! engine holds the edit; every mutation arrives as a `relay_project`
//! [`Command`], is applied with undo recorded, and the new state goes back
-//! over the wire. The UI's provisional model (`lib/project.ts`) is frozen
-//! and being replaced by calls into this module - see
+//! over the wire. This is the API `lib/editor.ts` mirrors; the provisional
+//! TypeScript model it replaced is gone - see
//! `engine/docs/decisions/0007-engine-owns-the-project.md`.
//!
//! Saving reuses `projects::save`'s temp-file-and-rename, so the document on
diff --git a/desktop/src-tauri/src/projects.rs b/desktop/src-tauri/src/projects.rs
index 0058f938..ddb08068 100644
--- a/desktop/src-tauri/src/projects.rs
+++ b/desktop/src-tauri/src/projects.rs
@@ -84,8 +84,8 @@ pub fn create(
std::fs::create_dir_all(&root)
.map_err(|error| format!("could not create {}: {error}", root.display()))?;
- // Only the settings for now. The timeline joins them once the engine owns
- // the edit and there is a canonical form to serialise.
+ // Settings only: a fresh project has no edit yet. The full document -
+ // timelines included - is written by `editor_save` from the first change.
let document = Manifest {
relay: env!("CARGO_PKG_VERSION").to_owned(),
name: name.to_owned(),
@@ -112,10 +112,9 @@ pub fn create(
/// Writes the whole project document to `relay.json`.
///
/// The document is passed through as opaque JSON rather than being mirrored
-/// into Rust types. The edit model is still provisional and lives in the UI
-/// (see `lib/project.ts`); duplicating it here would mean changing two
-/// definitions in lockstep for no benefit, and the host has no decisions to
-/// make about its contents.
+/// into Rust types: the engine (`relay-project`) owns the canonical model and
+/// produced this document, and the host has no decisions to make about its
+/// contents beyond writing it safely.
///
/// Written to a temporary file and renamed into place, because a save
/// interrupted halfway is worse than no save at all - a truncated relay.json
diff --git a/desktop/src/components/ConfirmDialog.tsx b/desktop/src/components/ConfirmDialog.tsx
index f0b57740..b6c1a64e 100644
--- a/desktop/src/components/ConfirmDialog.tsx
+++ b/desktop/src/components/ConfirmDialog.tsx
@@ -5,8 +5,9 @@ import { Icon } from "./Icon";
/**
* A small blocking confirmation, for actions that destroy work.
*
- * There is no undo system yet, so "are you sure" is the only line of defence
- * a destructive action has. Kept deliberately plain: a title that names the
+ * Edits are undoable through the engine's history; this sheet guards the
+ * destructions that are not, or that erase enough at once that a stray click
+ * should not get to do it. Kept deliberately plain: a title that names the
* thing, one sentence of consequence, and a danger-coloured button that
* repeats the verb - never just "OK", because the button is what people read
* when they skip the sentence.
diff --git a/desktop/src/components/MediaBin.tsx b/desktop/src/components/MediaBin.tsx
index 0b704e5a..7cb9d2ca 100644
--- a/desktop/src/components/MediaBin.tsx
+++ b/desktop/src/components/MediaBin.tsx
@@ -49,10 +49,11 @@ const TABS: { id: LibraryTab; label: string }[] = [
* sidebar on the left, and the browsing area on the right where media, effect
* previews and so on are shown.
*
- * Media is the only page that is fully live. Text offers the one title style
- * that exists. Transitions and Effects browse the catalogues in
- * `lib/effects.ts` but cannot yet be applied - the engine has no video effect
- * pipeline - so their cards say "Soon" instead of pretending to drag.
+ * Media is fully live. Text offers the one title style that exists.
+ * Transitions and Effects browse the catalogues in `lib/effects.ts` and apply
+ * to the selected clip; only the motion transitions (wipe, push, zoom) still
+ * say "Soon", waiting on animated transforms in the engine. Templates lists
+ * saved bundles and hands off to the launch screen's fill flow.
*
* Media items are drag sources: dragging one onto the timeline places a clip
* at the drop position. That is the primary way material gets into an edit, so
diff --git a/desktop/src/components/StartScreen.tsx b/desktop/src/components/StartScreen.tsx
index 6c352e0d..c22ccacc 100644
--- a/desktop/src/components/StartScreen.tsx
+++ b/desktop/src/components/StartScreen.tsx
@@ -410,7 +410,7 @@ export function StartScreen({
? `${missing} slot${missing === 1 ? "" : "s"} still need${missing === 1 ? "s" : ""} a clip.`
: "Every slot is filled.";
})()
- : "The timeline is not saved to disk yet."}
+ : "The project folder is created now; the edit autosaves into it."}
</p>
</div>