¶ Before installing your mods
Currently, The Hub is the main source for finding and downloading mods for SPT. The Forge the Work in Progress upgrade to the Hub. Only mods downloaded from those website are provided support for.
It is highly recommended that you download and install 7-Zip. Other archiving programs, such as WinRAR or Windows itself, are known to corrupt files upon extracting without telling you.
Notepad++ is another useful tool to have installed. It simplifies editing config files, and will let you know if there’s any formatting issues with the edits you made.
Make sure that you have already loaded SPT up to the main menu before installing mods.
When selecting the mods you want to install, make sure that you only install mods that have been made for the current SPT version. Mods for older SPT versions will not work, and will break things. If you are unsure what version of SPT you are on, you can see the SPT version in the top left of the server window or in the bottom left while in-game.
Read the mod pages of the mods you want to install. They include information on how to install, configure and incompatibilities with other mods.
Close everything SPT related when installing or removing mods. Your server needs to be closed when configuring server mods.
¶ Installing mods
- Open the mod archive using 7zip.
- If the mod archive has a
BepInExoruseror both folders, drag and drop the contents of the archive to the empty space in your SPT folder. - If the mod archive has just a folder or files, read the mod page for install instructions:
- For mods that go into your
userfolder, drag and drop the mod folder intouser\mods. - For mods that go into your
BepInExorplugins, drag and drop the mod folders and files intoBepInEx\pluginsfolder.
¶ Profiles
Nearly all mods can be added to an existing profile. However, removing some mods might be impossible without making a new profile. Mods that add new traders, quests, or items fall under that category. Always read the modpage, as the author should specify if a mod is unsafe to remove from a profile.
If you removed a mod that broke your profile, you can attempt to fix it by changing removeModItemsFromProfile and removeInvalidTradersFromProfile to true inside SPT_Data\Server\configs\core.json. This is not guaranteed to work. SPT will do the best it can to remove any item that’s in your profile from the removed mod, but some mods make irreversable changes to your profile.
¶ Load order
You do not need to edit your load order manually unless a mod specifies you to do so. By default, with an empty order.json SPT loads mods alphabetically from A to Z. Mods expect to be loaded in that order.
Mods that load first get overridden by those loaded later. However, they will only override the values they both alter, not the entire mod.
If you need to edit it, you should use a tool like Load Order Editor or Load Order Editor Drag-Drop. Your edited load order should still be A to Z, with only few mods moved.
To create a new, empty load order, delete your user\mods\order.json. SPT will create a new one the next time you run it.
Note: Mods like SVM can override/break any mod loaded before it, so it’s recommended to load it first.
¶ Uninstalling mods
- Close your game, launcher and server.
- Read the mod page of the mod you’re uninstalling. Some, like Realism, Raid Overhaul or SVM, have extra steps you’ll need to do beforehand.
- Generally, to uninstall a mod, move or delete its files from
user\mods,BepInEx\pluginsand/orBepInEx\patchers.
- The easiest way to see what files a mod has is to look inside its archive you downloaded.
- Do not remove your
BepInEx\plugins\sptfolder andBepInEx\patchers\spt-prepatch.dllfile.
¶ Updating mods
Most mods can be updated by simply reinstalling their files, overriding any files when prompted.
However, some mods move, delete or rename files between versions. While the mod authors should make a note of it, sometimes it’s missed.
If you are experiencing issues after updating a mod, or a mod has a large number of individual files, you should delete and reinstall it.