malkuthro
27705be037
* feat(sidebar): add onboarding guide * docs(guide): clarify tag search casing * docs(guide): clarify workflow save copy * docs(guide): refine sidebar visuals * docs(guide): refresh save snapshot visual * docs(guide): refresh load snapshot visual * docs(guide): refresh module save visual * docs(guide): use real sidebar screenshot * docs(guide): render sidebar overview screenshot directly * docs(guide): soften sidebar overview annotations * docs(guide): clarify nodes action bar callout * docs(guide): clarify workflow action bar callout * docs(guide): simplify sidebar overview markers * docs(guide): align sidebar overview intro * docs(guide): use real snapshot recipe screenshots * docs(guide): simplify project workflow diagram * docs(guide): make function cards scannable * docs(guide): sketch module recipe icon focus * docs(guide): use real icon screenshot for module recipe * docs(guide): add cropped workflow action screenshot * docs(guide): use full toolbar screenshot for module recipe * docs(guide): use real search screenshot * docs(guide): use real node search screenshot * docs(guide): standardize screenshot recipe cards * docs(guide): tighten recipe callout styling * docs: require visual QA for UI work * docs(guide): address pass-2 review nits
87 lines
3.3 KiB
Markdown
87 lines
3.3 KiB
Markdown
# ComfyUI-Koolook
|
|
|
|
Kforge Labs for ComfyUI: a project-kit sidebar plus Koolook nodes for VFX,
|
|
image, and video workflows.
|
|
|
|
The main experience is the **Kforge Labs sidebar**. It helps you keep a
|
|
project setup together: favorite nodes, saved workflows, reusable modules,
|
|
tags, snapshots, and recovery tools.
|
|
|
|
## Kforge Labs Sidebar
|
|
|
|
Use the sidebar as a reusable project kit.
|
|
|
|
| Feature | What it does |
|
|
|---|---|
|
|
| **Snapshots** | Save and load the whole Kforge Labs state: favorite nodes, workflows, modules, tags, archive, and recovery data. |
|
|
| **Search** | Find nodes, workflows, directories, and tags from one field. Tags keep exact capitalization, so `Depth` and `depth` can be separate folders. |
|
|
| **Nodes** | Keep favorite nodes close, grouped by theme or repository name. |
|
|
| **Workflows** | Save the whole script, save a selection of nodes, load workflows, or insert saved modules into the current canvas. |
|
|
| **Recovery** | Use autosaves, starter presets, snapshot library settings, and missing-pack install helpers. |
|
|
|
|
New users should start with the bundled visual guide:
|
|
[`web/guide/index.html`](web/guide/index.html)
|
|
|
|
Inside ComfyUI, open it from the Kforge Labs sidebar with **Tools → Info**.
|
|
|
|
## Included Nodes
|
|
|
|
| Node ID | Display name | Category |
|
|
|---|---|---|
|
|
| `EasyWan22Prompt` | Wan 2.2 Easy Prompt (Koolook) | `Koolook/Wan_Video` |
|
|
| `EasyResize_Koolook` | Easy Resize (Koolook) | `Koolook/Image` |
|
|
| `EasyAIPipeline` | Easy AI Pipeline (Koolook) | `Koolook/Pipeline` |
|
|
| `easy_ImageBatch` | Easy Image Batch (Koolook) | `Koolook/Image` |
|
|
| `KoolookLoadCameraPosesAbsolute` | Koolook Load Camera Poses (Absolute Path) | `Koolook/Camera` |
|
|
| `Easy_hdr_VAE_encode` | Easy HDR VAE Encode (Koolook) | `Koolook/VAE` |
|
|
| `Easy_hdr_VAE_decode` | Easy HDR VAE Decode (Koolook) | `Koolook/VAE` |
|
|
|
|
The root Koolook nodes and the slim Radiance Koolook VAE wrappers have no
|
|
extra Python dependencies beyond `torch`, which ComfyUI already requires.
|
|
|
|
## Install
|
|
|
|
### ComfyUI-Manager
|
|
|
|
1. Open ComfyUI Manager.
|
|
2. Choose **Install Custom Nodes**.
|
|
3. Install by Git URL:
|
|
`https://github.com/malkuthro/ComfyUI-Koolook.git`
|
|
4. Restart ComfyUI.
|
|
5. Open the **Kforge Labs** sidebar tab.
|
|
|
|
### Manual
|
|
|
|
Clone this repository into `ComfyUI/custom_nodes/`:
|
|
|
|
```bash
|
|
git clone https://github.com/malkuthro/ComfyUI-Koolook.git
|
|
```
|
|
|
|
Restart ComfyUI after installation.
|
|
|
|
## Learn More
|
|
|
|
- **Visual sidebar guide:** [`web/guide/index.html`](web/guide/index.html)
|
|
- **User guide:** [`docs/user_guide/`](docs/user_guide/)
|
|
- **Change history:** [`CHANGELOG.md`](CHANGELOG.md)
|
|
- **Maintainer docs:** [`docs/maintainers/`](docs/maintainers/)
|
|
- **Fork attribution and provenance:** [`forks/THIRD_PARTY.md`](forks/THIRD_PARTY.md)
|
|
- **Versioning reference:** [`docs/reference/versioning.md`](docs/reference/versioning.md)
|
|
|
|
## Stability
|
|
|
|
For production work, install a pinned release tag or commit instead of following
|
|
a moving branch head. Node IDs are treated carefully so saved ComfyUI workflows
|
|
continue to load across compatible updates.
|
|
|
|
## License
|
|
|
|
**GPL-3.0**. See [`LICENSE`](LICENSE).
|
|
|
|
This package incorporates and adapts GPL-3.0 code from
|
|
[fxtdstudios/radiance](https://github.com/fxtdstudios/radiance) under
|
|
`forks/radiance_koolook/`. Attribution and per-fork modification notes are
|
|
tracked in [`forks/THIRD_PARTY.md`](forks/THIRD_PARTY.md) and
|
|
[`forks/forks_manifest.yaml`](forks/forks_manifest.yaml).
|