💽Installation and Setup
Last updated
Last updated
Once you own Retro Diffusion, you can download the ".zip" file that contains extension files and some other information. This file will be labeled something along the lines of "RetroDiffusion#.#.#.zip." The numbers at the end represent which version it is (all available files are kept up to date with the latest versions).
This file is all you need to begin the installation-you do not need to download the models or other components manually.
If at any point you get confused in this guide, or otherwise need more information, you can view the help playlist.
To begin the installation, extract the "RetroDiffusion#.#.#.zip" file. Inside of it you will find a "README.txt" file and "RetroDiffusion.aseprite-extension."
Open Aseprite, and navigate to "Edit" then "Preferences":
Inside of the preferences menu, navigate to the "Extensions" tab, and click the "Add Extension" button:
Use the file selection window that opens to navigate to the "RetroDiffusion.aseprite-extension" file and select it. After the extension is installed in Aseprite, an introduction message will open with some information and prompt you to "Begin Setup":
Retro Diffusion is a very complex piece of software and requires more files and setup than Aseprite's native extension handler provides, so there are a few extra steps to get it working after installation.
Either click the "Begin Setup" button (shown in the above menu), or navigate to the "File" tab and click "Setup Retro Diffusion":
This will open the setup menu which contains different settings and options for file locations and other installation details:
Before we continue, Python and Git must be installed and running properly. To do this, simply click the buttons in the setup menu for "Download Python" and "Download Git." These links will lead to the specific versions required.
If you are on Linux, you may also need to install "gnome-terminal."
When you install Python, make sure to enable the "Add Python to environment variables" checkbox:
Once you have downloaded and installed Python and Git, click the "Check Requirements" button. If Python and Git have been installed properly, it will respond like this:
If not all requirements are found, try restarting your computer and checking again.
If issues persist, join the Discord server to get assistance.
Once all requirements have been found, if you need to specify install locations for the python virtual environment (6GB of space needed), you can switch to the "File Locations" tab in the setup menu:
Additionally, you can manually set the python and git executables if you have multiple versions installed. This is an advanced feature, so only use it if you understand what it means.
By default, the python virtual environment will be installed in Aseprite's extension folder, and the python and git executables in the system's internal path variable will be used. You must navigate fully into the folders for the locations to be saved correctly.
These settings are required for specific hardware conditions (use the system information discussed in the System Compatibility section to check the appropriate boxes).
After reviewing these settings, press the "Run Install Script" button.
A new window will open, featuring more options to review:
Here, you can select which file locations to install the Retro Diffusion models to. Remember, you must navigate fully into the folders for the locations to save correctly.
The "LLM Prompt Enhancement" tool is only usable on systems with more than 8GB of VRAM, but it can significantly improve generation quality and allows for some very complex prompts and setups.
Once you have selected the models you want to download, you can click the "Setup Environment" button.
A terminal window should open and begin installing the required libraries:
If a terminal window does not appear, you may need to disable anti-virus programs or run Aseprite as administrator.
If the terminal says "System cannot find the specified path," please check if you are using Aseprite portable and have Microsoft OneDrive enabled. If this is the case, move the entire Aseprite portable install to a location on your physical storage device (not on OneDrive) and try setup again.
The installation may take a long time, and it is important to read the messages in the terminal window.
If a download is interrupted, you may need to interact with the console to re-try the download.
If you encounter any red text, or text that looks out of place, please refer to the "Common Installation Errors" section, or contact a developer in the Retro Diffusion Discord server.
Upon completion, the terminal will send this message:
Now, you can return to Aseprite and begin generating images! All scripts are found under the "Help" menu in Aseprite and in various other locations throughout the program (such as the "Sprite" menu).
Some scripts require the use of an active sprite, so if a script is grey, try opening a sprite.
More information on the scripts and what they do can be found here.
