Enhance readme with workflow examples and images

Added images and descriptions for various workflows and nodes in the readme.
This commit is contained in:
cellzero
2025-11-17 19:50:28 +08:00
committed by GitHub
parent 58efe7fa9f
commit 7716702a8b
+25
View File
@@ -32,6 +32,7 @@ Currently, only **custom nodes** are supported. Support for **official ComfyUI A
5. Open one of the example workflows (e.g., `AnimonI2V`), enter your API key, and run the workflow.
# 🗂️ Workflow Examples
You can find several example workflows in the `workflows` folder. Try them out to explore different use cases!
@@ -40,10 +41,15 @@ You can find several example workflows in the `workflows` folder. Try them out t
Generates a video from a **single first-frame image** and a **text prompt**.
![workflow_i2v](https://github.com/user-attachments/assets/2c02d7b0-b55c-4349-9e56-2f590aa1e65a)
## 🔁 Start-End to Video
Generates a video using both a **starting image** and an **ending image**.
![workflow_ib2v](https://github.com/user-attachments/assets/90b7279e-f0c4-4838-bc7d-ead2cb9440e6)
### 📝 Notes:
- If using **more than one image**, you must **upload them to the server first**.
@@ -53,10 +59,14 @@ Generates a video using both a **starting image** and an **ending image**.
> 💡 **Tip:** The start and end frames can be the **same image**. In that case, you can reuse the `VIDEO_ID` from a previous generation instead of uploading again.
## 🔼 Upscale Video
Upscales a video to **1080P at 24 FPS**.
![workflow_sr](https://github.com/user-attachments/assets/d46ba28f-f220-4797-9ed7-595d10505b5b)
### ⚠️ Requirements:
- Input video must be **smaller than 1080P**.
@@ -66,6 +76,9 @@ Upscales a video to **1080P at 24 FPS**.
This workflow combines both generation and upscaling in a seamless process: it first generates a video from an image and a text prompt, then upscales the resulting video to 1080P resolution, and finally outputs the high-resolution result.
![workflow_i2v_sr](https://github.com/user-attachments/assets/15056be1-2984-42dc-a7dc-b1e52c09b466)
# 🧩 Node Overview
Animon provides **three types of nodes** for use in ComfyUI:
@@ -77,6 +90,9 @@ Animon provides **three types of nodes** for use in ComfyUI:
To add a node:
Right-click in the ComfyUI workspace → `Add Node` → `Animon` → `Node Name`.
![menu](https://github.com/user-attachments/assets/97133254-1837-46dd-91e7-f6ab5facc561)
## 🔐 Key Node
This node is used to input your **Animon API key**, available from the [Animon API platform](https://www.animon.ai/).
@@ -89,6 +105,8 @@ This node is used to input your **Animon API key**, available from the [Animon A
These nodes handle video generation. Currently supported: `Image to Video`, `Start-End Frame to Video`, `Upscale Video`.
![node_i2v_ib2v](https://github.com/user-attachments/assets/4ec049aa-608b-4517-b21f-7ad21bef7f95)
You can choose the generation model in the node settings.
### 📌 Supported Models
@@ -101,6 +119,7 @@ You can choose the generation model in the node settings.
- Up to **81 frames** at **16 FPS** for **480P / 720P / 1080P**
## ⬆️ Upload Nodes
When using **multiple images** or **videos**, you must upload them to the server **before generation**.
@@ -111,18 +130,24 @@ When using **multiple images** or **videos**, you must upload them to the server
Use `Animon Upload Image` or `Animon Upload Video` like ComfyUI’s `LoadImage` or `LoadVideo`.
![node_upload_direct](https://github.com/user-attachments/assets/33f19beb-d1de-4a6a-8856-8cd02943c511)
Then connect the resulting `IMAGE_ID` or `VIDEO_ID` to a generation node.
#### 2. Upload from ComfyUI Tensors
If you generate images/videos using other ComfyUI nodes (e.g., Stable Diffusion), use: `Animon Upload Image (from Tensor)` or `Animon Upload Video (from Tensor)`.
![node_upload_from_tensor](https://github.com/user-attachments/assets/6f65d508-05aa-4cc6-8ec4-120cb2a2cb1a)
These convert ComfyUI's internal `IMAGE` type into an `IMAGE_ID` or `VIDEO_ID` usable by Animon.
#### 3. Upload from Generated Video Bytes
To reuse a video generated by Animon, use `Animon Upload Video (from Bytes)` and link `VIDEO_BYTES` from any Animon generation node.
![node_upload_from_bytes](https://github.com/user-attachments/assets/2eac8344-54dd-49f7-82ab-98ad38cf9b46)
> 💡 This method avoids re-encoding and is faster than uploading from tensor.
# 📫 Feedback & Contributions