Skip to content

AI media harness for planning, generating, and editing locally

TypeScript

README: compact, current features and settings names

Bitti478128697dd4
diff --git a/README.md b/README.md
index 93aa264..357658e 100644
--- a/README.md
+++ b/README.md
@@ -13,75 +13,32 @@
<p align="center">
<a href="#features">Features</a> &nbsp;&middot;&nbsp;
- <a href="#from-idea-to-export">From idea to export</a> &nbsp;&middot;&nbsp;
<a href="#setup">Setup</a>
</p>
---
-Slopus brings an AI assistant, a scene generator, reusable visual references, and a timeline editor together. Describe what you want to make, generate clips locally with SlopFab, and shape the result into a video you can export and share.
+Slopus brings an AI assistant, a scene generator, reusable references, a timeline editor, and a still image editor together. Generate locally with SlopFab (no Python, no FFmpeg) and export finished videos and images.
-New projects can be **Image projects** or **Video projects**. Choose an empty project folder first; the New project popup shows its path and defaults the project name to the folder name. Changing the project name does not rename the folder. Existing projects open as Video projects. Both live in folders with a `slopus.json` document.
-
-Image projects use **Agent**, **Editor**, and **References** tabs. In the Editor, build a hierarchy of objects, text and groups on the left, arrange their placement boxes in the center, and edit descriptions, style, colors and generation settings in the right inspector. Choose a MiniMax H3 generator above the canvas and press **Generate**. Generation uses the native SlopFab runtime without Python. Full-resolution images are saved in `media/generated/`, remain available in the image history, and can be exported as JPEG or PNG using **Export** beside **Save**.
-
-The inspector offers **Prompt root** for a new composition and **Image root** to open an existing PNG or JPEG. You can also right-click a generated thumbnail and choose **Edit** to start an image root from it. Add Object nodes with descriptions and placement boxes, then Generate. In image-root mode, SlopFab applies each edit in hierarchy order using exact bounding-box inpainting, preserving pixels outside each box. The final PNG keeps the source resolution and becomes a clean image root for further edits. In prompt-root mode, placement boxes guide the prompt rather than acting as masks.
-
-An **Editing** thumbnail holds the pending image version. Select other thumbnails to browse results, then select Editing to return to its hierarchy and prompts. Saving the project also saves this draft. Successful generation replaces the temporary thumbnail with the finished image; failed or cancelled generation keeps it available for retry.
-
-Right-click the image bar or a thumbnail and choose **New empty image** to add a blank Prompt draft. Its thumbnail keeps the new composition available while browsing and is replaced by the generated image when finished.
-
-The Agent can add, edit, reorder, reparent, duplicate and remove image nodes, and adjust prompts, style, placement, palettes, references, steps and seeds. Edits are transactional and preserve generated images. See the [image command guide](src-tauri/assets/agent-image.md) for the command vocabulary and examples.
-
-> **GPU recommendation:** A GPU with **24 GB of VRAM or more** is currently recommended for local video generation. We plan to reduce VRAM usage in future updates.
+> **GPU recommendation:** **24 GB of VRAM or more** is currently recommended for local generation. We plan to reduce this in future updates.
![Slopus application screenshot](marketing/screenshot1.png)
## Features
-### Create through conversation
-
-Connect Claude Code, Codex, OpenRouter, or a local model served through an OpenAI-compatible API. Ask your assistant to develop an idea into scenes and shots, build references, and refine the project through conversation.
-
-### Plan scenes and generate clips
-
-- **Scene and shot board:** Write shot prompts, set timing, and drag scenes and shots into order.
-- **Creative controls:** Shape shots with camera and visual settings, attach references, or use an image as a scene's starting frame.
-- **Local generation:** Render with SlopFab using model files on your computer. Adjust generation steps and seeds, and save different model setups as generator presets.
-- **Work queue:** Follow generation progress and cancel queued or running jobs.
-
-### Keep a reusable reference library
-
-Define characters, animals, products, locations, and styles with written descriptions and image attachments. Start from searchable presets or create your own references, then reuse them across scenes to guide a consistent look. See which scenes use a reference and jump back into the generator to edit them.
-
-### Edit picture and sound
-
-- **Video and audio tracks:** Combine generated clips with imported media, arrange clips with snapping, trim their edges, and split at the playhead.
-- **Visual timeline:** Use video thumbnails, audio waveforms, zoom, and scrubbing to find the right moment. Lock or mute tracks as you work.
-- **Clip effects:** Scale, rotate, and reposition footage; adjust opacity and color temperature; remove a background color with chroma key.
-- **Transitions and preview:** Add fades or directional wipes and review the composition in the program monitor.
-
-### Export for your audience
-
-Work in landscape, portrait, square, or 4:5 formats. Preview the edit, choose output resolution, frame rate, and quality, then export an MP4. H.264, VP9, and AV1 options depend on the encoders available on your computer; the export view checks support before rendering.
-
-### Keep projects under your control
-
-Projects live in local file system, with a `slopus.json` project file and files for generated media, references, and exports. Imported media can also be linked from elsewhere on your computer. Agent endpoints and API keys stay in this computer's settings, outside project files.
-
-Choose a light, dark, or system theme, and check for app updates from Settings.
-
-## From idea to export
-
-1. **Create a project** create a project folder and choose its video format.
-2. **Build your references** with descriptions and images for the subjects and look you want.
-3. **Write scenes and shots** yourself or work with the assistant, then generate clips.
-4. **Assemble the edit** on the timeline, add video or audio, and refine timing and effects.
-5. **Preview and export** the finished video as an MP4.
+- **Two project types.** A project is a folder with a `slopus.json` file. Video projects have **Timeline**, **Generator**, **References** and **Export** tabs; Image projects have **Editor**, **References** and **Export**.
+- **Agent.** Claude Code, Codex, OpenRouter, or a local OpenAI-compatible model in a docked pane (Ctrl+Shift+A). It can plan scenes, build references, and edit video and image projects (see the [image command guide](src-tauri/assets/agent-image.md)).
+- **Scene generator.** A board of scenes and shot tiles. Scene types: First & last frame, Animate, Pose, Character replace, Extend and Bridge. Attach references and start frames, and set steps, seeds and generator presets. Runs in the **Work queue**, where jobs can be cancelled.
+- **References.** Characters, animals, products, locations and styles with descriptions and images. Start from searchable presets, browse as Icons or Details, and see which scenes use each one.
+- **Timeline.** Video and audio tracks with thumbnails, waveforms, snapping, trimming, splitting, zoom and keyboard shortcuts. Transform, opacity, chroma key, fades and wipes, plus GPU effects (sharpen, blur, color correction, vignette, `.cube` LUTs) that can be bypassed.
+- **Image editor.** Build a hierarchy of objects, text and groups with placement boxes, then generate with MiniMax H3. Use **Image root** to open a PNG or JPEG (or **Edit** a result) and apply edits in hierarchy order with bounding-box inpainting. Results and drafts stay in the image bar.
+- **Export.** Video: MP4 in H.264, VP9 or AV1 (as your encoders allow) at a chosen resolution, frame rate and quality; exports keep running in the background. Images: pick one from the image bar and save it as JPG or PNG at a chosen size and quality.
+- **Undo everywhere.** Save, Undo and Redo sit in the title bar; Ctrl+Z and Ctrl+Y cover edits from any view, the agent and project settings.
+- **Your data.** Projects and media stay on disk. API keys stay in this computer's settings, outside project files.
## Setup
-Local video generation requires separately installed model weights and GPU support. In **Settings → Video engine**, configure a generator's model paths and check that its status reads **Engine ready**. Configure OpenRouter or a local model endpoint in **Settings → Agents** to make it available in the assistant's agent list.
+Local video generation requires separately installed model weights and GPU support. In **Settings → Generator**, configure a generator's model paths and check that its status reads **Ready**. Configure OpenRouter or a local model endpoint in **Settings → Agents** to make it available in the assistant's agent list.
The project's GPU setup recommendations are:
@@ -98,6 +55,6 @@ Slopus uses Tauri 2, Rust, React, and TypeScript. WebCodecs and WebGPU power med
## Model licensing
-Powered by MiniMax H3.
+Powered by MiniMax H3.
MiniMax H3 model weights are licensed separately under their own **MiniMax H3 COMMUNITY LICENSE AGREEMENT**.