diff --git a/README.md b/README.md index bba967a..b4c9ccd 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,71 @@ -# ComfyUI-Chibi-Nodes +# ComfyUI Chibi Nodes -A Pack of nodes for [ComfyUI](https://github.com/comfyanonymous/ComfyUI) +Enhance your [ComfyUI](https://github.com/comfyanonymous/ComfyUI) experience with this collection of experimental nodes. ## Current Nodes -At the moment there not many, But im sure to add more in the future. +While the selection is currently limited, expect more additions in the future. Please note that these nodes are in an experimental stage and may contain bugs or issues. -Be aware, These are all very experimental right now so may have some bugs or issues. - -![screenshot of current nodes](https://github.com/chibiace/ComfyUI-Chibi-Nodes/blob/main/screenshot.png) +![Screenshot of Current Nodes](https://github.com/chibiace/ComfyUI-Chibi-Nodes/blob/main/screenshot.png) ### Loader -A more comprehensive Checkpoint, Vae loader with afew other features such as clip skip value selector and initial empty latent image generation +A comprehensive Checkpoint VAE loader with additional features such as a clip skip value selector and initial empty latent image generation. ### Prompts -Combined Positive and Negative Prompts, Just to save some room. +Combined positive and negative prompts, designed to save space. -### ImageTool (wip) +### ImageTool (Work in Progress) -Uses PIL for some simple image manipulation. Won't do batch images yet, work in progress. +Utilizes PIL for simple image manipulation. Currently, batch image processing is not supported, but development is ongoing. ### Wildcards -Replaces a keyword from input text if given with a random line from a text file, if no input is given it will output just the random line - -Can now return multiple random lines from the same file if desired, but be aware you can get doubles - -wildcards files (some of which i've included which also need some more work) are stored under the extras/chibi-wildcards directory. +Replaces a keyword from input text with a random line from a text file. If no input is given, it will output just a random line. It can now return multiple random lines from the same file, but be cautious as duplicates may occur. Wildcards files are stored under the extras/chibi-wildcards directory. ### LoadEmbedding -Appends the embedding text to the end of the input text ", (embedding:filename.pt:weight) " +Appends the embedding text to the end of the input text ", (embedding:filename.pt:weight) ". ### ConditionText -4 in 4 out, text to conditioning. +A 4-in-4-out node for text conditioning. -### SaveImages (wip) +### SaveImages -VaeDecode and SaveImage mixed together. saves to the normal output directory but uses a unix time stamp as the filename eg. 1698462650*001*.png +This feature merges the functionalities of VaeDecode and SaveImage, offering three distinct modes for filenames: + +1. **Timestamp:** Saves files to the standard output directory with a Unix timestamp as the filename (e.g., 1698462650001.png). +2. **Fixed:** Utilizes the `fixed_filename` variable for individual images and batches (e.g., output_001.png). +3. **Fixed Single:** Uses the `fixed_filename` variable but saves all images under the same filename, not ideal for batches (e.g., output.png). ### Textbox -A simple text box, if passthrough text is supplied it will update the textbox contents and also send it forward. +A simple text box. If pass-through text is supplied, it updates the textbox contents and sends it forward. ### ImageSizeInfo -Displays the resolution of the input image, and sends it along as well as two int values for the dimensions. +Displays the resolution of the input image and sends it along with two int values for the dimensions. ### ImageSimpleResize -A quick way to make a large image into a size your GPU can handle. +A quick way to resize a large image to a size your GPU can handle: -largest sets the biggest dimension to the set size and keeps your aspect ratio - -smallest sets the lowest dimension to the set size and keeps your aspect ratio - -all sets all dimensions to the set size - -height and width only sets the one you pick. +- "largest" sets the biggest dimension to the specified size while maintaining aspect ratio. +- "smallest" sets the lowest dimension to the specified size while maintaining aspect ratio. +- "all" sets all dimensions to the specified size. +- "height" and "width" only set the chosen dimension. ### Int2String -Takes a number, gives you a text string, for debugging i guess. +Converts a number into a text string, primarily for debugging purposes. ## Installation -download the repo to the custom_nodes directory. eg. +To install, download the repository to the custom_nodes directory: -`cd custom_nodes` - -`git clone https://github.com/chibiace/ComfyUI-Chibi-Nodes/` +```bash +cd custom_nodes +git clone https://github.com/chibiace/ComfyUI-Chibi-Nodes/ +```