Skip to content

Commit

Permalink
docs: πŸ“ fix typo and add more details
Browse files Browse the repository at this point in the history
  • Loading branch information
melMass committed Jul 28, 2023
1 parent 9e751a2 commit 7c020ba
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
## Core
These 3 script should cannot be used independently and must all be present to work
These 3 scripts cannot be used independently and must all be present to work, they are mostly enhancing the frontend of python nodes
- `comfy_shared`: library of methods used in `mtb_widgets` and `debug`

**mtb_widgets** define ui callbacks, and various widgets like the `COLOR` type:
<img src="https://github.com/melMass/comfy_mtb/assets/7041726/5dbcb714-e1e2-4be7-b0e2-68a6c38c83de" width=400/>

or the `BOOL` type:
<img src="https://github.com/melMass/comfy_mtb/assets/7041726/7601366d-601c-4f4d-b735-1a4b076770b0" width=400/>

There is also `Debug` which is a node that should be able to display any data input, it handle a few cases and fallback to the string representation of the
data otherwise:
![debug](https://github.com/melMass/comfy_mtb/assets/7041726/1f4393e4-1c3d-4807-9501-fe8888bfae25)



## Standalone
These scripts can be taken and placed independently of `comfy_mtb` or any other files, mimicking what pythongosss did for their [Custom Scripts](https://github.com/pythongosssss/ComfyUI-Custom-Scripts/tree/main/js)
These scripts can be taken and placed independently of `comfy_mtb` or any other files, mimicking what pythongosss did for their

- **imageFeed**: a fork of @pythongosssss ' s [image feed](https://github.com/pythongosssss/ComfyUI-Custom-Scripts/tree/main/js), it adds support for: a lightbox to see images bigger, a way to load the current session history (in case of a web page reload), and different icons, most of the work come from the original script.


- **imageFeed**: a fork of pythongosssss's image feed, it adds support for: a lightbox to see images bigger, a way to load the current session history (in case of a web page reload), and different icons, most of the work come from the original script.
> **NOTE**
>
> The original imagefeed got updated since and offer more options, ideally I would clean my lightbox thing and PR it to pythongoss later but in the meantime the script will detect if you already use the original one and not load this fork
- ![imagefeed](https://github.com/melMass/comfy_mtb/assets/7041726/c3acab4b-d28b-4432-a31b-248391aa2ee8)

- **notify**: a basic toast notification system that I use in some places accross mtb, it can be used by simply calling `window.MTB.notify("Hello world!")`
Expand Down

0 comments on commit 7c020ba

Please sign in to comment.