comfyui-prompt-reader-node
comfyui-prompt-reader-node copied to clipboard
The ultimate solution for managing image metadata and multi-tool compatibility. ComfyUI node version of the SD Prompt Reader
![icon](https://github.com/receyuki/stable-diffusion-prompt-reader/raw/master/sd_prompt_reader/resources/icon-cube.png)
SD Prompt Reader Node
This is a subproject of the
SD Prompt Reader.
It helps you extract metadata from images in any format supported by the
SD Prompt Reader and saves the images with
additional metadata to ensure compatibility with metadata detection on websites such as Civitai.
Supported Formats • Installation • Usage • Change Log • Credits
![](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/screenshot_v130.png)
Supported Formats
PNG | JPEG | WEBP | TXT* | |
---|---|---|---|---|
A1111's webUI | ✅ | ✅ | ✅ | ✅ |
Easy Diffusion | ✅ | ✅ | ✅ | |
StableSwarmUI* | ✅ | ✅ | ||
StableSwarmUI (prior to 0.5.8-alpha)* | ✅ | ✅ | ||
Fooocus-MRE* | ✅ | ✅ | ||
NovelAI (stealth pnginfo) | ✅ | ✅ | ||
NovelAI (legacy) | ✅ | |||
InvokeAI | ✅ | |||
InvokeAI (prior to 2.3.5-post.2) | ✅ | |||
InvokeAI (prior to 1.15) | ✅ | |||
ComfyUI* | ✅ | |||
Draw Things | ✅ | |||
Naifu(4chan) | ✅ |
See SD Prompt Reader for details
Installation
[!NOTE] While ZIP package is available, it is strongly recommended not to use it for installation.
Install and update via ComfyUI Manager (Recommended)
Search for SD Prompt Reader
in the ComfyUI Manager and install it.
Install manually
Please make sure to install the submodules along with the main repository.
-
cd
to thecustom_node
folder - Clone this repo
git clone --recursive https://github.com/receyuki/comfyui-prompt-reader-node.git
- Install dependencies
cd comfyui-prompt-reader-node pip install -r requirements.txt
Update
When updating, don't forget to include the submodules along with the main repository.
git pull --recurse-submodules
Usage
Prompt Reader Node
![reader node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/reader.png)
- The
Prompt Reader
Node works exactly the same as the standalone SD Prompt Reader. It uses the Image Data Reader from the standalone SD Prompt Reader, allowing it to support the same formats and receive updates along with the SD Prompt Reader.
[!IMPORTANT] Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability to read image metadata correctly, it is recommended to embed the
Prompt Saver
Node within the workflow to ensure maximum compatibility.
More Information
parameter_index
- For images containing multiple sets of parameters, such as those processed through
hires-fix
orrefiner
, you will need to modify theparameter_index
to select the parameters you need
SDXL
- For images generated by SDXL and containing multiple sets of prompts,
the
text_g
will be combined withtext_l
into a single prompt
Batch Read
- For batch processing, please use the
Batch Loader
node. When using theBatch Loader
node for bulk reading, the preview image will not update, and the text box will only display the metadata of the last image.
![connect batch loader to prompt reader](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/loader2reader.png)
Additional Parameters
- To read parameters other than the existing output, please connect the
settings
to theParameter Extractor
node.
![connect prompt reader to parameter extractor](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/reader2extractor.png)
MODEL_NAME
-
MODEL_NAME
is a special output that matches the model name in the metadata with the existing models on the server according to the following priority:- Identical path, filename, and extension.
- Identical filename, and extension.
e.g.
sd_xl_base.safetensors
will be matched withSDXL\sd_xl_base.safetensors
, and vice versa. - Identical filename.
e.g.
sd_xl_base
will be matched withSDXL\sd_xl_base.safetensors
, and vice versa. - If a matching model cannot be found, the original name will be outputted.
Prompt Saver Node
![saver node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/saver.png)
- The
Prompt Saver
Node and theParameter Generator
Node are designed to be used together. - The
Prompt Saver
Node will write additional metadata in the A1111 format to the output images to be compatible with any tools that support the A1111 format, including SD Prompt Reader and Civitai. - Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability to read image metadata correctly, it's recommended to embed this node within the workflow to ensure maximum compatibility.
[!TIP] Since it's not possible to directly extract metadata from
KSampler
, it's necessary to use theParameter Generator
Node to generate parameters and simultaneously output them to thePrompt Saver
Node andKSampler
Node.
More Information
Image Format
- Only PNG format supports embedding both metadata and workflow at the same time. Other formats can only embed metadata.
Duplicate Filename
- When the filename already exists, an index will be added at the end of the filename,
e.g.
file.png, file_1.png, file_2.png
.
Hashes & Auto-Detection on Civitai
- When
calculate_hash
is enabled, the node will compute the hash values of checkpoint, VAE, Lora, and embedding/Textual Inversion, and write them into the metadata. After the server restarts, or a new checkpoint, VAE, Lora, or embedding/Textual Inversion is loaded, the first image generation may take a longer time for hash calculation. The hash value will be stored in temporary storage without the need for repeated calculation, until the server is restarted. - When
resource_hash
is enabled, the resource hashes will be written into the metadata to support auto-detection on Civitai. This function will only run whencalculate_hash
is enabled. - If you need to calculate the hash of Lora, please use the
Lora Loader
Node or theLora Selector
Node. The hash value of the embedding/Textual Inversion will be automatically detected from the prompt.
save_metadata_file
- When the
save_metadata_file
is turned on, the metadata will be saved as a TXT file with the same name alongside the image.
date_format
& time_format
- For the
date_format
andtime_format
, please refer to strftime.org or www.strfti.me.
filename
& path
-
%counter
cannot be used forpath
, it can only be used forfilename
. This%counter
is slightly different from the%counter
in the built-inSaver
node, it will count all image files in thepath
. -
Please refer to the following table for placeholders supported by the
filename
andpath
.%seed %date %steps %time %cfg %counter %model %extension %sampler %quality %scheduler
Parameter Generator Node
![generator node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/generator.png)
- Since it's not possible to directly extract metadata from
KSampler
, it's necessary to use theParameter Generator
Node to generate parameters and simultaneously output them to both thePrompt Saver
Node andKSampler
Node.
[!TIP] The
Parameter Generator
Node can also be used as a control panel for complex ComfyUI workflows, just like the AP workflow.
More Information
Optimal Resolution
- The
model_version
andaspect_ratio
are used only for calculating the optimal resolution of the selected model version under the chosen aspect ratio. The calculation method is based on the Stability AI development documentation and the StableSwarmUI source code (developed by Stability AI).
refiner_start
-
refiner_start
refers to the proportion of steps completed when the refiner starts running, i.e., the proportion of base steps to total steps. This is used to calculate thestart_at_step
(REFINER_START_STEP
) required by the refinerKSampler
under the selected step ratio.
Batch Loader Node
![loader node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/loader.png)
- The
Batch Loader
Node is specifically designed for thePrompt Reader
Node to batch-read image files in a directory and cannot be used with other custom nodes.
More Information
- For batch processing, please connect the
IMAGE
output of theBatch Loader
Node to theimage
input of thePrompt Reader
Node.
![connect prompt reader to parameter extractor](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/loader2reader.png)
path
- The
path
supports relative paths such as./input/
or absolute paths likeC:/Users/receyuki/Pictures
. - Both
\
and/
are acceptable. - You can also input a single file or a list of files into the
path
, in which case theimage_load_limit
andstart_index
will not function.
Parameter Extractor Node
![extractor node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/extractor.png)
- The
Parameter Extractor
Node is an extension of thePrompt Reader
Node, designed to retrieve the values of all parameters in the settings (including those parameters that thePrompt Reader
Node cannot output). e.g.Hires upscaler
More Information
- Connect the
SETTINGS
of thePrompt Reader
Node to thesettings
of theParameter Extractor
Node. After the first run, the parameter list will be loaded.
![connect prompt reader to parameter extractor](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/reader2extractor.png)
Prompt Merger Node & Type Converter Node
![merger and converter node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/merger_converter.png)
- Since the A1111 format cannot store
text_g
andtext_l
separately, SDXL users need to use thePrompt Merger
Node to combinetext_g
andtext_l
into a single prompt. - Since
model_name
,sampler_name
, andscheduler
are special types that cannot be directly used by some other nodes, You can use theType Converter
Node to convert them intoSTRING
type.
Lora Loader Node & Lora Selector Node
![lora loader and selector node](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/lora.png)
- The
Lora Loader
Node andLora Selector
Node are used to write Lora data into metadata and support auto-detection on Civitai.
More Information
- Replace the original loader with the
Lora Loader
Node, or connect theLORA_NAME
output of theLora Selector
Node to thelora_name
input of other lora loaders (built-in or custom), and link theNEXT_LORA
output to thelora_name
input of thePrompt Saver
Node. Both of these nodes have the same function, please choose according to your needs.
Multiple Loras
- If you need to load multiple Loras, please connect the
Lora Loader
Node orLora Selector
Node head to tail throughlast_lora
andNEXT_LORA
, and connect theNEXT_LORA
at the end of the Lora chain to thelora_name
input of thePrompt Saver
Node.
- Lora Loader chain
![lora loader chain](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/lora_loader_chain.png)
- Lora Selector chain
![lora loader chain](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/images/lora_selector_chain.png)
Example Workflow
Simple Example
![example workflow](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/workflows/simple_example.png)
Lora Example
![example workflow](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/workflows/lora_example.png)
Hires-fix Example
![example workflow](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/workflows/hires_fix_example.png)
SDXL Example
![example workflow](https://github.com/receyuki/comfyui-prompt-reader-node/raw/main/workflows/sdxl_example.png)
Credits
- The SD Prompt Reader node is based on ComfyUI Load Image With Metadata
- The SD Prompt Saver node is based on Comfy Image Saver & Stable Diffusion Webui
- The seed generator in the SD Parameter Generator is modified from rgthree's Comfy Nodes
- A special thanks to @alessandroperilli and his AP Workflow for providing numerous suggestions