Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ShiftHackZ/Stable-Diffusion-Android

Stable Diffusion AI client app for Android
https://github.com/ShiftHackZ/Stable-Diffusion-Android

ai android automatic1111 clean-architecture compose compose-ui foss gson koin kotlin material3 multimodule-android-app mvi retrofit2 room-database rxjava3 stable-diffusion stable-diffusion-mobile stable-diffusion-webui viewmodel

Last synced: 2 days ago
JSON representation

Stable Diffusion AI client app for Android

Host: GitHub
URL: https://github.com/ShiftHackZ/Stable-Diffusion-Android
Owner: ShiftHackZ
License: agpl-3.0
Created: 2023-03-04T15:35:58.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-10-20T17:12:48.000Z (22 days ago)
Last Synced: 2024-10-22T01:30:34.094Z (20 days ago)
Topics: ai, android, automatic1111, clean-architecture, compose, compose-ui, foss, gson, koin, kotlin, material3, multimodule-android-app, mvi, retrofit2, room-database, rxjava3, stable-diffusion, stable-diffusion-mobile, stable-diffusion-webui, viewmodel
Language: Kotlin
Homepage: https://sdai.moroz.cc
Size: 8.37 MB
Stars: 684
Watchers: 13
Forks: 67
Open Issues: 75
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Support: docs/supporters.json

Awesome Lists containing this project

README

        ![Header](docs/assets/github-header-image.png)

# Stable-Diffusion-Android

![Google Play](https://img.shields.io/endpoint?color=blue&logo=google-play&logoColor=white&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.shifthackz.aisdv1.app%26l%3DGoogle%2520Play%26m%3D%24version)

![F-Droid](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ff-droid.org%2Fapi%2Fv1%2Fpackages%2Fcom.shifthackz.aisdv1.app.foss&query=%24.packages%5B0%5D.versionName&label=F-Droid&link=https%3A%2F%2Ff-droid.org%2Fpackages%2Fcom.shifthackz.aisdv1.app.foss%2F)

[![Google Play](docs/assets/google_play.png)](https://play.google.com/store/apps/details?id=com.shifthackz.aisdv1.app)

[![F-Droid](docs/assets/fdroid.png)](https://f-droid.org/packages/com.shifthackz.aisdv1.app.foss)

[![4pda](docs/assets/4pda.png)](https://4pda.to/forum/index.php?showtopic=1082639)

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.

## Features

- Can use server environment powered by [AI Horde](https://stablehorde.net/) (a crowdsourced distributed cluster of Stable Diffusion workers)

- Can use server environment powered by [Stable-Diffusion-WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) (AUTOMATIC1111)

- Can use server envitonment powered by [Hugging Face Inference API](https://huggingface.co/docs/api-inference/quicktour).

- Can use server environment powered by [OpenAI](https://platform.openai.com/docs/api-reference/images) (DALL-E-2, DALL-E-3).

- Can use server environment powered by [Stability AI](https://platform.stability.ai/).

- Can use local environment powered by LocalDiffusion (Beta)

- Supports original Txt2Img, Img2Img modes

  - **Positive** and **negative** prompt support

  - Support dynamic **size** in range from 64 to 2048 px (for width and height)

  - Selection of different **sampling methods** (available samplers are loaded from server)

  - Unique **seed** input

  - Dynamic **sampling steps** in range from 1 to 150

  - Dynamic **CFG scale** in range from 1.0 to 30.0

  - **Restore faces** option

  - ( Img2Img ONLY ) : Image selection from device gallery _(requires user permission)_

  - ( Img2Img ONLY ) : Capture input image from camera _(requires user permission)_

  - ( Img2Img ONLY ) : Fetching random image for the input

  - ( Img2Img ONLY ) : Inpaint (for A1111)

    - Mask blur (1 to 64)

    - Mask mode (Masked, not masked)

    - Masked content (Fill, Original, Latent noise, Latent nothing)

    - Inpaint area (Whole picture, only masked)

    - Only masked padding (0 to 256 px)

  - Batch generation with maximum of 20 images (for A1111 and Horde)

  - Lora picker (for A1111)

  - Textual inversion picker (for A1111)

  - Hypernetworks picker (for A1111)

  - SD Model picker (for A1111)

- In-app Gallery, stored locally, contains all AI generated images

  - Displays generated images grid

  - Image detail view: Zoom, Pinch, Generation Info. 

  - Export all gallery to **.zip** file

  - Export single photo to **.zip** file

- Settings

  - WebUI server URL

  - Active SD Model selection

  - Server availability monitoring (http-ping method)

  - Enable/Disable auto-saving of generated images

  - Enable/Disable saving generated images to `Download/SDAI` android MediaStore folder

  - Clear gallery / app cache

## Setup instruction

### Option 1: Use your own Automatic1111 instance

This requires you to have the AUTOMATIC1111 WebUI that is running in server mode.

You can have it running either on your own hardware with modern GPU from Nvidia or AMD, or running it using Google Colab. 

1. Follow the setup instructions on [Stable-Diffusion-WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) repository.

2. Add the arguments `--api --listen` to the command line arguments of WebUI launch script.

3. After running the server, get the IP address, or URL of your WebUI server.

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.

If for some reason you have no ability to run your server instance, you can toggle the **Demo mode** switch 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.

### Option 2: Use AI Horde

[AI Horde](https://stablehorde.net/) is a crowdsourced distributed cluster of Image generation workers and text generation workers. 

AI Horde requires to use API KEY, this mobile app alows to use either default API KEY (which is "0000000000"), or type your own. You can sign up and get your own AI Horde API KEY [here](https://stablehorde.net/register).

### Option 3: Hugging Face Inference

[Hugging Face Inference API](https://huggingface.co/docs/api-inference/index) allows to test and evaluate, over 150,000 publicly accessible machine learning models, or your own private models, via simple HTTP requests, with fast inference hosted on Hugging Face shared infrastructure. This service is free, but is rate-limited.

Hugging Face Inference requires to use API KEY, which can be created in [Hugging Face account settings](https://huggingface.co/settings/tokens).

### Option 4: OpenAI

OpenAI provides a service for text to image generation using [DALLE-2](https://openai.com/dall-e-2) or [DALLE-3](https://openai.com/dall-e-3) models. This service is paid. 

OpenAI requires to use API KEY, which can be created in [OpenAI API Key settings](https://platform.openai.com/api-keys).

### Option 5: StabilityAI

[StabilityAI](https://platform.stability.ai/) is the image generation service provided by DreamStudio.

StabilityAI requires to use API KEY, which can be created in [API Keys page](https://platform.stability.ai/account/keys).

### Option 6: Local Diffusion (Beta)

Only **txt2img** mode is supported.

Allows to use phone resources to generate images.

## Supported languages

App uses the language provided by OS default settings.

User interface of the app is translated for languages listed in this table:

| Language | Since version | Status |

| --- | --- | --- |

| English | 0.1.0 | `Translated` |

| Ukrainian | 0.1.0 | `Translated` |

| Turkish | 0.4.1 | `Translated` |

| Russian | 0.5.5 | `Translated` |

| Chinese (Simplified) | 0.6.2 | `Translated` |

Any contributions to the translations are welcome.

## Difference between builds from Google Play and F-Droid/GitHub releases

As Google Play has some policies that app needs to be compliant with in order to be allowed to publish on Google Play there are some differences between builds distributed via Google Play and F-Droid/GitHub releases, listed in this table:

| Feature | Google Play build | F-Droid/GitHub build | Reason |

| --- |:---:|:---:| --- |

| Sideloading LocalDiffusion custom model | ❌ | ✅ | Google Play does not allow publishing apps with `android.permission.MANAGE_EXTERNAL_STORAGE` permission, which is required to read custom model files from external storage directly. |

## Donate

This software is open source, provided with no warranty, and you are welcome to use it for free. 

In case you find this software valuable, and you'd like to say thanks and show a little support, here is the button:

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/shifthackz)