Nodes Browser
ComfyDeploy: How ComfyUI-ImageMetadataExtension works in ComfyUI?
What is ComfyUI-ImageMetadataExtension?
Custom node for ComfyUI. It adds additional metadata for saved images, ensuring compatibility with the Civitai website.
How to install it in ComfyDeploy?
Head over to the machine page
- Click on the "Create a new machine" button
- Select the
Edit
build steps - Add a new step -> Custom Node
- Search for
ComfyUI-ImageMetadataExtension
and select it - Close the build step dialig and then click on the "Save" button to rebuild the machine
ComfyUI-ImageMetadataExtension
Custom node for ComfyUI. It adds additional metadata for saved images, ensuring compatibility with the Civitai website.
This is a fork of 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) 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
field allows you to specify the format for saving images. Supported formats include PNG, JPG, and WebP. - The
metadata_scope
option includes the following levels:full
– includes default metadata plus extra metadata.default
– same as the SaveImage node.workflow_only
– workflow metadata only.none
– no metadata.
Installation
Recommended Installation
Use the ComfyUI-Manager to install.
ComfyUI-ImageMetadataExtension
Manual Installation
- Navigate to the
custom_nodes
directory inside your ComfyUI folder. - Clone this repository:
cd <ComfyUI directory>/custom_nodes
git clone https://github.com/edelvarden/ComfyUI-ImageMetadataExtension.git
Usage
Basic usage looks like (workflow.json):
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.
Formatting Options
- The
filename_prefix
andsubdirectory_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 | | yy | Short year format | | MM | Month | | dd | Day | | hh | Hour | | mm | Minute | | ss | Second |