ComfyUI_LoRA_Sidebar

Now supports CivitAI.info, Stability Matrix, and RG Three data!

What is this?

A custom front-end UX node that creates a visual library of all your LoRAs. It's designed to be fast, slim, and make using LoRAs in Comfy a lot more fun for visual users - especially if you have lots of LoRAs. Should make people used to A1111 and other UI heavy platforms feel more at home. If you've got lots of LoRAs, this sidebar could be your new best friend!

Updates

10/27/24

• More external data changes, expanded support to both Stability Matrix data files as well as rgthree metadata. Reduced external calls on processing even more so should be even faster, loading additional data on demand in background. I don't plan to add anymore metadata support at this time, so this should be the last major data support change for a while
• Custom images now can be easily added to any LoRA Info window by just placing the images in the LoRA's base directory (where the preview.jpg and info.json live) - this also makes setting them as the thumbnail super easy
• Can now replace the default LoRA thumbail via the LoRA Info popup
• Enhanced LoRA Info popup image handling, added hi-rez pop out
• Added Favorites category override to keep it expanded even if you have categories minimized (Nice QoL buff for those with large datasets)
• Now properly detects symlink directories in default and custom lora paths, why do you people do this to me (I'm so over symlinks 😝)
• Fixed some bugs / text

10/25/24

• Now supports using existing data and images that follow the civitai.info format, this reduces duplication and also greatly speeds up processing of LoRAs that have it
• Fixed a bug with the way subdirs were calculated, now drag and drop should be much more reliable
• Added detection for old data files and reprocessing logic, I won't change this unless I have to, but being able to check it is important (cause I changed it this time 😛)
• Overhaul of stored data to lay groundwork for future updates
• Can now search for "lycoris" in the search box to quickly find all your lycos 🥳

Features

• Sidebar that automatically generates a visual library of all your LoRA models
• Designed to be super fast for searches
• Easily filter LoRAs by base model (and any search term, obviously)
• View LoRA details via LoRA Info popup, includes important model info and has easy to copy trained words and tags
• Drag and drop LoRAs to create or update LoRA nodes on the canvas
  • Drag and drop images from the LoRA Info popup to load entire workflows (if metadata exists)
• Categorize and sort your LoRAs in multiple ways such as folder structure and automatic or custom tags
• Works with custom LoRAs - see usage notes below
• Provides NSFW protection for all those LoRAs that you don't remember downloading 😁
• Battle tested with very large (9000+ models) LoRA libraries
• Supports symlinks!
• Supports video preview files, because why not

Installation

Registry / Manager

• Available in Manager, install and go!

Manual

• git clone this repo into your ComfyUI custom nodes folder
  • There are no python dependencies for this node since it's front end only, you can also just download and extract the node there and I won't tell.
• Make sure to enable the new menu in the ComfyUI settings
• After install you probably want to go into Lora Sidebar Settings and configure things to your liking. If you have a very large collection and want to use categories I suggest using the collapsed default setting.
• The sidebar will automatically detect and start to process all your LoRAs when you open it. This can take a while!

NOTE - The sidebar will process and download metadata and images from Civitai into the loraData directory within the custom node folder - but ONLY if external data doesn't already exist! This is so everything can be fast, but it does take ~1MB of space per 10 LoRAs. A collection of ~9500 LoRAs was ~1GB.

Usage

• Open the sidebar and start the initial import / process of your LoRAs
  • If you have a lot of LoRAs this can take a while. The reason this is so slow is because I've used SAFE rate limits for the CivitAI API. If you know where to look in the code you can change it, but I don't recommend it. The process will run the background and if you close Comfy before it finishes it will resume where it left off.
• Use the search box to quickly search for any LoRAs
  • The sidebar is fastest using no categories and just doing raw searches, I know it's not for everyone but you can give it a try.
• Filter by base model using the dropdown
• Add LoRAs to your favorites by clicking on the ⭐ (remove them by clicking it again)
• View LoRA details by click on the i button, this popup contains lots of useful data and lets you copy tags and delete LoRAs
• Copy the lora trained words by using the 📋 button
• Refresh LoRA details with the...refresh button
• Drag and drop the LoRA images to create a LoRA node on your canvas, or drop them on a LoRA node to update it
  • Only supports default (core) ComfyUI nodes for now
• Use the slider at the top to quickly change the size of the LoRA Previews
• Update LoRA previews and/or data by editing the preview image and info files in the LoRA folder in the custom node's loraData folder - this is the best way to get custom LoRAs working fully and all the data is local only
• Customize the look and feel with the settings

Settings

This plugin has a host of settings to customize the appearence and sorting. Settings that aren't (hopefully) self explainatory have tooltips to describe how they are used. The one that most people will want to mess with here are the custom tags for sorting, if you don't use your directory structure for that. Because of the performance hit I do recommend giving it a swing with the default None and see if that does the trick, but I get browsing isn't as fun that way. Honestly if you don't have 3k+ LoRAs it really doesn't matter.

Limitations

• Drag and drop only supports core Comfy nodes, if you have some custom nodes you use please open an issue and I can add support for whatever
• Sorting does make the sidebar perform worse than with sorting off, it's not really noticable unless you have a lot of LoRAs though
• Sometimes with large LoRA libraries the sidebar won't initially load everything right, closing and reopening it fixes it (or hitting the X button on the search box) - this doesn't affect searching at all
• Sliders don't really look great and they don't use the right node. If you have sliders and use them frequently I strongly suggest looking into my Slider Sidebar - https://github.com/Kinglord/ComfyUI_Slider_Sidebar
• This isn't a LoRA management tool so it's not made to help you manage your LoRA files
• With large datasets it can cause some timeouts, they are harmless but they do clutter the server logs a bit

Requirements

• This is a front end plugn so you must use the new menu for to work, you can enable it in the ComfyUI settings here (Top or Bottom doesn't matter)

• ComfyUI 0.1.3+
• There's no additional python requirements since it's just a frontend UI.

Roadmap

• [ ] Adding support for more LoRA nodes outside of ComfyUI Core - just open an issue for me to add them
• [ ] Custom category sorting
• [ ] Look into fixing timeouts with large datasets so the server logs don't get spammed
• [ ] Investigate some ways to improve performance when using categories
• [ ] Whatever bugs you find / features you submit
• [X] Support searching by model type (LoRA or Lycoris)
• [X] Support external data to speed up processing and reduce duplication
• [X] Fix LoRA processor from grabbing hidden system files

Why

There have been other solutions for dealing with LoRAs visually in ComfyUI, but none of them hit the mark for me, and most of them made working with LoRAs slower than normal. I wanted something that made working with LoRAs easier and faster, without any added bloat. I actually had worked on this and stopped when I heard about the new built-in model browser. However, I used it a few days ago and I have too many LoRAs and it crashed the front end. So, I wouldn't recommend trying to use that if you have a bunch like I do. 😄 This plugin was designed for true LoRA "power users" and to make their lives easier in ComfyUI.

Credits

LoRA Creators for all the great content they produce!

Comfy Org (Duh)
https://github.com/comfyanonymous/ComfyUI

https://www.comfy.org/discord

Compatability

Tested on ComfyUI 0.2.0 Should work on any version 0.1.3+