mirror of
https://github.com/Azornes/Comfyui-LayerForge.git
synced 2026-03-21 20:52:12 -03:00
Update README with new features and controls
Expanded the feature list to include persistent state, advanced masking, AI-powered matting, memory management, and improved workflow integration. Rewrote and reorganized the controls section for clarity, adding new shortcuts and detailed descriptions for canvas, layer, clipboard, and mask mode interactions.
This commit is contained in:
Dariusz L
99
README.md
99
README.md
@@ -18,15 +18,19 @@
|
|||||||
|
|
||||||
## ✨ Key Features
|
## ✨ Key Features
|
||||||
|
|
||||||
- **Multi-Layer Editing:** Add, arrange, and manage multiple image layers.
|
- **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.
|
||||||
- **Full Transformation Controls:** Move, scale, and rotate layers with mouse or keyboard shortcuts.
|
- **Multi-Layer Editing:** Add, arrange, and manage multiple image layers with z-ordering.
|
||||||
- **Blend Modes & Opacity:** Apply 12 common blend modes (`Overlay`, `Multiply`, etc.) and adjust opacity on a per-layer basis.
|
- **Advanced Masking Tool:** A dedicated masking mode with adjustable brush size, strength, and softness. Masks have their own separate undo/redo history.
|
||||||
- **Drag & Drop:** Drop image files directly onto the canvas to create new layers.
|
- **Full Transformation Controls:** Precisely move, scale, and rotate layers with mouse or keyboard shortcuts.
|
||||||
- **Precise Alignment:** Snap layers to a grid (`Ctrl` key) for perfect positioning.
|
- **Blend Modes & Opacity:** Apply 12 common blend modes (`Overlay`, `Multiply`, etc.) and adjust opacity on a per-layer basis via a context menu.
|
||||||
- **Dynamic Canvas:** Resize the entire canvas with a live preview of the new dimensions.
|
- **Comprehensive Undo/Redo:** Full history support for both layer manipulations and mask drawing.
|
||||||
- **Workflow Integration:**
|
- **Seamless I/O:**
|
||||||
- Import the last generated image directly into a layer.
|
- **Drag & Drop** image files to create new layers.
|
||||||
- Outputs a final composite **image** and a combined alpha **mask**.
|
- **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.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -44,33 +48,62 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🖱️ Controls
|
## 🎮 Controls & Shortcuts
|
||||||
|
|
||||||
### Layer Controls (When one or more layers are selected)
|
### Canvas Control
|
||||||
|
|
||||||
| Action | Description |
|
| Action | Description |
|
||||||
| ------------------------- | ------------------------------------------------------------------------ |
|
|--------|-------------|
|
||||||
| **Mouse Drag** | Move selected layer(s). |
|
| `Click + Drag` | Pan canvas view |
|
||||||
| `Ctrl` + **Mouse Drag** | Move selected layer(s) with **grid snapping**. |
|
| `Mouse Wheel` | Zoom view in/out |
|
||||||
| `Ctrl` + **Click** | Add or remove a layer from the current selection. |
|
| `Shift + Click (background)` | Start resizing canvas area |
|
||||||
| **Mouse Wheel** | Scale selected layer(s) up or down. |
|
| `Shift + Ctrl + Click` | Start moving entire canvas |
|
||||||
| `Shift` + **Mouse Wheel** | Rotate selected layer(s). |
|
| `Double Click (background)` | Deselect all layers |
|
||||||
| `Shift` + **Click** | Open the **Blend Mode & Opacity** menu for the clicked layer. |
|
|
||||||
| `Delete` Key | Remove all selected layers. |
|
|
||||||
| **Arrow Keys** | Nudge selected layer(s) by 1 pixel. |
|
|
||||||
| `Shift` + **Arrow Keys** | Nudge selected layer(s) by 10 pixels. |
|
|
||||||
| `[` / `]` Keys | Rotate selected layer(s) by 1 degree. |
|
|
||||||
| `Shift` + `[` / `]` Keys | Rotate selected layer(s) by 10 degrees. |
|
|
||||||
|
|
||||||
### Canvas & Global Controls
|
### Clipboard & I/O
|
||||||
|
|
||||||
| Action | Description |
|
| Action | Description |
|
||||||
| --------------------------- | ------------------------------------------------------------ |
|
|--------|-------------|
|
||||||
| **Drag Background** | Pan the canvas viewport. |
|
| `Ctrl + C` | Copy selected layer(s) |
|
||||||
| **Mouse Wheel** | Zoom the viewport in or out (centered on the cursor). |
|
| `Ctrl + V` | Paste from clipboard (image or internal layers) |
|
||||||
| **Drag & Drop Image File** | Add a new image layer from a file on your disk. |
|
| `Drag & Drop Image File` | Add image as a new layer |
|
||||||
| `Shift` + **Drag Empty Space** | Define a new canvas size with a live preview. |
|
|
||||||
| **Double-Click Empty Space** | Deselect all layers. |
|
### 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) |
|
||||||
|
|
||||||
|
### 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 |
|
||||||
|
|
||||||
|
### 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 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -119,4 +152,4 @@ 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.
|
||||||
|
|||||||
Reference in New Issue
Block a user