ComfyUI-decadetw-spout-syphon-im-vj 插件完全使用指南
1. 插件简介
GitHub原地址: https://github.com/xlinx/ComfyUI-decadetw-spout-syphon-im-vj
这个插件是专门为 VJ(Visual Jockey,可视化音乐表演师)设计的工具,让你可以把 ComfyUI 生成的图片实时传输给其他软件使用。就像是在两个软件之间架了一座桥梁,让图片可以瞬间从 ComfyUI 传到其他地方。
能带来什么效果:
- 实时传输:就像直播一样,ComfyUI 生成的图片可以立即在其他软件中显示
- 无延迟分享:通过显卡内存直接传输,速度超快
- 多软件配合:可以和 MadMapper、Processing、QLab 等专业 VJ 软件配合使用
- 跨平台支持:Windows 用 Spout,Mac 用 Syphon,网络用 NDI
2. 如何安装
方法一:ComfyUI Manager 安装(推荐)
- 在 ComfyUI 中打开 Manager 菜单
- 点击 "Install Custom Nodes"
- 搜索 "decadetw-spout-syphon"
- 点击安装并重启 ComfyUI
方法二:手动安装
- 打开 ComfyUI 的
custom_nodes文件夹 - 在命令行中输入:
git clone https://github.com/xlinx/ComfyUI-decadetw-spout-syphon-im-vj.git - 重启 ComfyUI
额外设置要求
- Windows 用户: 需要先安装 Spout 客户端(https://spout.zeal.co/)
- Mac 用户: 需要先安装 Syphon 客户端(https://syphon.github.io/)
- 网络用户: 需要安装 NDI 支持(https://github.com/leadedge/ofxNDI)
3. 节点详细解析
3.1 Im-SD-VJ-Spout 节点(Windows 专用输出节点)
这个节点就像一个"图片广播电台",把 ComfyUI 生成的图片通过 Spout 技术广播出去,让其他软件可以接收到。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 图片输入 | image | IMAGE | 连接图片 | 就像把照片放进广播机里 | 接收要传输的图像数据 | 把任何图片生成节点连接过来 |
| 发送器名称 | sender_name | 文本 | "ComfyUI_Out" | 给你的广播电台起个名字 | 设置Spout发送器的标识名称 | 起个好记的名字,比如"我的AI画图" |
| 启用发送 | enable | 布尔值 | True | 开关按钮,决定要不要广播 | 控制是否激活Spout传输 | 想传输就选True,不想传就选False |
| 分辨率宽度 | width | 整数 | 1024 | 决定广播出去的图片有多宽 | 输出图像的像素宽度 | 一般用1024或1920 |
| 分辨率高度 | height | 整数 | 1024 | 决定广播出去的图片有多高 | 输出图像的像素高度 | 一般用1024或1080 |
| 帧率 | fps | 整数 | 30 | 每秒钟广播多少张图片 | 输出帧率控制 | 30帧够用了,60帧更流畅但更耗资源 |
3.2 Im-SD-VJ-Syphon 节点(Mac 专用输出节点)
这个节点和 Spout 节点功能一样,只是专门为 Mac 电脑设计的"图片广播电台"。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 图片输入 | image | IMAGE | 连接图片 | 就像把照片放进苹果专用的广播机里 | 接收要传输的图像数据 | 把任何图片生成节点连接过来 |
| 服务器名称 | server_name | 文本 | "ComfyUI_Syphon" | 给你的苹果广播电台起个名字 | 设置Syphon服务器的标识名称 | 起个好记的名字,比如"Mac_AI画图" |
| 启用发送 | enable | 布尔值 | True | 开关按钮,决定要不要广播 | 控制是否激活Syphon传输 | 想传输就选True,不想传就选False |
| 分辨率宽度 | width | 整数 | 1024 | 决定广播出去的图片有多宽 | 输出图像的像素宽度 | 一般用1024或1920 |
| 分辨率高度 | height | 整数 | 1024 | 决定广播出去的图片有多高 | 输出图像的像素高度 | 一般用1024或1080 |
| 帧率 | fps | 整数 | 30 | 每秒钟广播多少张图片 | 输出帧率控制 | 30帧够用了,60帧更流畅但更耗资源 |
3.3 Im-SD-VJ-NDI 节点(网络传输节点)
这个节点就像一个"网络图片快递员",可以把图片通过网络传给其他电脑上的软件。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 图片输入 | image | IMAGE | 连接图片 | 就像把照片放进网络快递箱里 | 接收要传输的图像数据 | 把任何图片生成节点连接过来 |
| NDI 名称 | ndi_name | 文本 | "ComfyUI_NDI" | 给你的网络快递服务起个名字 | 设置NDI源的标识名称 | 起个好记的名字,比如"办公室AI画图" |
| 启用发送 | enable | 布尔值 | True | 开关按钮,决定要不要网络传输 | 控制是否激活NDI传输 | 想传输就选True,不想传就选False |
| 分辨率宽度 | width | 整数 | 1024 | 决定网络传输的图片有多宽 | 输出图像的像素宽度 | 一般用1024或1920 |
| 分辨率高度 | height | 整数 | 1024 | 决定网络传输的图片有多高 | 输出图像的像素高度 | 一般用1024或1080 |
| 帧率 | fps | 整数 | 30 | 每秒钟网络传输多少张图片 | 输出帧率控制 | 30帧够用了,网络传输建议不要太高 |
| 网络质量 | quality | 整数 | 100 | 就像调节快递包装质量 | 控制NDI传输的图像质量 | 100是最好质量,50是普通质量,节省带宽 |
3.4 Im-SD-VJ-Spout-Input 节点(Windows 专用输入节点)
这个节点就像一个"图片接收器",可以接收其他软件通过 Spout 发来的图片。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 接收器名称 | receiver_name | 文本 | "External_App" | 告诉接收器要收听哪个电台 | 指定要接收的Spout发送器名称 | 填写其他软件的发送器名称 |
| 启用接收 | enable | 布尔值 | True | 开关按钮,决定要不要接收 | 控制是否激活Spout接收 | 想接收就选True,不想接收就选False |
| 自动搜索 | auto_search | 布尔值 | True | 自动寻找可用的图片电台 | 自动检测可用的Spout发送器 | 建议开启,会自动找到其他软件 |
| 超时时间 | timeout | 整数 | 5000 | 多长时间没收到图片就放弃 | 接收超时时间(毫秒) | 5000就是5秒,够用了 |
3.5 Im-SD-VJ-Syphon-Input 节点(Mac 专用输入节点)
这个节点和 Spout 输入节点功能一样,只是专门为 Mac 电脑设计的"图片接收器"。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 服务器名称 | server_name | 文本 | "External_Mac_App" | 告诉接收器要收听哪个苹果电台 | 指定要接收的Syphon服务器名称 | 填写其他Mac软件的服务器名称 |
| 启用接收 | enable | 布尔值 | True | 开关按钮,决定要不要接收 | 控制是否激活Syphon接收 | 想接收就选True,不想接收就选False |
| 自动搜索 | auto_search | 布尔值 | True | 自动寻找可用的苹果图片电台 | 自动检测可用的Syphon服务器 | 建议开启,会自动找到其他Mac软件 |
| 超时时间 | timeout | 整数 | 5000 | 多长时间没收到图片就放弃 | 接收超时时间(毫秒) | 5000就是5秒,够用了 |
3.6 LLM-Auto-Prompt 节点(智能提示词生成节点)
这个节点就像一个"AI写作助手",可以帮你自动生成更好的提示词。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 基础提示词 | base_prompt | 文本 | "一个美丽的女孩" | 你想要什么样的图片 | 用户输入的基础提示词 | 写个简单的描述就行 |
| 模型路径 | model_path | 文本 | 模型文件路径 | 告诉系统用哪个AI大脑来思考 | LLM模型文件的完整路径 | 选择下载好的模型文件 |
| 启用增强 | enable_enhance | 布尔值 | True | 要不要让AI帮你丰富提示词 | 控制是否启用提示词增强 | 建议开启,会让图片更精美 |
| 最大长度 | max_length | 整数 | 200 | 生成的提示词最多多少个字 | 生成文本的最大长度 | 200个字符够用了 |
| 温度 | temperature | 浮点数 | 0.7 | 控制AI的创造力 | 控制生成文本的随机性 | 0.7比较均衡,0.3保守,0.9创意 |
| 语言 | language | 选择项 | "中文" | 选择提示词的语言 | 指定生成文本的语言 | 可以选中文、英文等 |
3.7 LLM-Vision-Prompt 节点(看图说话节点)
这个节点就像一个"AI看图说话助手",可以看着图片自动生成描述。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 输入图片 | image | IMAGE | 连接图片 | 给AI看什么图片 | 接收要分析的图像数据 | 把任何图片连接过来 |
| 视觉模型路径 | vision_model_path | 文本 | 模型文件路径 | 告诉系统用哪个AI眼睛来看图 | 视觉模型文件的完整路径 | 选择下载好的视觉模型文件 |
| 描述风格 | description_style | 选择项 | "详细描述" | 想要什么样的图片描述 | 控制描述的详细程度和风格 | 可以选详细、简洁、艺术等风格 |
| 启用分析 | enable_analysis | 布尔值 | True | 要不要让AI分析图片 | 控制是否启用图像分析 | 建议开启,会生成更准确的描述 |
| 最大长度 | max_length | 整数 | 300 | 生成的描述最多多少个字 | 生成描述的最大长度 | 300个字符够详细了 |
| 语言 | language | 选择项 | "中文" | 选择描述的语言 | 指定生成描述的语言 | 可以选中文、英文等 |
3.8 Mobile-Notify 节点(手机通知节点)
这个节点就像一个"私人秘书",可以在图片生成完毕后自动发消息到你的手机。
参数详解:
| 参数名 (UI显示) | 参数名 (代码里) | 参数值 | 建议值 | 通俗解释 (能干嘛的) | 专业解释 | 怎么用/举个例子 |
|---|---|---|---|---|---|---|
| 通知平台 | platform | 选择项 | "LINE" | 选择用哪个软件发消息 | 指定消息推送平台 | 可以选LINE、Telegram、Discord |
| 机器人令牌 | bot_token | 文本 | 你的机器人密钥 | 就像给秘书一个工作证 | 各平台的机器人访问令牌 | 需要先申请机器人账号 |
| 接收ID | chat_id | 文本 | 你的用户ID | 告诉秘书要发给谁 | 消息接收者的唯一标识 | 你的用户ID或群组ID |
| 消息内容 | message | 文本 | "图片已生成完毕" | 想发什么消息 | 要发送的消息内容 | 可以自定义任何提醒内容 |
| 启用通知 | enable | 布尔值 | True | 要不要发送通知 | 控制是否启用消息推送 | 想收到通知就选True |
| 发送图片 | send_image | 布尔值 | True | 要不要把生成的图片也发给你 | 控制是否附带图片 | 建议开启,可以直接看到结果 |
4. 使用技巧和建议
4.1 性能优化建议
- 帧率设置: 如果不是做实时表演,帧率设置为15-30就够了,太高会占用过多资源
- 分辨率选择: 根据实际需求选择,1024x1024适合大部分场景,4K只在专业表演时使用
- 内存管理: 长时间运行时建议定期重启ComfyUI,避免内存泄漏
4.2 网络传输优化
- NDI质量: 本地网络用100,互联网传输建议50-70
- 带宽考虑: 高质量1080p大约需要50-100Mbps带宽
- 延迟控制: 对延迟要求高的场景,优先使用本地Spout/Syphon
4.3 LLM模型选择
- 显存4GB以下: 用4B模型,如CHE-72/Qwen1.5-4B
- 显存8GB以上: 用7B-8B模型,如Llama-3-Taiwan-8B
- 视觉模型: 推荐llava-phi-3-mini,平衡性能和效果
4.4 实际应用场景
- 现场表演: 用Spout/Syphon连接MadMapper等VJ软件
- 直播推流: 用NDI连接OBS等推流软件
- 远程协作: 用NDI在局域网内共享AI生成内容
- 创意设计: 用视觉模型分析参考图片,自动生成相似风格
5. 常见问题解答
Q1:安装后节点不显示怎么办?
A: 检查以下几点:
- 确保已安装对应的客户端软件(Spout/Syphon/NDI)
- 重启ComfyUI
- 检查Python环境是否正确
- 查看控制台是否有错误信息
Q2:Spout/Syphon连接不上其他软件?
A: 检查以下几点:
- 确保其他软件也支持Spout/Syphon
- 检查发送器和接收器的名称是否匹配
- 确保两个软件都在同一台电脑上运行
- 尝试重启两个软件
Q3:NDI网络传输延迟很高?
A: 优化方法:
- 降低分辨率和帧率
- 检查网络带宽是否充足
- 使用有线网络而非WiFi
- 降低NDI质量设置
Q4:LLM模型加载失败?
A: 检查以下几点:
- 确保模型文件路径正确
- 检查显存是否充足
- 确认模型文件没有损坏
- 查看控制台错误信息
Q5:手机通知收不到?
A: 检查以下几点:
- 确认机器人令牌是否正确
- 检查用户ID是否正确
- 确保网络连接正常
- 查看各平台的机器人设置
Q6:图片传输质量不好?
A: 优化方法:
- 提高分辨率设置
- 检查图片格式是否支持
- 确保显卡驱动是最新版本
- 调整图片压缩参数
6. 进阶使用技巧
6.1 工作流程设计
推荐的节点连接顺序:
- 图片生成节点 → LLM-Vision-Prompt → 提示词优化 → 新的图片生成
- 图片生成节点 → Im-SD-VJ-Spout → 外部软件接收
- 图片生成完成 → Mobile-Notify → 手机通知
6.2 批量处理技巧
- 使用队列系统批量生成图片
- 设置自动保存避免丢失作品
- 配置不同分辨率的多路输出
6.3 与其他插件配合
- 配合ControlNet使用:先用视觉模型分析参考图,再用ControlNet生成
- 配合动画插件:创建连续的图片序列并实时输出
- 配合后处理插件:在传输前对图片进行最后的优化
6.4 故障排除指南
- 定期检查日志: 查看ComfyUI控制台的错误信息
- 测试连接: 定期测试各个传输通道是否正常
- 备份设置: 保存好用的工作流程和参数设置
- 更新维护: 定期更新插件和依赖库
这个插件特别适合需要实时图片传输的场景,比如现场表演、直播推流、远程协作等。通过合理配置各个节点,可以打造出专业级的AI视觉表演系统。