comfyui-workflow-templates 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

{comfyui_workflow_templates-0.1.1.dist-info → comfyui_workflow_templates-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comfyui_workflow_templates
-Version: 0.1.1
+Version: 0.1.3
 Summary: ComfyUI workflow templates package
 Author: Comfy-Org
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -686,55 +686,33 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-- [workflow\_templates](#workflow_templates)
-  - [Adding New Templates](#adding-new-templates)
-    - [1 — Find Templates Folder](#1--find-templates-folder)
-    - [2 — Obtain Workflow](#2--obtain-workflow)
-    - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
-    - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
-    - [5 — Rename and Move Files](#5--rename-and-move-files)
-    - [6 — Add Entry to `index.json`](#6--add-entry-to-indexjson)
-    - [7 — Embed Models](#7--embed-models)
-    - [8 — Embed Node Versions (optional)](#8--embed-node-versions-optional)
-    - [9 — Add Documentation Nodes (optional)](#9--add-documentation-nodes-optional)
-    - [9 — Create PR](#9--create-pr)
-    - [10 — Add Translations](#10--add-translations)
-
 # workflow_templates
 
 ComfyUI workflow templates hosted under <https://github.com/Comfy-Org/ComfyUI_frontend/tree/main/public>.
 
+- [Adding New Templates](#adding-new-templates)
+  - [1 — Find Templates Folder](#1--find-templates-folder)
+  - [2 — Obtain Workflow](#2--obtain-workflow)
+  - [3 — Obtain Thumbnails](#3--obtain-thumbnails)
+  - [4 — Choose Thumbnail Type](#4--choose-thumbnail-type)
+  - [5 — Compress Assets](#5--compress-assets)
+  - [6 — Rename and Move Files](#6--rename-and-move-files)
+  - [7 — Add Entry to `index.json`](#7--add-entry-to-indexjson)
+  - [8 — Embed Models](#8--embed-models)
+  - [9 — Embed Node Versions (optional)](#9--embed-node-versions-optional)
+  - [10 — Add Documentation Nodes (optional)](#10--add-documentation-nodes-optional)
+  - [11 — Bump Version and Create PR](#11--bump-version-and-create-pr)
+  - [12 — Add Translations](#12--add-translations)
+
 ## Adding New Templates
 
 I will demonstrate how to add a new template by walking through the process of adding the Wan text to video template.
 
 ### 1 — Find Templates Folder
 
-**Option 1**: [Set up ComfyUI_frontend dev environment](https://github.com/Comfy-Org/ComfyUI_frontend?tab=readme-ov-file#development), start the dev server and use the `ComfyUI_frontend/public/templates` folder (create it if it doesn't exist)
-
-**Option 2**: Start the virtual environment you use to run ComfyUI (if applicable), then run this command in the terminal to print the location of the templates folder:
-
-```bash
-python -c "import comfyui_frontend_package, os; print(os.path.join(comfyui_frontend_package.__path__[0], 'static', 'templates'))"
-```
-
-**Options 3**: Specify the frontend version with the `--front-end-version` argument. For example if using `1.13.5`, use the command:
-
-```bash
-python main.py --front-end-version Comfy-Org/ComfyUI_frontend@1.13.5
-```
-
-The templates folder will then be at the location:
-
-```
-ComfyUI/web_custom_versions/Comfy-Org_ComfyUI_frontend/1.13.5/templates
-```
-
-If using option 3, keep in mind local changes will be overwritten when restarting ComfyUI.
+[Set up ComfyUI_frontend dev environment](https://github.com/Comfy-Org/ComfyUI_frontend?tab=readme-ov-file#development), start the dev server.
 
-> [!IMPORTANT]
->
-> Now that you know the location, you can test changes to the templates by modifying the contents of this folder
+Copy the `templates` folder from this repository to the `ComfyUI_frontend/public` folder.
 
 ### 2 — Obtain Workflow
 
@@ -757,8 +735,8 @@ For my Wan 2.1 template, I'll just use [the webp video](https://comfyanonymous.g
 
 Choose the content type and hover effect (optional) for your thumbnail:
 
-| Content Types                                                                                                   | Hover Effects                                                                                                       |
-| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| Content Types                                                                                                   | Hover Effects                                                                                                                |
+| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
 | ![Image Element](docs/pictures/thumbnail-variants/default.gif)<br>**Image**: Default image with no extra effect | ![Compare Slider](docs/pictures/thumbnail-variants/compare-slider.gif)<br>**Compare Slider**: Before/after comparison tool   |
 | ![Video Player](docs/pictures/thumbnail-variants/video.gif)<br>**Video**: Webp animation                        | ![Hover Dissolve](docs/pictures/thumbnail-variants/hover-disolve.gif)<br>**Hover Dissolve**: Dissolves to 2nd image on hover |
 | ![Audio Controls](docs/pictures/thumbnail-variants/audio.gif)<br>**Audio**: Audio playback                      | ![Hover Zoom](docs/pictures/thumbnail-variants/hover-zoom.gif)<br>**Hover Zoom**: Same as default but zooms more             |
@@ -769,7 +747,17 @@ Choose the content type and hover effect (optional) for your thumbnail:
 
 Since my Wan 2.1 thumbnail is already an animated video, I'll use a video thumbnail but choose not to add an effect.
 
-### 5 — Rename and Move Files
+### 5 — Compress Assets
+
+Attempt to compress the assets. Since the thumbnails will never be taking up a large portion of the screen, it is acceptable to lower their size. It's also good to convert them to a space-efficient file format like webp or jpeg, applying a lossy compression algorithm (e.g., convert at 65% quality).
+
+[EzGif](https://ezgif.com/png-to-webp) has free tools for changing resolution, compressing, and converting file types. Use whatever tool you are comfortable with.
+
+> [!TIP]
+>
+> Convert to webp first, then resize to a smaller resolution. You can maintain high quality and still get near 95% reduction if e.g., converting from png.
+
+### 6 — Rename and Move Files
 
 Give the workflow a filename that has no spaces, dots, or special characters. Then rename the thumbnail file(s) to match, but with a counter suffix.
 
@@ -788,7 +776,7 @@ text_to_video_wan-1.webp
 
 Then move the renamed files to your templates folder.
 
-### 6 — Add Entry to `index.json`
+### 7 — Add Entry to `index.json`
 
 There's an [`index.json`](templates/index.json) file in the templates folder which is where template configurations are set. You will need to add your template to this file, using the fields outlined below:
 
@@ -822,6 +810,7 @@ If your template doesn't fit into an existing category, you can add a new one:
 +       "mediaSubtype": "webp",
 +       "description": "Your template"s description.",
 +       "tutorialUrl": "https://link-to-some-helpful-docs-if-they-exist.como"
++       "thumbnailVariant": "zoomHover",
 +     },
 +   ]
 + }
@@ -852,13 +841,15 @@ The Wan 2.1 template I'm adding already fits into the "Video" category, so I'll
   },
 ```
 
+The `thumbnailVariant` field is where you add the choice of thumbnail variant.
+
 Now you can start ComfyUI (or refresh browser if already running) and test that your template works.
 
 > [!WARNING]
 >
 > Make sure to use double-quotes `"` instead of single-quotes `'` when adding things to json files
 
-### 7 — Embed Models
+### 8 — Embed Models
 
 Now we need to embed metadata for any models the template workflow uses. This way, the user can download and run the workflow without ever leaving ComfyUI.
 
@@ -896,6 +887,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan_2.1_vae.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/vae/wan_2.1_vae.safetensors?download=true",
++           "hash": "2fc39d31359a4b0a64f55876d8ff7fa8d780956ae2cb13463b0223e15148976b"
++           "hash_type": "SHA256",
 +           "directory": "vae"
 +         }
 +       ]
@@ -928,6 +921,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "umt5_xxl_fp8_e4m3fn_scaled.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/text_encoders/umt5_xxl_fp8_e4m3fn_scaled.safetensors?download=true",
++           "hash": "c3355d30191f1f066b26d93fba017ae9809dce6c627dda5f6a66eaa651204f68",
++           "hash_type": "SHA256",
 +           "directory": "text_encoders"
 +         }
 +       ]
@@ -964,6 +959,8 @@ To add them to the workflow json, find each associated node and add the metadata
 +         {
 +           "name": "wan2.1_t2v_1.3B_bf16.safetensors",
 +           "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
++           "hash": "6f999b0d6cb9a72b3d98ac386ed96f57f8cecae13994a69232514ea4974ad5fd",
++           "hash_type": "SHA256",
 +           "directory": "diffusion_models"
 +         }
 +       ]
@@ -972,25 +969,17 @@ To add them to the workflow json, find each associated node and add the metadata
     },
 ```
 
-You can also specify the model hash if appropriate:
+You can find the `hash` and `hash_type` for a model on huggingface (see below)or by calculating it yourself with a script or online tool.
 
-```json
-{
-  "name": "wan2.1_t2v_1.3B_bf16.safetensors",
-  "url": "https://huggingface.co/Comfy-Org/Wan_2.1_ComfyUI_repackaged/resolve/main/split_files/diffusion_models/wan2.1_t2v_1.3B_bf16.safetensors?download=true",
-  "directory": "diffusion_models",
-  "hash": "8743b52063cd84097a65d1633f5c74f5",
-  "hash_type": "MD5"
-}
-```
+![finding hash on hugginface](docs/pictures/finding-hugginface-hash.png)
 
-[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) for more details.
+[Workflow spec](https://docs.comfy.org/specs/workflow_json#workflow-json) and [ModelFile Zod schema](https://github.com/Comfy-Org/ComfyUI_frontend/blob/6bc03a624ecbc0439501d0c7c2b073ca90e9a742/src/schemas/comfyWorkflowSchema.ts#L34-L40) for more details.
 
 > [!CAUTION]
 >
 > Ensure that the filename being downloaded from the links matches the filenames in the `widgets_values` exactly.
 
-### 8 — Embed Node Versions (optional)
+### 9 — Embed Node Versions (optional)
 
 If your template requires a specific version of Comfy or a custom node, you can specify that using the same process as with models.
 
@@ -1024,7 +1013,7 @@ The Wan 2.1 workflow requires the SaveWEBM node which wasn't fully supported unt
 
 This can help diagnose issues when others run the workflow and ensure the workflow is more reproducible.
 
-### 9 — Add Documentation Nodes (optional)
+### 10 — Add Documentation Nodes (optional)
 
 If your template corresponds with a page on https://github.com/comfyanonymous/ComfyUI_examples, https://docs.comfy.org/custom-nodes/workflow_templates, etc., you can add a `MarkdownNote` node with links:
 
@@ -1040,19 +1029,22 @@ Raw markdown used:
 > [Wan 2.1 Tutorial - docs.comfy.org](https://docs.comfy.org/advanced/wan-video) — Explanation of concepts and step-by-step tutorial
 ```
 
-### 9 — Create PR
+### 11 — Bump Version and Create PR
 
 1. Fully test the workflow: delete the models, input images, etc. and try it as a new user would. Ensure the process ahs no hiccups and you can generate the thumbnail image on the first execution (if applicable).
 2. Create a fork of https://github.com/Comfy-Org/workflow_templates
 3. Clone the fork to your system
 4. Copy your new workflow and thumbnail(s) into the `templates` folder
 5. Add your changes to the `templates/index.json` file
-6. Commit and push changes
-7. Create a PR on https://github.com/Comfy-Org/workflow_templates
+6. Bump the version in `pyproject.toml` ([example](https://github.com/Comfy-Org/workflow_templates/pull/32))
+7. Commit and push changes
+8. Create a PR on https://github.com/Comfy-Org/workflow_templates
 
 Here is the PR I made for the Wan template: https://github.com/Comfy-Org/workflow_templates/pull/16
 
-### 10 — Add Translations
+Once the PR is merged, if you followed step 6 correctly, a new version will be published to the [comfyui-workflow-templates PyPi package](https://pypi.org/project/comfyui-workflow-templates).
+
+### 12 — Add Translations
 
 Make a PR in https://github.com/Comfy-Org/ComfyUI_frontend adding the mapping from your template filename (without extension) to the English display name title. The mapping goes in [`ComfyUI_frontend/src/locales/en/main.json`](https://github.com/Comfy-Org/ComfyUI_frontend/blob/9f0abac57ba0d5752c51198bf8a075b8336fdda1/src/locales/en/main.json#L480-L487).
 

{comfyui_workflow_templates-0.1.1.dist-info → comfyui_workflow_templates-0.1.3.dist-info}/RECORD

@@ -44,11 +44,11 @@ comfyui_workflow_templates/templates/flux_schnell-1.webp,sha256=fQ7jcpAp78BSu5t0
 comfyui_workflow_templates/templates/flux_schnell.json,sha256=t0H9W4oD76duF3gyYD1M_gHiaE-o4YsY3_YFbbN2O5g,6758
 comfyui_workflow_templates/templates/gligen_textbox_example-1.webp,sha256=4Lv5YE_FdAhd4WOYgyjtSeEUxLnbMnYlC1sJRa6ITmI,105278
 comfyui_workflow_templates/templates/gligen_textbox_example.json,sha256=BbfVZLIvBpAk4sks-9CQ8Q_g9lp53Z3NaqGpW1kbQw8,8907
-comfyui_workflow_templates/templates/hidream_i1_dev-1.png,sha256=EUdfUTHY6let-LNDwPruoAO8Ceo6kgrrDjK7n6AoPJk,1548930
+comfyui_workflow_templates/templates/hidream_i1_dev-1.webp,sha256=SVb1Rx2j7PYQ3bLpS4ihDHGnEHzuLvcxA0a-vEYrw3A,30980
 comfyui_workflow_templates/templates/hidream_i1_dev.json,sha256=dGwH3hix6IjKEeT2NZtDk169q3aFH9qy-ftoCHBcBfU,14102
-comfyui_workflow_templates/templates/hidream_i1_fast-1.png,sha256=5V0kvId-LtxVXmHplAk2hgh05zsdL-F57zaiWXwX_3c,1190054
+comfyui_workflow_templates/templates/hidream_i1_fast-1.webp,sha256=6RCa4l9uGFw5HnyJpWwaLHRmv_NH1uZusv15oBnKVUs,19014
 comfyui_workflow_templates/templates/hidream_i1_fast.json,sha256=a7rYf05gErHUqjriNwPWzQGN8vDAcczzMcHO2nQxudk,14028
-comfyui_workflow_templates/templates/hidream_i1_full-1.png,sha256=rgcizygcpFB9jVXC8ue_F1Gagr6T6b03MUlqZlLqvpE,778573
+comfyui_workflow_templates/templates/hidream_i1_full-1.webp,sha256=44kCdFDcOV_TU9kDvc5SmlGVEEF8s0j2h9748DXuNc4,8832
 comfyui_workflow_templates/templates/hidream_i1_full.json,sha256=JvHLKt1t42TNS7cUl0S5rKfhM3Z0pNzUlbqkSzFgp58,13972
 comfyui_workflow_templates/templates/hiresfix_esrgan_workflow-1.webp,sha256=qwI-UaVLBvjdvN6PqKgZArO7JsxW1iBuwTBV1t_ub24,80022
 comfyui_workflow_templates/templates/hiresfix_esrgan_workflow.json,sha256=4Uyhq8sL6f-EbopDoRXQpbJTt0lsV4-D2tT47wiMpPQ,13353
@@ -70,7 +70,7 @@ comfyui_workflow_templates/templates/image_to_video-1.webp,sha256=-3fIlyNhM-troU
 comfyui_workflow_templates/templates/image_to_video.json,sha256=0HU8Cd0_AL-HJlBf6o_yvkToA8j0G5o4Kp-5HA91sUI,6625
 comfyui_workflow_templates/templates/image_to_video_wan-1.webp,sha256=cxtxeW5KepuVvqInT1G4d6ddKN_qCWzzWW4sv0Yl6PI,926424
 comfyui_workflow_templates/templates/image_to_video_wan.json,sha256=eJJzxJcRo-f2P1EW3OOPFm0Nx-6rxFdpdkRVcXPATs4,11813
-comfyui_workflow_templates/templates/index.json,sha256=gaFlk7FSmMoQDgTtFONtkge7aIlulzqGOkpDGbCap0M,16626
+comfyui_workflow_templates/templates/index.json,sha256=IVrLph1NqHfBHTfLGPmk3dWngDy-U5QoU0yh3iqW1sY,19051
 comfyui_workflow_templates/templates/inpain_model_outpainting-1.webp,sha256=PVdIJ4LKvAGP-OzD1FmzQGFpcUKOMdXj-bBgQwIgZDI,116632
 comfyui_workflow_templates/templates/inpain_model_outpainting-2.webp,sha256=8I_BITesJrhvWdqebcz_BUsG2O5ltayxgIkwZCs-R9w,27708
 comfyui_workflow_templates/templates/inpain_model_outpainting.json,sha256=ovkgoh1C-grKfehN495pSUKTBGnSQ6Hm9GTVgQ3LjCU,8608
@@ -121,12 +121,15 @@ comfyui_workflow_templates/templates/text_to_video_wan-1.webp,sha256=Olfa2hHjGbq
 comfyui_workflow_templates/templates/text_to_video_wan.json,sha256=t2ngFOKrRNy7hU3CaLpW9UCtbsyO4bxGf_uV9b8TqPM,8581
 comfyui_workflow_templates/templates/txt_to_image_to_video-1.webp,sha256=IXxokwudVpNY0_bO7wVU5w8jZlPiUg-ptsSr-sKv5MY,740588
 comfyui_workflow_templates/templates/txt_to_image_to_video.json,sha256=OgF78IDS70E0rX_TLF-P24eP72FVyKFCUChyZx9f5vo,11438
-comfyui_workflow_templates/templates/wan2.1_fun_control-1.webp,sha256=LbGDA_8hyqU1yEEvvPEZypI8jNdJ4WBpLLHwjCYv9_c,5256208
+comfyui_workflow_templates/templates/wan2.1_flf2v_720_f16-1.webp,sha256=XQ1iZ9f0-qigZ23pByTgPoszg7Ltm36_qkhdmKiPfDg,1356354
+comfyui_workflow_templates/templates/wan2.1_flf2v_720_f16.json,sha256=FmBaPGjT1OAhvBSN5bXjLujuKt5S5KNx4NFgFldFGns,17248
+comfyui_workflow_templates/templates/wan2.1_fun_control-1.webp,sha256=hOIglkDZd_pRJMqpSVNFqwrJGOxl8KvaCCEzmzsg1q0,1379780
+comfyui_workflow_templates/templates/wan2.1_fun_control-2.webp,sha256=czOi3YuJI9HrCCo8qs-XWf6pNgpJtMLK5jlXYF5ZS4s,1181802
 comfyui_workflow_templates/templates/wan2.1_fun_control.json,sha256=DtwD0aCFtDAfmHFZ60SmVaTQCwAKy27Ggpi5YHTjdbE,20623
-comfyui_workflow_templates/templates/wan2.1_fun_inp-1.webp,sha256=MwXmlKZmm830PP7Qv-_TKsQxgglQjQYSCqwcHhpoB5Y,4674784
+comfyui_workflow_templates/templates/wan2.1_fun_inp-1.webp,sha256=0xKRBDLFCbMrni6o5zFlVt6o5a38Rxg1_Q0ETU2hPHc,1578046
 comfyui_workflow_templates/templates/wan2.1_fun_inp.json,sha256=PFoDxG-3_scsi2TGnDukSJ31dMC6j8ZYLqLQ_uJE5xM,19174
-comfyui_workflow_templates-0.1.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-comfyui_workflow_templates-0.1.1.dist-info/METADATA,sha256=Hk2Qey56Xxm2liqHprMYjLO-47rpb_nVC7ErL5RcjXU,54809
-comfyui_workflow_templates-0.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-comfyui_workflow_templates-0.1.1.dist-info/top_level.txt,sha256=u4ElFwwqJ25NY9OpjIB2eFEaFoAIk4bHrlGJKPMwJOo,27
-comfyui_workflow_templates-0.1.1.dist-info/RECORD,,
+comfyui_workflow_templates-0.1.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+comfyui_workflow_templates-0.1.3.dist-info/METADATA,sha256=wOC-FaNkcbDaLpjVJrOl5GVtzj-EHhIvgHKT5EY1jIk,55417
+comfyui_workflow_templates-0.1.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+comfyui_workflow_templates-0.1.3.dist-info/top_level.txt,sha256=u4ElFwwqJ25NY9OpjIB2eFEaFoAIk4bHrlGJKPMwJOo,27
+comfyui_workflow_templates-0.1.3.dist-info/RECORD,,