Current State of Plugin integration





Supported ComfyUI Versions

Royal Rendes supports the Windows packages "ComfyUI Portable" and  "ComfyUI Desktop".


If there is interest in a Linux or Mac setup, please let us know.




General information

Version control

Some general statement about version control:

Please note that ComfyUI was build with ongoing development in mind.
This means you can always and very easily update any part of ComfyUI.


And as the ComfyUI is in active development, files change all the time.
The ComfyUI version stated does not reflect all changes, the version is updated from time to time.

ComfyUI was not build with a production pipeline in mind that requires to use the same version on all machines.

(Like other applications do that offer specific updates as download. e.g. Houdini 21.0.0, 21.0.1, ... )

You and all other artists just have to keep that in mind before they update their local installation.



The ComfyUI Ecosystem



We need to take a look at the ComfyUI parts first.


Webserver
(Application)

The webserver does all the processing.
The webserver provides websites to your browser.

"BASE" Directory

This is an directory for 

  1. Workflow related files
    • /user
      Primary load/save location for your ComfyUI workspace files.
      This is the location that is shown if you click on the workspace in ComfyUI.
      In addition a database file that contains some user specific data.
    • /input
      You can place any textures in here. 
      These textures are found when you click into the filename fields of a an image loader note.
      Note about textures: 
      While you can place all images in this folder and load them by name into ComfyUI, 
      you can use full paths as well.
      This way you do not have to copy all textures for all workspaces into one folder.
      And depending on your setup, this folder might be on your workstation and is therefore not available on the farm.
    • /output
      ComfyUI own save nodes do not allow absolute paths.
      ComfyUI renders all images/videos into this folder.
      Of course you can enter subfolders (relative paths) in your save nodes as well. E.g. "myRender/ latest/ myImage".


  1. Plugins for ComfyUI
    • /custom_nodes
      New plugin nodes for the workspace of ComfyUI.
    • /models
      Plugin model files.  
      Those model files are huge.


  1. The python executable and modules
    A mix of application files requied for ComfyUI and modules required for custom plugins.
    • /.venv
      The python executable that starts the webserver and does the actual processing.
      It is a separated/isolated from your system's Python to prevent version conflicts and to keep your system's python clean.



  1. Temp folder
    • /temp




Setup


Submission


To install the rrSubmitter plugin, please copy the folder [RR]\render_apps\_submitplugins\RR_ComfyUI_Plugin\  

into your ComfyUI custom_nodes folder (like for example C:\ComfyUI_Base\custom_nodes\RR_ComfyUI_Plugin\ )


The plugin reads the RR network folder location from the environment variable RR_ROOT.
This env var is installed by rrWorkstationInstaller.
It you cannot use rrWorkstationInstaller or if it does not work for you, you can edit the file RR_ComfyUI_Plugin\rrSubmit.py. 
Change the function getRR_Root() and replace one of the %RRLocationWin% variables with the path to Royal Render (use forward slashes).



Rendering



ComfyUI is setup as RR Shared Executable.
You do not install it on every render client, you copy it into RR.

Please see help subsection Windows or Linux how to setup it.



Models / Custom Nodes


The rrClient copies a models and a custom_nodes folder from the [RR] network folder.


The easiest way to see the source path is to open a render log.

The render log file states:

* ComfyUI source models path is set to <RR_COMFYUI_MODELS>

* ComfyUI source custom_nodes path is set to <RR_COMFYUI_NODES> 



Important Note:
The rrClients require a lot of free space for all the models!