alphard/Comfyui-LayerForge
1
0
Fork 0
mirror of https://github.com/Azornes/Comfyui-LayerForge.git synced 2026-03-21 20:52:12 -03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Dariusz L
2025-06-28 06:50:32 +02:00
parent f08214e224
commit a7208cb504
1 changed files with 90 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
README.md
View File

@@ -1,13 +1,26 @@
<h1 align="center">LayerForge – Advanced Canvas Editor for ComfyUI 🎨</h1>
---
# LayerForge – Advanced Canvas Editor for ComfyUI 🎨
<p align="center"><i>LayerForge is an advanced canvas node for ComfyUI, providing a Photoshop-like layer-based editing experience directly within your workflow. It extends the concept of a simple canvas with multi-layer support, masking, blend modes, precise transformations, and seamless integration with other nodes.</i></p>
**LayerForge** is an advanced canvas node for ComfyUI, providing a Photoshop-like layer-based editing experience directly within your workflow. It extends the concept of a simple canvas with multi-layer support, masking, blend modes, precise transformations, and seamless integration with other nodes.
<p align="center">
<a href="https://github.com/Azornes/ocrTranslator/releases">
<img alt="Downloads" src="https://img.shields.io/badge/dynamic/json?color=2F80ED&label=Downloads&query=$.downloads&url=https://api.comfy.org/nodes/layerforge&style=for-the-badge">
</a>
<a href="https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2FAzornes%2FComfyui-LayerForge">
<img src="https://api.visitorbadge.io/api/combined?path=https%3A%2F%2Fgithub.com%2FAzornes%2FComfyui-LayerForge&countColor=%2337d67a&style=for-the-badge&labelStyle=none" />
</a>
<img alt="Python 3.10+" src="https://img.shields.io/badge/-Python_3.10+-4B8BBE?logo=python&logoColor=FFFFFF&style=for-the-badge&logoWidth=20">
<img alt="JavaScript" src="https://img.shields.io/badge/-JavaScript-000000?logo=javascript&logoColor=F7DF1E&style=for-the-badge&logoWidth=20">
</p>
### Why LayerForge?
- **Full Creative Control:** Move beyond simple image inputs. Composite, mask, and blend multiple elements without leaving ComfyUI.
- **Seamless Integration:** Outputs a final image and a corresponding mask, ready to be piped into any other node (e.g., `VAEEncode`, `Apply Mask`).
- **Intuitive UI:** Familiar controls like drag-and-drop, keyboard shortcuts, and a pannable/zoomable viewport make editing fast and easy.
- **Full Creative Control:** Move beyond simple image inputs. Composite, mask, and blend multiple elements without
leaving ComfyUI.
- **Seamless Integration:** Outputs a final image and a corresponding mask, ready to be piped into any other node (e.g.,
`VAEEncode`, `Apply Mask`).
- **Intuitive UI:** Familiar controls like drag-and-drop, keyboard shortcuts, and a pannable/zoomable viewport make
editing fast and easy.
---
@@ -18,33 +31,36 @@
## ✨ Key Features
- **Persistent & Stateful:** Your work is automatically saved to the browser's IndexedDB, preserving your full canvas state (layers, positions, etc.) even after a page reload.
- **Multi-Layer Editing:** Add, arrange, and manage multiple image layers with z-ordering.
- **Advanced Masking Tool:** A dedicated masking mode with adjustable brush size, strength, and softness. Masks have their own separate undo/redo history.
- **Full Transformation Controls:** Precisely move, scale, and rotate layers with mouse or keyboard shortcuts.
- **Blend Modes & Opacity:** Apply 12 common blend modes (`Overlay`, `Multiply`, etc.) and adjust opacity on a per-layer basis via a context menu.
- **Comprehensive Undo/Redo:** Full history support for both layer manipulations and mask drawing.
- **Seamless I/O:**
- **Drag & Drop** image files to create new layers.
- **Copy & Paste** images directly from your system clipboard.
- Import the last generated image from your workflow with one click.
- **AI-Powered Matting:** Optional background removal for any layer using the `BiRefNet` model.
- **Efficient Memory Management:** An automatic garbage collection system cleans up unused image data to keep the browser's storage footprint low.
- **Workflow Integration:** Outputs a final composite **image** and a combined alpha **mask**, ready for any other ComfyUI node.
- **Persistent & Stateful:** Your work is automatically saved to the browser's IndexedDB, preserving your full canvas
state (layers, positions, etc.) even after a page reload.
- **Multi-Layer Editing:** Add, arrange, and manage multiple image layers with z-ordering.
- **Advanced Masking Tool:** A dedicated masking mode with adjustable brush size, strength, and softness. Masks have
their own separate undo/redo history.
- **Full Transformation Controls:** Precisely move, scale, and rotate layers with mouse or keyboard shortcuts.
- **Blend Modes & Opacity:** Apply 12 common blend modes (`Overlay`, `Multiply`, etc.) and adjust opacity on a per-layer
basis via a context menu.
- **Comprehensive Undo/Redo:** Full history support for both layer manipulations and mask drawing.
- **Seamless I/O:**
- **Drag & Drop** image files to create new layers.
- **Copy & Paste** images directly from your system clipboard.
- Import the last generated image from your workflow with one click.
- **AI-Powered Matting:** Optional background removal for any layer using the `BiRefNet` model.
- **Efficient Memory Management:** An automatic garbage collection system cleans up unused image data to keep the
browser's storage footprint low.
- **Workflow Integration:** Outputs a final composite **image** and a combined alpha **mask**, ready for any other
ComfyUI node.
---
## 🚀 Installation
1. Navigate to your ComfyUI `custom_nodes` directory.
1. Install [ComfyUi](https://github.com/comfyanonymous/ComfyUI).
2. Clone this repo into `custom_modules`:
```bash
cd ComfyUI/custom_nodes/
git clone https://github.com/Azornes/Comfyui-LayerForge.git
```
2. Clone this repository:
```bash
git clone https://github.com/Azornes/Comfyui-LayerForge
```
3. Restart ComfyUI.
3. Start up ComfyUI.
---
@@ -52,97 +68,70 @@
### Canvas Control
| Action | Description |
|--------|-------------|
| `Click + Drag` | Pan canvas view |
| `Mouse Wheel` | Zoom view in/out |
| Action | Description |
|------------------------------|----------------------------|
| `Click + Drag` | Pan canvas view |
| `Mouse Wheel` | Zoom view in/out |
| `Shift + Click (background)` | Start resizing canvas area |
| `Shift + Ctrl + Click` | Start moving entire canvas |
| `Double Click (background)` | Deselect all layers |
| `Shift + Ctrl + Click` | Start moving entire canvas |
| `Double Click (background)` | Deselect all layers |
### Clipboard & I/O
| Action | Description |
|--------|-------------|
| `Ctrl + C` | Copy selected layer(s) |
| `Ctrl + V` | Paste from clipboard (image or internal layers) |
| `Drag & Drop Image File` | Add image as a new layer |
| Action | Description |
|--------------------------|-------------------------------------------------|
| `Ctrl + C` | Copy selected layer(s) |
| `Ctrl + V` | Paste from clipboard (image or internal layers) |
| `Drag & Drop Image File` | Add image as a new layer |
### Layer Interaction
| Action | Description |
|--------|-------------|
| `Click + Drag` | Move selected layer(s) |
| `Ctrl + Click` | Add/Remove layer from selection |
| `Alt + Drag` | Clone selected layer(s) |
| `Shift + Click` | Show blend mode & opacity menu |
| `Mouse Wheel` | Scale layer (snaps to grid) |
| `Ctrl + Mouse Wheel` | Fine-scale layer |
| `Shift + Mouse Wheel` | Rotate layer by 5° |
| `Arrow Keys` | Nudge layer by 1px |
| `Shift + Arrow Keys` | Nudge layer by 10px |
| `[` or `]` | Rotate by 1° |
| `Shift + [` or `]` | Rotate by 10° |
| `Delete` | Delete selected layer(s) |
| Action | Description |
|-----------------------|---------------------------------|
| `Click + Drag` | Move selected layer(s) |
| `Ctrl + Click` | Add/Remove layer from selection |
| `Alt + Drag` | Clone selected layer(s) |
| `Shift + Click` | Show blend mode & opacity menu |
| `Mouse Wheel` | Scale layer (snaps to grid) |
| `Ctrl + Mouse Wheel` | Fine-scale layer |
| `Shift + Mouse Wheel` | Rotate layer by 5° |
| `Arrow Keys` | Nudge layer by 1px |
| `Shift + Arrow Keys` | Nudge layer by 10px |
| `[` or `]` | Rotate by 1° |
| `Shift + [` or `]` | Rotate by 10° |
| `Delete` | Delete selected layer(s) |
### Transform Handles (on selected layer)
| Action | Description |
|--------|-------------|
| `Drag Corner/Side` | Resize layer |
| `Drag Rotation Handle` | Rotate layer |
| `Hold Shift` | Keep aspect ratio / Snap rotation to 15° |
| `Hold Ctrl` | Snap to grid |
| Action | Description |
|------------------------|------------------------------------------|
| `Drag Corner/Side` | Resize layer |
| `Drag Rotation Handle` | Rotate layer |
| `Hold Shift` | Keep aspect ratio / Snap rotation to 15° |
| `Hold Ctrl` | Snap to grid |
### Mask Mode
| Action | Description |
|--------|-------------|
| `Click + Drag` | Paint on the mask |
| `Middle Mouse Button + Drag` | Pan canvas view |
| `Mouse Wheel` | Zoom view in/out |
| **Brush Controls** | Use sliders to control brush **Size**, **Strength**, and **Softness** |
| **Clear Mask** | Remove the entire mask |
| **Exit Mode** | Click the "Draw Mask" button again |
---
## 🛠️ Basic Workflow
1. Add the **LayerForge** node to your graph.
2. Use the **"Add Image"** button or **Drag & Drop** a file to create a layer.
3. Use the **"Import Input"** button to load the last generated image from your workflow.
4. Arrange, resize, and blend your layers as needed.
5. Connect the outputs to other nodes:
- `image` -> `VAE Encode` (for further processing)
- `mask` -> `Apply Mask` or `Set Latent Noise Mask`
```
┌────────────────┐
│ Load Image │
└───────┬────────┘
│
┌───────▼────────┐ ┌──────────────┐
│ LayerForge ├──────► VAE Encode │
│(output: image) │ └──────────────┘
└───────┬────────┘
│
┌───────▼────────┐ ┌──────────────┐
│(output: mask) ├──────► Apply Mask │
└────────────────┘ └──────────────┘
```
---
| Action | Description |
|------------------------------|-----------------------------------------------------------------------|
| `Click + Drag` | Paint on the mask |
| `Middle Mouse Button + Drag` | Pan canvas view |
| `Mouse Wheel` | Zoom view in/out |
| **Brush Controls** | Use sliders to control brush **Size**, **Strength**, and **Softness** |
| **Clear Mask** | Remove the entire mask |
| **Exit Mode** | Click the "Draw Mask" button again |
## 🧠 Optional: Matting Model (for image cutout)
The "Matting" feature allows you to automatically generate a cutout (alpha mask) for a selected layer. This is an optional feature and requires a model.
The "Matting" feature allows you to automatically generate a cutout (alpha mask) for a selected layer. This is an
optional feature and requires a model.
> - **Model Name**: `BiRefNet`
> - **Download from**:
> - [Hugging Face](https://huggingface.co/ZhengPeng7/BiRefNet/tree/main) (Recommended)
> - [Google Drive](https://drive.google.com/drive/folders/1BCLInCLH89fmTpYoP8Sgs_Eqww28f_wq?usp=sharing)
> - **Installation Path**: Place the model file in `ComfyUI/models/BiRefNet/`.
> - **Model Name**: `BiRefNet`
> - **Download from**:
>
- [Hugging Face](https://huggingface.co/ZhengPeng7/BiRefNet/tree/main) (Recommended)
> - [Google Drive](https://drive.google.com/drive/folders/1BCLInCLH89fmTpYoP8Sgs_Eqww28f_wq?usp=sharing)
> - **Installation Path**: Place the model file in `ComfyUI/models/BiRefNet/`.
---
@@ -152,4 +141,5 @@ This project is licensed under the MIT License. Feel free to use, modify, and di
---
Based on the original [**Comfyui-Ycanvas**](https://github.com/yichengup/Comfyui-Ycanvas) by yichengup. This fork significantly enhances the editing capabilities for practical compositing workflows inside ComfyUI.
Based on the original [**Comfyui-Ycanvas**](https://github.com/yichengup/Comfyui-Ycanvas) by yichengup. This fork
significantly enhances the editing capabilities for practical compositing workflows inside ComfyUI.