Stable-Diffusion-Webui-Civi.../README.cn.md

173 lines
7.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Stable-Diffusion-Webui-Civitai-Helper
Stable Diffusion Webui 扩展Civitai助手用于更轻松的管理和使用Civitai模型。
[Civitai Url](https://civitai.com/models/16768/civitai-helper-sd-webui-civitai-extension)
# 注意
在安装或更新新版本之后需要整个关闭SD Webui重新启动它。光是Reload UI对本插件不起作用。
# 功能
* 扫描所有模型从Civitai下载模型信息和预览图
* 通过civitai模型页面url连接本地模型和civitai模型信息
* 通过Civitai模型页面url下载模型(含信息和预览图)到SD目录或子目录。
* 下载支持断点续传
* 批量检查本地模型在civitai上的新版本
* 直接下载新版本模型到SD模型目录内(含信息和预览图)
* 修改了内置的"Extra Network"模型卡片,每个卡片增加了如下功能按钮:
- 🖼: 修改文字"replace preview"为这个图标
- 🌐: 在新标签页打开这个模型的Civitai页面
- 💡: 一键添加这个模型的触发词到关键词输入框
- 🏷: 一键使用这个模型预览图所使用的关键词
* 以上额外功能按钮支持thumbnail模式
* 增加一直显示按钮的选项,以供触屏用户使用
# 安装
下载本项目为zip文件解压到`你的SD webui目录/extensions`下即可。
然后整个关闭SD Webui重新启动它。只是Reload UI不起作用。以后更新也是必须重启SD Webui。
(如果用SD webui的插件界面安装请先给git配置代理。它不是通过浏览器下载是通过git下载。)
# 使用方法
## 更新你的SD webui
本扩展需要取到 Extra Network的卡片列表id。**这个是2023-02-06才添加到SD webui里面的。**
所以如果你用的版本比这个早你就需要先更新你的SD Webui
## 扫描模型
前往扩展页面"Civitai Helper",有个按钮叫:"Scan Model"
![](img/extension_tab.jpg)
点击就会扫描所有模型生成SHA256码用于从civitai获取模型信息和预览图。**扫描需要很久,耐心等待**。
每个模型本扩展都会创建一个json文件用来保存从civitai得到的模型信息。这个文件会保存在模型同目录下名称为"模型名字.civitai.info"。
![](img/model_info_file.jpg)
如果模型信息文件已经存在扫描时就会跳过这个模型。如果模型不是civitai的就会创建个空信息文件以避免以后重复扫描。
### 添加新模型
当你下载了新模型之后只要再次点击扫描按钮即可。已经扫描过的文件不会重复扫描会自动得到新模型的信息和预览图。无须重启SD webui。
## 模型卡片
**(先完成扫描,再使用卡片功能)**
打开SD webui's 内置的 "Extra Network" 页面,显示模型卡片
![](img/extra_network.jpg)
移动鼠标到模型卡片底部就会显示4个按钮
- 🖼: 修改文字"replace preview"为这个图标
- 🌐: 在新标签页打开这个模型的Civitai页面
- 💡: 一键添加这个模型的触发词到关键词输入框
- 🏷: 一键使用这个模型预览图所使用的关键词
![](img/model_card.jpg)
如果你没有看到这些额外的按钮,只要点击`Refresh Civitai Helper`,他们就会被重新添加到卡片上。
![](img/refresh_ch.jpg)
每次当Extra Network刷新他都会删除掉额外的修改我们的按钮就会消失。这时你就需要点击`Refresh Civitai Helper`把这些功能添加回去。
### 小图模式
以上功能按钮支持小图模式但受制于SD Webui的CSS问题目前只能要么一直显示要么一直不显示不能鼠标滑过才显示。
![](img/thumb_mode.jpg)
## 下载
通过Civitai模型页面Url下载模型要3个步骤
* 填入url点击按钮获取模型信息
* 扩展会自动填入模型名称和类型,你需要选择下载的子目录和模型版本。
* 点击下载
![](img/download_model.jpg)
下载过程会显示在命令行界面带个进度条。
支持断点续传,无畏大文件。
## 批量检查模型新版本
你可以按照模型类型批量检查你的本地模型在civitai上的新版本。你可以选择多个模型类型。
![](img/check_model_new_version.jpg)
检查新版本的时候每检查完一个模型都会有一个1秒的延迟所以速度有点慢。
这是为了保护Civitai避免因为本插件而短暂陷入类似DDos的局面。有些云服务商有类似“免费用户每秒API请求不能超过1次”的保护机制。Civitai还没有这种设置。但我们还是得自觉保护它。因为如果它挂了对大家都没有好处。
**检查完毕之后**就会如下图在UI上显示所有找到的新版本的信息。
每个模型新版本都有3个链接。
* 第一个是这个模型的网页。
* 第二个是这个新版本的下载地址。
* 第三个是个按钮在python端直接下载新版本到模型目录内。
这种方式下载,下载详情显示在"Download Model"的区域和命令行窗口中。一次一个任务,不支持多任务。
![](img/check_model_new_version_output.jpg)
## 根据URL获取模型信息
如果无法在civitai上找到你的模型的SHA256但你还是希望能把你的模型连接到一个civitai模型你可以在本扩展页面从列表中选择你的模型并提供一个civitai模型页面的url。
点击按钮之后扩展就会下载那个civitai模型的信息作为你这个本地模型的信息使用。
![](img/get_one_model_info.jpg)
## 其他设置
**保存设置按钮, 会保存扫描模型区域,以及其他设置 这两个区域的选项**
* "一直显示按钮" 是为了方便触屏。
* "小图模式显示功能按钮" 会开关功能按钮在小图模式的显示
![](img/other_setting.jpg)
## 预览图
Extra Network支持两种预览图命名`model_name.png` 和 `model_name.preview.png`。其中,`model_name.png`优先级较高。
当优先级较高的预览图不存在,他就会自动使用`model_name.preview.png`。
这样,你自己创建的预览图 和 网络下载的预览图,能够同时存在,并优先使用你自己创建的。
## 关键词
卡片上添加关键词按钮是添加从civitai预览图中得到的关键词而不是你自己创建的图片的关键词。
civitai不是每个图片都有关键词一个模型中也不是所有预览图关键词都一样。所以这里是遍历所有civitai预览图信息加载第一个有关键词的。
## SHA256
为了创建文件的SHA256插件需要读取整个文件。对于大尺寸文件就会很慢。
默认插件使用内存优化的SHA256生成方法就不会卡住你的系统(最新版本强制使用内存优化的)。所以,如果你想要在扫描模型的同时使用电脑,就不要取消勾选这个优化。
有两种情况这个SHA256无法从civitai找到对应模型
* 太老的模型civitai没有存储SHA256.
* 模型作者静静的换掉了模型文件但没有修改描述和版本。所以虽然网页上看不出来但实际上civitai上的 和你本地的模型文件,已经不是同一个文件了。
这些情况下你可以在插件上通过提供模型页面的url来获取模型信息文件。v1.3新功能)
## Civitai API失效
Civitai在面临类似DDos的问题的时候会把整个网站立刻置于Cloudflare验证机制的保护下包括API的接口。于是API请求就会被跳转到Cloudflare的真人验证页面而无法获取任何信息。
这种情况请耐心等待Civitai恢复之后再连接Civitai。根据以往经验每次Civitai这样折腾一轮要6-8小时。
## 新特性
从v1.5开始v1.x不再接受任何新特性。所有新特性进入2.x。
2.x专注于自定义模型信息并可能改名为"Model Info Helper"。因为不再是专注Civitai了。
从v1.5开始。v1.x进入维护阶段。
Enjoy!