3. Installing a mod - robot9706/FSSE GitHub Wiki

Installing a mod

There are two ways of installing a mod. It can be done either by using the FSModTool (this is intended for modders) or the FSModInstaller (this is intended for players). With FSModTool installation can be automatized to make mod development easier.

Installing using FSModTool

To install a mod goto the "Patcher" tab in FSModTool. And select the following paths and folders:

  • Patched assembly: The assembly prepared in the "Prepare DLL" tab. Done in step 1 of the guide.
  • FSLoader.dll: Path to the "FSLoader.dll".
  • Reference folder: Path to the folder which contains the dependencies of the patched "Assembly-CSharp.dll", this is basically the "Managed" folder.
  • Output: The patched dll, with the hooks prepared. This is the new "Assembly-CSharp.dll". This can directly point to the ".../Managed/Assembly-CSharp.dll".
  • Patch files: This list contains the mod dll files which hooks need to be prepared. Add your mod DLL here. The DLL can be found in: "..project location../bin/Debug/".

After all the paths and files are ready, hit "Patch". After the patching is done the new assembly is ready to be used. Overwrite the old "Assembly-CSharp.dll" in the game files with the new patched one. Also copy the "FSLoader.dll" to the "Managed" folder too.

Mods will be loaded from ".../FalloutShelter_Data/Mods", so anytime you make changes to your mod dll make sure to copy it to the "Mods" folder. Copy your mod dll into this folder so FSLoader will be able to load it.

Once a mod is hooked every mod will be able to use it through FSLoader, so the patching step is only required if new methods need to be hooked. Otherwise only the mod dll requires overwriting.

After all the patching and file copying is done start FalloutShelter and goto the credits screen, if everything is correct the credits should start with "Modded Fallout Shelter", otherwise FSLoader is not patched into the assembly correctly.

Next step: Enabling the new mod

Useful links
FSModTool guide
FSLoader API
Mod pack source code