ComfyUI-KJNodes Documentation

Introduction

ComfyUI-KJNodes is a repository of custom nodes for ComfyUI created to enhance the quality of life and facilitate masking-related tasks. These nodes are crafted by combining the functionalities of existing nodes within ComfyUI, offering enhanced capabilities and convenience for users. The repository includes innovative tools designed to streamline various workflows within the ComfyUI ecosystem.

Installation

Steps to Install

1. Clone the Repository:

   • Place the cloned repository into the custom_nodes folder of your ComfyUI installation.

2. Install Dependencies:

   • Run the following command to install the necessary dependencies:

     pip install -r requirements.txt
     

   • For portable installations, navigate to the ComfyUI_windows_portable directory and run:

     python_embeded\python.exe -m pip install -r ComfyUI\custom_nodes\ComfyUI-KJNodes\requirements.txt
     

Purpose of the Repository

This repository serves as a collection of custom nodes providing enhanced functionalities for ComfyUI. It aims to simplify processes such as setting, getting constants, and working with masks, thereby reducing unnecessary coding lines and saving valuable time for users. This collection is particularly beneficial for those looking to optimize their workflows and leverage additional masking features.

Nodes Provided

Set/Get

• Description: Javascript nodes that allow setting and getting of constants. They are primarily used to reduce unnecessary lines by visually managing data flow in a ComfyUI charted workflow.
• Limitations: Incompatibility with nodes dynamically setting outputs or when directly connected to bypassed nodes.

ColorToMask

• Description: Converts RGB color values to masks. Supports batch processing and AnimateDiff.

ConditioningMultiCombine

• Description: Combines multiple conditions into a singular workspace, optimizing space usage.

ConditioningSetMaskAndCombine

• Description: Masks and combines two condition sets, helping save space in workflow integration.

GrowMaskWithBlur

• Description: Enables the growth or shrinkage of a mask. Allows for inversion operations and mask blurring, albeit with a slower operation on larger batches.

RoundMask

• Description: Node designed for creating rounded mask effects.

WidgetToString

• Description: Outputs the value of a widget on any node as a string. Useful for tracking and visually displaying node data.

Special Features

Javascript Integration

• browserstatus.js:
  • Customizes the browser favicon to indicate processing status with a visual green (idle) and red (processing) indicator. Shows progress percentage and queue length, enhancing user interface interaction.

Usage in ComfyUI Workflows

ComfyUI-KJNodes is invaluable for users seeking to improve their workflow efficiency within ComfyUI. By abstracting complex tasks into pre-built nodes, users can focus on higher-level tasks and reduce time spent on routine actions. The repository's masking capabilities, specially designed for integration with conditions, make it a vital tool for any ComfyUI power user looking to optimize and streamline their strategy for complex projects. Additionally, with features like WidgetToString, users can easily monitor and manage widget data, further augmenting operational efficiency.

Overall, ComfyUI-KJNodes enrich the ComfyUI experience by providing practical, reusable components for an enhanced, seamless UI workflow.