From 893e514b417fb40ed2b90238d9fdcec5ead2e698 Mon Sep 17 00:00:00 2001 From: kukuo6666 Date: Tue, 18 Mar 2025 17:46:31 +0800 Subject: [PATCH] Update: Complete English documentation and version 1.1.0 --- INSTALL.md | 44 +++++++++++++++++---------- README.md | 48 ++++++++++++++++------------- __init__.py | 3 +- comfyui-manager-entry.json | Bin 898 -> 1102 bytes e -Force .git | 60 +++++++++++++++++++++++++++++++++++++ 5 files changed, 119 insertions(+), 36 deletions(-) create mode 100644 e -Force .git diff --git a/INSTALL.md b/INSTALL.md index e8346d2..e0d3de4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,13 +1,15 @@ # Installation Guide ## Requirements -- Python 3.8+ + +- Python 3.8 or higher - Latest version of ComfyUI - Sufficient GPU memory for processing large panoramic images +- CUDA-compatible GPU recommended ## Basic Installation -1. Clone this repository to ComfyUI's `custom_nodes` directory: +1. Clone this repository to your ComfyUI's `custom_nodes` directory: ```bash cd ComfyUI/custom_nodes git clone https://github.com/yourusername/ComfyUI-Equirect.git @@ -23,7 +25,7 @@ ## Manual Installation of py360convert -If `pip install py360convert` fails, you can try installing from source: +If `pip install py360convert` fails, you can install from source: ```bash git clone https://github.com/sunset1995/py360convert.git @@ -38,25 +40,37 @@ If you encounter import errors, ensure all dependencies are correctly installed: ``` ImportError: No module named 'py360convert' ``` - -Solution: Manually install the py360convert library. +Solution: Manually install the py360convert library as described above. ### Memory Errors -Processing large panoramic images may require substantial memory. If you encounter memory errors, try: -1. Reduce the input image size -2. Lower the cubemap face size +Processing large panoramic images requires substantial memory. If you encounter memory errors: +1. Reduce input image size +2. Lower cubemap face size 3. Use a device with more GPU memory ### Conversion Quality -For best conversion quality: -1. Use high-resolution input images (at least 4K) +For optimal conversion quality: +1. Use high-resolution input images (4K or higher recommended) 2. Set cubemap face size to 512 or higher -3. Keep default FOV (90 degrees) +3. Maintain default FOV (90 degrees) ## Performance Optimization -To speed up processing: -1. Ensure PyTorch with CUDA support is correctly installed -2. Use reasonable image sizes (unnecessarily large sizes will increase processing time) -3. Process images individually if batch processing is not required \ No newline at end of file +To improve processing speed: +1. Ensure PyTorch with CUDA support is properly installed +2. Use appropriate image sizes (larger sizes increase processing time) +3. Process images individually when batch processing is not required + +## Version Compatibility + +- Tested with Python 3.8-3.12 +- Compatible with latest ComfyUI releases +- Requires CUDA-capable GPU for optimal performance + +## Support + +For issues and questions: +1. Check the GitHub issues page +2. Ensure all dependencies are correctly installed +3. Verify input image formats and sizes \ No newline at end of file diff --git a/README.md b/README.md index 84903c6..7f98308 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # ComfyUI-Equirect -ComfyUI nodes for conversion between equirectangular panoramas and cubemaps. +A ComfyUI extension for converting between equirectangular panoramas and cubemaps. This tool provides essential functionality for 360° image processing and VR/AR content creation. ## Features -- **EquirectToCubemapNode**: Convert equirectangular panoramas to 6 cubemap faces -- **CubemapToEquirectNode**: Convert 6 cubemap faces back to equirectangular panoramas +- **EquirectToCubemapNode**: Convert equirectangular panoramas into 6 cubemap faces +- **CubemapToEquirectNode**: Convert 6 cubemap faces back to equirectangular panorama ## Installation -1. Clone this repository to your ComfyUI `custom_nodes` directory: +1. Clone this repository into your ComfyUI's `custom_nodes` directory: ```bash cd ComfyUI/custom_nodes git clone https://github.com/yourusername/ComfyUI-Equirect.git @@ -23,30 +23,35 @@ ComfyUI nodes for conversion between equirectangular panoramas and cubemaps. ## Usage -### EquirectToCubemapNode (Equirectangular to Cubemap) +### EquirectToCubemapNode + +Converts a 360° panorama into six individual faces of a cubemap. Inputs: - `equirect_image`: Equirectangular panorama input (2:1 aspect ratio) -- `face_size`: Size of the output cubemap faces +- `face_size`: Output size for each cubemap face - `fov`: Field of view angle (default: 90 degrees) Outputs: - `front`, `right`, `back`, `left`, `top`, `bottom`: 6 cubemap faces -### CubemapToEquirectNode (Cubemap to Equirectangular) +### CubemapToEquirectNode + +Reconstructs a 360° panorama from six cubemap faces. Inputs: - `front`, `right`, `back`, `left`, `top`, `bottom`: 6 cubemap faces -- `output_height`: Height of the output equirectangular image (width will be automatically set to twice the height) +- `output_height`: Height of the output panorama (width will be 2x height) Outputs: - `equirect_image`: Converted equirectangular panorama -## Technical Notes +## Technical Details -- Uses `py360convert` library for high-quality conversion when available -- Automatically falls back to custom implementation if the library is not available -- Supports batch processing and maintains correct image formats +- High-quality conversion using `py360convert` library +- Automatic fallback to custom implementation if needed +- Batch processing support +- Format preservation throughout conversion ## Dependencies @@ -58,18 +63,21 @@ Outputs: ## Parameters -- **Input Image**: Equirectangular panorama image with 2:1 aspect ratio -- **Face Size**: Edge length for each cubemap face (default: 512, range: 64-4096) -- **Field of View**: FOV angle for each face (default: 90, range: 60-120) +- **Input Image**: Equirectangular panorama (2:1 aspect ratio) +- **Face Size**: Cubemap face edge length (default: 512, range: 64-4096) +- **Field of View**: View angle per face (default: 90°, range: 60-120°) ## System Requirements -- ComfyUI +- ComfyUI latest version - Python 3.7+ -- PyTorch -- Pillow (PIL) -- NumPy +- CUDA-compatible GPU recommended +- Sufficient GPU memory for large panoramas ## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details \ No newline at end of file +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Version + +Current version: 1.1.0 \ No newline at end of file diff --git a/__init__.py b/__init__.py index 0826f93..22eb2c8 100644 --- a/__init__.py +++ b/__init__.py @@ -1,5 +1,6 @@ """ -ComfyUI nodes for equirectangular image processing +ComfyUI nodes for equirectangular image processing and cubemap conversion. +Provides functionality for converting between equirectangular panoramas and cubemap faces. """ from .equirect_to_cubemap import EquirectToCubemapNode diff --git a/comfyui-manager-entry.json b/comfyui-manager-entry.json index f882793511ed22f28e4119bbf826048dd6617181..9d6da18edf10b1e3082e6dadb7eb84850dc2febe 100644 GIT binary patch literal 1102 zcmbVMO-sW-5PfIC{}6KSmlQ;LE5(CXQ7 ze!`3lCF7VFV#HfSLk@&zu}aM3Yi0T2Fbk|4}^!GcqF!7yFrGRYToY zmFe{GtMirMy<+1$G5s=PI3%g$=h7;~%SlzMidfj)!U2xY7Ms%PtBs+!i! zwCZq)A!l1=I6!T~DTI5G^HAKtPkm^slSmTMAf8JeU`n?(V#q z*?If@^(l8KuUEZ?uh8|OW?HDwR%`9_pgUdaR&StEReDjZMqYFJ2bO`Y0o5o2*JAvL z%bjpV%9X&LDT3eW9_@lv4Z}t6b5MAOyT(O@Qi)ayI`7qP=s0%oI4xvdjvEz0BMv{Wrm95`0Tw;Vf5$s_`4`i{PW-x%jl?AS@!E7;0Xn)2Vd$-!*t>~b1sY&k5B*r)j- zFpW0hW*yh*Os9L-q-V3TtZkx?eADGoXs8nGTr(;Olimb}SL9$XX7u80S3^#c=nVNtxB){(LLH;%QHakC>b+