175 lines
5.0 KiB
Markdown
175 lines
5.0 KiB
Markdown
<div align="center">
|
||
<img src="imgs/extralinks_logo.png">
|
||
</div><br>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
A one-click collection of alternate connection styles for ComfyUI.
|
||
|
||
------------------------------------------------------------------
|
||
|
||
<div align="center">
|
||
<img width=750 src="imgs/extralinks.png">
|
||
</div>
|
||
|
||
------------------------------------------------------------------
|
||
|
||
Different types of **link connections**, **geometry awareness**, and routed **Trace** links.
|
||
|
||
<div align="center">
|
||
<img width=250 src="imgs/curved.png">
|
||
<img width=250 src="imgs/manhattan.png">
|
||
<img width=250 src="imgs/subway.png">
|
||
</div>
|
||
|
||
<div align="center">
|
||
<img width=750 src="imgs/geometry_awareness_sample.gif">
|
||
</div>
|
||
|
||
<div align="center">
|
||
<img width=750 src="imgs/trace.png">
|
||
</div>
|
||
|
||
## Requirements
|
||
|
||
**ComfyUI frontend**: ≥ **1.27.1** (new link renderer API)
|
||
|
||
> On older ComfyUI versions, use ExtraLinks v0.0.2 (see Compatibility).
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Installation
|
||
|
||
### Git Clone
|
||
|
||
```powershell
|
||
cd ComfyUI\custom_nodes
|
||
git clone https://github.com/edoardocarmignani/extralinks.git
|
||
```
|
||
|
||
Restart ComfyUI.
|
||
|
||
### ComfyUI Manager
|
||
|
||
Go to **Custom Nodes Manager** and search for **Extra Links**, install and restart ComfyUI.
|
||
|
||
### Comfy CLI
|
||
|
||
```powershell
|
||
comfy node install extralinks
|
||
```
|
||
|
||
Restart ComfyUI.
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Usage
|
||
|
||
Open **Settings** → **Extra Links** and configure:
|
||
|
||
- **Enable**: toggle on/off
|
||
- **Shape**: `Curved` | `Manhattan` | `Subway` | `Trace`
|
||
- **Radius**: corner smoothing
|
||
- **Offset**: horizontal separation for multi-outputs
|
||
- **Curvature**: strength of turn-in/out
|
||
|
||
Changes apply immediately to the canvas.
|
||
|
||
### Trace
|
||
|
||
`Trace` routes links with mostly 90° and 45° segments, rounded corners, and node-aware obstacle routing. It avoids the center marker used by the other link styles.
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Compatibility
|
||
|
||
| ExtraLinks version | ComfyUI frontend | Notes |
|
||
|--------------------|------------------|-------|
|
||
| **1.0.0+** | **≥ 1.27.1** | Uses new `drawLinkPath` API |
|
||
| 0.0.2 | < 1.27.1 | Legacy `renderLink` patch |
|
||
|
||
> Staying on an older ComfyUI? Keep using **v0.0.2** (see legacy tag/releases).
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Troubleshooting
|
||
|
||
- **Only the center dot appears**
|
||
Likely start/end were read as arrays. Ensure you’re on **v1.0.0+**; we read `{x,y}` points.
|
||
- **No lines drawn**
|
||
Check DevTools Console for warnings from ExtraLinks; verify ComfyUI is **≥ 1.27.1**.
|
||
- **After toggling Enable nothing changes**
|
||
Try reloading the page; ensure there’s no other extension overriding link rendering.
|
||
|
||
If issues persist, please open an issue with:
|
||
|
||
- ComfyUI frontend commit/date
|
||
- Browser + OS
|
||
- A screenshot / brief recording
|
||
- Console logs (copy/paste)
|
||
|
||
👉 [Open an issue](https://github.com/edoardocarmignani/extralinks/issues)
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Versioning & Releases
|
||
|
||
- **1.2.0** - Added Trace mode with node-aware 90°/45° routing.
|
||
- **1.1.2** - Fixed links inside subgraphs.
|
||
- **1.1.1** - Fixed collapsed state node links.
|
||
- **1.1.0** - Added subway style and geometry awareness.
|
||
- **1.0.2** - Fixed path method to patch each instance.
|
||
- **1.0.1** - Fixed links lookup.
|
||
- **1.0.0** - Migration to new ComfyUI link renderer (**breaking**: drops < 1.27.1).
|
||
|
||
> See [`CHANGELOG`](CHANGELOG.md) for details.
|
||
|
||
Tags:
|
||
|
||
- `v1.x.y` → current series.
|
||
- `v0.0.2` → legacy (for older ComfyUI).
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Development
|
||
|
||
- Main code lives in `extralinks/web/js/ExtraLinks.js`
|
||
- Trace routing lives in `extralinks/web/js/Trace.js`
|
||
- Node bbox indexing lives in `extralinks/web/js/NodeBBoxIndex.js`
|
||
- Settings/registration live in `extralinks/web/js/extralinks_register.js`
|
||
- Python exposes `WEB_DIRECTORY` via `extralinks/__init__.py`
|
||
|
||
Typical flow:
|
||
|
||
```bash
|
||
# edit JS files
|
||
# reload ComfyUI browser tab
|
||
# watch console for "[Extra Links]" logs
|
||
```
|
||
|
||
Optional Runtime guard:
|
||
|
||
```javascript
|
||
const ok = app?.canvas?.linkRenderer?.pathRenderer?.drawLinkPath;
|
||
if (!ok) {
|
||
console.warn("[ExtraLinks] Requires ComfyUI frontend >= 1.27.1");
|
||
}
|
||
```
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## License
|
||
|
||
MIT (see [`LICENSE`](LICENSE))
|
||
|
||
------------------------------------------------------------------
|
||
|
||
## Credits
|
||
|
||
- Built by [@edoardocarmignani](https://github.com/edoardocarmignani)
|
||
- Trace routing is adapted from [quick-connections](https://github.com/niknah/quick-connections) by [@niknah](https://github.com/niknah)
|
||
- Thanks to the ComfyUI community for the incredible work
|