ComfyUI-N-Sidebar 插件完整教程
1. 插件简介
ComfyUI-N-Sidebar 是一个专门为 ComfyUI 设计的侧边栏增强插件,由 Nuked88 开发。
GitHub 地址: https://github.com/Nuked88/ComfyUI-N-Sidebar
这个插件的主要作用是为 ComfyUI 添加一个功能强大的侧边栏,让你的工作流程更加高效便捷。它就像给你的 ComfyUI 装了一个超级工具箱,把所有常用的功能都整理得井井有条,随手就能找到。
插件能给我们带来什么效果:
- 🖱️ 拖拽添加节点 - 就像从工具箱里拿工具一样,直接拖拽节点到画布上
- 📌 收藏常用节点 - 把经常用的节点钉在侧边栏,就像手机桌面的常用应用
- 🔍 智能搜索功能 - 支持模糊搜索,输入关键词就能快速找到想要的节点
- 📂 自定义分类 - 可以按自己的习惯给节点分类整理
- 📄 工作流管理 - 管理和快速加载你保存的工作流文件
- 🎨 模板系统 - 保存和使用常用的节点组合模板
- 📥 资源下载器 - 直接从 CivitAI 下载模型文件到指定文件夹
- ⚙️ 丰富的设置选项 - 可以根据个人喜好调整界面和功能
重要说明: 这个插件不包含传统意义上的 ComfyUI 节点,而是一个界面增强工具。它通过前端 JavaScript 代码为 ComfyUI 添加侧边栏功能,包含 0 个处理节点,但提供了丰富的界面功能模块。
2. 如何安装
方法一:Git 克隆安装(推荐)
- 打开终端或命令提示符
- 进入 ComfyUI 的
custom_nodes目录 - 执行命令:
git clone https://github.com/Nuked88/ComfyUI-N-Sidebar.git
- 重启 ComfyUI
方法二:通过 ComfyUI Manager 安装
- 打开 ComfyUI Manager
- 搜索 "N-Sidebar" 或 "ComfyUI-N-Sidebar"
- 点击安装并重启 ComfyUI
方法三:手动下载安装
- 访问 GitHub 页面下载 ZIP 文件
- 解压到 ComfyUI 的
custom_nodes目录 - 确保文件夹名称为
ComfyUI-N-Sidebar - 重启 ComfyUI
注意事项:
- 安装后会自动安装必要的依赖包(如 aiofiles)
- 确保文件夹名称正确,否则可能无法正常工作
- 首次启动可能需要稍等片刻让插件完全加载
3. 功能模块详细解析
3.1 主侧边栏功能
侧边栏主体
这个就像你桌面上的工具栏,把所有常用功能都放在一个地方,随时可以打开使用。
主要特性:
| 功能名称 | 功能说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 拖拽宽度调整 | 可以用鼠标拖拽改变侧边栏宽度 | 就像拉窗帘一样,想要多宽就拉多宽 | 动态调整侧边栏宽度以适应不同屏幕 | 鼠标放在侧边栏边缘,出现双箭头时拖拽 |
| 位置切换 | 可以把侧边栏放在左边或右边 | 左撇子右撇子都能用得舒服 | 支持左右两侧定位以适应用户习惯 | 在设置中选择 "Left" 或 "Right" |
| 自动隐藏 | 鼠标离开时自动收起侧边栏 | 就像手机的悬浮球,不用时自动隐藏 | 鼠标悬停时显示,离开时自动隐藏 | 设置中开启 "Auto Hide" 功能 |
| 固定模式 | 侧边栏始终显示不隐藏 | 就像电脑任务栏一样一直在那里 | 侧边栏固定显示,不会自动隐藏 | 关闭 "Auto Hide" 即为固定模式 |
3.2 节点管理功能
节点搜索系统
这个功能就像图书馆的检索系统,帮你快速找到需要的节点。
搜索功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 普通搜索 | 输入节点名称的一部分进行搜索 | 就像在手机通讯录里找联系人 | 基于字符串匹配的精确搜索 | 输入 "load" 找到所有包含 load 的节点 |
| 模糊搜索 | 即使拼写不完全正确也能找到 | 就像打字时的智能联想功能 | 基于模糊匹配算法的容错搜索 | 输入 "lod" 也能找到 "Load" 相关节点 |
| 分类搜索 | 在节点分类中搜索 | 就像在商店的不同货架上找商品 | 在节点类别层级中进行搜索 | 点击分类搜索图标,然后输入分类名 |
| 反向搜索 | 搜索结果按相关度排序 | 最匹配的结果排在最前面 | 根据匹配度评分对结果排序 | 搜索时自动按相关度排列结果 |
节点收藏系统
这个功能就像浏览器的书签,把常用的节点收藏起来。
收藏功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 添加收藏 | 把节点添加到收藏列表 | 就像把喜欢的歌加入播放列表 | 将节点添加到用户自定义收藏集合 | 点击节点旁边的图钉图标 |
| 取消收藏 | 从收藏列表中移除节点 | 就像从播放列表删除不喜欢的歌 | 从收藏集合中移除指定节点 | 再次点击已收藏节点的图钉图标 |
| 收藏排序 | 可以拖拽调整收藏节点的顺序 | 就像整理手机桌面应用的顺序 | 通过拖拽操作重新排列收藏项目 | 在收藏区域拖拽节点到想要的位置 |
| 收藏折叠 | 可以折叠或展开收藏区域 | 就像折叠手机的应用文件夹 | 控制收藏区域的显示和隐藏状态 | 点击收藏区域的标题栏 |
3.3 自定义分类功能
分类管理系统
这个功能就像给你的工具箱添加不同的隔间,按用途分类存放。
分类功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 创建分类 | 新建一个自定义节点分类 | 就像新建一个文件夹 | 创建用户自定义的节点分组 | 右键菜单选择"创建新分类" |
| 分类命名 | 给分类起一个容易记住的名字 | 就像给文件夹取名字 | 为自定义分类设置标识名称 | 创建时输入分类名称,如"我的常用节点" |
| 添加到分类 | 把节点添加到指定分类 | 就像把文件放到对应文件夹 | 将节点关联到特定的自定义分类 | 右键节点选择"添加到分类" |
| 分类颜色 | 给分类设置不同的颜色标识 | 就像用不同颜色的标签纸 | 为分类设置视觉标识颜色 | 在分类设置中选择颜色 |
| 分类排序 | 调整分类在侧边栏中的显示顺序 | 就像整理书架上书的摆放顺序 | 控制自定义分类的显示优先级 | 拖拽分类标题调整顺序 |
3.4 工作流管理功能
工作流文件系统
这个功能就像一个文件管理器,专门管理你保存的工作流。
工作流管理参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 工作流路径 | 设置工作流文件存放的文件夹 | 就像告诉程序去哪里找你的文件 | 配置工作流文件的存储目录路径 | 设置中输入文件夹路径,如 "/workflows" |
| 多路径支持 | 可以设置多个工作流文件夹 | 就像可以从多个文件夹找文件 | 支持多个工作流存储路径的配置 | 每行输入一个路径,支持多行配置 |
| 工作流预览 | 显示工作流包含的节点列表 | 就像文件的预览功能 | 显示工作流文件的节点组成信息 | 鼠标悬停在工作流名称上查看 |
| 工作流重命名 | 可以直接重命名工作流文件 | 就像重命名电脑文件 | 修改工作流文件的名称 | 右键工作流选择"重命名" |
| 工作流删除 | 删除不需要的工作流文件 | 就像删除不要的文件 | 从存储中移除工作流文件 | 右键工作流选择"删除" |
| 工作流分类 | 把工作流按用途分类管理 | 就像把照片分到不同相册 | 将工作流组织到自定义分类中 | 右键工作流选择"添加到分类" |
3.5 模板系统功能
模板管理器
这个功能就像一个模板库,保存你常用的节点组合。
模板功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 模板保存 | 把选中的节点组合保存为模板 | 就像保存常用的文档模板 | 将节点组合序列化为可重用模板 | 选中节点后右键选择"保存为模板" |
| 模板加载 | 从模板库中加载节点组合 | 就像使用文档模板创建新文档 | 从模板数据重建节点组合 | 拖拽模板到画布或双击加载 |
| 模板预览 | 显示模板包含的节点信息 | 就像预览文档模板的内容 | 显示模板的节点构成和连接关系 | 鼠标悬停在模板上查看详情 |
| 模板分类 | 按用途给模板分类整理 | 就像把模板放到不同文件夹 | 将模板组织到分类目录中 | 创建分类文件夹并拖拽模板 |
| 模板共享 | 导出模板供他人使用 | 就像分享文档模板给同事 | 将模板数据导出为可分享格式 | 右键模板选择"导出" |
3.6 资源下载器功能
CivitAI 模型下载器
这个功能就像一个应用商店,可以直接下载各种 AI 模型。
下载器功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 模型搜索 | 在 CivitAI 上搜索模型 | 就像在应用商店搜索应用 | 通过 API 查询 CivitAI 模型数据库 | 在搜索框输入模型名称或关键词 |
| 模型分类 | 按类型筛选模型 | 就像按分类浏览应用 | 根据模型类型进行分类筛选 | 选择 Checkpoint、LoRA、VAE 等分类 |
| 下载路径 | 设置不同类型模型的保存位置 | 就像设置下载文件夹 | 配置各类型模型的存储目录 | 在设置中为每种模型类型设置路径 |
| 下载进度 | 显示模型下载的进度 | 就像下载文件时的进度条 | 实时显示下载状态和完成百分比 | 下载时在进度面板查看状态 |
| 断点续传 | 支持暂停和继续下载 | 就像迅雷的断点续传功能 | 支持下载中断后从断点继续 | 点击暂停按钮可暂停,再点击继续 |
| 批量下载 | 可以同时下载多个模型 | 就像批量下载多个文件 | 支持多任务并行下载管理 | 选择多个模型后点击批量下载 |
| API 密钥 | 设置 CivitAI 的 API 密钥 | 就像登录账号获得更多权限 | 配置 API 认证以访问私有资源 | 在设置中输入你的 CivitAI API Key |
3.7 设置系统功能
全局设置管理
这个功能就像系统设置,可以调整插件的各种行为。
设置功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 界面主题 | 选择侧边栏的外观主题 | 就像换手机主题 | 切换界面的视觉样式主题 | 在设置中选择 Dark、Light 等主题 |
| 启动显示 | 设置启动时是否显示侧边栏 | 就像设置开机启动项 | 控制插件启动时的初始显示状态 | 开启"Show at Startup"选项 |
| 搜索类型 | 选择搜索算法类型 | 就像选择搜索引擎 | 配置节点搜索的匹配算法 | 选择"Normal"或"Fuzzy"搜索 |
| 节点排序 | 设置节点的排列顺序 | 就像选择文件排序方式 | 控制节点列表的排序规则 | 选择"Alphabetical"或"Original"排序 |
| 快捷键设置 | 自定义键盘快捷键 | 就像设置游戏按键 | 配置功能的键盘快捷方式 | 设置 Alt+Z 切换侧边栏等 |
| 导入导出 | 备份和恢复设置 | 就像备份手机设置 | 导出配置数据或导入备份配置 | 点击"Export Settings"导出配置 |
3.8 终端功能
内置命令行
这个功能就像在侧边栏里嵌入了一个小型终端。
终端功能参数:
| 参数名称 | 参数说明 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 命令执行 | 可以执行系统命令 | 就像在电脑的命令提示符里输入命令 | 通过 Web 界面执行系统 Shell 命令 | 输入 "ls" 查看文件列表 |
| 输出显示 | 显示命令执行的结果 | 就像命令行显示执行结果 | 实时显示命令的标准输出和错误输出 | 执行命令后在下方查看结果 |
| 历史记录 | 保存之前执行过的命令 | 就像浏览器的历史记录 | 维护命令执行的历史列表 | 使用上下箭头键查看历史命令 |
3.9 快捷键系统
键盘快捷键
这个功能让你可以用键盘快速操作,就像游戏里的快捷键。
快捷键功能参数:
| 参数名称 | 默认快捷键 | 通俗解释 | 专业解释 | 使用方法/举例 |
|---|---|---|---|---|
| 切换侧边栏 | Alt+Z (Option+Z) | 就像按 F11 切换全屏 | 显示或隐藏侧边栏界面 | 按 Alt+Z 快速打开/关闭侧边栏 |
| 聚焦搜索 | Alt+X (Option+X) | 就像按 Ctrl+F 打开搜索 | 将光标定位到搜索输入框 | 按 Alt+X 直接开始搜索节点 |
| 打开设置 | Alt+G (Option+G) | 就像按 F12 打开开发者工具 | 打开插件设置面板 | 按 Alt+G 快速打开设置界面 |
| 自定义快捷键 | 用户自定义 | 就像自定义游戏按键 | 允许用户重新定义快捷键组合 | 在设置中修改快捷键配置 |
4. 使用技巧和建议
4.1 新手入门建议
- 先熟悉基本操作:从简单的节点搜索和拖拽开始,逐步掌握其他功能
- 善用收藏功能:把常用的节点收藏起来,提高工作效率
- 学会使用快捷键:记住 Alt+Z 和 Alt+X 这两个最常用的快捷键
- 合理设置工作流路径:把工作流文件整理到固定文件夹,方便管理
4.2 高级使用技巧
- 自定义分类管理:按项目或用途创建不同的节点分类,让工作更有条理
- 模板系统应用:把常用的节点组合保存为模板,避免重复搭建
- 批量下载模型:利用资源下载器批量获取需要的模型文件
- 设置备份:定期导出设置配置,避免重新配置的麻烦
4.3 性能优化建议
- 合理调整侧边栏宽度:根据屏幕大小调整合适的宽度,既不占用太多空间又能清楚显示内容
- 使用自动隐藏功能:在小屏幕上开启自动隐藏,节省屏幕空间
- 定期清理不用的分类:删除不再使用的自定义分类和模板,保持界面整洁
- 合理设置下载路径:为不同类型的模型设置专门的文件夹,便于管理
5. 常见问题解答
Q1: 安装后侧边栏没有显示怎么办?
A: 检查以下几点:
- 确保插件文件夹名称为
ComfyUI-N-Sidebar - 重启 ComfyUI 并等待完全加载
- 按 Alt+Z 尝试手动打开侧边栏
- 检查浏览器控制台是否有错误信息
Q2: 搜索功能不工作怎么办?
A: 可能的解决方案:
- 检查搜索类型设置,尝试切换"Normal"和"Fuzzy"搜索
- 清除浏览器缓存并刷新页面
- 确保输入的搜索词没有特殊字符
Q3: 工作流文件夹设置不生效?
A: 解决步骤:
- 确保文件夹路径正确且存在
- 路径使用正斜杠
/而不是反斜杠\ - 设置后需要重启 ComfyUI
- 检查文件夹权限是否允许读取
Q4: 下载模型失败怎么办?
A: 检查以下方面:
- 网络连接是否正常
- CivitAI API 是否可访问
- 下载路径是否有写入权限
- 磁盘空间是否充足
Q5: 快捷键不响应?
A: 可能的原因和解决方法:
- 检查是否与其他软件快捷键冲突
- 确保 ComfyUI 窗口处于活动状态
- 在设置中重新配置快捷键
- 尝试使用默认快捷键组合
Q6: 侧边栏显示异常或样式错误?
A: 解决方案:
- 清除浏览器缓存
- 检查是否与其他插件冲突
- 尝试重置插件设置到默认状态
- 更新到最新版本
6. 总结
ComfyUI-N-Sidebar 是一个功能强大的界面增强插件,虽然它不包含传统的处理节点,但提供了丰富的界面功能模块。通过本教程的详细介绍,你应该能够:
- 理解插件的核心价值:提升 ComfyUI 的使用体验和工作效率
- 掌握各项功能的使用方法:从基本的节点管理到高级的模板系统
- 学会个性化配置:根据自己的工作习惯调整设置
- 解决常见问题:遇到问题时能够自行排查和解决
插件功能模块统计:
- 界面功能模块: 9个主要功能区域
- 配置参数: 约60个可调整参数
- 快捷键: 3个默认快捷键 + 自定义支持
- 面板系统: 支持多个功能面板的动态加载
这个插件特别适合需要频繁使用 ComfyUI 的用户,能够显著提升工作流程的效率。建议从基础功能开始使用,逐步探索高级功能,让你的 ComfyUI 使用体验更上一层楼!