pixelworld AIandClaude Opus 4.6
25ad75758e
Wraps Niko Pueringer's CorridorKey neural network keyer as ComfyUI custom nodes. Includes Load Model, Greenscreen, Chroma Key Prepass, and Composite nodes. CorridorKey is installed as a pip dependency with auto-download of the model checkpoint from HuggingFace. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
51 lines
3.1 KiB
Markdown
51 lines
3.1 KiB
Markdown
# ComfyUI-CorridorKey
|
|
|
|
Custom ComfyUI nodes for [CorridorKey](https://github.com/nikopueringer/CorridorKey) — the neural network green screen keyer by [Niko Pueringer](https://github.com/nikopueringer) and [Corridor Crew](https://www.youtube.com/@Corridor).
|
|
|
|
CorridorKey solves the color unmixing problem that traditional keyers struggle with. For every pixel — even highly transparent ones like motion blur or out-of-focus edges — the model predicts the true foreground color and a clean alpha channel, as if the green screen was never there.
|
|
|
|
## Nodes
|
|
|
|
| Node | Description |
|
|
|------|-------------|
|
|
| **Load CorridorKey Model** | Load the GreenFormer neural network. The model checkpoint (~300MB) is auto-downloaded from HuggingFace on first use. |
|
|
| **CorridorKey Greenscreen** | Run inference on green screen footage. Takes an image and a coarse alpha hint, outputs a clean alpha, foreground, RGBA, and composite preview. |
|
|
| **Chroma Key Prepass** | Fast chroma key that generates a coarse alpha hint from green/blue screen footage. Designed as input to CorridorKey Greenscreen. |
|
|
| **CorridorKey Composite** | Composite a keyed foreground over a background with proper linear-space blending and sRGB output. |
|
|
|
|
## Installation
|
|
|
|
### Via ComfyUI Manager
|
|
|
|
Search for **ComfyUI-CorridorKey** in the ComfyUI Manager and install.
|
|
|
|
### Manual
|
|
|
|
```bash
|
|
cd ComfyUI/custom_nodes
|
|
git clone https://github.com/pixelworldai/ComfyUI-CorridorKey.git
|
|
cd ComfyUI-CorridorKey
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
The CorridorKey model checkpoint is automatically downloaded to `ComfyUI/models/corridorkey/` on first use. You can also place a `.pth` file there manually.
|
|
|
|
## Usage
|
|
|
|
1. **Load CorridorKey Model** — loads the model onto your GPU
|
|
2. **Chroma Key Prepass** — feed in your green screen footage to generate a rough alpha hint (or bring your own from any roto/keying tool)
|
|
3. **CorridorKey Greenscreen** — connect the model, your image, and the alpha hint to get a clean key
|
|
4. **CorridorKey Composite** (optional) — composite the result over a background
|
|
|
|
The alpha hint does not need to be precise. CorridorKey was trained on coarse, blurry, eroded masks and excels at filling in fine detail from rough hints.
|
|
|
|
## Credits & Acknowledgements
|
|
|
|
**CorridorKey** was created by [Niko Pueringer](https://github.com/nikopueringer) at [Corridor Digital](https://corridordigital.com). The core model, inference engine, and all neural network architecture are entirely his work. This node pack is a ComfyUI wrapper around the original [CorridorKey](https://github.com/nikopueringer/CorridorKey) project.
|
|
|
|
Join the [Corridor Creates Discord](https://discord.gg/zvwUrdWXJm) to share ideas, results, and contribute to CorridorKey's development.
|
|
|
|
## License
|
|
|
|
The CorridorKey model and engine are licensed under the [Corridor Key Licence](https://github.com/nikopueringer/CorridorKey/blob/main/LICENSE) (CC BY-NC-SA 4.0 with additional terms). You may use this tool for processing images as part of commercial projects, but you may not repackage and sell the tool itself or offer inference as a paid API service. See the full license for details.
|