Setup

Make sure you have dependencies installed and a copy of the manager.

• Grab a personal API key from Nexus
• Install dependencies, if you don't have them already. You'll need to sudo apt install them
  • 7z for installing 7zip files
  • libarchive-tools for installing rar files
• Download smm.desktop and starfield-mod-manger.jar from github or the nexus. Place the jar in a folder where you want to run it from.

This section lets you more easily run the manager, and use the "Download with Vortex" buttons on Nexus.

• Place smm.desktop in ~/.local/share/applications/
• Edit the Exec line so it points to your jar install location.
  • Should look something like: Exec=sh -c "java -jar /home/<user>/games/programs/starfield-mod-manager/starfield-mod-manager.jar %U"
• Edit the Path line so it points at the folder of your jar
  • Should look something like: Path=/home/<user>/games/programs/starfield-mod-manager/
• Update ~/.local/share/applications/mimeapps.list by adding a line x-scheme-handler/nxm=smm.desktop
• Make the desktop shortcut the default handler by running: xdg-mime default smm.desktop x-scheme-handler/nxm
• Optional: If you want to run from an existing terminal, add something like alias smm='pushd /home/<user>/games/programs/starfield-mod-manager && java -jar starfield-mod-manager.jar; popd' to your bash aliases. This is how I run the manager in the demos on the site

Before you can download and deploy mods, you need to configure the app. This config will be saved in config.json in the folder the jar is in. (Mod data will be stored in another file in that folder).

• Start the app using one of the methods from the Shortcuts section above
• config api-key <key> using the api key you got from the prerequisites step
• config game-path <path> to point to your game folder
  • Should look something like: <...>/SteamLibrary/steamapps/common/Starfield/
  • This is used as the target to deploy mods to and for launching the game
• config appdata-path <path> to point to your local appdata folder
  • Should look something like: <...>/SteamLibrary/steamapps/compatdata/1716740/pfx/drive_c/users/steamuser/AppData/Local/Starfield/
  • This is used to deploy the Plugins.txt in order to enable ESMs etc

• Uninstall any manually added mod files, or consider doing a clean install of the game
• Using the app, install and enable SFSE
• For convenient launching of SFSE, both from steam and from the mod manager add: bash -c 'exec "${@/Starfield.exe/sfse_loader.exe}"' -- %command% to your launch options (in steam > game properties > general)
• Using the app, install and enable BAKA Disable My Games Folder
• For mods with plugin files, you'll also want to install and enable Plugins.txt Enabler
• Make sure to enable mods in your StarfieldCustom.ini (that lives at your ini path). There are many tutorials you can google, but the important part is to create the file if it doesn't exist and add these three lines:

  [Archive] bInvalidateOlderFiles=1 sResourceDataDirsFinal=

• All features should now work, and mods will be deployed to the game folder

If you're unable to install SFSE, you can deploy to the docs folder directly, but please note that this is not recommended as it's more error prone and can cause issues

• config ini-path <path> to point to your ini (my docs) folder
  • Should look something like: <...>/SteamLibrary/steamapps/compatdata/1716740/pfx/drive_c/users/steamuser/Documents/My Games/Starfield
• In the app run config use-my-docs true
• You can always revert the setting later (set it to false) once you have SFSE installed

FOMODs are made to be installed with a gui. Because they rely on images and require the parsing of a non-trivial XML structure, it's not worth the time to support through the terminal.

Instead, FOMODS are called out when you try to enable them, or run the validate command. Installing them, even without a gui, is still simple to do.

• When trying to enable a FOMOD, the manager will warn you and give you the index of the mod
• Open the mod locally by running local x, with x being the index of the mod.
• In the file explorer, look at any pictures under the fomod folder, and pick the files you want from the various folders. Consolidate your choices and delete the other folders and files
• Once you have properly structured files (starting with the Data folder), and you've deleted the fomod folder, the manager will be able to enable and deploy the mod

Run the app and then use help to see commands. Alternatively you can look at the generated man page. You can also look through examples.

To reduce typing, most commands take the index of the mod, instead of mod id or name. This means the index of a mod can change as mods are added, deleted or sorted. Listing mods will always show their indices, and filtering will retain the index.

Please report any issues with the manager or this site to their respective github issues page.