This software is meant to be a productive contribution to the rapidly growing AI-generated media industry. It will help artists with tasks such as animating a custom character or using the character as a model for clothing etc.

The developers of this software are aware of its possible unethical applicaitons and are committed to take preventative measures against them. We will continue to develop this project in the positive direction while adhering to law and ethics.

Users of this software are expected to use this software responsibly while abiding the local law. If face of a real person is being used, users are suggested to get consent from the concerned person and clearly mention that it is a deepfake when posting content online. Developers and Contributors of this software are not responsible for actions of end-users.

Installation

To install the extension, follow these steps:

(For Windows Users) Install Visual Studio 2022 (Community version, for example - you need this step to build some of dependencies): https://visualstudio.microsoft.com/downloads/ OR only VS C++ Build Tools (if you don't need the whole Visual Studio) and select "Desktop Development with C++" under "Workloads -> Desktop & Mobile": https://visualstudio.microsoft.com/visual-cpp-build-tools/
In web-ui, go to the "Extensions" tab and use this URL https://github.com/Gourieff/sd-webui-roop-nsfw in the "Install from URL" tab.
Go to the "Installed" tab and click "Restart the UI"

Usage

Under "Roop-GE" drop-down menu, import an image containing a face;
Turn on the "Enable" checkbox;
That's it, now the generated result will have the face you selected.

You can use Roop-GE with Webui API:

Check the SD Web API Wiki for how to use API;
Call requests.get(url=f'{address}/sdapi/v1/script-info') to find the args that Roop-GE needs;
Define Roop-GE script args and add like this "alwayson_scripts": {"roop-ge":{"args":args}} in the payload;
Call the API, there's an full usage example in example folder.

The result face is blurry

Use the "Restore Face" option. You can also try the "Upscaler" option or for more finer control, use an upscaler from the "Extras" tab. You can also set the postproduction order (from 0.1.0 version):

The old logic was the opposite (Upscale -> then Restore), resulting in worse face quality (and big texture differences) after upscaling.

There are multiple faces in result

Select the face numbers you wish to swap using the "Comma separated face number(s)" option for swap-source and result images. You can use different index order.

The result is totally black

~~This means roop detected that your image is NSFW.~~

Img2Img

You can choose to activate the swap on the source image or on the generated image, or on both using the checkboxes. Activating on source image allows you to start from a given base and apply the diffusion process to it.

Inpainting should work but only the masked part will be swapped.

Troubleshooting

I. "You should at least have one model in models directory"

Please, check the path where "inswapper_128.onnx" model is stored. It must be inside the folder stable-diffusion-webui\models\roop. Move the model there if it's stored in a different directory.

II. Any problems with installing Insightface or other dependencies

(for Windows Users) If you have VS C++ Build Tools or MS VS 2022 installed but still have a problem, then try the next step:

Close your sd-webui and start it again (for Any OS Users) If the problem still there, then do the following:
Go to stable-diffusion-webui\venv\Lib\site-packages folder (or it can be stable-diffusion-webui/venv/lib/python3.10/site-packages)
If you see any folders the with names start from ~ (ex. "~rotobuf") - delete them
Go to stable-diffusion-webui\venv\Scripts or stable-diffusion-webui/venv/bin
Run Terminal or Console (cmd) for that folder and type activate
Update your pip at first: pip install -U pip
Then one-by-one:
- pip install insightface==0.7.3
- pip install onnxruntime==1.15.0
- pip install opencv-python==4.7.0.72
- pip install diffusers==0.17.1
- pip install tqdm
Type deacticate, you can close your Terminal or Console and start your sd-webui, Roop should start OK - if not, welcome to Issues section.

III. "TypeError: UpscaleOptions.init() got an unexpected keyword argument 'do_restore_first'"

The solution is here: https://github.com/Gourieff/sd-webui-roop-nsfw/issues/3

Updating

A good and quick way to check for Extensions updates: https://github.com/Gourieff/sd-webui-extensions-updater