ComfyUI Node: Build Filename String (WLSH)

Build Filename String (WLSH):

The Build Filename String (WLSH) node is designed to help you create dynamic and meaningful filenames for your AI-generated content. This node allows you to construct filenames using various tokens such as timestamps, model names, seeds, and counters, ensuring that each file is uniquely identifiable and organized. By leveraging this node, you can automate the naming process, making it easier to manage and retrieve your files. The primary goal of this node is to provide a flexible and customizable way to generate filenames that reflect important metadata, enhancing your workflow efficiency and file management.

Build Filename String (WLSH) Input Parameters:

filename

This parameter is a string that serves as the base format for your filename. You can include tokens like %time, %model, %seed, and %counter within this string to dynamically insert the corresponding values. For example, a filename format like image_%time_%seed will be replaced with the current timestamp and seed value. This parameter is required and does not support multiline input.

modelname

This optional string parameter allows you to specify the name of the model used in generating the content. If included in the filename format using the %model token, it will be replaced with the value of this parameter. The default value is an empty string, and it does not support multiline input.

seed

This optional integer parameter represents the seed value used in the generation process. Including the %seed token in your filename format will replace it with this seed value. The default value is 0, with a minimum of 0 and a maximum of 0xffffffffffffffff.

counter

This optional parameter is an integer that can be used to keep track of the number of files generated. Including the %counter token in your filename format will replace it with this counter value. The default value is 0.

time_format

This optional string parameter defines the format of the timestamp that will replace the %time token in your filename format. The default format is %Y-%m-%d-%H%M%S, which corresponds to a timestamp like 2023-10-05-153045. This parameter does not support multiline input.

Build Filename String (WLSH) Output Parameters:

filename

The output parameter is a string that represents the fully constructed filename based on the provided format and input values. This filename will include the dynamically replaced tokens, making it unique and informative. The generated filename helps in organizing and identifying files easily.

Build Filename String (WLSH) Usage Tips:

• Use descriptive tokens in your filename format to include important metadata like timestamps, model names, and seed values, which can help in better organizing and retrieving your files.
• Customize the time_format parameter to match your preferred timestamp format, ensuring consistency across all generated filenames.
• Utilize the counter parameter to keep track of the number of files generated in a sequence, which can be particularly useful for batch processing.

Build Filename String (WLSH) Common Errors and Solutions:

Invalid time format

• Explanation: The time_format parameter provided is not a valid format string for the timestamp.
• Solution: Ensure that the time_format string follows the correct formatting rules for Python's strftime method. Refer to the Python documentation for valid format codes.

Missing required filename parameter

• Explanation: The filename parameter is required but was not provided.
• Solution: Make sure to include a valid string for the filename parameter when using the node.

Seed value out of range

• Explanation: The seed parameter value is outside the acceptable range.
• Solution: Ensure that the seed value is within the range of 0 to 0xffffffffffffffff.

Empty filename after processing

• Explanation: The processed filename resulted in an empty string.
• Solution: Check the filename format and ensure that it includes valid tokens or static text to avoid an empty result.