MushroomFleet-ComfyUI-Variationator/docs/INSTALLATION.md

ComfyUI Installation Guide - Prompt Orchestration Nodes

Repository: https://github.com/MushroomFleet/ComfyUI-Variationator

---

Quick Installation

Method 1: Git Clone (Recommended)

cd ComfyUI/custom_nodes
git clone https://github.com/MushroomFleet/ComfyUI-Variationator.git
# Restart ComfyUI

The nodes will appear under "Prompt Orchestration" category.

Method 2: Manual Installation

1. Download the repository

   • Download ZIP from https://github.com/MushroomFleet/ComfyUI-Variationator
   • Or clone locally and copy the folder

2. Copy to ComfyUI

   # Copy the entire folder to ComfyUI/custom_nodes/
   cp -r ComfyUI-Variationator ComfyUI/custom_nodes/
   

3. Restart ComfyUI

   • Restart your ComfyUI instance
   • Look for the loading message in console
   • Nodes will appear under "Prompt Orchestration" category

Method 3: Symlink (For Development)

cd ComfyUI/custom_nodes
ln -s /path/to/ComfyUI-Variationator ComfyUI-Variationator

---

Directory Structure

After installation, your structure should look like:

ComfyUI/
└── custom_nodes/
    └── ComfyUI-Variationator/
        ├── __init__.py
        ├── prompt_orchestration_nodes.py
        ├── prompt_orchestrator.py
        ├── batch_processor.py
        ├── README.md
        ├── README_COMFYUI.md
        └── INSTALLATION.md

---

Verification

1. Check Console Output

When ComfyUI starts, you should see:

================================================================================
Prompt Orchestration Nodes v1.0.0 loaded successfully!
  - 9 custom nodes available
  - 20 lighting modifiers (DRY/WET categories)
  - 10+ built-in style templates
  - Category: 'Prompt Orchestration'
================================================================================

2. Check Node Menu

In ComfyUI:

1. Right-click on canvas → "Add Node"
2. Look for "Prompt Orchestration" category
3. You should see 9 nodes:
   • Lighting Modifier (Single)
   • Batch Variation Generator
   • Style Transform
   • Smart Variation (NLP)
   • Preset Collection
   • Modifier Info
   • Prompt Combiner
   • Random Modifier
   • Multi-Style Layer

---

Troubleshooting

Nodes Don't Appear

Problem: Nodes not showing in menu

Solutions:

1. Check folder name: Must be in custom_nodes/ directory
2. Check console for errors
3. Verify all files are present (especially __init__.py)
4. Restart ComfyUI completely (not just refresh)

Import Errors

Problem: "Could not import prompt_orchestrator" error

Solutions:

1. Ensure prompt_orchestrator.py is in the same folder as __init__.py
2. Ensure batch_processor.py is in the same folder
3. Check file permissions (should be readable)

Python Version Issues

Problem: Syntax errors or import failures

Requirements:

• Python 3.7 or higher (same as ComfyUI requirement)
• No additional packages needed (uses stdlib only)

---

Uninstallation

To remove the nodes:

rm -rf ComfyUI/custom_nodes/ComfyUI-Variationator

Then restart ComfyUI.

---

Updating

To update to a new version:

1. Backup your workflows (recommended)
2. Delete the old folder
3. Copy the new version
4. Restart ComfyUI

---

Platform-Specific Notes

Windows

# Git clone
cd C:\path\to\ComfyUI\custom_nodes
git clone https://github.com/MushroomFleet/ComfyUI-Variationator.git

# Or manual copy
xcopy /E /I ComfyUI-Variationator "C:\path\to\ComfyUI\custom_nodes\ComfyUI-Variationator"

macOS / Linux

# Git clone
cd ~/ComfyUI/custom_nodes
git clone https://github.com/MushroomFleet/ComfyUI-Variationator.git

# Or manual copy
cp -r ComfyUI-Variationator ~/ComfyUI/custom_nodes/

---

File Checklist

Make sure these files are present after installation:

• __init__.py - Package initialization
• prompt_orchestration_nodes.py - Node definitions
• prompt_orchestrator.py - Core engine
• batch_processor.py - Batch operations
• README_COMFYUI.md - Documentation
• INSTALLATION.md - This file

---

Next Steps

After successful installation:

1. Read the README: Check README_COMFYUI.md for usage guide
2. Load Example Workflow: Import example JSON workflows
3. Try Basic Node: Start with "Lighting Modifier (Single)"
4. Explore Presets: Use "Preset Collection" for quick results

---

Support

If you encounter issues:

1. Check the console for error messages
2. Verify file structure matches expected layout
3. Ensure Python version compatibility
4. Check file permissions
5. Open an issue on GitHub: https://github.com/MushroomFleet/ComfyUI-Variationator

---

Requirements

• ComfyUI: Latest version recommended
• Python: 3.7 or higher
• Dependencies: None (uses Python stdlib only)
• Platform: Windows, macOS, Linux

---

Success!

If you see the nodes in your ComfyUI interface under "Prompt Orchestration", you're ready to go! 🎉

Check README_COMFYUI.md for detailed usage instructions and examples.

---

Citation

https://github.com/MushroomFleet/ComfyUI-Variationator