Update README and pyproject.toml for ComfyUI Manager submission

Add full documentation with usage examples and wire-up guide.
Fill in repository URL and publisher ID in pyproject.toml.
This commit is contained in:
DaPaLi
2026-03-17 07:33:06 +01:00
parent 8df777ce99
commit 36153acd78
2 changed files with 63 additions and 30 deletions
+60 -27
View File
@@ -1,50 +1,83 @@
# ComfyUI Block Bypass Switch
A custom node pack for ComfyUI that lets you bypass or mute entire node groups with a single click.
A custom node pack for ComfyUI that lets you **bypass or mute entire node groups with a single click** — no rewiring needed.
## Features
- **⚡ Block Bypass Switch** — A node that routes your signal either through a block or directly around it via a one-click toggle
- **⚡ Group Bypass (Right-click)** — Right-click any group in your workflow to bypass, mute, or activate all nodes inside it
- **⚡ Group Bypass Panel** — A floating panel with a dropdown listing all groups in your workflow, with Bypass / Mute / Activate buttons
## Compatibility
- ComfyUI Node Spec 2.0 (new frontend)
- Falls back automatically to legacy ComfyUI versions
| Feature | Description |
|---------|-------------|
| **⚡ Block Bypass Switch** | Node that routes your signal either through a block or directly around it via a one-click toggle |
| **⚡ Group Bypass (Right-click)** | Right-click any group on the canvas to bypass, mute, or activate all nodes inside it |
| **⚡ Group Bypass Panel** | Floating panel with a dropdown listing all groups — apply Bypass / Mute / Activate in one click |
## Installation
### Option A — Manual
1. Download or clone this repository
### Option A — ComfyUI Manager (recommended)
1. Open **ComfyUI Manager**
2. Search for `Block Bypass Switch`
3. Click **Install** and restart ComfyUI
### Option B — Manual
1. Clone or download this repository
2. Copy the `comfyui-block-bypass` folder into your `ComfyUI/custom_nodes/` directory
3. Restart ComfyUI
### Option B — ComfyUI Manager
Search for `Block Bypass Switch` in the ComfyUI Manager and install directly.
## Usage
### Block Bypass Switch Node
Find it under `utils/bypass` → `⚡ Block Bypass Switch`
| Input | Description |
|-------|-------------|
| `direct_in` | Signal **before** your block |
| `block_out` | Signal **after** your block |
| `bypass` | Toggle: ON = skip block, OFF = use block |
Find it under **`utils/bypass`** → **`⚡ Block Bypass Switch`**
Wire it up like this:
```
[Node Before Block] ──► direct_in ──┐
├──► output ──► [Rest of workflow]
[Block Output] ──► block_out ──┘
bypass = ON → signal goes around the block (direct_in)
bypass = OFF → signal goes through the block (block_out)
```
| Input | Type | Description |
|-------|------|-------------|
| `direct_in` | ANY | Signal **before** your block |
| `block_out` | ANY | Signal **after** your block |
| `bypass` | BOOLEAN | ON = skip block · OFF = use block |
| Output | Type | Description |
|--------|------|-------------|
| `output` | ANY | The selected signal |
---
### Group Bypass Panel
After installing, a **`⚡ Gruppen`** button appears at the bottom center of your ComfyUI window.
Click it to open the panel:
- Select a group from the dropdown
- Click **⚡ Bypass**, **🔇 Mute**, or **✅ Aktiv**
- Use **↻** to refresh the group list after renaming groups
After installing, a **`⚡ Gruppen`** button appears at the **bottom center** of your ComfyUI window.
1. Click **`⚡ Gruppen`** to open the panel
2. Select a group from the dropdown
3. Click one of:
- **⚡ Bypass** — skip all nodes in the group
- **🔇 Mute** — mute all nodes in the group
- **✅ Aktiv** — re-enable all nodes in the group
4. Use **↻** to refresh the list after renaming groups
---
### Right-click Group Menu
Right-click any group directly on the canvas for quick bypass/mute/activate options.
Right-click directly on any group frame on the canvas for quick access:
- **⚡ Gruppe bypassen** / **✅ Gruppe aktivieren**
- **🔇 Gruppe muten** / **✅ Gruppe aktivieren**
---
## Compatibility
- ComfyUI (new frontend, Node Spec 2.0)
- Automatic fallback for legacy ComfyUI versions
## License
MIT
[MIT](LICENSE)
+3 -3
View File
@@ -4,9 +4,9 @@ version = "1.0.0"
description = "1-Klick Block Bypass Switch Node für ComfyUI"
[project.urls]
Repository = ""
Repository = "https://github.com/DaPaLi/comfyui-block-bypass"
[tool.comfy]
PublisherId = ""
DisplayName = "Block Bypass Switch"
PublisherId = "DaPaLi"
DisplayName = "ComfyUI Block Bypass Switch"
Icon = ""