Installation and setup
The easiest way to install this plugin is to head to the releases page and download the correct version of the plugin for the version of Unreal that you are using.
Two types of plugin releases are provided and for both options make sure to install/extract the plugin to your YourProject/Plugins folder. If the YourProject/Plugins folder is missing then you can create one and extract the plugin there. The two release types are as follows:
-
RECOMMENDED - A self extracting 7zip installer that contains all of the required Python dependencies and binaries for your editor version. Look for releases with the word
fullin the filename. - A zip file that does not come with dependencies (installable through the editor) but comes with binaries. Has the words
pluginOnlyin the filename.
You can also clone this repository into your YourProject/Plugins folder but this option requires Visual Studio to be installed with the C++ desktop development workload to be installed.
Open your project in Unreal and got to Edit->Plugins and make sure that the StableDiffusionTools plugin is enabled.
NOTE: If you installed a version of the plugin with the word full in the filename you can skip this section.
Open the dependencies window from Windows->Diffusion Tools Dependencies, I recommend dragging/docking the window on the side of the screen after opening it. Check Clean install and click on the Update all dependencies button. The editor will prompt you to restart and after it opens, the dependencies installer window will track your installation process. After it completes you will be prompted to restart the editor again.
Before you can use the plugin you need to pick a bridge backend to use. The bridge allows the plugin to communicate with different backends that can generate diffusion images that will be returned to Unreal. Open Editor->ProjectSettings->Stable Diffusion Tools to pick a bridge backend.
The recommended bridge to choose is DiffusersBridge which will locally render a Stable Diffusion image on your computer using your GPU.
Most bridges require a token in order to communicate with web services. Once your bridge is selected, click on the Open token website button to open a webpage that will let you register an account to obtain a token. For example, the Diffusers bridge needs a token obtained from huggingface.co so that the plugin can download any required base models it needs.
Once you've obtained a token, paste it into the Generator Tokens map next to the bridge you want to register the token to.