diff --git a/README.md b/README.md index a2408b6..b7e3827 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,16 @@ -

-๐Ÿ‘‹ Welcome to StableStudio, the open-source version of DreamStudio -
-
-[ ๐ŸŽจ UI README ] -[ ๐Ÿ”Œ Plugins README ] -[ ๐ŸŽฎ Discord ] -[ ๐Ÿ›Ÿ Bugs & Support ] -[ ๐Ÿ’ฌ Discussion ] -

+

๐Ÿ‘‹ Welcome to StableStudio, the open-source version of DreamStudio!

-
+**๐Ÿ—บ Contents โ€“ [๐Ÿš€ Quick Start](#quick-start) ยท [โ„น๏ธ About](#about) ยท [๐Ÿ™‹ FAQ](#faq) ยท [๐Ÿง‘โ€๐Ÿ’ป Contributing](#contributing)** + +**๐Ÿ“š Documentation โ€“ [๐ŸŽจ UI](./packages/stablestudio-ui/README.md) ยท [๐Ÿ”Œ Plugins](./packages/stablestudio-plugin/README.md) ยท โšก๏ธ platform.stability.ai** + +**๐Ÿ”— Links โ€“ ๐ŸŽฎ Discord ยท ๐ŸŒˆ DreamStudio ยท ๐Ÿ›Ÿ Bugs & Support ยท ๐Ÿ’ฌ Discussion** + +
+
diff --git a/packages/stablestudio-plugin-webui/README.md b/packages/stablestudio-plugin-webui/README.md index 1b32506..8913902 100644 --- a/packages/stablestudio-plugin-webui/README.md +++ b/packages/stablestudio-plugin-webui/README.md @@ -2,55 +2,64 @@ # ๐Ÿ”Œ [`stable-diffusion-webui`](https://github.com/AUTOMATIC1111/stable-diffusion-webui) Plugin -**๐Ÿ—บ Contents โ€“ [โ„น๏ธ About](#about) ยท [๐Ÿ“ฆ Installation](#installation) ยท [๐Ÿค Contract](#technology) ยท [๐Ÿ”ฎ Future](#conventions)** +**๐Ÿ—บ Contents โ€“ [โ„น๏ธ About](#about) ยท [โš™๏ธ Usage](#usage) ยท [โญ๏ธ Features](#features)** **[โฌ†๏ธ Top-Level README](../../README.md)** ![Electric1111](../../misc/Electric1111.png) -### ๐Ÿšง ๐Ÿ‘ท **PLUGINS ARE EXPERIMENTAL AND NOT FINAL** ๐Ÿ›  ๐Ÿšง - -_The contract and implementation are [likely to change](https://github.com/Stability-AI/StableStudio/issues/3)..._ - # โ„น๏ธ About -In order to make StableStudio easier to extend, we've ripped out the "back-end" into a plugin system. +This plugin enables StableStudio to run using [`stable-diffusion-webui`](https://github.com/AUTOMATIC1111/stable-diffusion-webui), which means you can generate images entirely on your own machine! -This means you can implement an entirely different inference stack, StableStudio doesn't care if it's local or a hosted API. - -This is a basic implement for stable-diffusion-webui plugin. +Thanks goes to [jtydhr88](https://github.com/jtydhr88) for the original work on this plugin. # โš™๏ธ Usage -1. On stable-diffusion-webui side, edit webui-user.bat and - `set COMMANDLINE_ARGS=--nowebui --cors-allow-origins=http://localhost:3000` - Then start your webui. -2. Once you see **INFO: Uvicorn running on http://127.0.0.1:7861**, means you started webui on api mode successfully. - you can open http://127.0.0.1:7861/docs to double check. -3. On StableStudio side, run `yarn dev:use-webui-plugin` -4. once the server started, click settings to check this plugin loaded successfully or not. ![webui-plugin](docs/images/webui-plugin.png) - ![overall](docs/images/overall.png) -5. click **Dream**, your webui server should start to process your request from StableStudio. -6. if you need to load existing from webui, you also need to install the extension [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio)) +1. First, you'll need to configure your local installation of `stable-diffusion-webui` to run without the UI and with CORS enabled. -Still, currently this plugin is a basic implement for webui, and only support a few of features: + **Windows** -- [x] txt2img -- [x] basic features (prompt, negative prompt, steps, batch_size, image size) -- [x] features provided by StableStudio -- [x] model select -- [x] sampler select -- [x] img2img -- [x] mask/inpaint/outpaint -- [x] store settings -- [x] webui status could replace images generated status -- [x] load existing images (need an extension on webui: [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio)) -- [x] Need to think about how to deal with extensions ecosystem in webui (made a start with [sd-webui-StableStudio](https://github.com/jtydhr88/sd-webui-StableStudio)) -- [x] upscale -- [ ] test and bugs fix (working) + Edit the command line arguments within `webui-user.bat`: + + ``` + set COMMANDLINE_ARGS=--nowebui --cors-allow-origins=http://localhost:3000 + ``` + + **Mac** + + Edit the command line arguments within `webui-macos-env.sh`: + + ``` + export COMMANDLINE_ARGS="--nowebui --cors-allow-origins=http://localhost:3000" + ``` + +2. Start `stable-diffusion-webui` and look for `INFO: Uvicorn running on http://127.0.0.1:7861`. + + You can make sure everything is running correctly by checking to see if [`http://127.0.0.1:7861/docs`](http://127.0.0.1:7861/docs) displays API documentation. + +3. Within your installation of StableStudio, run `yarn dev:use-webui-plugin`. + + _**That's it!**_ ๐ŸŽ‰ You should now be able to generate images using your local machine. + +## ๐Ÿ’พ Image History + +To persist your image history, you'll need to install the [`sd-webui-StableStudio`](https://github.com/jtydhr88/sd-webui-StableStudio) extension for `stable-diffusion-webui`. + +# โญ๏ธ Features + +Missing something? Please [let us know](https://github.com/Stability-AI/StableStudio/issues/new/choose)! + +- [x] Text-to-image +- [x] Image-to-image +- [x] Basic features (prompt, negative prompt, steps, batch size, image size) +- [x] Model selection +- [x] Sampler selection +- [x] Masking, in-painting, and out-painting +- [x] Settings storage +- [x] Accurate plugin status +- [x] [Loading existing images]("#image-history) +- [x] Upscaling - [ ] Lora support -- [ ] plugin could use path in settings along with a field for extra cli flags to launch webui on startup -- [ ] MacOS and Linux support (since I donโ€™t have environment with MacOS/Linux, may need someone help with this) -- [ ] many other features from webui...