Connect ComfyUI
connect_comfyuiBridge a running ComfyUI server into TouchDesigner using tox drop or webclient build, exposing a Null TOP for downstream output.
Instructions
Bridge a running ComfyUI server: drops the TDComfyUI .tox if installed, otherwise builds a stock webclientDAT skeleton. The container exposes a Null TOP at /out as the downstream output.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 'auto' tries tox_drop first then falls back to webclient. Force one explicitly when you know which is installed. | auto |
| parent_path | No | COMP that will receive the ComfyUI container. | /project1 |
| name | No | Container name; defaults to 'comfyui'. | |
| tox_path | No | Explicit .tox path. When omitted, candidates are probed in order: olegchomp/TDComfyUI, JiSenHua/ComfyUI-TD. | |
| server_url | No | ComfyUI server base URL — host:port of `python main.py --listen`. | http://127.0.0.1:8188 |
| workflow_json_path | No | Absolute path to a ComfyUI workflow JSON exported from the web UI (Save (API Format)). Required for webclient mode. | |
| source_top_path | No | (webclient) TOP whose current frame is sent as the workflow input image via Syphon/Spout re-broadcast. | |
| output_top_name | No | Name of the Null TOP exposed inside the container as the downstream output. | out |
| output_mode | No | How the generated frame is pulled back into TD. 'file_watch' reloads ComfyUI's output folder via a movieFileInTOP. | syphon |
| output_source_name | No | Spout sender / Syphon server / NDI source name to receive on. Must match the ComfyUI side. | ComfyUI |
| watch_folder | No | (output_mode=file_watch) Folder ComfyUI writes outputs to. The movieFileInTOP cycles the newest file. | |
| poll_interval_seconds | No | (webclient) How often to poll /history for completion. | |
| active | No | Start polling / streaming immediately. Default off so the artist can sanity-check first. |