prepare for publication (#3)

* create the files needed for publication on ComfyUI-Manager and Comfy Registry
* init the README
* small adjustments to the wiki
This commit is contained in:
Bug, Ltd.
2025-01-21 19:27:31 +01:00
committed by GitHub
parent 023fe8ab4e
commit cc6775802d
11 changed files with 183 additions and 35 deletions
+115 -2
View File
@@ -1,2 +1,115 @@
# ComfyLab-Pack
A collection of carefully crafted nodes, to improve your Comfy UX.
<h1 align="center">
ComfyLab Pack
</h1>
<p align="center">
<img src=".images/repo_banner.jpg" width="70%" title="welcome to ComfyLab Pack!">
<br/>
<span style="color:#787878; font-size: large; font-style: italic">A collection of carefully experimented nodes, to improve your Comfy UX.</span>
</p>
<h2 align="center"><a href="#️node-overview">Node overview</a> &nbsp; | &nbsp; <a href="#documentation">Documentation</a> | &nbsp; <a href="#installation">Installation</a></h2>
# Node overview
**The complete list of nodes can be found in the [wiki / node reference](./wiki/node%20reference/)**
## XY Plot - build beautiful and unique grids
**Auto-queue**, make virtually **anything vary** (checkpoints, LoRAs, ...), **not restricted to KSampler**, pagination, ...\
**Many configuration options**: page header / footer, custom fonts (even your own), background,...\
**Make it RGBA** and add a custom background image for a very unique look.
<details>
<summary><strong>Detailed features</strong> <i>(click to show)</i></summary>
- simple to use by default: **only 2 nodes**
- **optional configuration nodes** to customize the grid, or the **page header / footer**
- with possible **pagination, row / column switch**
- **auto-queuing** (very simple to use, automatic error / interruption detection)
- you can virtually **make anything vary**: CFG, seed, checkpoint / sampler / LoRA / ...
- **not restricted to KSampler**: can be adapted to any process generating images
- **many configuration options**:
- custom row/col headers, with string templating
- font (type / size / color)
- in row / column headers, and/or page header / footer (each configurable differently)
- either one of the 4 fonts shipped with the extension, or any other TTF font on your disk
- background color:
- make **your grid transparent (RGBA)** to add a custom background image
- padding, wrap, ...
- mix any image resolution / aspect ratio
- ...
</details>
> For a quick start, it is advised to read the [core concepts](./wiki/node%20reference/xy%20plot/00%20-%20core%20concepts.md).\
> More information in the [XY Plot node reference](./wiki/node%20reference/xy%20plot/) and the [dedicated tutorials](./wiki/tutorials/XY%20Plot/), from simple to advanced.\
> You can also check the [examples](./wiki/examples/), they will be frequently extended.
## Output Config - dynamic outputs from a config file
The `Output Config` nodes allow you to load custom config files, to **dynamically create any number of custom outputs**, that you can later connect to other nodes before executing the workflow.\
Very **useful to standardize your workflows**, and keep a collection of configurations / test cases separately. Or many more, depending on you specific case...
<details>
<summary><strong>Detailed features</strong> <i>(click to show)</i></summary>
- **any number of outputs**, you decide what you need for your speific cases
- **very simple** config file, by default, only `output: value` is needed
- optionally configure the **shape, color, and even the type** of each output
- available in **JSON / JSON5 / YAML** (with comments if you wish)
- strictly validated with a **JSON Schema**, with **detailed visual report** in case of errors
</details>
> More information in the [Output Config node reference](./wiki/node%20reference/output%20config.md) and the [dedicated tutorials](./wiki/tutorials/Output%20Config/).\
> You can also check the [examples](./wiki/examples/), they will be frequently extended.
## Format String - one node to rule them all
Take advantage of the powerful **Python string `format()`** method, to build strings using placeholders.\
Very useful for many operations: **replace, concatenate, prefix / append, pad, limit**, ...\
**Any number of inputs** _(credits to [@melMass](https://github.com/melMass) and his [comfy_mtb](https://github.com/melMass/comfy_mtb) extension for the trick!)_.\
Compatible with **integers, floats, booleans.**\
Exist in 2 flavors: **simple string and multiline**.\
Safe to use (no arbitary code execution, ...): a well-proven, standard Python method.
> More information in the [Format String node reference](./wiki/node%20reference/format.md) and the [dedicated tutorials](./wiki/tutorials/Format/).\
> You can also check the [examples](./wiki/examples/), they will be frequently extended.
## Queue - efficient and simple to use
Exist in 3 flavors: **Generic**, **File**, **Image**.\
Very simple to use: **auto-queuing** (with error / interruption detection), no counter to reset or batch size to set.
## List utilities - make lists as you want
A set of nodes to **create lists** (from string, file, individual elements).\
**Parse and convert** strings to integers, floats, ...\
**Merge / limit** lists.
# Documentation
<ins>Important note:</ins> all nodes in this extension has been adjusted with custom tooltips.\
By simply **moving the mouse pointer over** a node or its inputs / widgets / outputs, you can get useful **contextual information**.
In addition, more detailed information in the [wiki](./wiki/):
- [Node reference](./wiki/node%20reference/)
- [Tutorials](./wiki/tutorials/)
- [Examples](./wiki/examples/)
# Installation
Preferred installation method via the [ComfyUI Manager](https://github.com/ltdrdata/ComfyUI-Manager): search and install `ComfyLab Pack`
Manual installation (from the ComfyUI directory):
```bash
source venv/bin/activate # adjust to your env
cd custom_nodes
git clone https://github.com/bugltd/ComfyLab-Pack.git
cd ComfyLab-Pack
pip install -r requirements.txt
cd ../..
deactivate
# run ComfyUI as usual
```