diff --git a/README.md b/README.md index 10ba2eb..6ca4062 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,49 @@ -### Lanuage +### Language [δΈ­ζ–‡](README.cn.md) # Stable-Diffusion-Webui-Civitai-Helper Stable Diffusion Webui Extension for Civitai, to handle your models much more easily. -# Feature -* Scan all models to download model information and preview images from Civitai. -* Modified Build-in "Extra Network" cards, to add following buttons on each card: +# 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. +Go to SD webui's extension tab, go to `Install from url` sub-tab. +Copy this project's url into it, click install. -Or, just download this project as zip file, unzip it to `Your SD webui/extensions`. +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. +Then reload UI with "Reload UI" Button in Setting tab. -Done. +Done. -# How ot use -## Scan model -Go to extension tab "Civitai Helper". There is a button called "Scan Model". +# How to Use +## Scanning Models +Go to extension tab "Civitai Helper". There is a button called "Scan model". -![](img/extension_tab.jpg) +![](img/extension_tab.jpg) -Click it, extension will scan all your models to generate SHA256 hash, and use this hash, to get model information and preview images from civitai. +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. +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. -![](img/model_info_file.jpg) +![](img/model_info_file.jpg) -If a model info file is already exists, it will skip this model. If a model can not be find in civitai, it will create an empty model info file, so it won't scan this model twice. +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. -### Add new models -When you have some new models, just click this button again, to get new model's information and preview images. +### 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 scaned your models!)** -Open SD webui's build-in "Extra Network" tab, to show model cards. +**(Use this only after you scanned your models!)** +Open SD webui's build-in "Extra Network" tab, to show model cards. -![](img/extra_network.jpg) +![](img/extra_network.jpg) Move your mouse on to the bottom of a model card. It will show 4 icon buttons: @@ -51,10 +51,10 @@ Move your mouse on to the bottom of a model card. It will show 4 icon buttons: - 🌐: 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 - -![](img/model_card.jpg) -If you click Refresh Button of extra network, those additional buttons will be removed. You can click `Refresh Civitai Helper` button to bring them back. +![](img/model_card.jpg) + +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. ![](img/refresh_ch.jpg) @@ -62,8 +62,8 @@ If you click Refresh Button of extra network, those additional buttons will be r Enjoy! -# Known Issue -* It can not force a model link to civitai by model id for now, will add this later. +# Known Issues +* It cannot force a model link to Civitai by model ID for now. This will be added later. # Change Log ## v1.2 @@ -77,4 +77,3 @@ Enjoy! * Check if refresh is needed when clicking "Refresh Civitai Helper" * Add space when adding trigger words * Add memory optimised sha256 as an option -