Transform your 3D texturing workflow with the power of generative AI, directly within Blender!
add manual installation instructions
sakalond257133fe9add
diff --git a/docs/MANUAL_INSTALLATION.md b/docs/MANUAL_INSTALLATION.mdnew file mode 100644index 0000000..fb5520e--- /dev/null+++ b/docs/MANUAL_INSTALLATION.md@@ -0,0 +1,142 @@+# Manual Installation++If you prefer to set up dependencies manually or need to install specific components not covered by the script, follow these instructions.+**Estimated time for manual setup:** 15-30 minutes (excluding model download times, which can be significant).++**Prerequisites for manual installation:**+* **Git:** Required for cloning ComfyUI custom nodes. Download from [git-scm.com](https://git-scm.com/).+* **Sufficient Disk Space:** AI models are large. Ensure you have adequate free space (10GB to 50GB+).++**Manual Installation Steps:**++**1. Install Required ComfyUI Custom Nodes**++StableGen requires specific custom nodes for ComfyUI to function correctly, particularly for IPAdapter support.++1. Open your system's terminal or command prompt.+2. Navigate to your ComfyUI custom nodes directory:+ ```bash+ cd <YourComfyUIDirectory>/custom_nodes/+ ```+3. Clone the following repository:+ * **ComfyUI IPAdapter Plus:**+ ```bash+ git clone [https://github.com/cubiq/ComfyUI_IPAdapter_plus.git](https://github.com/cubiq/ComfyUI_IPAdapter_plus.git)+ ```+4. **Restart ComfyUI** after installing new custom nodes to ensure they are loaded.++ *(You may find the [ComfyUI Manager](https://github.com/ltdrdata/ComfyUI-Manager) custom node helpful for managing other custom nodes in the future, though it's not a strict requirement for StableGen's core dependencies listed here.)*++**2. Download and Place Required AI Models for StableGen**++These models are essential for StableGen's core features and presets. Download each file and place it into the specified subdirectory within `<YourComfyUIDirectory>/models/`. **Create directories if they do not exist.** Pay close attention to **renaming instructions** where specified, as they are crucial.++* **a) IPAdapter Model (Core Functionality)**+ * **Directory:** `<YourComfyUIDirectory>/models/ipadapter/`+ * **Filename:** `ip-adapter-plus_sdxl_vit-h.safetensors`+ * **Download URL:** [https://huggingface.co/h94/IP-Adapter/resolve/main/sdxl_models/ip-adapter-plus_sdxl_vit-h.safetensors?download=true](https://huggingface.co/h94/IP-Adapter/resolve/main/sdxl_models/ip-adapter-plus_sdxl_vit-h.safetensors?download=true)+ * **License:** Apache 2.0+ * **Size:** ~850 MB++* **b) IPAdapter CLIP Vision Models (Dependencies for IPAdapter)**+ * **Directory:** `<YourComfyUIDirectory>/models/clip_vision/`+ * **File 1:**+ * **Target Filename:** `CLIP-ViT-H-14-laion2B-s32B-b79K.safetensors`+ * **Download URL:** [https://huggingface.co/h94/IP-Adapter/resolve/main/models/image_encoder/model.safetensors](https://huggingface.co/h94/IP-Adapter/resolve/main/models/image_encoder/model.safetensors)+ * **Action:** Download `model.safetensors` and **rename it** to `CLIP-ViT-H-14-laion2B-s32B-b79K.safetensors`.+ * **File 2:**+ * **Target Filename:** `CLIP-ViT-bigG-14-laion2B-39B-b160k.safetensors`+ * **Download URL:** [https://huggingface.co/h94/IP-Adapter/resolve/main/sdxl_models/image_encoder/model.safetensors](https://huggingface.co/h94/IP-Adapter/resolve/main/sdxl_models/image_encoder/model.safetensors)+ * **Action:** Download `model.safetensors` and **rename it** to `CLIP-ViT-bigG-14-laion2B-39B-b160k.safetensors`.+ * **License (for both):** Apache 2.0+ * **Combined Size:** ~6 GB++* **c) SDXL Lighting LoRA (Recommended for Presets & Speed)**+ * **Directory:** `<YourComfyUIDirectory>/models/loras/`+ * **Filename:** `sdxl_lightning_8step_lora.safetensors`+ * **Download URL:** [https://huggingface.co/ByteDance/SDXL-Lightning/resolve/main/sdxl_lightning_8step_lora.safetensors?download=true](https://huggingface.co/ByteDance/SDXL-Lightning/resolve/main/sdxl_lightning_8step_lora.safetensors?download=true)+ * **License:** OpenRAIL+++ * **Size:** ~400 MB++* **d) ControlNet Model (Depth - Crucial for Presets)**+ * **Directory:** `<YourComfyUIDirectory>/models/controlnet/`+ * **Target Filename:** `controlnet_depth_sdxl.safetensors`+ * **Download URL:** [https://huggingface.co/xinsir/controlnet-depth-sdxl-1.0/resolve/main/diffusion_pytorch_model.safetensors?download=true](https://huggingface.co/xinsir/controlnet-depth-sdxl-1.0/resolve/main/diffusion_pytorch_model.safetensors?download=true)+ * **Action:** Download `diffusion_pytorch_model.safetensors` and **rename it** to `controlnet_depth_sdxl.safetensors`.+ * **License:** Apache 2.0+ * **Size:** ~2.5 GB++**3. (Optional but Recommended) Additional AI Models**++While the models above are core/hardcoded for some presets, StableGen supports more.++* **Other SDXL Lighting & Hyper-SD LoRAs:**+ * Place in: `<YourComfyUIDirectory>/models/loras/`+ * No renaming needed.+ * **SDXL Lightning 4-step:** [Download Link](https://huggingface.co/ByteDance/SDXL-Lightning/resolve/main/sdxl_lightning_4step_lora.safetensors?download=true) (License: OpenRAIL++)+ * **SDXL Lightning 2-step:** [Download Link](https://huggingface.co/ByteDance/SDXL-Lightning/resolve/main/sdxl_lightning_2step_lora.safetensors?download=true) (License: OpenRAIL++)+ * **Hyper-SDXL 8-steps LoRA:** [Download Link](https://huggingface.co/ByteDance/Hyper-SD/resolve/main/Hyper-SDXL-8steps-lora.safetensors?download=true) (License: Unknown)+ * **Hyper-SDXL 4-steps LoRA:** [Download Link](https://huggingface.co/ByteDance/Hyper-SD/resolve/main/Hyper-SDXL-4steps-lora.safetensors?download=true) (License: Unknown)+ * **Hyper-SDXL 1-step LoRA:** [Download Link](https://huggingface.co/ByteDance/Hyper-SD/resolve/main/Hyper-SDXL-1step-lora.safetensors?download=true) (License: Unknown)++* **Other ControlNet Models:**+ * Place in: `<YourComfyUIDirectory>/models/controlnet/`+ * **Depth (alternative variant):**+ * Filename: `diffusion_pytorch_model.fp16.safetensors` (No rename needed)+ * URL: [https://huggingface.co/diffusers/controlnet-depth-sdxl-1.0/resolve/main/diffusion_pytorch_model.fp16.safetensors?download=true](https://huggingface.co/diffusers/controlnet-depth-sdxl-1.0/resolve/main/diffusion_pytorch_model.fp16.safetensors?download=true)+ * License: OpenRAIL+++ * Size: ~2.5 GB+ * **Union (Depth/Normal/Canny):**+ * Target Filename: `sdxl_promax.safetensors`+ * URL: [https://huggingface.co/brad-twinkl/controlnet-union-sdxl-1.0-promax/resolve/main/diffusion_pytorch_model.safetensors?download=true](https://huggingface.co/brad-twinkl/controlnet-union-sdxl-1.0-promax/resolve/main/diffusion_pytorch_model.safetensors?download=true)+ * Action: Download and **rename** to `sdxl_promax.safetensors`.+ * License: Apache 2.0+ * Size: ~2.5 GB++**4. Download a Base SDXL Model**++You need at least one main SDXL checkpoint. These are large and are user's choice.++* **Recommended Placement:** `<YourComfyUIDirectory>/models/checkpoints/`+* **Recommended Model (Used throughout development):**+ * **RealVisXL V5.0 (fp16):**+ * URL: [https://huggingface.co/SG161222/RealVisXL_V5.0/resolve/main/RealVisXL_V5.0_fp16.safetensors?download=true](https://huggingface.co/SG161222/RealVisXL_V5.0/resolve/main/RealVisXL_V5.0_fp16.safetensors?download=true)+ * License: OpenRAIL+++ * Size: ~7 GB+* **Alternative: Standard SDXL Base:**+ * **SDXL Base 1.0:**+ * URL: [https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors?download=true](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/resolve/main/sd_xl_base_1.0.safetensors?download=true)+ * License: OpenRAIL+++ * Size: ~7 GB+* *Note: StableGen supports any SDXL-based model.*++**5. (Optional) FLUX.1 Setup**++FLUX.1 is a newer diffusion architecture and its usage in StableGen is optional.+**Important Considerations for FLUX.1:**+* **License:** The FLUX.1-dev model and its specific ControlNet have a **strict non-commercial license**. You must agree to its terms on Hugging Face before downloading.+* **Hugging Face Account:** Downloading the FLUX.1-dev model typically requires a Hugging Face account and being logged in.+* **IPAdapter:** Not currently supported for the FLUX.1 architecture within StableGen.+* **Size:** FLUX.1 models and their dependencies are very large.++* **a) FLUX.1-dev Model:**+ * **Directory:** `<YourComfyUIDirectory>/models/checkpoints/`+ * **Filename:** `flux1-dev.safetensors`+ * **Download Page:** [https://huggingface.co/black-forest-labs/FLUX.1-dev/](https://huggingface.co/black-forest-labs/FLUX.1-dev/)+ * **License:** FLUX-1-dev Non-Commercial License+ * **Size:** ~24 GB++* **b) FLUX CLIP Models (Required for FLUX.1-dev):**+ * **Directory:** `<YourComfyUIDirectory>/models/clip/`+ * **File 1:** `t5xxl_fp8_e4m3fn.safetensors` ([URL](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/t5xxl_fp8_e4m3fn.safetensors?download=true))+ * **File 2:** `clip_l.safetensors` ([URL](https://huggingface.co/comfyanonymous/flux_text_encoders/resolve/main/clip_l.safetensors?download=true))+ * **License (for both CLIP models):** Apache 2.0+ * **Combined Size:** ~5.5 GB++* **c) FLUX ControlNet (Union - Depth/Canny):**+ * **Directory:** `<YourComfyUIDirectory>/models/controlnet/`+ * **Target Filename:** `controlnet_flux1_union_pro.safetensors`+ * **Download URL:** [https://huggingface.co/Shakker-Labs/FLUX.1-dev-ControlNet-Union-Pro/resolve/main/diffusion_pytorch_model.safetensors?download=true](https://huggingface.co/Shakker-Labs/FLUX.1-dev-ControlNet-Union-Pro/resolve/main/diffusion_pytorch_model.safetensors?download=true)+ * **Action:** Download and **rename** to `controlnet_flux1_union_pro.safetensors`.+ * **License:** FLUX-1-dev Non-Commercial License+ * **Size:** ~6.5 GB