From 1b29ec668aeee3b0aefd3ee677d6196f89bb8bf4 Mon Sep 17 00:00:00 2001 From: Light-x02 <105165695+Light-x02@users.noreply.github.com> Date: Mon, 23 Dec 2024 02:36:56 +0100 Subject: [PATCH] Update README.md --- README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 77 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66fb21c..4541393 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,77 @@ -# ComfyUI-FluxSettingsNode -FluxSettingsNode is a combined node merging the functionalities of the native nodes 'FluxGuidance', 'KSamplerSelect', 'BasicScheduler', and 'RandomNoise' to simplify and enhance workflows in ComfyUI. +# FluxSettingsNode + +**Version**: 1.0.0 +**Author**: [Light-x02](https://github.com/Light-x02) + +## Support My Work +If you find this project useful, you can support my work on Ko-fi: +[https://ko-fi.com/light_x02](https://ko-fi.com/light_x02) + +## Description +FluxSettingsNode is a combined node for **ComfyUI** that merges the functionalities of the native nodes **FluxGuidance**, **KSamplerSelect**, **BasicScheduler**, and **RandomNoise** into one powerful and flexible tool. This node simplifies workflows by consolidating these features while enhancing their compatibility. + +## Features +- **Combined Guidance**: Control guidance strength with precise adjustments. +- **Sampler Selection**: Choose your preferred sampler dynamically. +- **Flexible Scheduling**: Configure sigmas and denoise levels for advanced workflows. +- **Noise Management**: Generate random noise or disable it entirely. +- **Streamlined Workflows**: Reduce complexity by integrating multiple nodes into one. + +## Installation + +### Method 1: Install via ComfyUI Manager +*Coming Soon...* + +2. Go to the **Custom Nodes** section in the interface. +3. Search for **"FluxSettingsNode"** and install it directly from the ComfyUI Manager. +4. **Restart ComfyUI** + Restart ComfyUI to load the node. + +### Method 2: Clone the Repository +1. Open a terminal or command prompt. +2. Run the following command to clone the repository: + ```bash + git clone https://github.com/Light-x02/ComfyUI-FluxSettingsNode.git + ``` +3. **Restart ComfyUI** + Once the files are in place, restart ComfyUI to load the node. + +### Manual Installation +1. **Download or Clone the Project** + [https://github.com/Light-x02/ComfyUI-FluxSettingsNode](https://github.com/Light-x02/ComfyUI-FluxSettingsNode) + +2. **Move the Folder to Your ComfyUI Directory** + Copy the folder `ComfyUI-FluxSettingsNode` into the `custom_nodes` directory of your ComfyUI installation. + +3. **Restart ComfyUI** + Once the files are in place, restart ComfyUI to load the node. + +## Usage + +### Included Functionalities + +#### Guidance Control +- **Description**: Adjusts guidance strength dynamically to influence model behavior. + +#### Sampler Selection +- **Description**: Dynamically selects a sampler for image generation. + +#### Scheduling +- **Description**: Configures sigma and denoise settings for advanced workflows. + +#### Noise Management +- **Description**: Generates random noise or disables noise for specific workflows. + +### Example Workflow +1. Use the FluxSettingsNode to configure guidance, sampler, scheduling, and noise settings. +2. Connect it to other nodes in your workflow. +3. Generate your image with streamlined and enhanced control. + +## Additional Notes +This node is designed to work seamlessly with the ComfyUI ecosystem. Ensure you have the latest version of ComfyUI installed for the best experience. + +## License +This project is licensed under the **MIT License**. You are free to use, modify, and distribute it, provided you include a copyright notice. + +## Contribution +Contributions are welcome! If you want to report a bug or suggest an improvement, open an issue or submit a pull request on the [GitHub repository](https://github.com/Light-x02/ComfyUI-FluxSettingsNode).