Dependencies
To get started with modding Satisfactory, you’ll need multiple other pieces of software installed first.
Don’t worry, we’ll guide you through each step of downloading and installing these dependencies.
This can be a very lengthy process, so if you have to work on something else, make a note of where you left off so it’s easier to resume.
Beware that the modding environment can take up a lot of space once everything is installed and built - 30+ GB is possible. Keep this in mind when deciding where put all your files - don’t keep them on a drive with very little space left.
|
If you’d prefer a different format of guide, you can find a video guide here. As of SML 3.0.0, these tutorials are out of date, but some of the concepts will still carry over. If you get stuck in the video tutorials, return here and follow these guides instead. Be sure to read over the steps here as well to be sure you’re doing things correctly. |
Satisfactory
This one should be pretty straightforward, and odds are, you’ve already done it. Simply buy, download, and install Satisfactory from the Epic Games Launcher or Steam. Launch the game at least once to ensure all files get set up correctly.
Visual Studio
Visit the Microsoft Visual Studio downloads page and download the version you want. We suggest either Visual Studio 2019 or 2017 Community, because they’re free of charge. It is important that if you use 2019 you still install the 2017 compilers.
Run the installer, and agree to prompts you receive along the way. From the "Workloads" page select the "Desktop & Mobile > Desktop development with C++" and "Gaming > Game development with C++". You might have to scroll a bit to find them.
If you already have Visual Studio installed, you can run the installer again and choose Modify to select these two workloads and add them to your installation.
Continue through the rest of the prompts to install Visual Studio. Downloading and installing Visual Studio can take a while, so we advise you to find some lizard doggos to pet while you wait, or working on some of the other install steps below.
|
An alternative to Visual Studio which is very popular among C++ modders is Rider for Unreal Engine. If you consider using it, make sure you still have the necessary VS-C++ packages installed. |
Unreal Engine 4 (Custom Engine)
Because Satisfactory uses a modified version of Unreal Engine, we modders need to be using that same version as well to develop our mods.
You’ll need to register your GitHub account with Epic Games and join the Epic Games GitHub organization to be able to download this special version. Directions on how to do so can be found here.
If the page says, "Sorry, the service is temporarily unavailable. Please try back later." try turning off any adblockers or content filters you may have enabled and refreshing the page without cache (Ctrl+Shift+R).
You will probably have to check your email and confirm from there, as well as making sure you’re logged into your linked GitHub account when you follow the upcoming link.
Once you’ve done that, go to the Satisfactory Modding Unreal Engine project and download UnrealEngine-CSS-Editor-Win64.exe, then run it to install the Unreal Engine editor for this custom version.
|
If you see a "404 This is not the web page you are looking for" error, then you didn’t finish linking your account. The page is not dead, this is what GitHub displays as a security measure when someone tries to access a private repo and is not part of the correct organization. Check for emails from both Epic and GitHub, and be sure that you followed the above steps. You can verify that you’ve correctly joined the GitHub organization by checking for "EpicGames" on the [GitHub Account Organizations page](https://github.com/settings/organizations). If your GitHub account is already listed as linked on the Epic Games page you can unlink and relink it re-send the GitHub organization invitation. |
This install process, and opening Unreal for the first time afterwards, can take some time. Don’t worry about opening Unreal yet though. It will probably ask you to compile things you haven’t properly set up yet.
Once the installer is done, you’ll also need to install a Visual Studio extension shipped with the Editor. Navigate to where you installed the Editor, probably something like C:\Program Files\Unreal Engine - CSS\, and then navigate to the folder \Engine\Extras\UnrealVS\. Open the sub folder for the version of Visual Studio you have installed (probably 2019) and run the .vsix installer to install the Unreal Visual Studio extension, which will help with debugging.
Wwise
Wwise is a sound engine used by Coffee Stain, and in order to develop mods, you’ll need to install and integrate Wwise with your mod project.
Visit Wwise.com and click on the
Get Wwise → Download Wwise button in the upper right corner.
Click the download button, which will ask you to sign in.
Create an account if you don’t have one yet, or sign in, to download the launcher.
After you finished downloading Wwise, open the installer.
Select WWISE from the top bar. Click the Latest drop-down and change it to All. Select 2021.1 from the next dropdown. Select version 2021.1.0.7575 from the final dropdown. Click Install.
Once presented with options on what to install, select:
-
Packages
-
Authoring
-
SDK (C++)
-
-
Deployment Platforms
-
Apple
-
macOS
-
-
Microsoft
-
Windows
-
Visual Studio 2017
-
Visual Studio 2019
-
-
-
Click Next. You don’t need to add any plugins so just press Install to skip in the bottom left to begin the installation process. Accept the terms and conditions prompts that appear along the way.
|
If you are getting a checksum error during Wwise integration, installing any other Wwise version should fix the problem. |
Starter Project
To get started developing your mod, start off with the Starter Project as a base. You can find it on the Satisfactory Modding GitHub, or download it directly via this link.
The Starter Project itself is contained in FactoryGame.uproject,
and this download contains the relevant SML-related plugins already loaded.
Don’t do anything with the downloaded zip file yet - this will be covered on the next page, Project Setup.
If you are familiar with version control software, we suggest you
clone the repo instead,
which simplifies the process of updating your project later.
Check on the discord to find out which branch to clone,
although it’s most likely master.
|
DEPENDING ON THE UNREAL VERSION YOU DOWNLOADED, THERE ARE DIFFERENT STARTER PROJECTS
|
Satisfactory Mod Manager
Satisfactory Mod Manager
offers a convenient developer mode that
automatically installs the correct version of SML and helps manage mod files for you.
To enable it, change your selected profile to development.
If you’re using Satisfactory Mod Manager,
you can skip the below steps and move on to the next page of the tutorial.
If you’re not using the mod manager, you’ll need to follow the manual install directions to get the relevant files set up.
Alternatively, once your modding environment is set up, you can use Alpakit to automatically build and install SML.
Now that all the dependencies are installed, you can move onto setting up the project.