Skip to content

Commit cc9943c

Browse files
committed
initial wave of SwarmUI rename pushes
1 parent 6071f8f commit cc9943c

45 files changed

Lines changed: 123 additions & 136 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to StableSwarmUI
1+
# Contributing to SwarmUI
22

33
Please open an Issue or Discussion, or ask on Discord before opening a pull request, to make sure your work doesn't overlap with others.
44

@@ -12,7 +12,7 @@ Want to help translate Swarm into another language?
1212
- Are you just helping improve an existing language?
1313
- Great! Just edit the file in `languages/(language-code).json` and improve the translations included
1414
- Do you want to add a new language?
15-
- See example commit here: https://github.com/Stability-AI/StableSwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
15+
- See example commit here: https://github.com/mcmonkeyprojects/SwarmUI/commit/20fd27a20127b6529a2837eb838a0cfae80c20b8
1616
- In short: copy/paste `languages/en.json` to `languages/(your-code).json`, fill out the info at the top, and start translating keys.
1717
- Also add `src/wwwroot/imgs/flags/(your-code).jpg` as a small icon image of a flag that represents the language.
1818
- You can use https://github.com/mcmonkeyprojects/translate-tool to fill out any keys you can't be bothered filling in yourself with automatic AI-powered translation

README.md

Lines changed: 30 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
1-
# StableSwarmUI
1+
# SwarmUI
22

3-
**StableSwarmUI 0.6.4.1 Beta**.
3+
**SwarmUI 0.9.0.0 Beta**.
44

55
A Modular Stable Diffusion Web-User-Interface, with an emphasis on making powertools easily accessible, high performance, and extensibility.
66

7-
![ui-screenshot](.github/images/stableswarmui.jpg)
7+
![ui-screenshot](.github/images/swarmui.jpg)
88

99
Join the [Discord](https://discord.gg/q2y38cqjNw) to discuss the project, get support, see announcements, etc.
1010

11-
Follow the [Feature Announcements Thread](https://github.com/Stability-AI/StableSwarmUI/discussions/11) for updates on new features.
12-
13-
# Migration Notice
14-
15-
As of 2024/06/21 StableSwarmUI will no longer be maintained under Stability AI.
16-
17-
The original developer will be maintaining an independent version of this project as [mcmonkeyprojects/SwarmUI](https://github.com/mcmonkeyprojects/SwarmUI)
18-
19-
Windows users can migrate to the new independent repo by simply updating and then running `migrate-windows.bat`
20-
21-
For Linux, Mac, or manual Windows: open a terminal in your Swarm folder then run `git remote set-url origin https://github.com/mcmonkeyprojects/SwarmUI`
22-
23-
See full migration guide here: https://github.com/mcmonkeyprojects/SwarmUI/discussions/2
11+
Follow the [Feature Announcements Thread](https://github.com/mcmonkeyprojects/SwarmUI/discussions/1) for updates on new features.
2412

2513
----
2614

@@ -45,7 +33,7 @@ Key feature targets not yet implemented:
4533

4634
**WARNING**: Google Colab does not necessarily allow remote WebUIs, particularly for free accounts, use at your own risk.
4735

48-
Colab link if you want to try Swarm: https://colab.research.google.com/github/Stability-AI/StableSwarmUI/blob/master/colab/colab-notebook.ipynb
36+
Colab link if you want to try Swarm: https://colab.research.google.com/github/mcmonkeyprojects/SwarmUI/blob/master/colab/colab-notebook.ipynb
4937

5038
### Runpod
5139

@@ -57,11 +45,11 @@ Note it may take several minutes to start up the first time. Check the container
5745

5846
Note: if you're on Windows 10, you may need to manually install [git](https://git-scm.com/download/win) and [DotNET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) first. (Windows 11 this is automated).
5947

60-
- Download [The Install-Windows.bat file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
48+
- Download [The Install-Windows.bat file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-windows.bat), store it somewhere you want to install at (not `Program Files`), and run it.
6149
- It should open a command prompt and install itself.
6250
- If it closes without going further, try running it again, it sometimes needs to run twice. (TODO: Fix that)
6351
- It will place an icon on your desktop that you can use to re-launch the server at any time.
64-
- When the installer completes, it will automatically launch the StableSwarmUI server, and open a browser window to the install page.
52+
- When the installer completes, it will automatically launch the SwarmUI server, and open a browser window to the install page.
6553
- Follow the install instructions on the page.
6654
- After you submit, be patient, some of the install processing take a few minutes (downloading models and etc).
6755

@@ -71,16 +59,16 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
7159

7260
- Install git from https://git-scm.com/download/win
7361
- Install DotNET 8 SDK from https://dotnet.microsoft.com/en-us/download/dotnet/8.0 (Make sure to get the SDK x64 for Windows)
74-
- open a terminal to the folder you want swarm in and run `git clone https://github.com/Stability-AI/StableSwarmUI`
62+
- open a terminal to the folder you want swarm in and run `git clone https://github.com/mcmonkeyprojects/SwarmUI`
7563
- open the folder and run `launch-windows.bat`
7664

7765
# Installing on Linux
7866

7967
- Install `git`, `python3` via your OS package manager if they are not already installed (make sure to include `pip` and `venv` on distros that do not include them in python directly)
8068
- For example, on recent Ubuntu versions, `sudo apt install git python3-pip python3-venv`
81-
- Download [the install-linux.sh file](https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-linux.sh), store it somewhere you want to install at, and run it
69+
- Download [the install-linux.sh file](https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh), store it somewhere you want to install at, and run it
8270
- If you like terminals, you can open a terminal to the folder and run the following commands:
83-
- `wget https://github.com/Stability-AI/StableSwarmUI/releases/download/0.6.1-Beta/install-linux.sh -O install-linux.sh`
71+
- `wget https://github.com/mcmonkeyprojects/SwarmUI/releases/download/0.6.5-Beta/install-linux.sh -O install-linux.sh`
8472
- `chmod +x install-linux.sh`
8573
- Run the `./install-linux.sh` script, it will install everything for you and eventually open the webpage in your browser.
8674
- Follow the install instructions on-page.
@@ -96,8 +84,8 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
9684
- Some users [have said](https://github.com/Stability-AI/StableSwarmUI/pull/6) that certain Linux distros expect `aspnet-runtime` to be installed separately
9785
- Open a shell terminal and `cd` to a directory you want to install into
9886
- Run shell commands:
99-
- `git clone https://github.com/Stability-AI/StableSwarmUI`
100-
- cd `StableSwarmUI`
87+
- `git clone https://github.com/mcmonkeyprojects/SwarmUI`
88+
- cd `SwarmUI`
10189
- `./launch-linux.sh`
10290
- open `http://localhost:7801/Install` (if it doesn't launch itself)
10391
- Follow the install instructions on-page.
@@ -106,28 +94,28 @@ Note: if you're on Windows 10, you may need to manually install [git](https://gi
10694

10795
# Installing on Mac
10896

109-
> **Note**: You can only run StableSwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
97+
> **Note**: You can only run SwarmUI on Mac computers with M1 or M2 (Mx) Apple silicon processors.
11098
11199
- Open Terminal.
112100
- Ensure your `brew` packages are updated with `brew update`.
113101
- Verify your `brew` installation with `brew doctor`. You should not see any error in the command output.
114102
- Install .NET for macOS: `brew install dotnet`.
115103
- If you don't have Python, install it: `brew install python@3.10` and `brew install virtualenv`
116-
- Change the directory (`cd`) to the folder where you want to install StableSwarmUI.
117-
- Clone the StableSwarmUI GitHub repository: `git clone https://github.com/Stability-AI/StableSwarmUI`.
118-
- `cd StableSwarmUI` and run the installation script: `./launch-macos.sh`.
104+
- Change the directory (`cd`) to the folder where you want to install SwarmUI.
105+
- Clone the SwarmUI GitHub repository: `git clone https://github.com/mcmonkeyprojects/SwarmUI`.
106+
- `cd eSwarmUI` and run the installation script: `./launch-macos.sh`.
119107

120-
The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the StableSwarmUI window.
108+
The installation starts now and downloads the Stable Diffusion models from the internet. Depending on your internet connection, this may take several minutes. Wait for your web browser to open the SwarmUI window.
121109

122-
> During the StableSwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
110+
> During the SwarmUI installation, you are prompted for the type of backend you want to use. For Mac computers with M1 or M2, you can safely choose the ComfyUI backend and choose the Stable Diffusion XL Base and Refiner models in the Download Models screen.
123111
124112
# Running with Docker
125113

126114
- To forward an Nvidia GPU, you must have the Nvidia Container Toolkit installed: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html
127115
- Open a shell terminal and `cd` to a directory you want to install into
128116
- Run shell commands:
129-
- `git clone https://github.com/Stability-AI/StableSwarmUI`
130-
- cd `StableSwarmUI`
117+
- `git clone https://github.com/mcmonkeyprojects/SwarmUI`
118+
- cd `SwarmUI`
131119
- `./launch-docker.sh`
132120
- Open your browser to `localhost:7801`
133121
- Note that it will forward the `Models` and `Output` directory, and will mount `Data` and `dlbackend` as independent persistent volumes.
@@ -140,7 +128,7 @@ See [the documentation folder](/docs/README.md).
140128

141129
The "Swarm" name is in reference to the original key function of the UI: enabling a 'swarm' of GPUs to all generate images for the same user at once (especially for large grid generations). This is just the feature that inspired the name and not the end all of what Swarm is.
142130

143-
The overall goal of StableSwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.
131+
The overall goal of SwarmUI is to a be full-featured one-stop-shop for all things Stable Diffusion.
144132

145133
See [the motivations document](/docs/Motivations.md) for motivations on technical choices.
146134

@@ -161,13 +149,20 @@ This project:
161149
- has the option to connect to remote servers to use [the Stability AI API](https://platform.stability.ai/) as a backend.
162150
- supports user-built extensions which may have their own licenses or legal conditions.
163151

164-
StableSwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.
152+
SwarmUI itself is under the MIT license, however some usages may be affected by the GPL variant licenses of connected projects list above, and note that any models used have their own licenses.
153+
154+
### Previous License
155+
156+
(For updates prior to June 2024)
157+
158+
The MIT License (MIT)
159+
Copyright (c) 2024 Stability AI
165160

166161
### License
167162

168163
The MIT License (MIT)
169164

170-
Copyright (c) 2024 Stability AI
165+
Copyright (c) 2024 Alex "mcmonkey" Goodwin
171166

172167
Permission is hereby granted, free of charge, to any person obtaining a copy
173168
of this software and associated documentation files (the "Software"), to deal

StableSwarmUI.sln renamed to SwarmUI.sln

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
33
# Visual Studio Version 17
44
VisualStudioVersion = 17.5.33530.505
55
MinimumVisualStudioVersion = 10.0.40219.1
6-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StableSwarmUI", "src\StableSwarmUI.csproj", "{2A621042-196A-4F9C-88EA-10369EAEE774}"
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SwarmUI", "src\SwarmUI.csproj", "{2A621042-196A-4F9C-88EA-10369EAEE774}"
77
EndProject
88
Global
99
GlobalSection(SolutionConfigurationPlatforms) = preSolution

colab/colab-notebook.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"SWARMPATH = '/content/drive/MyDrive'\n",
2323
"\n",
2424
"# Colab breaks venvs, and doesn't save anything valid to drive, so just screw it do a global install of pip reqs if we used a comfy backend in the drive\n",
25-
"!if [[ -f \"$SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/requirements.txt\" ]]; then rm -rf $SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/venv/; pip install -r $SWARMPATH/StableSwarmUI/dlbackend/ComfyUI/requirements.txt; fi"
25+
"!if [[ -f \"$SWARMPATH/SwarmUI/dlbackend/ComfyUI/requirements.txt\" ]]; then rm -rf $SWARMPATH/SwarmUI/dlbackend/ComfyUI/venv/; pip install -r $SWARMPATH/SwarmUI/dlbackend/ComfyUI/requirements.txt; fi"
2626
]
2727
},
2828
{
@@ -51,8 +51,8 @@
5151
"# Colab breaks venv, so, tell swarm to not make a venv\n",
5252
"os.environ['SWARM_NO_VENV'] = 'true'\n",
5353
"\n",
54-
"# Download StableSwarmUI\n",
55-
"url = \"https://github.com/Stability\" + \"-AI/StableSwarmUI\"\n",
54+
"# Download SwarmUI\n",
55+
"url = \"https://github.com/mcmonkeyprojects/SwarmUI\"\n",
5656
"!git clone $url"
5757
]
5858
},
@@ -65,7 +65,7 @@
6565
"outputs": [],
6666
"source": [
6767
"# Alright, launch it! Watch the output for a Cloudflare URL\n",
68-
"%cd $SWARMPATH/StableSwarmUI/\n",
68+
"%cd $SWARMPATH/SwarmUI/\n",
6969
"!git pull\n",
7070
"\n",
7171
"!bash ./launch-linux.sh --launch_mode none --cloudflared-path cloudflared"

docker-compose.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
services:
2-
stableswarmui:
3-
image: stableswarmui
2+
swarmui:
3+
image: swarmui
44
build: .
5-
container_name: stableswarmui
5+
container_name: swarmui
66
# uncomment `networks: host` if you want to access other services on the host network (eg a separated comfy instance)
77
# networks: host
88
volumes:

docs/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# StableSwarmUI API Documentation
1+
# SwarmUI API Documentation
22

3-
StableSwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).
3+
SwarmUI has a full-capability network API that you can use from external programs, both to use Swarm features (eg generate images) and to manage the Swarm instance (eg modify backends).
44

55
Swarm uses its own API - you can simply open the web interface, open your browser tools, and interact with Swarm to watch what API calls are made, and then replicate those from your own code.
66

docs/APIRoutes/AdminAPI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# StableSwarmUI API Documentation - AdminAPI
1+
# SwarmUI API Documentation - AdminAPI
22

33
> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
44

docs/APIRoutes/BackendAPI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# StableSwarmUI API Documentation - BackendAPI
1+
# SwarmUI API Documentation - BackendAPI
22

33
> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
44

docs/APIRoutes/BasicAPIFeatures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# StableSwarmUI API Documentation - BasicAPIFeatures
1+
# SwarmUI API Documentation - BasicAPIFeatures
22

33
> This is a subset of the API docs, see [/docs/API.md](/docs/API.md) for general info.
44

0 commit comments

Comments
 (0)