# sd-webui-autowatermark

**Repository Path**: bosima/sd-webui-autowatermark

## Basic Information

- **Project Name**: sd-webui-autowatermark
- **Description**: Automatically add watermarks to generated images in Stable Diffusion WebUI
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Auto Watermark Extension for Stable Diffusion WebUI

这是一个为Stable Diffusion WebUI自动添加水印的插件，支持中文水印和跨平台使用。

## 功能特性

- 🎨 自动为生成的图片添加水印文字
- 🈚 **完整支持中文水印**（Windows、Linux、macOS）
- 📍 支持多种水印位置（右下角、左下角、右上角、左上角、居中）
- 🎨 可自定义文字颜色和轮廓颜色
- 📏 可调节字体大小和透明度
- 🖼️ 支持文字轮廓以提高可读性
- 🌐 跨平台支持（Windows/Linux/macOS）
- 🔤 智能字体检测和回退机制
- ⚙️ 简单易用的界面设置

## 安装方法

### 方法1：通过扩展管理器安装（推荐）
1. 打开Stable Diffusion WebUI
2. 进入 `Extensions` 标签页
3. 点击 `Install from URL`
4. 在URL字段中输入：`https://github.com/bosima/sd-webui-autowatermark.git`
5. 点击 `Install`
6. 重启WebUI

### 方法2：手动安装
1. 进入Stable Diffusion WebUI的安装目录
2. 进入 `extensions` 文件夹
3. 克隆本仓库：
   ```bash
   git clone https://github.com/yourusername/sd-webui-autowatermark.git
   ```
4. 重启WebUI

## 使用方法

1. 安装插件后，重启Stable Diffusion WebUI
2. 进入 `Settings` 设置页面
3. 在左侧找到 `Auto Watermark 自动水印` 部分
4. 配置水印设置：
   - **启用自动水印**：勾选以启用水印功能
   - **水印文字**：输入要显示的水印文字（默认："AI生成"，支持中文、英文、emoji等）
   - **字体大小**：调节文字大小（10-100）
   - **透明度**：调节水印透明度（0-255）
   - **位置**：选择水印在图片中的位置
   - **文字颜色**：设置水印文字的颜色（默认：白色）
   - **轮廓颜色**：设置文字轮廓的颜色（默认：黑色）
   - **轮廓宽度**：设置轮廓的粗细（0-5）

5. 点击页面顶部的 `Apply settings` 保存设置
6. 配置完成后，所有生成的图片都会自动添加水印

## 🈚 中文支持

本插件完整支持中文水印，包括：

### 支持的中文文字
- **简体中文**：如 "AI生成"、"人工智能创作"
- **繁体中文**：如 "AI生成"、"人工智慧創作"
- **中英混合**：如 "AI生成 Generated by AI"
- **Emoji表情**：如 "🎨 AI创作"、"✨ 智能生成"

### 跨平台字体支持

**Windows系统**
- 微软雅黑 (推荐)
- 黑体
- 宋体
- 楷体等系统内置字体

**Linux系统**
- 文泉驿微米黑
- 文泉驿正黑
- Noto Sans CJK
- AR PL UMing/UKai

**macOS系统**
- 苹方 (PingFang)
- 黑体-简
- 冬青黑体简体中文

### 字体检测和安装

**方式一：使用插件字体目录（推荐）**

1. 将字体文件直接放入插件的 `fonts/` 目录
2. 支持 `.ttf`、`.ttc`、`.otf` 格式的字体文件
3. 重启 WebUI 即可自动使用新字体

**快速设置中文字体：**
```bash
# 自动下载中文字体
python download_fonts.py

# 或手动复制Windows系统字体
copy "C:\Windows\Fonts\msyh.ttc" "fonts\msyh.ttc"
```

**方式二：系统字体检测**

如果插件字体目录为空，会自动检测系统字体：

```bash
# 检查中文字体支持
python install_chinese_fonts.py

# 测试中文水印功能
python test_chinese_watermark.py
```

**Ubuntu/Debian用户：**
```bash
sudo apt update && sudo apt install fonts-wqy-microhei fonts-wqy-zenhei fonts-noto-cjk
```

**CentOS/RHEL用户：**
```bash
sudo yum install wqy-microhei-fonts wqy-zenhei-fonts google-noto-sans-cjk-fonts
```

### 中文水印示例
- `AI生成` - 简洁的中文水印
- `人工智能生成` - 详细说明
- `🎨 AI创作` - 带表情符号
- `Generated by AI | AI生成` - 中英双语

## 设置说明

### 统一设置管理
- 所有水印设置都在 `Settings` 页面的 `Auto Watermark 自动水印` 部分
- 不需要在每个生成页面单独设置
- 设置保存后对所有生成（txt2img、img2img等）都生效
- 修改设置后需要点击 `Apply settings` 来保存更改

## 配置选项详解

### 位置选项
- **右下角**：水印显示在图片右下角（默认）
- **左下角**：水印显示在图片左下角
- **右上角**：水印显示在图片右上角
- **左上角**：水印显示在图片左上角
- **居中**：水印显示在图片中央

### 颜色设置
- 支持通过颜色选择器设置文字和轮廓颜色
- 默认文字颜色为白色，轮廓为黑色，确保在大多数背景下都能清晰显示

### 字体支持
插件会自动检测并使用系统字体：
- **Windows**：微软雅黑、黑体、宋体、楷体
- **macOS**：苹方、黑体-简、冬青黑体
- **Linux**：文泉驿字体、Noto Sans CJK、Liberation Sans

插件具有智能字体回退机制，会自动选择最适合的字体来显示中文或英文内容。

## 技术特性

- 基于PIL（Python Imaging Library）进行图像处理
- 支持中文和英文字体
- 自动适配不同操作系统的字体
- 优化的性能，不会显著影响生成速度

## 注意事项

- 水印会永久添加到生成的图片上，无法撤销
- 建议在正式使用前先测试水印效果
- 如果字体加载失败，会自动使用系统默认字体

## 常见问题

**Q: 中文水印显示为方框怎么办？**
A: 这通常是字体问题，请按以下步骤排查：

1. **运行诊断工具**：
   ```bash
   python diagnose_chinese.py
   ```

2. **检查字体文件**：
   - 确认 `fonts/` 目录中有中文字体文件
   - 运行 `python download_fonts.py` 自动下载字体
   - 或手动复制系统字体到 `fonts/` 目录

3. **检查WebUI控制台日志**：
   - 查找 "🎯 开始添加水印" 等调试信息
   - 检查是否有 "✓ 成功加载字体" 信息
   - 如果看到 "✗ 字体加载失败"，说明字体路径有问题

4. **强制重载**：
   - 重启 Stable Diffusion WebUI
   - 清除浏览器缓存
   - 重新 Apply settings

5. **系统字体备选**：
   ```bash
   # Windows用户可以复制系统字体
   copy "C:\Windows\Fonts\msyh.ttc" "fonts\msyh.ttc"
   ```

**Q: 插件加载了但水印不显示怎么办？**
A: 检查以下设置：
1. Settings > Auto Watermark > 启用自动水印 ✅
2. 水印文字不能为空
3. 点击 "Apply settings" 保存设置
4. 查看控制台是否有错误信息

**Q: 水印文字显示不清楚怎么办？**
A: 可以尝试调整轮廓宽度和颜色，或者增加文字大小。

**Q: 能否支持图片水印？**
A: 当前版本只支持文字水印，图片水印功能将在未来版本中考虑添加。

**Q: 如何临时禁用水印？**
A: 在Settings页面取消勾选"启用自动水印"选项，然后点击"Apply settings"即可。

**Q: 修改设置后为什么没有生效？**
A: 修改设置后需要点击页面顶部的"Apply settings"按钮来保存设置。

**Q: 设置在哪里找到？**
A: 在Stable Diffusion WebUI的Settings页面，左侧找到"Auto Watermark 自动水印"部分。

**Q: 插件加载失败怎么办？**
A: 
1. 检查是否正确安装了PIL/Pillow库
2. 确认插件文件位于正确的extensions目录下
3. 查看WebUI启动日志是否有错误信息
4. 尝试重启WebUI

## 调试信息

插件会在控制台输出调试信息，包括：
- "Auto Watermark 插件已加载" - 插件成功加载
- "添加水印: [文字内容]" - 开始处理水印
- "水印位置: (x, y)" - 水印坐标计算结果
- "水印绘制完成" - 水印处理完成

如果没有看到这些信息，说明插件可能没有正确加载或触发。

## 更新日志

### v2.0.0 (2024-09-09)
- ✨ **新增完整中文支持**
  - 支持中文、英文、emoji混合水印
  - 智能字体检测和回退机制
  - 优先使用插件目录字体文件
- 🔧 **改进字体管理**
  - 新增 `fonts/` 目录，支持用户自定义字体
  - 自动字体下载工具 (`download_fonts.py`)
  - 跨平台字体适配 (Windows/Linux/macOS)
- 🐛 **修复和优化**
  - 改进文字渲染错误处理
  - 优化字体加载性能
  - 增强调试信息输出

### v1.0.0
- 初始版本发布
- 支持基本的文字水印功能
- 支持多种位置和样式设置
- 统一设置管理，在Settings页面配置
- 所有生成模式共用水印设置

## 许可证

MIT License

## 贡献

欢迎提交Issue和Pull Request来改进这个插件！

## 支持

如果您觉得这个插件有用，请给个星星⭐！