feat: automatically use the correct runtime

Makefile.in

@@ -46,21 +46,6 @@ fix_shebangs:
 	find $(DESTDIR) -type f -name "*.sh" -exec sed -i '1s|^#!/usr/bin/env sh|#!$(SHELL_INTERPRETER)|' {} \;
 	find $(DESTDIR) -type f -name "umu-run" -exec sed -i '1s|^#!/usr/bin/env sh|#!$(SHELL_INTERPRETER)|' {} \;
 
-# Special case, do this inside the source directory for release distribution
-umu/umu_version.json: umu/umu_version.json.in
-	$(info :: Updating $(@) )
-	cp $(<) $(<).tmp
-	sed 's|##UMU_VERSION##|$(shell git describe --always --long --tags)|g' -i $(<).tmp
-	mv $(<).tmp $(@)
-
-.PHONY: version
-version: umu/umu_version.json
-
-version-install: version
-	$(info :: Installing umu_version.json )
-	install -d $(DESTDIR)$(PYTHONDIR)/$(INSTALLDIR)
-	install -Dm 644 umu/umu_version.json -t $(DESTDIR)$(PYTHONDIR)/$(INSTALLDIR)
-
 
 $(OBJDIR)/.build-umu-docs: | $(OBJDIR)
 	$(info :: Building umu man pages )
@@ -79,7 +64,7 @@ umu-docs-install: umu-docs
 	install -m644 $(OBJDIR)/umu.5 $(DESTDIR)$(MANDIR)/man5/umu.5
 
 
-$(OBJDIR)/.build-umu-dist: | $(OBJDIR) version
+$(OBJDIR)/.build-umu-dist: | $(OBJDIR)
 	$(info :: Building umu )
 	$(PYTHON_INTERPRETER) -m build --wheel --skip-dependency-check --no-isolation --outdir=$(OBJDIR)
 	touch $(@)
@@ -93,9 +78,9 @@ umu-dist-install: umu-dist
 	$(PYTHON_INTERPRETER)  -m installer --destdir=$(DESTDIR) $(OBJDIR)/*.whl
 
 ifeq ($(FLATPAK), xtrue)
-umu-install: version-install umu-dist-install
+umu-install: umu-dist-install
 else
-umu-install: version-install umu-dist-install umu-docs-install
+umu-install: umu-dist-install umu-docs-install
 endif
 
 ifeq ($(FLATPAK), xtrue)
@@ -148,15 +133,15 @@ $(OBJDIR):
 .PHONY: clean
 clean:
 	$(info :: Cleaning source directory )
-	@rm -rf -v $(OBJDIR) umu/umu_version.json ./$(RELEASEDIR) $(RELEASEDIR).tar.gz
+	@rm -rf -v $(OBJDIR) ./$(RELEASEDIR) $(RELEASEDIR).tar.gz
 
 
 RELEASEDIR := $(PROJECT)-$(shell git describe --abbrev=0)
 $(RELEASEDIR):
 	mkdir -p $(@)
 
 .PHONY: release
-release: $(RELEASEDIR) | version zipapp
+release: $(RELEASEDIR) | zipapp
 	$(info :: Creating source distribution for release )
 	mkdir -p $(<)
 	rm -rf umu/__pycache__
@@ -177,11 +162,10 @@ ZIPAPP := $(OBJDIR)/umu-run
 ZIPAPP_STAGING := $(OBJDIR)/zipapp_staging
 ZIPAPP_VENV := $(OBJDIR)/zipapp_venv
 
-$(OBJDIR)/.build-zipapp: | $(OBJDIR) version
+$(OBJDIR)/.build-zipapp: | $(OBJDIR)
 	$(info :: Building umu-launcher as zipapp )
 	$(PYTHON_INTERPRETER) -m venv $(ZIPAPP_VENV)
 	. $(ZIPAPP_VENV)/bin/activate && python3 -m pip install -t "$(ZIPAPP_STAGING)" -U --no-compile .
-	install -Dm644 umu/umu_version.json "$(ZIPAPP_STAGING)"/umu/umu_version.json
 	cp umu/__main__.py "$(ZIPAPP_STAGING)"
 	find "$(ZIPAPP_STAGING)" -exec touch -h -d "$(SOURCE_DATE_EPOCH)" {} +
 	. $(ZIPAPP_VENV)/bin/activate && python3 -m zipapp $(ZIPAPP_STAGING) -o $(ZIPAPP) -p "$(PYTHON_INTERPRETER)" -c

umu/__init__.py

@@ -1 +1,6 @@
 __version__ = "1.1.1"  # noqa: D104
+__pressure_vessel_runtime__ = ("steamrt3", "sniper", "1628350")
+__pressure_vessel_runtimes__ = (
+    ("steamrt3", "sniper", "1628350"),
+    ("steamrt2", "soldier", "1391110"),
+)

umu/umu_consts.py

@@ -1,8 +1,6 @@
 import os
 from pathlib import Path
 
-CONFIG = "umu_version.json"
-
 STEAM_COMPAT: Path = Path.home().joinpath(
     ".local", "share", "Steam", "compatibilitytools.d"
 )

umu/umu_run.py

@@ -38,6 +38,7 @@
 from Xlib.protocol.rq import Event
 from Xlib.xobject.drawable import Window
 
+from umu import __pressure_vessel_runtime__
 from umu.umu_consts import (
     PR_SET_CHILD_SUBREAPER,
     PROTON_VERBS,
@@ -51,6 +52,8 @@
 from umu.umu_util import (
     get_libc,
     get_library_paths,
+    get_vdf_value,
+    get_vdfs,
     is_installed_verb,
     is_winetricks_verb,
     xdisplay,
@@ -733,6 +736,7 @@ def main() -> int:  # noqa: D103
         "UMU_RUNTIME_UPDATE": "",
     }
     opts: list[str] = []
+    runtime_platform: Path = UMU_LOCAL / __pressure_vessel_runtime__[0]
     prereq: bool = False
     root: Traversable
 
@@ -804,7 +808,11 @@ def main() -> int:  # noqa: D103
 
         # Setup the launcher and runtime files
         future: Future = thread_pool.submit(
-            setup_umu, root, UMU_LOCAL, thread_pool
+            setup_umu,
+            root,
+            UMU_LOCAL,
+            __pressure_vessel_runtime__,
+            thread_pool,
         )
 
         if isinstance(args, Namespace):
@@ -840,8 +848,51 @@ def main() -> int:  # noqa: D103
     ):
         sys.exit(1)
 
+    # Get Proton's required compatibility tool in its .vdf file.
+    # The App ID is the runtime that it's built against
+    toolappid_proton: str = get_vdf_value(
+        Path(env["PROTONPATH"], "toolmanifest.vdf"), "require_tool_appid"
+    )
+    has_matching_compat_tools: bool = False
+
+    # Since it's common for people to change Proton versions, verify we're
+    # using Proton's intended runtime and auto change to it if downloaded
+    for file in get_vdfs(UMU_LOCAL, "**/steampipe/app_build*.vdf"):
+        if get_vdf_value(file, "appid") == toolappid_proton:
+            runtime_platform: Path = file.parent.parent
+            log.debug("App ID (Proton): %s", toolappid_proton)
+            log.debug("Steam Linux Runtime: %s", file.parent.parent.name)
+            log.console(
+                f"Using {Path(env['PROTONPATH']).name} with "
+                f"{runtime_platform.name}"
+            )
+            has_matching_compat_tools = True
+            break
+
+    # Warn if compatibility tools mismatch (e.g., using proton 7 with sniper)
+    # Assuming our parser is correct, at this point, the user is probably
+    # trying to use a proton without its required runtime. This may happen if
+    # we did not bump the runtime in time because, at the time of this writing,
+    # we're currently assuming the usage of sniper. In this case, just warn
+    # them and opt not to set an appropriate proton for the user to avoid the
+    # risk of breaking users' pfxs
+    if not has_matching_compat_tools:
+        log.warning("Compatibility tools mismatch")
+        log.warning(
+            "'%s' is not a required compatibility tool for '%s'",
+            runtime_platform,
+            env["PROTONPATH"],
+        )
+        log.warning(
+            "Prefix '%s' was created with compatibility tool %s",
+            env["WINEPREFIX"],
+            Path(env["PROTONPATH"], "version").read_text(encoding="utf-8"),
+        )
+
     # Build the command
-    command: tuple[Path | str, ...] = build_command(env, UMU_LOCAL, opts)
+    command: tuple[Path | str, ...] = build_command(
+        env, runtime_platform, opts
+    )
     log.debug("%s", command)
 
     # Run the command
@@ -858,7 +909,3 @@ def main() -> int:  # noqa: D103
             sys.exit(e.code)
     except BaseException as e:
         log.exception(e)
-    finally:
-        UMU_LOCAL.joinpath(".ref").unlink(
-            missing_ok=True
-        )  # Cleanup .ref file on every exit