Update README.md

This commit is contained in:
space-nuko
2023-05-12 21:47:22 -05:00
parent ff52ef1bba
commit 14b0facde2
3 changed files with 12 additions and 14 deletions

View File

@@ -1,8 +1,6 @@
# ComfyBox # ComfyBox
An alternative UI to the backend server of the Stable Diffusion webapp [ComfyUI](https://github.com/comfyanonymous/ComfyUI). Build your workflow in a graph structure and have a custom Stable Diffusion interface created for you automatically. ComfyBox is a frontend to Stable Diffusion that lets you create custom image generation interfaces without any code. It uses [ComfyUI](https://github.com/comfyanonymous/ComfyUI) under the hood for maximum power and extensibility.
This project is *still under construction* and many features are missing, be aware of the tradeoffs if you're interested in using it.
![Screenshot](./static/screenshot.png) ![Screenshot](./static/screenshot.png)
@@ -10,21 +8,21 @@ This project is *still under construction* and many features are missing, be awa
## Installation ## Installation
1. Download the latest release [here](https://nightly.link/space-nuko/ComfyBox/workflows/build-and-publish/master/ComfyBox-dist) and extract it somewhere 1. Download the latest release [here](https://nightly.link/space-nuko/ComfyBox/workflows/build-and-publish/master/ComfyBox-dist) and extract it somewhere.
2. Start the ComfyUI backend with `python main.py --enable-cors-header` 2. Start the ComfyUI backend with `python main.py --enable-cors-header`.
3. In the folder you extracted open the `run.bat`/`run.sh` script (requires Python 3 to be on your PATH). Alternatively you can serve the contents of the folder with a web server. 3. In the folder you extracted open the `run.bat`/`run.sh` script (requires Python 3 to be on your PATH). Alternatively you can serve the contents of the folder with any web server.
## NOTE ## NOTE
This frontend isn't compatible with regular ComfyUI's workflow format since extra metadata is saved like panel layout, so you'll have to spend a bit of time recreating them. This project also isn't compatible with regular ComfyUI's frontend extension format, but useful extensions can be integrated into this repo with some effort. This project is *still under construction* and some features are missing, be aware of the tradeoffs if you're interested in using it.
## Proposed Features This frontend isn't compatible with regular ComfyUI's workflow format since extra metadata is saved like panel layout, so you'll have to spend a bit of time recreating them. This project also isn't compatible with regular ComfyUI's frontend extension format, but useful extensions can be integrated into the base repo with some effort.
- All the power of ComfyUI with more convenience on top
- Autocreation of UI widgets from your workflow, quickly creating a personalized dashboard ## Features
- Arrange the UI however you like and attach custom classes/styles to each widget - *No-Code UI Builder* - A novel system for creating your own Stable Diffusion user interfaces from the basic components.
- Custom widget types - *Extension Support* - All custom ComfyUI nodes are supported out of the box.
- See the status of queued and finished generations and their configs in realtime - *Prompt Queue* - Queue up multiple prompts without waiting for them to finish first. Inspect currently queued and executed prompts.
- Development with TypeScript - *Prompt History* - Browse through previously generated prompts and their output images/parameters.
## Development ## Development

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 MiB

After

Width:  |  Height:  |  Size: 2.6 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 MiB

After

Width:  |  Height:  |  Size: 2.6 MiB