Repository navigation
v0.9.0
New: the case explainer (--mode CASE). A topic and up to three sources in, a finished sectioned explainer video out, in 16:9 and 9:16. It fits any subject that can be told in sections (an event, a failure, a product, a scam, a historic moment).
- Grounded. The script is written only from the sources. A sentence holding a figure or name no source contains is dropped; with no source the video says UNVERIFIED. Every section shows a small "SOURCE host" chip and the end card says how many sentences were left out.
- Sources can be web pages, PDFs (link or file, needs
pypdf: extrasources), YouTube links (captions; with none, the audio is listened to), audio or video files (listened to by the local speech model, first 40 minutes), caption files (.srt,.vtt), text files or pasted notes. - Made for you: a narrator voice (ElevenLabs when its key is set, else Edge; after one failure the rest of the video uses Edge), captions, synthesised light music and sound effects (nothing downloaded, nothing licensed), drawn scenes that light up as each item is spoken (timeline, flow, counters, checklist, terminal, quote, formula), optional stock video or photos behind the scenes (
PEXELS_API_KEY) or your own image or video, and a Manim animation of the mechanism, floating over the picture. - Pacing: each section is cut into 3.5 to 6.5 second beats at the narrator's sentence ends; every beat has its own picture, a punch-in and a flash.
- Nine looks (
theme): dark, clean, warm, neon, newsroom, blueprint, terminal, editorial, midnight. Each sets colours, the animated background, card style and type (system fonts only). - Options in one schema (
engine/case_options.py, built on the reusableengine/mode_options.py):--case KEY=VALUE(repeatable;--case helplists them) or--case_file FILE.json. Keys: template, theme, formats, background, manim, draft, plan_only, resume. The house rule for other modes is in AGENTS.md. - Review and iterate:
plan_onlywrites just the script so you can edit it;resume=FOLDERredoes the render with the saved script, narration and animations (new look, background or shape, no new voice);draftrenders a half-size draft in about a minute. - Animations are checked before they are rendered: built from a tested kit (
engine/manim_kit.py: chain, branch, cycle, before and after, bar), run once at a tiny size to find texts that overlap or cross a box edge, and checked on sample frames (cut off, nearly empty, cramped); a failed check goes back to the model with the reason. - Browser app: a Case explainer card (topic, sources, sections, look, shapes, background, quick draft, earlier runs to redo) with a review box to edit the script as plain text before rendering.
- See docs/FEATURES.md ("Case explainers").
Clip tool
- Review step: below the chosen moments, up to three runner-ups the tool ranked next are shown unticked; tick one to render it too (
plan.jsonmarks them"spare": true). - A clip run saves every moment that was in the running, best first (
candidates.json). With--gold,scripts/clip_benchmark.pyadds recall@5 and recall@8. scripts/picker_bench.py: an offline benchmark of the moment picker on the transcripts of the four public test videos (seconds, no video, no AI);--ablateshows what each picking rule is worth.- Experimental, off by default:
SHORTSFLOW_LOCAL_RERANK=1has a model running on this PC (Ollama,LOCAL_LLM_MODEL) rank the best 15 candidates; there is no cloud fallback for the text.SHORTSFLOW_SENTENCE_WINDOWS=1picks no-key shorts as sentence windows; it does not beat the current picker on the benchmark yet.
Other
shortsflow doctor --reportprints a block to paste into a bug report (versions and the doctor checks, no keys, no folder or account names).- Python 3.10 is tested in CI;
requirements-full.txtallows Gradio 6 likepyproject.toml; runs started by the MCP server and the API open no console window on Windows. engine/modes/clip_extract.py:run()is a short orchestrator calling named steps. No behaviour change.