sd-webui-kitchen-theme-legacy/README.md

303 lines
10 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden 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.

<a name="readme-top"></a>
<div align="center">
<h1>⚠️ Maintenance Mode</h1>
<p>Kitchen Theme has moved into maintenance mode!</p>
<p>Recommend using <a href="https://github.com/canisminor1990/sd-webui-lobe-theme" target="_blank">Lobe Theme</a> for more custom features</p>
<img width="160" src="https://gw.alipayobjects.com/mdn/rms_7d1485/afts/img/A*XDYxSJXBjjwAAAAAAAAAAAAAARQnAQ">
<h1 align="center">Kitchen Theme</h1>
Kitchen Theme for Stable Diffusion WebUI
English · [简体中文](./README-zh_CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
<!-- SHIELD GROUP -->
[![release][release-shield]][release-url]
[![releaseDate][release-date-shield]][release-date-url]
[![ciTest][ci-test-shield]][ci-test-url]
[![ciRelease][ci-release-shield]][ci-release-url] <br/>
[![contributors][contributors-shield]][contributors-url]
[![forks][forks-shield]][forks-url]
[![stargazers][stargazers-shield]][stargazers-url]
[![issues][issues-shield]][issues-url]
</div>
![](https://github.com/canisminor1990/sd-web-ui-kitchen-theme/blob/main/assets/screenshot.webp?raw=true)
<details>
<summary><kbd>Table of contents</kbd></summary>
#### TOC
- [✨ Features](#-features)
- [🖥 Environment Support](#-environment-support)
- [📦 Installation](#-installation)
- [⚒️ Recommended Settings](#-recommended-settings)
- [🪄 Prompt formatting](#-prompt-formatting)
- [⌨️ Local Development](#-local-development)
- [🤝 Contributing](#-contributing)
- [🔗 Credits](#-credits)
####
</details>
<br/>
## ✨ Features
- 🌈 Supports light and dark themes with switch button.
- 🪄 Supports Prompt formatting.
- 🎛️ Quick Setting in draggable sidebar.
- 🎨 Based on Antd CSS Token.
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🖥 Environment Support
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Safari |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| last 2 versions | last 2 versions | last 2 versions |
> ⚠️ There is currently a known compatibility issue with styles on Firefox browser.
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 📦 Installation
As an extension (recommended)
Either clone the repo into your extensions folder:
```shell
git clone "https://github.com/canisminor1990/sd-web-ui-kitchen-theme" extensions/kitchen-theme
```
The current theme supports both light and dark themes. If you want to force dark mode, use the `--theme=dark` argument to launch your WebUI. For example, on Windows, your `webui-user.bat` should include:
```shell
set COMMANDLINE_ARGS= --theme=dark
```
Alternatively, you can switch directly through URL Props:
```shell
http://localhost:7860/?__theme=light
http://localhost:7860/?__theme=dark
```
> ⚠️ Warning: minimum requirements gradio-3.23.0 & sd-webui [4c1ad74](https://github.com/AUTOMATIC1111/stable-diffusion-webui/commit/4c1ad743e3baf1246db0711aa0107debf036a12b)
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## ⚒️ Recommended Settings
#### Kitchen WebUI Setting
> 👉 Tip: top right `⚙` icon in header
- **Prompt Textarea**
- Display mode: `scroll` | `resizable`
- **Sidebar**
- Default expand: `true`
- Display mode: `fixed` | `float`
- Default width: `280`
- **ExtraNetwork Sidebar**
- Enable: `true`
- Default expand: `true`
- Display mode: `fixed` | `float`
- Default Width: `340`
- Default card size: `86`
<br/>
#### Extra-Networks
- thumbs
- width: 86
- height: 128
![](https://github.com/canisminor1990/sd-web-ui-kitchen-theme/blob/main/assets/extra-networks.webp?raw=true)
<br/>
#### Quick-Setting
```txt
sd_model_checkpoint, sd_vae, CLIP_stop_at_last_layers, img2img_background_color, img2img_color_correction, samples_save, samples_format, grid_save, return_grid, n_rows, live_previews_enable, show_progress_every_n_steps, live_preview_refresh_period
```
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🪄 Prompt formatting
![](https://github.com/canisminor1990/sd-web-ui-kitchen-theme/blob/main/assets/prompt-formatting.webp?raw=true)
> 👉 Tip: Convert full-width punctuation to half-width, remove extra spaces, add missing commas, and move the Extra-Networks model to the end.
Before
```text
photorealistic photo of a handsome male (wizard :1.2 <lora:LuisapHotlineStyle:0.5> <lora:ElegantHanfuRuqunStyle:0.2> short beard, white wizard shirt, (with golden trim:0.8),
```
After
```text
photorealistic photo of a handsome male, (wizard:1.2), short beard, white wizard shirt, (with golden trim:0.8), <lora:LuisapHotlineStyle:0.5>, <lora:ElegantHanfuRuqunStyle:0.2>
```
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## ⌨️ Local Development
You can use Gitpod for online development:
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url]
Or clone it for local development:
```bash
$ git clone https://github.com/canisminor1990/sd-web-ui-kitchen-theme.git
$ cd sd-web-ui-kitchen-theme
$ npm install
$ npm start
```
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🤝 Contributing
<!-- CONTRIBUTION GROUP -->
> 📊 Total: <kbd>**7**</kbd>
<a href="https://github.com/canisminor1990" title="canisminor1990">
<img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
</a>
<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
</a>
<a href="https://github.com/actions-user" title="actions-user">
<img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
</a>
<a href="https://github.com/web-97" title="web-97">
<img src="https://avatars.githubusercontent.com/u/46352788?v=4" width="50" />
</a>
<a href="https://github.com/antfu" title="antfu">
<img src="https://avatars.githubusercontent.com/u/11247099?v=4" width="50" />
</a>
<a href="https://github.com/StimeKe" title="StimeKe">
<img src="https://avatars.githubusercontent.com/u/25315788?v=4" width="50" />
</a>
<a href="https://github.com/alwayshopeless" title="alwayshopeless">
<img src="https://avatars.githubusercontent.com/u/38844539?v=4" width="50" />
</a>
<!-- CONTRIBUTION END -->
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🔗 Credits
- stable-diffusion-webui<https://github.com/AUTOMATIC1111/stable-diffusion-webui>
- gradio-theme-gallery: <https://huggingface.co/spaces/gradio/theme-gallery>
- _before `1.0.0` version_
- sd-web-ui-quickcs: <https://github.com/Gerschel/sd-web-ui-quickcss/>
- Dark-Themes-SD-WebUI-Automatic1111: <https://github.com/Nacurutu/Dark-Themes-SD-WebUI-Automatic1111>
<div align="right">
[![][back-to-top]](#readme-top)
</div>
---
#### 📝 License
Copyright © 2023 [CanisMinor][profile-url]. <br />
This project is [MIT](./LICENSE) licensed.
<!-- LINK GROUP -->
[profile-url]: https://github.com/canisminor1990
[gitpod-url]: https://gitpod.io/#https://github.com/canisminor1990/sd-webui-kitchen-theme
<!-- SHIELD LINK GROUP -->
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
<!-- release -->
[release-shield]: https://img.shields.io/github/v/release/canisminor1990/sd-web-ui-kitchen-theme?style=flat&sort=semver&logo=github
[release-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/releases
<!-- releaseDate -->
[release-date-shield]: https://img.shields.io/github/release-date/canisminor1990/sd-web-ui-kitchen-theme?style=flat
[release-date-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/releases
<!-- ciTest -->
[ci-test-shield]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/workflows/Test%20CI/badge.svg
[ci-test-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/actions/workflows/test.yml
<!-- ciRelease -->
[ci-release-shield]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/workflows/Build%20and%20Release/badge.svg
[ci-release-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/actions/workflows/release.yml
<!-- contributors -->
[contributors-shield]: https://img.shields.io/github/contributors/canisminor1990/sd-web-ui-kitchen-theme.svg?style=flat
[contributors-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/graphs/contributors
<!-- forks -->
[forks-shield]: https://img.shields.io/github/forks/canisminor1990/sd-web-ui-kitchen-theme.svg?style=flat
[forks-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/network/members
<!-- stargazers -->
[stargazers-shield]: https://img.shields.io/github/stars/canisminor1990/sd-web-ui-kitchen-theme.svg?style=flat
[stargazers-url]: https://github.com/canisminor1990/sd-web-ui-kitchen-theme/stargazers
<!-- issues -->
[issues-shield]: https://img.shields.io/github/issues/canisminor1990/sd-web-ui-kitchen-theme.svg?style=flat
[issues-url]: https://github.com/canisminor1990/sd-webui-kitchen-theme/issues/new/choose