# comfyui-auto-watermark

**Repository Path**: bosima/comfyui-auto-watermark

## Basic Information

- **Project Name**: comfyui-auto-watermark
- **Description**: ComfyUI 无节点自动水印插件 —— 通过设置为所有预览/保存图片添加自定义文字水印，无需修改工作流。
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-10
- **Last Updated**: 2026-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# ComfyUI Auto Watermark

自动为 ComfyUI 通过 `SaveImage` 节点输出的图片叠加文字水印。

**版本：v1.0**  |  License: GPL-3.0-or-later

</div>

## ✨ 特性

- 自动截获 `SaveImage` 保存并写入水印（原流程零改动）
- 自定义：文字 / 位置 / 字体 / 颜色 / 透明度
- 可选按图像宽度等比缩放字体（基准 1024px）
- 多字体：自动枚举 `fonts/` 下的 `.ttf / .otf` 文件
- 设置面板直接修改，0.5s 内自动保存（无需按钮）
- 轻量：无预览 / 无上传接口 / 无外部依赖

> v1.0 为首次稳定发布；后续扩展（如图形水印、样式模板）将在后续版本规划中。

## 📦 安装

1. 将本仓库克隆或拷贝到 `ComfyUI/custom_nodes/comfyui-auto-watermark`
2. 确认结构包含：`web/js/auto_watermark_ext.js` 与 `fonts/`
3. 重启 ComfyUI（或启动后热加载）

启动后在 Settings 中应出现 `Auto Watermark:` 前缀的配置项。

## ⚙️ 配置

两种方式：
1. ComfyUI 前端 Settings 面板（推荐）
2. 直接编辑插件目录下 `config.json`（若存在）后重启或等待 ~2 秒缓存失效

### 配置项说明

| 名称 (UI 显示) | 字段 | 说明 | 示例/默认 |
|----------------|------|------|-----------|
| AutoWM: Text | watermark_text | 水印文字 | © FireflySoft 2025 |
| AutoWM: Position | position | 位置 | bottom-right |
| AutoWM: Font Size (base 1024w) | font_size | 1024px 宽时基准字号 | 24 |
| AutoWM: Auto Scale | auto_scale | 是否随宽度缩放 | false |
| AutoWM: Opacity (0-255) | opacity | 不透明度 | 128 |
| AutoWM: Color | color | 文字颜色 (hex) | #ffffff |
| AutoWM: Font | font_name | 使用的字体文件（空=自动） | （空） |
| AutoWM: Enabled | enabled | 是否启用 | true |

说明：
- `auto_scale = true` 时：实际字号 = `font_size * (image_width / 1024)`（可做上限控制，当前实现未限制）
- `font_name` 为空：使用枚举列表第一个；放入新字体后重新打开/刷新 Settings 即可
- 仅对新保存的图片生效，已存在文件不会 retro-active 修改

## 🚀 使用

1. 启动 ComfyUI 并加载任意工作流
2. 在 Settings 设置水印参数
3. 正常执行工作流，查看 `output` 目录图片已带水印

## 🔌 API（内部 / 可脚本使用）

| Method | Path | 说明 |
|--------|------|------|
| GET | /auto_watermark/config | 获取当前配置（JSON） |
| POST | /auto_watermark/config | 更新配置（完整或部分字段） |
| GET | /auto_watermark/fonts | 列出可用字体数组 |

POST 发送示例（仅修改文字与开关）：
```jsonc
{
	"watermark_text": "© Demo 2025",
	"enabled": true
}
```

## ❓ 常见问题 (FAQ)

### 看不到设置项
1. 路径是否正确：`custom_nodes/comfyui-auto-watermark/web/js/auto_watermark_ext.js`
2. 浏览器控制台是否有 404 / JS 报错
3. 强制刷新 (Cmd+Shift+R / Ctrl+F5)
4. 重启 ComfyUI

### 中文/特殊字符显示为方块
1. 将支持字符的字体放入 `fonts/`
2. 确认扩展名 `.ttf / .otf`
3. 在 `Font` 下拉重新选择/清空后再选
4. 如仍失败：检查字体文件是否损坏

### 没有加水印
1. 检查 `Enabled` 是否开启
2. 文字是否为空
3. 控制台是否有报错（权限 / 字体加载）

### 想用图形 / Logo 水印
当前版本仅支持文字。建议：先用透明 PNG 生成节点合成；或等待后续版本计划。

## 🗂 版本

v1.0 (当前)：稳定的文字水印（位置 / 颜色 / 字体 / 透明度 / 自动缩放 / 字体枚举 / 即时保存）。

（历史记录将在后续版本开始维护）

## 📄 License

SPDX: `GPL-3.0-or-later`

遵循 GPLv3；分发修改版需保留原始版权与许可证声明，并以兼容方式开源。

完整文本见 `LICENSE`。

---
欢迎提交 Issue / PR 改进功能或补充文档。