Skip to main content

Experimental AR/USDZ export toolkit for ComfyUI - Create AR-ready 3D content from existing workflows

Project description

ComfyReality 🎨✨

Professional AR/USDZ Content Creation Pipeline for ComfyUI

PyPI version Python 3.12+ UV MIT License ComfyUI

ComfyReality transforms ComfyUI into a professional AR content creation studio. Generate stunning AR stickers, remove backgrounds with precision, and export production-ready USDZ files - all optimized for iOS ARKit and mobile devices.

✨ Features

  • 🎨 FLUX/SDXL AR Sticker Generation - Create stunning stickers optimized for AR viewing
  • ✂️ Advanced SAM2 Segmentation - Precise background removal with clean alpha channels
  • 📦 Professional USDZ Export - iOS ARKit-ready files with proper optimization
  • 🚀 GPU-Accelerated Pipeline - Optimized for NVIDIA GPUs with CUDA support
  • 📱 Mobile-First Design - AR content optimized for phones and tablets
  • 🔧 Modern Python Standards - Built with UV, Ruff, and 2025 best practices

🚀 Quick Start

Installation

Using UV (Recommended):

uv add comfyui-reality

Using pip:

pip install comfyui-reality

The ComfyUI nodes will be automatically available after installation - no manual setup required!

Available Nodes

  1. 🎨 AR Sticker Generator - Generate AR-optimized stickers using FLUX/SDXL
  2. ✂️ SAM2 Background Remover - Advanced segmentation and background removal
  3. 📦 USDZ AR Exporter - Export production-ready AR files for iOS

🎛️ Node Documentation

ARStickerGenerator

Generates high-quality stickers optimized for AR viewing using state-of-the-art diffusion models.

Parameters:

  • prompt: Text description of desired sticker
  • sticker_style: Style preset (cartoon, realistic, artistic, etc.)
  • background_style: Background handling (clean_white, transparent, etc.)
  • width/height: Output dimensions (recommended: 1024x1024)
  • guidance_scale: Control prompt adherence (7.5 typical)
  • num_inference_steps: Quality vs speed tradeoff (20-50)

SAM2Segmenter

Advanced background removal using Meta's Segment Anything Model 2.

Features:

  • Automatic subject detection
  • Clean alpha channel generation
  • Configurable edge smoothing
  • Multiple output formats

USDZExporter

Professional USDZ file creation for iOS ARKit compatibility.

Specifications:

  • Y-up coordinate system
  • 64-byte alignment
  • <25MB file size optimization
  • <25K vertex count limits
  • 1024×1024 texture optimization

🛠️ Development

Prerequisites

  • Python 3.12+
  • UV package manager
  • NVIDIA GPU with CUDA (recommended)

Development Setup

# Clone repository
git clone https://github.com/gerred/stickerkit.git
cd stickerkit/comfy-reality

# Install dependencies
uv sync --extra dev

# Install pre-commit hooks
pre-commit install

# Run tests
uv run pytest

# Lint code
uv run ruff check
uv run ruff format

Project Structure

comfy-reality/
├── src/comfy_reality/     # Main package
│   ├── nodes/            # ComfyUI nodes
│   ├── models/           # Model loaders
│   └── utils/            # Shared utilities
├── tests/                # PyTest test suite
├── docs/                 # Documentation
├── examples/             # Example workflows
└── pyproject.toml        # Modern Python project config

📊 Performance

  • Sticker Generation: ~10-30 seconds (depends on steps, GPU)
  • Background Removal: ~2-5 seconds per image
  • USDZ Export: ~1-3 seconds per file
  • Memory Usage: ~6-12GB VRAM (varies by model)

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

🔗 Links


Made with ❤️ for the ComfyUI community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

comfyui_reality-0.1.3.tar.gz (262.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

comfyui_reality-0.1.3-py3-none-any.whl (60.3 kB view details)

Uploaded Python 3

File details

Details for the file comfyui_reality-0.1.3.tar.gz.

File metadata

  • Download URL: comfyui_reality-0.1.3.tar.gz
  • Upload date:
  • Size: 262.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.4

File hashes

Hashes for comfyui_reality-0.1.3.tar.gz
Algorithm Hash digest
SHA256 7ac13e2bb4426456d0a4528f764ae8283487749a036a8027559646b6ba29b7ba
MD5 2120dfbe2a17360b83701148db6947b3
BLAKE2b-256 7a1de6558757e2cc24f676343941b32ce62628a6d468049d89df5238d6321ba9

See more details on using hashes here.

File details

Details for the file comfyui_reality-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for comfyui_reality-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d186a0aae3c2516ccc0e0754610c1a71922a5712d91935faf0a35e77f2d6278a
MD5 83ad88cb2f7b053f836259ea47524a29
BLAKE2b-256 2464eda68868ad5d737f1efe3a1a3b3b9046c2a17570dba8b8a8df0ae371de69

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page