diff --git a/README.md b/README.md index 5b9ee836..03daa8ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # ComfyUI-FunPack -**FunPack turns ComfyUI into an AI movie studio.** At its heart is the **Cutting Room** — a full browser-based non-linear video editor where you write a script, arrange scenes on a real timeline, and generate a complete montage with one click. Behind it sits a self-improving generation engine: rate your clips and FunPack learns your taste, steering future generations toward what you liked. The nodes that power all of this (Studio, Video Refiner V2, the LTXAV Scene Chain Sampler, and more) remain fully usable in classic ComfyUI graph workflows with WAN, HunyuanVideo, LTX, and similar models. +**FunPack is a UI that unlocks novel conditioning and sampling enhancements, wires cutting-edge techniques and allows simple non-linear video montage - all while using regular ComfyUI backend.** +Graphs replaced with neat cards, get/set replaced with Linked inputs, and simple text fields leveled up to Composer - prefix, prompt, postfix, $variables, Ideas button, shortcuts and splits - for your prompting comfort.

Ko-fi  @@ -9,102 +10,16 @@

> [!IMPORTANT] -> FunPack is the project maintained by one person. Finding bugs, or features not working as intended, all alone - is nearly impossible - especially in an advanced piece of software like Editor. I've tried my best to make setup and acquaintance with FunPack as easy as possible, introducing multiple failsafes, but I can't envision how exactly you will use it. -> -> With this said - FunPack is provided "as is". Stable, uninterrupted work is NOT guaranteed even on main branch. But that doesn't mean bugs won't be fixed - you are free to file a bug report and I will most likely fix it in the nearest time. +> FunPack is a hobby project maintained by a single person. It's crafted for my personal needs mostly, and I can't test every single possible variant of usage to confirm it's bug-free and working as intended. +> If you had found a bug or you want to request a new feature, feel free to add an entry to Issues - that would be the most appreciated. -## What it looks like +## v4 update and migration/seize of support notice -Opening `/funpack/` inside ComfyUI lands you on the **Hub** - a small picker between FunPack's two browser UIs, plus at-a-glance version/update status. +Preparation for the next milestone update v4.0.0 has been started and it is in progress. -![FunPack Hub - pick a UI, see version and update status](docs/images/hub.png) +Since v4.0.0 all updates will target ONLY Cutting Room editor. Nodes will receive updates but their compatibility and proper display inside regular ComfyUI frontend won't be guaranteed and/or tested. -### Two UIs, one engine - -Both UIs drive the exact same generation engine (FunPack Studio + the LTXAV Scene Chain Sampler) and the exact same project files - a project opened in one opens unchanged in the other. Pick based on how much control you want in front of you: - -- **Cutting Room** - the full multi-scene non-linear editor: a real timeline with per-scene prompts, ratings and audio lanes, a program monitor, a media bin, and every Engine/Studio knob a click away. This is where rating-driven learning (refinement keys, value guidance, taste steering) lives. -- **Easy Gen** - one prompt, one Generate button, one big preview. Built for quick single-scene (or simple multi-scene via prompt splits) generations without the full NLE around it - advanced settings are still there, just tucked behind an "Advanced settings" link, and rating-dependent controls are hidden entirely since there's no rating UI to feed them (Studio always runs in a plain Prompt-only mode there). - -| Cutting Room - timeline, preview monitor, media bin, and scene inspector | Easy Gen - one prompt, one Generate button, one big preview | -| --- | --- | -| ![FunPack Cutting Room - timeline, preview monitor, media bin, and scene inspector](docs/images/cutting-room.png) | ![FunPack Easy Gen - single prompt box, Generate button, and preview pane](docs/images/easy-gen.png) | - -| The Composer - global prompt, shortcuts, split markers, `$variables` | Engine Settings - Studio + Chain Sampler knobs without touching a graph | -| --- | --- | -| ![Composer window](docs/images/composer.png) | ![Engine Settings dialog](docs/images/engine-settings.png) | - -Want a guided look at every panel? Open the editor and press **Help ▸ Welcome tour** - the same tour also auto-generates a full annotated gallery and walkthrough video via [`tools/showcase`](tools/showcase). - -## Dev and other non-main branches - -The `dev` branch is intended for testing unfinished changes, implementing new logic and basically, flipping everything just because I can. It can be broken, renamed, or changed without warning. - -Use only `main` if you want the most stable version of FunPack. Bug reports based on `dev` version will be ignored. - -From time to time other short-lived branches may appear for the most advanced yet most breaking changes and features (e.g. a large rework in progress). I do not recommend using any non-`main` branch unless it's strictly necessary for your workflow — any sort of stability is not guaranteed, and such branches can be force-pushed or deleted at any time. - -## Versions - -Since **3.5.1**, each major version carries a release codename — an adjective and a vegetable -sharing an initial, advancing alphabetically, in the tradition Ubuntu made familiar. All of -3.x is **"Auspicious Asparagus"**. It is shown in Settings ▸ About. - -### Version 3.0 — Cutting Room and development direction - -FunPack **3.0** introduces the **Cutting Room** — a dedicated montage editor at `/funpack/movie` inside ComfyUI. It is the primary surface for building multi-scene projects, previewing on a real timeline, and driving FunPack Studio + the LTXAV Scene Chain Sampler without wiring a graph by hand. - -Going forward, **new features and UX work target the Cutting Room frontend**. The classic ComfyUI node popups (Studio, Refiner V2, Scene Chain Sampler, and other pre-3.0 nodes) remain fully usable but will receive **bugfixes only** — no significant UI reworks unless a fix requires it. If you live in ComfyUI graphs, nothing breaks; if you want the full montage workflow, use the Cutting Room. - -**3.0.1** adds per-shortcut **refinement keys** (a shortcut can mark which key it trains, with per-scene multi-key steering and a timeline preview of the keys each scene will use) and fixes Cutting Room splitting/anchor bugs — see the [CHANGELOG](CHANGELOG.md). - -**3.1.1** adds prompt **`$variables`** and global-prompt **templates** in the Composer, a -cross-shot **JoyAI-Echo** audio/video memory mode, contrastive-pair **FreeSliders**, and a -seed-routing **path-outcome planner** that steers future generations away from disliked paths — -see the [CHANGELOG](CHANGELOG.md) for the full list. - -**3.1.2** fixes a Cutting Room regression where splitting a clip could undo itself (the second -half got pushed out as if a full-length clip had been appended) — see the -[CHANGELOG](CHANGELOG.md). - -**3.1.3** brings several **experimental sampler techniques** (ALG anchor de-staticking and -Momentum Guidance on Distilled Flow, Bounded Attention for multi-subject scenes), an **Auto -Montage** trailer builder, a **Temp files** browser, **reconnect-after-reload** for in-flight -generations, and a Blackwell (sm_120) guide-scene crash fix — see the [CHANGELOG](CHANGELOG.md) -for the full list. - -**3.4.0** brings **Easy Gen** to near feature-parity with the Cutting Room for the workflows -it targets: shortcut/transition library import/export, the full Engine settings panel -(including Best-FaceID), a Gallery picker with a one-click continuity pin, Save/Export buttons, -and several bugfixes (a bypass toggle that could silently do nothing, a state-sync bug that -could revert Models & Pipeline edits, and more) — see the [CHANGELOG](CHANGELOG.md) for the -full list. - -**3.4.1** adds a **second sampling pass** on the Chain Sampler — give it a schedule and every -scene is sampled twice, with an optional latent sharpen/2× upscale between the passes — plus -**cut the opening** for i2v scenes (keep the anchor's identity transfer at full strength, then -cut the reference still out of the finished clip), **context windows** for scenes longer than -the model's comfortable window, and a progress readout that says which scene and which pass is -running. Context windows, which never actually worked before, are fixed — see the -[CHANGELOG](CHANGELOG.md) for the full list. - -**3.5.0** adds a **second model family**: MiniMax H3 alongside LTX-2 / LTXAV. A project picks a -family, and everything downstream follows from that choice — which nodes the graph emits, which -model files the setup asks for, which sampler settings are even applicable, and what counts as a -valid scene length. Nothing about LTX-2 changes. - -**3.5.1 "Auspicious Asparagus"** is the first release with a codename, and a -compatibility-and-polish pass on top of 3.5.0. **LTX-2.5** works — it reuses the same model -classes behind new config flags, so almost everything binds unchanged, and the two places that -would have broken *silently* are fixed. **Settings ▸ About** now reports the machine ComfyUI -runs on (chip, memory, GPU and VRAM, disk, OS, Python, torch, and which fast-attention backend -is actually installed), which is the thing you want at a glance on a fresh rental. **ALG** runs -on any sampler rather than only FunPack's Distilled Flow, and its two duplicate switches became -one. **`cut_opening_frames`** no longer leaves a noisy first frame — it cuts decoded pixels -instead of latents, and the count is now exact. See the [CHANGELOG](CHANGELOG.md) for the full -list. - -See [`docs/MovieEditor.md`](docs/MovieEditor.md) for complete Cutting Room documentation. +Feel free to test and leave feedback regarding v4.0.0 by switching branch to "v4" via internal feature inside "Settings" -> "Updates and ComfyUI" -> "Switch branch". ## Installation @@ -127,31 +42,13 @@ Install them with: FunPack uses your existing ComfyUI/PyTorch install. The expected baseline is `transformers >= 5.0.0` -`hpsv3` is optional and only used by the `FunPack StoryMem Keyframe Extractor` quality filter, so it is not installed by default. - -Install it manually only if you need that feature: - -`pip3 install hpsv3 --no-build-isolation` - -## Important Note About `hpsv3` - -Installing `hpsv3` can break `Prompt Enhancer` and `Story Writer`, because `hpsv3` depends on a `transformers` version that conflicts with the version those LLM-based nodes require. - -FunPack's LLM nodes require `transformers >= 5.0`. The version required for `hpsv3` is strictly `transformers==4.45.2`. Installing any version different from it will result in broken quality detector. - -If you install `hpsv3`, use `--no-build-isolation`. Optionally, specify the exact version - `pip install transformers==4.45.2 --no-build-isolation`. - ## Documentation -Per-node documentation is available in the [`docs`](docs) folder. +To understand how to use FunPack Cutting Room, please consider walking through the Interactive Guide. -Start with: +It's available in the end of Project Setup Wizard or at anytime from the top bar menu - Help -> Welcome tour. -- [`docs/MovieEditor.md`](docs/MovieEditor.md) for the FunPack Cutting Room (Movie Editor) -- [`docs/FunPackVideoRefinerV2.md`](docs/FunPackVideoRefinerV2.md) for `FunPack Video Refiner V2` -- [`docs/FunPackVideoRefinerV2QuickGuide.md`](docs/FunPackVideoRefinerV2QuickGuide.md) for a short Discord-friendly Refiner V2 guide -- [`docs/FunPackLTXAVSceneChainSampler.md`](docs/FunPackLTXAVSceneChainSampler.md) for split-scene LTXV/LTXAV continuation -- [`docs/FunPackLoraWorkflow.md`](docs/FunPackLoraWorkflow.md) for the LoRA/refiner helper workflow +Additional information can be found in [docs folder](https://github.com/digital-garbage/ComfyUI-FunPack/tree/main/docs). Version history is available in [CHANGELOG.md](CHANGELOG.md). @@ -161,8 +58,6 @@ If you have suggestions, questions, or ideas for new features, feel free to open ## Intent -FunPack is a hobby project, provided to you by a fellow AI enthusiast who "lives in the trenches" and knows exactly what people seek in video/audio generation workflows. - FunPack is provided under GNU General Public License V3, which gives you broad rights to use, modify and distribute the original/modified version of it as long as the original license text is included. FunPack places no limitations on types of content you can generate by using it, meaning both SFW and NSFW content are fine as long as you don't violate your local laws. GPLv3 does not grant you rights for such violations. However, I do not endorse using FunPack and/or demonstrating it alongside morally and legally questionable/prohibited content, including: