ComfyUI Node: FolderScanner

FolderScanner:

The FolderScanner node is designed to streamline the process of managing and accessing various model files and configurations within your AI art projects. It provides a structured way to organize and retrieve files such as checkpoints, configurations, and other model-related data. By leveraging this node, you can ensure that your project files are systematically stored and easily accessible, which enhances workflow efficiency and reduces the likelihood of errors. The FolderScanner node is particularly beneficial for AI artists who need to manage multiple models and configurations, as it automates the process of locating and validating these files, ensuring that the correct versions are used in your projects.

FolderScanner Input Parameters:

folder_name

This parameter specifies the name of the folder you want to scan. It is crucial for identifying which set of files or models you are interested in accessing. The folder name should match one of the predefined categories such as "checkpoints," "configs," "loras," "vae," etc. This ensures that the node looks in the correct directory and applies the appropriate file extensions for filtering. There are no strict minimum or maximum values, but it must be a valid string that corresponds to a key in the folder_names_and_paths dictionary.

filename

This parameter is used to specify the exact file you are looking for within the chosen folder. It helps in pinpointing the specific file you need, ensuring that the node returns the correct path. The filename should include the extension and be a valid file name within the specified folder. There are no strict minimum or maximum values, but it must be a valid string that corresponds to an existing file in the specified folder.

FolderScanner Output Parameters:

full_path

This output parameter provides the full path to the specified file within the chosen folder. It is essential for accessing the file directly in your project, ensuring that you can load or manipulate the file as needed. The full path is a string that includes the directory and the filename, making it easy to locate the file on your system.

file_list

This output parameter returns a list of all files within the specified folder that match the supported extensions. It is useful for getting an overview of all available files in a particular category, allowing you to choose the appropriate file for your project. The file list is an array of strings, each representing a file name within the folder.

FolderScanner Usage Tips:

• Ensure that the folder_name parameter matches one of the predefined categories to avoid errors.
• Use the filename parameter to specify the exact file you need, which helps in retrieving the correct path quickly.
• Utilize the file_list output to get an overview of all available files in a folder, which can be helpful for selecting the right model or configuration.

FolderScanner Common Errors and Solutions:

"Invalid folder name"

• Explanation: The folder name provided does not match any of the predefined categories in the folder_names_and_paths dictionary.
• Solution: Ensure that the folder name is one of the following: "checkpoints," "configs," "loras," "vae," "clip," "unet," "clip_vision," "style_models," "embeddings," or "diffusers."

"File not found"

• Explanation: The specified file does not exist in the chosen folder.
• Solution: Verify that the filename is correct and that the file exists in the specified folder. Check for any typos or incorrect extensions.

"Unsupported file extension"

• Explanation: The file extension of the specified file is not supported for the chosen folder.
• Solution: Ensure that the file extension matches one of the supported extensions for the specified folder. For example, use ".ckpt," ".pt," ".bin," ".pth," ".safetensors," or ".pkl" for model files.