Uploading your Mod to Satisfactory Mod Repository (ficsit.app)
Once you’ve made your amazing mod, the Satisfactory Mod Repository is the best place to upload it if you want others to find and use your mod. Mods uploaded to SMR will automatically work with the Mod Manager. All mods available to SMR are checked for potential security concerns, so having your mod on SMR means users can trust that it is safe and secure.
The process of uploading your mod is fairly straightforward.
Create an Account on SMR
If you haven’t already created an account, you can do so by clicking 'Sign In' in the top right corner of the SMR homepage, then selecting to sign in with an existing GitHub, Google, or Facebook account.
You can change your profile photo and display name on your Settings screen, which can be accessed from your user icon in the top right corner.
Creating your Mod Page
Before you can upload a version of your mod for users to download, you’ll first have to create a mod page.
On the 'Mods' sidebar tab of SMR, click New Mod in the top left corner to get started.
Information About your Mod
Next, add some information about your mod.
-
The 'name' is the title that will appear in the mod list and browser.
-
The 'short description' is the summary text that will show up below the mod icon.
-
The 'full description' supports Markdown formatting (help on the SMR help page) and is shown when the user clicks to view your mod from the all mods list. Consider including the following information in here:
-
A summary of what your mod adds to the game
-
Screenshots or videos of your mod in action
-
How to get started with your mod (unlock via hub milestone? features turned on by default?)
-
A means of contacting you (preferably your Discord user tag, so staff and users can identify you on the modding Discord)
-
A means of reporting bugs, such as a GitHub issues page or contact info
-
Crediting people who helped you along the way (ex. icon attribution, coding help)
-
If you’re not sure what to write yet, don’t worry, you can come back and edit these fields later.
Your Mod Reference
One of the most important fields on this screen is the 'Mod Reference' field. Explained in more detail on the Mod Reference section of the Getting Started guide, your mod reference is your mod’s unique name. As a reminder, your mod’s plugin folder and C++ source folder (if using C++) must have the same name as your mod reference. Your mod reference cannot contain special characters or spaces.
|
You can’t change your mod reference after you have added your mod to SMR! So make sure it is correct! At least five times! And read up on the Mod Reference section again to make sure you understand what other parts of your mod need to use this same value. |
Icon and Source Link
Next, you can upload an image to use as the display image for your mod. Alternatively, you can leave this blank, and it will default to the Satisfactory Modding gear logo.
You can also provide a link to your source code, if it is hosted on a site like GitHub or similar. We strongly encourage you to release your source code, as it allows others to learn from your work and helps other developers debug mod compatibility.
You can edit both of these fields later.
Hidden Mods
You also have the option to mark your mod as Hidden upon creation. You can go back and edit this later.
If your mod is Hidden, it will not appear in the main mods list, nor when browsing in SMM, nor when searching the site. However, other users can still find it by looking at your profile page, and you can send people the link directly.
In addition, updates to Hidden mods will not cause messages to be sent in the #mod-updates channel of the modding Discord.
Submit your Mod Page
Once you click Submit, a page for your mod will be created.
Note that the page for your mod contains your mod’s mod reference as part of the URL.
For example, the page for a mod with reference AreaActions would be https://ficsit.app/mod/AreaActions.
You still need to upload a version for your mod to be usable by players. Until then, your mod will be marked as 'Outdated' since there are no compatible versions. This version submission process will be covered in the following sections.
Your Mod’s UPlugin File
<!-- TODO - we should really have a separate page for this in the future -→
Before you can upload a version, there are a few fields you need to edit in your mod’s uplugin file.
Every Unreal Engine plugin is require to have a
<mod reference>.uplugin file,
and Satisfactory mods are no exception.
This file is json formatted and holds information about the mod,
such as its version number, dependencies, credits, links, and more.
The file will be automatically generated for you by the editor, but you’ll have to modify couple fields yourself.
You can read about all the different Unreal settings available at the Plugins documentation here or at the C++ reference here.
After editing these fields, be sure to re-Alpak your mod so the files you upload will have your changes.
Default Fields
The following fields are part of Unreal’s normal uplugin format, but are given additional functionality by the modding toolkit.
| Parameter | Description of Function |
|---|---|
Version |
This integer should match the first digit of your |
VersionName |
This string should exactly match your |
FriendlyName |
This string is the name of your mod as it will appear in the in-game loaded mods list and configs screen. |
Description |
This string will appear when someone looks at your mod in the in-game loaded mods list and configs screen. |
CreatedBy |
This string will appear when someone looks at your mod in the in-game loaded mods list and configs screen. |
Special Fields
Note that SML and SMR require you to include additional fields in your plugin descriptor file.
The most important of these is a mod dependency list and a SemVersion for the mod.
|
Make sure that you have SML listed as an item in the Plugins field, as explained below. |
Below is a description of all extra fields SML and SMR require:
| Parameter | Description of Function | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SemVersion |
Version number for the mod. Should always increase with new releases,
and should follow the semver format, ex. |
||||||||||||
Plugins |
Additional functionality has been added to the regular uplugin Plugins array.
You can list other mod references (or Unreal Plugins) here,
and SMM will know to download when installing your mod.
If you add a plugin with a Mod Reference,
this basically makes the listed mod a dependency for your mod.
|
||||||||||||
RemoteVersionRange |
A Semver range of versions accepted from the remote clients.
This requires other players to have a certain version of the
mod installed to be able to join hosts.
See the Plugins SemVersion item above for the format for this field.
|
||||||||||||
AcceptsAnyRemoteVersion |
When |
Important C++ Fields
If your mod has C++ code, make sure that you list a UBT Module in the Modules plugin descriptor section. The examples below will demonstrate this.
Examples
|
You can check if your mod’s uplugin file is in the correct format with the validator on the SMR help page). If it fails validation, keep your eyes out for things like missing commas and mismatched braces and brackets. Consider asking on the Discord if you get stuck on this step. |
Some example `.uplugin`s are presented here:
Example Blueprint mod .uplugin:
{
"FileVersion": 3,
"Version": 6,
"VersionName": "6.2.1",
"SemVersion": "6.2.1",
"FriendlyName": "Example Mod",
"Description": "This is a random Blueprint mod.",
"Category": "Modding",
"CreatedBy": "Satisfactory Modding Team",
"CreatedByURL": "https://ficsit.app/",
"DocsURL": "https://docs.ficsit.app/",
"MarketplaceURL": "",
"SupportURL": "",
"CanContainContent": true,
"IsBetaVersion": false,
"IsExperimentalVersion": false,
"Installed": false,
"RemoteVersionRange": "^0.2.1",
"AcceptsAnyRemoteVersion": false,
"Plugins": [
{
"Name": "SML",
"SemVersion": "^3.3.0",
"bIsOptional": false,
"Enabled": true
},
{
"Name": "DependencyMod",
"SemVersion": "^1.3.0",
"bIsOptional": false,
"Enabled": true
}
]
}
Example C++/Blueprint mod .uplugin:
{
"FileVersion": 3,
"Version": 6,
"VersionName": "6.2.1",
"SemVersion": "6.2.1",
"FriendlyName": "Example Mod",
"Description": "This is a random example C++ and Blueprint mod.",
"Category": "Modding",
"CreatedBy": "Satisfactory Modding Team",
"CreatedByURL": "https://ficsit.app/",
"DocsURL": "https://docs.ficsit.app/",
"MarketplaceURL": "",
"SupportURL": "",
"CanContainContent": true,
"IsBetaVersion": false,
"IsExperimentalVersion": false,
"Installed": false,
"RemoteVersionRange": "^0.2.1",
"AcceptsAnyRemoteVersion": false,
"Modules": [
{
"Name": "ExampleMod",
"Type": "Runtime",
"LoadingPhase": "PostDefault"
}
],
"Plugins": [
{
"Name": "SML",
"SemVersion": "^3.3.0",
"bIsOptional": false,
"Enabled": true
},
{
"Name": "DependencyMod",
"SemVersion": "^1.3.0",
"bIsOptional": false,
"Enabled": true
}
]
}
SMR UPlugin Validator
If you’d like to check the format for your uplugin file, SMR offers a validator on its help page. You can paste in your uplugin file into the box on the right and it will display any error messages below the box.
The validator isn’t perfect, but it can help troubleshoot many errors that could occur during upload.
Uploading a Version
Once you have finished formatting your .uplugin,
make sure you have re-packaged your mod to include the changes with Alpakit.
Navigate to the mod page for your mod, then select 'New Version' in the top right corner. This will take you to a page where you can upload a version file, as well as provide some additional info about the version.
Put "Alpha", "Beta", "Release", etc. in the stability field so that users know how far along in development you consider this version of your mod to be.
Alpakit will generate a ready to upload zip-archive for you, located at
<project folder>/Saved/ArchivedPlugins/WindowsNoEditor/<mod reference>.zip.
Select this zip with the picker the File field.
Finally, write up a list of all of the things you changed or added in this version for the Changelog field.
We also strongly suggest you copy this information into an 'update history' section of your mod’s description on the main mod page.
|
If you decided to mark your mod as Hidden earlier, remember to make it visible again before uploading your first version! Otherwise, no notification will be sent on the Discord about your mod’s release, and nobody will be able (easily) to find your mod on the site. |
You should be all set now - once you press Create, the upload process will begin,
and your mod will be ready for use once it completes.
If any errors occur during the upload, they will be displayed on this screen. The uplugin validator may be of use. Consider asking for help on the Discord if you’re not sure how to resolve them.
Awaiting Approval
If you’ve uploaded a blueprint only mod, you’re all set, and your mod is ready for download and use! Regardless, we still suggest you read the below.
If you’ve uploaded a C++ mod, you’ll have to wait for it to be approved by the automated approval process before users can download it. The approval process is generally quite quick, about 1 to 3 minutes, and exists to make sure that users aren’t uploading content that violates SMR’s terms and conditions or harms players' computers.
In the meantime, we strongly suggest you take a look at your mod description and consider adding additional information to it. More on that below.
Refine your Mod Page
The mod description is what most players will see when deciding whether or not they want to use your mod, so keep it organized, and try to leave a good first impression! One could say that you should try to make viewing your mod page a 'Satisfactory' experience, so to speak.
We suggest taking the following steps to encourage users to try out your mod:
-
Check your grammar and spelling! Consider asking someone else to proofread your description. It’s an easy thing to do, and having correct grammar makes you appear more professional.
-
Pictures! Take some screenshots of what your mod can do, and what its buildings or features look like in game. Again, the long description supports Markdown formatting, which you can get help with using on the help page.
-
List where you can be reached for help, issue reporting, leaving suggestions, etc. Where do you want users to report issues to you with the mod? Via Discord, your mod’s Github page, or somewhere else? Consider putting your Discord tag in your mod description so people can contact you on the community Discord, and consider changing your nickname on the server to include your mod name.
-
Explain concepts or features of your mod that may be unclear to the user. Unless you write documentation or a guide for how to use your mod, players might have some trouble figuring out how to use all of the amazing new content in your mod.
-
List the features of your mod, and how to unlock them for use in-game. Consider listing what tiers the content is unlocked at.
-
Credit other users that contributed ideas, models, etc. by name and/or by link.