docs: update README with features and installation guide
This commit is contained in:
Thomas Kippster
@@ -1,76 +1,31 @@
|
||||
# ComfyUI Model Download Manager
|
||||
# ComfyUI Model Downloader 🚀
|
||||
|
||||
A robust, feature-rich Java Swing application designed to automate the process of identifying and downloading missing models for ComfyUI workflows. It bridges the gap between sharing a JSON workflow and having a fully functional local setup.
|
||||
Stop wasting time manually moving files! This tool automates your model management so you can stay in the creative flow.
|
||||
|
||||
## 🚀 Key Features
|
||||
## ✨ Features
|
||||
* **Automated Downloads:** Get your models directly into the right ComfyUI folders.
|
||||
* **Organized Structure:** No more messy `models/` directory.
|
||||
* **Fast & Lightweight:** Built for speed and minimal overhead.
|
||||
* **Shutdown after Queue:** Automatically shut down your PC after long download sessions.
|
||||
* **Background Mode:** Keep the downloader running in the system tray.
|
||||
* **Vault Security:** Encrypted storage for your API keys (Gemini, Hugging Face).
|
||||
|
||||
### 🔍 Advanced Workflow Extraction
|
||||
- **JSON & PNG Support**: Directly load `.json` workflows or drop ComfyUI-generated `.png` files to extract embedded workflow and prompt metadata (tEXt, iTXt, zTXt chunks).
|
||||
- **Recursive Traversal**: Scans deeply nested structures, including subgraphs and custom node definitions.
|
||||
- **Smart Detection**: Uses regex and node-type analysis to find model files (`.safetensors`, `.ckpt`, etc.) and infer their target directory (e.g., `checkpoints`, `loras`, `vae`).
|
||||
## 📸 Preview
|
||||
*(Add a screenshot or GIF here to showcase the UI)*
|
||||
|
||||
### 🤖 AI-Powered Discovery
|
||||
- **Local AI Heuristics**: Built-in scoring engine to predict model providers (e.g., StabilityAI, Black Forest Labs) offline based on filenames.
|
||||
- **Gemini Deep Search**: Integrated "Deep Search" using the Google Gemini API to find official Hugging Face repositories and direct download links for obscure models.
|
||||
- **Context Awareness**: Disambiguates generic filenames (like `ae.safetensors`) by analyzing the global workflow context (e.g., detecting FLUX or SD3 usage).
|
||||
|
||||
### 📥 Powerful Download Manager
|
||||
- **Resume Capability**: Implements HTTP Range requests to continue interrupted downloads exactly where they left off.
|
||||
- **Queue Control**: Start, **Pause**, **Resume**, and **Stop** functionality for full control over your bandwidth.
|
||||
- **Overwrite Protection**: Interactive dialogs prevent accidental data loss by asking to Resume, Overwrite, or Skip existing files.
|
||||
- **Live Metrics**: Real-time display of download speed (MB/s), percentage progress, and a global progress bar.
|
||||
|
||||
### 📂 Intelligent Sorting
|
||||
- **Automatic Path Mapping**: Infers the correct subdirectory (e.g., `checkpoints`, `loras`, `vae`, `controlnet`) based on node types like `LoraLoader` or `VAELoader`.
|
||||
- **Customizable Base Path**: Easily set your ComfyUI models root directory.
|
||||
|
||||
## 🛠️ Requirements
|
||||
- **Java 11** or higher
|
||||
- **Maven** (for building from source)
|
||||
- **API Key (Optional)**: A Google Gemini API key for "Deep Search" functionality.
|
||||
|
||||
## 🏗️ Build & Run
|
||||
|
||||
1. **Build the Fat JAR**:
|
||||
## 🛠 Installation
|
||||
1. Clone this repo:
|
||||
```bash
|
||||
mvn clean package
|
||||
git clone https://github.com/thomaskippster/comfymodeldownloader
|
||||
```
|
||||
2. Build with Maven or run the provided executable.
|
||||
3. Set your models directory (e.g., `C:\pinokio\api\comfy.git\app\models`).
|
||||
|
||||
2. **Launch**:
|
||||
```bash
|
||||
java -jar target/comfymodeldownloader-1.0-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
## 🏁 First Start & Model List Setup
|
||||
|
||||
Upon your first launch, it is highly recommended to import a master model list. This list helps the application immediately recognize models and their correct download sources.
|
||||
|
||||
1. **Prepare your JSON**: Create or obtain a `model-list.json` file. It should follow this structure:
|
||||
```json
|
||||
{
|
||||
"models": [
|
||||
{
|
||||
"name": "SDXL Base 1.0",
|
||||
"filename": "sd_xl_base_1.0.safetensors",
|
||||
"type": "checkpoints",
|
||||
"url": "https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
2. **Import**: Click the **Import Model List (JSON)...** button in the workflow panel.
|
||||
3. **Verification**: Once imported, the application will use this list as a primary reference for all future workflow analyses.
|
||||
|
||||
## 📖 How to Use
|
||||
|
||||
1. **Setup Path**: Enter or browse to your local ComfyUI models directory.
|
||||
2. **Provide Workflow**: Paste JSON content, load a `.json` file, or load a `.png` with embedded metadata.
|
||||
3. **Analyze**: Click **Analyze Models**. The application will identify missing models and categorize them.
|
||||
4. **Deep Search**: For unknown models, use the "Deep Search" feature to let the AI find the source.
|
||||
5. **Download**: Select models and click **Start Queue**.
|
||||
|
||||
## 📜 License
|
||||
This project is licensed under the MIT License.
|
||||
## 💡 Why use this?
|
||||
Manually downloading GBs of data and navigating deep folder structures is tedious. This tool bridges the gap between finding a model and using it in your workflow instantly by analyzing your ComfyUI JSON or PNG files.
|
||||
|
||||
---
|
||||
*Developed to make ComfyUI workflow sharing seamless.*
|
||||
|
||||
### Support & Feedback
|
||||
If you find this tool useful, please leave a star ⭐ on GitHub!
|
||||
Feedback is highly appreciated – feel free to open an issue or reach out.
|
||||
|
||||
Reference in New Issue
Block a user