# comfyui_image_metadata_extension

**Repository Path**: micdav/comfyui_image_metadata_extension

## Basic Information

- **Project Name**: comfyui_image_metadata_extension
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-16
- **Last Updated**: 2026-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ComfyUI Image Metadata Extension

![node-preview](assets/preview.PNG)

Custom node for [ComfyUI](https://github.com/comfyanonymous/ComfyUI). It adds additional metadata for saved images, ensuring compatibility with the Civitai website.

*This is a fork of [nkchocoai/ComfyUI-SaveImageWithMetaData](https://github.com/nkchocoai/ComfyUI-SaveImageWithMetaData).*

**Key differences:**
- Simplified the node by removing unnecessary fields for general use.
- Included metadata for LoRa weights.
- The `subdirectory_name` field allows you to specify a custom name or use mask values to create a subdirectory for saved images. For example, using the mask `%date:yyyy-MM%` ([formatting options](#formatting-options)) will create a directory named with the current year and month (e.g., `2024-10`), organizing your images by the date they were generated.
- The `output_format` defines the saved image format:
  - `png`, `jpg`, `webp` – saves in the specified format.
  - `png_with_json`, `jpg_with_json`, `webp_with_json` – saves in the chosen format and writes workflow metadata to a JSON file with the same name.
- The `quality` option has the following levels:
  - **`max` / `lossless WebP`** – 100%
  - **`high`** – 80%
  - **`medium`** – 60%
  - **`low`** – 30%

  *(Lower quality, smaller file size. PNG images ignore this setting.)*
- The `metadata_scope` option controls metadata inclusion:
  - **`full`** – default metadata with additional metadata.
  - **`default`** – same as the SaveImage node.
  - **`parameters_only`** – only A1111-style metadata.
  - **`workflow_only`** – workflow metadata only.
  - **`none`** – no metadata.

## Installation

### Recommended Installation

Use the [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) to install.

```
comfyui_image_metadata_extension
```

### Manual Installation

1. Navigate to the `custom_nodes` directory inside your ComfyUI folder.
2. Clone this repository:

  ```bash
   git clone https://github.com/edelvarden/comfyui_image_metadata_extension.git
  ```

## Usage

Basic usage looks like ([workflow.json](assets/workflow.json)):

![workflow-preview](assets/Capture1.PNG)

Lora strings are automatically added to the prompt area, allowing the Civitai website to understand the weights you used. Other metadata is also successfully included.

![website-preview](assets/Capture2.PNG)

## Formatting Options
- The `filename_prefix` and `subdirectory_name` support the following options:

| Key             | Information to be Replaced            |
| --------------- | ------------------------------------- |
| %seed%          | Seed value                            |
| %width%         | Image width                           |
| %height%        | Image height                          |
| %pprompt%       | Positive prompt                       |
| %pprompt:[n]%   | First n characters of positive prompt |
| %nprompt%       | Negative prompt                       |
| %nprompt:[n]%   | First n characters of negative prompt |
| %model%         | Checkpoint name                       |
| %model:[n]%     | First n characters of checkpoint name |
| %date%          | Date of generation (yyyyMMddhhmmss)  |
| %date:[format]% | Date of generation                    |

- See the following table for the identifiers specified by `[format]` in `%date:[format]%`:

| Identifier | Description                 |
| ---------- | --------------------------- |
| yyyy       | Year                        |
| MM         | Month                       |
| dd         | Day                         |
| hh         | Hour                        |
| mm         | Minute                      |
| ss         | Second                      |

## Supported Nodes and Extensions

- **Comfy Core Nodes**:
  - [modules/defs/samplers.py](modules/defs/samplers.py)
  - [modules/defs/captures.py](modules/defs/captures.py)

- **Third-Party Nodes**:
  - [modules/defs/ext/](modules/defs/ext/)

> [!TIP]  
> If you encounter errors with the "full" metadata scope, it may be because your third-party nodes are not supported. In that case, you can either use alternative nodes from Comfy Core or create a custom extension in the [ext](modules/defs/ext/) folder.