Testing Your Mods

param (
	[Parameter(HelpMessage="Launcher to use (steam, epic). Level 1 of the script's GameDirs config option.")]
		[string]$launcher = "steam",
	[Parameter(HelpMessage="Side to use (client, server). Level 2 of the script's GameDirs config option.")]
		[string]$side = "client",
	[Parameter(HelpMessage="Branch to use (stable, experimental). Level 3 of the script's GameDirs config option. Not supported by Steam launcher.")]
		[string]$branch = "stable",
	[Parameter(HelpMessage="When present, launches 2 copies of the game instead of 1. Most other arguments only apply to the first copy, read the script implementation for specifics.")]
		[switch]$multiplayer = $false,
	[Parameter(HelpMessage="When using the -multiplayer flag, how long to wait before launching the second copy in milliseconds.")]
		[int]$multiplayerLaunchDelayMs = 5000,
	[Parameter(HelpMessage="When present, the game will automatically load into the last save file you played. If used with the -multiplayer flag, the save must be in the `common` subfolder of the SaveGames directory.")]
		[switch]$loadLatestSave = $false,
	[Parameter(HelpMessage="When present, the second copy of the game will automatically run the `open 127.0.0.1` console command to connect to the first copy. Must be used with -loadLatestSave flag.")]
		[switch]$clientAutoJoin = $false,
	[Parameter(HelpMessage="Launch the game with the -WaitForDebugger flag, telling SML to hold the game's loading process to allow attaching a C++ debugger.")]
		[switch]$waitForDebugger = $false,
	[Parameter(HelpMessage="Launch the game with the -NoExceptionHandler flag, enabling JIT debugging and disabling the UE crash reporter.")]
		[switch]$noExceptionHandler = $false,
	[Parameter(HelpMessage="When present, print info about what copy of the game is being launched.")]
		[switch]$info = $false,
	[Parameter(HelpMessage="When present, the game will not actually be launched, allowing testing this script. Required files still may be created based on other parameters.")]
		[switch]$test = $false
)

# ========================================================================================================================
# Configure this section to match your system and preferences
# ========================================================================================================================

# Arguments to launch the game with
$CommonArgs = "-EpicPortal", "-log", "-NewConsole", "-nosplash"

# Edit the below "path"s to contain your game paths for these possible install locations
$GameDirs = @{
	steam = @{
		# Note: Steam only allows installing either client or server at a time
		# The script doesn't know which branch you have selected in Steam's own UI
		client = @{
			steam = @{
				# Example: "C:\Steam\steamapps\common\Satisfactory"
				path = "UNSET"
				exeName = "FactoryGameSteam"
				appid = "526870"
				# Example: value 12345678910111213 from path `%LOCALAPPDATA%\FactoryGame\Saved\SaveGames\12345678910111213`
				savegameSubfolderName = "UNSET"
			}
		}
		server = @{
			steam = @{
				# Example: "C:\Steam\steamapps\common\SatisfactoryDedicatedServer"
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
		}
	}
	epic = @{
		client = @{
			stable = @{
				path = "UNSET"
				exeName = "FactoryGameEGS"
				# Example: value 1234letters0and0numbers0longer12 from path `%LOCALAPPDATA%\FactoryGame\Saved\SaveGames\1234letters0and0numbers0longer12`
				savegameSubfolderName = "UNSET"
			}
			experimental = @{
				path = "UNSET"
				exeName = "FactoryGameEGS"
				savegameSubfolderName = "UNSET"
			}
		}
		server = @{
			stable = @{
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
			experimental = @{
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
		}
	}
	# Optionally define additional -launcher options here. Hierarchy is -launcher > -side > -branch
}

# Optionally configure the window size and position on the screen (2 sets for 2 copies when using -multiplayer)
$Game1 = "$CommonArgs" #, "-windowed", "-WinX=0", "-WinY=32", "ResX=960", "ResY=1040"
$Game2 = "$CommonArgs" #, "-windowed", "-WinX=960", "-WinY=32", "ResX=960", "ResY=1040"

# Location of your savegame root folder for usage with -loadLatestSave
# The default should be fine but you can change it if desired
# It gets combined with the savegameSubfolderName in the GameDirs data to make the full path
$SaveFolder = "$($env:LOCALAPPDATA)\FactoryGame\Saved\SaveGames\"


# Put custom overrides here if you want (for example, if you want to specify values for $GameDirs in one place)
# Example
# $GameDirs["steam"]["client"]["steam"]["path"] = "C:\Steam\steamapps\common\Satisfactory"

# ========================================================================================================================
# End configuration section
# ========================================================================================================================

$AutolaunchTempFileName = "AutolaunchScript_Temp.ini"

function CreateSteamAppidFile([string]$filepath, [string]$appid) {
	# Required to launch steam copies
	$SteamAppidFilePath = "$filepath\Engine\Binaries\Win64\steam_appid.txt"
	try {
		# cast to void suppresses output
		[void](New-Item $SteamAppidFilePath -ItemType File -Force)
		Add-Content $SteamAppidFilePath $appid
	} catch {
		Write-Error "Failed to create/modify steam appid file ($SteamAppidFilePath), try running script as admin"
		Write-Error $_
		exit 1
	}
}

function ResolveGamePathFromParams() {
	$selectedLauncher = $GameDirs[$launcher]
	if ($selectedLauncher -eq $null) {
		Write-Error "Requested launcher '$launcher' was not defined in your script config options"
		exit 1
	}
	$selectedSide = $selectedLauncher[$side]
	if ($selectedSide -eq $null) {
		Write-Error "Requested side '$side' was not defined in launcher '$launcher' in your script config options"
		exit 1
	}
	$actualBranch = $branch
	if ($launcher -eq "steam") {
		Write-Debug "Script does not support multiple branches for steam, ignoring the -branch option of '$branch'"
		$actualBranch = "steam"
	}
	$gamePathInfo = $selectedSide[$actualBranch]
	if (($gamePathInfo -eq $null) -or ($gamePathInfo -eq "UNSET")) {
		Write-Error "Requested branch '$actualBranch' for side '$side' was not defined in launcher '$launcher' in your script config options"
		exit 1
	}
	$gameDir = $gamePathInfo["path"]
	if ($gameDir -eq $null) {
		Write-Error "Selected game install '$selectedLauncher > $selectedSide > $actualBranch' is missing 'path' data, it should be the root directory of the install"
		exit 1
	}
	$gameEXE = $gamePathInfo["exeName"]
	if ($gameEXE -eq $null) {
		Write-Error "Selected game install '$selectedLauncher > $selectedSide > $actualBranch' is missing 'exeName' data, it should be the name of the executable file that launches the game"
		exit 1
	}
	if (-not ($gamePathInfo["appid"] -eq $null)) {
		CreateSteamAppidFile -filepath $gameDir -appid $gamePathInfo["appid"]
	}
	return $gamePathInfo
}

$gamePathInfo = ResolveGamePathFromParams

if ($info) {
	Write-Output "Using game install:"
	Write-Output $gamePathInfo
}


function PrepareArgs([string]$baseArgs, [switch]$applyFirstInstanceOnlyArguments, [System.Collections.Hashtable]$pathInfo) {
	$buildArgs = "$baseArgs"
	if ($clientAutoJoin -and (-not $multiplayer -or -not $loadLatestSave)) {
		Write-Error "clientAutoJoin flag requires multiplayer flag and loadLatestSave flag so there is a running game for the client to join"
		exit 1
	}

	if ($applyFirstInstanceOnlyArguments) {
		if ($waitForDebugger) {
			$buildArgs = "$buildArgs", "-WaitForDebugger"
		}
		if ($noExceptionHandler) {
			$buildArgs = "$buildArgs", "-NoExceptionHandler"
		}
		if ($loadLatestSave) {
			if ($multiplayer) {
				# Multiplayer GUID consistency consequence: can't see platform save files. Must be in the `common` subfolder
				$saveFolderUserId = "common"
			} else {
				$saveFolderUserId = $gamePathInfo["savegameSubfolderName"]
			}

			if (($saveFolderUserId -eq $null) -or ($saveFolderUserId -eq "UNSET")) {
				Write-Error "Selected game install is missing 'savegameSubfolderName' data in your script config options. It should be the name of the subfolder within your save directory containing the save files you want to use with -loadLatestSave. Your same file directory was entered as: $SaveFolder"
				exit 1
			}

			$fullSaveFolder = "$SaveFolder\$saveFolderUserId"

			# https://stackoverflow.com/questions/9675658/powershell-get-childitem-most-recent-file-in-directory
			# Steam keeps a steam_autocloud.vdf file in here that isn't a savegame
			$latestSaveFile = (Get-ChildItem $fullSaveFolder -Attributes !Directory -Filter *.sav | sort LastWriteTime | select -last 1)
			$latestSaveFileName = $latestSaveFile.Basename

			# Use Satisfactory's -ini feature to avoid needing to create an ini file and use -EngineINI (Unreal) to pass this info along
			$buildArgs = "$buildArgs", "-ini:Engine:[/Script/EngineSettings.GameMapsSettings]:GameDefaultMap=/Game/FactoryGame/Map/GameLevel01/Persistent_Level.Persistent_Level,[/Script/EngineSettings.GameMapsSettings]:LocalMapOptions=?skipOnboarding?listen?loadgame=$latestSaveFileName"
		}
	} else {
		# Only the second copy should run the connect command for clientAutoJoin
		if ($clientAutoJoin) {
			# ExecCmds uses UE syntax: https://dev.epicgames.com/documentation/en-us/unreal-engine/unreal-engine-command-line-arguments-reference
			$buildArgs = "$buildArgs", '-ExecCmds="open 127.0.0.1"'
		}
	}
	if ($multiplayer) {
		# CustomConfig: Satisfactory specific. More consistent multiplayer GUIDs
		# Multiprocess: Make the game not write user settings and other .ini files (unsafe operation while multiple copies are open)
		$buildArgs = "$buildArgs", "-CustomConfig=", "-Multiprocess"
	}
	return $buildArgs
}

$gameDir = $gamePathInfo["path"]
$gameEXE = $gamePathInfo["exeName"]
$GameString = "$($gameDir)\$($gameEXE).exe"

$Game1 = PrepareArgs $Game1 -applyFirstInstanceOnlyArguments
$Game2 = PrepareArgs $Game2

function BGProcess(){
	if ($test) {
		Write-Output "Test switch used, not actually launching the game"
		Write-Output "Arguments for this game instance: "
		Write-Output @args
		return
	} else {
		Start-Process -NoNewWindow @args
	}
}

BGProcess $GameString $Game1

if ($multiplayer) {
	if (-not $test) {
		sleep -m $multiplayerLaunchDelayMs
	}
} else {
	return
}

BGProcess $GameString $Game2