feat(proton): install experimental Proton builds from a .zip (#2864)

Components > Proton gains an Experimental builds card that installs a Proton build from a .zip, lists it as Experimental-<name> and removes it with its stored and unpacked originals and selections. Replacing a build keeps its user settings and is safe to interrupt.

Co-authored-by: maxjivi05 <maxjividen@gmail.com>
This commit is contained in:
FryMcNuggetandmaxjivi05 authored and GitHub committed 2026-11-19 02:32:30 -05:00
1 parent c35da09d1a
commit 44ade5eeee
43 files changed
+1059 -36

No files matched your search

@@ -1089,9 +1089,10 @@ NATIVE_CHOICE = object()
def plan_mapping(current, installed, runnable, default, auto, native=None, picks=(), overrides=None, managed=None,
native_choices=(), tools=None):
native_choices=(), tools=None, removed=()):
tools = tools or {}
runnable = {n.lower() for n in runnable}
removed = {n.lower() for n in removed} - runnable
installed = set(installed)
picks = set(picks) | {app for app, platforms in tools.items() if "linux" not in platforms}
native = native or {}
@@ -1121,7 +1122,7 @@ def plan_mapping(current, installed, runnable, default, auto, native=None, picks
target = native.get(app, default)
if not name and (app in native_choices or (app in current and app in FEX_DEFAULT_APPS)):
target = NATIVE_CHOICE
stale = unrunnable(name, runnable)
stale = unrunnable(name, runnable) or name.lower() in removed
if name and not stale and (mine is None or name != mine):
continue
if target is NATIVE_CHOICE:
@@ -1163,6 +1164,26 @@ def followers(state, current):
return {app: name for app, name in current.items() if app != "0" and name == TOOL}
REPLACING = ".droiddeck-experimental-old"
def removed_tools(state, catalog, directory=None):
known = state.get("tools") if isinstance(state.get("tools"), list) else ()
previous = {t.get("name") for t in known if isinstance(t, dict) and not t.get("valve") and t.get("name")}
removed = previous - {t["name"] for t in catalog}
if directory is None:
return removed
known_dirs = {t.get("name"): t.get("dir") for t in known if isinstance(t, dict)}
return {name for name in removed if isinstance(known_dirs.get(name), str) and
not os.path.lexists(os.path.join(directory, known_dirs[name])) and
not os.path.lexists(os.path.join(directory, REPLACING, known_dirs[name]))}
def removed_dirs(state, removed):
known = state.get("tools") if isinstance(state.get("tools"), list) else ()
return {t["dir"] for t in known if isinstance(t, dict) and not t.get("valve") and t.get("name") in removed and isinstance(t.get("dir"), str)} - {""}
def tool_entry(name, display, path, valve):
return {"name": name, "display": display, "dir": os.path.basename(path) if path else "", "valve": valve}
@@ -1248,15 +1269,19 @@ def valid_game_request(app, request):
request["dir"] != "" and isinstance(request.get("valve"), bool)))
def settle_game_requests(requests, state, current, catalog, missing_is_cleared=False):
def settle_game_requests(requests, state, current, catalog, missing_is_cleared=False, removed=()):
recorded = state.get("games_applied")
if isinstance(recorded, dict):
applied = dict(recorded)
else:
applied = dict(requests) if "tools" in state else {}
by_name = {t["name"]: t for t in catalog}
gone = removed_dirs(state, removed)
out = dict(requests)
for app, request in requests.items():
if isinstance(request, dict) and request.get("valve") is False and isinstance(request.get("dir"), str) and request["dir"] in gone:
del out[app]
continue
if not valid_game_request(app, request) or app not in applied or applied[app] != request:
continue
if request is None:
@@ -1281,10 +1306,10 @@ def settle_game_requests(requests, state, current, catalog, missing_is_cleared=F
return out, out != requests
def settled_game_requests(state, current, catalog, missing_is_cleared=False, directory=None):
def settled_game_requests(state, current, catalog, missing_is_cleared=False, directory=None, removed=()):
for _ in range(2):
requests, text = read_game_requests(directory)
settled, moved = settle_game_requests(requests, state, current, catalog, missing_is_cleared)
settled, moved = settle_game_requests(requests, state, current, catalog, missing_is_cleared, removed)
if not moved or write_game_requests(settled, text, directory):
return settled
return None
@@ -1579,7 +1604,8 @@ def register_default(config_path, apps=(), protect=(), default=None, catalog=Non
set_mappings(tokens, mapping, moved)
current.update(moved)
steam_root = os.path.dirname(os.path.dirname(os.path.abspath(config_path)))
requests = settled_game_requests(state, current, catalog, not steam_running(), directory)
removed = removed_tools(state, catalog, os.path.join(steam_root, "compatibilitytools.d"))
requests = settled_game_requests(state, current, catalog, not steam_running(), directory, removed)
overrides = requested_games(requests or {}, catalog)
managed = state.get("auto", {}).keys() if isinstance(state.get("auto"), dict) else ()
native_choices = state.get("native_choices", ())
@@ -1590,7 +1616,7 @@ def register_default(config_path, apps=(), protect=(), default=None, catalog=Non
current.setdefault(app, "")
changes, auto = plan_mapping(
current, apps, names, default, followers(state, current), native, picks,
overrides, managed, native_choices, tool_platforms(steam_root))
overrides, managed, native_choices, tool_platforms(steam_root), removed)
set_mappings(tokens, mapping, changes)
text = serialize(tokens)
if text != serialize(tokenize(original)):
+116
View File
@@ -2254,6 +2254,87 @@ class ProtonDefaultTest(unittest.TestCase):
self.assertEqual(changes, {"0": "GE-Proton11-7", "10": "GE-Proton11-7", "11": "GE-Proton11-7", "14": "GE-Proton11-7"})
self.assertEqual(auto, {"10": "GE-Proton11-7", "11": "GE-Proton11-7", "14": "GE-Proton11-7"})
def test_games_on_a_removed_custom_proton_go_back_to_the_default(self):
changes, auto = COMPAT["plan_mapping"](
{"0": self.TOOL, "311210": "bo3fix-proton", "42": "GE-Proton11-7"}, ["311210", "42"], self.NAMES, self.TOOL, {},
removed={"bo3fix-proton"})
self.assertEqual(changes, {"311210": self.TOOL})
self.assertEqual(auto, {"311210": self.TOOL})
def test_removed_tools_are_custom_builds_missing_from_the_catalog(self):
state = {"tools": [
{"name": self.TOOL, "valve": True},
{"name": "bo3fix-proton", "valve": False},
{"name": "GE-Proton11-7", "valve": False},
]}
self.assertEqual(COMPAT["removed_tools"](state, self.CATALOG), {"bo3fix-proton"})
self.assertEqual(COMPAT["removed_tools"]({}, self.CATALOG), set())
def test_a_failed_extra_adoption_is_not_classified_as_removed(self):
with tempfile.TemporaryDirectory() as tmp:
tools = Path(tmp) / "compatibilitytools.d"
tools.mkdir()
state = {"tools": [{"name": "GE-Proton11-7", "dir": "GE-Proton11-7", "valve": False}]}
(tools / "GE-Proton11-7").mkdir()
catalog = [tool for tool in self.CATALOG if tool["name"] != "GE-Proton11-7"]
self.assertEqual(COMPAT["removed_tools"](state, catalog, str(tools)), set())
(tools / "GE-Proton11-7").rmdir()
self.assertEqual(COMPAT["removed_tools"](state, catalog, str(tools)), {"GE-Proton11-7"})
def test_a_build_being_replaced_is_not_classified_as_removed(self):
with tempfile.TemporaryDirectory() as tmp:
tools = Path(tmp) / "compatibilitytools.d"
state = {"tools": [{"name": "GE-Proton11-7", "dir": "GE-Proton11-7", "valve": False}]}
catalog = [tool for tool in self.CATALOG if tool["name"] != "GE-Proton11-7"]
aside = tools / COMPAT["REPLACING"] / "GE-Proton11-7"
aside.mkdir(parents=True)
self.assertEqual(COMPAT["removed_tools"](state, catalog, str(tools)), set())
aside.rmdir()
self.assertEqual(COMPAT["removed_tools"](state, catalog, str(tools)), {"GE-Proton11-7"})
def test_a_request_for_a_removed_tool_is_dropped_and_others_are_kept(self):
state = {"tools": self.CATALOG, "games_applied": {}}
requests = {"10": {"valve": False, "dir": "GE-Proton11-7"}, "11": {"valve": False, "dir": "Never-Installed"},
"12": {"valve": True, "dir": "GE-Proton11-7"}}
catalog = [tool for tool in self.CATALOG if tool["name"] != "GE-Proton11-7"]
settled, moved = COMPAT["settle_game_requests"](requests, state, {}, catalog, removed={"GE-Proton11-7"})
self.assertTrue(moved)
self.assertEqual(settled, {"11": requests["11"], "12": requests["12"]})
self.assertEqual(COMPAT["settle_game_requests"](requests, state, {}, catalog), (requests, False))
malformed = {"10": {"valve": False, "dir": []}}
self.assertEqual(COMPAT["settle_game_requests"](malformed, state, {}, catalog, removed={"GE-Proton11-7"}), (malformed, False))
def test_a_game_on_a_removed_tool_follows_the_default_across_registrations(self):
with tempfile.TemporaryDirectory() as tmp:
config = Path(tmp) / "config.vdf"
config.write_text(config_text([("0", self.TOOL), ("10", "GE-Proton11-7"), ("11", "GE-Proton11-7")]))
request = {"valve": False, "dir": "GE-Proton11-7"}
available = [tool for tool in self.CATALOG if tool["name"] != "GE-Proton11-7"]
(Path(tmp) / "games.json").write_text(json.dumps({"version": 1, "games": {"10": request}}))
(Path(tmp) / "state.json").write_text(json.dumps({
"default": self.TOOL,
"tools": self.CATALOG,
}))
for default in (self.TOOL, self.TOOL, COMPAT["TOOL_11"]):
COMPAT["register_default"](
str(config), ["10", "11"], default=default, catalog=available,
directory=tmp,
)
self.assertEqual(mapping_of(config.read_text()),
{"0": COMPAT["TOOL_11"], "10": COMPAT["TOOL_11"], "11": COMPAT["TOOL_11"]})
self.assertEqual(json.loads((Path(tmp) / "games.json").read_text())["games"], {})
def test_a_steam_pick_survives_the_removal_of_another_tool(self):
with tempfile.TemporaryDirectory() as tmp:
config = Path(tmp) / "config.vdf"
config.write_text(config_text([("0", self.TOOL), ("10", COMPAT["TOOL_11"])]))
available = [tool for tool in self.CATALOG if tool["name"] != "GE-Proton11-7"]
(Path(tmp) / "games.json").write_text(json.dumps(
{"version": 1, "games": {"10": {"valve": False, "dir": "GE-Proton11-7"}}}))
(Path(tmp) / "state.json").write_text(json.dumps({"default": self.TOOL, "tools": self.CATALOG, "auto": {}}))
COMPAT["register_default"](str(config), ["10"], default=self.TOOL, catalog=available, directory=tmp)
self.assertEqual(mapping_of(config.read_text()), {"0": self.TOOL, "10": COMPAT["TOOL_11"]})
def test_windows_only_titles_still_follow_the_default(self):
changes, auto = COMPAT["plan_mapping"](
{"0": self.TOOL}, ["42"], self.NAMES, self.TOOL, {})
@@ -2597,6 +2678,41 @@ class ProtonDefaultTest(unittest.TestCase):
"11": COMPAT["TOOL_11"],
})
def test_per_game_proton_that_was_removed_goes_back_to_the_default(self):
with tempfile.TemporaryDirectory() as tmp:
config = Path(tmp) / "config.vdf"
config.write_text(config_text([
("0", self.TOOL),
("10", "Experimental-DroidDeck-Proton-11-12.8-pr34-build"),
("12", "GE-Proton9-1"),
]))
(Path(tmp) / "games.json").write_text(json.dumps({
"version": 1,
"games": {
"10": {"valve": False, "dir": "Experimental-DroidDeck-Proton-11-12.8-pr34-build"},
"12": {"valve": False, "dir": "GE-Proton9-1"},
},
}))
(Path(tmp) / "state.json").write_text(json.dumps({
"default": self.TOOL,
"tools": self.CATALOG + [{
"name": "Experimental-DroidDeck-Proton-11-12.8-pr34-build",
"display": "Experimental-DroidDeck-Proton-11-12.8-pr34-build",
"dir": "Experimental-DroidDeck-Proton-11-12.8-pr34-build", "valve": False,
}],
}))
COMPAT["register_default"](
str(config), ["10", "12"], default=self.TOOL,
catalog=self.CATALOG, directory=tmp,
)
self.assertEqual(mapping_of(config.read_text()), {
"0": self.TOOL,
"10": self.TOOL,
"12": "GE-Proton9-1",
})
def test_the_last_side_to_change_wins(self):
state = {"default": self.TOOL, "applied": 5}
default, state = COMPAT["choose_default"]("GE-Proton11-7", state, {"seq": 5, "dir": "Proton 11.0 (ARM64)", "valve": True}, self.CATALOG, now=100)