68 lines
2.9 KiB
Markdown
68 lines
2.9 KiB
Markdown
<div align="center">
|
|
|
|
|
|
|
|
# ComfyPeeper Companion
|
|
|
|
</div>
|
|
|
|
A small ComfyUI extension that pairs with the **[ComfyPeeper](https://github.com/ethanfel/Discord-ComfyPeeper)**
|
|
Discord plugin to enable two things plain ComfyUI's API can't:
|
|
|
|
- **Send to ComfyUI** — ComfyPeeper can load a workflow straight into your **open ComfyUI
|
|
editor tab** (not just queue it headless).
|
|
- **Send to Discord** — get an output image into a Discord channel, either by **right-click →
|
|
📤 Send to Discord**, or by wiring the **Send to Discord (ComfyPeeper)** node into your graph
|
|
so every generation is posted automatically. Both go to a Discord **webhook** you configure;
|
|
the image carries its workflow in its PNG metadata, so ComfyPeeper detects it on the Discord side.
|
|
|
|
It also advertises a **friendly name** so ComfyPeeper can label the server and only show the
|
|
companion buttons where the companion is actually installed.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
cd <ComfyUI>/custom_nodes
|
|
git clone https://github.com/ethanfel/ComfyUI-ComfyPeeper-compagnion
|
|
cd ComfyUI-ComfyPeeper-compagnion
|
|
cp config.example.json config.json
|
|
# edit config.json: set "name", and "discord_webhook" if you want Send to Discord
|
|
# restart ComfyUI
|
|
```
|
|
|
|
Verify: `curl http://127.0.0.1:8188/comfypeeper/info` → `{"app":"ComfyPeeper","name":"…",…}`.
|
|
|
|
## config.json
|
|
|
|
| key | meaning |
|
|
|-----|---------|
|
|
| `name` | Friendly name shown by ComfyPeeper (e.g. `"4090 rig"`). |
|
|
| `discord_webhook` | A Discord channel **webhook URL** (Channel → Edit → Integrations → Webhooks). Leave empty to disable **Send to Discord**. |
|
|
|
|
## Nodes
|
|
|
|
| node | what it does |
|
|
|------|--------------|
|
|
| **Send to Discord (ComfyPeeper)** (`ComfyPeeper` category) | Output node — wire your images into it and every run posts them to the webhook, with the workflow embedded in the PNG. Optional `message` and `filename_prefix`. Previews what it sent. |
|
|
|
|
## Routes
|
|
|
|
| method · path | purpose |
|
|
|---------------|---------|
|
|
| `GET /comfypeeper/info` | `{ name, version, caps }` — `caps` includes `"send"` only when a webhook is set. |
|
|
| `POST /comfypeeper/load` | `{ workflow }` → pushed to open tabs; the frontend loads it. |
|
|
| `POST /comfypeeper/send` | `{ filename, subfolder, type }` → uploads that output image to the webhook. |
|
|
|
|
## Notes
|
|
|
|
- **Send to ComfyUI** needs a ComfyUI **tab open** to receive the workflow, and the editor
|
|
(`workflow`) graph — which ComfyPeeper has for most posts.
|
|
- The webhook URL stays **only** in this `config.json` on your ComfyUI host — it's never sent
|
|
to or stored by the Discord plugin. (`config.json` is git-ignored.)
|
|
- The routes are unauthenticated, same trust model as the rest of the ComfyUI server — run the
|
|
companion only on instances you control / trust.
|
|
|
|
## License
|
|
|
|
[GPL-3.0-or-later](LICENSE) — same as ComfyPeeper. Not affiliated with Discord, Vencord, or ComfyUI.
|