mirror of
https://github.com/spoopyghosty0/frameport.git
synced 2026-10-11 21:01:14 +02:00
Compare commits
22
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6acf9d048e | ||
|
|
cf18b30be9 | ||
|
|
eec0218b1d | ||
|
|
526ba0a684 | ||
|
|
23b6ff1b5e | ||
|
|
00c6863e54 | ||
|
|
4863035a05 | ||
|
|
a30162ea63 | ||
|
|
24eaa97fde | ||
|
|
767b152423 | ||
|
|
10e7669f70 | ||
|
|
76c4f2d225 | ||
|
|
3a851e911f | ||
|
|
2912d637b5 | ||
|
|
5c070ccf23 | ||
|
|
b979067215 | ||
|
|
4440b459e5 | ||
|
|
09b8046337 | ||
|
|
0d67335775 | ||
|
|
867b9977d5 | ||
|
|
80092098e0 | ||
|
|
feab03e049 |
No files matched your search
@@ -38,6 +38,6 @@ body:
|
||||
id: logs
|
||||
attributes:
|
||||
label: Diagnostics
|
||||
description: Drag the FramePort-diag-*.zip here (max 25 MB)
|
||||
description: "Drag the FramePort-diag-*.zip here (max 25 MB). If the box won't take it, submit the report and attach the zip in a comment."
|
||||
validations:
|
||||
required: true
|
||||
@@ -323,8 +323,17 @@ Games tests: `pytest -m games` (FRAMEPORT_GAMES=<downloads dir>); on-device chec
|
||||
native layer test: `FRAMEPORT_NATIVE_TESTS=1 pytest -m native` (compiles with the NDK, ~2 min on NTFS).
|
||||
Repo is on an NTFS drive (`core.fileMode=false`); line endings are LF (`.gitattributes`).
|
||||
- `FRAMEPORT_HOME=<dir>` isolates all app data (tests use it); `FRAMEPORT_JAVA/_OVERPORT_JAR/_APKSIGNER_JAR` override
|
||||
managed tools. Real app data (WSL): `~/.local/share/frameport` (tools, overport workspace + game keystores, library,
|
||||
artwork, frames.json, the app's SSH key which the dev Frame authorizes).
|
||||
managed tools. **The owner's real app data is the Windows copy's: `%LOCALAPPDATA%\FramePort`** (= `/mnt/c/Users/
|
||||
<user>/AppData/Local/FramePort`; tools, overport workspace + game keystores, library, artwork, frames.json, the app's
|
||||
SSH key which the dev Frame authorizes; moved from WSL's `~/.local/share/frameport` on 2026-10-11, which is now only
|
||||
a stale backup). The desktop shortcut "FramePort (dev)" runs the source checkout natively on Windows
|
||||
(`%LOCALAPPDATA%\FramePort-dev\launch-frameport-dev.vbs`: venv `FramePort-dev\venv` via `UV_PROJECT_ENVIRONMENT`,
|
||||
`uv sync --frozen`, log `FramePort\logs\dev-gui.log`). **WSL runs on that data need `FRAMEPORT_WINDOWS_DATA=1`**
|
||||
(set in `.claude/settings.local.json`; `paths.shares_windows_data`): the data folder becomes the Windows one, saved
|
||||
paths from the other side are translated on load (`paths.localize`: /mnt/d/X <-> D:\X in library.json, tools.json,
|
||||
PC deployment records), Java/Cpp2IL keep one copy per OS (tools.json `java-<os>-<arch>`), and the link handler isn't
|
||||
registered (it would point the Windows copy's links at WSL). Don't run a WSL GUI and the Windows GUI at once
|
||||
(the gui.lock flock/msvcrt locks don't see each other; only the gui.alive heartbeat does).
|
||||
- Device checks: `frameport test <pkg>` / `frameport parity-device --results <parity.json> --baseline <launch.txt>
|
||||
[--test-only]`; the pre-FramePort baseline is `PATCHED/_known-good-2026-09-28/_frame-state/baseline-launch.txt`.
|
||||
- Docs screenshots + videos (docs/SHOWCASE.md): never by hand. `uv run python scripts/showcase/render_docs.py`
|
||||
@@ -352,6 +361,11 @@ Repo is on an NTFS drive (`core.fileMode=false`); line endings are LF (`.gitattr
|
||||
`T.px(n)`, Material defaults through the theme's text_theme; never hardcode a bare pixel number in ui/.
|
||||
`scripts/ui_smoke.py --scale 1.5 --viewport 2560x1440` renders it. Flet draws a grey box for invalid layouts (e.g.
|
||||
an `expand` child in a `wrap=True` Row).
|
||||
- One GUI per data folder (`core/instance.py`, 2026-10-11): `<data>/gui.lock` (flock/msvcrt, pid inside); a second
|
||||
start asks the open window to come to the front (`gui.focus`, read by `_watch_links`) and exits; a lock held with no
|
||||
window (no `gui.alive`) and older than 30 s is a leftover FramePort process and is ended. `main()` ends the process
|
||||
(`os._exit`) once `ft.run` returns: background threads (re-analysis, session triage) used to keep a windowless
|
||||
process running. Session triage shows one pop-up for all games of a burst (`_announce_sessions`).
|
||||
- Stopping the GUI: `pkill -f` patterns match your own shell — use `pgrep -f "[b]in/frameport-gui|[f]let-desktop-light"`.
|
||||
|
||||
## Round-2 polish (2026-10-02)
|
||||
@@ -790,6 +804,13 @@ index lines; no index (fp_spirv) = the old newest-by-mtime 4 MB. One JSON line (
|
||||
is read whole by `Frame.agent` (fine at that size); `_Writer.fit` drops the least recently used modules last, after
|
||||
cutting logs, to stay under the 24 MB zip limit.
|
||||
**Unreal OBB check (GitHub #159, 2026-10-10):** Epic's DownloaderActivity checks OBB name+size (OBBData), then with `bVerifyOBBOnStartUp=true` CRCs the whole OBB; its screens are invisible in Lepton (stuck at `Displayed …/.DownloaderActivity`, triage `unreal-obb-check-stuck`) → `frame.unreal_skip_obb_check` (analysis `unreal_verify_obb`, ANALYSIS_VERSION 11) flips the manifest boolean (`axml.set_meta_data_bool`); skips only the CRC pass. Host-tested only.
|
||||
**Meta user id (GitHub #182, 2026-10-11):** OVRPort's platform loader (runtimes 3.4.3-23204ea and -aa54c3f) answers
|
||||
`ovr_GetLoggedInUserID` (and two other callers) without a Meta account with a made-up id from a helper (`stp; mov x29,
|
||||
sp; bl random; …; mov/movk x9 = 0x53444835ec580000 (6e18); add x0, x8, x9; ldp; ret`), kept only in memory → a new id
|
||||
every start; Walkabout Mini Golf files saves under `Profiles/Oculus/<id>/` and lost all progress. `frame.ovr_stable_user`
|
||||
(default_on, detect = the game has libovrplatformloader.so) rewrites the helper to `mov x0, <6e18 + 32 bits of
|
||||
sha256(package, keystore)>; ret`: stable per game and per user (keystores are personal), so online games never see two
|
||||
FramePort users as one. Found in every PATCHED build checked. Host-tested only; upstream candidate.
|
||||
**Vivox API 31 (GitHub #101, 2026-10-09):** newer Vivox builds (Green Hell VR) call Android 12 AudioManager
|
||||
communication-device methods from `com.vivox.sdk.AudioChangeListener` with no SDK check → NoSuchMethodError on Lepton's
|
||||
Android 11. `frame.vivox_audio_route` (analysis `vivox_api31`, ANALYSIS_VERSION 4) makes every such method return at
|
||||
@@ -820,7 +841,8 @@ on the dev Frame) in `files/framebridge-vrapi-fov.txt` and answers with it at th
|
||||
r_3dwidth/height, r_width/height from the runtime eye size (FrameBridge logs `runtime recommended eye size`) × scale,
|
||||
written at finalize, set_settings and by launch.sh before Lepton starts (`_config_sync`). Headless runs at scale 1.7
|
||||
end in `zink: DEVICE LOST` right after the bridge's 30 s no-tracking deadline tears the session down (gpu fault at the
|
||||
teardown; not at scale 1.0): a headless-only artifact, the headset never hits that deadline.
|
||||
teardown; not at scale 1.0): a headless-only artifact, the headset never hits that deadline. Launch tests count an exit/crash after
|
||||
such a line as a pass (triage.yaml `headless_end`, finding `headless-end`; GitHub #57 "Failed to launch" on install).
|
||||
**Session triage (agent v70, 2026-10-09):** launch tests never reach FOCUSED, so real play sessions are triaged
|
||||
too. list_installed gives each game `last_play` {start, end, test} from `<anchor>/plays.log` (launch tests write a
|
||||
`test <unix>` line first → test sessions are only marked); `session_log` returns the newest session's launch.log
|
||||
|
||||
@@ -44,7 +44,7 @@ try:
|
||||
except ImportError: # Windows: pc_revive loads this file for its VDF code only (GitHub #131)
|
||||
fcntl = None
|
||||
|
||||
AGENT_VERSION = 79
|
||||
AGENT_VERSION = 80
|
||||
HOME = os.path.expanduser("~")
|
||||
STEAM = os.path.join(HOME, ".local/share/Steam")
|
||||
ANCHORS = os.path.join(HOME, "Applications/quest-frame")
|
||||
@@ -6604,6 +6604,7 @@ MON_CRITICAL = ("steam", "steamwebhelper", "reaper", "vrserver", "vrcompositor",
|
||||
# processes whose command line can name a game (only these are read: cmdlines of ~500 processes cost too much)
|
||||
MON_ROOT_COMMS = ("conmon", "launch.sh", "reaper", "bash", "sh")
|
||||
MON_ROOT_PREFIXES = ("python", "proton", "pv-", "wine", "steam-runtime")
|
||||
AGENT_FILES = {os.path.abspath(__file__), os.path.realpath(__file__)}
|
||||
MON_GROUPS = ( # (group, comm prefixes), first match wins; games are found by their process tree
|
||||
("steamvr", ("vr", "XRService", "V4L2Cam", "eyetracking", "proxmicmute", "systemlayer")),
|
||||
("steam", ("steam", "reaper", "fossilize")),
|
||||
@@ -7035,7 +7036,9 @@ class Monitor:
|
||||
m = re.search(r"lepton-steamlaunch-(\d+)", cmd)
|
||||
if m and m.group(1) in by_appid:
|
||||
root = (by_appid[m.group(1)]["package"], "container")
|
||||
else:
|
||||
elif not any(a in cmd for a in AGENT_FILES):
|
||||
# the agent's own workers name a game's launch.sh too (uninstall's shortcut removal while Steam
|
||||
# restarts): they aren't the game (helpers launch.sh starts still count, as its children)
|
||||
pkg = next((k for path, k in anchors if path in cmd), None) or \
|
||||
next((k for base, k in bases if base in cmd), None)
|
||||
root = (pkg, "launcher") if pkg else None
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
package: com.SchellGames.DieScreaming
|
||||
title: SilentSlayer
|
||||
status: works
|
||||
tested_version: 1.1.2+323863s
|
||||
engine: Unreal
|
||||
xr: OpenXR
|
||||
alt_overport:
|
||||
- patch_remove_unreal_force_quit
|
||||
adapter:
|
||||
haptic_fix: 1
|
||||
verified:
|
||||
date: '2026-10-11'
|
||||
known_good_sha256: 5cb085909f9a54488543102242f19c5b2f176a1439659a29a9cca04362601f68
|
||||
app: 0.12.0
|
||||
overport_cli: 1.2.5
|
||||
frame_build: '20261007.6125817'
|
||||
agent: 59
|
||||
issue: 176
|
||||
source_hint: Silent Slayer - Vault of the Vampire
|
||||
@@ -5,6 +5,8 @@ notes: Needed the LAUNCHER category fix.
|
||||
details: Source APK is a community 'patch+savefix+90Hz' build. Shares Vader Immortal's Unreal 4 Oculus input (GitHub
|
||||
49) - thumbs follow the touches (frame.unreal_thumb_touch) and controller poses are located at the right time
|
||||
(pose_time_fix); added 2026-10-09 from Vader's headset results, not yet checked in this game.
|
||||
sync_guard added 2026-10-11 for a vrclient xrSyncActions crash on the loading splash after the intro (GitHub
|
||||
#188; the same runtime race as Myst).
|
||||
tested_version: '1.0'
|
||||
engine: Unreal
|
||||
xr: VrApi
|
||||
@@ -14,10 +16,11 @@ frame:
|
||||
- frame.unreal_thumb_touch
|
||||
adapter:
|
||||
pose_time_fix: 1
|
||||
sync_guard: 1
|
||||
verified:
|
||||
date: '2026-09-28'
|
||||
overport_cli: 1.2.3
|
||||
overport_runtime: 3.4.3-23204ea
|
||||
known_good_sha256: 4ce6e3563da131e288645f4b62a634ac98043e55bc42b7c0ad5f461207d5f53c
|
||||
updated: '2026-10-09'
|
||||
updated: '2026-10-11'
|
||||
source_hint: Robo Recall- Unplugged
|
||||
@@ -0,0 +1,24 @@
|
||||
package: com.drawandcode.TaskmasterVR
|
||||
title: Taskmaster
|
||||
status: works
|
||||
notes: Launched and played a few tasks. Seems to work pretty much flawlessly other than some occasionally finicky
|
||||
grip detection - very possible that this is just the game itself though
|
||||
tested_version: 1.0.17557.29562
|
||||
engine: Unity
|
||||
xr: OpenXR
|
||||
frame:
|
||||
- frame.unity_text_input
|
||||
- frame.oculusos
|
||||
device:
|
||||
- device.text_input_window
|
||||
adapter:
|
||||
haptic_fix: 1
|
||||
verified:
|
||||
date: '2026-10-11'
|
||||
known_good_sha256: e3b3c49d77284afb76e9f960828cbfaa4250d66c11b7fd9e4053d489aca662ae
|
||||
app: 1.0.0
|
||||
overport_cli: 1.2.5
|
||||
frame_build: '20261007.6125817'
|
||||
agent: 78
|
||||
issue: 183
|
||||
source_hint: Taskmaster VR
|
||||
@@ -0,0 +1,20 @@
|
||||
package: com.innerspacevr.afishermanstale
|
||||
title: Fisherman
|
||||
status: issues
|
||||
notes: Loading screens have corruption, but everything works otherwise.
|
||||
tested_version: '1.087'
|
||||
engine: Unreal
|
||||
xr: VrApi
|
||||
alt_overport:
|
||||
- patch_remove_unreal_force_quit
|
||||
adapter:
|
||||
haptic_fix: 1
|
||||
verified:
|
||||
date: '2026-10-11'
|
||||
known_good_sha256: c645ca6321845bd460b4ff1b8ac871e941adb26d280cccba0285e79e4a96a231
|
||||
app: 0.12.0
|
||||
overport_cli: 1.2.5
|
||||
frame_build: '20261007.6125817'
|
||||
agent: 59
|
||||
issue: 175
|
||||
source_hint: A Fisherman's Tale
|
||||
@@ -1,13 +1,12 @@
|
||||
package: com.owlchemylabs.jobsimulator
|
||||
title: Job Simulator
|
||||
status: works
|
||||
notes: 'Without Lepton''s Android window: with it, the hands froze after a few seconds (GitHub #193).'
|
||||
tested_version: 1.4.0.6515
|
||||
engine: Unity
|
||||
xr: OpenXR
|
||||
frame:
|
||||
frame_remove:
|
||||
- frame.unity_text_input
|
||||
device:
|
||||
- device.text_input_window
|
||||
verified:
|
||||
date: '2026-10-03'
|
||||
known_good_sha256: 64638d7f93bb93cc61f422a43a08bb0d35b9bb4b463e90a42da7002147f03d1b
|
||||
@@ -16,4 +15,5 @@ verified:
|
||||
frame_build: '20260930.6234839'
|
||||
agent: 33
|
||||
issue: 11
|
||||
updated: '2026-10-11'
|
||||
source_hint: Job Simulator
|
||||
@@ -1,14 +1,13 @@
|
||||
package: com.owlchemylabs.vacationsimulator
|
||||
title: Vacation Simulator
|
||||
status: issues
|
||||
notes: Controllers aren't tracked (reported; not yet diagnosed).
|
||||
status: works
|
||||
notes: 'Without Lepton''s Android window: with it (or after clicking it), the hands stayed on the floor (GitHub
|
||||
#163).'
|
||||
tested_version: 1.3.0.40142
|
||||
engine: Unity
|
||||
xr: OpenXR
|
||||
frame:
|
||||
frame_remove:
|
||||
- frame.unity_text_input
|
||||
device:
|
||||
- device.text_input_window
|
||||
adapter:
|
||||
haptic_fix: 1
|
||||
refresh_rate: 90.0
|
||||
@@ -20,4 +19,5 @@ verified:
|
||||
frame_build: '20261007.6125817'
|
||||
agent: 59
|
||||
issue: 163
|
||||
updated: '2026-10-11'
|
||||
source_hint: com.owlchemylabs.vacationsimulator
|
||||
@@ -0,0 +1,24 @@
|
||||
package: com.schellgames.ieytd3
|
||||
title: IEYTD3
|
||||
status: works
|
||||
tested_version: 1.0.1.211419 (ReleaseCandidate_1.0.0_QuestStore)
|
||||
engine: Unity
|
||||
xr: VrApi
|
||||
frame:
|
||||
- frame.unity_no_msaa
|
||||
- frame.unity_text_input
|
||||
- frame.unity_runtime_msaa_off
|
||||
- frame.unity_gl_shim
|
||||
device:
|
||||
- device.text_input_window
|
||||
adapter:
|
||||
haptic_fix: 1
|
||||
verified:
|
||||
date: '2026-10-11'
|
||||
known_good_sha256: 06f901ae22f7c07a79e11fc1af6b3941a51bbc99624336d6a0939f9593f3bfa0
|
||||
app: 0.12.1.dev263
|
||||
overport_cli: 1.2.5
|
||||
frame_build: '20261007.6125817'
|
||||
agent: 78
|
||||
issue: 181
|
||||
source_hint: 2026-10-08T23-57-41.310Z_211419
|
||||
@@ -481,6 +481,13 @@ signatures:
|
||||
the video was decoded in software instead, which is slow for 4K/8K. Turn off hardware video decoding in Steam's
|
||||
settings, restart Steam, then start the game again.
|
||||
suggest: []
|
||||
# Launch tests run without a worn headset. Some parts give up on tracking after a while and end the VR session; what
|
||||
# the game does after that (often a crash in the GPU driver while its renderer tears down) never happens in the
|
||||
# headset. In a launch test that already had paced frames before such a line, a later exit or crash still passes,
|
||||
# with a note (finding `headless-end`). Play sessions ignore this list.
|
||||
headless_end:
|
||||
- label: the VrApi bridge's 30 s tracking deadline
|
||||
pattern: 'EnterVrMode: no tracked head pose before deadline'
|
||||
milestones: # progress markers, in order; the furthest one reached is reported
|
||||
- {id: pcvr-launch, kind: pcvr, pattern: 'FramePort: launching|Launched injector with', label: Launcher started}
|
||||
- {id: pcvr-oculus-hmd, kind: pcvr, pattern: 'FramePort oculushmd: OculusHMDConnected event ready', label: Oculus headset event provided}
|
||||
|
||||
+144
-4
@@ -55,10 +55,150 @@ AXRB/ ← AXRB's download folder (Downloads/AX
|
||||
- **Several backups of one game:** FramePort uses the newest one. To use another, scan just that backup's folder.
|
||||
- **AXRB's patched builds** (`patched/`, `*-axrb.apk`) are converted for AXRB's PC runtime and lack the game's data, so
|
||||
FramePort skips them and, on the next scan, replaces a game that was added from one with the original download.
|
||||
- **AXRB export ZIPs:** unzip first. A game's ZIP holds `base.apk` and `Android/obb/<package>/`, which FramePort finds
|
||||
as is.
|
||||
- **The game page says the data file (.obb) is missing** although you have one: the backup didn't include it (copy
|
||||
- **AXRB export ZIPs:** unpack them first. A game's ZIP holds `base.apk` and `Android/obb/<package>/`, which FramePort
|
||||
finds as is.
|
||||
- **"Game data (.obb) is missing" on the game's page** although you have the file: the backup didn't include it (copy
|
||||
the game's `Android/obb/<package>` folder from the Quest with SideQuest), or it sits in a folder FramePort doesn't
|
||||
look in. Then use the layout in the previous answer.
|
||||
- **The game starts and stops at once (Steam shows Resume):** add the game again from its original download or
|
||||
backup, click **Update on Frame**, then **Report a problem…** on its page if it still stops.
|
||||
backup, click **Update on Frame**, then report it (last answer on this page) if it still stops.
|
||||
|
||||
## Where are a game's settings in FramePort?
|
||||
|
||||
Every game has three places; the answers below refer to them.
|
||||
|
||||
- **Game settings:** right-click the game in the **Library** → **Game settings…**. Sharpness, refresh rate,
|
||||
controllers, menus and more, in plain words. Changes apply the next time the game starts.
|
||||
- **Patches:** click the game in the **Library** to open its page, then **Customize** (in the **Patches** section).
|
||||
Turn a patch on or off, then click **Update on Frame** at the top of the page.
|
||||
- **The game's menu:** the **…** button at the top of its page (or right-click in the Library → **More actions…**).
|
||||
It has **Reset to suggested recipe…** and **Report a problem…**, among others.
|
||||
|
||||
The sidebar has two tabs for troubleshooting: **Monitor** (the running game's frame rate, CPU and graphics) and
|
||||
**Files** (each installed game's storage on the Frame, under **Game storage**).
|
||||
|
||||
## A game doesn't work right. Where do I start?
|
||||
|
||||
1. **Update FramePort** (it offers updates itself; Settings → Updates), then open the game's page: if it shows
|
||||
**Update on Frame**, click it. Recipes and patches improve often.
|
||||
2. **Read the game's page.** The last launch test and your last play session (**Last session**) leave their result
|
||||
there, often with a suggested patch or setting and a button that applies it. Try that first.
|
||||
3. **Changed patches yourself?** The game's menu → **Reset to suggested recipe…** brings back the tested ones.
|
||||
4. **Find your symptom below.** Each answer says how to tell what's wrong and what to do.
|
||||
5. **Still stuck?** Report it (last answer on this page).
|
||||
|
||||
## The game doesn't start, or stops right away
|
||||
|
||||
How to tell: the game's page shows the last launch test's result (**Last launch test:** …) with an explanation, and
|
||||
Steam returns to **Play** or **Resume** within seconds.
|
||||
|
||||
- **"Game data (.obb) is missing"** on the game's page: FramePort didn't find the game's data files, so they never
|
||||
reached the Frame.
|
||||
1. Find the game's `.obb` files (named like `main.<version>.<package>.obb`).
|
||||
2. Put them in a folder named exactly the package name (shown in the file names) next to the game's APK, as in the
|
||||
first answer on this page.
|
||||
3. Library → **Add games** → **Scan a folder…** and pick the game's folder.
|
||||
4. Open the game's page and click **Update on Frame**.
|
||||
- **"Lepton didn't start the game this time"**, or it failed only on the first start after an install: click **Play**
|
||||
again.
|
||||
- **"This game is 32-bit only"**: the Frame can't run 32-bit apps, and no patch changes that. Look for a PC VR version
|
||||
of the game.
|
||||
- **"The game quit itself right after starting"**: open the game's page and click **Update on Frame** so the suggested
|
||||
patches apply (many games check for a Quest at start, and a patch removes that).
|
||||
- **Nothing like that, or it still fails:** report it.
|
||||
|
||||
## It hangs on a logo, a black screen or a loading screen
|
||||
|
||||
How to tell what it's doing: leave it running and open **Monitor** in FramePort's sidebar.
|
||||
|
||||
- **CPU or graphics busy:** it's still working, often preparing its shaders on the first start. Wait up to 10 minutes
|
||||
once; the next start is quicker.
|
||||
- **CPU and graphics near zero:** it's stuck waiting for something. While it still hangs, open the game's menu →
|
||||
**Report a problem…** and save the diagnostics: that zip shows what each of the game's threads waits for (FramePort
|
||||
1.0.1 and newer), which a zip saved after quitting can't. Attach it to the report.
|
||||
- **The game starts with a video** and hangs at its logo: game page → **Customize** → turn off **Hardware video
|
||||
decoding** → **Update on Frame**, and try again.
|
||||
|
||||
## The picture is wrong
|
||||
|
||||
Most picture problems have a setting or a patch. Change one thing at a time, then start the game again (patches also
|
||||
need **Update on Frame**).
|
||||
|
||||
| You see | Try |
|
||||
|---|---|
|
||||
| Something shows in one eye only, or one eye is gray (Unity games) | Game page → **Customize** → [Unity: render each eye separately](PATCHES.md#frame-unity_multipass) |
|
||||
| Left and right look swapped (depth feels wrong) | **Game settings…** → **Swap eyes** |
|
||||
| Textures flicker, objects pop in and out | **Game settings…** → **Turn off space warp** |
|
||||
| One eye shimmers while menus look steady | Game page → **Customize** → **Eye-tracked foveation (Valve)**: **Fixed**, else **Off** |
|
||||
| Menus or screens upside down | **Game settings…** → **Fix upside-down menus** |
|
||||
| Curved menus or video screens missing | **Game settings…** → **Show curved menus and screens** |
|
||||
| Blurry | **Game settings…** → raise **Sharpness** (costs frame rate) |
|
||||
|
||||
The [patch reference](PATCHES.md) lists every patch with what it does. If nothing helps, report it with a short
|
||||
description of what you see.
|
||||
|
||||
## It stutters or runs slowly
|
||||
|
||||
How to tell: open **Monitor** in the sidebar while you play. Smooth play needs the game's frame rate at the refresh
|
||||
rate (for example 72 or 90 fps).
|
||||
|
||||
- **Below the refresh rate:** right-click the game → **Game settings…** → lower **Sharpness** (for example to 0.8×) or
|
||||
pick a lower **Refresh rate**. After a session, the game's page may suggest a value.
|
||||
- **At the refresh rate but it still judders:** report it; that points to timing, not speed.
|
||||
|
||||
## The game pauses or recenters by itself
|
||||
|
||||
The Frame briefly tells games they lost focus, for example when the headset's sensor thinks you took it off.
|
||||
Right-click the game → **Game settings…**: keep **Don't pause on short interruptions** on and raise **Ignore focus
|
||||
dips up to** (for example to 2.5 s).
|
||||
|
||||
## Controllers don't work in a game
|
||||
|
||||
Right-click the game → **Game settings…**:
|
||||
|
||||
- **No controllers, or only hands:** turn on **Use controllers**.
|
||||
- **Buttons work but you can't aim at menus:** adjust **Pointer angle**.
|
||||
- **Vibration too strong:** lower **Vibration strength**.
|
||||
|
||||
## The Frame turns off or gets hot during a game
|
||||
|
||||
How to tell: if it only happens on battery and never while plugged in, it's power, not FramePort. Heavy games can
|
||||
draw more than the battery delivers, especially at lower charge, and the Frame then turns off without an error.
|
||||
|
||||
- Play plugged in, or right-click the game → **Game settings…** → lower **Sharpness** to reduce the load.
|
||||
- It also turns off while plugged in: report it. The diagnostics include the log of the boot that ended.
|
||||
|
||||
## My progress isn't saved
|
||||
|
||||
1. Quit through the game's own menu, not Steam's **Exit game**. Exit game closes the game at once, and some games only
|
||||
save when they exit normally.
|
||||
2. Check whether it saves at all: **Files** in the sidebar → under **Game storage**, the game → look at the files'
|
||||
dates. Play, save in the game, quit from its menu and look again.
|
||||
3. Nothing changes: report it.
|
||||
|
||||
Saves stay on the Frame when you update or reinstall a game.
|
||||
|
||||
## A game with mods crashes
|
||||
|
||||
How to tell: play once without mods and custom content. If it then works, a mod is the cause; the diagnostics zip
|
||||
usually names the mod's library in the crash. Report it to the mod's author, and check for a mod version that matches
|
||||
your game version.
|
||||
|
||||
## The game needs files I supply (ports, emulators, mods)
|
||||
|
||||
How to tell where they go: the game says it on screen or in its instructions, and its log names the path (in the
|
||||
diagnostics zip, `launch.log`). It's usually `Android/data/<package>/files`.
|
||||
|
||||
1. Unpack or extract the files on your PC first: these apps read folders, not disc images (`.iso`) or archives.
|
||||
2. **Files** in the sidebar → under **Game storage**, the game → open that folder → **Upload folder…** (or
|
||||
**Upload files…**). The game's menu → **Add videos and files** opens the same place.
|
||||
|
||||
In-game "choose a file" buttons don't work on the Frame, which has no file picker.
|
||||
|
||||
## How do I report a problem well?
|
||||
|
||||
1. Reproduce it once, then right away open the game's menu (**…** on its page) → **Report a problem…**. For a hang,
|
||||
do it while the game still hangs.
|
||||
2. Say what you saw in the headset and what you already tried.
|
||||
3. **Collect and open GitHub** saves a diagnostics zip and opens a prefilled game report; attach the zip to it. The
|
||||
zip holds logs, not your game files, and personal details are removed.
|
||||
+28
-16
@@ -2,7 +2,7 @@
|
||||
|
||||
# Patches
|
||||
|
||||
Every patch and game setting FramePort knows: 155 entries in 5 groups. A game's recipe is its chosen patches and settings; tested games get theirs from the catalog ([GAMES.md](GAMES.md)), and other games get the patches FramePort suggests from its analysis. You change them on the game page under Customize.
|
||||
Every patch and game setting FramePort knows: 156 entries in 5 groups. A game's recipe is its chosen patches and settings; tested games get theirs from the catalog ([GAMES.md](GAMES.md)), and other games get the patches FramePort suggests from its analysis. You change them on the game page under Customize.
|
||||
|
||||
Each entry says what the patch does, whether it changes the APK or only the install, when FramePort suggests it, its options, the catalog games whose recipe names it and the launch-test signatures that suggest it. Patches that are on by default are on for every game, so the catalog rarely names them.
|
||||
|
||||
@@ -11,7 +11,7 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
## Groups
|
||||
|
||||
- [Patches from OVRPort](#group-overport) (25)
|
||||
- [Steam Frame patches](#group-frame) (44)
|
||||
- [Steam Frame patches](#group-frame) (45)
|
||||
- [Game settings](#group-adapter) (65)
|
||||
- [Files and settings on the Frame](#group-device) (8)
|
||||
- [PC VR (Proton and Revive)](#group-pcvr) (13)
|
||||
@@ -39,7 +39,7 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
| [Patch Oculus detection for Unity](#patch_oculus_unity) | `patch_oculus_unity` | Patches from OVRPort | default |
|
||||
| [Patch Oculus detection for Unreal](#patch_oculus_unreal) | `patch_oculus_unreal` | Patches from OVRPort | default |
|
||||
| [Remove localized app names](#patch_remove_localized_names) | `patch_remove_localized_names` | Patches from OVRPort | default |
|
||||
| [Remove Unreal's ForceQuit](#patch_remove_unreal_force_quit) | `patch_remove_unreal_force_quit` | Patches from OVRPort | 29 |
|
||||
| [Remove Unreal's ForceQuit](#patch_remove_unreal_force_quit) | `patch_remove_unreal_force_quit` | Patches from OVRPort | 31 |
|
||||
| [Remove uses-library](#patch_remove_uses_library) | `patch_remove_uses_library` | Patches from OVRPort | default |
|
||||
| [Remove VrApi library](#patch_remove_vrapi) | `patch_remove_vrapi` | Patches from OVRPort | |
|
||||
| [Replace application label and icon](#patch_replace_icon_label) | `patch_replace_icon_label` | Patches from OVRPort | default |
|
||||
@@ -59,8 +59,9 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
| [Declare Meta-only permissions](#frame-meta_permissions) | `frame.meta_permissions` | Steam Frame patches | 1 |
|
||||
| [Meta XR Audio: skip Quest telemetry class](#frame-metaxr_telemetry) | `frame.metaxr_telemetry` | Steam Frame patches | default |
|
||||
| [Clear android:debuggable](#frame-nodebug) | `frame.nodebug` | Steam Frame patches | 3 |
|
||||
| [Oculus OS telemetry class stubs](#frame-oculusos) | `frame.oculusos` | Steam Frame patches | 13 |
|
||||
| [Oculus OS telemetry class stubs](#frame-oculusos) | `frame.oculusos` | Steam Frame patches | 14 |
|
||||
| [Fix crash when the game prepares the microphone](#frame-ovr_microphone) | `frame.ovr_microphone` | Steam Frame patches | |
|
||||
| [Keep the same Meta user between starts](#frame-ovr_stable_user) | `frame.ovr_stable_user` | Steam Frame patches | default |
|
||||
| [Trace Meta platform requests (diagnostics)](#frame-ovr_trace) | `frame.ovr_trace` | Steam Frame patches | |
|
||||
| [Platform compat (ovrMessageType_ToString)](#frame-ovrplatformcompat) | `frame.ovrplatformcompat` | Steam Frame patches | default |
|
||||
| [Stub missing Meta platform functions](#frame-ovrstubs) | `frame.ovrstubs` | Steam Frame patches | default |
|
||||
@@ -70,12 +71,12 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
| [Start straight in VR (skip the 2D launcher)](#frame-start_activity) | `frame.start_activity` | Steam Frame patches | |
|
||||
| [Allow swapchains larger than 4096 px](#frame-swapchain_limit) | `frame.swapchain_limit` | Steam Frame patches | default |
|
||||
| [Team Beef ports: treat the Frame as a Meta headset](#frame-tbxr_vendor) | `frame.tbxr_vendor` | Steam Frame patches | 1 |
|
||||
| [GL shim for Unity (no multisampled render-to-texture)](#frame-unity_gl_shim) | `frame.unity_gl_shim` | Steam Frame patches | 11 |
|
||||
| [GL shim for Unity (no multisampled render-to-texture)](#frame-unity_gl_shim) | `frame.unity_gl_shim` | Steam Frame patches | 12 |
|
||||
| [Unity: render each eye separately (no multiview)](#frame-unity_multipass) | `frame.unity_multipass` | Steam Frame patches | 1 |
|
||||
| [Unity: disable MSAA](#frame-unity_no_msaa) | `frame.unity_no_msaa` | Steam Frame patches | 6 |
|
||||
| [Unity: disable MSAA](#frame-unity_no_msaa) | `frame.unity_no_msaa` | Steam Frame patches | 7 |
|
||||
| [Unity: skip OVROverlay layers (fades, splash screens)](#frame-unity_no_overlay_copy) | `frame.unity_no_overlay_copy` | Steam Frame patches | 2 |
|
||||
| [Unity: start VR without Meta's system apps](#frame-unity_oculus_check) | `frame.unity_oculus_check` | Steam Frame patches | 9 |
|
||||
| [Unity: keep MSAA off at runtime (OVRManager)](#frame-unity_runtime_msaa_off) | `frame.unity_runtime_msaa_off` | Steam Frame patches | 16 |
|
||||
| [Unity: keep MSAA off at runtime (OVRManager)](#frame-unity_runtime_msaa_off) | `frame.unity_runtime_msaa_off` | Steam Frame patches | 17 |
|
||||
| [Make Unity text fields work](#frame-unity_text_input) | `frame.unity_text_input` | Steam Frame patches | 56 |
|
||||
| [Unity: headset always counts as worn](#frame-unity_user_presence) | `frame.unity_user_presence` | Steam Frame patches | 1 |
|
||||
| [GL shim for Unreal (no multisampled render-to-texture)](#frame-unreal_gl_shim) | `frame.unreal_gl_shim` | Steam Frame patches | 1 |
|
||||
@@ -113,7 +114,7 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
| [GL shim: high-precision vertex shaders](#adapter-gl_highp_markers) | `adapter.gl_highp_markers` | Game settings | 1 |
|
||||
| [GL shim: integer vertex inputs](#adapter-gl_int_attribs) | `adapter.gl_int_attribs` | Game settings | 1 |
|
||||
| [Flat panel diagnostics (log)](#adapter-gl_mv_debug) | `adapter.gl_mv_debug` | Game settings | |
|
||||
| [Fix freezes when controllers vibrate](#adapter-haptic_fix) | `adapter.haptic_fix` | Game settings | 40 |
|
||||
| [Fix freezes when controllers vibrate](#adapter-haptic_fix) | `adapter.haptic_fix` | Game settings | 44 |
|
||||
| [Vibration strength](#adapter-haptic_scale) | `adapter.haptic_scale` | Game settings | |
|
||||
| [Turn off space warp](#adapter-hide_space_warp) | `adapter.hide_space_warp` | Game settings | 4 |
|
||||
| [Controller input diagnostics (log)](#adapter-input_diag) | `adapter.input_diag` | Game settings | |
|
||||
@@ -145,7 +146,7 @@ Link to an entry with its id, dots replaced by dashes: `PATCHES.md#frame-unity_t
|
||||
| [Native video surfaces (Batman renderer)](#adapter-surface_native) | `adapter.surface_native` | Game settings | 1 |
|
||||
| [Swap eyes](#adapter-swap_eyes) | `adapter.swap_eyes` | Game settings | |
|
||||
| [Retry refused picture formats](#adapter-swapchain_fix) | `adapter.swapchain_fix` | Game settings | |
|
||||
| [Steady controller input after focus](#adapter-sync_guard) | `adapter.sync_guard` | Game settings | 2 |
|
||||
| [Steady controller input after focus](#adapter-sync_guard) | `adapter.sync_guard` | Game settings | 3 |
|
||||
| [Hide Vulkan foveation](#adapter-vk_hide_fdm) | `adapter.vk_hide_fdm` | Game settings | 1 |
|
||||
| [Stop objects popping in and out](#adapter-vk_query_slots) | `adapter.vk_query_slots` | Game settings | |
|
||||
| [Vulkan shader dump (diagnostics)](#adapter-vk_shader_dump) | `adapter.vk_shader_dump` | Game settings | |
|
||||
@@ -406,7 +407,7 @@ Stops some Unreal games from closing themselves right after starting.
|
||||
- `patch_remove_unreal_force_quit`
|
||||
- **Changes:** Changes the APK (during the OVRPort conversion).
|
||||
- **Offered (off):** Built as the alternate APK for Unreal games (use it if the game quits itself).
|
||||
- **Catalog games (29):** Asgard's Wrath 2, BARTENDER VR SIMULATOR, Carve Snowboarding, Creed, Espire 1: VR Operative (Quest Edition), Espire 2, ExploreVR, In Death: Unchained and 21 more.
|
||||
- **Catalog games (31):** Asgard's Wrath 2, BARTENDER VR SIMULATOR, Carve Snowboarding, Creed, Espire 1: VR Operative (Quest Edition), Espire 2, ExploreVR, Fisherman and 23 more.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `force-quit` (error): The game quit itself right after starting.
|
||||
- **Source:** [patches/overport.py](../src/frameport/patches/overport.py)
|
||||
@@ -667,7 +668,7 @@ Provides stand-ins for Quest system calls some games make at start.
|
||||
- **Suggested (on):** The Unreal build of Meta XR Audio looks up com.oculus.os.AnalyticsEvent and aborts without it (for example NOPE Challenge).
|
||||
- **Suggested (on):** Several Meta SDK libraries look up com.oculus.os.AnalyticsEvent (…); games like this abort without the stub (for example Nano).
|
||||
- **Offered (off):** … references com.oculus.os.AnalyticsEvent; usually harmless (for example Batman: Arkham Shadow and LEGO Bricktales run without it). Enable if the game aborts with ClassNotFoundException.
|
||||
- **Catalog games (13):** AgeOfJoy, AllInOneSports, Caves, Deep Cuts, Does it Stack?, Nano, NOPE CHALLENGE, RC Pilot Trainer and 5 more.
|
||||
- **Catalog games (14):** AgeOfJoy, AllInOneSports, Caves, Deep Cuts, Does it Stack?, Nano, NOPE CHALLENGE, RC Pilot Trainer and 6 more.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `oculus-os-class` (fatal): The game looks up a Quest-only system class and aborts.
|
||||
- **Source:** [patches/frame/telemetry.py](../src/frameport/patches/frame/telemetry.py)
|
||||
@@ -687,6 +688,17 @@ Stops a crash a few seconds after the logo in games with voice chat.
|
||||
|
||||
> OVRPort's Meta platform library opens the microphone only when it's started, but answers a game's question about the microphone buffer size from that not-yet-opened stream: games that ask first (Unreal's Oculus voice chat, for example The Walking Dead: Saints & Sinners Ch. 2) crash a few seconds after the logo (SIGSEGV in libaaudio.so). Adds the missing check (size 0 until the microphone is started).
|
||||
|
||||
### <a id="frame-ovr_stable_user"></a>Keep the same Meta user between starts
|
||||
|
||||
Keeps your progress in games that file their saves under your Meta user.
|
||||
|
||||
- `frame.ovr_stable_user` · on by default
|
||||
- **Changes:** Changes the APK (a rebuild and reinstall apply it).
|
||||
- **Suggested (on):** The game uses Meta's platform library: OVRPort's version gives it a new user id at every start, which loses saves filed under that id.
|
||||
- **Source:** [patches/frame/ovr_stable_user.py](../src/frameport/patches/frame/ovr_stable_user.py)
|
||||
|
||||
> Without a Meta account, OVRPort's platform library makes up a new user id at every start (ovr_GetLoggedInUserID). Games that file saves under the user id (for example Walkabout Mini Golf) then start with an empty profile each time and seem to lose all progress. Gives the game a fixed id instead, different for each game and each FramePort user.
|
||||
|
||||
### <a id="frame-ovr_trace"></a>Trace Meta platform requests (diagnostics)
|
||||
|
||||
For troubleshooting: records the game's requests to Meta's online services.
|
||||
@@ -811,7 +823,7 @@ Stops a gray or frozen screen in Unity games that turn on anti-aliasing while ru
|
||||
- `frame.unity_gl_shim`
|
||||
- **Changes:** Changes the APK (a rebuild and reinstall apply it).
|
||||
- **Suggested (on):** Unity GLES game that may switch to MSAA at runtime: hide multisampled render-to-texture, which crashes the Frame's GL driver (for example The Room VR).
|
||||
- **Catalog games (11):** Audica, BattleSisters, Beat Saber, Clockwork, Cosmodread, Down the Rabbit Hole, End Space, Gravity Lab and 3 more.
|
||||
- **Catalog games (12):** Audica, BattleSisters, Beat Saber, Clockwork, Cosmodread, Down the Rabbit Hole, End Space, Gravity Lab and 4 more.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `unreal-msrtt-crash` (fatal): The game's graphics crashed a few seconds after start.
|
||||
- **Source:** [patches/frame/vrapi_bridge.py](../src/frameport/patches/frame/vrapi_bridge.py)
|
||||
@@ -838,7 +850,7 @@ Turns off a smoothing setting that crashes some older Unity games on the Frame.
|
||||
- **Changes:** Changes the APK (a rebuild and reinstall apply it).
|
||||
- **Suggested (on):** Legacy VrApi Unity game on GLES with MSAA (… quality levels): multisampled render-to-texture hangs the Frame's GL driver (for example Sniper Elite VR).
|
||||
- **Offered (off):** GLES Unity game with MSAA on (… quality levels); enable if it hangs the GPU ('zink: DEVICE LOST').
|
||||
- **Catalog games (6):** Audica, BattleSisters, Jurassic World Aftermath Collection, Sniper Elite VR, SUPERHOT VR, The Room VR.
|
||||
- **Catalog games (7):** Audica, BattleSisters, IEYTD3, Jurassic World Aftermath Collection, Sniper Elite VR, SUPERHOT VR, The Room VR.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `zink-device-lost` (fatal): The GPU hung, so the game froze or closed.
|
||||
- **Source:** [patches/frame/unity_no_msaa.py](../src/frameport/patches/frame/unity_no_msaa.py)
|
||||
@@ -880,7 +892,7 @@ Keeps a smoothing setting off that the game turns on itself and that can freeze
|
||||
- `frame.unity_runtime_msaa_off` · revision 2
|
||||
- **Changes:** Changes the APK (a rebuild and reinstall apply it).
|
||||
- **Suggested (on):** GLES Unity game whose OVRManager turns 4x MSAA on at runtime: multisampled render-to-texture can hang the Frame's GPU.
|
||||
- **Catalog games (16):** Audica, BattleSisters, Beat Saber, Clockwork, Cosmodread, Down the Rabbit Hole, End Space, Gravity Lab and 8 more.
|
||||
- **Catalog games (17):** Audica, BattleSisters, Beat Saber, Clockwork, Cosmodread, Down the Rabbit Hole, End Space, Gravity Lab and 9 more.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `unity-render-crash` (fatal): The game's graphics crashed, so the picture freezes or stays gray.
|
||||
- `unity-runtime-msaa` (info): The game turns MSAA on at runtime, which can hang the Frame's GPU.
|
||||
@@ -1424,7 +1436,7 @@ For games that freeze the Frame when a controller vibrates (for example Lucky's
|
||||
- **Options:**
|
||||
- Value: int, default `0`.
|
||||
- Game settings → Controllers → "Fix freezes when controllers vibrate" (advanced).
|
||||
- **Catalog games (40):** AgeOfJoy, Ancient_Dungeon, Audica, BattleSisters, Caves, Clockwork, Cosmodread, cubism and 32 more.
|
||||
- **Catalog games (44):** AgeOfJoy, Ancient_Dungeon, Audica, BattleSisters, Caves, Clockwork, Cosmodread, cubism and 36 more.
|
||||
- **Source:** [patches/settings.py](../src/frameport/patches/settings.py)
|
||||
|
||||
> Routes OVRPlugin through FramePort's extension shim, which turns Meta's amplitude-envelope vibrations into plain ones: OVRPort's loader reads their nanosecond duration as seconds and allocates gigabytes, freezing the Frame when the game vibrates a controller (for example Lucky's Tale's save slots, GitHub #9). Needs a rebuild.
|
||||
@@ -1893,7 +1905,7 @@ For games that crash right after you return to them (for example after the Steam
|
||||
- **Options:**
|
||||
- Value: int, default `0`.
|
||||
- Game settings → Troubleshooting → "Steady controller input after focus" (advanced).
|
||||
- **Catalog games (2):** Batman: Arkham Shadow, Myst.
|
||||
- **Catalog games (3):** Batman: Arkham Shadow, Myst, Robo Recall.
|
||||
- **Suggested by launch-test signatures:**
|
||||
- `runtime-input-crash` (fatal): The Frame's runtime crashed in its controller code, usually right after the game got focus. sync_guard runs input syncs (xrSyncActions) one at a time and pauses them briefly after focus returns.
|
||||
- **Source:** [patches/settings.py](../src/frameport/patches/settings.py)
|
||||
|
||||
@@ -31,7 +31,9 @@ version is `catalog/triage.yaml` (used by `frameport test` / the Job screen); ke
|
||||
| An overlay app (fpsVR, a wrist watch) installed on the Frame never appears, or SteamVR doesn't start it | not registered with the Frame's SteamVR, or registered with a manifest SteamVR skips: on the Frame vrserver reads only `binary_path_linux_arm` (vrserver.txt: "must specify binary_path for launch_type binary. Skipping") | `pcvr.vr_overlay` (Windows) / a Linux app with a bundled `.vrmanifest` (`is_dashboard_overlay`): agent v75 `register_vr_overlay` (check `vrcmd --overlays`, `~/.config/openvr/config/appconfig.json` manifest_paths); the app's own `--install` writes binary_path_linux only. fpsVR under Proton never loads OpenVR (quits after 60 s): unsupported for now |
|
||||
| An overlay app with **Start with SteamVR** on doesn't start by itself after the Frame or SteamVR starts (it works when started by hand) | SteamVR's own auto-launch flag (SetApplicationAutoLaunch) didn't persist on the Frame (no autolaunch entry in `~/.config/openvr/config/steamvr.vrsettings`) | agent v76: FramePort's service `frameport-vr-overlays.service` starts it at every new vrserver. Check `systemctl --user status frameport-vr-overlays`, `~/.local/share/frameport/vr-overlays.log` (`new SteamVR (vrserver N)` → `<pkg>: started` / `running` / `couldn't start it: …`), the deployment's `overlay.autostart`, and that `~/.local/share/frameport/vr-overlays.disabled` doesn't exist; `frameport frame info` (ensure_host_fixes) installs a missing service |
|
||||
| Every game suddenly fails to start: `crun: create keyring …: Disk quota exceeded`, `is not a running context` | rootless podman leaked a kernel keyring per launch; 200-key quota exhausted | `keyring = false` in `~/.config/containers/containers.conf` (FramePort agent does it), then reboot the Frame once |
|
||||
| Launch test "failed" although the game runs in the headset: frames paced, then `OVRPortVrApi: EnterVrMode: no tracked head pose before deadline`, then a crash (e.g. `zink: DEVICE LOST` + SIGSEGV in a `gdrv` thread) (GitHub #57, BlazeRush) | the VrApi bridge ends the VR session after 30 s without head tracking, which only happens without a worn headset; the game's renderer then crashes while tearing down | none needed: launch tests (`triage(..., headless=True)`) treat an exit or crash after a `headless_end` line (catalog/triage.yaml) as a pass when frames were paced before it (info finding `headless-end`); play sessions ignore it. Add new such markers to `headless_end` |
|
||||
| Launch test EXITED, launch.log has `Target app (<pkg>) did not start` and no `Start proc …:<pkg>` (GitHub #179) | Lepton occasionally doesn't start the app on the first start after an APK change; Android's `WebViewLoader-: System.exit` at boot is not the game (triage `app-not-started`) | start it again |
|
||||
| A game keeps no progress between starts although it saves (its storage gets a new `Profiles/Oculus/<id>/`-style folder per start; Walkabout Mini Golf, GitHub #182) | OVRPort's platform loader answers `ovr_GetLoggedInUserID` with a made-up id (6e18 + `random()`), new at every start; games file saves under the user id | `frame.ovr_stable_user` (default for games with the platform library): a fixed id per game and keystore. Old progress: copy the newest old profile into the new id's folder |
|
||||
| A Unity app's text field shows a caret for a moment and loses focus; no keyboard appears (for example Stremio VR login) | Unity's TMP_InputField/InputField wait for Android's on-screen keyboard and close themselves without one (Lepton has none); headless VR apps also have no focused Android window, so no key press reaches them | `frame.unity_text_input` (Cpp2IL finds `TouchScreenKeyboardShouldBeUsed`/`isKeyboardUsingEvents`, rewritten to false/true) + `device.text_input_window` (lepton-show-flatscreen: Steam's keyboard and Type on Frame work) |
|
||||
| Play gives Steam's "Game configuration unavailable"; Steam's console_log: `GameAction [AppID <id>] … RequestingLicense → UpdatingAppInfo → LaunchApp failed with AppError_9` | this Frame's Steam never loaded FramePort's shortcuts.vdf entry (it treats the id as a store app); cause unknown (GitHub #21/#30) | automatic since agent v43: Play registers the game through Steam's devkit interface ("Devkit Game: …", `devkit_register`) and starts that; uninstall removes it. Agent v58: a devkit entry Steam forgot after a restart is added again live on Play (no NOT_IN_LIBRARY → no Steam restart), and installs/art updates of devkit games only copy art (no Steam restart, GitHub #41) |
|
||||
| Steam's Exit game leaves the game running (container `lepton-steamlaunch-<appid>` still up) | Steam stopped only its `reaper`; launch.sh and Lepton (setsid) never got a signal (GitHub #36) | agent v44: launch.sh's 2 s loop ends the game when its parent is gone (`upgrade_launchers` adds it to existing launchers); by hand: `podman kill lepton-steamlaunch-<appid>` |
|
||||
|
||||
@@ -149,6 +149,7 @@ def main() -> int:
|
||||
("transit-activity", lambda a: a.show_activity(True))]
|
||||
if args.fake_frame: # GitHub #90: the Move to… dialog (drives load in the background)
|
||||
steps.append(("move-dialog", lambda a: (a.page.pop_dialog(), a.move_game(game))))
|
||||
steps.append(("uninstall-dialog", lambda a: (a.page.pop_dialog(), a.uninstall(game))))
|
||||
# last: the right-click menu stays open over whatever comes next
|
||||
steps.append(("library-menu", lambda a: (a.show_activity(False), a.navigate(0), time.sleep(3),
|
||||
a.library_view.open_menu(game))))
|
||||
|
||||
@@ -1,14 +1,23 @@
|
||||
{
|
||||
"updated": "2026-10-10",
|
||||
"updated": "2026-10-11",
|
||||
"people": [
|
||||
{
|
||||
"login": "spoopyghosty0",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/336754034?v=4",
|
||||
"url": "https://github.com/spoopyghosty0",
|
||||
"commits": 462,
|
||||
"commits": 523,
|
||||
"issues": 4,
|
||||
"prs": 2,
|
||||
"total": 484
|
||||
"prs": 3,
|
||||
"total": 550
|
||||
},
|
||||
{
|
||||
"login": "StevenPartridge",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/22158507?v=4",
|
||||
"url": "https://github.com/StevenPartridge",
|
||||
"commits": 0,
|
||||
"issues": 15,
|
||||
"prs": 0,
|
||||
"total": 45
|
||||
},
|
||||
{
|
||||
"login": "tkp206093",
|
||||
@@ -19,15 +28,6 @@
|
||||
"prs": 0,
|
||||
"total": 45
|
||||
},
|
||||
{
|
||||
"login": "StevenPartridge",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/22158507?v=4",
|
||||
"url": "https://github.com/StevenPartridge",
|
||||
"commits": 0,
|
||||
"issues": 14,
|
||||
"prs": 0,
|
||||
"total": 42
|
||||
},
|
||||
{
|
||||
"login": "Klownicle",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/6896081?v=4",
|
||||
@@ -100,6 +100,24 @@
|
||||
"prs": 0,
|
||||
"total": 15
|
||||
},
|
||||
{
|
||||
"login": "eepykith",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/338898488?v=4",
|
||||
"url": "https://github.com/eepykith",
|
||||
"commits": 0,
|
||||
"issues": 4,
|
||||
"prs": 0,
|
||||
"total": 12
|
||||
},
|
||||
{
|
||||
"login": "nickwilde77555",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/180547421?v=4",
|
||||
"url": "https://github.com/nickwilde77555",
|
||||
"commits": 0,
|
||||
"issues": 4,
|
||||
"prs": 0,
|
||||
"total": 12
|
||||
},
|
||||
{
|
||||
"login": "Rizsraketa",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/64963535?v=4",
|
||||
@@ -127,6 +145,15 @@
|
||||
"prs": 0,
|
||||
"total": 12
|
||||
},
|
||||
{
|
||||
"login": "trankillity",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/53357041?v=4",
|
||||
"url": "https://github.com/trankillity",
|
||||
"commits": 0,
|
||||
"issues": 4,
|
||||
"prs": 0,
|
||||
"total": 12
|
||||
},
|
||||
{
|
||||
"login": "xhuytox",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/20061642?v=4",
|
||||
@@ -163,15 +190,6 @@
|
||||
"prs": 0,
|
||||
"total": 9
|
||||
},
|
||||
{
|
||||
"login": "eepykith",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/338898488?v=4",
|
||||
"url": "https://github.com/eepykith",
|
||||
"commits": 0,
|
||||
"issues": 3,
|
||||
"prs": 0,
|
||||
"total": 9
|
||||
},
|
||||
{
|
||||
"login": "m4ddh7jm7c-bit",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/338352097?v=4",
|
||||
@@ -227,18 +245,18 @@
|
||||
"total": 6
|
||||
},
|
||||
{
|
||||
"login": "nickwilde77555",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/180547421?v=4",
|
||||
"url": "https://github.com/nickwilde77555",
|
||||
"login": "puppet-head",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/8073775?v=4",
|
||||
"url": "https://github.com/puppet-head",
|
||||
"commits": 0,
|
||||
"issues": 2,
|
||||
"prs": 0,
|
||||
"total": 6
|
||||
},
|
||||
{
|
||||
"login": "puppet-head",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/8073775?v=4",
|
||||
"url": "https://github.com/puppet-head",
|
||||
"login": "Sidilium",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/44266441?v=4",
|
||||
"url": "https://github.com/Sidilium",
|
||||
"commits": 0,
|
||||
"issues": 2,
|
||||
"prs": 0,
|
||||
@@ -262,6 +280,15 @@
|
||||
"prs": 1,
|
||||
"total": 6
|
||||
},
|
||||
{
|
||||
"login": "AlexanderCowell",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/225416878?v=4",
|
||||
"url": "https://github.com/AlexanderCowell",
|
||||
"commits": 0,
|
||||
"issues": 1,
|
||||
"prs": 0,
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "bcain2005-gif",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/258048498?v=4",
|
||||
@@ -334,6 +361,15 @@
|
||||
"prs": 0,
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "gnargle",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/9372593?v=4",
|
||||
"url": "https://github.com/gnargle",
|
||||
"commits": 0,
|
||||
"issues": 1,
|
||||
"prs": 0,
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "InsideCat02",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/111202797?v=4",
|
||||
@@ -389,9 +425,9 @@
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "Sidilium",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/44266441?v=4",
|
||||
"url": "https://github.com/Sidilium",
|
||||
"login": "s1lenceSRG",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/340965322?v=4",
|
||||
"url": "https://github.com/s1lenceSRG",
|
||||
"commits": 0,
|
||||
"issues": 1,
|
||||
"prs": 0,
|
||||
@@ -415,15 +451,6 @@
|
||||
"prs": 0,
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "trankillity",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/53357041?v=4",
|
||||
"url": "https://github.com/trankillity",
|
||||
"commits": 0,
|
||||
"issues": 1,
|
||||
"prs": 0,
|
||||
"total": 3
|
||||
},
|
||||
{
|
||||
"login": "TylerJaacks",
|
||||
"avatar": "https://avatars.githubusercontent.com/u/1505374?v=4",
|
||||
|
||||
@@ -17,8 +17,8 @@ export const DOCS: DocInfo[] = [
|
||||
summary: 'Install FramePort on Windows, macOS or Linux, connect your Steam Frame once, then install and play Quest and PC VR games.' },
|
||||
{ file: 'FRAME_SETUP.md', slug: 'frame-setup', name: 'What the setup changes', group: 'Get started', blurb: 'Changes on the Frame, firewalls, undoing it.',
|
||||
summary: "What FramePort's one-time setup changes on the Steam Frame, how to undo it, and what your network and firewall need." },
|
||||
{ file: 'FAQ.md', slug: 'faq', name: 'FAQ', group: 'Get started', blurb: 'Game folders and common questions.',
|
||||
summary: "Common questions about FramePort: how to lay out game folders with APK and OBB files, and what to do when a game doesn't run." },
|
||||
{ file: 'FAQ.md', slug: 'faq', name: 'FAQ', group: 'Get started', blurb: 'Game folders and fixing problems.',
|
||||
summary: "Common questions about FramePort: how to lay out game folders with APK and OBB files, where a game's settings are, and how to fix games that don't start, hang, look wrong or stutter." },
|
||||
{ file: 'COMPATIBILITY.md', slug: 'compatibility', name: 'Compatibility', group: 'Using FramePort', blurb: 'What runs on the Frame.',
|
||||
summary: 'Which Quest games, PC VR games and Android apps run on the Steam Frame with FramePort, and how to share a recipe that works.' },
|
||||
{ file: 'THEMES.md', slug: 'themes', name: 'Themes', group: 'Using FramePort', blurb: 'Color themes and making your own.',
|
||||
|
||||
@@ -444,6 +444,11 @@
|
||||
"title": "Fix crash when the game prepares the microphone",
|
||||
"group": "Steam Frame patches"
|
||||
},
|
||||
"frame.ovr_stable_user": {
|
||||
"anchor": "frame-ovr_stable_user",
|
||||
"title": "Keep the same Meta user between starts",
|
||||
"group": "Steam Frame patches"
|
||||
},
|
||||
"frame.ovr_trace": {
|
||||
"anchor": "frame-ovr_trace",
|
||||
"title": "Trace Meta platform requests (diagnostics)",
|
||||
|
||||
@@ -1,13 +1,29 @@
|
||||
{
|
||||
"updated": "2026-10-10",
|
||||
"updated": "2026-10-11",
|
||||
"releases": [
|
||||
{
|
||||
"tag": "v1.0.1",
|
||||
"name": "FramePort v1.0.1",
|
||||
"date": "2026-10-11",
|
||||
"url": "https://github.com/spoopyghosty0/frameport/releases/tag/v1.0.1",
|
||||
"dev": false,
|
||||
"notes": "FramePort v1.0.1: Windows (x64), macOS (Apple Silicon) and Linux (x64, ARM64).\n\n## What's new\n\n- **Diagnostics for games that hang:** save diagnostics while the game is stuck, and the zip shows what the game is waiting for.\n- **Clearer launch tests:** when Lepton doesn't start a game, the test says so instead of reporting that the game quit itself.\n- A reference of every patch and game setting is now in the docs.\n\nAlready have FramePort? It offers this update itself (Library → **Update now**).\n\n## Install\n\nDownload the file for your PC, unpack it and start FramePort. Guide:\n[Install and first steps](https://frameport.app/docs/install/).\n"
|
||||
},
|
||||
{
|
||||
"tag": "v1.0.0",
|
||||
"name": "FramePort v1.0.0",
|
||||
"date": "2026-10-11",
|
||||
"url": "https://github.com/spoopyghosty0/frameport/releases/tag/v1.0.0",
|
||||
"dev": false,
|
||||
"notes": "FramePort v1.0.0: Windows (x64), macOS (Apple Silicon) and Linux (x64, ARM64).\n\n## What's new\n\n- **A new look:** Portal and Original themes, an \"On your Frame\" shelf in the Library, and install progress shown as the game passing through a portal.\n- **Easier setup:** run `curl -fsSL https://frameport.app/s | bash` on the Frame and allow it on the PC. A Frame in Developer Mode pairs without a click.\n- **SteamVR overlay apps** (for example Temporal Reality) run on the Frame over your games and can start with SteamVR.\n- **More folders just work:** SideQuest backups and AXRB downloads import with their data files.\n- **Rename any game**, and the name in Steam follows.\n- **Hardware video decoding** for games that play videos (opt-in per game), a Steam Input gamepad for flat Android apps, and Godot games start.\n- **BlazeRush works** (fixes from a tester's guide), and Unreal games no longer hang on their OBB check.\n- **Play sessions are checked too:** after you play, FramePort reads the session's log and suggests fixes on the game's page.\n- **126 game recipes** (76 in 0.12.0), and fixes for Vader Immortal, VR4, Doom3Quest, Star Wars Pinball, Green Hell VR, Budget Cuts and more.\n- The update dialog lists every change since your version. Install buttons now use frameport.app links, and game reports are titled \"[Game report]\".\n\nAlready have FramePort? It offers this update itself (Library → **Update now**).\n\n## Install\n\nDownload the file for your PC, unpack it and start FramePort. Guide:\n[Install and first steps](https://frameport.app/docs/install/).\n"
|
||||
},
|
||||
{
|
||||
"tag": "dev",
|
||||
"name": "FramePort dev build 0.12.1.dev253",
|
||||
"date": "2026-10-10",
|
||||
"name": "FramePort dev build 0.12.1.dev263",
|
||||
"date": "2026-10-11",
|
||||
"url": "https://github.com/spoopyghosty0/frameport/releases/tag/dev",
|
||||
"dev": true,
|
||||
"notes": "Dev build **0.12.1.dev253** from commit ca14fad (2026-10-10). For testing fixes before\nthe next release; you get that release as a normal update.\n\n## Please test\n\nControllers as a gamepad for flat Android apps (#162, opt-in); Vulkan shader capture for GPU hangs (vk_shader_dump, #140); Update on Frame after adding a newer APK (#161); 15 new catalog entries.\n\n## Changes since v0.12.0\n\n- Steam Input gamepad for 2D Android apps (device.steam_gamepad, agent v72, GitHub #162)\n- Vulkan shim: vk_shader_dump writes the game's SPIR-V modules with a creation index (GitHub #140)\n- Triage: unity-data-missing fails a launch test when Unity can't read the game's data files (incomplete OBB or one from another version; Batman passed while st\n- Game page shows Update on Frame after a newer APK of an installed game was added (builds record the APK version they were made from; GitHub #161); triage only\n- Catalog: Eleven (Quest) and GOLF+ unsupported (Meta online services / the game's login refuse the platform), Beat Saber DLC isn't detected, Doom3Quest works (\n- Catalog: 13 shared working configs (Freedom, Zombieland VR, Caves, Ancient Dungeon, Containment Protocol, Down the Rabbit Hole, End Space, ExploreVR, Racket: \n- Shared video decoder (codec revision 8): hidden VP9 frames no longer end the EOS drain early\n- Shared video decoder: remove a game's old per-game codec folder once its launcher is converted, also when the recipe (not deployment.json) asks for hardware d\n- Shared video decoder: per game (frame.hw_video_decode) with a global off switch; 8K retry at start and VP9 fixes from the hw-video-decode branch\n- Catalog: Audica works (shared working config)\n- Uninstall dialog: option to also delete the game's saves and everything it stored on the Frame (mods, downloads); they survived every uninstall before (GitHub\n- Install on this PC works on Windows again: the agent (loaded for its VDF code) imported the POSIX-only fcntl at the top (ModuleNotFoundError for every PC VR i\n- Deploy shared hardware video decoding for compatible Lepton apps\n- Codec wrapper (PR #96): find the host's podman when Lepton calls it with the Android guest's PATH (its boot-wait, app-pid and logcat-mirror podman exec calls \n- Catalog: Doom3Quest uses frame.gl_multiview_fbo (HUD/PDA shown, no frame-rate drop: Xandrix1987's headset test, GitHub #77)\n- Catalog: cubism works (shared working config)\n- SUPERHOT VR (Quest): create its cloud save folder at install, so the launcher gives it group write permission before the very first start (the game creates an\n- Catalog: Vader Immortal III's campaign intro starts black by design (owner)\n- Catalog: Vader Immortal Episodes II and III work (owner's headset test) with Episode I's Unreal fixes (quest precompile, key map, thumb touch, pose_time_fix),\n- Docs: session triage (PLAYBOOK rows for the session findings, CLAUDE.md note incl. the pac_hints survey)\n- Triage real play sessions: the connection refresh fetches a finished session's log (agent v70) and triages it (launch-test signatures + new space-warp-used qu\n- Agent v70: session_log (the newest play session's launch.log sliced to 4 MB + its crash logcat + kernel GPU hang lines), last_play in list_installed, launch t\n- FrameBridge: always log the runtime's focus losses and returns with their length (focus: lost / back after N ms), before focus_hold hides a dip; for session t\n- Heuristics: suggest pose_time_fix for Unreal 4 games with Vader Immortal's Oculus input (the unreal_thumb_touch code match). Catalog: Phantom, Robo Recall and\n- Harden codec deployment and isolate native video hooks\n- Catalog: Clockwork (Quest), Beat Saber, Eleven: Table Tennis VR and Pistol Whip (PC VR, run directly without Revive) from shared working configs\n- Heuristics: suggest scene_emul for every game that declares Meta's USE_SCENE permission, not only mixed-reality-only ones (VR HOT's room setup retried forever\n- Agent v68: launch tests count their window from Lepton's 'Waiting for app' (up to 240 s more for boot + install). The first start after an APK change installs\n- frame.unreal_thumb_touch: UE4 OculusInput's ThumbUp from the capacitive touches instead of near-touch, which the Frame never reports (thumbs always pointed up\n- pose_time_fix: never move a recent predicted display time; monotonic times only told apart when the clocks are more than 4 display periods apart and the time \n- Lint: extraneous parentheses (ruff UP034)\n- Game page: a patch the build left out because the OVRPort runtime already has the fix (build.superseded, e.g. haptic_fix with runtime 3.4.3-aa54c3f) no longer\n- Triage: Lepton's own short lines survive the game-process filter. With the package known, game_lines dropped every line of 3 words or fewer, so Lepton's 'Boot\n- Catalog: Max Mustard is listed by its name, not its package name Matilda (GitHub #110)\n- frame.gl_multiview_fbo: single-view twins for multiview programs drawn into flat framebuffers Line truncated
|
||||
"notes": "Dev build **0.12.1.dev263** from commit dccdcaa (2026-10-11). For testing fixes before\nthe next release; you get that release as a normal update.\n\n## Please test\n\n1.0 release candidate. New since dev261: SteamVR overlay apps (for example Temporal Reality's Linux arm64 build) installed with Add a Linux app run on the Frame over your games, with a Start with SteamVR switch.\n\n## Changes since v0.12.0\n\n- SteamVR overlay apps on the Frame (agent v75)\n- Sharing: fall back to a plain issue when the form opens empty (#167)\n- Monitor: per-module collection needs agent 73 (main's 72 lacks it); correct agent versions in comments\n- serialize_flet_updates: tolerate Flet versions without Session.patch_control or Prop (log, keep the rest)\n- Issue forms: quote the descriptions so the templates are valid YAML\n- Auto pairing scan: skip container/VM/VPN interfaces and CGNAT, back off after empty scans\n- pyproject: Development Status 5 - Production/Stable\n- Catalog: Vacation Simulator starts; controllers aren't tracked yet (shared working config)\n- Catalog: The Thrill Of The Fight runs with Unity's overlay copy skipped; the right eye misses the opponent and referee (shared working config)\n- Catalog: Fruit Salon works (shared working config)\n- Auto pairing: hold off only while a setup request is open (not for allowed, denied or expired ones)\n- Docs: diagrams instead of ASCII art\n- Install links: FramePort's https://frameport.app/install?… page is the documented button link (pasted links parse too); README, docs, site and in-app texts \n- Pairing: setup requests expire when the Frame stops polling; setup.sh explains HTTP 429\n- Diagnostics: send every shader module of the newest session (#140)\n- CLI frame pair: don't announce the pairing server over mDNS (it can't answer setup-URL requests)\n- Issue reports: a game's report is titled \"[Game report] <game>\" with the game-compatibility label; reports about FramePort itself \"[App] FramePort\" with bug (\n- Setup line: curl -fsSL https://frameport.app/s (fail on HTTP errors, explicit https)\n- Site: Cloudflare and Google analytics, with a cookie choice\n- Docs: update screenshots and videos\n- Site: SEO for frameport.app\n- Site: What's new page and section from GitHub releases\n- Site: shorter, consistent copy, served at frameport.app\n- Docs: shorter, consistent copy\n- App: shorter, consistent interface text\n- Developer docs, CLI and launch-test diagnoses: consistent terms\n- Steam Input gamepad for 2D Android apps (device.steam_gamepad, agent v72, GitHub #162)\n- Wording: style word list and length rules\n- Vulkan shim: vk_shader_dump writes the game's SPIR-V modules with a creation index (GitHub #140)\n- Triage: unity-data-missing fails a launch test when Unity can't read the game's data files (incomplete OBB or one from another version; Batman passed while st\n- Game page shows Update on Frame after a newer APK of an installed game was added (builds record the APK version they were made from; GitHub #161); triage only\n- Catalog: Eleven (Quest) and GOLF+ unsupported (Meta online services / the game's login refuse the platform), Beat Saber DLC isn't detected, Doom3Quest works (\n- Catalog: 13 shared working configs (Freedom, Zombieland VR, Caves, Ancient Dungeon, Containment Protocol, Down the Rabbit Hole, End Space, ExploreVR, Racket: \n- Site: two neon worlds, a portal-first download page, one-eye live view\n- Game page: open the last launch test's log\n- Site: interactive docs, a download page, two more worlds, solid rocks\n- Site: three hero worlds, a 3D live view, a closer app trial, real screenshots\n- Install walkthrough: the setup line and Allow, in the video and on the site\n- Pair Frames in Developer Mode without a click on the PC\n- Shared video decoder (codec revision 8): hidden VP9 frames no longer end the EOS drain early\n"
|
||||
},
|
||||
{
|
||||
"tag": "v0.12.0",
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 248 KiB After Width: | Height: | Size: 229 KiB |
@@ -1,2 +1,2 @@
|
||||
# The FramePort version: the single source (pyproject reads it via hatch; CI checks a release tag matches it).
|
||||
__version__ = "1.0.1"
|
||||
__version__ = "1.0.4"
|
||||
@@ -0,0 +1,139 @@
|
||||
"""One FramePort window at a time (no Flet).
|
||||
|
||||
Two GUI processes on one data folder fought over library.json and both re-analysed the library and triaged the same
|
||||
play sessions (the Library flickered under a stream of pop-ups). The GUI holds an exclusive lock on
|
||||
`<data>/gui.lock` for its lifetime (released by the OS when the process ends, also after a crash). A second start:
|
||||
- the window is there (fresh `gui.alive` heartbeat): asks it to come to the front (`gui.focus`) and exits;
|
||||
- the lock is held but no window answers (a process left over after its window went away): ends that process (only
|
||||
when it is a FramePort GUI) and takes over.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
from .paths import user_data_dir
|
||||
|
||||
_held = None # the open lock file (kept for the process lifetime)
|
||||
|
||||
|
||||
def lock_file() -> Path:
|
||||
return user_data_dir() / "gui.lock"
|
||||
|
||||
|
||||
def focus_file() -> Path:
|
||||
return user_data_dir() / "gui.focus"
|
||||
|
||||
|
||||
def _try_lock(f) -> bool:
|
||||
try:
|
||||
if sys.platform == "win32":
|
||||
import msvcrt
|
||||
|
||||
f.seek(0)
|
||||
msvcrt.locking(f.fileno(), msvcrt.LK_NBLCK, 1)
|
||||
else:
|
||||
import fcntl
|
||||
|
||||
fcntl.flock(f.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||
return True
|
||||
except OSError:
|
||||
return False
|
||||
|
||||
|
||||
def acquire(path: Path | None = None) -> bool:
|
||||
"""Take the GUI lock; False when another process holds it."""
|
||||
global _held
|
||||
path = path or lock_file()
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
f = open(path, "a+") # noqa: SIM115 (kept open on purpose)
|
||||
if not _try_lock(f):
|
||||
f.close()
|
||||
return False
|
||||
f.seek(0)
|
||||
f.truncate()
|
||||
f.write(str(os.getpid()))
|
||||
f.flush()
|
||||
_held = f
|
||||
return True
|
||||
|
||||
|
||||
def holder(path: Path | None = None) -> int | None:
|
||||
try:
|
||||
return int((path or lock_file()).read_text().strip() or 0) or None
|
||||
except (OSError, ValueError):
|
||||
return None
|
||||
|
||||
|
||||
def _is_frameport_gui(pid: int) -> bool:
|
||||
try:
|
||||
import psutil
|
||||
|
||||
cmd = " ".join(psutil.Process(pid).cmdline()).lower()
|
||||
except Exception: # noqa: BLE001 (gone, or not ours to inspect)
|
||||
return False
|
||||
return "frameport" in cmd
|
||||
|
||||
|
||||
STARTUP_GRACE = 30.0 # a GUI this young may still be opening its window (no heartbeat yet): never end it
|
||||
|
||||
|
||||
def end_leftover(pid: int, wait: float = 5.0) -> bool:
|
||||
"""End a FramePort GUI process that has no window any more; True when it's gone."""
|
||||
if pid == os.getpid() or not _is_frameport_gui(pid):
|
||||
return False
|
||||
import psutil
|
||||
|
||||
try:
|
||||
p = psutil.Process(pid)
|
||||
if time.time() - p.create_time() < STARTUP_GRACE:
|
||||
return False
|
||||
p.terminate()
|
||||
try:
|
||||
p.wait(wait)
|
||||
except psutil.TimeoutExpired:
|
||||
p.kill()
|
||||
p.wait(wait)
|
||||
except psutil.NoSuchProcess:
|
||||
pass
|
||||
except Exception: # noqa: BLE001
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def ask_focus() -> None:
|
||||
try:
|
||||
focus_file().touch()
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def take_focus_request() -> bool:
|
||||
"""True once after another start asked the window to come to the front."""
|
||||
try:
|
||||
focus_file().unlink()
|
||||
return True
|
||||
except OSError:
|
||||
return False
|
||||
|
||||
|
||||
def claim(window_open, retries: int = 20) -> bool:
|
||||
"""Called at GUI start: True = this process is the GUI; False = another window is open (it was asked to come to
|
||||
the front). `window_open()` says whether a window answers (urlhandler.app_running)."""
|
||||
if acquire():
|
||||
return True
|
||||
if window_open():
|
||||
ask_focus()
|
||||
return False
|
||||
pid = holder()
|
||||
if pid:
|
||||
end_leftover(pid)
|
||||
for _ in range(retries): # the OS releases the lock when the process is gone
|
||||
if acquire():
|
||||
return True
|
||||
time.sleep(0.25)
|
||||
if window_open():
|
||||
ask_focus()
|
||||
return False
|
||||
@@ -10,7 +10,7 @@ from dataclasses import asdict
|
||||
from pathlib import Path
|
||||
|
||||
from .models import Analysis, Recipe
|
||||
from .paths import user_data_dir, write_atomic
|
||||
from .paths import localize, user_data_dir, write_atomic
|
||||
|
||||
# One lock for every read-modify-write of library.json: jobs, the poll thread and the UI all change it, and a change
|
||||
# made between another thread's load() and save() would be lost. Re-entrant so edit() can call load()/save().
|
||||
@@ -28,7 +28,7 @@ _updating = threading.local() # set while load() runs the migrations/catalog st
|
||||
def load() -> dict:
|
||||
with _lock:
|
||||
try:
|
||||
data = json.loads(_path().read_text(encoding="utf-8"))
|
||||
data = localize(json.loads(_path().read_text(encoding="utf-8")))
|
||||
except (OSError, ValueError):
|
||||
return {"games": {}, "settings": {}}
|
||||
# The catalog step loads the catalog, whose first load reads a setting: that nested load() must not run the
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
import threading
|
||||
from pathlib import Path
|
||||
@@ -45,10 +46,34 @@ def _on_frame() -> bool:
|
||||
return on_frame()
|
||||
|
||||
|
||||
def shares_windows_data() -> bool:
|
||||
"""WSL with FRAMEPORT_WINDOWS_DATA=1: use the Windows FramePort's data folder (one library for a Windows copy and
|
||||
WSL source runs; paths the other side saved are translated by `localize`)."""
|
||||
if not os.environ.get("FRAMEPORT_WINDOWS_DATA") or os.environ.get("FRAMEPORT_HOME"):
|
||||
return False
|
||||
from .winhost import is_wsl
|
||||
|
||||
return is_wsl()
|
||||
|
||||
|
||||
_win_data: list = [] # cached: finding %LOCALAPPDATA% from WSL starts cmd.exe
|
||||
|
||||
|
||||
def _windows_data_dir() -> Path | None:
|
||||
if not _win_data:
|
||||
from .winhost import env_path
|
||||
|
||||
local = env_path("LOCALAPPDATA")
|
||||
_win_data.append(local / "FramePort" if local else None)
|
||||
return _win_data[0]
|
||||
|
||||
|
||||
def user_data_dir() -> Path:
|
||||
"""Tools, keystores, work dirs and settings. Override with FRAMEPORT_HOME."""
|
||||
if os.environ.get("FRAMEPORT_HOME"):
|
||||
base = Path(os.environ["FRAMEPORT_HOME"])
|
||||
elif shares_windows_data() and _windows_data_dir() is not None:
|
||||
base = _windows_data_dir()
|
||||
elif sys.platform == "win32":
|
||||
base = Path(os.environ.get("LOCALAPPDATA", Path.home() / "AppData/Local")) / "FramePort"
|
||||
elif sys.platform == "darwin":
|
||||
@@ -63,6 +88,37 @@ def user_data_dir() -> Path:
|
||||
return base
|
||||
|
||||
|
||||
_WSL_DRIVE = re.compile(r"^/mnt/([a-zA-Z])(?:/(.*))?$")
|
||||
_WIN_DRIVE = re.compile(r"^([a-zA-Z]):[\\/](.*)$")
|
||||
|
||||
|
||||
def local_path(p: str) -> str:
|
||||
"""A path saved by FramePort on the other side of WSL in this side's spelling: /mnt/d/X -> D:\\X on Windows, and
|
||||
D:\\X -> /mnt/d/X in WSL runs on the Windows copy's data (`shares_windows_data`); anything else unchanged.
|
||||
Plain string mapping (drive letters only), so it is cheap enough for whole files."""
|
||||
if sys.platform == "win32":
|
||||
m = _WSL_DRIVE.match(p)
|
||||
return f"{m[1].upper()}:\\" + (m[2] or "").replace("/", "\\") if m else p
|
||||
if shares_windows_data():
|
||||
m = _WIN_DRIVE.match(p)
|
||||
if m:
|
||||
return f"/mnt/{m[1].lower()}" + ("/" + m[2].replace("\\", "/") if m[2] else "")
|
||||
return p
|
||||
|
||||
|
||||
def localize(obj):
|
||||
"""`local_path` applied to every string in loaded JSON (library.json, deployment records, tools.json): a data
|
||||
folder shared by a Windows copy and WSL source runs holds paths from both."""
|
||||
if isinstance(obj, str):
|
||||
return local_path(obj) if obj[:1] in "/" or obj[1:3] in (":\\", ":/") else obj
|
||||
if isinstance(obj, dict):
|
||||
for k, v in obj.items():
|
||||
obj[k] = localize(v)
|
||||
elif isinstance(obj, list):
|
||||
obj[:] = [localize(v) for v in obj]
|
||||
return obj
|
||||
|
||||
|
||||
_removed = threading.Event()
|
||||
|
||||
|
||||
|
||||
@@ -178,8 +178,9 @@ def _problem_fields(g: dict | None, description: str, env: dict, bundle_name: st
|
||||
a = g.get("analysis") or {}
|
||||
game = f"{title} — {g['package']} (version {a.get('version') or '?'}, {a.get('engine') or '?'} / " \
|
||||
f"{a.get('xr') or '?'})"
|
||||
logs = f"⬇ Drag and drop {bundle_name} (the diagnostics zip FramePort just saved) into this box." \
|
||||
if bundle_name else ""
|
||||
# some browsers don't let the prefilled box take a file (GitHub #196): the comment route always works
|
||||
logs = f"⬇ Drag and drop {bundle_name} (the diagnostics zip FramePort just saved) into this box. If it won't " \
|
||||
"take the file, submit the report and attach the zip in a comment." if bundle_name else ""
|
||||
return {
|
||||
# a game's report is about the game on the Frame, not a FramePort fault (titles read as a list of app bugs)
|
||||
"title": red.text(f"[Game report] {title}" if g else "[App] FramePort"),
|
||||
|
||||
@@ -538,6 +538,10 @@
|
||||
"FramePort isn't sure which program starts this game. Open the game and use … → Change program… to pick it.": "",
|
||||
"FramePort keeps its own copies; nothing is installed system-wide": "",
|
||||
"FramePort live view": "",
|
||||
"FramePort looked at your last session of {n} game and has something to try.": [
|
||||
"",
|
||||
""
|
||||
],
|
||||
"FramePort looked at your last session of {title} and has something to try.": "",
|
||||
"FramePort picked {value} to start this game, but isn't sure. Check it before installing.": "",
|
||||
"FramePort saves a diagnostics zip (no game files or personal data) and opens a GitHub issue. Drag the zip into it and submit.": "",
|
||||
@@ -740,6 +744,7 @@
|
||||
"Keep menus in place": "",
|
||||
"Keep pictures in bounds": "",
|
||||
"Keep the game's saved resolution in step": "",
|
||||
"Keep the same Meta user between starts": "",
|
||||
"Keep the signing keys: without them, updating a game loses its saves.": "",
|
||||
"Keeps a smoothing setting off that the game turns on itself and that can freeze the Frame.": "",
|
||||
"Keeps every submitted image rect inside its swapchain. Unity can size the eye area a few pixels past the image on some Frames; SteamVR then rejects every frame (xrEndFrame -25, XR_ERROR_SWAPCHAIN_RECT_INVALID) and the game stops drawing (for example PowerWash Simulator stuck at \"Waiting\").": "",
|
||||
@@ -747,6 +752,7 @@
|
||||
"Keeps one label so the title is stable.": "",
|
||||
"Keeps one name for the game, so it shows the same everywhere.": "",
|
||||
"Keeps the resolution the game saves in step with the headset's picture size (else the picture is shifted, with black borders, after a sharpness change).": "",
|
||||
"Keeps your progress in games that file their saves under your Meta user.": "",
|
||||
"Keyboard connected to {label}.": "",
|
||||
"Keyboard disconnected: {error}": "",
|
||||
"KiB": "",
|
||||
@@ -988,6 +994,7 @@
|
||||
"Open in browser": "",
|
||||
"Open the Monitor": "",
|
||||
"Open {scheme}:// links with FramePort?": "",
|
||||
"Open {title}": "",
|
||||
"OpenGL ES games run through a translation to Vulkan that is stricter than Quest drivers. Vulkan games run directly.": "",
|
||||
"OpenGL ES shader dump (diagnostics)": "",
|
||||
"OpenGL ES shader fixes": "",
|
||||
@@ -1738,6 +1745,7 @@
|
||||
"Windows' firewall blocks the Frame on public networks. Set this network to Private in Windows' network settings.": "",
|
||||
"Windows' firewall for WSL blocks the Frame. Show the setup command again and allow the change when Windows asks.": "",
|
||||
"With sound": "",
|
||||
"Without a Meta account, OVRPort's platform library makes up a new user id at every start (ovr_GetLoggedInUserID). Games that file saves under the user id (for example Walkabout Mini Golf) then start with an empty profile each time and seem to lose all progress. Gives the game a fixed id instead, different for each game and each FramePort user.": "",
|
||||
"Working": "",
|
||||
"Working…": "",
|
||||
"Works": "",
|
||||
|
||||
@@ -0,0 +1,138 @@
|
||||
"""OVRPort's platform loader gives the game a new Meta user id at every start, so games lose their progress.
|
||||
|
||||
Without a Meta account on the device, OVRPort's `ovr_GetLoggedInUserID` (and the logged-in user's `ovr_User_GetID`)
|
||||
answer with an id it makes up: 6e18 + a value from `random()`, kept only in memory. Games that file their saves under
|
||||
the user id (Walkabout Mini Golf: `Profiles/Oculus/<user id>/`, GitHub #182) open an empty profile at every start, so
|
||||
their progress seems gone (the old saves stay on the Frame, under the earlier ids).
|
||||
|
||||
This patch rewrites that helper to return a fixed id instead: 6e18 + 32 bits of a hash of the game's package name and
|
||||
its signing keystore. The id stays the same for every build and reinstall of the game (the keystore never changes), and
|
||||
differs between games and between FramePort users (each user's keystores are their own), so games that use the id
|
||||
online don't see two players as one.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
|
||||
from ...analysis import elf
|
||||
from ..base import ApkContext, Patch, Suggestion, register
|
||||
|
||||
LOADER = "libovrplatformloader.so"
|
||||
BASE_ID = 0x53444835EC580000 # 6e18: OVRPort's own base for made-up ids
|
||||
|
||||
STP = 0xA9BF7BFD # stp x29, x30, [sp, #-16]!
|
||||
MOV_FP = 0x910003FD # mov x29, sp
|
||||
BL, BL_MASK = 0x94000000, 0xFC000000
|
||||
# the end of the helper, which loads 6e18 into x9 and adds it (same bytes in OVRPort runtimes 3.4.3-23204ea and
|
||||
# 3.4.3-aa54c3f)
|
||||
MOV_X9_LO = 0xD2BD8B09 # mov x9, #0xec580000
|
||||
MOVK_X9_32 = 0xF2C906A9 # movk x9, #0x4835, lsl #32
|
||||
MOVK_X9_48 = 0xF2EA6889 # movk x9, #0x5344, lsl #48
|
||||
ADD_X0 = 0x8B090100 # add x0, x8, x9
|
||||
LDP = 0xA8C17BFD # ldp x29, x30, [sp], #16
|
||||
RET = 0xD65F03C0
|
||||
SIZE = 19 # instructions in the helper, stp … ret
|
||||
|
||||
|
||||
def _words(data: bytes | bytearray, off: int, n: int) -> list[int]:
|
||||
return [int.from_bytes(data[off + 4 * i:off + 4 * i + 4], "little") for i in range(n)]
|
||||
|
||||
|
||||
def _text_ranges(data: bytes) -> list[tuple[int, int]]:
|
||||
"""File ranges of executable PT_LOAD segments."""
|
||||
try:
|
||||
e = elf._elf(data)
|
||||
except Exception: # noqa: BLE001
|
||||
return []
|
||||
return [(s["p_offset"], s["p_offset"] + s["p_filesz"]) for s in e.iter_segments()
|
||||
if s["p_type"] == "PT_LOAD" and s["p_flags"] & 1]
|
||||
|
||||
|
||||
def find_helper(data: bytes) -> int | None:
|
||||
"""File offset of OVRPort's made-up-user-id helper (stp; mov x29,sp; bl random; …; mov/movk x9 = 6e18; add x0,
|
||||
x8, x9; ldp; ret), or None. Exactly one match is required."""
|
||||
tail = [MOV_X9_LO, MOVK_X9_32, MOVK_X9_48, ADD_X0, LDP, RET]
|
||||
found = []
|
||||
for start, end in _text_ranges(data):
|
||||
off = data.find(MOV_X9_LO.to_bytes(4, "little") + MOVK_X9_32.to_bytes(4, "little"), start, end)
|
||||
while off != -1:
|
||||
head = off - 4 * (SIZE - len(tail))
|
||||
if head >= start and _words(data, off, len(tail)) == tail:
|
||||
w = _words(data, head, 3)
|
||||
if w[0] == STP and w[1] == MOV_FP and w[2] & BL_MASK == BL:
|
||||
found.append(head)
|
||||
off = data.find(MOV_X9_LO.to_bytes(4, "little") + MOVK_X9_32.to_bytes(4, "little"), off + 4, end)
|
||||
return found[0] if len(found) == 1 else None
|
||||
|
||||
|
||||
def stable_id(package: str, keystore: bytes) -> int:
|
||||
"""6e18 + 32 bits from the package name and the game's signing keystore."""
|
||||
digest = hashlib.sha256(package.encode() + b"\0" + keystore).digest()
|
||||
return BASE_ID + int.from_bytes(digest[:4], "little")
|
||||
|
||||
|
||||
def _mov_x0(value: int) -> list[int]:
|
||||
"""movz/movk x0 with a 64-bit value."""
|
||||
out = []
|
||||
for i in range(4):
|
||||
imm = (value >> (16 * i)) & 0xFFFF
|
||||
base = 0xD2800000 if i == 0 else 0xF2800000 # movz / movk (64-bit)
|
||||
out.append(base | (i << 21) | (imm << 5))
|
||||
return out
|
||||
|
||||
|
||||
def pin_user_id(data: bytes, user_id: int) -> bytes | None:
|
||||
"""The loader whose made-up-id helper returns `user_id`, or None when the helper isn't found (Meta's own loader,
|
||||
another OVRPort build, already patched)."""
|
||||
off = find_helper(data)
|
||||
if off is None:
|
||||
return None
|
||||
new = _mov_x0(user_id) + [RET]
|
||||
out = bytearray(data)
|
||||
for i, word in enumerate(new): # the rest of the helper stays (unreachable), so the size never changes
|
||||
out[off + 4 * i:off + 4 * i + 4] = word.to_bytes(4, "little")
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _keystore(package: str) -> bytes:
|
||||
from ...apk import sign
|
||||
|
||||
try:
|
||||
return sign.ensure_keystore(package).read_bytes()
|
||||
except OSError:
|
||||
return b""
|
||||
|
||||
|
||||
class OvrStableUser(Patch):
|
||||
id = "frame.ovr_stable_user"
|
||||
title = "Keep the same Meta user between starts"
|
||||
description = ("Without a Meta account, OVRPort's platform library makes up a new user id at every start "
|
||||
"(ovr_GetLoggedInUserID). Games that file saves under the user id (for example Walkabout Mini "
|
||||
"Golf) then start with an empty profile each time and seem to lose all progress. Gives the game "
|
||||
"a fixed id instead, different for each game and each FramePort user.")
|
||||
order = 47
|
||||
default_on = True # suggested only where the game has the platform library (detect)
|
||||
|
||||
def detect(self, a):
|
||||
if LOADER in a.libs:
|
||||
return Suggestion(True, "The game uses Meta's platform library: OVRPort's version gives it a new user "
|
||||
"id at every start, which loses saves filed under that id.")
|
||||
return None
|
||||
|
||||
def applies(self, a):
|
||||
return LOADER in a.libs
|
||||
|
||||
def apply(self, ctx: ApkContext) -> bool:
|
||||
ws = ctx.ws
|
||||
if not ws.has(ws.lib(LOADER)):
|
||||
return False
|
||||
package = ctx.analysis.package
|
||||
user_id = stable_id(package, _keystore(package))
|
||||
fixed = pin_user_id(ws.read_lib(LOADER), user_id)
|
||||
if fixed:
|
||||
ws.put(ws.lib(LOADER), fixed)
|
||||
ctx.notes.append(f"{LOADER}: the logged-in user id is always {user_id}")
|
||||
return bool(fixed)
|
||||
|
||||
|
||||
register(OvrStableUser)
|
||||
@@ -88,6 +88,7 @@ SUMMARIES = {
|
||||
"frame.asset_files": "Lets the game find extra content it keeps next to its data (for example Star Wars Tales' "
|
||||
"seasons).",
|
||||
"frame.ovr_microphone": "Stops a crash a few seconds after the logo in games with voice chat.",
|
||||
"frame.ovr_stable_user": "Keeps your progress in games that file their saves under your Meta user.",
|
||||
"frame.avatar_stub": "Lets games start that would stop at Meta's avatars (for example BlazeRush). No Meta "
|
||||
"avatars.",
|
||||
"frame.vrapi_bridge": "Lets games built on Meta's oldest VR interface run on the Frame.",
|
||||
|
||||
@@ -16,7 +16,7 @@ from pathlib import Path
|
||||
from ..core import winhost
|
||||
from ..core.events import Reporter
|
||||
from ..core.models import Recipe
|
||||
from ..core.paths import agent_file, user_data_dir
|
||||
from ..core.paths import agent_file, localize, user_data_dir
|
||||
from ..patches.pcvr import game_args
|
||||
from ..validate.triage import triage
|
||||
from .base import PC_LABEL, Target
|
||||
@@ -77,7 +77,7 @@ def local_installs() -> dict[str, dict]:
|
||||
out = {}
|
||||
for f in sorted((user_data_dir() / "pc").glob("*/deployment.json")):
|
||||
try:
|
||||
dep = json.loads(f.read_text(encoding="utf-8"))
|
||||
dep = localize(json.loads(f.read_text(encoding="utf-8")))
|
||||
out[dep["package"]] = dep
|
||||
except (OSError, ValueError, KeyError):
|
||||
continue
|
||||
@@ -113,7 +113,7 @@ class PcReviveTarget(Target):
|
||||
out = []
|
||||
for f in sorted(pc_dir().glob("*/deployment.json")):
|
||||
try:
|
||||
dep = json.loads(f.read_text(encoding="utf-8"))
|
||||
dep = localize(json.loads(f.read_text(encoding="utf-8")))
|
||||
except (OSError, ValueError):
|
||||
continue
|
||||
dep["apk_present"] = Path(dep.get("exe_local", "")).exists()
|
||||
@@ -122,7 +122,7 @@ class PcReviveTarget(Target):
|
||||
|
||||
def _dep(self, package: str) -> dict:
|
||||
try:
|
||||
return json.loads((pc_dir() / package / "deployment.json").read_text(encoding="utf-8"))
|
||||
return localize(json.loads((pc_dir() / package / "deployment.json").read_text(encoding="utf-8")))
|
||||
except (OSError, ValueError):
|
||||
raise RuntimeError(f"{package} is not installed on this PC") from None
|
||||
|
||||
@@ -195,7 +195,7 @@ class PcReviveTarget(Target):
|
||||
exe_field, _, _ = shortcut_fields(dep)
|
||||
d = pc_dir() / package
|
||||
try: # a reinstall keeps the shortcut's appid: Steam's entry is matched by its Exe, whatever its name now
|
||||
old = json.loads((d / "deployment.json").read_text(encoding="utf-8"))
|
||||
old = localize(json.loads((d / "deployment.json").read_text(encoding="utf-8")))
|
||||
except (OSError, ValueError):
|
||||
old = {}
|
||||
same_exe = bool(old.get("appid") and old.get("exe_win") and shortcut_fields(old)[0] == exe_field)
|
||||
|
||||
@@ -28,6 +28,10 @@ def asset_suffix() -> str:
|
||||
return "Linux-ARM64" if arm else "Linux"
|
||||
|
||||
|
||||
def _exe_name() -> str:
|
||||
return "Cpp2IL.exe" if sys.platform == "win32" else "Cpp2IL"
|
||||
|
||||
|
||||
def pick_release(releases: list[dict], suffix: str) -> tuple[str, str] | None:
|
||||
"""(version, download url) of the newest release that has an executable for this computer."""
|
||||
for rel in releases:
|
||||
@@ -40,7 +44,7 @@ def pick_release(releases: list[dict], suffix: str) -> tuple[str, str] | None:
|
||||
def path() -> Path | None:
|
||||
if os.environ.get("FRAMEPORT_CPP2IL"):
|
||||
return Path(os.environ["FRAMEPORT_CPP2IL"])
|
||||
found = sorted(tools_dir().glob("cpp2il-*/Cpp2IL*"))
|
||||
found = sorted(tools_dir().glob(f"cpp2il-*/{_exe_name()}")) # the data folder may hold other OSes' copies too
|
||||
return found[-1] if found else None
|
||||
|
||||
|
||||
@@ -59,7 +63,7 @@ def ensure(progress=None) -> Path:
|
||||
if picked is None:
|
||||
raise RuntimeError("couldn't find a Cpp2IL download for this computer")
|
||||
version, url = picked
|
||||
exe = tools_dir() / f"cpp2il-{version}" / ("Cpp2IL.exe" if sys.platform == "win32" else "Cpp2IL")
|
||||
exe = tools_dir() / f"cpp2il-{version}" / _exe_name()
|
||||
cache.download(url, exe, progress)
|
||||
exe.chmod(exe.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
|
||||
return exe
|
||||
@@ -19,7 +19,7 @@ from pathlib import Path
|
||||
from xml.etree import ElementTree
|
||||
|
||||
from ..core import cache
|
||||
from ..core.paths import tools_dir, write_atomic
|
||||
from ..core.paths import localize, tools_dir, write_atomic
|
||||
|
||||
ADOPTIUM = "https://api.adoptium.net/v3/assets/latest/21/hotspot?architecture={arch}&image_type=jre&os={os}"
|
||||
# overport's CLI: maintained in the downstream fork Android-XR-Bridge/OVRPort since 1.2.5 (stable channel = plain
|
||||
@@ -54,7 +54,7 @@ def _state_file() -> Path:
|
||||
|
||||
def _state() -> dict:
|
||||
try:
|
||||
return json.loads(_state_file().read_text())
|
||||
return localize(json.loads(_state_file().read_text()))
|
||||
except (OSError, ValueError):
|
||||
return {}
|
||||
|
||||
@@ -64,37 +64,49 @@ def _save_state(state: dict) -> None:
|
||||
|
||||
|
||||
# ------------------------------------------------------------------------------------------ Java
|
||||
def _java_key() -> str:
|
||||
"""The Java entry of tools.json: one per OS, since a data folder can be shared by Windows and WSL."""
|
||||
return "java-{}-{}".format(*_os_arch())
|
||||
|
||||
|
||||
def java_path() -> Path | None:
|
||||
if os.environ.get("FRAMEPORT_JAVA"):
|
||||
return Path(os.environ["FRAMEPORT_JAVA"])
|
||||
st = _state().get("java")
|
||||
state = _state()
|
||||
st = state.get(_java_key())
|
||||
if not st and state.get("java"): # before 1.0.4: one entry; it's this OS's if it has this OS's java name
|
||||
st = state["java"] if Path(state["java"]["path"]).name == _java_exe() else None
|
||||
if st and Path(st["path"]).exists():
|
||||
return Path(st["path"])
|
||||
return None
|
||||
|
||||
|
||||
def _java_exe() -> str:
|
||||
return "java.exe" if sys.platform == "win32" else "java"
|
||||
|
||||
|
||||
def install_java(progress=None) -> ToolStatus:
|
||||
osname, arch = _os_arch()
|
||||
info = cache.http_get(ADOPTIUM.format(os=osname, arch=arch)).json()[0]
|
||||
pkg = info["binary"]["package"]
|
||||
version = info["version"]["semver"]
|
||||
dest = tools_dir() / f"jre-{version}"
|
||||
dest = tools_dir() / f"jre-{version}-{osname}-{arch}"
|
||||
if not dest.exists():
|
||||
archive = cache.download(pkg["link"], tools_dir() / pkg["name"], progress, expected_sha256=pkg["checksum"])
|
||||
tmp = tools_dir() / f".jre-{version}.extract"
|
||||
tmp = tools_dir() / f".jre-{version}-{osname}-{arch}.extract"
|
||||
shutil.rmtree(tmp, ignore_errors=True)
|
||||
_extract(archive, tmp)
|
||||
top = next(tmp.iterdir())
|
||||
top.rename(dest)
|
||||
shutil.rmtree(tmp, ignore_errors=True)
|
||||
archive.unlink(missing_ok=True)
|
||||
exe = "java.exe" if sys.platform == "win32" else "java"
|
||||
exe = _java_exe()
|
||||
candidates = [dest / "bin" / exe, dest / "Contents/Home/bin" / exe]
|
||||
java = next(p for p in candidates if p.exists())
|
||||
if sys.platform != "win32":
|
||||
java.chmod(0o755)
|
||||
state = _state()
|
||||
state["java"] = {"version": version, "path": str(java)}
|
||||
state[_java_key()] = {"version": version, "path": str(java)}
|
||||
_save_state(state)
|
||||
return ToolStatus("java", True, version, java)
|
||||
|
||||
|
||||
+68
-21
@@ -9,6 +9,7 @@ The UI only calls `frameport.pipeline`, the targets and the toolchain; long work
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
import traceback
|
||||
@@ -53,12 +54,16 @@ def _stop_link_watch() -> None:
|
||||
|
||||
|
||||
def _watch_links() -> None:
|
||||
"""Heartbeat for the link handler scripts (FramePort runs) + hand queued install links to the window."""
|
||||
"""Heartbeat for the link handler scripts (FramePort runs) + hand queued install links to the window; a second
|
||||
start of FramePort brings this window to the front (core/instance.py)."""
|
||||
from .. import urlhandler
|
||||
from ..core import instance
|
||||
|
||||
while not _link_state["closing"]:
|
||||
urlhandler.heartbeat()
|
||||
app = _link_state["owner"]
|
||||
if app is not None and instance.take_focus_request(): # FramePort was started again: show this window
|
||||
app.page.run_task(app.bring_to_front)
|
||||
if app is not None:
|
||||
for link in urlhandler.take_links():
|
||||
applog.log.info("install link received")
|
||||
@@ -156,6 +161,8 @@ class FramePortApp:
|
||||
for key, value in window_geometry(library.setting("ui.window"), T.SCALE).items():
|
||||
setattr(page.window, key, value)
|
||||
page.window.on_event = self._on_window_event
|
||||
if sys.platform == "win32" and (icon := G.window_icon(Path(assets_dir()))):
|
||||
page.window.icon = str(icon) # source runs: FramePort's icon instead of Flet's
|
||||
page.on_keyboard_event = self._on_key
|
||||
if page.web: # the library's right-click menu; otherwise the browser shows its own
|
||||
try:
|
||||
@@ -183,6 +190,13 @@ class FramePortApp:
|
||||
atexit.register(_stop_link_watch)
|
||||
self.run_bg(urlhandler.apply_setting) # framedrop:// + frameport:// → FramePort (Settings → General)
|
||||
|
||||
async def bring_to_front(self) -> None:
|
||||
win = self.page.window
|
||||
if win.minimized:
|
||||
win.minimized = False
|
||||
C.update(self.page)
|
||||
await win.to_front()
|
||||
|
||||
# ================================================================== shell
|
||||
def _build_shell(self) -> None:
|
||||
"""The window: sidebar (logo, navigation, update/activity/Frame cards), the view area and the activity panel.
|
||||
@@ -935,7 +949,11 @@ class FramePortApp:
|
||||
from .views.library import display_title, twins
|
||||
|
||||
g = library.game(pkg)
|
||||
return display_title(g, twins(library.games())) if g else pkg
|
||||
if g:
|
||||
return display_title(g, twins(library.games()))
|
||||
# a game on the Frame that isn't in this library (Frame page → Installed): the name it has there
|
||||
on_frame = next((d for d in (self.frame_info or {}).get("installed", []) if d.get("package") == pkg), None)
|
||||
return (on_frame or {}).get("title") or pkg
|
||||
|
||||
def install_options(self, g: dict) -> list[tuple]:
|
||||
"""[(label, icon, on_click, disabled, tooltip)] — the first is the primary action."""
|
||||
@@ -1660,9 +1678,9 @@ class FramePortApp:
|
||||
delete_local, extra = self._delete_local_option(pkg)
|
||||
delete_data = None
|
||||
if to == "frame": # GitHub #130: what the game stored (saves, mods, downloads) used to survive every uninstall
|
||||
delete_data = ft.Checkbox(label=tr("Also delete its saves and everything it stored on the Frame (mods, "
|
||||
"downloaded content)"), value=False, active_color=T.ERROR)
|
||||
extra = delete_data if extra is None else ft.Column([delete_data, extra], spacing=T.px(8), tight=True)
|
||||
delete_data, row = C.checkbox(tr("Also delete its saves and everything it stored on the Frame (mods, "
|
||||
"downloaded content)"), value=False, active_color=T.ERROR)
|
||||
extra = row if extra is None else ft.Column([row, extra], spacing=T.px(8), tight=True)
|
||||
|
||||
def run(job: Job):
|
||||
self._target_for(to).uninstall(pkg, keep_data=not (delete_data and delete_data.value))
|
||||
@@ -1685,12 +1703,12 @@ class FramePortApp:
|
||||
return None, None
|
||||
size = sum((sum(f.stat().st_size for f in p.rglob("*") if f.is_file()) if p.is_dir() else p.stat().st_size)
|
||||
for p in files)
|
||||
box = ft.Checkbox(label=tr("Also delete this game's files on this PC ({size})").format(size=fmt_size(size)),
|
||||
value=False, active_color=T.ERROR)
|
||||
box, row = C.checkbox(tr("Also delete this game's files on this PC ({size})").format(size=fmt_size(size)),
|
||||
value=False, active_color=T.ERROR)
|
||||
from ..core import winhost
|
||||
|
||||
shown = [winhost.to_windows(p) if winhost.is_wsl() else str(p) for p in files]
|
||||
return box, ft.Column([box, *[C.body("• " + s, T.TEXT_3) for s in shown[:4]]], spacing=T.px(4), tight=True)
|
||||
return box, ft.Column([row, *[C.body("• " + s, T.TEXT_3) for s in shown[:4]]], spacing=T.px(4), tight=True)
|
||||
|
||||
def remove_from_library(self, pkg: str) -> None:
|
||||
title = self._title(pkg)
|
||||
@@ -1893,7 +1911,7 @@ class FramePortApp:
|
||||
else "works"))
|
||||
notes = C.field(label=tr("Notes (what you checked, known issues)"), multiline=True, min_lines=2,
|
||||
max_lines=6, width=T.DIALOG_M)
|
||||
played = ft.Checkbox(label=tr("I played it in the headset with this recipe"), value=False)
|
||||
played, played_row = C.checkbox(tr("I played it in the headset with this recipe"), value=False)
|
||||
send = C.primary(tr("Open GitHub issue"), ft.Icons.OPEN_IN_NEW_ROUNDED, on_click=None)
|
||||
|
||||
def sync(e=None):
|
||||
@@ -1921,7 +1939,7 @@ class FramePortApp:
|
||||
get=C.test_result(last.get("verdict"), last.get("milestone"))[0],
|
||||
value=C.test_result(last.get("verdict"), last.get("milestone"))[1]),
|
||||
T.TEXT_3)] if last else []),
|
||||
ft.Row([status, C.help_icon("share_config")]), notes, played,
|
||||
ft.Row([status, C.help_icon("share_config")]), notes, played_row,
|
||||
C.body(tr("Launch tests can't check the picture or controls — only you can."),
|
||||
T.TEXT_3),
|
||||
], tight=True, spacing=T.S3),
|
||||
@@ -2356,6 +2374,8 @@ class FramePortApp:
|
||||
self._sessions_busy, target = True, self.target
|
||||
|
||||
def work():
|
||||
found = [] # games whose session has something to try: one pop-up for all of them (a burst at the
|
||||
# first connection used to show one per game, and the Library flickered under them)
|
||||
try:
|
||||
for pkg, lp, fetch in due:
|
||||
if not fetch:
|
||||
@@ -2368,22 +2388,36 @@ class FramePortApp:
|
||||
if isinstance(exc, AgentFailed): # the agent answered: asking again won't help
|
||||
pipeline.mark_session_checked(pkg, lp["end"])
|
||||
continue
|
||||
self._session_triaged(pkg, summary)
|
||||
if self._session_triaged(pkg, summary):
|
||||
found.append(pkg)
|
||||
finally:
|
||||
self._sessions_busy = False
|
||||
self._announce_sessions(found)
|
||||
threading.Thread(target=work, daemon=True).start()
|
||||
|
||||
def _session_triaged(self, pkg: str, summary: dict) -> None:
|
||||
def _session_triaged(self, pkg: str, summary: dict) -> bool:
|
||||
"""True when the session has something to try (shown on the game's page; _announce_sessions tells the user)."""
|
||||
from ..validate.session import shown_findings
|
||||
|
||||
if not summary or not shown_findings(summary):
|
||||
return
|
||||
return False
|
||||
if self.route[:2] == ("game", pkg):
|
||||
self.refresh_view()
|
||||
else:
|
||||
return True
|
||||
|
||||
def _announce_sessions(self, packages: list[str]) -> None:
|
||||
"""One pop-up for the play sessions that have something to try (not for the game page already shown)."""
|
||||
packages = [p for p in packages if self.route[:2] != ("game", p)]
|
||||
if len(packages) == 1:
|
||||
pkg = packages[0]
|
||||
self.toast(tr("FramePort looked at your last session of {title} and has something to try.")
|
||||
.format(title=self._title(pkg)), action=tr("Open game"),
|
||||
on_action=lambda e: self.open_game(pkg))
|
||||
elif packages:
|
||||
self.toast(tr_n("FramePort looked at your last session of {n} game and has something to try.",
|
||||
"FramePort looked at the last sessions of {n} games and has something to try on their "
|
||||
"pages.", len(packages)), action=tr("Open {title}").format(title=self._title(packages[0])),
|
||||
on_action=lambda e: self.open_game(packages[0]))
|
||||
|
||||
def apply_session_fix(self, pkg: str, suggestions: list[str], finding: str | None = None) -> None:
|
||||
"""A fix from the game page's "Last session": FrameBridge settings are written on the Frame at once (no
|
||||
@@ -2724,12 +2758,11 @@ class FramePortApp:
|
||||
shown_dir = winhost.to_windows(backup_dir) if winhost.is_wsl() else str(backup_dir)
|
||||
keys_label = tr("Back up the signing keys ({len}) to {shown_dir} first").format(len=len(pl.keys),
|
||||
shown_dir=shown_dir)
|
||||
cb_keys = ft.Checkbox(label=keys_label,
|
||||
value=bool(pl.keys), active_color=T.ACCENT)
|
||||
cb_frame = ft.Checkbox(label=tr("Also remove FramePort's games and files from the Frame") +
|
||||
("" if connected else tr(" (connect the Frame first)")), value=connected,
|
||||
disabled=not connected, active_color=T.ACCENT)
|
||||
cb_saves = ft.Checkbox(label=tr("Keep game saves on the Frame"), value=True, active_color=T.ACCENT)
|
||||
cb_keys, keys_row = C.checkbox(keys_label, value=bool(pl.keys), active_color=T.ACCENT)
|
||||
cb_frame, frame_row = C.checkbox(tr("Also remove FramePort's games and files from the Frame") +
|
||||
("" if connected else tr(" (connect the Frame first)")), value=connected,
|
||||
disabled=not connected, active_color=T.ACCENT)
|
||||
cb_saves, saves_row = C.checkbox(tr("Keep game saves on the Frame"), value=True, active_color=T.ACCENT)
|
||||
frame_items = [i for i in pl.items if i.kind == "frame"]
|
||||
steam_items = [i for i in pl.items if i.kind == "steam"]
|
||||
other = [i for i in pl.items if i.kind == "pc"]
|
||||
@@ -2765,7 +2798,7 @@ class FramePortApp:
|
||||
self.page.show_dialog(C.dialog(
|
||||
tr("Uninstall FramePort?"),
|
||||
ft.Column([C.body(tr("This removes:"), T.TEXT), *lines, ft.Container(height=T.S2),
|
||||
cb_keys, cb_frame, cb_saves,
|
||||
keys_row, frame_row, saves_row,
|
||||
C.meta(tr("Keep the signing keys: without them, updating a game "
|
||||
"loses its saves."))],
|
||||
spacing=T.S2, tight=True, scroll=ft.ScrollMode.AUTO),
|
||||
@@ -2875,6 +2908,12 @@ def main(argv=None):
|
||||
if links and urlhandler.app_running():
|
||||
return # the open window takes it
|
||||
applog.setup("gui")
|
||||
from ..core import instance
|
||||
|
||||
if not instance.claim(urlhandler.app_running):
|
||||
applog.log.info("FramePort is already running: brought its window to the front")
|
||||
print("FramePort is already running.", file=sys.stderr)
|
||||
return
|
||||
serialize_flet_updates()
|
||||
from ..core import library
|
||||
from .updater import apply_pending_at_start
|
||||
@@ -2889,6 +2928,14 @@ def main(argv=None):
|
||||
if updates.install_kind() == "bundle": # a packaged app finds artwork by file path, not by URL (GitHub #16)
|
||||
thumbs.use_file_paths(True)
|
||||
ft.run(lambda page: FramePortApp(page), assets_dir=assets_dir())
|
||||
# the window is gone: end the process now. Background threads (re-analysis, session triage) would otherwise keep
|
||||
# it running without a window, holding the GUI lock; library writes are atomic and installs resume.
|
||||
_stop_link_watch()
|
||||
import logging
|
||||
import os
|
||||
|
||||
logging.shutdown()
|
||||
os._exit(0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@@ -213,6 +213,23 @@ def h2(text: str) -> ft.Text:
|
||||
return ft.Text(text, size=T.T_H2, weight=ft.FontWeight.W_600, color=T.TEXT)
|
||||
|
||||
|
||||
def checkbox(label: str, **kw) -> tuple[ft.Checkbox, ft.Control]:
|
||||
"""(the checkbox, the control to show): a checkbox whose label wraps (Material's own label stays on one line and
|
||||
runs past a dialog's edge); clicking the label toggles it too."""
|
||||
box = ft.Checkbox(**kw)
|
||||
|
||||
def click_label(e):
|
||||
if box.disabled:
|
||||
return
|
||||
box.value = not box.value
|
||||
update(box)
|
||||
if box.on_change:
|
||||
box.on_change(SimpleNamespace(control=box))
|
||||
return box, ft.Row([box, ft.Container(ft.Text(label, color=T.TEXT, size=T.px(14)), expand=True,
|
||||
on_click=click_label, ink=True, border_radius=T.RADIUS_XS)],
|
||||
spacing=T.S1, vertical_alignment=ft.CrossAxisAlignment.CENTER)
|
||||
|
||||
|
||||
def switch(label: str = "", wrap: bool = True, **kw) -> ft.Control:
|
||||
"""A labelled switch in the theme's text colour (Material's default label is dark text). The label wraps (a
|
||||
Switch's own label is cut off when it's longer than the window); clicking it toggles the switch too.
|
||||
|
||||
@@ -45,6 +45,27 @@ def install(assets: Path) -> Path:
|
||||
return target
|
||||
|
||||
|
||||
APP_ICON = Path(__file__).resolve().parents[2] / "assets" / "icon.png" # src/assets: the bundles' app icon
|
||||
|
||||
|
||||
def window_icon(assets: Path, source: Path = APP_ICON) -> Path | None:
|
||||
"""<assets>/ui-icons/app.ico made from the app icon, for the window and taskbar of source runs on Windows (they
|
||||
run Flet's prebuilt client, which shows Flet's logo; `flet build` bundles have the icon built in). None when the
|
||||
icon isn't there (bundles) or can't be converted."""
|
||||
dest = assets / FOLDER / "app.ico"
|
||||
try:
|
||||
if dest.is_file() and dest.stat().st_mtime >= source.stat().st_mtime:
|
||||
return dest
|
||||
from PIL import Image
|
||||
|
||||
dest.parent.mkdir(parents=True, exist_ok=True)
|
||||
with Image.open(source) as im:
|
||||
im.convert("RGBA").save(dest, sizes=[(n, n) for n in (16, 20, 24, 32, 40, 48, 64, 128, 256)])
|
||||
return dest
|
||||
except Exception: # noqa: BLE001 (Flet's icon then; never worth failing the start)
|
||||
return None
|
||||
|
||||
|
||||
PORTAL_REV = 2
|
||||
|
||||
|
||||
|
||||
@@ -143,7 +143,7 @@ class Updater:
|
||||
tr("FramePort {version} is available").format(version=up.version),
|
||||
_changes_column(page, changes, intro), size="l", height=_changes_height(changes, 100),
|
||||
actions=[C.ghost(tr("Skip this version"), on_click=skip),
|
||||
C.ghost(tr("Release page"), ft.Icons.OPEN_IN_NEW_ROUNDED, lambda e: page.launch_url(up.page)),
|
||||
C.ghost(tr("Release page"), ft.Icons.OPEN_IN_NEW_ROUNDED, lambda e: _open_url(page, up.page)),
|
||||
C.primary(tr("Update now"), ft.Icons.SYSTEM_UPDATE_ROUNDED, go)]))
|
||||
|
||||
def show_news(self) -> None:
|
||||
@@ -161,7 +161,7 @@ class Updater:
|
||||
page = self.app.page
|
||||
if not entries:
|
||||
self.app.toast(tr("Couldn't load the changelog — check the internet connection"), error=True,
|
||||
action=tr("Releases"), on_action=lambda e: page.launch_url(f"{REPO_URL}/releases"))
|
||||
action=tr("Releases"), on_action=lambda e: _open_url(page, f"{REPO_URL}/releases"))
|
||||
return
|
||||
self.app.page.run_thread(lambda: page.show_dialog(_changes_dialog(page, tr("FramePort changelog"),
|
||||
entries, current=__version__)))
|
||||
@@ -199,7 +199,7 @@ class Updater:
|
||||
tr("Install dev build {version}?").format(version=up.version),
|
||||
_changes_column(page, changes, warn), size="l", height=_changes_height(changes, 160),
|
||||
actions=[C.ghost(tr("Cancel"), on_click=lambda e: page.pop_dialog()),
|
||||
C.ghost(tr("Build page"), ft.Icons.OPEN_IN_NEW_ROUNDED, lambda e: page.launch_url(up.page)),
|
||||
C.ghost(tr("Build page"), ft.Icons.OPEN_IN_NEW_ROUNDED, lambda e: _open_url(page, up.page)),
|
||||
C.primary(tr("Install dev build"), G.TEST, go)]))
|
||||
|
||||
# ---------------------------------------------------------------- installing
|
||||
@@ -214,7 +214,7 @@ class Updater:
|
||||
if not target or not updates.can_replace(target):
|
||||
self.app.toast(tr("FramePort can't update itself in {value} (no permission) — opening the release "
|
||||
"page to download it").format(value=target or 'this folder'), error=True)
|
||||
page.launch_url(up.page)
|
||||
_open_url(page, up.page)
|
||||
return
|
||||
if kind == "source" and updates.source_is_dirty():
|
||||
self.app.toast(tr("This source checkout has uncommitted changes — commit or stash them, then update"),
|
||||
@@ -301,7 +301,7 @@ def _entry_section(page: ft.Page, entry: updates.ChangelogEntry, expanded: bool,
|
||||
notes = ft.Container(
|
||||
ft.Markdown(entry.body.strip() or tr("No release notes."), selectable=True,
|
||||
extension_set=ft.MarkdownExtensionSet.GITHUB_WEB, md_style_sheet=_notes_style(),
|
||||
on_tap_link=lambda e: page.launch_url(e.data)),
|
||||
on_tap_link=lambda e: _open_url(page, e.data)),
|
||||
padding=ft.Padding(T.S4, 0, T.S4, T.S3), visible=expanded)
|
||||
chevron = ft.Icon(ft.Icons.EXPAND_MORE_ROUNDED if expanded else ft.Icons.CHEVRON_RIGHT_ROUNDED, size=T.px(18),
|
||||
color=T.TEXT_3)
|
||||
@@ -338,12 +338,25 @@ def _changes_height(entries: list[updates.ChangelogEntry], extra: int) -> float:
|
||||
return T.px(min(480, extra + 26 * lines + 50 * len(entries)))
|
||||
|
||||
|
||||
def _open_url(page: ft.Page, url: str) -> None:
|
||||
"""Open a link in the browser. Flet 1.0 has no Page.launch_url (GitHub #194: "All releases" raised
|
||||
AttributeError); same path as FramePortApp.open_url."""
|
||||
from ..core import winhost
|
||||
|
||||
if winhost.is_wsl() and winhost.open_url(url): # the desktop client would open a Linux browser in WSL
|
||||
return
|
||||
try:
|
||||
page.run_task(ft.UrlLauncher().launch_url, url)
|
||||
except Exception: # noqa: BLE001
|
||||
winhost.open_url(url)
|
||||
|
||||
|
||||
def _changes_dialog(page: ft.Page, title: str, entries: list[updates.ChangelogEntry],
|
||||
current: str | None = None) -> ft.AlertDialog:
|
||||
return C.dialog(title, _changes_column(page, entries, None, current), size="l",
|
||||
height=_changes_height(entries, 20),
|
||||
actions=[C.ghost(tr("All releases"), ft.Icons.OPEN_IN_NEW_ROUNDED,
|
||||
lambda e: page.launch_url(f"{REPO_URL}/releases")),
|
||||
lambda e: _open_url(page, f"{REPO_URL}/releases")),
|
||||
C.primary(tr("Close"), on_click=lambda e: page.pop_dialog())])
|
||||
|
||||
|
||||
|
||||
@@ -480,12 +480,27 @@ def _extract(archive: Path, dest: Path, platform: str) -> Path:
|
||||
return folder
|
||||
|
||||
|
||||
# set by the running app's Flutter host / embedded Python for *this* process (its server socket, its temporary
|
||||
# extraction folder, …): a relaunched FramePort that inherits them talks to the old, gone app and its window stays
|
||||
# black (GitHub #195)
|
||||
APP_ENV_PREFIXES = ("FLET_", "SERIOUS_PYTHON")
|
||||
APP_ENV_NAMES = ("PYTHONHOME", "PYTHONPATH", "PYTHONNOUSERSITE", "PYTHONINSPECT", "PYTHONDONTWRITEBYTECODE")
|
||||
|
||||
|
||||
def clean_env(env: dict | None = None) -> dict:
|
||||
"""The environment for the swap script and the FramePort it relaunches: without the running app's own Flet and
|
||||
embedded-Python variables."""
|
||||
env = dict(os.environ if env is None else env)
|
||||
return {k: v for k, v in env.items()
|
||||
if not k.upper().startswith(APP_ENV_PREFIXES) and k.upper() not in APP_ENV_NAMES}
|
||||
|
||||
|
||||
def _powershell() -> tuple[str, dict]:
|
||||
"""Windows PowerShell 5.1 (always installed) and an environment it can load its own modules in: started from
|
||||
PowerShell 7 (pwsh), PSModulePath points at pwsh's modules and 5.1 fails to load Microsoft.PowerShell.Security /
|
||||
.Management (Get-AuthenticodeSignature, Copy-Item). Without PSModulePath it rebuilds its default."""
|
||||
exe = Path(os.environ.get("SystemRoot", r"C:\Windows")) / "System32/WindowsPowerShell/v1.0/powershell.exe"
|
||||
env = {k: v for k, v in os.environ.items() if k.upper() != "PSMODULEPATH"}
|
||||
env = {k: v for k, v in clean_env().items() if k.upper() != "PSMODULEPATH"}
|
||||
return (str(exe) if exe.exists() else "powershell"), env
|
||||
|
||||
|
||||
@@ -683,7 +698,8 @@ def apply(app: Path, target: Path | None = None, relaunch: bool = True, pid: int
|
||||
"Hidden", "-File", str(script)], env=env)
|
||||
else:
|
||||
proc = subprocess.Popen(["/bin/sh", str(script)], start_new_session=not wait, close_fds=True,
|
||||
stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
|
||||
env=clean_env())
|
||||
if not wait: # make sure the script really runs before FramePort quits (it logs first thing)
|
||||
deadline = time.time() + START_TIMEOUT
|
||||
while time.time() < deadline:
|
||||
|
||||
@@ -406,8 +406,12 @@ def unregister(schemes=None) -> dict:
|
||||
def apply_setting() -> dict | None:
|
||||
"""At GUI start: register the enabled schemes (never taking one from another program) and remove FramePort's
|
||||
registration of the disabled ones. Errors are logged, never raised (links are a convenience)."""
|
||||
# an isolated data dir (FRAMEPORT_HOME: tests, screenshots) never takes over the user's link handler
|
||||
if os.environ.get("FRAMEPORT_NO_LINK_HANDLER") or os.environ.get("FRAMEPORT_HOME") or not platform_kind():
|
||||
# an isolated data dir (FRAMEPORT_HOME: tests, screenshots) never takes over the user's link handler, nor does a
|
||||
# WSL run on the Windows copy's data (it would point the Windows copy's links at WSL)
|
||||
from .core.paths import shares_windows_data
|
||||
|
||||
if (os.environ.get("FRAMEPORT_NO_LINK_HANDLER") or os.environ.get("FRAMEPORT_HOME") or shares_windows_data()
|
||||
or not platform_kind()):
|
||||
return None
|
||||
try:
|
||||
off = [s for s in SCHEMES if not enabled(s)]
|
||||
|
||||
@@ -16,8 +16,10 @@ def launch_test(frame: Frame, package: str, reporter: Reporter, seconds: int = 4
|
||||
return TriageResult("UNKNOWN", None), ""
|
||||
log = frame.get_text(res["log"]) if res.get("log_size") else ""
|
||||
crash = frame.get_text(res["crash_log"]) if res.get("crash_log") else "" # tombstones (backtraces), agent >= 23
|
||||
result = triage(log, res["state"], package, crash=crash[-256 * 1024:])
|
||||
reporter.check("Process", res["state"] == "RUNNING", f"{res['state']} after {res['elapsed']}s")
|
||||
result = triage(log, res["state"], package, crash=crash[-256 * 1024:], headless=True)
|
||||
reporter.check("Process", res["state"] == "RUNNING" or (None if result.headless_end else False),
|
||||
f"{res['state']} after {res['elapsed']}s"
|
||||
+ (f" (after {result.headless_end}: expected without the headset)" if result.headless_end else ""))
|
||||
for m in result.milestones:
|
||||
reporter.check(m, True)
|
||||
if result.fps:
|
||||
|
||||
@@ -30,11 +30,12 @@ class TriageResult:
|
||||
milestones: list[str] = field(default_factory=list)
|
||||
findings: list[Finding] = field(default_factory=list)
|
||||
fps: float | None = None
|
||||
headless_end: str | None = None # launch test: the session ended for lack of a worn headset (label), see triage()
|
||||
|
||||
@property
|
||||
def verdict(self) -> str:
|
||||
fatal = [f for f in self.findings if f.severity == "fatal"]
|
||||
if self.state == "RUNNING" and not fatal:
|
||||
if (self.state == "RUNNING" or self.headless_end) and not fatal:
|
||||
return "pass"
|
||||
return "fail" if fatal or self.state in ("EXITED", "NEVER_STARTED") else "unknown"
|
||||
|
||||
@@ -114,9 +115,10 @@ def split_suggestion(s: str) -> tuple[str, str | None]:
|
||||
|
||||
|
||||
def triage(log: str, state: str = "UNKNOWN", package: str | None = None, crash: str = "",
|
||||
kernel: str = "") -> TriageResult:
|
||||
kernel: str = "", headless: bool = False) -> TriageResult:
|
||||
"""`crash` = the container's crash logcat (tombstones come from crash_dump's pid, so it isn't pid-filtered);
|
||||
`kernel` = kernel log lines of a play session ("kernel: …", GPU hangs; agent session_log)."""
|
||||
`kernel` = kernel log lines of a play session ("kernel: …", GPU hangs; agent session_log); `headless` = a launch
|
||||
test (no headset worn): what happens after a `headless_end` line doesn't count against the game."""
|
||||
db = database()
|
||||
kind = "pcvr" if package and package.startswith("rift.") else "quest" # Proton/Revive logs vs Lepton logcat
|
||||
lines = game_lines(log, package) if kind == "quest" else [ANSI.sub("", ln) for ln in log.splitlines()]
|
||||
@@ -149,11 +151,14 @@ def triage(log: str, state: str = "UNKNOWN", package: str | None = None, crash:
|
||||
hidden = {h for sig in db["signatures"] if any(f.id == sig["id"] for f in res.findings)
|
||||
for h in sig.get("supersedes") or []}
|
||||
res.findings = [f for f in res.findings if f.id not in hidden]
|
||||
if headless:
|
||||
_forgive_headless_end(res, lines, db.get("headless_end") or [])
|
||||
fps = re.findall(r"pacing: ([0-9.]+) fps", text)
|
||||
if fps:
|
||||
res.fps = float(fps[-1])
|
||||
stopped = frames_stopped(lines)
|
||||
if stopped and state == "RUNNING" and not any(f.severity == "fatal" for f in res.findings):
|
||||
if (stopped and state == "RUNNING" and not res.headless_end
|
||||
and not any(f.severity == "fatal" for f in res.findings)):
|
||||
res.findings.append(Finding(
|
||||
"frames-stopped", "fatal",
|
||||
f"The game stopped sending frames {stopped:.0f} s before the test ended although its process kept "
|
||||
@@ -162,6 +167,40 @@ def triage(log: str, state: str = "UNKNOWN", package: str | None = None, crash:
|
||||
return res
|
||||
|
||||
|
||||
def _forgive_headless_end(res: TriageResult, lines: list[str], markers: list[dict]) -> None:
|
||||
"""A launch test whose game sent paced frames until a `headless_end` line (the VR session ended because nobody
|
||||
wears the headset, e.g. the VrApi bridge's tracking deadline): an exit or crash after it is an artifact of the
|
||||
test (BlazeRush: zink DEVICE LOST + SIGSEGV in the GPU driver thread as the renderer tore down, GitHub #57).
|
||||
Findings first seen after that line become one info finding; the verdict then passes (TriageResult.verdict)."""
|
||||
hits = ((m, next((i for i, ln in enumerate(lines) if re.search(m["pattern"], ln)), None)) for m in markers)
|
||||
marker, at = next(((m, i) for m, i in hits if i is not None), (None, None))
|
||||
if at is None or not any("FrameBridge: pacing:" in ln for ln in lines[:at]):
|
||||
return # no such line, or no frames before it: the game never really ran
|
||||
when = _secs(lines[at])
|
||||
|
||||
def after(f: Finding) -> bool:
|
||||
i = next((i for i, ln in enumerate(lines) if f.evidence and f.evidence in ln.strip()), None)
|
||||
if i is None:
|
||||
return False
|
||||
t = _secs(lines[i])
|
||||
return t >= when if t is not None and when is not None else i > at
|
||||
|
||||
late = [f for f in res.findings if after(f)]
|
||||
res.findings = [f for f in res.findings if f not in late]
|
||||
res.headless_end = marker["label"]
|
||||
what = ", ".join(f.id for f in late) or "the game ended"
|
||||
res.findings.append(Finding(
|
||||
"headless-end", "info",
|
||||
f"The game ran (paced frames) until the VR session ended for lack of a worn headset ({marker['label']}). What "
|
||||
f"came after ({what}) is a side effect of this headless test and doesn't happen in the headset.", [],
|
||||
lines[at].strip()[:300]))
|
||||
|
||||
|
||||
def _secs(line: str) -> float | None:
|
||||
m = LOGCAT_TIME.match(line)
|
||||
return int(m[1]) * 3600 + int(m[2]) * 60 + int(m[3]) + int(m[4]) / 1000 if m else None
|
||||
|
||||
|
||||
MISSING_OBB = ("The game keeps its content in a data file (.obb) and none was installed: FramePort found no .obb "
|
||||
"files next to its APK. Unreal games then stop right after start without an error (GitHub #85). Put "
|
||||
"the .obb files in a folder named like the package (or obb/) next to the APK, add the folder again "
|
||||
|
||||
@@ -9,6 +9,7 @@ import pytest
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
|
||||
# modules that read settings at import time (UI) run during collection, before the per-test fixture below
|
||||
os.environ["FRAMEPORT_HOME"] = tempfile.mkdtemp(prefix="frameport-tests-")
|
||||
os.environ.pop("FRAMEPORT_WINDOWS_DATA", None) # a WSL dev shell may share the Windows data folder: never in tests
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
|
||||
BIN
Binary file not shown.
Vendored
+40
@@ -0,0 +1,40 @@
|
||||
// Test fixture for patches/frame/ovr_stable_user.py: OVRPort's helper that makes up the logged-in user id
|
||||
// (same instructions as libovrplatformloader.so in OVRPort runtimes 3.4.3-23204ea and 3.4.3-aa54c3f).
|
||||
// Build: aarch64-linux-android29-clang -shared -fPIC -nostdlib fakestableuser.S -o ../libfakestableuser_arm64.so
|
||||
.text
|
||||
.globl random
|
||||
.type random, %function
|
||||
random:
|
||||
mov x0, #7
|
||||
ret
|
||||
.size random, .-random
|
||||
|
||||
.globl fake_user_id
|
||||
.type fake_user_id, %function
|
||||
fake_user_id:
|
||||
stp x29, x30, [sp, #-16]!
|
||||
mov x29, sp
|
||||
bl random
|
||||
mov x8, #0xa7640000
|
||||
mov x9, #-0x7ffffffffffffffd
|
||||
movk x8, #0xb6b3, lsl #32
|
||||
movk x9, #1, lsl #32
|
||||
movk x8, #0xde0, lsl #48
|
||||
mul x8, x0, x8
|
||||
smulh x9, x8, x9
|
||||
add x8, x9, x8
|
||||
asr x9, x8, #30
|
||||
add x8, x9, x8, lsr #63
|
||||
mov x9, #0xec580000
|
||||
movk x9, #0x4835, lsl #32
|
||||
movk x9, #0x5344, lsl #48
|
||||
add x0, x8, x9
|
||||
ldp x29, x30, [sp], #16
|
||||
ret
|
||||
.size fake_user_id, .-fake_user_id
|
||||
|
||||
.globl ovr_GetLoggedInUserID
|
||||
.type ovr_GetLoggedInUserID, %function
|
||||
ovr_GetLoggedInUserID:
|
||||
b fake_user_id
|
||||
.size ovr_GetLoggedInUserID, .-ovr_GetLoggedInUserID
|
||||
@@ -324,3 +324,11 @@ def test_agent_collect_diag(monkeypatch, tmp_path):
|
||||
assert f["launch.log"].startswith("[... first 4000 bytes cut") and "files" not in json.loads(f["deployment.json"])
|
||||
assert res["listing"]["roots"]
|
||||
assert a.cmd_collect_diag({"package": "com.not.installed"})["installed"] is False
|
||||
|
||||
|
||||
def test_updater_never_uses_page_launch_url():
|
||||
"""GitHub #194: Flet 1.0's Page has no launch_url ("All releases" raised AttributeError)."""
|
||||
from pathlib import Path
|
||||
|
||||
src = Path(__file__).resolve().parents[1] / "src" / "frameport"
|
||||
assert not [p for p in src.rglob("*.py") if "page.launch_url(" in p.read_text(encoding="utf-8")]
|
||||
@@ -0,0 +1,52 @@
|
||||
"""One FramePort window at a time (core/instance.py)."""
|
||||
import subprocess
|
||||
import sys
|
||||
import textwrap
|
||||
|
||||
from frameport.core import instance
|
||||
|
||||
|
||||
def _hold_lock(path):
|
||||
"""A separate process holding the GUI lock (like a running FramePort)."""
|
||||
code = textwrap.dedent(f"""
|
||||
import sys, time
|
||||
sys.path.insert(0, {str(instance.__file__.rsplit('/frameport/', 1)[0])!r})
|
||||
from pathlib import Path
|
||||
from frameport.core import instance
|
||||
assert instance.acquire(Path({str(path)!r}))
|
||||
print("locked", flush=True)
|
||||
time.sleep(30)
|
||||
""")
|
||||
p = subprocess.Popen([sys.executable, "-c", code], stdout=subprocess.PIPE, text=True)
|
||||
assert p.stdout.readline().strip() == "locked"
|
||||
return p
|
||||
|
||||
|
||||
def test_second_start_is_refused_while_a_window_is_open(tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("FRAMEPORT_HOME", str(tmp_path))
|
||||
holder = _hold_lock(instance.lock_file())
|
||||
try:
|
||||
assert instance.holder() == holder.pid
|
||||
assert not instance.acquire()
|
||||
assert instance.claim(lambda: True) is False # a window answers: it's asked to come to the front
|
||||
assert instance.take_focus_request() and not instance.take_focus_request()
|
||||
# no window answers, but the holder isn't a FramePort GUI (or is still starting): it's left alone
|
||||
assert instance.claim(lambda: False, retries=1) is False
|
||||
assert holder.poll() is None
|
||||
finally:
|
||||
holder.kill()
|
||||
holder.wait()
|
||||
assert instance.acquire() # released by the OS when the holder ends
|
||||
|
||||
|
||||
def test_leftover_frameport_gui_is_ended(tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("FRAMEPORT_HOME", str(tmp_path))
|
||||
holder = _hold_lock(instance.lock_file())
|
||||
monkeypatch.setattr(instance, "_is_frameport_gui", lambda pid: pid == holder.pid)
|
||||
monkeypatch.setattr(instance, "STARTUP_GRACE", 0.0)
|
||||
try:
|
||||
assert instance.claim(lambda: False) is True # no window: the leftover process is ended, the lock taken
|
||||
assert holder.wait(5) is not None
|
||||
finally:
|
||||
if holder.poll() is None:
|
||||
holder.kill()
|
||||
@@ -108,6 +108,9 @@ def frame_tree(root, home):
|
||||
proc(root, 302, "lus4xvrplayerov", 301, cpu=50, fds={3: ("/dev/kgsl-3d0", 5000)},
|
||||
cgroup="/user.slice/libpod-abc.scope/container", cmdline=["cn.vr4p.oculus4xvrplayerov"])
|
||||
proc(root, 400, "bash", 1, cmdline=["bash", "-c", "sleep 9"])
|
||||
# the agent's shortcut worker during an uninstall names the game's launch.sh: not the game
|
||||
proc(root, 500, "python3", 1, cmdline=["python3", "{agent}", "_shortcuts_worker",
|
||||
json.dumps({"remove": [{"exe": f'"{launcher}"'}]})])
|
||||
return base
|
||||
|
||||
|
||||
@@ -119,6 +122,9 @@ def fa(monkeypatch, tmp_path):
|
||||
a = load_agent(monkeypatch, home)
|
||||
root = tmp_path / "frame"
|
||||
frame_tree(root, home)
|
||||
agent_file = next(iter(a.AGENT_FILES))
|
||||
cmd = root / "proc" / "500" / "cmdline"
|
||||
cmd.write_text(cmd.read_text().replace("{agent}", agent_file))
|
||||
monkeypatch.setattr(a, "PROC", str(root / "proc"))
|
||||
monkeypatch.setattr(a, "SYS", str(root / "sys"))
|
||||
monkeypatch.setattr(a, "POWER_SUPPLY", str(root / "power_supply"))
|
||||
@@ -177,6 +183,7 @@ def test_processes_games_and_filters(fa):
|
||||
assert 3 not in names and 2 not in names # kernel threads
|
||||
assert {names[pid]["game"] for pid in (200, 300, 301, 302)} == {GAME}
|
||||
assert names[100]["group"] == "steam" and names[101]["group"] == "steamvr" and names[400]["group"] == "other"
|
||||
assert names[500]["game"] is None
|
||||
assert names[302]["name"] == "cn.vr4p.oculus4xvrplayerov" # the full name, not the truncated comm
|
||||
assert names[101]["critical"] and names[1]["locked"]
|
||||
# default filter: the game's processes + the busiest others as context
|
||||
|
||||
@@ -894,3 +894,35 @@ def test_bonelab_recipe_serves_both_builds():
|
||||
old, new = _analysis(engine="Unity", libs=libs), _analysis(engine="Unity", libs=libs + ["libSLZQuestNative.so"])
|
||||
assert presence.applies(old) and presence.applies(new)
|
||||
assert not hooks.applies(old) and hooks.applies(new)
|
||||
|
||||
|
||||
def test_ovr_stable_user_pins_the_made_up_user_id():
|
||||
"""GitHub #182: OVRPort makes up a new user id at every start (6e18 + random()); games lose saves filed under it."""
|
||||
from frameport.analysis import elf
|
||||
from frameport.patches.frame.ovr_stable_user import BASE_ID, find_helper, pin_user_id, stable_id
|
||||
|
||||
lib = _fixture("libfakestableuser_arm64.so")
|
||||
assert find_helper(lib) is not None
|
||||
uid = stable_id("com.example.game", b"keystore")
|
||||
assert BASE_ID <= uid < BASE_ID + 2**32
|
||||
assert uid == stable_id("com.example.game", b"keystore") != stable_id("com.example.other", b"keystore")
|
||||
assert uid != stable_id("com.example.game", b"another user's keystore")
|
||||
out = pin_user_id(lib, uid)
|
||||
assert out is not None and len(out) == len(lib)
|
||||
ins = [(m, o) for _, m, o in elf.text_instructions(out)]
|
||||
start = next(i for i, (m, o) in enumerate(ins) if m == "mov" and o.startswith("x0,") and ins[i + 1][0] == "movk")
|
||||
assert [m for m, _ in ins[start:start + 5]] == ["mov", "movk", "movk", "movk", "ret"]
|
||||
value = 0
|
||||
for i, (_, o) in enumerate(ins[start:start + 4]):
|
||||
imm = int(o.split("#")[1].split(",")[0], 0)
|
||||
value |= imm << (16 * i)
|
||||
assert value == uid
|
||||
assert not any(m == "bl" for m, _ in ins[start:start + 5]) # random() isn't called any more
|
||||
assert pin_user_id(out, uid) is None # idempotent
|
||||
assert pin_user_id(_fixture("libfakemicrophone_arm64.so"), uid) is None # not OVRPort's helper
|
||||
|
||||
|
||||
def test_ovr_stable_user_suggested_for_platform_games():
|
||||
p = base.get("frame.ovr_stable_user")
|
||||
assert p.detect(_analysis(engine="Unity", libs=["libovrplatformloader.so", "libunity.so"])).recommended
|
||||
assert p.detect(_analysis(engine="Unity", libs=["libunity.so"])) is None
|
||||
@@ -0,0 +1,73 @@
|
||||
"""A data folder shared by a Windows copy and WSL source runs (FRAMEPORT_WINDOWS_DATA)."""
|
||||
import json
|
||||
|
||||
from frameport.core import paths
|
||||
from frameport.tools import cpp2il, toolchain
|
||||
|
||||
|
||||
def test_local_path_on_windows(monkeypatch):
|
||||
monkeypatch.setattr(paths.sys, "platform", "win32")
|
||||
assert paths.local_path("/mnt/d/Games/X/a.apk") == "D:\\Games\\X\\a.apk"
|
||||
assert paths.local_path("/mnt/c") == "C:\\"
|
||||
assert paths.local_path("/home/steamos/Applications/x") == "/home/steamos/Applications/x" # Frame paths stay
|
||||
assert paths.local_path("D:\\Games") == "D:\\Games"
|
||||
|
||||
|
||||
def test_local_path_on_wsl(monkeypatch):
|
||||
monkeypatch.setattr(paths.sys, "platform", "linux")
|
||||
monkeypatch.setattr(paths, "shares_windows_data", lambda: True)
|
||||
assert paths.local_path("D:\\Games\\X\\a.apk") == "/mnt/d/Games/X/a.apk"
|
||||
assert paths.local_path("C:/Users/A") == "/mnt/c/Users/A"
|
||||
assert paths.local_path("/mnt/d/Games") == "/mnt/d/Games"
|
||||
monkeypatch.setattr(paths, "shares_windows_data", lambda: False)
|
||||
assert paths.local_path("D:\\Games") == "D:\\Games" # own data folder: left alone
|
||||
|
||||
|
||||
def test_localize_walks_json(monkeypatch):
|
||||
monkeypatch.setattr(paths.sys, "platform", "win32")
|
||||
data = {"games": {"a": {"apk": "/mnt/d/x.apk", "build": {"checks": [{"detail": "see /mnt/d/x"}]},
|
||||
"list": ["/mnt/e/y"], "n": 3, "title": "Cool"}}}
|
||||
paths.localize(data)
|
||||
g = data["games"]["a"]
|
||||
assert g["apk"] == "D:\\x.apk" and g["list"] == ["E:\\y"]
|
||||
assert g["build"]["checks"][0]["detail"] == "see /mnt/d/x" # only whole-string paths
|
||||
assert g["n"] == 3 and g["title"] == "Cool"
|
||||
|
||||
|
||||
def test_windows_data_only_when_asked(monkeypatch):
|
||||
monkeypatch.delenv("FRAMEPORT_WINDOWS_DATA", raising=False)
|
||||
assert not paths.shares_windows_data()
|
||||
monkeypatch.setenv("FRAMEPORT_WINDOWS_DATA", "1")
|
||||
assert not paths.shares_windows_data() # FRAMEPORT_HOME (set by the test fixtures) wins
|
||||
|
||||
|
||||
def test_java_entry_per_os(monkeypatch, tmp_path):
|
||||
monkeypatch.setattr(toolchain, "tools_dir", lambda: tmp_path)
|
||||
monkeypatch.delenv("FRAMEPORT_JAVA", raising=False)
|
||||
monkeypatch.setattr(toolchain.sys, "platform", "linux")
|
||||
linux_java = tmp_path / "jre-21" / "bin" / "java"
|
||||
linux_java.parent.mkdir(parents=True)
|
||||
linux_java.write_text("")
|
||||
# a legacy single entry written by Windows isn't this OS's java
|
||||
(tmp_path / "tools.json").write_text(json.dumps({"java": {"version": "21", "path": "C:\\\\x\\\\java.exe"}}))
|
||||
assert toolchain.java_path() is None
|
||||
(tmp_path / "tools.json").write_text(json.dumps({"java": {"version": "21", "path": str(linux_java)}}))
|
||||
assert toolchain.java_path() == linux_java
|
||||
(tmp_path / "tools.json").write_text(json.dumps({
|
||||
"java": {"version": "21", "path": "C:\\\\x\\\\java.exe"},
|
||||
toolchain._java_key(): {"version": "21", "path": str(linux_java)}}))
|
||||
assert toolchain.java_path() == linux_java
|
||||
|
||||
|
||||
def test_cpp2il_picks_this_os_exe(monkeypatch, tmp_path):
|
||||
monkeypatch.setattr(cpp2il, "tools_dir", lambda: tmp_path)
|
||||
monkeypatch.delenv("FRAMEPORT_CPP2IL", raising=False)
|
||||
d = tmp_path / "cpp2il-2022.1"
|
||||
d.mkdir()
|
||||
(d / "Cpp2IL.exe").write_text("")
|
||||
monkeypatch.setattr(cpp2il.sys, "platform", "linux")
|
||||
assert cpp2il.path() is None
|
||||
(d / "Cpp2IL").write_text("")
|
||||
assert cpp2il.path() == d / "Cpp2IL"
|
||||
monkeypatch.setattr(cpp2il.sys, "platform", "win32")
|
||||
assert cpp2il.path() == d / "Cpp2IL.exe"
|
||||
@@ -330,3 +330,34 @@ LeptonProcessObserver: Target app (com.example.game) did not start.
|
||||
real = "09-28 17:39:01.000 1000 1000 I ActivityManager: Start proc 1150:com.example.game/u0a55 for activity\n" \
|
||||
"09-28 17:39:05.000 1150 1150 I GameActivity: System.exit called, status: 0\n"
|
||||
assert "force-quit" in [f.id for f in triage(real, "EXITED", package="com.example.game").findings]
|
||||
|
||||
|
||||
HEADLESS_END = """
|
||||
10-11 16:35:09.900 1000 1000 I ActivityManager: Start proc 1192:ru.targem.blazerush/u0a14 for activity
|
||||
10-11 16:35:12.282 1192 1222 I FrameBridge: xrCreateInstance result=0
|
||||
10-11 16:35:18.219 1192 1222 I FrameBridge: pacing: 68.7 fps, displayTime vs predicted: avg 0.00 ms, max 0.00 ms
|
||||
10-11 16:35:38.316 1192 1222 I FrameBridge: pacing: 72.2 fps, displayTime vs predicted: avg 0.00 ms, max 0.00 ms
|
||||
10-11 16:35:43.150 1192 1222 I OVRPortVrApi: EnterVrMode: no tracked head pose before deadline
|
||||
10-11 16:35:52.086 1192 1248 E MESA : zink: DEVICE LOST!
|
||||
10-11 16:35:52.087 1192 1248 F libc : Fatal signal 11 (SIGSEGV), code 1 (SEGV_MAPERR), fault addr 0x1a08
|
||||
"""
|
||||
|
||||
|
||||
def test_crash_after_the_headless_tracking_deadline_passes_a_launch_test():
|
||||
"""BlazeRush (GitHub #57): its launch test failed on the GPU crash that follows the VrApi bridge ending the session
|
||||
for lack of a worn headset; that never happens in the headset."""
|
||||
r = triage(HEADLESS_END, "EXITED", "ru.targem.blazerush", headless=True)
|
||||
assert r.verdict == "pass" and r.headless_end
|
||||
assert [f.id for f in r.findings] == ["headless-end"] and r.findings[0].severity == "info"
|
||||
assert "zink-device-lost" in r.findings[0].diagnosis
|
||||
# a play session (not headless) keeps the crash
|
||||
assert triage(HEADLESS_END, "EXITED", "ru.targem.blazerush").verdict == "fail"
|
||||
# a crash before the deadline still fails
|
||||
early = HEADLESS_END.replace("16:35:52.08", "16:35:40.08")
|
||||
early_lines = early.strip().splitlines()
|
||||
early = "\n".join(early_lines[:4] + early_lines[5:] + early_lines[4:5])
|
||||
r = triage(early, "EXITED", "ru.targem.blazerush", headless=True)
|
||||
assert r.verdict == "fail" and {"zink-device-lost", "native-crash"} <= {f.id for f in r.findings}
|
||||
# no frames before the deadline: the game never ran
|
||||
no_frames = "\n".join(ln for ln in HEADLESS_END.splitlines() if "pacing:" not in ln)
|
||||
assert triage(no_frames, "EXITED", "ru.targem.blazerush", headless=True).verdict == "fail"
|
||||
@@ -411,3 +411,13 @@ def test_pending_news_shows_once_and_waits_while_offline():
|
||||
library.set_setting("update.last_seen_version", None)
|
||||
library.set_setting("update.last_check", 1.0) # updated from an older FramePort
|
||||
assert [e.version for e in updates.pending_news("0.9.2", entries)] == ["0.9.2"]
|
||||
|
||||
|
||||
def test_relaunch_environment_drops_the_running_apps_own_variables():
|
||||
"""GitHub #195: the relaunched app inherited the old app's Flet/embedded-Python variables and stayed black."""
|
||||
from frameport import updates
|
||||
|
||||
env = updates.clean_env({"PATH": "/bin", "FLET_SERVER_UDS_PATH": "/tmp/old.sock", "flet_platform": "windows",
|
||||
"SERIOUS_PYTHON_SITE_PACKAGES": "x", "PYTHONHOME": "C:/Temp/serious_python_temp",
|
||||
"PYTHONPATH": "y", "USERPROFILE": "C:/Users/u", "PSModulePath": "z"})
|
||||
assert env == {"PATH": "/bin", "USERPROFILE": "C:/Users/u", "PSModulePath": "z"}
|
||||
Reference in new issue
Block a user