Merge pull request #107 from Comfy-Org/main

Checkout submodules before publishing

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -34,14 +34,3 @@ body:
         ![DESCRIPTION](LINK.png)
     validations:
       required: false
-  - type: dropdown
-    id: version
-    attributes:
-      label: "Version"
-      description: What version are you running?
-      multiple: false
-      options:
-        - 1.0.0
-      default: 0
-    validations:
-      required: false

.github/workflows/package_repo.yml

@@ -36,7 +36,10 @@ jobs:
 
     - name: Extract Section
       id: extract_section
-      run: sed -n '/## Installation/,/## Usage/ {/## Usage/!p;}' README.md > installation.md
+      run: |
+        tag_name="${{ env.TAG_NAME }}"
+        sed -n "/## $tag_name/,/## /p" CHANGELOG.md | sed '$d' >> installation.md
+        sed -n '/## Installation/,/## Usage/ {/## Usage/!p;}' README.md >> installation.md
     
     - name: Create GitHub Release
       uses: softprops/action-gh-release@v1

.github/workflows/publish_registry.yml

@@ -0,0 +1,22 @@
+name: Publish to Comfy registry
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "pyproject.toml"
+
+jobs:
+  publish-node:
+    name: Publish Custom Node to registry
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Publish Custom Node
+        uses: Comfy-Org/publish-node-action@main
+        with:
+          personal_access_token: ${{ secrets.REGISTRY_ACCESS_TOKEN }}

.gitignore

@@ -153,3 +153,4 @@ dmypy.json
 cython_debug/
 
 .idea/
+preview/

CHANGELOG.md

@@ -0,0 +1,105 @@
+# Change Log
+## v1.3.4
+> [!TIP]
+> Starting from v1.3, to support auto-detection on Civitai, `calculate_model_hash` will be renamed as 
+> `calculate_hash` and it will be enabled by default. Due to the addition of temporary storage of the model hash values,
+> the first image generated after switching to the new model will take more time to calculate the hash value, 
+> but it will not affect the generation speed afterwards until the server is restarted.
+
+> [!NOTE]
+> comfyui-prompt-reader-node is now published on the [Comfy Registry](https://www.comfyregistry.org/).
+
+- Add `Any Converter` node #76 #78
+- Fix the input validation of the `Parameter Generator` node #89
+- Fix the input validation of the `Parameter Extractor` node #90
+- Fix the `Parameter Generator` unable to choose standard resolutions #82
+- Fix the `Prompt Saver` unable to correctly handle filenames containing `.` #80
+- Update the `Parameter Extractor` node to support parsing quoted parameters #87 @spagatticode
+- Update PyProject Toml - License #85 @haohaocreates
+
+## v1.3.3
+> [!TIP]
+> Starting from v1.3, to support auto-detection on Civitai, `calculate_model_hash` will be renamed as 
+> `calculate_hash` and it will be enabled by default. Due to the addition of temporary storage of the model hash values,
+> the first image generated after switching to the new model will take more time to calculate the hash value, 
+> but it will not affect the generation speed afterwards until the server is restarted.
+
+> [!NOTE]
+> comfyui-prompt-reader-node is now published on the [Comfy Registry](https://www.comfyregistry.org/).
+
+- Add pyproject.toml for Custom Node Registry #75 @haohaocreates
+
+## v1.3.2
+> Starting from v1.3, to support auto-detection on Civitai, `calculate_model_hash` will be renamed as 
+> `calculate_hash` and it will be enabled by default. Due to the addition of temporary storage of the model hash values,
+> the first image generated after switching to the new model will take more time to calculate the hash value, 
+> but it will not affect the generation speed afterwards until the server is restarted.
+
+- Add support for pasted images to the `Prompt Reader` node #64
+- Update core to [1.3.5](https://github.com/receyuki/stable-diffusion-prompt-reader/releases/tag/v1.3.5)
+- Update nodes.py save_images to have %width and %height #66 @COvert96
+- Update the `Prompt Reader` node to the new exception handling method
+
+## v1.3.1
+> Starting from v1.3, to support auto-detection on Civitai, `calculate_model_hash` will be renamed as 
+> `calculate_hash` and it will be enabled by default. Due to the addition of temporary storage of the model hash values,
+> the first image generated after switching to the new model will take more time to calculate the hash value, 
+> but it will not affect the generation speed afterwards until the server is restarted.
+
+- Add user-friendly warnings and remove the exception raised during the reading of metadata #58 #63
+- Add JPEG to the image extension list
+- Fix the issue where the `Prompt Saver` node cannot consume filename from another `Prompt Saver` node #62
+- Fix the `Prompt Saver` node freezes workflow when name includes `%model` #61
+- Remove ckpt validation of the `Prompt Reader` node #59
+
+## v1.3.0
+> Starting from this version, to support auto-detection on Civitai, `calculate_model_hash` will be renamed as 
+> `calculate_hash` and it will be enabled by default. Due to the addition of temporary storage of the model hash values,
+> the first image generated after switching to the new model will take more time to calculate the hash value, 
+> but it will not affect the generation speed afterwards until the server is restarted.
+
+- Add `Lora Loader` node and `Lora Selector` node
+- Add `VAE_NAME` output to the `Parameter Generator` node and add `vae_name` input to the `Prompt Saver` node #39
+- Add `lora_name` input to the `Prompt Saver` node
+- Add `resource_hash` switch to the `Prompt Saver` node
+- Add resources hashes to metadata for auto-detection on Civitai #35
+- Add temporary storage for model hashes
+- Add `WEB_DIRECTORY` and remove old js directory
+- Fix adding the `Parameter Generator` node to a workflow disables the queue button #45
+- Fix the `Parameter Generator` node doesn't load seed value from generated images #44
+- Fix the input validation of the `Batch Loader` node #37 #38
+- Fix the parsing error caused by the loss of model data #43
+- Fix the error message caused by aspect_ratio
+- Rename `calculate_model_hash` as `calculate_hash`
+- Update seedGen.js to rgthree's latest code
+- Update core to cc3c8b2
+
+## v1.2.1
+- Fix the input validation of the `Prompt Reader` node #37
+- Fix the `Batch Loader` node not working when not connected to any node
+
+## v1.2.0
+- Add `Parameter Extractor` node #24
+- Add a model matching feature to the `Prompt Reader` node #24
+- Add `save_metadata_file` option to the `Prompt Saver` node #30
+- Add `FILE_PATH` output to the `Prompt Saver` node #26
+- Fix the issue where the `Prompt Merger` node threw an error when merging empty strings #29
+- Enhance the `Batch Loader` node to support processing either a single file or a list of files #26
+- Update core to 1.3.4.post1
+
+## v1.1.0
+- Add `Batch Loader` node #13
+- Add `MODEL_NAME` output to the `Prompt Reader` node #23
+- Add VAE selector to the `Parameter Generator` node #15
+- Add pixel dimensions display to the `aspect_ratio` in the `Parameter Generator` node #6
+- Add Positive and Negative Aesthetic Score to the `PARAMETERS` in the `Parameter Generator` node #8
+- Add `FILENAME` and `METADATA` output to the `Prompt Saver` node #16
+
+## v1.0.1
+- Add a new file-naming mechanism to ensure naming uniqueness
+- Fix `%counter` overwriting existing images #11 #14
+- Fix the bug causing the `Prompt Saver` node fails to save images in jpg and webp formats #10
+- Use relative paths for js imports #12
+
+## v1.0.0
+- Initial release

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img alt="icon" src="https://github.com/receyuki/stable-diffusion-prompt-reader/raw/master/sd_prompt_reader/resources/icon.png" width=20% height=20%>
+    <img alt="icon" src="https://github.com/receyuki/stable-diffusion-prompt-reader/raw/master/sd_prompt_reader/resources/icon-cube.png" width=20% height=20%>
     <h1>SD Prompt Reader Node</h1>
     <a href="https://github.com/receyuki/comfyui-prompt-reader-node/blob/master/LICENSE">
         <img alt="GitHub" src="https://img.shields.io/github/license/receyuki/comfyui-prompt-reader-node"></a>
@@ -20,29 +20,35 @@ additional metadata to ensure compatibility with metadata detection on websites
     <a href="#supported-formats">Supported Formats</a> •
     <a href="#installation">Installation</a> •
     <a href="#usage">Usage</a> •
+    <a href="./CHANGELOG.md">Change Log</a> •
     <a href="#credits">Credits</a>
   </p>
-    <img src="./images/screenshot_v100.png">
+    <img src="./images/screenshot_v130.png">
 </div>
 
 
 ## Supported Formats
 |                                                                                        | PNG | JPEG | WEBP | TXT* |
-|--------------------------------------------------------------------------|:---:|:----:|:----:|:----:|
+|----------------------------------------------------------------------------------------|:---:|:----:|:----:|:----:|
 | [A1111's webUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui)               |  ✅  |  ✅   |  ✅   |  ✅   |
 | [Easy Diffusion](https://github.com/easydiffusion/easydiffusion)                       |  ✅  |  ✅   |  ✅   |      |
 | [StableSwarmUI](https://github.com/Stability-AI/StableSwarmUI)*                        |  ✅  |  ✅   |      |      |
+| [StableSwarmUI (prior to 0.5.8-alpha)](https://github.com/Stability-AI/StableSwarmUI)* |  ✅  |  ✅   |      |      |
 | [Fooocus-MRE](https://github.com/MoonRide303/Fooocus-MRE)*                             |  ✅  |  ✅   |      |      |
+| [NovelAI (stealth pnginfo)](https://novelai.net/)                                      |  ✅  |      |  ✅   |      |
+| [NovelAI (legacy)](https://novelai.net/)                                               |  ✅  |      |      |      |
 | [InvokeAI](https://github.com/invoke-ai/InvokeAI)                                      |  ✅  |      |      |      |
+| [InvokeAI (prior to 2.3.5-post.2)](https://github.com/invoke-ai/InvokeAI)              |  ✅  |      |      |      |
+| [InvokeAI (prior to 1.15)](https://github.com/invoke-ai/InvokeAI)                      |  ✅  |      |      |      |
 | [ComfyUI](https://github.com/comfyanonymous/ComfyUI)*                                  |  ✅  |      |      |      |
-| [NovelAI](https://novelai.net/)                                          |  ✅  |      |      |      |
 | [Draw Things](https://drawthings.ai/)                                                  |  ✅  |      |      |      |
 | Naifu(4chan)                                                                           |  ✅  |      |      |      |
 
 See [SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader#supported-formats) for details
 
 ## Installation
->While ZIP package is available, it is strongly recommended not to use it for installation.
+> [!NOTE]
+> While ZIP package is available, it is strongly recommended not to use it for installation.
 ### Install and update via [ComfyUI Manager](https://github.com/ltdrdata/ComfyUI-Manager) (Recommended)
 Search for `SD Prompt Reader` in the ComfyUI Manager and install it.
 ### Install manually
@@ -65,91 +71,250 @@ git pull --recurse-submodules
 
 ## Usage
 ### Prompt Reader Node
+<div align="center">
+   <img src="./images/reader.png" width="25%" height="25%" alt="reader node">
+</div>
+
 - The `Prompt Reader` Node works exactly the same as the 
 [standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader). 
 It uses the Image Data Reader from the 
 [standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader), 
 allowing it to support the same formats and receive updates along with the 
 [SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader).
-- Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability 
+> [!IMPORTANT]
-to read image metadata correctly, it is recommended to embed the `Prompt Saver` Node within the workflow 
+> Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability 
-to ensure maximum compatibility.   
+> to read image metadata correctly, it is recommended to embed the `Prompt Saver` Node within the workflow 
+> to ensure maximum compatibility.
+
+<details>
+    <summary><b>More Information</b></summary>
+
+#### `parameter_index`
 - For images containing multiple sets of parameters, such as those processed through `hires-fix` or `refiner`, 
 you will need to modify the `parameter_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 with `text_l` into a single prompt
-
+#### Batch Read
+- For batch processing, please use the `Batch Loader` node. When using the `Batch Loader` node for bulk reading, 
+the preview image will not update, and the text box will only display the metadata of the last image.
 <div align="center">
-   <img src="./images/reader.png" width="25%" height="25%" alt="reader node">
+   <img src="./images/loader2reader.png" width="50%" height="50%" alt="connect batch loader to prompt reader">
 </div>
 
+#### Additional Parameters
+- To read parameters other than the existing output, please connect the `settings` to the `Parameter Extractor` node.
+<div align="center">
+   <img src="./images/reader2extractor.png" width="50%" height="50%" alt="connect prompt reader to parameter extractor">
+</div>
+
+#### `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:
+  1. Identical path, filename, and extension.
+  2. Identical filename, and extension. 
+e.g. `sd_xl_base.safetensors` will be matched with `SDXL\sd_xl_base.safetensors`, and vice versa.
+  3. Identical filename.
+e.g. `sd_xl_base` will be matched with `SDXL\sd_xl_base.safetensors`, and vice versa.
+  4. If a matching model cannot be found, the original name will be outputted.
+
+</details>
+
 ### Prompt Saver Node
-- The `Prompt Saver` Node and The `Parameter Generator` Node are designed to be used together.  
+<div align="center">
+   <img src="./images/saver.png" width="25%" height="25%" alt="saver node">
+</div>
+
+- The `Prompt Saver` Node and the `Parameter 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 
+- 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 this node within the workflow 
+to read image metadata correctly, it's recommended to embed this node within the workflow 
 to ensure maximum compatibility.
-- Since it's not possible to directly extract metadata from `KSampler`, it is necessary to 
+> [!TIP]
-use the `Parameter Generator` Node to generate parameters and simultaneously output them to both 
+> Since it's not possible to directly extract metadata from `KSampler`, it's necessary to 
-the `Prompt Saver` Node and `KSampler`.
+> use the `Parameter Generator` Node to generate parameters and simultaneously output them to 
-- Please refer to the following table for placeholders supported by the `filename` and `path`.
+> the `Prompt Saver` Node and `KSampler` Node.
 
-   | Placeholder |
+<details>
-   |-------------|
+    <summary><b>More Information</b></summary>
-   | %date       |
-   | %time       |
-   | %counter    |
-   | %seed       |
-   | %steps      |
-   | %cfg        |
-   | %extension  |
-   | %model      |
-   | %sampler    |
-   | %scheduler  |
-   | %quality    |
 
+#### 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 when `calculate_hash` is enabled.
+- If you need to calculate the hash of Lora, please use the `Lora Loader` Node or the `Lora 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` and `time_format`, please refer to 
 [strftime.org](https://strftime.org/) or [www.strfti.me](https://www.strfti.me/).
+#### `filename` & `path`
+- `%counter` cannot be used for `path`, it can only be used for `filename`. This `%counter` is slightly different 
+from the `%counter` in the built-in `Saver` node, it will count all image files in the `path`.
+- Please refer to the following table for placeholders supported by the `filename` and `path`.
 
+   |            |            |
+   |------------|------------|
+   | %seed      | %date      |
+   | %steps     | %time      |
+   | %cfg       | %counter   |
+   | %model     | %extension |
+   | %sampler   | %quality   |
+   | %scheduler |            |
+
+</details>
+
+### Parameter Generator Node
 <div align="center">
-   <img src="./images/saver.png" width="25%" height="25%" alt="generator and saver node">
+   <img src="./images/generator.png" width="25%" height="25%" alt="generator node">
 </div>
 
-## Parameter Generator Node
+- Since it's not possible to directly extract metadata from `KSampler`, it's necessary to 
-- Since it's not possible to directly extract metadata from `KSampler`, it is necessary to 
 use the `Parameter Generator` Node to generate parameters and simultaneously output them to both 
-the `Prompt Saver` Node and `KSampler`.
+the `Prompt Saver` Node and `KSampler` Node.
-- The `model_version` and `aspect_ratio` are used only for calculating the optimal resolution of the selected model version 
+> [!TIP]
-under the chosen aspect ratio. The calculation method is based on the 
+> The `Parameter Generator` Node can also be used as a control panel for complex ComfyUI workflows, just like the [AP workflow](https://perilli.com/ai/comfyui/).
+
+<details>
+    <summary><b>More Information</b></summary>
+
+#### Optimal Resolution
+- The `model_version` and `aspect_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](https://platform.stability.ai/docs/features/api-parameters#about-dimensions) 
 and the [StableSwarmUI source code](https://github.com/Stability-AI/StableSwarmUI) (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 the `start_at_step` (`REFINER_START_STEP`)
 required by the refiner `KSampler` under the selected step ratio.
 
+</details>
+
+### Batch Loader Node
 <div align="center">
-   <img src="./images/generator.png" width="25%" height="25%" alt="generator and saver node">
+   <img src="./images/loader.png" width="25%" height="25%" alt="loader node">
 </div>
 
+- The `Batch Loader` Node is specifically designed for the `Prompt Reader` Node to batch-read image files in a directory 
+and cannot be used with other custom nodes.
+<details>
+    <summary><b>More Information</b></summary>
+
+- For batch processing, please connect the `IMAGE` output of the `Batch Loader` Node to the `image` input of 
+the `Prompt Reader` Node.
+<div align="center">
+   <img src="./images/loader2reader.png" width="50%" height="50%" alt="connect prompt reader to parameter extractor">
+</div>
+
+#### `path`
+- The `path` supports relative paths such as `./input/` or absolute paths like `C:/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 the `image_load_limit` and `start_index` will not function.
+
+</details>
+
+### Parameter Extractor Node
+<div align="center">
+   <img src="./images/extractor.png" width="25%" height="25%" alt="extractor node">
+</div>
+
+- The `Parameter Extractor` Node is an extension of the `Prompt Reader` Node, designed to retrieve the values 
+of all parameters in the settings (including those parameters that the `Prompt Reader` Node cannot output). 
+e.g. `Hires  upscaler`
+<details>
+    <summary><b>More Information</b></summary>
+
+- Connect the `SETTINGS` of the `Prompt Reader` Node to the `settings` of the `Parameter Extractor` Node. 
+After the first run, the parameter list will be loaded.
+<div align="center">
+   <img src="./images/reader2extractor.png" width="50%" height="50%" alt="connect prompt reader to parameter extractor">
+</div>
+</details>
+
 ### Prompt Merger Node & Type Converter Node
+<div align="center">
+   <img src="./images/merger_converter.png" width="25%" height="25%" alt="merger and converter node">
+</div>
+
 - Since the A1111 format cannot store `text_g` and `text_l` separately, SDXL users need to use 
 the `Prompt Merger` Node to combine `text_g` and `text_l` into a single prompt.
 - Since `model_name`, `sampler_name`, and `scheduler` are special types 
 that cannot be directly used by some other nodes,
 You can use the `Type Converter` Node to convert them into `STRING` type.
 
+### Lora Loader Node & Lora Selector Node
 <div align="center">
-   <img src="./images/merger_converter.png" width="25%" height="25%" alt="merger and converter node">
+   <img src="./images/lora.png" width="50%" height="50%" alt="lora loader and selector node">
 </div>
 
-### [Example Workflow](./workflows/example_workflow.json)
+- The `Lora Loader` Node and `Lora Selector` Node are used to write Lora data into metadata and support auto-detection
+on Civitai. 
+<details>
+    <summary><b>More Information</b></summary>
 
+- Replace the original loader with the `Lora Loader` Node, or connect the `LORA_NAME` output of the `Lora Selector` Node
+to the `lora_name` input of other lora loaders (built-in or custom), and link the `NEXT_LORA` output to the `lora_name` 
+input of the `Prompt 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 or `Lora Selector` Node head to tail 
+through `last_lora` and `NEXT_LORA`, and connect the `NEXT_LORA` at the end of the Lora chain to the `lora_name` input 
+of the `Prompt Saver` Node.
+1. Lora Loader chain
 <div align="center">
-   <img src="./images/example_workflow.png" width="100%" height="100%" alt="example workflow">
+    <img src="./images/lora_loader_chain.png" width="100%" height="100%" alt="lora loader chain">
 </div>
 
+2. Lora Selector chain
+<div align="center">
+    <img src="./images/lora_selector_chain.png" width="100%" height="100%" alt="lora loader chain">
+</div>
+
+</details>
+
+### Example Workflow
+<details>
+    <summary><b>Simple Example</b></summary>
+<div align="center">
+   <img src="./workflows/simple_example.png" width="100%" height="100%" alt="example workflow">
+</div>
+</details>
+
+<details>
+    <summary><b>Lora Example</b></summary>
+<div align="center">
+   <img src="./workflows/lora_example.png" width="100%" height="100%" alt="example workflow">
+</div>
+</details>
+
+<details>
+    <summary><b>Hires-fix Example</b></summary>
+<div align="center">
+   <img src="./workflows/hires_fix_example.png" width="100%" height="100%" alt="example workflow">
+</div>
+</details>
+
+<details>
+    <summary><b>SDXL Example</b></summary>
+<div align="center">
+   <img src="./workflows/sdxl_example.png" width="100%" height="100%" alt="example workflow">
+</div>
+</details>
+
+
 ## Credits
 - The SD Prompt Reader node is based on [ComfyUI Load Image With Metadata](https://github.com/tkoenig89/ComfyUI_Load_Image_With_Metadata)
 - The SD Prompt Saver node is based on [Comfy Image Saver](https://github.com/giriss/comfy-image-saver) & [Stable Diffusion Webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui)

__init__.py

@@ -6,14 +6,10 @@ import shutil
 import folder_paths
 import os
 
+WEB_DIRECTORY = "./js"
+
+# remove old directory
 comfy_path = os.path.dirname(folder_paths.__file__)
-tk_nodes_path = os.path.join(os.path.dirname(__file__))
+old_dir = os.path.join(comfy_path, "web", "extensions", "SDPromptReader")
-
+if os.path.exists(old_dir):
-js_dest_path = os.path.join(comfy_path, "web", "extensions", "SDPromptReader")
+    shutil.rmtree(old_dir)
-os.makedirs(js_dest_path, exist_ok=True)
-
-files_to_copy = ["promptDisplay.js", "parameterDisplay.js", "seedGen.js"]
-
-for file in files_to_copy:
-    js_src_path = os.path.join(tk_nodes_path, "js", file)
-    shutil.copy(js_src_path, js_dest_path)

__version__.py

@@ -1 +1 @@
-VERSION = "1.0.0"
+VERSION = "1.3.4"

js/extractorDisplay.js

@@ -0,0 +1,31 @@
+import {app} from "../../scripts/app.js";
+import {ComfyWidgets} from "../../scripts/widgets.js";
+import {createTextWidget} from "./utils.js"
+
+app.registerExtension({
+    name: "sd_prompt_reader.extractorDisplay",
+    async beforeRegisterNodeDef(nodeType, nodeData, app) {
+        if (nodeData.name === "SDParameterExtractor") {
+            const onNodeCreated = nodeType.prototype.onNodeCreated;
+
+            nodeType.prototype.onNodeCreated = function () {
+                const result = onNodeCreated?.apply(this, arguments);
+
+                // Create widgets
+                const styles = {textAlign: "center", fontSize: "0.75rem"}
+                const value_display =  createTextWidget(app, this, "value_display", styles);
+            };
+
+            // Update widgets
+            const onExecuted = nodeType.prototype.onExecuted;
+            nodeType.prototype.onExecuted = function (message) {
+                onExecuted?.apply(this, arguments);
+                this.widgets.find(obj => obj.name === "value_display").value = message.text[1]
+                this.widgets.find(obj => obj.name === "parameter").options.values = message.text[0]
+                if (this.widgets.find(obj => obj.name === "parameter").value === "parameters not loaded") {
+                    this.widgets.find(obj => obj.name === "parameter").value = message.text[0][0]
+                }
+            };
+        }
+    },
+});

js/loaderDisplay.js

@@ -0,0 +1,30 @@
+import {app} from "../../scripts/app.js";
+import {ComfyWidgets} from "../../scripts/widgets.js";
+import {createTextWidget} from "./utils.js"
+
+// Displays file list on the node
+app.registerExtension({
+    name: "sd_prompt_reader.loaderDisplay",
+    async beforeRegisterNodeDef(nodeType, nodeData, app) {
+        if (nodeData.name === "SDBatchLoader") {
+            const onNodeCreated = nodeType.prototype.onNodeCreated;
+
+            nodeType.prototype.onNodeCreated = function () {
+                const result = onNodeCreated?.apply(this, arguments);
+
+                // Create prompt and setting widgets
+                const styles = {opacity: 0.7}
+                const fileList =createTextWidget(app, this, "fileList", styles);
+                return result;
+            };
+
+            // Update widgets
+            const onExecuted = nodeType.prototype.onExecuted;
+            nodeType.prototype.onExecuted = function (message) {
+                onExecuted?.apply(this, arguments);
+                this.widgets.find(obj => obj.name === "fileList").value = message.text[0];
+
+            };
+        }
+    },
+});

js/parameterDisplay.js

@@ -1,14 +1,6 @@
-import {app} from "/scripts/app.js";
+import {app} from "../../scripts/app.js";
-import {ComfyWidgets} from "/scripts/widgets.js";
+import {ComfyWidgets} from "../../scripts/widgets.js";
-
+import {createTextWidget} from "./utils.js"
-// Create a read-only string widget
-function createWidget(app, node, widgetName, type) {
-    const widget = ComfyWidgets[type](node, widgetName, ["STRING", {multiline: true}], app).widget;
-    widget.inputEl.readOnly = true;
-    widget.inputEl.style.textAlign = "center";
-    widget.inputEl.style.fontSize = "0.75rem";
-    return widget;
-}
 
 app.registerExtension({
     name: "sd_prompt_reader.parameterDisplay",
@@ -20,8 +12,9 @@ app.registerExtension({
                 const result = onNodeCreated?.apply(this, arguments);
 
                 // Create widgets
-                const steps_display = createWidget(app, this, "steps_display", "STRING");
+                const styles = {textAlign: "center", fontSize: "0.75rem"}
-                const aspect_ratio_display = createWidget(app, this, "aspect_ratio_display", "STRING");
+                const steps_display = createTextWidget(app, this, "steps_display", styles);
+                const aspect_ratio_display = createTextWidget(app, this, "aspect_ratio_display", styles);
 
                 // Resize the node
                 const nodeWidth = this.size[0];
@@ -59,6 +52,18 @@ Refiner start at step: ${message.text[6]} (${base_percentage})`;
 
                 this.widgets.find(obj => obj.name === "steps_display").value = step_message;
                 this.widgets.find(obj => obj.name === "aspect_ratio_display").value = ar_message;
+
+                const scalingFactor = message.text[9][message.text[1]]
+                const aspectRatioArray = Object.entries(message.text[8]).map(([ratio, dimensions]) => {
+                    const [width, height] = dimensions;
+                    return `${ratio} - ${width*scalingFactor}x${height*scalingFactor}`;
+                });
+                aspectRatioArray.unshift("custom")
+                if (message.text[0] !== "custom") {
+                    const aspectRatio = `${message.text[0]} - ${message.text[8][message.text[0]][0]*scalingFactor}x${message.text[8][message.text[0]][1]*scalingFactor}`
+                    this.widgets.find(obj => obj.name === "aspect_ratio").value = aspectRatio
+                }
+                this.widgets.find(obj => obj.name === "aspect_ratio").options.values = aspectRatioArray
             };
         }
     },

js/promptDisplay.js

@@ -1,13 +1,6 @@
-import {app} from "/scripts/app.js";
+import {app} from "../../scripts/app.js";
-import {ComfyWidgets} from "/scripts/widgets.js";
+import {ComfyWidgets} from "../../scripts/widgets.js";
-
+import {createTextWidget} from "./utils.js"
-// Create a read-only string widget with opacity set
-function createWidget(app, node, widgetName) {
-    const widget = ComfyWidgets["STRING"](node, widgetName, ["STRING", {multiline: true}], app).widget;
-    widget.inputEl.readOnly = true;
-    widget.inputEl.style.opacity = 0.7;
-    return widget;
-}
 
 // Displays prompt and setting on the node
 app.registerExtension({
@@ -20,9 +13,10 @@ app.registerExtension({
                 const result = onNodeCreated?.apply(this, arguments);
 
                 // Create prompt and setting widgets
-                const positive = createWidget(app, this, "positive");
+                const styles = {opacity: 0.7}
-                const negative = createWidget(app, this, "negative");
+                const positive = createTextWidget(app, this, "positive", styles);
-                const setting = createWidget(app, this, "setting");
+                const negative = createTextWidget(app, this, "negative", styles);
+                const setting = createTextWidget(app, this, "setting", styles);
                 // Resize the node
                 const nodeWidth = this.size[0];
                 const nodeHeight = this.size[1];
@@ -34,9 +28,9 @@ app.registerExtension({
             const onExecuted = nodeType.prototype.onExecuted;
             nodeType.prototype.onExecuted = function (message) {
                 onExecuted?.apply(this, arguments);
-                this.widgets[3].value = message.text[0];
+                this.widgets.find(obj => obj.name === "positive").value = message.text[0];
-                this.widgets[4].value = message.text[1];
+                this.widgets.find(obj => obj.name === "negative").value = message.text[1];
-                this.widgets[5].value = message.text[2];
+                this.widgets.find(obj => obj.name === "setting").value = message.text[2];
             };
         }
     },

js/seedGen.js

@@ -1,16 +1,115 @@
 /**
- * Modified from: https://github.com/rgthree/rgthree-comfy/blob/main/web/seed.js
+ * Modified from: https://github.com/rgthree/rgthree-comfy/blob/main/web/comfyui/seed.js
  * Modified by: receyuki
  */
 import {app} from "../../scripts/app.js";
 import {ComfyWidgets} from "../../scripts/widgets.js";
 
-const LAST_SEED_BUTTON_LABEL = "(Use Last Queued Seed)";
+const LAST_SEED_BUTTON_LABEL = "(Use last queued seed)";
 const SPECIAL_SEED_RANDOM = -1;
 const SPECIAL_SEED_INCREMENT = -2;
 const SPECIAL_SEED_DECREMENT = -3;
 const SPECIAL_SEEDS = [SPECIAL_SEED_RANDOM, SPECIAL_SEED_INCREMENT, SPECIAL_SEED_DECREMENT];
 
+function getResolver(timeout = 5000) {
+    const resolver = {};
+    resolver.id = generateId(8);
+    resolver.completed = false;
+    resolver.resolved = false;
+    resolver.rejected = false;
+    resolver.promise = new Promise((resolve, reject) => {
+        resolver.reject = () => {
+            resolver.completed = true;
+            resolver.rejected = true;
+            reject();
+        };
+        resolver.resolve = (data) => {
+            resolver.completed = true;
+            resolver.resolved = true;
+            resolve(data);
+        };
+    });
+    resolver.timeout = setTimeout(() => {
+        if (!resolver.completed) {
+            resolver.reject();
+        }
+    }, timeout);
+    return resolver;
+}
+
+function generateId(length) {
+    const arr = new Uint8Array(length / 2);
+    crypto.getRandomValues(arr);
+    return Array.from(arr, dec2hex).join('');
+}
+
+function dec2hex(dec) {
+    return dec.toString(16).padStart(2, "0");
+}
+
+let graphResolver = null;
+
+function waitForGraph() {
+    if (graphResolver === null) {
+        graphResolver = getResolver();
+
+        function _wait() {
+            if (!graphResolver.completed) {
+                if (app === null || app === void 0 ? void 0 : app.graph) {
+                    graphResolver.resolve(app.graph);
+                } else {
+                    requestAnimationFrame(_wait);
+                }
+            }
+        }
+
+        _wait();
+    }
+    return graphResolver.promise;
+}
+
+class Rgthree extends EventTarget {
+    constructor() {
+        super();
+        this.processingQueue = false;
+        this.initialGraphToPromptSerializedWorkflowBecauseComfyUIBrokeStuff = null;
+        this.initializeGraphAndCanvasHooks();
+        this.initializeComfyUIHooks();
+    }
+
+    async initializeGraphAndCanvasHooks() {
+        const rgthree = this;
+        const [graph] = await Promise.all([waitForGraph()]);
+        const onSerialize = graph.onSerialize;
+        graph.onSerialize = (data) => {
+            this.initialGraphToPromptSerializedWorkflowBecauseComfyUIBrokeStuff = data;
+            onSerialize === null || onSerialize === void 0 ? void 0 : onSerialize.call(graph, data);
+        };
+    }
+
+    initializeComfyUIHooks() {
+        const rgthree = this;
+        const queuePrompt = app.queuePrompt;
+        app.queuePrompt = async function () {
+            rgthree.dispatchEvent(new CustomEvent("queue"));
+            rgthree.processingQueue = true;
+            try {
+                await queuePrompt.apply(app, [...arguments]);
+            } finally {
+                rgthree.processingQueue = false;
+                rgthree.dispatchEvent(new CustomEvent("queue-end"));
+            }
+        };
+    }
+
+    getNodeFromInitialGraphToPromptSerializedWorkflowBecauseComfyUIBrokeStuff(node) {
+        var _a, _b, _c;
+        return ((_c = (_b = (_a = this.initialGraphToPromptSerializedWorkflowBecauseComfyUIBrokeStuff) === null || _a === void 0 ? void 0 : _a.nodes) === null || _b === void 0 ? void 0 : _b.find((n) => n.id === node.id)) !== null && _c !== void 0 ? _c : null);
+    }
+}
+
+const rgthree = new Rgthree();
+
 class SeedControl {
     constructor(node) {
         this.lastSeed = undefined;
@@ -33,6 +132,7 @@ class SeedControl {
         for (const [i, w] of this.node.widgets.entries()) {
             if (w.name === "seed") {
                 this.seedWidget = w;
+                this.seedWidget.value = SPECIAL_SEED_RANDOM;
             } else if (w.name === "control_after_generate") {
                 this.node.widgets.splice(i, 1);
             }
@@ -58,6 +158,9 @@ class SeedControl {
         this.lastSeedButton.disabled = true;
         this.seedWidget.serializeValue = async (node, index) => {
             const inputSeed = this.seedWidget.value;
+            if (!rgthree.processingQueue) {
+                return inputSeed;
+            }
             this.serializedCtx = {
                 inputSeed: this.seedWidget.value,
             };
@@ -76,7 +179,13 @@ class SeedControl {
             } else {
                 this.serializedCtx.seedUsed = this.seedWidget.value;
             }
-            node.widgets_values[index] = this.serializedCtx.seedUsed;
+            const n = rgthree.getNodeFromInitialGraphToPromptSerializedWorkflowBecauseComfyUIBrokeStuff(node);
+            if (n) {
+                n.widgets_values[index] = this.serializedCtx.seedUsed;
+            } else {
+                console.warn('No serialized node found in workflow. May be attributed to '
+                    + 'https://github.com/comfyanonymous/ComfyUI/issues/2193');
+            }
             this.seedWidget.value = this.serializedCtx.seedUsed;
             this.lastSeed = this.serializedCtx.seedUsed;
             if (SPECIAL_SEEDS.includes(this.serializedCtx.inputSeed)) {
@@ -97,42 +206,6 @@ class SeedControl {
             }
             this.serializedCtx = {};
         };
-        this.node.getExtraMenuOptions = (_, options) => {
-            options.splice(options.length - 1, 0, {
-                content: "Show/Hide Last Seed Value",
-                callback: (_value, _options, _event, _parentMenu, _node) => {
-                    this.node.properties["showLastSeed"] = !this.node.properties["showLastSeed"];
-                    if (this.node.properties["showLastSeed"]) {
-                        this.addLastSeedValue();
-                    } else {
-                        this.removeLastSeedValue();
-                    }
-                },
-            });
-        };
-    }
-
-    addLastSeedValue() {
-        if (this.lastSeedValue)
-            return;
-        this.lastSeedValue = ComfyWidgets["STRING"](this.node, "last_seed", ["STRING", {multiline: true}], app).widget;
-        this.lastSeedValue.inputEl.readOnly = true;
-        this.lastSeedValue.inputEl.style.fontSize = "0.75rem";
-        this.lastSeedValue.inputEl.style.textAlign = "center";
-        this.lastSeedValue.serializeValue = async (node, index) => {
-            node.widgets_values[index] = "";
-            return "";
-        };
-        this.node.computeSize();
-    }
-
-    removeLastSeedValue() {
-        if (!this.lastSeedValue)
-            return;
-        this.lastSeedValue.inputEl.remove();
-        this.node.widgets.splice(this.node.widgets.indexOf(this.lastSeedValue), 1);
-        this.lastSeedValue = null;
-        this.node.computeSize();
     }
 }
 
@@ -142,12 +215,8 @@ app.registerExtension({
         if (nodeData.name === "SDParameterGenerator") {
             const onNodeCreated = nodeType.prototype.onNodeCreated;
             nodeType.prototype.onNodeCreated = function () {
-                const result = onNodeCreated?.apply(this, []);
+                onNodeCreated ? onNodeCreated.apply(this, []) : undefined;
                 this.seedControl = new SeedControl(this);
-                const nodeWidth = this.size[0];
-                const nodeHeight = this.size[1];
-                this.setSize([nodeWidth * 1.5, nodeHeight * 1.1]);
-                return result;
             };
         }
     },

js/utils.js

@@ -0,0 +1,10 @@
+import {app} from "../../scripts/app.js";
+import {ComfyWidgets} from "../../scripts/widgets.js";
+
+// Create a read-only string widget
+export function createTextWidget(app, node, widgetName, styles = {}) {
+    const widget = ComfyWidgets["STRING"](node, widgetName, ["STRING", {multiline: true}], app).widget;
+    widget.inputEl.readOnly = true;
+    Object.assign(widget.inputEl.style, styles);
+    return widget;
+}

pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "comfyui-prompt-reader-node"
+description = "The ultimate solution for managing image metadata and multi-tool compatibility. ComfyUI node version of the SD Prompt Reader."
+version = "1.3.4"
+license = { text = "MIT License" }
+dependencies = ["piexif"]
+
+[project.urls]
+Repository = "https://github.com/receyuki/comfyui-prompt-reader-node"
+#  Used by Comfy Registry https://comfyregistry.org
+
+[tool.comfy]
+PublisherId = "receyuki"
+DisplayName = "comfyui-prompt-reader-node"
+Icon = "https://raw.githubusercontent.com/receyuki/comfyui-prompt-reader-node/main/images/icon-400.png"