Added games: the user's own Windows games in the client's library

A Games folder chosen in the Steam cog is scanned one level deep, one subfolder per game; the
program to launch is the .exe named after the folder, else the largest, never an installer,
redistributable or crash reporter, and the settings page lets the user pick another for any
game. Each session the app writes the list, and bannerlator-steam-shortcuts puts the games into
the client's shortcuts.vdf as non-Steam games (the client's own entries kept) with the appid the
client itself derives, mapped to the ARM64 Proton through the compat registrar. They appear in
the rail under Steam and launch by steam://rungameid/ like any title.
This commit is contained in:
The412Banner committed 2026-09-23 09:12:15 -04:00
1 parent cc3b963dd0
commit 65b00242d9
9 files changed
+380 -3

No files matched your search

@@ -216,6 +216,12 @@ case $mode in
bannerlator-steam-library "$steam_root" || true
step "setting up the ARM64 Proton compatibility tool"
bannerlator-steam-compat "$steam_root" || true
# The user's own games, as non-Steam shortcuts under that tool; the list is written by the app
# each session (empty = the app's earlier entries are removed, the client's own are kept).
if [ -n "${BL_ADDED_GAMES:-}" ]; then
step "adding the app's own games to the client's library"
bannerlator-steam-shortcuts "$steam_root" "$BL_ADDED_GAMES" || true
fi
# Steam runs a game's shared redistributables inside its prefix on first launch; marking
# them as already run keeps those x86 installers from starting under emulation at all.
bannerlator-seed-redists "$steam_root" || true
@@ -0,0 +1,177 @@
#!/usr/bin/env python3
"""Puts the app's added games (Windows games in the user's own folders) into the Steam client's
library as non-Steam shortcuts, each mapped to the ARM64 Proton, before the client starts.
bannerlator-steam-shortcuts <steam_root> <added-games.json>
The JSON is a list the app writes each session: {"name", "exe", "dir", "appid"} with guest paths.
The client keeps non-Steam games in userdata/<account>/config/shortcuts.vdf, a binary VDF it
reads at start-up and rewrites at exit, so this runs while it is down. Entries the app wrote
carry the tag "steamdeck-app" and are replaced wholesale; anything the user added inside the
client is kept as it is. The appid is the one the client itself derives (crc32 of exe+name with
the top bit set), so the launch URL the app uses matches what the client shows.
"""
import importlib.util
import json
import os
import re
import struct
import sys
TAG = "steamdeck-app"
def account_dir(steam_root):
"""The most recent account's userdata folder, else the only one that is not 0."""
users = os.path.join(steam_root, "config", "loginusers.vdf")
recent = None
try:
with open(users, encoding="utf-8", errors="replace") as f:
text = f.read()
for block in re.finditer(r'"(\d{5,})"\s*\{([^}]*)\}', text):
if re.search(r'"MostRecent"\s*"1"', block.group(2)):
recent = int(block.group(1))
except OSError:
pass
userdata = os.path.join(steam_root, "userdata")
if recent is not None:
# loginusers holds the 64-bit id; userdata folders use the 32-bit account id.
acct = recent - 76561197960265728
return os.path.join(userdata, str(acct))
try:
dirs = [d for d in os.listdir(userdata) if d.isdigit() and d != "0"]
except OSError:
dirs = []
return os.path.join(userdata, dirs[0]) if len(dirs) == 1 else None
# ---- binary VDF: 0x00 map, 0x01 string, 0x02 int32, 0x08 end ----
def parse(data):
pos = [0]
def cstr():
end = data.index(b"\x00", pos[0])
s = data[pos[0]:end].decode("utf-8", "replace")
pos[0] = end + 1
return s
def node():
out = {}
while True:
t = data[pos[0]]
pos[0] += 1
if t == 0x08:
return out
key = cstr()
if t == 0x00:
out[key] = node()
elif t == 0x01:
out[key] = cstr()
elif t == 0x02:
out[key] = struct.unpack_from("<i", data, pos[0])[0]
pos[0] += 4
else:
raise ValueError("unknown vdf type 0x%02x" % t)
t = data[pos[0]]
pos[0] += 1
key = cstr()
return {key: node()}
def write(obj):
out = bytearray()
def emit(key, value):
if isinstance(value, dict):
out.append(0x00)
out += key.encode() + b"\x00"
for k, v in value.items():
emit(k, v)
out.append(0x08)
elif isinstance(value, int):
out.append(0x02)
out += key.encode() + b"\x00" + struct.pack("<i", value)
else:
out.append(0x01)
out += key.encode() + b"\x00" + str(value).encode() + b"\x00"
for k, v in obj.items():
emit(k, v)
out.append(0x08)
return bytes(out)
def shortcut(game):
appid = int(game["appid"]) & 0xFFFFFFFF
return {
"appid": struct.unpack("<i", struct.pack("<I", appid))[0],
"AppName": game["name"],
"Exe": '"%s"' % game["exe"],
"StartDir": '"%s"' % game["dir"],
"icon": "",
"ShortcutPath": "",
"LaunchOptions": "",
"IsHidden": 0,
"AllowDesktopConfig": 1,
"AllowOverlay": 1,
"OpenVR": 0,
"Devkit": 0,
"DevkitGameID": "",
"DevkitOverrideAppID": 0,
"LastPlayTime": 0,
"FlatpakAppID": "",
"tags": {"0": TAG},
}
def main():
if len(sys.argv) < 3:
print(__doc__)
return 2
steam_root, listing = sys.argv[1], sys.argv[2]
try:
with open(listing, encoding="utf-8") as f:
games = json.load(f)
except (OSError, ValueError) as e:
print("bannerlator-steam-shortcuts: no list (%s)" % e)
return 0
acct = account_dir(steam_root)
if not acct:
print("bannerlator-steam-shortcuts: no signed-in account yet; nothing written")
return 0
config = os.path.join(acct, "config")
os.makedirs(config, exist_ok=True)
path = os.path.join(config, "shortcuts.vdf")
existing = {}
if os.path.isfile(path):
try:
with open(path, "rb") as f:
existing = parse(f.read()).get("shortcuts", {})
except (ValueError, IndexError) as e:
print("bannerlator-steam-shortcuts: could not read the existing file (%s); starting over" % e)
kept = [v for v in existing.values() if isinstance(v, dict) and TAG not in (v.get("tags") or {}).values()]
ours = [shortcut(g) for g in games if g.get("exe") and g.get("name")]
entries = {str(i): v for i, v in enumerate(kept + ours)}
tmp = path + ".bannerlator"
with open(tmp, "wb") as f:
f.write(write({"shortcuts": entries}))
os.replace(tmp, path)
print("bannerlator-steam-shortcuts: %d added game(s) written, %d of the client's own kept" % (len(ours), len(kept)))
# Each added game runs under the ARM64 Proton: the compat registrar's own mapping writer.
try:
spec = importlib.util.spec_from_file_location("compat", "/usr/local/bin/bannerlator-steam-compat")
compat = importlib.util.module_from_spec(spec)
spec.loader.exec_module(compat)
cfg = os.path.join(steam_root, "config", "config.vdf")
if os.path.isfile(cfg) and ours:
compat.register_default(cfg, apps=[str(int(g["appid"]) & 0xFFFFFFFF) for g in games if g.get("exe")])
print("bannerlator-steam-shortcuts: mapped them to %s" % compat.TOOL)
except Exception as e: # noqa: BLE001 - the games still show; the client falls back to the default tool
print("bannerlator-steam-shortcuts: compat mapping skipped (%s)" % e)
return 0
if __name__ == "__main__":
sys.exit(main())