Skip to content

Commit 7597748

Browse files
authored
Readme (#22)
* Asset upload * Asset upload * Create README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 4808497 commit 7597748

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
![Header](docs/assets/github-header-image.png)
2+
3+
# Stable-Diffusion-Android
4+
5+
[![Version](https://img.shields.io/badge/Version-0.1.0-green)](https://github.com/ShiftHackZ/Stable-Diffusion-Android/releases)
6+
7+
8+
[![Google Play](docs/assets/google_play.png)](https://play.google.com/store/apps/details?id=com.shifthackz.aisdv1.app)
9+
10+
Stable Diffusion AI is an easy-to-use app that lets you quickly generate images from text or other images with just a few clicks. With this app, you can communicate with your own server and generate high-quality images in seconds.
11+
12+
## Features
13+
14+
- Uses server environment powered by [Stable-Diffusion-WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) (AUTOMATIC1111)
15+
- Supports original Txt2Img, Img2Img modes
16+
- **Positive** and **negative** prompt support
17+
- Support dynamic **size** in range from 64 to 2048 px (for width and height)
18+
- Selection of different **sampling methods** (available samplers are loaded from server)
19+
- Unique **seed** input
20+
- Dynamic **sampling steps** in range from 1 to 150
21+
- Dynamic **CFG scale** in range from 1.0 to 30.0
22+
- **Restore faces** option
23+
- ( Img2Img ONLY ) : Image selection from device gallery _(requires user permission)_
24+
- ( Img2Img ONLY ) : Capture input image from camera _(requires user permission)_
25+
- In-app Gallery, stored locally, contains all AI generated images
26+
- Displays generated images grid
27+
- Image detail view: Zoom, Pinch, Generation Info.
28+
- Export all gallery to **.zip** file
29+
- Export single photo to **.zip** file
30+
- Settings
31+
- WebUI server URL
32+
- Active SD Model selection
33+
- Server availability monitoring (http-ping method)
34+
- Enable/Disable auto-saving of generated images
35+
- Clear gallery / app cache
36+
37+
## Setup instruction
38+
39+
This app requires you to have the AUTOMATIC1111 WebUI that is running in server mode.
40+
41+
You can have it running either on your own hardware with modern GPU from Nvidia or AMD, or running it using Google Colab.
42+
43+
1. Follow the setup instructions on [Stable-Diffusion-WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) repository.
44+
2. Add the arguments `--api --listen` to the command line arguments of WebUI launch script.
45+
3. After running the server, get the IP address, or URL of your WebUI server.
46+
4. On the first launch, app will ask you for the server URL, enter it and press Connect button. If you want to change the server URL, go to Settings tab, choose Configure option, and repeat the setup flow.
47+
48+
If for some reason you have no ability to run your server instance, you can toggle the **Demo mode** swith on server setup page: it will allow you to test the app and get familiar with it, but it will return some mock images instead of AI-generated ones.
49+
50+
## Supported languages
51+
52+
App uses the language provided by OS default settings.
53+
54+
User interface of the app is translated for languages listed in this table:
55+
56+
| Language | Since version | Status |
57+
| --- | --- | --- |
58+
| English | 0.1.0 | `Translated` |
59+
| Ukrainian | 0.1.0 | `Translated` |
60+
61+
Any contributions to the translations are welcome.
62+
63+
## Donate
64+
65+
Main **foss** flavor of the app is open source, and you are welcome to use it for free.
66+
Only **play** flavor contains small ad-banner at the bottom navigation.
67+
68+
The donation is optional, if you'd like to say thanks and show a little support, here is the button:
69+
70+
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/shifthackz)
79.1 KB
Loading

docs/assets/google_play.png

8.14 KB
Loading

0 commit comments

Comments
 (0)