Download or populate models with metadata and preview image from civitai.com

Go to file

butaixianran 0b51381b34 update js to check no null value		2023-03-08 20:08:19 +08:00
img	add know issues to doc	2023-03-07 20:47:59 +08:00
javascript	update js to check no null value	2023-03-08 20:08:19 +08:00
scripts	update js to check no null value	2023-03-08 20:08:19 +08:00
.gitignore	update js to check no null value	2023-03-08 20:08:19 +08:00
README.cn.md	update document, add info for scanning model	2023-03-08 01:14:40 +08:00
README.md	Merge branch 'main' of https://github.com/butaixianran/Stable-Diffusion-Webui-Civitai-Helper	2023-03-08 12:52:33 +08:00

README.md

Language

中文

Stable-Diffusion-Webui-Civitai-Helper

Stable Diffusion Webui Extension for Civitai, to handle your models much more easily.

Features

Scans all models to download model information and preview images from Civitai.
Modified Built-in "Extra Network" cards, to add the following buttons on each card:
- 🖼: Modified "replace preview" text into this icon
- 🌐: Open this model's Civitai url in a new tab
- 💡: Add this model's trigger words to prompt
- 🏷: Use this model's preview image's prompt

Install

Go to SD webui's extension tab, go to Install from url sub-tab. Copy this project's url into it, click install.

Alternatively, download this project as a zip file, and unzip it to Your SD webui folder/extensions.

Then reload UI with "Reload UI" Button in Setting tab.

Done.

How to Use

Scanning Models

Go to extension tab "Civitai Helper". There is a button called "Scan model".

Click it and the extension will scan all your models to generate SHA256 hashes, using them to retreive model information and preview images from Civitai.

For each model, it will create a json file to save all model info from Civitai. This model info file will be "Your_model_name.civitai.info" in your model folder.

If a model info file already exists, it will be skipped. If a model cannot be found in Civitai, it will create an empty model info file, so the model won't be scanned twice.

Adding New Models

When you have some new models, just click this button again, to get new model's information and preview images.

Model Card

(Use this only after you scanned your models!) Open SD webui's build-in "Extra Network" tab, to show model cards.

Move your mouse on to the bottom of a model card. It will show 4 icon buttons:

🖼: Modified "replace preview" text into this icon
🌐: Open this model's Civitai url in a new tab
💡: Add this model's trigger words to prompt
🏷: Use this model's preview image's prompt

If you click the Refresh Button of extra network, those additional buttons will be removed. You can click the Refresh Civitai Helper button to bring them back.

Enjoy!

Known Issues

It cannot force a model link to Civitai by model ID for now. This will be added later.