diff --git a/README.md b/README.md index 6e0181f..23ddd79 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,147 @@ -# ComfyUI-Pollinations-BYOP -Official ComfyUI custom node for Pollinations.ai with BYOP (Bring Your Own Pollen) support for free and paid image, video and text generation. +# 🌸 ComfyUI-Pollinations-BYOP + +[![ComfyUI](https://img.shields.io/badge/ComfyUI-Custom_Node-blue)](https://github.com/comfyanonymous/ComfyUI) +[![Pollinations.ai](https://img.shields.io/badge/Powered_by-Pollinations.ai-pink)](https://pollinations.ai/) +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) + +The official ComfyUI custom node suite for **[Pollinations.ai](https://pollinations.ai/)** with full **BYOP (Bring Your Own Pollen)** support. + +Generate high-quality images, text, and videos using state-of-the-art models (like **Flux**, **DeepSeek**, and **Wan 2.6**) directly inside ComfyUI—**without using any of your local GPU VRAM.** + +Whether you are running on an 8GB laptop or a cloud server, this node suite offloads the heavy compute lifting to the Pollinations API. + +--- + +## ✨ Features +* **Zero Local VRAM Required:** Generation happens entirely in the cloud. +* **Multimodal Generation:** Create Images, Videos, and Text all from within your node tree. +* **BYOP Support:** Seamlessly integrate your Pollinations API Key to use your own "Pollen" quota, bypassing anonymous rate limits and supporting the ecosystem. +* **Lightning Fast:** Outputs load directly as standard ComfyUI `IMAGE` and `STRING` formats, ready for immediate downstream processing (Upscaling, I2V, Compositing). + +--- + +## 🧩 Nodes Included & Supported Models + +### 1. 🌸 Pollinations Image Gen (BYOP) +Generates high-fidelity images directly to a ComfyUI `IMAGE` tensor. +* **Supported Models:** + * `flux` (Default - High quality) + * `flux-realism` (Photorealistic) + * `flux-anime` (Anime style) + * `flux-3d` (3D Render style) + * `any-dark` (Dark aesthetic) + * `turbo` (Ultra-fast generation) + * `klein-large` (Complex scenes / prompt adherence) + * `gptimage` (GPT-powered image generation) +* **Parameters:** `prompt`, `model`, `width`, `height`, `seed`, `api_key` + +### 2. 🌸 Pollinations Video Gen (BYOP) +Generates high-quality AI video. +* **Supported Models:** + * `seedance` (ByteDance's high-motion model) + * `wan` / `wan-2.6` (Alibaba's cinematic model) + * `veo` / `veo-3.1` (Google's highly detailed model) + * `ltx-2` (Fast, high-quality video) + * `kling` (Advanced physics and realism) + * `luma` (Smooth transitions) + * `grok-video` (Fast rendering) +* **Parameters:** `prompt`, `model`, `api_key` + +### 3. 🌸 Pollinations Text Gen (BYOP) +Leverage top-tier LLMs for prompt expansion, dynamic tagging, or scriptwriting inside your workflow. +* **Supported Models:** + * `openai` (GPT-4o) + * `openai-reasoning` (o1/o3 - deep thinking) + * `claude` (Claude 3.5 Sonnet) + * `gemini` (Google Gemini Pro/Flash) + * `deepseek` (DeepSeek V3 / R1) + * `llama` (Meta Llama 3) + * `mistral` (Mistral Large) + * `searchgpt` (Web-grounded search) +* **Parameters:** `prompt`, `system_instruction`, `model`, `api_key` + +--- + +## 📸 Screenshots + +*(User Note: Add your screenshot of the nodes connected to Preview Image/Text nodes here)* +![Pollinations Node Example](docs/node_example.png) + +*(User Note: Add a screenshot of an impressive output generated by the node here)* +![Example Output](docs/output_example.png) + +--- + +## ⚙️ Installation + +### Method 1: ComfyUI Manager (Recommended) +1. Open the **ComfyUI Manager**. +2. Click **Install Custom Nodes**. +3. Search for `Pollinations BYOP`. +4. Click Install and restart ComfyUI. + +### Method 2: Manual Git Clone +1. Navigate to your ComfyUI `custom_nodes` directory in your terminal: + ```bash + cd ComfyUI/custom_nodes + ``` +2. Clone this repository: + ```bash + git clone https://github.com/ChunkyPanda29/ComfyUI-Pollinations-BYOP.git + ``` +3. Restart ComfyUI. + +--- + +## 🛠️ How to Use + +1. Double-click your ComfyUI canvas and search for **`Pollinations`**. +2. Select your desired node (**Image**, **Video**, or **Text**). +3. **prompt:** Enter your creative description. +4. **model:** Select your desired engine from the dropdown list. +5. **api_key (Optional but Recommended):** Paste your Pollinations API key here (See instructions below). +6. Connect the output to a **Save Image**, **Video Combine**, or **Show Text** node. +7. Click **Queue Prompt**! + +--- + +## 🔑 How to get your API Key (BYOP) + +Pollinations operates on a unique **"Pollen"** economy. While anonymous generation is free, it is heavily rate-limited. By using your own API key, you unlock your personal daily/weekly free Pollen grants, allowing for faster and more consistent generation. + +1. Go to **[enter.pollinations.ai](https://enter.pollinations.ai/)**. +2. Sign in using your Discord or Google account. +3. Once logged in, your API key will be visible on your dashboard. +4. Copy the key and paste it into the `api_key` field of the ComfyUI node. +5. *That's it! Your ComfyUI workflow is now fueled by your own Pollen.* + +--- + +## ❓ FAQ + +**Q: Does this cost money?** +**A:** No! Pollinations provides free anonymous generations, and every registered user receives a free allowance of "Pollen" every week. You only pay if you decide to scale up massively and buy extra Pollen. + +**Q: Why does my generation fail or timeout?** +**A:** If you are leaving the `api_key` field blank, you are using the anonymous public tier, which can experience high traffic or strict rate limits. **Adding your free API key solves this.** + +**Q: Does this download large models to my hard drive?** +**A:** No. This is a pure API node. Your local installation size will remain exactly the same, making it perfect for budget 8GB VRAM setups. + +**Q: Can I chain these nodes together?** +**A:** Yes! A popular workflow is to use the **Text Gen** node to expand a simple idea into a highly detailed visual prompt, then feed that string directly into the **Image Gen** node, and finally pass that image output into a Video generation node. + +--- + +## 🤝 Contributing +Feel free to submit pull requests or open issues! Devs who contribute to Pollinations integrations can earn "Dev Points" to unlock Seed Status and greater API limits. +``` + +### **To push this to your repository:** +1. Save the file. +2. In your PowerShell, run: +```powershell +git commit -am "Docs: Update README with Text and Video node docs and model lists" +git push origin main +git push huggingface main +```