ComfyUI Web Viewer

A custom node collection for ComfyUI under the vrch.ai category, providing a Web Viewer utility and a framework for real-time AI-generated interactive art.

Features:

• Real-time interaction and AI generation.
• Easily accessible on any device with a web browser.
• Supports interactive input methods such as keyboard, OSC control, and sound input.

Changelog

see CHANGELOG

Installation

Method 1: Auto Installation (Recommended)

Simply search for ComfyUI Web Viewer in ComfyUI Manager and install it directly.

Method 2: Manual Installation

1. Clone this repo into the custom_nodes directory of ComfyUI
2. Install dependencies:

   pip install -r requirements.txt
   

   or if you use the windows portable install, run this in ComfyUI_windows_portable folder:

   python_embeded\python.exe -m pip install -r ComfyUI\custom_nodes\comfyui-web-viewer\requirements.txt
   

3. Restart ComfyUI

How to Use

Web Viewer Nodes

• Documentation: Usage of Web Viewer nodes
• Example workflows:
  • Workflow Example: Image Web Viewer node

OSC Control Nodes

• Documentation: Usage of OSC Control nodes
• TouchOSC Control Panel:
  • comfyui_osc_control.tosc
• Example workflows:
  • Workflow Example: OSC Control Nodes
  • Workflow Example: Live Portrait + Gamepad
  • Workflow Example: IC-Light

Key Control Nodes

• Documentation: Usage of Key Control nodes
• Example workflows:
  • Workflow Example: Key Control Nodes

Audio Nodes

• Documentation: Usage of Audio nodes
• Example workflows:
  • Workflow Example: Audio Recorder Node

Image Nodes

• Documentation: Usage of Image nodes
• Example workflows: n/a

Version Update

This project uses bump2version for version management. To update the version:

1. Ensure you have bump2version installed:

   pip install bump2version

2. To update the version, run:

   python update_version.py [major|minor|patch]

   Replace [major|minor|patch] with the part of the version you want to increment.
3. This will automatically:
   • Update the version number in __init__.py
   • Update the CHANGELOG.md file
   • Create a new git commit and tag (if you're using git)
4. After running the script, review and update the CHANGELOG.md file with details about the new version's changes.
   • Note: make sure you've put changes in Unreleased section manually

Contributing

Created and maintained by the vrch.io team.

Contributions are welcome! Please feel free to submit a Pull Request.

Contact Us

For any inquiries, you can contact us at hi@vrch.io.

License

MIT License