Allow to specify custom ATS/ETS2 launch options (truckersmp-cli#167)

Author: kakurasan

Diff for: .github/workflows/build_and_upload_inject_program.yaml

@@ -29,7 +29,7 @@ jobs:
       - name: Build truckersmp-cli.exe
              # we need "make clean" because we already have truckersmp-cli.exe
              # and "make" does nothing even when truckersmp-cli.c is changed
-        run: make clean && make
+        run: make clean && make truckersmp_cli/truckersmp-cli.exe
       - name: Strip truckersmp-cli.exe
         run: x86_64-w64-mingw32-strip truckersmp_cli/truckersmp-cli.exe
       - uses: actions/upload-artifact@v1

Diff for: README.md

@@ -104,6 +104,7 @@ Short option|Long option|Description
 (Not available)|`--check-windows-steam`|Check for the Windows Steam version on updating when using Proton
 (Not available)|`--disable-proton-overlay`|Disable Steam Overlay when using Proton
 (Not available)|`--downgrade`|**DEPRECATED** Downgrade to the latest version that is supported by TruckersMP. Note: This option implies "--update" option and is ignored if "--beta" ("-b") option is specified
+(Not available)|`--game-options OPTIONS`|Specify ATS/ETS2 options Note: If specifying one option, use `--game-options=-option` format [Default: `-nointro -64bit`]
 (Not available)|`--native-steam-dir`|Choose native Steam installation, useful only if your Steam directory is not detected automatically [Default: `auto`]
 (Not available)|`--self-update`|Update files to the latest release and quit
 (Not available)|`--singleplayer`|**DEPRECATED** Start singleplayer game, useful for save editing, using/testing DXVK in singleplayer, etc.

Diff for: truckersmp-cli.c

@@ -10,6 +10,7 @@
  */
 
 #include <stdio.h>
+#include <string.h>
 #include <windows.h>
 #include <unistd.h>
 
@@ -29,13 +30,13 @@ int
 main(int argc, char **argv)
 {
 	int i, len;
-	const char opts[] = "-nointro -64bit";
+	char opts[BUF_SIZE] = {0};
 	char cmd[BUF_SIZE];
 	char dll[BUF_SIZE];
 	char *exepath, *dllpath, *steamid;
 
 	if (argc < 3)
-		die("Usage: truckersmp-cli GAMEDIR MODDIR\n");
+		die("Usage: truckersmp-cli GAMEDIR MODDIR GAME_OPTIONS...\n");
 
 	for (i = 1; i < 3; i++) { /* '\' and '/' can be mixed in windows type pathes */
 		len = strlen(argv[i]);
@@ -59,7 +60,25 @@ main(int argc, char **argv)
 		}
 	}
 
-	snprintf(cmd, sizeof(cmd), "%s%s %s", argv[1], exepath, opts);
+	if (argc == 3) {
+		/* if game options are not given, use default options for compatibility */
+		strcpy(opts, " -nointro -64bit");
+	} else {
+		/* build game options string */
+		len = strlen(argv[1]) + strlen(exepath) + 1;  /* game exe path + "\0" */
+		for (i = 3; i < argc; i++) {
+			/* check whether a space and the option can be added to the buffer */
+			len += 1 + strlen(argv[i]);  /* 1 = strlen(" ") */
+			if (len <= BUF_SIZE) {
+				strcat(opts, " ");
+				strcat(opts, argv[i]);
+			} else {
+				die("Game options are too long.");
+			}
+		}
+	}
+
+	snprintf(cmd, sizeof(cmd), "%s%s%s", argv[1], exepath, opts);
 	snprintf(dll, sizeof(dll), "%s%s", argv[2], dllpath);
 
 	SetEnvironmentVariable("SteamGameId", steamid);

Diff for: truckersmp_cli/args.py

@@ -306,6 +306,13 @@ def create_arg_parser():
                 Note: This option implies "--update" option and
                 is ignored if "--beta" ("-b") option is specified""",
         action="store_true"))
+    store_actions.append(parser.add_argument(
+        "--game-options", metavar="OPTIONS", type=str,
+        default="-nointro -64bit",
+        help="""specify ATS/ETS2 options
+                Note: If specifying one option, use "--game-options=-option" format
+                [Default: "-nointro -64bit"]""",
+        action="store_true"))
     store_actions.append(parser.add_argument(
         "--native-steam-dir", metavar="DIR", type=str,
         default="auto",

Diff for: truckersmp_cli/main.py

@@ -176,7 +176,8 @@ def setup_logging():
 
 def start_with_proton():
     """Start game with Proton."""
-    # pylint: disable=consider-using-with,too-many-branches,too-many-statements
+    # pylint: disable=consider-using-with,too-many-branches
+    # pylint: disable=too-many-locals,too-many-statements
     steamdir = wait_for_steam(use_proton=True, loginvdf_paths=File.loginusers_paths)
     logging.info("Steam installation directory: %s", steamdir)
 
@@ -216,15 +217,12 @@ def start_with_proton():
     env["PROTON_USE_WINED3D"] = "1" if Args.use_wined3d else "0"
     env["PROTON_NO_D3D11"] = "1" if not Args.enable_d3d11 else "0"
     # enable Steam Overlay unless "--disable-proton-overlay" is specified
-    if Args.disable_proton_overlay:
-        ld_preload = ""
-    else:
+    if not Args.disable_proton_overlay:
         overlayrenderer = os.path.join(steamdir, File.overlayrenderer_inner)
         if "LD_PRELOAD" in env:
             env["LD_PRELOAD"] += ":" + overlayrenderer
         else:
             env["LD_PRELOAD"] = overlayrenderer
-        ld_preload = "LD_PRELOAD={}\n  ".format(env["LD_PRELOAD"])
 
     # start wine-discord-ipc-bridge for multiplayer
     # unless "--without-wine-discord-ipc-bridge" is specified
@@ -240,29 +238,35 @@ def start_with_proton():
     if Args.singleplayer:
         exename = "eurotrucks2.exe" if Args.ets2 else "amtrucks.exe"
         gamepath = os.path.join(Args.gamedir, "bin/win_x64", exename)
-        argv += gamepath, "-nointro", "-64bit"
+        argv.append(gamepath)
     else:
         argv += File.inject_exe, Args.gamedir, Args.moddir
 
+    # game options
+    for opt in Args.game_options.split(" "):
+        if opt != "":
+            argv.append(opt)
+
     env["SteamGameId"] = Args.steamid
     env["SteamAppId"] = Args.steamid
-    logging.info(
-        """Startup command:
-  SteamGameId=%s
-  SteamAppId=%s
-  STEAM_COMPAT_DATA_PATH=%s
-  STEAM_COMPAT_CLIENT_INSTALL_PATH=%s
-  PROTON_USE_WINED3D=%s
-  PROTON_NO_D3D11=%s
-  %s%s %s
-  run
-  %s %s %s""",
-        env["SteamGameId"], env["SteamAppId"],
-        env["STEAM_COMPAT_DATA_PATH"], env["STEAM_COMPAT_CLIENT_INSTALL_PATH"],
-        env["PROTON_USE_WINED3D"],
-        env["PROTON_NO_D3D11"],
-        ld_preload,
-        sys.executable, proton, argv[-3], argv[-2], argv[-1])
+    env_print = ["SteamAppId", "SteamGameId"]
+    if "LD_PRELOAD" in env:
+        env_print.append("LD_PRELOAD")
+    env_print += [
+        "PROTON_NO_D3D11",
+        "PROTON_USE_WINED3D",
+        "STEAM_COMPAT_CLIENT_INSTALL_PATH",
+        "STEAM_COMPAT_DATA_PATH",
+    ]
+
+    env_str = ""
+    cmd_str = ""
+    name_value_pairs = []
+    for name in env_print:
+        name_value_pairs.append("{}={}".format(name, env[name]))
+    env_str += "\n  ".join(name_value_pairs) + "\n  "
+    cmd_str += "\n    ".join(argv)
+    logging.info("Running Proton:\n  %s%s", env_str, cmd_str)
     try:
         output = subproc.check_output(argv, env=env, stderr=subproc.STDOUT)
         logging.info("Proton output:\n%s", output.decode("utf-8"))
@@ -282,7 +286,7 @@ def start_with_proton():
 
 def start_with_wine():
     """Start game with Wine."""
-    # pylint: disable=consider-using-with
+    # pylint: disable=consider-using-with,too-many-branches
     wine = os.environ["WINE"] if "WINE" in os.environ else "wine"
     if Args.activate_native_d3dcompiler_47:
         activate_native_d3dcompiler_47(Args.prefixdir, wine)
@@ -314,25 +318,27 @@ def start_with_wine():
     if not Args.enable_d3d11:
         env["WINEDLLOVERRIDES"] += ";d3d11=;dxgi="
 
-    desktop_args = ""
     if Args.wine_desktop:
         argv += "explorer", "/desktop=TruckersMP,{}".format(Args.wine_desktop)
-        desktop_args += argv[1] + " " + argv[2] + " "
     if Args.singleplayer:
         exename = "eurotrucks2.exe" if Args.ets2 else "amtrucks.exe"
         gamepath = os.path.join(Args.gamedir, "bin/win_x64", exename)
-        argv += gamepath, "-nointro", "-64bit"
+        argv.append(gamepath)
     else:
         argv += File.inject_exe, Args.gamedir, Args.moddir
-    logging.info(
-        """Startup command:
-  WINEDEBUG=-all
-  WINEARCH=win64
-  WINEPREFIX=%s
-  WINEDLLOVERRIDES="%s"
-  %s %s%s %s %s""",
-        env["WINEPREFIX"], env["WINEDLLOVERRIDES"],
-        wine, desktop_args, argv[-3], argv[-2], argv[-1])
+
+    for opt in Args.game_options.split(" "):
+        if opt != "":
+            argv.append(opt)
+
+    env_str = ""
+    cmd_str = ""
+    name_value_pairs = []
+    for name in ("WINEARCH", "WINEDEBUG", "WINEDLLOVERRIDES", "WINEPREFIX"):
+        name_value_pairs.append("{}={}".format(name, env[name]))
+    env_str += "\n  ".join(name_value_pairs) + "\n  "
+    cmd_str += "\n    ".join(argv)
+    logging.info("Running Wine:\n  %s%s", env_str, cmd_str)
     try:
         output = subproc.check_output(argv, env=env, stderr=subproc.STDOUT)
         logging.info("Wine output:\n%s", output.decode("utf-8"))