README

2024-11-21 00:21:54 +08:00
parent a9f24502a5
commit 0f5c6acae0
3 changed files with 104 additions and 1 deletions
@@ -1,5 +1,7 @@
 # ComfyUI Image Compressor Node

+[English](README_en.md) | 中文
+
 一个用于图像压缩的ComfyUI自定义节点，支持多种压缩格式和参数调整。

 ![image](workflow/screenshot.png)
@@ -16,7 +18,7 @@

 1. 将本插件复制到 ComfyUI 的 `custom_nodes` 目录下
 2. 重启 ComfyUI
-3. 在节点列表中找到 "图片压缩器"
+3. 在节点列表中找到 "Image Compressor"

 ## 参数说明

@@ -0,0 +1,101 @@
+# ComfyUI Image Compressor Node
+
+English | [中文](README.md)
+
+A ComfyUI custom node for image compression, supporting multiple formats and adjustable parameters.
+
+![image](workflow/screenshot.png)
+
+## Features
+
+- Support multiple image formats (PNG, WEBP, JPEG)
+- Adjustable image quality and compression levels
+- Support image resizing
+- Custom output path and filename prefix
+- Display file size before and after compression
+
+## Installation
+
+1. Copy this plugin to ComfyUI's `custom_nodes` directory
+2. Restart ComfyUI
+3. Find "Image Compressor" in the node list
+
+## Parameter Description
+
+### Basic Parameters
+
+- **image**: Input image
+- **save_image**: Whether to save the compressed image file (Default: Yes)
+- **output_prefix**: Output filename prefix (Default: compressed_)
+- **output_path**: Custom output path (Optional, defaults to ComfyUI's output/compressed directory)
+
+### Compression Parameters
+
+#### Format Selection (format)
+- **PNG**: Lossless compression, suitable for scenarios requiring image quality preservation
+  - Pros: Lossless compression, supports transparency
+  - Cons: Relatively larger file size
+  - Use cases: Icons, screenshots, images requiring perfect quality
+
+- **WEBP**: Modern image format developed by Google
+  - Pros: Good compression ratio, supports both lossy and lossless compression
+  - Cons: Compatibility might not be as good as PNG and JPEG
+  - Use cases: Web images, scenarios requiring balance between quality and size
+
+- **JPEG**: Common lossy compression format
+  - Pros: High compression ratio, small file size
+  - Cons: Lossy compression, no transparency support
+  - Use cases: Photos, images not requiring transparency
+
+#### Quality Control
+- **quality**: Compression quality (1-100, Default: 85)
+  - Effective for JPEG and WEBP formats
+  - Higher value means better quality but larger file size
+  - Recommended values:
+    - High quality: 85-95
+    - Balanced quality: 75-85
+    - High compression: 60-75
+
+- **compression_level**: PNG compression level (0-9, Default: 6)
+  - Only effective for PNG format
+  - Higher value means higher compression ratio but longer compression time
+  - Recommended values:
+    - Fast compression: 3-4
+    - Balanced compression: 6
+    - Maximum compression: 9
+
+- **resize_factor**: Size adjustment factor (0.1-1.0, Default: 1.0)
+  - 1.0 means keeping original size
+  - Values less than 1.0 will proportionally reduce image size
+  - Can be used to reduce file size by lowering resolution
+
+## Usage Recommendations
+
+1. **Format Selection**:
+   - Need lossless compression: Use PNG
+   - Web images: Prefer WEBP
+   - Photo-type images: Use JPEG
+
+2. **Quality Settings**:
+   - PNG: Adjust compression_level, recommend 6-9
+   - WEBP: quality setting 80-90 provides good balance
+   - JPEG: quality setting 75-85 is usually sufficient
+
+3. **File Size Optimization**:
+   - First try adjusting quality parameter
+   - If still too large, consider adjusting resize_factor
+   - Finally consider changing compression format
+
+## Output Information
+
+The node returns:
+- Compressed image
+- Compressed file size
+- Original file size
+- Save path (if saving is enabled)
+
+## Notes
+
+- Output directory is created automatically
+- Filenames include timestamp and counter to avoid overwriting existing files
+- Recommend selecting appropriate compression parameters based on specific use cases