Compare commits

...
Author SHA1 Message Date
toorux 2c7863dcfb Release Framely 0.5.1-preview.3 2026-10-07 16:36:13 +08:00
toorux 7e374a669a Emit Android L2 and R2 button events alongside trigger axes 2026-10-07 16:27:04 +08:00
toorux b1d0c739b2 Recover renamed Steam APK shortcuts after partial registration 2026-10-07 16:21:27 +08:00
toorux 73fa970021 Allocate independent APK contexts around legacy occupied names 2026-10-07 16:01:03 +08:00
toorux 73d2d4289b Release Framely 0.5.1-preview.2 2026-10-07 15:54:58 +08:00
toorux 3b7382e1a0 Pin installed release version in update notification tests 2026-10-07 15:49:00 +08:00
toorux d24aa708a7 Reduce launcher rendering scale to 1.5x 2026-10-07 15:37:38 +08:00
toorux c64bdfb374 Release Framely 0.5.1-preview.1 2026-10-07 15:25:20 +08:00
toorux 1fc2e32f26 Handle empty Lepton sm output when checking Android external storage 2026-10-07 15:24:19 +08:00
toorux 3d2899fb6e Use quiet Steam keyboard clicks for UI sound feedback 2026-10-07 14:32:57 +08:00
toorux 6589f85ec6 List named Remote Play hosts in redesigned localized launch chooser 2026-10-07 14:32:50 +08:00
toorux e8c406ffca Disable UI sound feedback by default while preserving preferences 2026-10-07 14:31:56 +08:00
toorux 16fb76c579 Move compact plugin install button before manager tabs 2026-10-07 14:16:47 +08:00
toorux c75896541c Release Framely 0.5.0-preview.2 2026-10-07 14:12:48 +08:00
toorux 36e1c04758 Fix native host poll regression test request order 2026-10-07 14:11:15 +08:00
toorux 882b22aa62 Release Framely 0.5.0-preview.1 2026-10-07 13:57:02 +08:00
toorux 782b6ab419 Use consistent typed placeholders for missing application icons 2026-10-07 13:50:31 +08:00
toorux b22d7e9fc3 Make retained-container APK uninstall readiness and cleanup retry-safe 2026-10-07 13:45:23 +08:00
toorux accae9cfbf Include APK and Lepton Android logs in diagnostic exports 2026-10-07 13:35:35 +08:00
toorux 70862a79d8 ui(apk): simplify installation review and update confirmation 2026-10-07 13:27:06 +08:00
toorux 386c131a66 feat(apk): offer exclusive container deletion during uninstall 2026-10-07 13:24:12 +08:00
toorux 9b5e25cdf9 Add configurable UI haptic and Steam sound feedback 2026-10-07 13:21:14 +08:00
toorux dec35d7529 Launch flat APK tasks in fullscreen without restarting games 2026-10-07 13:09:30 +08:00
toorux 45de17f617 Fix Steam gamepad startup and device event processing 2026-10-07 13:09:23 +08:00
toorux 7c130038f6 Clean owned container artifacts and remove Steam library artwork 2026-10-07 13:04:14 +08:00
toorux 3ce1a9142f Finish APK installation runtime before native Steam launch 2026-10-07 12:28:09 +08:00
toorux 78010a93d8 feat(gamepad): bridge Steam Input and Android rumble 2026-10-07 12:14:56 +08:00
toorux d2531168fa chore(release): bump core and installer preview versions 2026-10-07 11:57:25 +08:00
toorux fe7d0f6df5 fix(gamepad): match Xbox Android X and Y scan codes 2026-10-07 11:53:21 +08:00
toorux fbd3f9cfa3 feat(launcher): offer local and Remote Play launch choices 2026-10-07 11:46:11 +08:00
toorux 6a50b4a74b feat(apk): make persistent Steam entries optional 2026-10-07 11:45:58 +08:00
toorux 0359f24879 feat(installer): add persistent system and custom proxy settings 2026-10-07 11:35:35 +08:00
toorux d83397ac20 feat(launcher): show delayed two-stage icon hold progress 2026-10-07 11:35:35 +08:00
toorux 6d2b4ca0a0 fix(apk): label containers by app and offer close action during install 2026-10-07 11:35:35 +08:00
toorux 77a10fbdd3 fix(input): give Dock entry priority over launcher gaze presses 2026-10-07 11:25:51 +08:00
toorux 9405d4798d fix(dock): reject stale hold timing and draw blue border progress 2026-10-07 11:22:03 +08:00
toorux 550ca817e5 fix(dock): correct texture orientation and separate hold feedback timing 2026-10-07 11:15:52 +08:00
toorux de65f8dbef fix(dock): stabilize hold textures and refine progress ring 2026-10-07 11:10:42 +08:00
toorux 3a76271878 fix(launcher): use compositor fades and reset interrupted visibility 2026-10-07 03:15:41 +08:00
toorux ce3b460fcb feat(dock): use click and hold entry gestures with progress ring 2026-10-07 03:02:01 +08:00
toorux 09320554bb release: prepare v0.4.5-preview.1 2026-10-07 02:57:29 +08:00
toorux 5a69f95cc7 fix(apk): isolate gamepad identities and route native input independently 2026-10-07 02:57:26 +08:00
toorux 96986f533e fix(apk): release native gamepad after confirmed launch exit 2026-10-07 02:36:05 +08:00
toorux 5a2bb2dacd fix(apk): retain gamepad and storage ownership across native launch 2026-10-07 02:28:27 +08:00
toorux 0ec7afeafa fix(apk): use data-preserving native Steam launches and app artwork 2026-10-07 02:15:02 +08:00
toorux e205d3bae6 Avoid syncing unchanged APK inventory state 2026-10-07 02:00:47 +08:00
toorux efe5f9b3e9 docs(apk): record verified Wayland close limitation of Steam wrapping 2026-10-07 01:40:32 +08:00
toorux dfce767894 fix(apk): allow Steam cold launch after transient container removal 2026-10-07 01:36:59 +08:00
toorux 17af2ebfd5 fix(apk): use Steam-compatible temporary Devkit responses 2026-10-07 01:32:42 +08:00
toorux d31915e4ee Optimize Android resource storage and persist shader cache with Steam launch integration 2026-10-07 01:25:43 +08:00
toorux d180622a53 Optimize APK and file manager uploads with concurrent chunks 2026-10-07 00:50:36 +08:00
toorux df9969ee58 fix(apk): reject stale running state after container processes exit 2026-10-07 00:36:39 +08:00
toorux fe7edfea3f refactor(apk): move global preferences into dedicated settings page 2026-10-07 00:35:33 +08:00
toorux 82e1e66047 feat(apk): add conservative container lifecycle controls 2026-10-07 00:25:00 +08:00
toorux fcaaa561ce fix(launcher): restore Dock windows and add bounded UI scheduling priority 2026-10-07 00:02:06 +08:00
toorux 831f3707d3 fix(apk): reuse hidden containers and hand off launched windows promptly 2026-10-07 00:00:15 +08:00
toorux 98bb7cfa6c perf(apk): reuse verified installations and batch launch checks 2026-10-06 23:50:28 +08:00
toorux d1d55ee391 fix(apk): wait for Android boot and storage before app startup 2026-10-06 23:25:54 +08:00
toorux 541066da6d Keep unavailable APK launcher icons visible across container handoffs 2026-10-06 22:38:50 +08:00
toorux bdc2148619 Harden gamepad cleanup and isolate concurrent APK tests 2026-10-06 22:32:19 +08:00
toorux 0871352331 Extract high-density APK launcher icons 2026-10-06 22:31:16 +08:00
toorux ca5beaf95e Guard Lepton storage setup and preserve partial game updates 2026-10-06 22:27:49 +08:00
toorux 127976d8b7 Require independent containers for new APK applications 2026-10-06 22:26:19 +08:00
toorux 435f8cc839 Reuse running APK sessions and preserve input after launch failure 2026-10-06 22:25:04 +08:00
toorux c88da85414 Retain Lepton gamepads through application handoffs 2026-10-06 22:22:36 +08:00
toorux 5d713d4838 Inspect Frame-local APK selections without browser upload 2026-10-06 22:14:30 +08:00
toorux 45c12b26b3 Preserve APKs and downloaded resources across Lepton container restarts 2026-10-06 22:10:03 +08:00
toorux 651663ad1d Add opt-in Frame controller input for Lepton APKs 2026-10-06 21:52:39 +08:00
toorux 26643ed11d Restore subtle translucent backgrounds across manager pages and terminal 2026-10-06 20:46:27 +08:00
toorux 1b95f3a14a Keep file quick access fixed above independently scrolling folder tree 2026-10-06 20:39:08 +08:00
toorux e71ba84f1d Highlight installer management action and open panel after first installation 2026-10-06 20:30:54 +08:00
toorux e9384c0cfc Fix file sidebar scrolling and navigation with persistent resizing and context menus 2026-10-06 20:30:51 +08:00
toorux 0c0f23dee0 Redesign terminal workspace and add copy and paste shortcuts 2026-10-06 20:30:41 +08:00
toorux 3a9dc0a5a5 fix: fill manager content with the file workspace 2026-10-06 20:12:07 +08:00
toorux b925856276 refactor: redesign file manager as a compact desktop workspace 2026-10-06 20:10:21 +08:00
toorux 8769717242 fix: separate file quick access and tree in a horizontal layout 2026-10-06 20:02:47 +08:00
toorux 32c3992f95 docs: document manager terminal and file workflows in both languages 2026-10-06 19:57:15 +08:00
toorux 948836c99a fix: handle file navigation and transfer boundaries safely 2026-10-06 19:57:03 +08:00
toorux ae096ba3a1 fix: show terminal close errors inside confirmation 2026-10-06 19:56:57 +08:00
toorux 2664d953cd feat: add user file management, transfers, editing and media preview 2026-10-06 19:47:24 +08:00
toorux e32d3d9155 fix: keep local terminal usable without a network connection 2026-10-06 19:47:22 +08:00
toorux abe7f6e49d feat: add persistent user terminal sessions to manager 2026-10-06 19:45:43 +08:00
toorux 1df96e1de7 refactor: organize manager navigation into five sections 2026-10-06 19:12:15 +08:00
toorux 590ce561eb fix: crop all launcher artwork to centered circles 2026-10-06 18:54:49 +08:00
toorux f937260387 fix: improve APK parsing, container launches and window orientation 2026-10-06 18:54:20 +08:00
toorux fb169e9cdb feat: refine launcher glass and startup feedback with APK display modes 2026-10-06 18:07:44 +08:00
toorux 88261cd5ae feat: add gaze calibration and refine launcher appearance and APK startup 2026-10-06 17:21:55 +08:00
toorux f102d78804 chore: release 0.4.4-preview.1 2026-10-06 01:50:03 +08:00
toorux 7719ddd9a8 Merge feat/apk-manager into main 2026-10-06 01:45:35 +08:00
toorux a04c445210 feat: provide native plugin scrolling and refine launcher interactions 2026-10-06 01:45:35 +08:00
toorux 57d70f807b feat: add Frame file picker and refine launcher drag paging 2026-10-06 01:19:20 +08:00
toorux 142fd2a345 fix: prioritize the middle row in launcher layouts 2026-10-06 00:59:29 +08:00
toorux bf73601f9c fix: harden sideload management and add launcher install shortcut 2026-10-06 00:56:16 +08:00
toorux dd990dd401 Merge main into feat/apk-manager 2026-10-06 00:11:29 +08:00
toorux 66fe29b024 chore: release v0.4.3-preview.6 2026-10-06 00:06:26 +08:00
toorux 85017b2c54 fix: isolate launcher operations and bound application handoffs 2026-10-06 00:05:29 +08:00
toorux 5e0bb582f0 feat: add Lepton APK installation and management 2026-10-05 23:52:32 +08:00
toorux 4fb5eeb5a7 Update README screenshots and installation instructions 2026-10-05 22:39:19 +08:00
toorux 3bbc502481 Fix batch install test ownership for CI runners 2026-10-05 22:12:54 +08:00
toorux 0037d4f0ba Release 0.4.3-preview.4 with smoother launcher and page scrolling 2026-10-05 22:02:55 +08:00
toorux 0d19314106 Release 0.4.3-preview.3 with launcher search and UI refinements 2026-10-05 21:04:49 +08:00
toorux e2348280c1 Clear uninstall safe mode guard after successful cleanup and reinstall 2026-10-05 19:28:34 +08:00
toorux 148bb96ab6 Release 0.4.3-preview.2 with spatial launcher and diagnostic exports 2026-10-05 19:22:32 +08:00
212 changed files with 24987 additions and 340 deletions

No files matched your search

Generated
+611 -11
View File
@@ -8,6 +8,26 @@ version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
[[package]]
name = "ahash"
version = "0.7.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "891477e0c6a8957309ee5c45a6368af3ae14bb510732d2684ffa19af310920f9"
dependencies = [
"getrandom 0.2.17",
"once_cell",
"version_check",
]
[[package]]
name = "aho-corasick"
version = "1.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba"
dependencies = [
"memchr",
]
[[package]]
name = "anstream"
version = "1.0.0"
@@ -79,12 +99,43 @@ version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d92bec98840b8f03a5ff5413de5293bfcd8bf96467cf5452609f939ec6f5de16"
[[package]]
name = "autocfg"
version = "1.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
[[package]]
name = "base64"
version = "0.22.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
[[package]]
name = "bincode"
version = "2.0.0-rc.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7bb50c5a2ef4b9b1e7ae73e3a73b52ea24b20312d629f9c4df28260b7ad2c3c4"
dependencies = [
"bincode_derive",
"serde",
]
[[package]]
name = "bincode_derive"
version = "2.0.0-rc.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0a45a23389446d2dd25dc8e73a7a3b3c43522b630cac068927f0649d43d719d2"
dependencies = [
"virtue",
]
[[package]]
name = "bitflags"
version = "1.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
[[package]]
name = "bitflags"
version = "2.13.2"
@@ -106,6 +157,24 @@ version = "3.20.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649"
[[package]]
name = "bytemuck"
version = "1.25.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "95832e849adfb21180ccb6826a99da14e5d266ae5c2e668e1602cf234f153797"
[[package]]
name = "byteorder-lite"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8f1fe948ff07f4bd06c30984e69f5b4899c516a3ef74f34df92a2df2ab535495"
[[package]]
name = "bytes"
version = "1.12.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04"
[[package]]
name = "cc"
version = "1.5.1"
@@ -113,6 +182,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f360145194ee8e21db5ee7f3fcd4fe52210864c75c985dae33218202c8bbe040"
dependencies = [
"find-msvc-tools",
"jobserver",
"libc",
"shlex",
]
@@ -122,6 +193,12 @@ version = "1.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
[[package]]
name = "cfg_aliases"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fd16c4719339c4530435d38e511904438d07cce7950afa3718a84ac36c10e89e"
[[package]]
name = "chunked_transfer"
version = "1.5.0"
@@ -183,6 +260,12 @@ dependencies = [
"libc",
]
[[package]]
name = "crawdad"
version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "87fbd1ecd2ed790e11c8fbe034f9b3e7687404818d1bdfd8218d26ec645ec7c5"
[[package]]
name = "crc32fast"
version = "1.5.2"
@@ -208,6 +291,21 @@ dependencies = [
"typenum",
]
[[package]]
name = "csv-core"
version = "0.1.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "704a3c26996a80471189265814dbc2c257598b96b8a7feae2d31ace646bb9782"
dependencies = [
"memchr",
]
[[package]]
name = "data-encoding"
version = "2.11.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4583a4551df46e2792f82ceeac45e850d2e2d5debba0b91f102385cda5b11f06"
[[package]]
name = "derive_arbitrary"
version = "1.4.2"
@@ -241,6 +339,12 @@ dependencies = [
"syn 3.0.6",
]
[[package]]
name = "downcast-rs"
version = "1.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "75b325c5dbd37f80359721ad39aca5a29fb04c89279657cffdda8736d0c0b9d2"
[[package]]
name = "equivalent"
version = "1.0.2"
@@ -263,6 +367,36 @@ version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223"
[[package]]
name = "fdeflate"
version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1e6853b52649d4ac5c0bd02320cddc5ba956bdb407c4b75a2c6b75bf51500f8c"
dependencies = [
"simd-adler32",
]
[[package]]
name = "filedescriptor"
version = "0.8.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e40758ed24c9b2eeb76c35fb0aebc66c626084edd827e07e1552279814c6682d"
dependencies = [
"libc",
"thiserror 1.0.69",
"winapi",
]
[[package]]
name = "filetime"
version = "0.2.29"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c287a33c7f0a620c38e641e7f60827713987b3c0f26e8ddc9462cc69cf75759"
dependencies = [
"cfg-if",
"libc",
]
[[package]]
name = "find-msvc-tools"
version = "0.1.14"
@@ -276,7 +410,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6e634e2e0ebac1ee034020da1ca582e17ffe4e0f5e985823721e168928136dcb"
dependencies = [
"crc32fast",
"miniz_oxide",
"miniz_oxide 0.9.1",
"zlib-rs",
]
@@ -291,24 +425,33 @@ dependencies = [
[[package]]
name = "framely"
version = "0.4.3-preview.1"
version = "0.5.1-preview.3"
dependencies = [
"anyhow",
"base64",
"clap",
"flate2",
"hex",
"image",
"libc",
"pbkdf2",
"rand",
"pinyin",
"portable-pty",
"rand 0.8.8",
"semver",
"serde",
"serde_json",
"sha2",
"tar",
"tempfile",
"tiny_http",
"tungstenite",
"unicode-normalization",
"ureq",
"url",
"vibrato",
"zip",
"zstd",
]
[[package]]
@@ -332,6 +475,18 @@ dependencies = [
"wasi",
]
[[package]]
name = "getrandom"
version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd"
dependencies = [
"cfg-if",
"libc",
"r-efi 5.3.0",
"wasip2",
]
[[package]]
name = "getrandom"
version = "0.4.3"
@@ -340,7 +495,16 @@ checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099"
dependencies = [
"cfg-if",
"libc",
"r-efi",
"r-efi 6.0.0",
]
[[package]]
name = "hashbrown"
version = "0.12.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"
dependencies = [
"ahash",
]
[[package]]
@@ -370,6 +534,22 @@ dependencies = [
"digest",
]
[[package]]
name = "http"
version = "1.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "918d3568bebf352712bc2ef3d46a8bcf1a75b373be6539de198e9105cbbf9ce0"
dependencies = [
"bytes",
"itoa",
]
[[package]]
name = "httparse"
version = "1.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87"
[[package]]
name = "httpdate"
version = "1.0.3"
@@ -480,6 +660,32 @@ dependencies = [
"icu_properties",
]
[[package]]
name = "image"
version = "0.25.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "85ab80394333c02fe689eaf900ab500fbd0c2213da414687ebf995a65d5a6104"
dependencies = [
"bytemuck",
"byteorder-lite",
"image-webp",
"moxcms",
"num-traits",
"png",
"zune-core",
"zune-jpeg",
]
[[package]]
name = "image-webp"
version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "525e9ff3e1a4be2fbea1fdf0e98686a6d98b4d8f937e1bf7402245af1909e8c3"
dependencies = [
"byteorder-lite",
"quick-error",
]
[[package]]
name = "indexmap"
version = "2.14.2"
@@ -487,7 +693,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855"
dependencies = [
"equivalent",
"hashbrown",
"hashbrown 0.17.1",
]
[[package]]
@@ -502,6 +708,22 @@ version = "1.0.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
[[package]]
name = "jobserver"
version = "0.1.35"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1c00acbd29eabad4a2392fa0e921c874934dbbf4194312ad20f04a0ed67a3cb3"
dependencies = [
"getrandom 0.4.3",
"libc",
]
[[package]]
name = "lazy_static"
version = "1.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "20870f649af7073d53e38067b2a84312175d56ea15217e1b15bc83506ec50afb"
[[package]]
name = "libc"
version = "0.2.189"
@@ -532,6 +754,16 @@ version = "2.8.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
[[package]]
name = "miniz_oxide"
version = "0.8.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316"
dependencies = [
"adler2",
"simd-adler32",
]
[[package]]
name = "miniz_oxide"
version = "0.9.1"
@@ -542,6 +774,37 @@ dependencies = [
"simd-adler32",
]
[[package]]
name = "moxcms"
version = "0.8.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bb85c154ba489f01b25c0d36ae69a87e4a1c73a72631fc6c0eb6dde34a73e44b"
dependencies = [
"num-traits",
"pxfm",
]
[[package]]
name = "nix"
version = "0.28.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ab2156c4fce2f8df6c499cc1c763e4394b7482525bf2a9701c9d79d215f519e4"
dependencies = [
"bitflags 2.13.2",
"cfg-if",
"cfg_aliases",
"libc",
]
[[package]]
name = "num-traits"
version = "0.2.19"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
dependencies = [
"autocfg",
]
[[package]]
name = "once_cell"
version = "1.21.4"
@@ -570,6 +833,52 @@ version = "2.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220"
[[package]]
name = "pinyin"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e225f595052d9c46045755be4b8d7950b6d9f3c33e0c0b74ba58f11bbfa8c64b"
[[package]]
name = "pkg-config"
version = "0.3.34"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548"
[[package]]
name = "png"
version = "0.18.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "60769b8b31b2a9f263dae2776c37b1b28ae246943cf719eb6946a1db05128a61"
dependencies = [
"bitflags 2.13.2",
"crc32fast",
"fdeflate",
"flate2",
"miniz_oxide 0.8.9",
]
[[package]]
name = "portable-pty"
version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b4a596a2b3d2752d94f51fac2d4a96737b8705dddd311a32b9af47211f08671e"
dependencies = [
"anyhow",
"bitflags 1.3.2",
"downcast-rs",
"filedescriptor",
"lazy_static",
"libc",
"log",
"nix",
"serial2",
"shared_library",
"shell-words",
"winapi",
"winreg",
]
[[package]]
name = "potential_utf"
version = "0.1.6"
@@ -597,6 +906,18 @@ dependencies = [
"unicode-ident",
]
[[package]]
name = "pxfm"
version = "0.1.30"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d55d956fa96f5ec02be2e13af0e20391a5aa83d6a074e3ad368959d0fab299ea"
[[package]]
name = "quick-error"
version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a993555f31e5a609f617c12db6250dedcac1b0a85076912c436e6fc9b2c8e6a3"
[[package]]
name = "quote"
version = "1.0.47"
@@ -606,6 +927,12 @@ dependencies = [
"proc-macro2",
]
[[package]]
name = "r-efi"
version = "5.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f"
[[package]]
name = "r-efi"
version = "6.0.0"
@@ -619,8 +946,18 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e058c7de0b26af77780c769414d6257830bb240f3c38477dbc2c16e5f54d6d4c"
dependencies = [
"libc",
"rand_chacha",
"rand_core",
"rand_chacha 0.3.1",
"rand_core 0.6.4",
]
[[package]]
name = "rand"
version = "0.9.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b9ef1d0d795eb7d84685bca4f72f3649f064e6641543d3a8c415898726a57b41"
dependencies = [
"rand_chacha 0.9.0",
"rand_core 0.9.5",
]
[[package]]
@@ -630,7 +967,17 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
dependencies = [
"ppv-lite86",
"rand_core",
"rand_core 0.6.4",
]
[[package]]
name = "rand_chacha"
version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb"
dependencies = [
"ppv-lite86",
"rand_core 0.9.5",
]
[[package]]
@@ -642,6 +989,44 @@ dependencies = [
"getrandom 0.2.17",
]
[[package]]
name = "rand_core"
version = "0.9.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c"
dependencies = [
"getrandom 0.3.4",
]
[[package]]
name = "regex"
version = "1.13.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d"
dependencies = [
"aho-corasick",
"memchr",
"regex-automata",
"regex-syntax",
]
[[package]]
name = "regex-automata"
version = "0.4.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2"
dependencies = [
"aho-corasick",
"memchr",
"regex-syntax",
]
[[package]]
name = "regex-syntax"
version = "0.8.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
[[package]]
name = "ring"
version = "0.17.14"
@@ -662,7 +1047,7 @@ version = "1.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "891efababe418670775f199f0d233d84843c227a0949a883ce15b37c78d6629d"
dependencies = [
"bitflags",
"bitflags 2.13.2",
"errno",
"libc",
"linux-raw-sys",
@@ -753,6 +1138,28 @@ dependencies = [
"zmij",
]
[[package]]
name = "serial2"
version = "0.2.38"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b16809bc35793b19ce4e0c53924bc0dce3937f15487997cfdaed936004180730"
dependencies = [
"cfg-if",
"libc",
"windows-sys 0.61.2",
]
[[package]]
name = "sha1"
version = "0.10.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a978451301f4db1d02937a4ab3ccce137717b81826e79b7d49ffe3244a13c3b8"
dependencies = [
"cfg-if",
"cpufeatures",
"digest",
]
[[package]]
name = "sha2"
version = "0.10.9"
@@ -764,6 +1171,22 @@ dependencies = [
"digest",
]
[[package]]
name = "shared_library"
version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a9e7e0f2bfae24d8a5b5a66c5b257a83c7412304311512a0c054cd5e619da11"
dependencies = [
"lazy_static",
"libc",
]
[[package]]
name = "shell-words"
version = "1.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dc6fe69c597f9c37bfeeeeeb33da3530379845f10be461a66d16d03eca2ded77"
[[package]]
name = "shlex"
version = "2.0.1"
@@ -833,6 +1256,16 @@ dependencies = [
"syn 3.0.6",
]
[[package]]
name = "tar"
version = "0.4.46"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3f6221d9a6003c78398e3b239969f352578258df48c8eb051caadae0015bc840"
dependencies = [
"filetime",
"libc",
]
[[package]]
name = "tempfile"
version = "3.27.0"
@@ -846,13 +1279,33 @@ dependencies = [
"windows-sys 0.61.2",
]
[[package]]
name = "thiserror"
version = "1.0.69"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52"
dependencies = [
"thiserror-impl 1.0.69",
]
[[package]]
name = "thiserror"
version = "2.0.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e"
dependencies = [
"thiserror-impl",
"thiserror-impl 2.0.21",
]
[[package]]
name = "thiserror-impl"
version = "1.0.69"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.119",
]
[[package]]
@@ -888,6 +1341,29 @@ dependencies = [
"zerovec",
]
[[package]]
name = "tinyvec"
version = "1.13.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee"
[[package]]
name = "tungstenite"
version = "0.28.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8628dcc84e5a09eb3d8423d6cb682965dea9133204e8fb3efee74c2a0c259442"
dependencies = [
"bytes",
"data-encoding",
"http",
"httparse",
"log",
"rand 0.9.5",
"sha1",
"thiserror 2.0.21",
"utf-8",
]
[[package]]
name = "typenum"
version = "1.20.1"
@@ -900,6 +1376,15 @@ version = "1.0.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"
[[package]]
name = "unicode-normalization"
version = "0.1.25"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5fd4f6878c9cb28d874b009da9e8d183b5abc80117c40bbd187a1fde336be6e8"
dependencies = [
"tinyvec",
]
[[package]]
name = "untrusted"
version = "0.9.0"
@@ -936,6 +1421,12 @@ dependencies = [
"serde",
]
[[package]]
name = "utf-8"
version = "0.7.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9"
[[package]]
name = "utf8_iter"
version = "1.0.4"
@@ -954,12 +1445,41 @@ version = "0.9.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
[[package]]
name = "vibrato"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "17bb75519548ea63e35dd02e9bc3cc672a25423a9b8757bd035f5387771eb4cd"
dependencies = [
"bincode",
"bincode_derive",
"crawdad",
"csv-core",
"hashbrown 0.12.3",
"regex",
]
[[package]]
name = "virtue"
version = "0.0.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7b60dcd6a64dd45abf9bd426970c9843726da7fc08f44cd6fcebf68c21220a63"
[[package]]
name = "wasi"
version = "0.11.1+wasi-snapshot-preview1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
[[package]]
name = "wasip2"
version = "1.0.4+wasi-0.2.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b67efb37e106e55ce722a510d6b5f9c17f083e5fc79afc2badeb12cc313d9487"
dependencies = [
"wit-bindgen",
]
[[package]]
name = "webpki-roots"
version = "0.26.11"
@@ -978,6 +1498,28 @@ dependencies = [
"rustls-pki-types",
]
[[package]]
name = "winapi"
version = "0.3.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
dependencies = [
"winapi-i686-pc-windows-gnu",
"winapi-x86_64-pc-windows-gnu",
]
[[package]]
name = "winapi-i686-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
[[package]]
name = "winapi-x86_64-pc-windows-gnu"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
[[package]]
name = "windows-link"
version = "0.2.1"
@@ -1066,6 +1608,21 @@ version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
[[package]]
name = "winreg"
version = "0.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "80d0f4e272c85def139476380b12f9ac60926689dd2e01d4923222f40580869d"
dependencies = [
"winapi",
]
[[package]]
name = "wit-bindgen"
version = "0.57.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e"
[[package]]
name = "writeable"
version = "0.6.4"
@@ -1188,7 +1745,7 @@ dependencies = [
"flate2",
"indexmap",
"memchr",
"thiserror",
"thiserror 2.0.21",
"zopfli",
]
@@ -1215,3 +1772,46 @@ dependencies = [
"log",
"simd-adler32",
]
[[package]]
name = "zstd"
version = "0.13.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e91ee311a569c327171651566e07972200e76fcfe2242a4fa446149a3881c08a"
dependencies = [
"zstd-safe",
]
[[package]]
name = "zstd-safe"
version = "7.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "64d80649ab6db9d9f6f9c80a40becd948eda4714a0a5ac8c4d157a32231c7882"
dependencies = [
"zstd-sys",
]
[[package]]
name = "zstd-sys"
version = "2.1.0+zstd.1.5.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0ef0a8027ec3ee71300ab3bcbcd0393f434aa72b91ca6d635a39941deae8eea0"
dependencies = [
"cc",
"pkg-config",
]
[[package]]
name = "zune-core"
version = "0.5.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d56377fd46368984a170bc5aac5567e52ca5da874caa60bea39fcbca78fb658b"
[[package]]
name = "zune-jpeg"
version = "0.5.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "27bc9d5b815bc103f142aa054f561d9187d191692ec7c2d1e2b4737f8dbd7296"
dependencies = [
"zune-core",
]
+10 -4
View File
@@ -1,6 +1,6 @@
[package]
name = "framely"
version = "0.4.3-preview.1"
version = "0.5.1-preview.3"
edition = "2021"
license = "AGPL-3.0-only"
@@ -20,11 +20,17 @@ url = "2"
ureq = { version = "2.12", features = ["json"] }
zip = { version = "2.4", default-features = false, features = ["deflate"] }
pbkdf2 = "0.12.2"
[dev-dependencies]
pinyin = "0.11"
vibrato = { version = "=0.5.0", default-features = false }
zstd = "0.13"
unicode-normalization = "0.1"
portable-pty = { version = "0.9", default-features = false }
tungstenite = { version = "0.28", default-features = false, features = ["handshake"] }
tar = { version = "0.4", default-features = false }
flate2 = { version = "1", default-features = false, features = ["rust_backend"] }
tempfile = "3"
image = { version = "0.25", default-features = false, features = ["png", "jpeg", "webp"] }
[profile.release]
lto = "thin"
strip = true
+18 -3
View File
@@ -7,13 +7,25 @@
[简体中文](README.zh-CN.md)
> Framely is still under rapid development. Preview releases may change frequently; features and interactions are still being refined.
A React plugin manager for Steam Frame, with a Rust core service, a separate CEF/OpenVR host, a network management panel, and a desktop installer. Manage plugins, sources, windows, notifications, and updates.
![Framely spatial launcher](docs/images/launcher.png)
![Framely plugin library](docs/images/plugin-library.png)
## Installation
The target device is a Linux ARM64 Steam Frame. Download the `Framely Installer` for your computer from [Releases](https://github.com/SteamFramelyHomebrew/framely/releases), connect to the device, and install Framely. Alternatively, run this in the Frame SSH terminal to install the latest stable release:
The target device is a Linux ARM64 Steam Frame. Enable developer mode and SSH on Frame, connect your computer and Frame to the same network, and prepare the `steamos` account password.
### Desktop installer
Download the package for your computer from the [Framely Installer release](https://github.com/SteamFramelyHomebrew/framely/releases/tag/installer-v0.4.1-preview.10). Linux packages are `.tar.gz`; Windows and macOS packages are `.zip`. Extract and launch the installer, enter the Frame IP and SSH port, verify the SSH fingerprint, and connect with the `steamos` account. Select the Framely version, then confirm installation. Enable testing releases to install a Preview version. Installer and device versions are independent.
### Command installation
Run the following command **in Frame's SSH terminal** to install the latest stable release:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
@@ -22,10 +34,12 @@ curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/i
For a Preview release, specify an actual published tag:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.5-preview.2
```
First installation uses the complete offline package with CEF; updates use the smaller core package and reuse CEF; the device needs neither Node.js nor Rust. Installation requests sudo and does not automatically disable SteamOS read-only protection. Open the Framely Dock icon in the SteamVR Dashboard for the quick menu, then use Settings → Manage plugins to open the manager.
Replace the example tag with the published version you want to install. Enter the sudo password when prompted. See the [installation guide](docs/user-guide/installation.md) for updates, repair, and uninstallation.
First installation uses the complete offline package with CEF; updates use the smaller core package and reuse CEF; the device needs neither Node.js nor Rust. Installation requests sudo and does not automatically disable SteamOS read-only protection. Click the Framely Dock icon in the SteamVR Dashboard to open the launcher, or hold it for 600 ms to open the quick panel; a border progress indicator appears while holding. Open the manager from the launcher’s Settings button.
The network panel uses port `15915` by default. Visit `http://DEVICE_IP:15915` on your phone or computer. When no password is configured, the first visit requires setting and confirming a password before login. The device password and panel password are independent.
@@ -35,6 +49,7 @@ Start at the [documentation index](docs/README.md):
- [Install, update, repair, roll back, and uninstall](docs/user-guide/installation.md)
- [Basic usage](docs/user-guide/basic-usage.md) · [Install and manage plugins](docs/user-guide/plugins.md)
- [APK Manager](docs/user-guide/apk-manager.md) · [Space launcher](docs/launcher.md)
- [Network management panel](docs/user-guide/network-panel.md)
- [Plugin development through publishing](docs/developer-guide/README.md) · [Publish plugins and sources](docs/developer-guide/publishing.md)
- [SDK API](docs/developer-guide/sdk.md) · [Manifest configuration](docs/developer-guide/manifest.md) · [Lifecycle](docs/plugin-lifecycle.md)
+18 -3
View File
@@ -7,13 +7,25 @@
[English](README.md)
> Framely 目前仍在快速迭代中,Preview 版本可能频繁更新,功能与交互仍在持续完善。
Steam Frame 的 React 插件管理器:Rust 核心服务、独立 CEF/OpenVR 宿主、网络管理面板和电脑端安装器。可管理插件、来源、窗口、通知和更新。
![Framely 空间启动台](docs/images/launcher.png)
![Framely 插件库](docs/images/plugin-library.png)
## 安装
目标为 Linux ARM64 Steam Frame。电脑端从 [Releases](https://github.com/SteamFramelyHomebrew/framely/releases) 下载对应平台的 `Framely Installer`,连接设备后安装本体。也可在 Frame 的 SSH 终端安装最新正式版:
目标设备为 Linux ARM64 Steam Frame。先在 Frame 上启用开发者模式与 SSH,确保电脑和 Frame 在同一网络,并准备好 `steamos` 账户密码。
### 安装器安装
从 [Framely Installer 发行下载页](https://github.com/SteamFramelyHomebrew/framely/releases/tag/installer-v0.4.1-preview.10) 下载适合电脑平台的安装器。Linux 提供 `.tar.gz`,Windows 和 macOS 提供 `.zip`。解压并启动安装器,填写 Frame 的 IP 和 SSH 端口,核对 SSH 指纹后使用 `steamos` 账户连接。选择 Framely 版本,再确认安装。安装 Preview 版本时需启用测试版本;安装器与 Frame 本体的版本号相互独立。
### 命令安装
**在 Frame 的 SSH 终端中**执行以下命令,安装最新正式版:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
@@ -22,10 +34,12 @@ curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/i
安装 Preview 时指定实际已发布的标签:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.5-preview.2
```
首次安装使用包含 CEF 的完整离线包,更新使用不含 CEF 的本体包并复用运行库;同时提供独立 CEF 在线下载。设备无需 Node.js 或 Rust。安装会请求 sudo;不会自动解除 SteamOS 只读保护。打开 SteamVR Dashboard 的 Framely Dock 图标进入快捷菜单,从“设置 → 管理插件”打开管理窗口。
将示例标签替换为需要安装的已发布版本,并在提示时输入 sudo 密码。更新、修复和卸载步骤见[安装指南](docs/zh-CN/user-guide/installation.md)。
首次安装使用包含 CEF 的完整离线包,更新使用不含 CEF 的本体包并复用运行库;同时提供独立 CEF 在线下载。设备无需 Node.js 或 Rust。安装会请求 sudo;不会自动解除 SteamOS 只读保护。在 SteamVR Dashboard 中点击 Framely Dock 图标打开启动台,长按 600 毫秒打开快捷面板,按住期间显示边框进度;点击启动台右侧的设置按钮打开管理面板。
网络面板默认端口 `15915`,手机/电脑访问 `http://设备IP:15915`。未配置密码时首次访问必须设置并确认密码,保存后登录。设备密码与面板密码相互独立。
@@ -35,6 +49,7 @@ curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/i
- [安装、更新、修复、回滚与卸载](docs/zh-CN/user-guide/installation.md)
- [基本使用](docs/zh-CN/user-guide/basic-usage.md) · [插件安装与管理](docs/zh-CN/user-guide/plugins.md)
- [APK 管理](docs/zh-CN/user-guide/apk-manager.md) · [空间启动台](docs/zh-CN/launcher.md)
- [网络管理面板](docs/zh-CN/user-guide/network-panel.md)
- [插件开发到发布完整流程](docs/zh-CN/developer-guide/README.md) · [发布插件和插件源](docs/zh-CN/developer-guide/publishing.md)
- [SDK API](docs/zh-CN/developer-guide/sdk.md) · [Manifest 配置](docs/zh-CN/developer-guide/manifest.md) · [生命周期](docs/zh-CN/plugin-lifecycle.md)
+73
View File
@@ -0,0 +1,73 @@
Copyright 2000, 2001, 2002, 2003 Nara Institute of Science
and Technology.
Copyright 2023, LegalOn Technologies, Inc.
All Rights Reserved.
Use, reproduction, and distribution of this software is permitted.
Any copy of this software, whether in its original form or modified,
must include both the above copyright notice and the following
paragraphs.
Nara Institute of Science and Technology (NAIST),
the copyright holders, disclaims all warranties with regard to this
software, including all implied warranties of merchantability and
fitness, in no event shall NAIST be liable for
any special, indirect or consequential damages or any damages
whatsoever resulting from loss of use, data or profits, whether in an
action of contract, negligence or other tortuous action, arising out
of or in connection with the use or performance of this software.
A large portion of the dictionary entries
originate from ICOT Free Software. The following conditions for ICOT
Free Software applies to the current dictionary as well.
Each User may also freely distribute the Program, whether in its
original form or modified, to any third party or parties, PROVIDED
that the provisions of Section 3 ("NO WARRANTY") will ALWAYS appear
on, or be attached to, the Program, which is distributed substantially
in the same form as set out herein and that such intended
distribution, if actually made, will neither violate or otherwise
contravene any of the laws and regulations of the countries having
jurisdiction over the User or the intended distribution itself.
NO WARRANTY
The program was produced on an experimental basis in the course of the
research and development conducted during the project and is provided
to users as so produced on an experimental basis. Accordingly, the
program is provided without any warranty whatsoever, whether express,
implied, statutory or otherwise. The term "warranty" used herein
includes, but is not limited to, any warranty of the quality,
performance, merchantability and fitness for a particular purpose of
the program and the nonexistence of any infringement or violation of
any right of any third party.
Each user of the program will agree and understand, and be deemed to
have agreed and understood, that there is no warranty whatsoever for
the program and, accordingly, the entire risk arising from or
otherwise connected with the program is assumed by the user.
Therefore, neither ICOT, the copyright holder, or any other
organization that participated in or was otherwise related to the
development of the program and their respective officials, directors,
officers and other employees shall be held liable for any and all
damages, including, without limitation, general, special, incidental
and consequential damages, arising out of or otherwise in connection
with the use or inability to use the program or any product, material
or result produced or otherwise obtained by using the program,
regardless of whether they have been advised of, or otherwise had
knowledge of, the possibility of such damages at any time during the
project or thereafter. Each user will be deemed to have agreed to the
foregoing by his or her commencement of use of the program. The term
"use" as used herein includes, but is not limited to, the use,
modification, copying and distribution of the program and the
production of secondary products from the program.
In the case where the program, whether in its original form or
modified, was distributed or delivered to or received by a user from
any person, organization or entity other than ICOT, unless it makes or
grants independently of ICOT any specific warranty to the user in
writing, such person, organization or entity, will also be exempted
from and not be held liable to the user for any such damages as noted
above as far as the program is concerned.
÷÷
+7
View File
@@ -0,0 +1,7 @@
This software includes a binary version of data from
http://jaist.dl.sourceforge.net/project/mecab/mecab-ipadic/2.7.0-20070801/mecab-ipadic-2.7.0-20070801.tar.gz,
where the connection ids are remapped using CORE data in BCCWJ (except the PN category)
https://clrd.ninjal.ac.jp/bccwj/.
+21
View File
@@ -0,0 +1,21 @@
# Offline launcher search data
`ipadic.dic.zst` is the IPADic 2.7.0 dictionary compiled for Vibrato 0.5.0.
Vibrato is pinned to the matching reader format; upgrade the reader and dictionary together.
Source: https://github.com/daac-tools/vibrato/releases/download/v0.5.0/ipadic-mecab-2_7_0.tar.xz
Source archive SHA-256: `4764f983b7c3a9e1cb6a5ee945e00558efd812980e0dad61224f63ee3b0475d9`
Dictionary SHA-256: `82a6da70bb4a17be70f20ff44f650f9ad1d2b0b4fcb2f39c17fc797f92d0ab75`
Chinese pinyin uses rust-pinyin 0.11.0 and pinyin-data 0.15.0 (MIT); see `pinyin-LICENSE`.
Vibrato license notices are included as `vibrato-LICENSE-*`.
Keep `COPYING` and `NOTICE` with the dictionary. Release packaging copies this directory to
`share/search`, includes it in core updates and offline packages, and records its checksum.
The dictionary is loaded lazily by the session's search worker. No remote service is used.
中文:此目录包含 Vibrato 0.5.0 格式的 IPADic 2.7.0 离线日语读音词典。读入器与词典必须一起升级。
发布包复制到 `share/search`,包含于本体更新包和完整离线包,并纳入校验。
请保留 `COPYING` 和 `NOTICE`。词典由会话搜索线程按需加载,不使用远程服务。
Binary file not shown.
+22
View File
@@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2016 mozillazg
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 legalforce-research
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+5
View File
@@ -10,6 +10,8 @@ Framely manages plugins on Steam Frame through device services, a SteamVR interf
2. [Basic usage](user-guide/basic-usage.md): Dock, manager, enabling plugins, favorites and safe mode.
3. [Install and manage plugins](user-guide/plugins.md): plugin library, sources, subscriptions, local packages and updates.
4. [Network panel](user-guide/network-panel.md): address, first password setup, login and phone/desktop access.
5. [APK Manager](user-guide/apk-manager.md): sideload installation, updates, containers, retained data and cleanup.
6. [Terminal and files](user-guide/terminal-and-files.md): user-owned terminal sessions, file operations, recycle bin, transfers and previews.
## Plugin development and publishing
@@ -33,3 +35,6 @@ Framely manages plugins on Steam Frame through device services, a SteamVR interf
- [Framely releases and updates](releases.md)
- [Desktop installer](../installer/README.md)
- [Space launcher](launcher.md)
- [Launcher actions and host compatibility](developer-guide/launcher.md)
+4
View File
@@ -82,3 +82,7 @@ Inspect Framely status and systemd logs. Do not mix debug messages into backend
Default GitHub Releases use tag `v<version>` and asset `<id>-<version>.framely`; source may omit `downloadUrl`. Community registration derives it automatically. Prepare a temporary packaged Manifest containing the final URL as shown in [publishing](publishing.md), because current `framely pack` does not read Git remotes. Set an explicit URL for custom downloads. Publish the Release/assets with usage, runtime-user details, changes and actual test coverage, then host a catalog or register a fixed source commit. Database registration also checks expected whole-package hashes and field compatibility.
For updates: bump version → regenerate the release Manifest (update explicit custom URLs if used) → rebuild/verify → device test → new Release → update the source pin. Never replace old assets.
## Launcher actions and host compatibility
[Launcher actions and host compatibility](launcher.md)
+73
View File
@@ -0,0 +1,73 @@
# Launcher, actions and host compatibility
[简体中文](../zh-CN/developer-guide/launcher.md) · [Manifest](manifest.md) · [SDK](sdk.md)
Available from Framely **0.4.3-preview.2**. Existing plugins need no changes: a short press opens their quick page and a long press offers Quick panel, Manage plugin and Uninstall plugin. A missing quick page disables that menu item. Uninstall always asks for confirmation.
## Host version requirement
```json
"engines": {"framely": ">=0.4.3-preview.2 <0.5.0"}
```
`engines.framely` is a mandatory host compatibility check, separate from `apiVersion` (the protocol version). It is optional for existing plugins and required when using launcher declarations. A declared launcher feature must have an explicit version floor of `0.4.3-preview.2` or newer.
Ranges use the same parser as plugin dependencies: exact versions (`0.4.3` or `=0.4.3`), comparisons, whitespace/comma intersections, `^`, `~`, and wildcards. `||` and hyphen ranges are not supported. A normal range excludes preview versions; to include a preview, explicitly name its major/minor/patch and prerelease in a comparator. For example `>=0.4.3-preview.2 <0.5.0` matches later 0.4.3 previews and compatible stable releases, but does not automatically include 0.4.4 previews. Build metadata does not affect matching.
The host checks before installation side effects, updates, version rollback, and runtime startup. Incompatible versions remain visible in the library but cannot be installed; dependency resolution skips them. Downgrading Framely preserves incompatible plugins and their enabled preferences while blocking execution. Published older hosts reject the unknown fields rather than run a new-format package; their error messages cannot be retroactively upgraded.
## Entry behavior
```json
"ui": {
"quickPage": "page.js",
"windows": {"main": {"entry": "page.js", "title": "Example"}},
"launch": {
"launcher": {"type": "window", "window": "main"},
"quickPanel": {"type": "quickPage"},
"manager": {"type": "window", "window": "main"}
}
}
```
Omitted entry behavior opens the plugin's quick page. The manager's separate management button is unaffected. The built-in **Quick panel** menu action always opens the quick page regardless of entry configuration. Window references must name a declared window; a `quickPage` target requires a declared quick page.
`plugin.open` retains its existing backend-start meaning. It does not apply entry navigation.
## Long-press actions
Declare buttons in order; Framely renders them above its three built-in actions. At most 16 custom actions are allowed, with unique valid IDs and nonempty labels up to 120 bytes. Labels are developer-provided text; choose localized content in your published package as appropriate.
```json
"launcherActions": [
{"id": "open", "label": "Open window", "target": {"type": "window", "window": "main"}},
{"id": "connect", "label": "Connect", "target": {"type": "backend", "method": "connect", "params": {"profile": "default"}}},
{"id": "notify", "label": "Send notification", "target": {"type": "frontend", "entry": "actions.js"}}
]
```
A backend target requires a backend and receives `{params, context}`; reserved `framely.*` methods are prohibited. A frontend target names a hashed payload bundle. It runs in a dedicated sandbox only when invoked, without rendering the quick page, and uses the existing scoped SDK capabilities. Frontend actions have a 90-second host deadline; failures stay visible for retry. Actions do not gain plugin management or arbitrary host-command privileges.
Build a separate `actions.ts` bundle (the scaffold's build command does this automatically):
```ts
import {registerLauncherActions, framely} from '@framely/sdk';
registerLauncherActions({
notify: async context => {
await framely.notifications.send({
id: 'hello', title: 'Hello', body: `From ${context.source}`, inbox: true,
});
},
});
```
## Startup context
```ts
const initial = await framely.ui.launchContext.get();
const unsubscribe = framely.ui.launchContext.onChanged(context => {
console.log(context.source, context.trigger, context.actionId);
});
```
`source` is `launcher`, `quickPanel`, or `manager`; `trigger` is `shortPress` or `menuAction`; custom menu actions additionally include `actionId`. Initial context is available after loading, and subsequent activations of a reused page/window send `ui.launch`. Frontend action callbacks receive context directly; backend actions receive it with their parameters. A backend `onStart` lifecycle context also includes `launchContext` when startup was caused by an entry launch. Old calls without a known entry use the quick-panel default.
+4
View File
@@ -96,3 +96,7 @@ Dependencies use ranges or `{version, source}`, with source pointing to an HTTPS
Manifest JSON is limited to 256 KiB and payload paths to 512 bytes. Payload paths allow ASCII letters/digits and `/._-+` only. Absolute paths, empty segments, `.`/`..`, symlinks and undeclared archive files are forbidden. Successful validation is not a safety review; users still assess runtime privileges.
`backend.uiVisibilityEvents` (boolean, default false) subscribes to manager-only `framely.ui.visibility` RPCs. Reply promptly. Delivery does not depend on mounted pages and requires a host supporting visibility events.
## Launcher actions and host compatibility
[Launcher actions and host compatibility](launcher.md)
+8
View File
@@ -146,3 +146,11 @@ Declare `backend.uiVisibilityEvents: true` to receive the reserved JSON-line RPC
`framely.ui.close()` closes the current native surface: the quick panel or the current plugin window. It does not stop the backend or recording. Requires a host with this bridge method.
Standalone plugin windows display the plugin page without a host title bar. Plugins provide their own title, navigation and close button using `framely.ui.close()` or `framely.windows.close(id)`. Quick panels retain host navigation.
## Launcher actions and host compatibility
[Launcher actions and host compatibility](launcher.md)
### Host page scrolling
The native CEF host installs vertical trigger-drag scrolling whenever a frame finishes loading, including existing plugin pages, nested frames and `localWeb` windows without the SDK. The shared document guard prevents duplicate installation by the host bootstrap or SDK. Laser-targeted stick scrolling also works in these windows through native wheel input. It selects the scrollable ancestors under the pointer and chains at their boundaries. Controls such as inputs, textareas, editable content and sliders are excluded. Use `data-framely-no-scroll-drag` on an element (or ancestor) whose vertical dragging is handled by the plugin; native `draggable="true"` elements are also excluded. No new manifest field or plugin rebuild is required.
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

+57
View File
@@ -0,0 +1,57 @@
# Space launcher
[简体中文](zh-CN/launcher.md)
Click the Framely Dock icon with any supported click input to open the launcher. Hold it for **600 milliseconds** to open the quick panel; a border progress indicator shows the hold duration. Releasing after a long press does not also open the launcher. This replaces the primary/upper-trigger split and the trigger-swap setting.
The launcher is a native Dock dashboard panel, 3.6 meters wide, with the previous 2-meter height retained. Steam places and curves it and switches from the current Dock panel when it opens. It closes when the Dock is hidden. UI drawing is capped at 60 FPS independently of the headset refresh rate to limit pixel readback and texture upload load. This is a drawing limit, not a guaranteed measured frame rate. The launcher uses a 4320 × 2400 texture (3× the logical resolution), retains mipmap filtering for edge quality and uploads only changed regions. App ordering and search results are cached during drag animations. The icon area always reserves space for six columns and three rows, regardless of the number of apps. Each page holds up to 13 icons. Fill the first row with four icons, the second with five, then the third with four. The second row starts half a slot to the left; the third aligns with the first. Partial rows retain those starting positions: nine icons are 4 / 5, ten are 4 / 5 / 1. Collections of up to four icons use one centered row. The Done button uses the same translucent surface, border and highlights as the category selector. The visible gap beside the category selector is wider than the gap between adjacent icon artwork. The icon area is centered independently of the category selector, with a fixed 570-pixel height. All three row positions stay fixed, including when only one or two rows are populated. Button and joystick page changes slide and fade over 300 ms. Category changes slide vertically and fade in over 360 ms, with the category selector’s active surface sliding to the selected item; reduced-motion mode skips these transitions. Switching to another Dock panel replaces the launcher normally. Framely does not change other windows’ transparency or input settings. Closing the launcher returns to Steam’s Dock panel. Steam uses local cover artwork first and falls back to logos or initials. The right capsule opens the plugin library or management settings. Use the left category selector for Favorites, All, Plugins, Steam, Lepton or Desktop apps, the bottom dots to change pages, and the star on hover to favorite apps. Favorited apps show a filled blue star on hover; click it again to remove the favorite without changing the icon order. The transparent surface curves around you; only icons, names and categories are normally visible. Disabled plugins are hidden; safe mode prevents third-party plugin launch. Steam lists installed apps from the Frame's local libraries, not account-only or remote-streaming apps.
Press and release may drift by up to 36 UI pixels without changing the initial hit. Icon and category hit areas are larger than the artwork. Deliberate movement cancels stabilization. Hold a plugin icon with the primary trigger for 400 ms to open its action menu; ordinary jitter keeps the hold active. It contains developer actions plus Quick panel, Manage plugin and Uninstall plugin. Press **B** or click an unused area to close the launcher. During icon arrangement, the first press or click exits arrangement and keeps the launcher open. Hold the primary trigger and swipe horizontally: the current page follows your movement while the adjacent page slides into view. Release to snap to that page, or return to the current page if the drag is too short or reaches the boundary. By default the action menu closes ten seconds after the pointer leaves; returning cancels the timer. Configure the switch and delay (1–300 seconds) in **Manager → Launcher**. Uninstall requires confirmation and keeps plugin data.
Keep holding for **800 ms** to enter icon arrangement. Drag any icon (including Framely itself, which opens the management panel) onto another position; icons shift and automatically fill the 4 / 5 / 4 slots without gaps. The left drag edge is to the right of the category selector; the selector itself does not trigger paging. Hold a dragged icon at either edge of the icon area for 650 ms to turn a page; continue holding to move across further pages. Release to save the order, or choose **Done** to finish arranging. Closing or hiding the Dock cancels an unfinished drag. Manual icon order is preserved across favorites, search, refreshes and reopening. Favoriting never moves icons to the front; the Favorites category filters the same order. Apps without a saved position are appended in name order.
Either controller's stick switches categories vertically and pages horizontally. A gesture uses only its dominant axis; return below the neutral threshold before the next navigation step. This prevents a diagonal or simultaneous stick input from performing both actions.
Desktop applications come from the session user's XDG application directories, including Flatpak exports; hidden entries and duplicate Steam game shortcuts are omitted. Steam-installed APK applications appear in the Lepton category and launch through Steam. Sideloaded Lepton apps are discovered from installed APKs in each context's package database; empty contexts and Android system packages are excluded. These launch in their existing user-owned context. Missing Android labels/artwork fall back to the package name and initials. Downloaded but uninstalled APK files are not included. Enumeration does not start containers.
Steam launch feedback confirms handoff to Steam rather than game readiness. Plugin-library entries can specify `engines.framely`; update Framely if your version does not satisfy the shown range.
## Categories and favorites
The manager has a dedicated **Launcher** page for trigger assignment, menu timeout and the categories included in **All**. Plugins (including Framely), Steam, Lepton and Desktop apps are included by default. Turning a category off only removes it from All; its own category and Favorites remain accessible. Turning every category off leaves All empty.
Every app type can be favorited using the star shown on hover. Existing plugin and Steam favorites are preserved. Disabled plugins stay hidden; favorites for temporarily unavailable apps are retained. Each opening clears the search and resets pagination. Once local enumeration completes, Favorites opens if any favorite is currently available; otherwise All opens. Removing the final favorite while viewing Favorites shows an empty state without switching categories until the next opening.
## Search
Click the capsule at the top to open the VR keyboard. Search stays within the selected category and preserves its ordering. Clear the field to restore its apps. While the keyboard is open, launcher stick navigation and background dismissal are paused; B closes the keyboard first. The icon canvas keeps its fixed size and position while searching.
Search accepts original names, English word initials, Chinese pinyin and Japanese romaji / syllable initials. Matching ignores case, width, tone marks, spaces and punctuation; it supports prefixes and continuous fragments. Examples: `toushi`, `tiaose` and `tsts` find **透视调色**; `sakura` and `skr` find **さくら**; `toukyou` finds **東京**; `hla` finds **Half-Life: Alyx**. Chinese alternate character readings are supported within a bounded index; uncommon names or compound readings may differ from the intended pronunciation.
Indexes are built asynchronously and cached on the device. Chinese uses offline pinyin data; Japanese uses the bundled Vibrato / IPADic reading dictionary. Han names receive both Chinese and Japanese candidates regardless of interface language. Unknown dictionary readings retain their original text. Original-name search remains available before phonetic indexing completes. No app names are sent to an external search service.
Session API: `launcher.search.index` accepts `{names: string[]}` and returns a name-keyed map of `{terms: string[]}`. `launcher.favorite` accepts `{key, favorite}` with the same stable keys as launcher ordering. Plugin and Steam keys update their existing favorites; `framely`, `desktop:` and local `lepton:` keys use `launcherFavorites`. `launcher.settings.save` now includes `allCategories` (`plugin`, `steam`, `lepton`, `desktop`); omitted fields migrate to all four categories, while an explicit empty array means none. Search dictionaries and notices are included in both core updates and offline packages under `share/search`.
## Gaze and controller confirmation
When the laser is not pointing at the launcher, valid eye tracking can select an icon, category or action button. A target becomes highlighted after 120 ms of stable gaze with a light controller pulse. Fixation jitter is lightly filtered, nearby icon gaps accept the nearest icon, and short tracking dropouts retain hover for up to 280 ms. A dropout during a press still cancels that press. Pointing the laser at the launcher restores laser interaction immediately; Steam window positioning controls and the VR keyboard pause gaze input. This uses launcher laser focus as the fallback rule, rather than assuming Steam’s private per-hand gamepad mode flags are available through OpenVR.
Use the left controller’s lower D-pad button (the position requested as “A”), right A, or either primary trigger to confirm. Short press opens the selected item; holding an icon for 400 ms opens its menu and 800 ms enters arrangement mode. The target is locked until release, so moving your eyes does not drag or switch the pressed icon. Arrange icons with the laser and joystick afterwards. Losing eye tracking or disconnecting the confirming controller cancels the press; buttons must be released before another press can begin. Unsupported or inactive tracking does not fall back to head direction.
### Gaze calibration
In the Frame management panel, open **Launcher → Eye tracking calibration → Start calibration**. You can also use the eye calibration button above Settings in the launcher’s right rail. A simulated launcher uses the same Dock surface, icon layout, search capsule and side rails. Start the guided sequence, then look naturally at the highlighted target; no confirmation press is needed. It samples 13 icons, six category controls, four shortcuts and search, then repeats five targets to validate the correction. Allow about one minute with uninterrupted tracking. Tracking loss pauses collection; excessive jitter asks you to retry. B or Cancel exits without saving.
You can turn or move your head to see peripheral targets. Each frame pairs the measured gaze with the direction from the current eye origin to the highlighted target, using the head pose at the same nominal sampling time. The target point is located using Steam's curved-overlay intersection, and is checked again as the head or window moves. Head movement itself is not treated as fixation jitter.
Paired directions are averaged in short time slices before fitting; each target has equal weight, and robust reweighting limits the influence of mis-fixated targets. Validation measures the median residual direction for each fixation, preserving per-frame head coordinates. A single spike cannot invalidate calibration.
The result shows RMS target bias and the worst target bias in degrees. Each target also shows its 95th percentile frame error and uncorrected median error, separating systematic bias from sensor noise. Calibration summaries and paired training blocks are recorded in the session log for diagnosis. **Save calibration** persists a correction of head-relative yaw and pitch. At runtime, the corrected direction is rotated into world space with the current headset pose, preserving the eye origin before intersecting the Dock surface. It does not change laser input or the system tracker. Validation compares against highlighted target directions, not against native gaze as a reference. Failed validation cannot overwrite the previous calibration. Old viewport-coordinate calibrations are ignored; run calibration again after this update. The correction handles systematic angular bias and gain; nonlinear tracking errors may remain. OpenVR does not expose the eye camera's exact exposure timestamp, so fast motion may still have timing error.
After substantial changes to headset fit or the window distance, run calibration again.
Press feedback appears only after holding for 200 ms. The Dock entry uses a blue border indicator and opens the quick panel at 600 ms. Launcher icons show a translucent white circular progress border: the halfway tick opens the menu at 400 ms; continuing to 800 ms enters icon editing. Release or cancellation removes the indicator.
### Remote Steam games
The Steam category also shows apps installed on a connected Remote Play computer. A small Remote Play badge appears at the bottom right of their icons. The list refreshes in the background; disconnected hosts disappear, and each App ID has one icon. If both local and remote installations are available, clicking it opens a choice between launching locally and Remote Play. Favorites and manual ordering remain shared for that game. Clicking a remote icon asks Steam to stream from its current host and checks availability again before launching. Artwork uses the local Steam cache, with a placeholder when unavailable. The integration uses the running Steam client UI; if that interface is unavailable, local games remain usable.
+4
View File
@@ -84,3 +84,7 @@ Restart defaults to `on-failure`; `never` reports failure without retrying. Limi
States include starting/running/stopping/stopped/recovering/failed. Core management is serialized. Normal SIGTERM/SIGINT attempts to stop plugins; forced termination or power loss cannot guarantee hooks. Support safe recovery on next startup.
The log view includes backend and lifecycle logs; each retains a current 2 MiB file and a preceding copy. Failed pre-registration installs log to `/var/lib/framely/logs/<id>.lifecycle.log`. User data is under `/var/lib/framely/data/<id>/<identity>/`, relative to any custom core state root.
## Launch context
[Launch context](developer-guide/launcher.md)
+176
View File
@@ -0,0 +1,176 @@
# APK Manager
Global controller and container lifecycle preferences are under **APK → Settings**, separate from the application list. Per-application display and launch preferences remain in each app’s management dialog.
[简体中文](../zh-CN/user-guide/apk-manager.md)
[Documentation](../README.md) · [Launcher](../launcher.md)
APK Manager installs and manages sideloaded Lepton applications on Steam Frame. Use the header switch to move between Plugin Manager and APK Manager in the headset or authenticated network panel. Visiting the device IP opens Plugin Manager by default. APK Manager has its own Apps, Containers and Data cleanup navigation. It is a file-based manager: it has no store, recommendations, download sources, or automatic APK updates.
## Requirements and discovery
Install Lepton through Steam first. Framely uses the Steam session user's Lepton and Podman; it does not install Android globally or operate as root. Lepton compatibility varies: Google services, vendor APIs and DRM may be unavailable.
Open **APK Manager → Refresh**. Discovery reads the standard Lepton context directories, saved Framely records and running containers' compatibility-data labels. It does not start containers during scanning. Steam-managed APKs appear in the container view; use Steam for their updates and removal.
For data stored elsewhere, open **Containers → Additional data locations** and add the `baked` directory containing `data_overlay/system/packages.xml`. Enter the original Lepton context name when it differs from the enclosing directory. Names cannot conflict with containers belonging to other data locations. Paths must belong to the session user. Removing a scan location does not delete its data. Custom tools can use layouts Framely cannot discover; missing locations must be registered explicitly.
Applications are identified by context plus package name. The same package in two containers is treated as two applications. A context name or location change can therefore create a different identity.
## Install and update
During APK installation, choose **Display mode → Flat window / VR app**. The initial selection follows APK detection; updates keep your previous window override. Flat mode displays the Android window, while VR mode hides it and requires the app itself to support VR. A successful installation saves the choice; failed installations preserve the previous setting.
Choose **Install APK**, select an individual `.apk`, and review its name, package, version, minimum Android SDK and target container. Inside Frame, the selected APK is inspected directly on the device without a browser upload. A private local snapshot is retained for the confirmation step; the original file is not changed. Uploads from the network panel are staged on Frame's persistent filesystem, not its limited `/tmp`. Transfer shows actual bytes; subsequent work shows named stages instead of invented percentages.
Inside Frame, file inputs in both management panels use Framely’s built-in file picker, including APKs, plugin packages and language files. It opens Downloads by default, remembers the last selected folder, and provides a lazily loaded folder tree for Home, temporary files and mounted storage, with folder navigation, path entry, search, hidden files and file-type filtering. Select a file and confirm; B/Escape cancels the picker without closing the panel. External browsers continue using their system file picker. The launcher’s **Install APK** shortcut opens APK Manager.
Framely installs packages into separate Android package directories even when they share a container. Container restarts preserve downloaded resources in Android external storage, including unfinished download fragments and update checkpoints. Unrecognized Lepton media setup hooks are rejected before they can discard those files. Whether a game resumes its download still depends on its own updater. Older single-APK mounts are repaired from the saved APK when available, and legacy OBB resource links are migrated before replacement without deleting their original target. This prevents future loss; resources already deleted by an older startup cannot be reconstructed from the APK alone.
Launcher icons use the highest-density packaged raster resource instead of the first resource-table entry. Existing installations are re-inspected when the panel/launcher refreshes; no APK reinstall is needed. PNG, WebP and JPEG icons retain their original bytes.
Each new app uses its own independent container. Existing shared containers remain discoverable; their existing packages can still be updated or managed, but new package identities cannot be added. Framely does not automatically split, migrate or delete older shared containers or their data. Steam-managed containers remain excluded.
Installation runs in a headless background container without opening the Android desktop, regardless of the selected display mode. After installation, choose **Open** if desired; installation does not automatically launch the APK. An app with no detected launch entry remains manageable but does not appear in the launcher. Opening an already visible app reuses its running container and virtual gamepad. A headless or fully hidden display, a physical window-size change, or first attaching a new gamepad requires a restart because Lepton cannot safely perform those display or device transitions in place.
To update, open the app's management dialog and choose **Install newer APK**. Package identity and version are checked; Android enforces signing compatibility during replacement. Downgrades are refused, and signature failures never trigger an uninstall/reinstall workaround. Same-package replacement retains data. Updating may stop the target container, affecting its other applications.
Before replacing an existing installation, Framely saves a container-data snapshot while it is stopped. Scratch overlay work directories, runtime sockets and FIFOs are excluded. Backups include a SHA-256 integrity inventory checked before restoration. Backup failure aborts replacement. Snapshots are recovery material, not a guarantee that every Android data migration is reversible. One-click restore supports sideloaded containers with a single recorded application and a matching data location, including external containers; shared snapshots require manual recovery. Restoration creates another snapshot of the current state and requires launching the app to verify saved data afterward.
Once a modifying operation starts, cancellation is disabled until its actual outcome is known. Uploads and preparation can be cancelled. Switching panels does not stop a submitted task; reopening APK Manager resumes its progress display. Interrupted restores are recovered from a local transaction journal before the next modifying operation. After interruption, use **Reconcile installed state** before retrying or deleting data. An unreadable container displays Installation state unknown, preserves the previous record and disables launching, reinstallation and deletion until its actual state is reconciled.
## Launch and window display
The launcher uses declared MAIN/LAUNCHER, television launcher and recognized VR entries, plus the running Android package manager's resolved launcher entry. Disabled packages/components are excluded. A launch entry does not guarantee that an app will run successfully.
Flat apps use Lepton’s full-display boot path to avoid the Gamescope window-creation failure in per-app mode. A headless container from installation, or a closed display, is restarted when needed; this also stops other apps in the same container. VR apps keep background boot. After ActivityManager reports success, Framely checks that the application and Android display service stay alive before reporting completion. Framely keeps Lepton’s development-context data handling instead of switching an existing container to APK bake mode. A temporary launch adapter uses the installed Lepton libraries without editing Steam’s installation; an unsupported entry script reports an error before starting a cold container. Manually choosing **Start container** still opens its desktop.
Window handling is automatic by default. **Advanced settings → Show Android window** is a troubleshooting override, applied on container restart. It does not convert a flat application into VR or a VR application into a flat application. Lepton development contexts may mount their APK at a different path after a restart. Framely re-registers the same signed APK when Android can no longer resolve it, preserving data and reporting failures. Advanced settings also allow selecting an enabled, declared Activity when a nonstandard app needs a different entry.
Launcher favorites, search and manual ordering continue to use stable context/package identities. Updating and refreshing do not reorder icons. Uninstalling hides an icon without deleting its favorite/order record; reinstalling in the same context restores it. Long-press a local Lepton icon to open APK management or removal confirmation.
## Close, uninstall and clean data
**Close app** force-stops only the selected package. **Stop container** affects every app inside it. All non-Steam sideloaded containers with a verified data location support deletion after confirmation of affected apps and permanent data loss. Standard Lepton context directories are removed as a whole; registered external locations remove only the baked directory, preserving unrelated files in the parent. Uninstalling an app keeps its container unless **Delete container** is enabled.
Uninstallation retains saved data by default. Enable **Delete app data** to remove it. If the container contains only this app, this also selects **Delete container** by default; you can turn it off to keep the container. Shared containers and unknown application states cannot use this option. The backend checks the inventory again before deleting. Container deletion also removes the associated APK cache and Steam library entry, icon and artwork, while keeping historical backups. Retained apps appear under **Uninstalled, data retained**, where you can reinstall or remove retained data with the same container option.
Android may require the original signed APK to remove an already uninstalled package's retained state. Framely keeps the original APK when it manages an uninstall. If an externally uninstalled app has no recoverable APK, supply its original APK through reinstallation before removing its retained state. Framely does not bypass signing checks or delete arbitrary directories to simulate success.
**Data cleanup** lists retained data, old APKs, recovery snapshots and expired temporary files. Saved data and backups are not selected by default. Unidentified data is displayed without an automatic deletion action. Each selected item is checked again before removal; a reinstalled application cannot be cleaned as an uninstalled one. Batch results report actual released file bytes and individual failures. File-byte counts may differ from physical disk usage due to compression, reflinks and shared storage.
## Logs and recovery without the panel
Use the app's **Logs → Export logs** to save its operation log. Detailed Android errors remain in logs. Review logs before sharing them.
As the Steam session user, the installed binary also provides these commands:
```bash
/var/lib/framely/current/bin/framely apk list
/var/lib/framely/current/bin/framely apk inspect --file /path/to/app.apk
/var/lib/framely/current/bin/framely apk install '{"ticket":"REVIEW_TICKET","approve":true}'
/var/lib/framely/current/bin/framely apk launch '{"app":"CONTEXT/PACKAGE"}'
/var/lib/framely/current/bin/framely apk logs '{"app":"CONTEXT/PACKAGE"}'
/var/lib/framely/current/bin/framely apk cleanup-list
```
Reviews expire after 15 minutes. APKs, operation records and recovery material are stored in `~/.local/share/framely/apk-manager`; managed Lepton data lives under `~/.local/share/lepton/contexts`. Framely uninstallation retains these user-owned directories. Back them up before removing Framely; the APK CLI requires a compatible Framely binary, while Lepton remains independently installed through Steam.
Start Framely-managed contexts through the APK panel or the `framely apk launch` command above. These launch paths preserve downloaded resources and attach persistent storage; a raw Lepton launch does not apply Framely's storage hooks.
### Downloaded resources and shader cache
On the next container start after upgrading, Framely moves existing Android shared storage to `baked/external` inside the context and mounts it directly, outside the Android data overlay. The move preserves partial downloads and checkpoints without copying their contents. If both storage locations already contain data or an unexpected link exists, startup stops and retains both locations for recovery. Already-running containers use the new layout after stopping and launching again. Registered Steam compatibility contexts retain their existing external-storage layout.
Each context also stores Mesa's shader cache in `baked/shadercache`, mounted at `/data/shaders`. Cache entries survive container restarts, allowing compatible shaders to be reused; first-time compilation still occurs. Managed context backups include both directories and restore downloaded resources and cache entries together with application data.
Do not invoke Lepton's global cleanup commands as an application-specific uninstall.
## Supported formats
The initial implementation supports individual APKs. Split APK bundles, XAPK/APKM, OBB import, Google Play installation and automatic Steam shortcut creation are outside this version. Unsupported bundles are rejected rather than treated as ordinary APKs.
### Flat window orientation
In **Manage app → Advanced settings → Window orientation**, choose **Automatic**, **Landscape**, or **Portrait**. The choice is saved per app and applied at its next launch. Forced portrait uses a tall window rather than rotating content sideways. Changing orientation may restart the shared container and stop other apps in it. VR apps ignore this setting. Flat APK startup also explicitly selects fullscreen and applies it to the created Android task, avoiding a restored freeform desktop window. This affects startup only; later manual resizing remains available.
Moonlight V+ 12.12.12’s connection-creation screen currently crashes on the tested Lepton build because Android’s clipboard service is absent. This is distinct from the window-startup failure. Framely does not modify or re-sign the APK; a compatible Lepton runtime or an app-side fallback is required.
### Optional gamepad input
**APK → Settings → Gamepad input** is off by default, including after upgrading an existing installation. Enable it to forward Steam Input as a standard Android gamepad for APKs opened through Framely. Steam Input is the default source and follows Steam’s controller configurations, including external controllers recognized by Steam. **Frame direct** retains the original OpenVR bindings for compatibility. Close and restart a container to change its source. It includes ABXY, the D-pad and diagonals, both sticks and stick clicks, shoulder buttons, analog triggers, Select and Start. Applications must support Android gamepad input; this does not map controls to touchscreen gestures or provide Android VR controller tracking; supported games can request gamepad rumble.
Enabling applies on the next application launch. Framely may restart its container to attach the input device, stopping other apps in that container. Disabling stops forwarding immediately. Only one Framely-launched APK receives input at a time. Switching apps, closing an app, transient process-query failures and foreground changes neutralize input without removing the virtual pad. Each running container retains its device for reuse; container stop, disabling the feature or session-service restart releases it. After a service restart, launch the APK again to reconnect. Keep the intended Android window selected in Dock; the bridge does not change Steam's physical-controller bindings.
The bridge runs as the Steam session user and requires access to `/dev/uinput`, active SteamVR and the supported Lepton startup hooks. It does not modify Steam's installed Lepton files. Only its virtual event node and read-only Android key layout are mounted into the target container, where Android claims it exclusively. If this claim fails, no input is forwarded and the launch reports an error. Disable the option to use the normal launch path. Bridge errors are recorded in `~/.local/share/framely/apk-manager/logs/gamepad.log`; key presses are not logged. The native helper and Android adapter ship in both offline and core update packages.
Native Steam launches select the input target before startup acknowledgement. Forwarding begins only after Android claims the virtual device and the target application becomes foreground. Frame direct helpers have separate temporary SteamVR identities. Steam Input helpers do not register OpenVR action sets, because that registration can suppress Steam virtual-gamepad enumeration in SDL. Returning to an already running application reselects its input target.
When this option is enabled, launch APKs through the management panel or launcher. A one-shot CLI launch cannot own the persistent input bridge and reports an error instead. For read-only diagnostics, run `framely apk input-status '{"app":"CONTEXT/PACKAGE"}'` as the Steam session user. It reports Android process, foreground and lifecycle status without input events or Steam tokens; it does not prove that the application handles gamepad events.
**Gamepad rumble** can be disabled independently and takes effect immediately. Linux `FF_RUMBLE` effects are acknowledged and sent back to the current source controller. Input source changes, Android foreground loss, disconnects and bridge shutdown stop feedback; stale effects are not resumed. Rumble intensity is capped at half strength and each request at ten seconds. Games must use Android gamepad vibration; phone vibration and Android VR haptics are not forwarded.
Steam Input loads SDL3 from Steam’s bundled ARM64 runtime and reads Steam’s virtual gamepads, never the physical devices directly. Framely’s output has a distinct device identity and is excluded to prevent a feedback loop. If the Steam runtime is unavailable, launch reports an error; choose Frame direct explicitly instead of silently bypassing Steam’s mappings. With multiple source controllers, the most recently active controller supplies input and receives rumble; they are not merged.
### 可选手柄输入
**APK → 设置 → 手柄输入**默认关闭,旧配置升级也保持关闭。开启后默认使用 Steam Input,沿用 Steam 的手柄配置,支持 Frame 手柄及 Steam 已识别的外接手柄。可选择 **Frame 直连(兼容模式)**保留原有 OpenVR 输入。切换来源需关闭容器后重新启动;关闭输入立即生效。
支持 ABXY、十字键及斜向、双摇杆及按压、肩键、模拟扳机、Select 与 Start;应用必须原生支持 Android 游戏手柄,不模拟触摸或 VR 控制器追踪。同时仅一个目标 APK 接收输入,Android 前台状态丢失、查询失败时清零,但保留虚拟设备以便恢复。
**手柄震动**可独立关闭并立即生效。支持游戏请求的 `FF_RUMBLE`,回传给当前输入手柄;切换来源、失去 Android 前台状态、断连或退出时停止,不恢复旧效果。强度上限为一半,单次请求最长十秒;不转发手机振动或 Android VR 触觉。多个手柄以最近产生有效输入的手柄为来源,不合并输入。
桥接以 Steam 会话用户运行,使用 Steam 随附的 ARM64 SDL3,仅读取 Steam 虚拟手柄。Framely 输出设备使用独立标识并排除自身,避免反馈循环。仅把专用事件节点及只读按键布局挂载进容器,不修改系统或 Steam 安装文件。Frame 直连使用独立的 SteamVR 身份;Steam Input 不注册 OpenVR 输入动作,避免影响 SDL 的虚拟手柄枚举。SDL3 不可用时明确报错,可手动选择 Frame 直连。日志位于 `~/.local/share/framely/apk-manager/logs/gamepad.log`,不记录按键。APK 必须从管理面板或启动台启动,单次 CLI 不能持有持续桥接。
## Container lifecycle
The APK page provides two persistent switches. **Stop container after app exits** defaults off: after a confirmed launch, all target app processes must remain absent for 15 seconds before the container stops. Background apps and services keep it alive. **Stop container when closing its window** defaults on: a confirmed system window-close signal stops the associated container (normally within a few seconds). Switching windows, minimizing, and opening the launcher do not count as closing.
Monitoring pauses during APK mutations and startup checks. A container restart, uncertain process query, or another active app in a legacy shared container prevents stopping. Steam-managed containers are left to Steam. Shutdown uses normal Podman stop with a 10-second grace period; APKs, saves and downloads are retained. Reopening a stopped container takes a cold Android start; with both switches disabled a healthy running container is reused.
### SteamOS window-close limitation
On Frame Gamescope `3.16.28-76-ge383171f`, both window and Dock close controls log `Closing Wayland windows not supported yet.` for direct, non-Steam Lepton windows. The close request does not reach Android, so this switch cannot make these controls work on that path. Use **Launch through Steam** as described below, or the APK panel's **Stop container** action. Framely does not infer close intent from focus changes or this unscoped log message.
## Native Steam / Lepton launches
**Launch through Steam** defaults to on. Framely registers launchable sideloaded APKs with Steam's native Lepton compatibility tool. Existing opt-outs remain disabled, and Steam-managed titles are not registered again. Registration does not launch or restart applications. Steam must be awake; unavailable registration is retried in the background.
Steam entries show the APK's application name and icon. Framely generates matching library capsules, headers and hero images from the icon, without downloading artwork. The original launcher icon, order and favorites stay intact; the explicit Steam App ID binding excludes duplicate entries from the launcher Steam category. APK updates refresh generated entry metadata.
The native runtime has a `steamlaunch-…` process/container name, while the APK keeps its existing data directory and Framely identity. No game-data copy, APK reinstall or system compositor modification is required. A private, per-user Lepton entry adapter retains resource storage, selected activity, window orientation, shader cache and optional controller forwarding. It prevents native Lepton from clearing an existing installation after a timestamp change or early exit. Unknown entry-script formats are refused before starting the application.
Close an already running container before switching its launch path. Framely does not restart a running game to assign Steam ownership. Old shared containers remain discoverable, but only one Steam launch may own their data at a time. Duplicate launches are blocked using an ownership lock that survives the native process launch.
On the tested Frame build, native Lepton ownership lets both the window's lower close button and the Dock close button show Steam's exit confirmation. Confirming exit stops the app and its container. Steam **Stop** and APK management **Stop container** remain available. This result was verified with an isolated flat APK; application-specific and VR behavior may differ. Direct, non-Steam Lepton windows still encounter that build's unsupported Wayland close path.
Entry metadata and the launch adapter are configured through Steam's existing local library UI API, reached through its local debugging endpoint on port 8080. Framely neither enables the endpoint nor changes Steam launch settings to enable it. If the API is unavailable or the shortcut target cannot be verified, registration reports an error and retries; it does not edit the live shortcuts database or silently switch to an unprotected launch. This Steam UI interface can change with Steam updates.
Disabling Steam launch removes only Framely's entry; close a native Steam app first. Uninstalling an APK stops its native container before removing its entry. APK data is removed only by the explicitly selected uninstall/data-cleanup operation. The same session service verifies process and container boot identities so an old ownership record cannot stop a newer application.
### Steam / Lepton 原生启动
**通过 Steam 启动**默认开启。Framely 使用 Steam 原生 Lepton 兼容工具注册可启动的侧载 APK,保留主动关闭的选择,跳过 Steam 已管理的应用。注册不会启动应用或重启容器;Steam 需要保持唤醒,不可用时会后台重试。
Steam 入口显示 APK 的应用名称和图标,并根据图标生成对应的库封面、横幅和背景图,不联网下载图片。启动台原有图标、排序和收藏不变,通过明确的 Steam App ID 绑定过滤 Steam 分类中的重复入口。APK 更新会刷新生成的入口信息。
原生运行时的进程和容器名为 `steamlaunch-…`,APK 仍保留原数据目录及 Framely 身份,无需复制游戏数据、重装 APK 或修改系统合成器。平面 APK 启动后会通过 Android 任务接口切换为全屏,避免恢复成桌面内的自由窗口;不会持续锁定用户之后的窗口调整。用户目录内的独立 Lepton 入口适配保留资源目录、选择的启动入口、窗口方向、着色器缓存和可选手柄转发,并防止原生 Lepton 在时间戳变化或短时间退出后清除已有安装。无法识别的入口脚本格式会在启动应用之前拒绝。
切换启动路径之前,需要先关闭已经运行的容器;Framely 不会为了绑定 Steam 重启游戏。旧共享容器仍可识别,但同时只允许一个 Steam 启动占用其数据。跨进程保留的占用锁阻止重复启动及共享数据的并发启动。
独立平面 APK 的实机验证显示,窗口下方和 Dock 的关闭按钮都能弹出 Steam 退出确认,确认后应用和容器停止。也可使用 Steam 的“停止”或 APK 管理中的“停止容器”。具体应用及 VR 应用行为可能不同;直接启动的非 Steam Lepton 窗口仍受当前系统未实现 Wayland 关闭的限制。
名称、图片和启动适配通过 Steam 已有的本地库界面 API 配置,连接其 8080 端口的本地调试接口。Framely 不开启该接口,也不为此修改 Steam 启动设置。API 不可用或快捷方式目标验证失败时,注册显示错误并重试,不直接修改运行中的快捷方式数据库,也不悄悄切换为无数据保护的启动。此 Steam 界面接口可能随 Steam 更新变化。
关闭原生 Steam 应用后,才能关闭“通过 Steam 启动”;关闭开关只移除 Framely 的入口。卸载 APK 时先停止其原生容器,确认 Android 卸载成功后再移除入口。只有明确选择的卸载或数据清理操作才删除应用数据。用户会话服务继续核对进程及容器启动标识,防止旧占用记录停止新的应用。
Container list headings show installed application names; the data path identifies the container. An APK update stops its container before backing up data. If stopping fails or a native Steam launch still owns it, the installation dialog offers **Close container** with confirmation. Closing interrupts running apps and retains their saves. The reviewed APK remains available so installation can be retried after closing.
### Steam entry retention
**APK → Settings → Keep installed APKs in Steam** defaults to on. Turning it off removes idle Framely-owned entries and disables automatic registration. Launching an app whose **Launch through Steam** option is enabled registers its entry on demand; after the native launch process and container finish, the entry and its temporary Devkit copy are removed. Installed APKs, containers, saves and downloaded game data are retained. Running entries are protected. Failed or interrupted starts are cleaned up after a startup grace period, with retries when Steam is unavailable. Turning retention back on resumes automatic registration.
### Uninstalling while keeping the container
Keeping application data uses Android PackageManager readiness instead of requiring user unlock or external storage mounting. Deleting data still waits for those conditions. Framely boots a stopped container without showing its desktop and repairs only the selected APK registration if needed. It reports startup, PackageManager, unlock, storage and container-exit failures separately. Steam entries are removed after Android confirms successful uninstall; Android success is saved first so a Steam cleanup retry does not uninstall again. Failed startup or uninstall preserves the application record, Steam binding and application data. The error dialog offers Retry and Export logs. A container that cannot boot still requires diagnosis; Framely does not silently delete it or edit Android package databases.
+36 -5
View File
@@ -11,9 +11,9 @@ Click Framely in the SteamVR Dashboard Dock. First use requires accepting the te
- **Favorites**: open favorite plugin quick pages.
- **Installed**: browse enabled local plugins and their pages.
- **Notifications**: view saved notifications and update reminders, and toggle floating notifications.
- **Settings**: choose an installed language, toggle safe mode, open the plugin manager or **Check for updates**. The update entry opens the manager’s About/update page. Install language files and download the language template from the manager’s Settings page.
- **Settings**: choose an installed language, toggle safe mode, open the plugin manager or **Check for updates**. The update entry opens the manager’s Settings → Updates page. Install language files and download the language template from the manager’s Settings page.
The manager opens a separate large window with navigation for plugins, plugin library, sources, settings, notification settings and About. Installation, updates and source management happen here. A phone or computer can also use the [network panel](network-panel.md).
The manager opens a separate large window with five sections: Plugin, APK, Terminal, Files and Settings. Installation, updates and source management happen here. A phone or computer can also use the [network panel](network-panel.md).
## Plugins and windows
@@ -25,11 +25,11 @@ Dock windows use SteamVR close controls. Temporary windows may be destroyed when
Settings provides language, network panel and proxy configuration. HTTP and GitHub proxies have independent switches; saving an address does not automatically enable it.
Safe mode pauses third-party plugins for troubleshooting; leave it after resolving the problem. About shows the device version, updates and terms. Revoking consent disables all plugins; accepting again does not automatically re-enable them.
Safe mode pauses third-party plugins for troubleshooting; leave it after resolving the problem. Settings → About shows the device version and terms; Settings → Updates manages updates. Revoking consent disables all plugins; accepting again does not automatically re-enable them.
In About, select the Stable or Testing update channel and check for updates. Choose **Download and install**, then confirm once: Framely downloads and verifies the release and automatically starts installation. Download and verification are displayed as separate stages, with byte progress for each. Download or verification failure stops installation and displays an error. Plugins and data remain; the Framely interface briefly closes and restarts.
In Settings → Updates, select the Stable or Testing update channel and check for updates. Choose **Download and install**, then confirm once: Framely downloads and verifies the release and automatically starts installation. Download and verification are displayed as separate stages, with byte progress for each. Download or verification failure stops installation and displays an error. Plugins and data remain; the Framely interface briefly closes and restarts.
Automatic update checks are enabled by default. Framely checks about 30 seconds after starting (once terms are accepted), then every 6 hours. In About, turn **Check for updates automatically** off or change the interval. Checks use the selected Stable/Testing channel and configured proxy, continue with the panel closed, and never download or install automatically. A newer version saves a notification to the inbox and shows a popup when notification settings allow it. **Ignore** dismisses that version's reminder; **Open updates** opens About's update page. The same version is not repeatedly announced, including after restart. Switching the source or channel clears the old reminder.
Automatic update checks are enabled by default. Framely checks about 30 seconds after starting (once terms are accepted), then every 6 hours. In Settings → Updates, turn **Check for updates automatically** off or change the interval. Checks use the selected Stable/Testing channel and configured proxy, continue with the panel closed, and never download or install automatically. A newer version saves a notification to the inbox and shows a popup when notification settings allow it. **Ignore** dismisses that version's reminder; **Open updates** opens Settings → Updates. The same version is not repeatedly announced, including after restart. Switching the source or channel clears the old reminder.
Floating notifications follow the headset near the upper-right of the view. Their input mask matches the visible card; short button clicks tolerate small tracking movements.
@@ -40,3 +40,34 @@ The **Allow notifications** switch at the top of Notifications controls all floa
In the manager, **Notification settings** provides global **Floating notifications** and **Launcher badge** switches, plus independent **Badge** and **Popup** switches for Framely itself (including update reminders) and every installed plugin, including disabled plugins. Global switches take priority and preserve each app’s preferences. The Framely Dock launcher badge counts unread inbox messages from sources allowed to show a badge, displays `99+` for larger counts, and disappears when you view the inbox. Hidden headset panels do not mark messages as read. Reading keeps messages and their actions available; it does not remove them. Settings and read state survive restart.
Log commands are in the [installation guide](installation.md). A working manager does not establish that all plugins work. Enable plugins individually and verify their sources and runtime users.
## Export logs
Open **Settings → Recovery and diagnostics → Export logs**. In the headset, the ZIP is saved in `~/Downloads` on Frame and the panel shows its path. From the network panel, the ZIP downloads to your browser instead. Collection includes recent Framely/plugin logs, CEF renderer logs, GPU evidence, service status and version information. Missing sources or failed commands are recorded in `report.json`; they do not prevent exporting the remaining information. Each source and the total archive input are bounded.
If the panel cannot open, connect to Frame using the installer and choose **Export logs** in its footer. Select where to save the ZIP on your computer. It collects directly over SSH, includes the installer’s current operation log, and works when Framely services are stopped or its state file is damaged. No release package selection is required.
Plugin configuration, inbox contents and password files are excluded. Common credential patterns in logs are masked; review application logs before sharing the archive. Nothing is uploaded automatically.
For terminal recovery without a running daemon:
```bash
sudo /var/lib/framely/current/bin/framely export-logs --output /tmp/framely-logs.zip
```
The output must be a new file. If the binary cannot run, an extracted release also includes `tools/export-diagnostics.py`, usable with `sudo python3 tools/export-diagnostics.py --output /tmp/framely-logs.zip`.
## Scrolling in VR
Point the laser at a page and move either controller's stick to scroll, without clicking or focusing the page first. Scrolling follows the element under the laser, including nested plugin panels. Keyboard input pauses page scrolling. Launcher stick navigation keeps its category/page controls.
Hold the primary trigger and move the laser up or down to drag scrollable page content. Small movements remain ordinary clicks; once a vertical drag starts, releasing does not activate the pressed button. Text inputs, sliders and explicit custom drag targets keep their own interactions. The launcher retains its icon arrangement and horizontal page-drag gestures.
Launcher blank-space clicks only dismiss the icon menu. Click outside the launcher window or press B to dismiss it (B exits arrangement first). Steam’s move/depth controls keep the window open and pause stick navigation until the stick returns to neutral. While dragging an icon in arrangement mode, horizontal stick input changes pages; vertical input does not change categories. The boundary rails remain an alternative: hold the pointer beyond a rail for 650 ms to move to the adjacent page.
## Launcher resource priority and closing
Settings → Launcher includes **Prioritize launcher resources**, enabled by default. While the launcher is open, Framely raises its native UI and CEF thread CPU priority to a bounded nice level of −5, then restores the previous priorities when closed or disabled. Games and terminal processes are excluded. This can help CPU contention; it does not reserve GPU capacity. The installed session service must include the matching priority limit.
Closing the launcher returns to the previously selected Dock window when it is still available. Starting an application hands focus to Steam instead of restoring the old window. APK windows are handed off after Android confirms the activity launch; startup health checks continue afterward. A running container with a hidden application window is reused rather than restarted solely because the previous game exited.
+2
View File
@@ -35,3 +35,5 @@ Change the port or switch in Settings → Network panel. Password/authentication
Restarting the session service also invalidates old logins. Saving identical settings retains the session. Incorrect password checks are rate-limited; retry later when asked.
If unreachable, check changing device IPs, network reachability, enabled state and port. Settings and passwords live in `/home/.framely/state` and are retained by uninstall; reinstalling may still require the old password.
The top switcher provides Plugin, APK, Terminal, Files and Settings; the device address defaults to Plugin. [Terminal and files](terminal-and-files.md) provides user-owned shell sessions, uploads/downloads, editing, archives and previews. These tools use the same login and port.
+69
View File
@@ -0,0 +1,69 @@
# Terminal and files
[简体中文](../zh-CN/user-guide/terminal-and-files.md)
[Documentation](../README.md) · [Network panel](network-panel.md)
## Manager navigation
The top switcher contains **Plugin / APK / Terminal / Files / Settings**. Opening the device IP without a fragment starts in Plugin. Each section remembers its last subpage in the browser. Existing `#settings`, `#launcher-settings`, `#about` and `#updates` links continue to work.
Plugin contains installed plugins, the plugin library, sources and notification settings, including Framely's notifications. Plugin-specific settings remain in each plugin's management dialog. APK keeps its apps, containers and retained-data cleanup. Settings contains General, Launcher, Updates and About.
## Interaction feedback
In **Settings → General → Interaction feedback**, Haptic feedback is enabled by default; Sound feedback is disabled by default. Both preferences are saved across restarts. Haptic feedback controls laser hover and launcher gaze-focus vibration across Framely and plugin pages; it does not change APK game rumble. Sound feedback uses Steam’s installed keyboard sound at reduced volume for focus and clicks. It requires the local Steam sound files and audio runtime; no sound files are bundled or downloaded.
## Terminal
Create a terminal to open the configured Steam session user's login shell in their home directory, normally `steamos`. This is a real PTY: Ctrl-C, Tab completion, arrows, Unicode input, window resizing and full-screen programs such as Vim and top work. Use `sudo` inside the terminal when administrator privileges are needed; the panel password is separate from the user's sudo password.
You can create up to 12 sessions, rename them, reconnect or explicitly close them. Changing pages, closing a browser or losing the network leaves the shell running. Restarting the user-session service or Framely ends the sessions; processes are not restored after restart. Closing a session requires confirmation and releases the shell, its session's child processes and PTY.
Only one connection can type in a session. Other connections are read-only; **Take control** transfers input ownership. While disconnected, input is disabled. Reconnection never replays queued keystrokes and restores only the retained output. Each session has a 2 MiB output buffer; a notice appears when older output was discarded. Replayed raw terminal output can lose earlier screen context after truncation.
Terminal input, sudo passwords and output are not written to Framely logs. Output is rendered as terminal characters, not HTML; terminal clipboard-write escape sequences are ignored. xterm.js and its fit addon are included with the offline UI, without CDN requests.
Use **Ctrl+Shift+C** to copy selected terminal text and **Ctrl+Shift+V** to paste. **Ctrl+C** still interrupts the running program; it is not the copy shortcut. The footer shows these shortcuts.
## Browse and organize files
Files opens the user's home directory and accesses the filesystem with that user's permissions. It never automatically elevates privileges. Permission changes are limited to ordinary Unix permission bits; use Terminal and `sudo` for administrator operations.
Use the address bar, breadcrumbs, parent button or expandable folder tree. Quick access includes Home, Downloads, mounted storage, the filesystem root, the recycle bin and your saved folders. Add the current folder using the star button; rename, reorder or remove its shortcut with the adjacent controls. Unavailable folders keep their saved shortcut and display the access error when opened.
Drag the divider between the sidebar and file list to resize it; the width is remembered in this browser and limited automatically on narrow windows. Quick access stays in a fixed-height upper section. The folder tree fills the remaining sidebar height; both lists scroll independently, with their headings kept visible. Opening a folder in the file list or address bar expands the tree to its location and highlights it.
The file list provides hidden-file visibility, sorting, checkboxes for multiple selection, current-folder filtering and cancellable recursive filename search. Recursive search does not follow directory links. Lists are paged in groups of 200; recursive results are limited to 5,000 matches and 500,000 visited entries. Media contents are never scanned to create thumbnails.
**Actions** provides copy, cut, paste, rename, delete, properties, permission editing, compression, extraction and opening files. Right-click a file or folder to open a menu at the pointer; right-clicking a selected item preserves the multi-selection. Right-click the empty list area for new file/folder, paste, upload and refresh actions. Escape or clicking elsewhere closes the menu. Symbolic links have an arrow marker and their target in Properties. Copy preserves links; deleting a link does not delete its target. Special filesystem objects cannot be copied or archived.
Copy, move, upload and extraction let you skip conflicts, keep both names or confirm replacement for the batch. Replacement of a same-name folder replaces that whole folder; it does not merge its contents. Long tasks show actual bytes or completed entries, can be cancelled, and report individual failures. Completed items remain completed when a later item fails or the task is cancelled. Switching manager sections keeps active file work and editor state in the current page.
## Recycle bin
Delete defaults to **Move to recycle bin (30 days)**. Permanent deletion requires an explicit choice and confirmation. Framely keeps trash on the source filesystem: home-directory trash or a private `.framely-trash-UID` directory at the storage mount. If that storage cannot support trash, the operation reports an error and does not fall back to permanent deletion.
The recycle bin supports restoring with an unused name or keeping both copies, permanent removal and clearing all tracked items. Restore needs the original parent directory to exist. Framely cleans expired records about hourly while the session service runs, and only removes items recorded in its own recycle bin. Unavailable storage is retained until accessible again. Other applications' trash is unaffected.
## Transfer and edit
Upload multiple files or a folder from your browser. Transfers use 1 MiB chunks, byte progress and private temporary files; only a completed upload receives its final filename. Cancelled uploads are removed and hourly maintenance removes transfers idle for at least an hour. A stopped service may leave clearly named `.framely-upload-*` temporary files, never a falsely complete final file. Uploads are limited to 64 GiB per file and 64 simultaneous transfer records.
Download a single file directly, or select multiple files/folders to download a ZIP. Download links expire after an hour. Large files stream without loading the entire file into memory; single-byte ranges support video seeking and resuming downloads.
Opening an ordinary file attempts the UTF-8 editor, limited to 5 MiB. Invalid UTF-8, binary data and larger files cannot be edited; use Download instead. Saving checks a content revision. External changes require reloading the file or explicitly confirming overwrite. Unsaved changes require confirmation before closing the editor.
## Archives and media
Create ZIP, TAR or TAR.GZ archives; the output filename selects the format. Choose a destination and conflict behavior when extracting. Archive operations reject absolute paths, parent traversal, symbolic/hard links and special files; extracted contents are never executed. Archive limits are 50,000 entries and 64 GiB expanded data. Cancelling removes staging files and leaves already committed items intact.
Select an image or video to preview it. PNG, JPEG, GIF, WebP, AVIF, BMP, MP4, WebM and MOV use the browser's native decoder; actual codec support depends on the browser. Video controls provide playback, seeking and fullscreen. Unsupported formats can be downloaded; there is no server-side transcoding. HTML and SVG are not opened as same-origin pages.
## Access and privacy
Terminal, file and transfer routes use the existing authenticated manager connection and port. Mutating routes and the terminal WebSocket require an exact matching Origin; plugin sandboxes cannot use them. The service runs as the configured Steam user, independently of the root daemon. Preview/download content is read only after explicit selection. Test media are generated fixtures; Framely does not automatically read or upload Arcturus recordings.
## Diagnostic export
**Settings → General → Export logs** and the installer’s **Export logs** use the same collector. The archive includes recent APK operation logs, Lepton’s saved Android logs, and a limited snapshot of running containers: Android boot, user unlock, storage mounting, PackageManager readiness and recent main/system/crash logs. Rootless containers are inspected as the configured Steam session user. Stopped containers are not started. App state is summarized without tokens or icons; APK files, saves, media and raw memory dumps are excluded. File and archive limits retain recent output; missing sources, truncation and command timeouts are listed in `report.json`. Logs can contain application information; review before sharing.
+5
View File
@@ -12,6 +12,8 @@ Framely 是 Steam Frame 的插件管理器,包含设备端服务、SteamVR 界
2. [基本使用](user-guide/basic-usage.md):Dock 入口、管理窗口、启停、收藏、安全模式。
3. [安装与管理插件](user-guide/plugins.md):插件库、来源、订阅、本地包和更新。
4. [网络管理面板](user-guide/network-panel.md):地址、首次密码、登录、手机/电脑使用。
5. [APK 管理](user-guide/apk-manager.md):侧载安装、更新、容器、保留数据与清理。
6. [终端与文件](user-guide/terminal-and-files.md):用户终端会话、文件操作、回收站、传输与预览。
## 插件开发与发布
@@ -35,3 +37,6 @@ Framely 是 Steam Frame 的插件管理器,包含设备端服务、SteamVR 界
- [Framely 发行与更新机制](releases.md)
- [电脑端安装器构建](../../installer/README.zh-CN.md)
- [空间启动台](launcher.md)
- [启动台操作与本体兼容](developer-guide/launcher.md)
+4
View File
@@ -82,3 +82,7 @@ sudo /var/lib/framely/current/bin/framely install ./yourname.my-plugin-0.1.0.fra
GitHub Release 默认使用标签 `v<version>` 和附件 `<id>-<version>.framely`,源码清单可以省略 `downloadUrl`。社区登记会自动拼接地址;打包前按[发布指南](publishing.md)生成包含最终地址的临时清单,因为当前 `framely pack` 不会自己读取仓库地址。自定义下载地址再显式填写 `downloadUrl`。随后公开 Release、上传包,提供使用说明、运行用户、更新记录和实际测试范围,再自行托管插件源或登记固定源码提交。社区数据库还需校验整包预期哈希和字段兼容性。
后续更新:提升版本号 → 重新生成发布清单(自定义地址时更新地址)→ 构建打包并校验 → 实机验证 → 新 Release → 更新来源登记。不要替换旧版本附件。
## 启动台操作与本体兼容
[启动台操作与本体兼容](launcher.md)
+71
View File
@@ -0,0 +1,71 @@
# 启动台、操作与本体兼容要求
[English](../../developer-guide/launcher.md) · [Manifest](manifest.md) · [SDK](sdk.md)
从 Framely **0.4.3-preview.2** 开始支持。旧插件无需修改:短按默认打开快捷页面,长按显示“快捷面板、管理插件、卸载插件”。没有快捷页面时对应按钮置灰,卸载始终需要确认。
## 本体版本要求
```json
"engines": {"framely": ">=0.4.3-preview.2 <0.5.0"}
```
`engines.framely` 是强制执行的本体兼容条件;`apiVersion` 表示协议版本,两者独立。旧插件可以省略;使用启动台新增声明时必须填写,并明确约束最低版本为 `0.4.3-preview.2` 或更新版本。
与插件依赖共用范围解析:精确版本(`0.4.3` 或 `=0.4.3`)、比较符、空格或逗号连接的交集、`^`、`~` 和通配符。不支持 `||` 和连字符区间。普通范围不匹配预览版;需要在比较条件中显式写出对应主、次、补丁版本及预览标识。例如 `>=0.4.3-preview.2 <0.5.0` 接受后续 0.4.3 预览版和兼容正式版,但不会自动接受 0.4.4 预览版。构建标识不影响匹配。
安装、更新、降级安装和启动均检查兼容性;不兼容安装在执行钩子或替换文件之前被拒绝。插件库仍展示不兼容版本及要求,依赖解析跳过这些版本。本体降级后保留插件文件及启用偏好,但阻止执行。已发布的旧本体会拒绝未知清单字段,无法追溯增加友好升级提示。
## 不同入口的行为
```json
"ui": {
"quickPage": "page.js",
"windows": {"main": {"entry": "page.js", "title": "Example"}},
"launch": {
"launcher": {"type": "window", "window": "main"},
"quickPanel": {"type": "quickPage"},
"manager": {"type": "window", "window": "main"}
}
}
```
未配置的入口默认进入对应插件快捷页面。管理面板独立管理按钮不受影响。长按菜单内置的“快捷面板”始终进入快捷页,不受入口配置影响。窗口目标必须引用已声明窗口,快捷页目标必须声明快捷页面。现有 `plugin.open` 仍仅启动后台,不执行入口导航。
## 长按操作
自定义按钮按声明顺序显示在三个内置操作上方;最多 16 个,ID 合法且不重复,名称非空且不超过 120 字节。名称由插件提供,发布时自行选择合适的语言。
```json
"launcherActions": [
{"id": "open", "label": "打开窗口", "target": {"type": "window", "window": "main"}},
{"id": "connect", "label": "连接", "target": {"type": "backend", "method": "connect", "params": {"profile": "default"}}},
{"id": "notify", "label": "发送通知", "target": {"type": "frontend", "entry": "actions.js"}}
]
```
后台目标必须有后台,接收 `{params, context}`,禁止使用保留的 `framely.*` 方法。前端目标必须指向包内带哈希的脚本;点击时在独立沙箱中加载,不渲染快捷页面,可使用现有 SDK 能力。前端操作最多等待 90 秒,失败保留菜单并支持重试。操作不会取得插件管理或任意系统命令权限。
新模板会自动把 `actions.ts` 构建为 `actions.js`:
```ts
import {registerLauncherActions, framely} from '@framely/sdk';
registerLauncherActions({
notify: async context => {
await framely.notifications.send({
id: 'hello', title: '你好', body: `来自 ${context.source}`, inbox: true,
});
},
});
```
## 启动上下文
```ts
const initial = await framely.ui.launchContext.get();
const unsubscribe = framely.ui.launchContext.onChanged(context => {
console.log(context.source, context.trigger, context.actionId);
});
```
`source` 为 `launcher`、`quickPanel` 或 `manager`;`trigger` 为 `shortPress` 或 `menuAction`;自定义操作还包含 `actionId`。首次加载即可查询,复用页面或窗口时接收 `ui.launch` 事件。前端操作直接接收上下文,后台操作随参数接收。入口导致后台首次启动时,`onStart` 生命周期参数也包含 `launchContext`。没有已知来源的旧调用默认标记为快捷面板。
+4
View File
@@ -96,3 +96,7 @@
清单 JSON 最大 256 KiB,载荷路径最多 512 字节。载荷路径仅允许 ASCII 字母、数字及 `/._-+`,禁止绝对路径、空段、`.`、`..`、软链接和未声明的附加包文件。清单通过校验后,运行权限仍需用户判断;文件哈希不代表插件安全审核。
`backend.uiVisibilityEvents`(boolean,默认 false):订阅宿主专用 `framely.ui.visibility` RPC。后端必须及时回复;通知无需页面挂载。该字段需要支持可见性事件的新版宿主。
## 启动台操作与本体兼容
[启动台操作与本体兼容](launcher.md)
+8
View File
@@ -153,3 +153,11 @@ const off = framely.ui.onVisibilityChanged(state => {
`framely.ui.close()` 关闭当前原生界面:快捷页关闭 Framely 面板,插件窗口关闭自身;不会停止插件后端或当前录制。需要包含此 bridge 方法的新版宿主。
独立插件窗口直接展示插件页面,宿主不添加标题栏。插件应自行提供标题、导航和关闭按钮,可使用 `framely.ui.close()` 或 `framely.windows.close(id)`。快捷面板仍保留宿主导航。
## 启动台操作与本体兼容
[启动台操作与本体兼容](launcher.md)
### 本体页面滚动
原生 CEF 宿主在每个页面加载完成时安装主扳机纵向拖动滚动,覆盖现有插件页面、嵌套页面,以及不使用 SDK 的 `localWeb` 窗口。共用的页面标记防止本体桥接或 SDK 重复安装。激光指向的摇杆滚动也通过原生滚轮输入支持这些窗口。它选择指针下可滚动的祖先区域,并在边界继续滚动外层。输入框、文本域、可编辑内容和滑块保留自身交互。若插件需要自行处理纵向拖拽,请在对应元素或其祖先上设置 `data-framely-no-scroll-drag`;原生 `draggable="true"` 元素也会排除。无需新增清单字段或重新打包插件。
+59
View File
@@ -0,0 +1,59 @@
# 空间启动台
[English](../launcher.md)
使用任意支持的点击输入点击 Framely Dock 图标,打开启动台。长按 **600 毫秒** 打开快捷面板,按住期间显示边框进度;长按完成后松手不会再打开启动台。此操作替代原来的主扳机、上扳机分工及扳机互换设置。
启动台是 Dock 内宽 3.6 米、高度保留为 2 米的原生面板,由 Steam 管理位置和曲面;打开时通过 Dock 的面板切换机制替代当前面板,Dock 隐藏时关闭。界面绘制上限固定为 60 FPS,不跟随头显刷新率升高,以限制像素读回与纹理上传负担。这是绘制上限,并不保证实测达到该帧率。启动台使用 4320×2400 的纹理(逻辑分辨率的 3 倍),保留多级纹理过滤以平滑图标边缘,只上传发生变化的区域;拖动动画期间缓存应用排序和搜索结果。图标区域始终保留六列三行的空间,不随应用数量变化;每页最多 13 个图标,按第一排 4 个、第二排 5 个、第三排 4 个的顺序填充。第二排向左错开半格,第三排与第一排对齐;未填满的第二、三排也从相同槽位开始,不按数量重新居中分配。9 个为 4/5,10 个为 4/5/1;1–4 个使用一排居中排列。图标区域独立于分类器居中,高度固定为 570 个界面像素;只有一排或两排图标时,每排的槽位位置仍保持不变。“完成”按钮使用与分类器相同的半透明背景、边框和高光,分类器与图标之间的可见留白大于图标之间的水平留白。按钮与摇杆翻页采用 300 毫秒横向滑动与淡入动效,分类切换采用 360 毫秒纵向滑动与淡入动效,分类器的激活底块同步滑动到选中项,系统启用减少动态效果时跳过这些过渡动画。切换到其他 Dock 面板会正常替代启动台,Framely 不修改其他窗口的透明度或输入设置。关闭启动台后返回 Steam 的 Dock 面板。Steam 优先使用本地封面,缺图时回退到 Logo 或首字母。透明界面沿用户面前弯曲,显示应用图标、名称、分类器和顶部搜索框。右侧胶囊按钮打开管理面板的插件库或设置页。左侧切换收藏、全部、插件、Steam、Lepton 和桌面程序,底部圆点翻页,悬停图标显示收藏按钮,已收藏时显示蓝色实心星标,再次点击可取消收藏。停用插件不显示,安全模式阻止第三方插件启动。Steam 仅展示 Frame 本机各库已安装应用,不包含仅在账号库或串流电脑中的应用。
按下后的激光落点允许在 36 个界面像素内抖动,点击区域大于图标本身;明显拖动会取消落点稳定处理。主扳机按住插件图标 400 毫秒展开操作菜单,普通抖动不会取消长按,包含开发者按钮和“快捷面板、管理插件、卸载插件”。按 **B** 或点击空白区域关闭启动台;处于图标整理状态时,第一次操作先退出整理,启动台继续显示。按住主扳机横向拖动时,当前页随手移动,相邻页同步滑入;松手后吸附到相邻页,拖动距离不足或到达边界则回到当前页。操作菜单默认在指针离开 10 秒后关闭,重新移入取消计时。在 **管理面板 → 启动台** 调整自动关闭开关与时长(1–300 秒)。卸载需要确认,并保留插件数据。
继续按住到 **800 毫秒**进入图标整理。拖动任意图标到其他位置,其他图标按顺序移动并自动补齐 4/5/4 槽位,不留空洞。Framely 本身也在启动台中,点击打开管理面板,并可一起排列。向左拖动的翻页边缘位于分类器右侧,分类器本身不会触发翻页。拖到图标区域左右边缘停留 650 毫秒自动翻页,继续停留可跨更多页面。放手保存排列,点击“完成”退出整理。关闭启动台或隐藏 Dock 会取消尚未完成的拖动。手动排列在收藏、搜索、刷新和重新打开后保持不变。收藏不会将图标移到前面,收藏分类按相同顺序筛选;尚无保存位置的应用按名称追加到末尾。
任一手柄的摇杆上下切换分类、左右翻页。每次拨动只取幅度较大的一个方向,回到中位范围后才允许再次导航,避免斜向或两个摇杆同时触发分类与翻页。
桌面程序从会话用户的 XDG 应用目录和 Flatpak 导出入口读取,隐藏入口及重复的 Steam 游戏快捷方式不会显示。Steam 安装的 APK 应用出现在 Lepton 分类,通过 Steam 启动;侧载应用从 Lepton 各容器的已安装 APK 与包数据库读取,排除空容器和 Android 系统组件,并在原有用户容器中启动。缺少 Android 名称、图片时使用包名和首字母。仅下载但未安装的 APK 不会加入启动台,读取应用列表也不会启动容器。
Steam 启动成功表示请求已交给 Steam,并不代表游戏加载完成。插件库版本可声明 `engines.framely`;当前本体不满足显示的范围时,请先升级本体。
## 分类与收藏
管理面板新增独立的 **启动台** 页面,集中设置扳机分配、菜单自动关闭及“全部包含的分类”。默认包含插件(含 Framely)、Steam、Lepton、桌面程序。关闭某个分类只影响“全部”,其单独分类和收藏仍可访问;全部关闭时,“全部”显示空状态。
所有类型的应用均可用悬停显示的星标收藏,已有插件与 Steam 收藏保持不变。停用插件不显示,暂时不可用的应用仍保留收藏记录。每次打开会清空搜索并重置分页,但保持上次所选分类;当前 Framely 运行期间的分类选择会一直保留。仅本次运行首次打开时,本地应用枚举完成后,有可显示的收藏则进入收藏,否则进入全部。在收藏页取消最后一个收藏时保持收藏分类,重新打开也显示空状态,不自动切换分类。
## 搜索
点击顶部胶囊搜索框打开 VR 键盘。仅搜索当前分类,并保留原有排序;清空后恢复分类内容。键盘打开期间暂停摇杆导航及背景关闭,B先关闭键盘。搜索不会改变图标区域的固定大小或位置。
支持原文、英文单词首字母、中文拼音、日语罗马音及音节首字母。不区分大小写、全半角,忽略声调、空格与分隔符,支持前缀及连续片段。例如 `toushi`、`tiaose`、`tsts` 匹配“透视调色”;`sakura`、`skr` 匹配“さくら”;`toukyou` 匹配“東京”;`hla` 匹配“Half-Life: Alyx”。中文索引在有限大小内包含单字的其他读音,生僻名称或词组读音可能与实际读法不同。
索引在设备后台异步生成并缓存。中文使用离线拼音数据,日语使用随包提供的 Vibrato/IPADic 读音词典。汉字名称同时生成中文和日语候选,不依赖界面语言;词典无法识别的部分保留原文。读音索引尚未完成时仍可使用原文搜索,不会将应用名称发送至外部搜索服务。
会话接口:`launcher.search.index` 接收 `{names: string[]}`,返回名称对应的 `{terms: string[]}`。`launcher.favorite` 接收 `{key, favorite}`,使用与图标排列相同的稳定标识。插件和 Steam 仍更新原有收藏,`framely`、`desktop:` 和本地 `lepton:` 标识保存于 `launcherFavorites`。`launcher.settings.save` 新增 `allCategories`(`plugin`、`steam`、`lepton`、`desktop`);旧配置省略字段时默认全选,显式空数组表示全部不选。词典和许可说明位于发布包 `share/search`,同时包含于本体更新包和完整离线包。
已收藏应用的右上角显示常驻的蓝色实心星标,再次点击即可取消收藏;收藏状态变化不会改变图标排序。
## 眼追与手柄确认
激光未指向启动台时,有效眼追可以选中图标、分类和操作按钮。稳定注视 120 毫秒后高亮目标,并轻振手柄;注视坐标经过轻度滤波,图标边缘附近也可命中最近图标;小幅抖动不会立即切换焦点,短暂丢帧最多保留高亮 280 毫秒。按住期间追踪失效仍会取消按下。激光指向启动台后立即恢复激光交互,Steam 的窗口移动控件及 VR 键盘会暂停眼追。这里使用“激光未指向启动台”的切换规则,不假定公开 OpenVR 能读取 Steam 私有的左右手柄模式标志。
使用左手柄下方方向键(需求中称为“A”的位置)、右手柄 A 或任意手柄的主扳机确认。短按打开选中项,图标长按 400 毫秒打开菜单,800 毫秒进入排列模式。按下后锁定目标,眼睛移动不会拖动图标或切换正在按住的目标;随后使用激光和摇杆排列。眼追失效或确认手柄断连会取消当前按下,必须松开按键才接受下一次操作。追踪不可用时不会用头部朝向替代眼追。
### 眼追校准
在 Frame 内的管理面板打开“启动台 → 眼追校准 → 开始校准”。也可点击启动台右侧设置按钮上方的眼追校准入口。模拟界面沿用同一个 Dock 窗口、图标排列、搜索框和两侧胶囊。开始后自然注视依次高亮的目标,不需要按键确认。采集 13 个图标、6 个分类按钮、4 个快捷按钮和搜索框,再重复采集 5 个位置验证修正效果。连续追踪时约需一分钟;追踪失效会暂停采集,抖动过大会提示重试。B 或取消退出,不保存结果。
可以转头或移动头部来看清边缘目标。每帧都结合当时的头显姿态,把测得的注视方向与“当前眼睛起点到高亮目标”的方向配对。目标位置通过 Steam 实际曲面命中反求,并在头部或窗口移动后重新检查;头部移动本身不算注视抖动。
拟合前对短时间片内的成对方向一起平均,每个目标权重相同,并通过稳健重加权减小采错目标的影响。验证使用每次注视的方向残差中位数,始终保留逐帧头部坐标;单个尖峰帧不会否决整次校准。
结果显示各目标偏差的均方根和最差目标偏差,单位为度。各目标还显示 95% 帧误差以及未修正时的中位误差,区分持续偏差和追踪噪声。校准摘要与训练时间片数据会写入会话日志,便于定位问题。“保存校准”持久保存头显坐标系内偏航、俯仰角的修正。运行时使用当前头显姿态把修正方向转换到空间坐标,保留眼睛起点,再与 Dock 曲面求交。不会改变激光输入或系统眼追。误差参照高亮目标方向,不以原生眼追作为正确答案。验证失败不会覆盖原有校准;旧版窗口坐标校准不再应用,更新后请重新校准。此修正处理稳定角度偏移与增益,非线性追踪误差仍可能存在。OpenVR 未公开眼睛摄像头的准确曝光时间,快速移动时仍可能有时序误差。
明显调整头显佩戴方式或窗口距离后,请重新校准。
按住 200 毫秒后才显示进度反馈。Dock 入口使用蓝色边框进度,600 毫秒打开快捷面板。启动台图标使用半透明白色圆形边框进度:中点刻度对应 400 毫秒打开菜单,继续按至 800 毫秒进入图标编辑;松手或取消按压后移除进度。
### Steam 远程畅玩
Steam 分类也显示已连接远程畅玩电脑上安装的应用,图标右下角标有远程图标。列表后台刷新,断连的电脑不再展示;相同 App ID 只显示一个图标;本机和远程都可用时,点击弹窗选择本机启动或远程畅玩,收藏和手动排序保持同一份。点击远程图标会先重新检查可用状态,再让 Steam 从对应电脑串流。图片使用本机 Steam 缓存,缺图显示占位图。此功能读取正在运行的 Steam 客户端界面;该接口不可用时,本机游戏仍可使用。
+4
View File
@@ -93,3 +93,7 @@ restart 默认为 on-failure;never 只记录失败,不自动重启。restart
状态包含 starting、running、stopping、stopped、recovering、failed 等阶段,并发管理操作沿核心服务的串行调度执行。管理器正常 SIGTERM/SIGINT 会尝试逐个停止插件;强制终止、断电不能保证任何钩子执行。清理应同时可在下次启动时安全恢复。
日志页面合并展示后端日志与 lifecycle 日志;每种日志保留当前 2 MiB 与上一份。安装失败且插件尚未登记时,可从 `/var/lib/framely/logs/<id>.lifecycle.log` 查看。运行身份的数据目录为 `/var/lib/framely/data/<id>/<身份>/`(自定义核心数据目录时相应变化)。
## 启动上下文
[启动上下文](developer-guide/launcher.md)
+150
View File
@@ -0,0 +1,150 @@
# APK 管理
全局手柄与容器生命周期选项位于 **APK → 设置**,不再占用应用列表。每个应用的显示与启动选项仍保留在对应应用的管理弹窗内。
[English](../../user-guide/apk-manager.md)
[文档首页](../README.md) · [启动台](../launcher.md)
APK 管理用于安装和管理 Steam Frame 上的 Lepton 侧载应用,本地管理面板与登录后的网络面板均可使用。它只管理用户提供的文件,不提供商店、推荐、下载源或自动更新。
通过顶部切换器可在插件管理与 APK 管理面板之间切换。直接访问设备 IP 默认进入插件管理;APK 管理有独立的应用、容器和数据清理导航。
## 环境与发现
先通过 Steam 安装 Lepton。Framely 使用 Steam 会话用户的 Lepton 与 Podman,不以 root 操作,也不全局安装 Android。应用兼容性取决于 Lepton;Google 服务、设备专用接口和 DRM 可能不可用。
打开“APK 管理 → 刷新”,扫描标准 Lepton 容器目录、Framely 已保存记录及运行中容器的兼容数据标签。扫描不会启动容器。Steam 管理的 APK 在容器视图中标识,更新和卸载仍通过 Steam。
其他工具使用自定义位置时,在“容器 → 其他数据位置”添加包含 `data_overlay/system/packages.xml` 的 `baked` 目录。如果原容器名称与上级目录不同,还需填写原容器名称;名称不能与其他数据目录对应的容器冲突。目录必须属于会话用户;移除扫描位置不会删除数据。无法自动发现的自定义布局需手动登记。
应用按“容器+包名”识别,同包在不同容器里分别管理。改变容器名称或数据位置可能改变应用身份。
## 安装与更新
安装确认中可选择 **显示方式 → 平面窗口 / VR 应用**。初始选项依据 APK 检测结果,更新时保留已有窗口设置。平面模式显示安卓窗口;VR 模式隐藏二维窗口,应用本身需要支持 VR。安装成功后保存选择,安装失败保留原设置。
点击“安装 APK”,选择单个 `.apk`,核对名称、包名、版本、最低 Android SDK 和目标容器。在 Frame 内选择本机 APK 会直接在设备上校验,不经过浏览器上传;确认阶段保留独立本机副本,不修改原文件。网络上传暂存于 Frame 持久化文件系统,避免占满较小的 `/tmp`。上传显示真实字节进度;后续显示处理阶段,不使用假百分比。
在 Frame 内,两个管理面板的文件选择入口统一使用 Framely 内置文件选择器,包括 APK、插件包和语言文件。默认打开下载目录,记住上次选择的目录;左侧为按需加载的文件夹树,覆盖主目录、临时目录和已挂载存储,支持逐级展开、收起和当前路径定位,提供目录导航、手动输入路径、搜索、隐藏文件和文件类型筛选。选中文件后确认;B/Escape 只取消选择器,不关闭管理面板。外部浏览器继续使用系统文件选择器。启动台右侧的“安装APK”按钮打开 APK 管理面板。
共享容器中的 APK 使用各自独立的 Android 安装目录。容器重启会保留 Android 外部存储中的已下载资源,包括未完成的下载片段和更新进度记录。无法识别的 Lepton 存储初始化脚本会在执行前拒绝,避免丢弃文件;游戏是否继续下载仍由自身更新器决定。旧版单 APK 挂载会在保存的安装包可用时恢复,旧 OBB 资源链接会在替换安装前迁移,并保留原目标。这只能防止后续丢失,旧版启动流程已经删除的下载资源无法仅靠 APK 还原。
已显示的应用再次打开时复用运行中的容器和虚拟手柄。无显示或已完全隐藏的窗口、改变窗口物理尺寸、首次挂载新的手柄设备时仍需重启,因为 Lepton 无法安全地在运行中完成这些显示或设备切换。
启动台图标优先使用 APK 中最高密度的位图资源,不再直接取资源表第一项。已安装应用会在面板或启动台刷新时重新提取,无须重装 APK;PNG、WebP、JPEG 图标保留原始字节。
每个新应用固定使用独立容器。已有共享容器继续识别,允许更新和管理其中已安装的应用,但不能再添加新的包名。Framely 不会自动拆分、迁移或删除旧共享容器及其数据;Steam 管理的容器仍不作为安装目标。
安装全程使用无显示的后台容器,不打开安卓桌面,不受所选显示方式影响。安装不会自动打开应用,完成后可以点击“打开”。没有检测到启动入口的 APK 仍可管理,但不会放进启动台。
更新时进入应用管理,点击“安装新版 APK”。先核对包名与版本,再由 Android 在覆盖安装时执行签名兼容校验。默认拒绝降级;签名失败不会自动卸载重装。同包覆盖安装保留数据。更新可能停止目标容器,影响其中其他应用。
替换已有安装前,会停止容器并保存数据快照,排除临时 overlay 工作目录、运行时套接字和 FIFO,保留删除标记。恢复前核对 SHA-256 文件清单;校验失败不会替换数据。备份失败则中止替换。快照是恢复材料,不保证所有 Android 数据迁移都可逆。仅包含一个应用、且数据目录与备份一致的侧载容器支持一键恢复,包括外部容器;共享容器需手动恢复。一键恢复先备份当前状态,恢复后需启动应用核对存档。
修改操作开始后等待实际结果,不能安全中断时不提供取消。上传与准备阶段可取消。异常中断后先“核对实际安装状态”,再重试或清理数据;容器读不到不代表应用已卸载;界面显示“安装状态未知”,保留之前记录,禁用启动、重新安装和删除操作,先核对实际状态。
## 启动入口与窗口
后台识别清单中的 MAIN/LAUNCHER、电视启动入口和已知 VR 入口,并结合运行中的 Android 包管理器解析结果。停用的包与组件排除。有入口不代表一定能正常运行。
平面应用使用 Lepton 完整显示窗口的启动路径,避免按应用创建窗口时触发 Gamescope 协议错误。安装留下的无显示容器或已关闭的显示窗口会按需重启;重启也会停止同容器内其他应用。VR 应用继续后台启动。ActivityManager 报告启动成功后,Framely 还会确认应用和安卓显示服务持续运行,再报告操作完成。Framely 保留 Lepton 开发容器的数据处理方式,不把已有容器切换到 APK 烘焙模式。临时启动适配脚本使用设备上已安装的 Lepton 库,不修改 Steam 安装目录;遇到不支持的入口脚本,会在冷启动容器前报错。手动“启动容器”仍保留显示桌面的行为。
默认自动处理窗口显示。“高级设置 → 显示安卓窗口”用于排查,并在重启容器后生效。它不会把二维应用转成 VR,也不会把 VR 应用转成二维。Lepton 开发容器重启后可能改变 APK 挂载路径;Android 无法识别时,Framely 会重新登记同签名 APK,保留数据并报告错误。非标准应用还可从已启用、已声明的 Activity 中指定启动入口。
启动台继续按稳定的容器与包名保存收藏、搜索和排序。更新或刷新不重排图标;卸载隐藏图标,保留收藏与位置记录,在原容器重新安装后恢复。长按本地 Lepton 图标可进入管理或卸载确认。
## 关闭、卸载与清理
“关闭应用”只停止目标包;“停止容器”影响其中全部应用。所有可确认数据位置的非 Steam 侧载容器均支持删除,并需确认受影响应用及永久数据删除。标准 Lepton 目录中的容器会整体删除;手动登记的外部位置只删除 baked 目录,保留父目录中的其他文件。卸载应用时默认保留容器,开启“删除容器”才同时删除。
卸载默认保留存档与设置,开启“删除应用数据”才彻底删除。如果容器内只有该应用,会默认勾选“删除容器”,也可手动关闭以保留容器。共享容器或应用状态未知时无法使用该选项,后端删除前会再次核对应用列表。删除容器会同时清理关联 APK 缓存和 Steam 库条目、图标及封面,历史备份保留。保留数据的应用显示在“已卸载但保留数据”中,可以重新安装或清除保留数据,清除时同样提供删除容器选项。
Android 清除已卸载包的保留状态时可能需要原签名 APK。Framely 管理卸载时会保存原 APK。如果其他工具已卸载应用且找不到原 APK,需要先提供原 APK 重新安装,再清除保留数据;不会绕过签名或删除任意目录假装成功。
“数据清理”列出保留数据、旧 APK、恢复快照及过期临时文件。存档与备份默认不选中;未知归属数据只展示,不自动删除。删除前重新核验,已重新安装的应用不会被当作残留清理。批量结果显示实际释放的文件字节及各项失败原因。由于压缩、reflink 和共享存储,文件字节数与物理磁盘占用可能不同。
切换面板不会中止已提交的任务;重新打开 APK 管理会继续显示进度。恢复流程使用本地事务记录,意外中断后会在下次修改操作前恢复到完整状态。
## 日志与面板外恢复
在应用的“日志 → 导出日志”保存操作记录。Android 详细错误保留在日志中,分享前应检查内容。
以 Steam 会话用户执行:
```bash
/var/lib/framely/current/bin/framely apk list
/var/lib/framely/current/bin/framely apk inspect --file /path/to/app.apk
/var/lib/framely/current/bin/framely apk install '{"ticket":"REVIEW_TICKET","approve":true}'
/var/lib/framely/current/bin/framely apk launch '{"app":"CONTEXT/PACKAGE"}'
/var/lib/framely/current/bin/framely apk logs '{"app":"CONTEXT/PACKAGE"}'
/var/lib/framely/current/bin/framely apk cleanup-list
```
校验票据有效期为 15 分钟。APK、管理记录和恢复材料位于 `~/.local/share/framely/apk-manager`,托管 Lepton 数据位于 `~/.local/share/lepton/contexts`。卸载 Framely 保留这些用户目录;卸载前应备份。APK 命令仍需兼容的 Framely 二进制,Lepton 本身由 Steam 独立安装。
请通过 APK 面板或上面的 `framely apk launch` 命令启动 Framely 托管容器。这些入口会保留下载资源并挂载持久存储;直接调用 Lepton 不会应用 Framely 的存储适配。
### 下载资源与 shader 缓存
升级后的下一次容器启动会把已有 Android 共享存储移动到容器内的 `baked/external`,直接挂载,绕开 Android 数据的 OverlayFS 层。迁移只移动目录,保留未完成下载和断点记录,不复制资源内容。若两处目录均已有数据或发现未知链接,会停止启动并保留数据供恢复。已经运行的容器需停止后再次启动才应用新布局;登记的 Steam 兼容数据容器保留原有独立资源布局。
每个容器的 Mesa shader 缓存保存在 `baked/shadercache`,挂载到 `/data/shaders`,重启后仍保留,可复用兼容的已编译 shader;首次使用仍需编译。托管容器备份包含这两个目录,恢复时会随应用数据一起恢复下载资源和缓存。
不要将 Lepton 的全局清理命令用作单应用卸载。
## 格式范围
首版支持单个 APK。不包含分包、XAPK/APKM、OBB 导入、Google Play 安装及自动创建 Steam 快捷方式;不支持的包格式会明确拒绝。
### 平面窗口方向
在 **管理应用 → 高级设置 → 窗口方向** 中选择 **自动选择、横屏或竖屏**。每个应用独立保存,下次启动时应用。竖屏使用纵向窗口,而不是让内容侧着显示。切换方向可能重启共享容器,停止其中其他应用;VR 应用忽略此设置。
Moonlight V+ 12.12.12 的创建连接界面在当前测试的 Lepton 版本上会因缺少 Android 剪贴板服务而崩溃,与此前窗口启动失败是两个问题。Framely 不修改或重新签名 APK,需要兼容的 Lepton 运行环境或应用端容错处理。
### 可选的 Frame 手柄输入
**APK → 应用 → Frame 手柄输入**默认关闭,旧配置升级后也保持关闭。开启后,通过 Framely 打开的 APK 可以将两个 Frame 手柄作为一个标准 Android 游戏手柄使用,包括 ABXY、十字键及斜向组合、双摇杆及按下、肩键、模拟扳机、Select 和 Start。应用本身需要支持 Android 游戏手柄;该功能不把按键映射为触屏操作,也不提供 Android VR 手柄追踪或振动。
开启后在下次打开应用时生效。接入输入设备可能需要重启容器,影响其中其他正在运行的应用。关闭开关立即停止转发。同一时间只向一个由 Framely 打开的 APK 转发。切换或关闭应用、进程查询暂时失败、前台切换时只暂停输入,不移除虚拟手柄。每个运行中的容器保留自己的输入设备供下次打开复用;停止容器、关闭开关或会话服务重启时释放设备。服务重启后再次打开 APK 即可重新接入。使用时在 Dock 中选中目标 Android 窗口;该功能不修改 Steam 的实体手柄绑定。
桥接以 Steam 会话用户运行,需要 `/dev/uinput` 访问权限、已运行的 SteamVR 和受支持的 Lepton 启动接口,不修改 Steam 安装目录中的 Lepton 文件。只向目标容器挂载自己的虚拟输入节点,由 Android 独占接收。接管失败时不转发输入,并提示启动错误;可以关闭开关恢复普通启动。错误记录在 `~/.local/share/framely/apk-manager/logs/gamepad.log`,不记录按键内容。原生桥接和 Android 适配库均包含在离线包及核心更新包中。
原生 Steam 启动在等待启动确认之前选择输入目标。只有 Android 接管虚拟设备、目标应用进入前台后,才开始转发。每个容器的桥接进程使用独立的临时 SteamVR 身份,避免其他桥接进程覆盖其登记。返回已运行应用时重新选择输入目标。
开启此选项后,请通过管理面板或启动台打开 APK。一次性命令行进程无法管理持续运行的输入桥接,此时命令行启动会明确报错。只读诊断可由 Steam 会话用户运行 `framely apk input-status '{"app":"CONTEXT/PACKAGE"}'`,查看 Android 进程、前台及生命周期状态,不输出输入事件或 Steam 令牌;这些状态不能证明应用实际处理了手柄事件。
## 容器退出策略
APK 页面提供两个持久保存的开关。**应用退出后自动停止容器**默认关闭:确认启动后,应用的所有相关进程连续消失 15 秒才停止容器;后台应用或服务仍存在时不会停止。**关闭窗口时停止容器**默认开启:确认系统发出的窗口关闭信号后停止对应容器,通常需要数秒。切换窗口、最小化和打开启动台不属于关闭。
APK 安装、更新、其他修改与启动检查期间暂停监测。容器重启、进程状态无法确认或旧共享容器内还有其他应用运行时,不停止容器;Steam 管理的容器交给 Steam。停止使用正常 Podman 停止流程,给予 10 秒退出时间,保留 APK、存档和下载数据。已停止的容器再次打开需要冷启动 Android;关闭两个开关后仍会复用健康的运行中容器。
### Steam / Lepton 原生启动
**通过 Steam 启动**默认开启。Framely 使用 Steam 原生 Lepton 兼容工具注册可启动的侧载 APK,保留主动关闭的选择,跳过 Steam 已管理的应用。注册不会启动应用或重启容器;Steam 需要保持唤醒,不可用时会后台重试。
Steam 入口显示 APK 的应用名称和图标,并根据图标生成对应的库封面、横幅和背景图,不联网下载图片。启动台原有图标、排序和收藏不变,通过明确的 Steam App ID 绑定过滤 Steam 分类中的重复入口。APK 更新会刷新生成的入口信息。
原生运行时的进程和容器名为 `steamlaunch-…`,APK 仍保留原数据目录及 Framely 身份,无需复制游戏数据、重装 APK 或修改系统合成器。用户目录内的独立 Lepton 入口适配保留资源目录、选择的启动入口、窗口方向、着色器缓存和可选手柄转发,并防止原生 Lepton 在时间戳变化或短时间退出后清除已有安装。无法识别的入口脚本格式会在启动应用之前拒绝。
切换启动路径之前,需要先关闭已经运行的容器;Framely 不会为了绑定 Steam 重启游戏。旧共享容器仍可识别,但同时只允许一个 Steam 启动占用其数据。跨进程保留的占用锁阻止重复启动及共享数据的并发启动。
独立平面 APK 的实机验证显示,窗口下方和 Dock 的关闭按钮都能弹出 Steam 退出确认,确认后应用和容器停止。也可使用 Steam 的“停止”或 APK 管理中的“停止容器”。具体应用及 VR 应用行为可能不同;直接启动的非 Steam Lepton 窗口仍受当前系统未实现 Wayland 关闭的限制。
名称、图片和启动适配通过 Steam 已有的本地库界面 API 配置,连接其 8080 端口的本地调试接口。Framely 不开启该接口,也不为此修改 Steam 启动设置。API 不可用或快捷方式目标验证失败时,注册显示错误并重试,不直接修改运行中的快捷方式数据库,也不悄悄切换为无数据保护的启动。此 Steam 界面接口可能随 Steam 更新变化。
关闭原生 Steam 应用后,才能关闭“通过 Steam 启动”;关闭开关只移除 Framely 的入口。卸载 APK 时先停止其原生容器,确认 Android 卸载成功后再移除入口。只有明确选择的卸载或数据清理操作才删除应用数据。用户会话服务继续核对进程及容器启动标识,防止旧占用记录停止新的应用。
容器列表标题显示已安装应用名称,数据路径用于识别容器。更新 APK 会先停止容器再备份数据。如果停止失败,或原生 Steam 启动进程尚未释放容器,安装确认中提供 **关闭容器** 按钮并要求确认。关闭会中断运行中的应用,保留存档;已检查的 APK 会保留,可关闭后重试安装。
### Steam 入口保留
**APK → 设置 → 保留安装的 APK 到 Steam** 默认开启。关闭后清理空闲的 Framely 自有入口,不再自动注册。应用启用 **通过 Steam 启动** 时,会在启动时临时注册入口;原生启动进程和容器退出后删除入口及临时 Devkit 副本。已安装 APK、容器、存档和下载的游戏数据都会保留,运行中的入口不会删除。失败或中断的启动在启动宽限期后清理;Steam 不可用时稍后重试。重新开启保留设置会恢复自动注册。
### 卸载并保留容器
保留应用数据的卸载使用 Android 包管理器就绪检查,不再强制等待用户解锁或外部存储挂载。删除数据仍等待这些条件。Framely 在后台启动已停止的容器,不显示容器桌面;需要时只修复目标 APK 的登记。启动、包管理器、解锁、存储和容器退出分别报错。Android 确认卸载成功后才移除 Steam 入口,先保存 Android 卸载结果,重试 Steam 清理不会重复卸载。启动或卸载失败保留应用记录、Steam 绑定和应用数据。错误弹窗提供重试与导出日志。无法启动的容器仍需诊断,不会自动删除容器或直接修改 Android 包数据库。
+36 -5
View File
@@ -11,9 +11,9 @@
- **常用**:打开收藏的插件快捷页。
- **已安装**:查看已启用的本机插件,进入插件页面。
- **通知**:查看收件箱消息和更新提醒,并控制悬浮通知。
- **设置**:选择已安装的语言、切换安全模式,或打开“管理插件”和“检查更新”。“检查更新”打开管理窗口的关于/更新页面;安装语言文件和下载语言模板在管理窗口的设置中进行。
- **设置**:选择已安装的语言、切换安全模式,或打开“管理插件”和“检查更新”。“检查更新”打开管理窗口的设置 → 更新页面;安装语言文件和下载语言模板在管理窗口的设置中进行。
“管理插件”打开独立大窗口,左侧导航进入插件、插件库、插件源、设置、通知设置和关于。安装、更新及来源管理在这里完成;电脑或手机也可使用[网络管理面板](network-panel.md)。
“管理插件”打开独立大窗口,顶部进入插件、APK、终端、文件与设置五个区域。安装、更新及来源管理在这里完成;电脑或手机也可使用[网络管理面板](network-panel.md)。
## 插件启停与窗口
@@ -25,9 +25,9 @@
设置中可修改语言、网络面板及代理。HTTP 代理和 GitHub 代理各有开关,保存地址不会自动启用代理。
“安全模式”暂停第三方插件,适合出现故障时检查;排查后再退出安全模式。在“关于”查看本体版本、检查更新和复查协议。撤回协议会停用全部插件,再次同意后需要手动启用。
“安全模式”暂停第三方插件,适合出现故障时检查;排查后再退出安全模式。在“设置 → 关于”查看本体版本和协议,在“设置 → 更新”检查更新。撤回协议会停用全部插件,再次同意后需要手动启用。
在“关于”选择正式版或测试版渠道并检查更新,点击“下载并安装”并确认一次:Framely 下载、校验发行包后自动开始安装。下载和校验分别显示阶段提示与实际字节进度。下载或校验失败时停止安装并显示原因。插件和数据保留,Framely 界面会暂时关闭并重新启动。
在“设置 → 更新”选择正式版或测试版渠道并检查更新,点击“下载并安装”并确认一次:Framely 下载、校验发行包后自动开始安装。下载和校验分别显示阶段提示与实际字节进度。下载或校验失败时停止安装并显示原因。插件和数据保留,Framely 界面会暂时关闭并重新启动。
日志排查命令见[安装指南](installation.md#修复与日志)。界面能打开不代表所有插件都正常;先逐个启用,确认运行身份与来源可信。
@@ -41,6 +41,37 @@
管理窗口的“通知设置”提供全局“悬浮通知”和“启动图标角标”开关,并为 Framely 本体(包括更新提醒)及所有已安装插件(包括已停用插件)提供独立的“角标”和“悬浮”开关。全局开关优先,关闭后仍保留各应用偏好。Framely Dock 启动图标的角标统计允许显示角标来源的未读收件箱消息,超过 99 显示 `99+`;实际打开通知标签后消除角标,隐藏的头显面板不会自动标记已读。查看消息不会删除消息,也不会关闭其操作按钮。设置和已读状态均会保存并在重启后恢复。
本体默认在启动约 30 秒后检查更新(须已接受用户协议),之后每 6 小时检查一次;面板关闭时也会继续检查。可在管理窗口“关于”的更新页关闭自动检查或修改间隔。自动检查遵循所选正式版/测试版渠道及代理配置,只检查并提醒,不会自动下载或安装。
本体默认在启动约 30 秒后检查更新(须已接受用户协议),之后每 6 小时检查一次;面板关闭时也会继续检查。可在管理窗口“设置 → 更新”关闭自动检查或修改间隔。自动检查遵循所选正式版/测试版渠道及代理配置,只检查并提醒,不会自动下载或安装。
发现较新版本后会将提醒保存在收件箱,通知设置允许时同时显示浮窗。“忽略”关闭并移除此版本提醒,同一版本在重启后也不会重复提醒;“打开更新”直接打开管理窗口的更新页面。更改更新源或渠道会清除旧提醒。
## 导出日志
打开 **设置 → 恢复与诊断 → 导出日志**。在头显内,ZIP 保存到 Frame 的 `~/Downloads`,面板显示保存路径;通过网络面板访问时,ZIP 下载到浏览器。日志包包括本体与插件的近期日志、CEF 渲染日志、GPU 信息、服务状态和安装版本。缺失来源或命令失败会记录在 `report.json` 中,不影响导出其余信息;单个来源和总收集量均有大小限制。
管理面板无法打开时,使用安装器连接 Frame,点击底部的 **导出日志**,选择电脑上的保存位置。安装器直接通过 SSH 收集,也会加入当前安装器的操作日志;本体服务停止或状态文件损坏时仍可使用,无需选择发行版本或安装包。
日志包不包含插件配置、收件箱内容或密码文件,会过滤日志中的常见凭据格式;分享前仍应检查应用日志。不会自动上传。
无需运行本体服务,也可以通过终端导出:
```bash
sudo /var/lib/framely/current/bin/framely export-logs --output /tmp/framely-logs.zip
```
输出路径必须是新文件。本体程序无法运行时,解压发行包中的 `tools/export-diagnostics.py` 也可独立使用:`sudo python3 tools/export-diagnostics.py --output /tmp/framely-logs.zip`。
## VR 页面滚动
激光指向页面后,拨动任意手柄的摇杆即可滚动,无需先点击或聚焦页面。滚动作用于激光下的元素,也支持插件页面的内层滚动区域。键盘打开时暂停页面摇杆滚动;启动台仍使用原有的摇杆分类与翻页操作。
按住主扳机并上下移动激光,可拖动可滚动的页面内容。小幅抖动仍视为普通点击;纵向拖动开始后,松开不会触发原先按下的按钮。文本输入、滑块及明确声明的自定义拖拽区域保留自身交互。启动台保留图标排列和横向拖动翻页操作。
启动台窗口内部的空白点击只收起图标菜单。点击窗口外或按 B 关闭;调整模式下 B 先退出调整。Steam 的移动、推远和拉近控件会保持窗口打开,并暂停摇杆导航,摇杆回中后恢复。调整模式拖拽图标时可以用摇杆左右翻页,上下不会切换分类;也可将指针移过分页线并停留 650 毫秒跨页。
## 启动台资源优先与关闭
设置 → 启动台新增默认开启的**启动台资源优先**。启动台打开时,将 Framely 原生界面与 CEF 线程的 CPU 调度优先级提高到有界的 nice −5,关闭启动台或禁用设置后恢复原优先级。游戏与终端进程不参与提升。此设置可以改善 CPU 竞争,不预留 GPU 资源;安装后的会话服务需要包含对应的优先级限制。
关闭启动台时,之前选中的 Dock 窗口仍存在则返回该窗口。启动应用时由 Steam 接管焦点,不恢复旧窗口。Android 确认应用启动后即交接 APK 窗口,后续仍进行启动存活检查。运行中的容器即使已隐藏应用窗口也会复用,不再仅因之前游戏退出就重启。
+2
View File
@@ -35,3 +35,5 @@ VR 窗口、手柄振动和 SteamVR 虚拟键盘需要头显端验收;浏览
会话服务重启也会使旧登录失效,需要重新登录。保存完全相同的设置不会撤销当前会话。错误密码验证有速率限制,提示尝试过多时稍后再试。
无法访问时检查设备 IP 是否变化、两台设备是否处于可互通的网络、面板是否开启以及端口是否正确。设置/密码保存在 `/home/.framely/state`,卸载本体保留这些状态,重装后可能仍需原密码。
顶部切换器提供插件、APK、终端、文件与设置;设备地址默认打开插件。[终端与文件](terminal-and-files.md)提供用户 Shell 会话、上传下载、编辑、压缩及预览,复用相同登录和端口。
@@ -0,0 +1,71 @@
# 终端与文件
[English](../../user-guide/terminal-and-files.md)
[文档索引](../README.md) · [网络面板](network-panel.md)
## 管理面板导航
顶部切换器为 **插件 / APK / 终端 / 文件 / 设置**。直接访问设备 IP 默认进入插件;各区域在当前浏览器中记住上次子页面。原有 `#settings`、`#launcher-settings`、`#about`、`#updates` 链接继续有效。
插件区域包含已安装插件、插件库、来源和通知设置,通知仍包含 Framely 本体;插件自身设置位于对应插件的管理弹窗。APK 保留应用、容器及数据清理。设置集中放置通用、启动台、更新和关于。
## 交互反馈
在 **设置 → 通用 → 交互反馈** 中,振动反馈默认开启,提示音反馈默认关闭,修改后会保存。振动开关统一控制 Framely 和插件页面的激光悬停、启动台眼动聚焦振动,不影响 APK 游戏振动。提示音开关使用 Steam 本机键盘音效,以较低音量反馈聚焦和点击,需要本机 Steam 音效文件与音频运行库,不打包或下载这些音效。
## 终端
新建终端会以安装时配置的 Steam 会话用户打开登录 Shell,初始目录为该用户主目录,通常是 `steamos`。真实 PTY 支持 Ctrl-C、Tab 补全、方向键、中文、尺寸调整,以及 Vim、top 等全屏程序。需要管理员权限时在终端使用 `sudo`;面板访问密码与 sudo 密码不同。
最多创建 12 个会话,支持改名、重连及明确关闭。切换页面、关闭浏览器或断网不结束 Shell;用户会话服务或 Framely 重启后结束,不恢复进程。关闭须确认,并回收 Shell、属于该 Unix 会话的子进程及 PTY。
同一会话只允许一个连接输入,其他连接只读;“接管控制”转移输入权限。断网时禁止输入,重连不重放按键,仅恢复保留输出。每个会话缓存上限 2 MiB,截断旧输出时显示提示;重放截断后的原始终端数据可能缺少此前屏幕上下文。
终端输入、sudo 密码及输出不写入 Framely 日志。输出作为终端字符渲染,不执行 HTML,忽略写剪贴板的转义请求。xterm.js 和尺寸适配依赖随离线包提供,不使用 CDN。
使用 **Ctrl+Shift+C** 复制终端选中文本,**Ctrl+Shift+V** 粘贴。**Ctrl+C** 用于中断运行中的程序,不作为复制快捷键;终端底部会显示提示。
## 浏览与整理文件
默认打开用户主目录,以该用户权限访问文件系统,不自动提权。权限编辑仅支持普通 Unix 权限位;管理员操作请使用终端里的 `sudo`。
通过地址栏、面包屑、上级按钮或可展开文件夹树导航。快速访问包含主目录、下载、挂载存储、文件系统根目录、回收站及自定义文件夹。星标按钮添加当前目录,旁边按钮可改名、排序、移除;暂不可用的目录保留记录,打开时显示访问错误。
文件列表支持隐藏文件、排序、多选、当前目录过滤及可取消的递归文件名搜索。递归搜索不跟随目录链接;列表每页 200 项,递归搜索最多返回 5,000 个匹配项、访问 500,000 项。不扫描媒体内容生成缩略图。
“操作”提供复制、剪切、粘贴、重命名、删除、属性、权限修改、压缩、解压及打开。右键文件会在指针处打开操作菜单。符号链接显示箭头,属性显示目标;复制保留链接,删除链接不会删除目标。特殊文件不能复制或压缩。
复制、移动、上传、解压可按批次选择跳过、保留两份或明确确认覆盖。同名文件夹覆盖会替换整个文件夹,不合并内容。长任务显示真实字节或已完成条目,可取消并逐项报告错误;后续失败或取消不撤销已完成的项目。在当前网页内切换区域会保留文件任务及编辑状态。
拖动侧栏与文件列表之间的分隔线可调整宽度,并在当前浏览器中记住;窄窗口会自动限制宽度。快速访问固定在顶部一定高度,目录树占据侧栏剩余高度;两个列表分别在内部滚动,标题保持可见,从右侧列表或地址栏进入文件夹时,目录树会展开并标记对应位置。
右键文件或文件夹会在指针处打开操作菜单;右键已选中的项目时保留多选。右键列表空白处可新建文件或文件夹、粘贴、上传和刷新。按 Escape 或点击其他位置关闭菜单。
## 回收站
删除默认选择“移至回收站(30 天)”,永久删除须主动选择并确认。回收站保存在原文件系统内:主目录回收站,或存储挂载点的私有 `.framely-trash-UID` 目录。存储无法支持回收站时报告错误,不自动改成永久删除。
支持恢复到空闲名称或保留两份、永久删除及清空已登记项目。恢复要求原父目录存在。用户会话服务运行时约每小时检查到期项目,只清理 Framely 登记的回收站文件;存储离线时保留记录,恢复访问后再处理。不影响其他应用的回收站。
## 传输与编辑
网页可上传多个文件或文件夹,使用 1 MiB 分块和字节进度,先写私有临时文件,完成后才获得最终文件名。取消会移除临时文件,约每小时清理闲置至少一小时的上传。服务被强行停止可能留下明确命名的 `.framely-upload-*` 临时文件,不会冒充完整结果。每个文件最大 64 GiB,同时最多保存 64 条上传记录。
单文件可直接下载,多选文件或文件夹以 ZIP 下载;下载链接一小时后失效。大文件流式传输,单段 Range 请求支持视频拖动和下载续传。
普通文件打开时尝试 UTF-8 文本编辑器,上限 5 MiB;非法编码、二进制或超大文件无法编辑,可下载后处理。保存校验内容版本,外部修改后须重新加载或确认覆盖。关闭未保存内容会要求确认。
## 压缩与媒体
支持创建 ZIP、TAR、TAR.GZ,输出文件名决定格式。解压时选择目标目录和冲突策略。拒绝绝对路径、向上路径穿越、软硬链接及特殊文件,不执行解压内容;最多 50,000 项、展开大小 64 GiB。取消会清理暂存文件,保留已经提交的项目。
选择图片或视频后才读取内容预览。PNG、JPEG、GIF、WebP、AVIF、BMP、MP4、WebM、MOV 使用浏览器原生解码,具体编码支持取决于浏览器;视频提供播放、暂停、拖动及全屏。不支持的格式提示下载,不转码。HTML、SVG 不作为同源页面打开。
## 访问与隐私
终端、文件与传输使用现有管理面板登录和端口;修改接口及终端 WebSocket 严格匹配 Origin,插件沙箱不可调用。接口运行于 Steam 用户会话服务,不借用 root 本体执行文件操作。预览与下载仅在用户主动选择后读取内容;测试媒体为生成的样本,不自动读取或上传 Arcturus 录制文件。
## 导出诊断日志
**设置 → 通用 → 导出日志** 和安装器的 **导出日志** 使用同一收集流程。日志包包含近期 APK 操作日志、Lepton 已保存的 Android 日志,以及运行中容器的有限快照:Android 启动、用户解锁、存储挂载、包管理器就绪状态和近期 main/system/crash 日志。以配置的 Steam 会话用户检查无 root 容器,不启动已停止的容器。应用状态只导出摘要,排除令牌和图标;不读取 APK、存档、媒体或原始内存转储。单文件及总大小受限,保留近期输出;缺失来源、截断和命令超时记录在 `report.json`。日志可能包含应用信息,分享前请检查。
+1 -1
View File
@@ -1985,7 +1985,7 @@ dependencies = [
[[package]]
name = "framely-installer"
version = "0.4.1-preview.8"
version = "0.4.1-preview.10"
dependencies = [
"anyhow",
"base64 0.22.1",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "framely-installer"
version = "0.4.1-preview.8"
version = "0.4.1-preview.10"
edition = "2024"
license = "AGPL-3.0-only"
+13 -1
View File
@@ -32,6 +32,8 @@ After an operation, maintenance shows a separate success/failure card and a reco
Scanning, downloads, and SSH work run on background threads, with progress and logs in the UI. The network panel button assumes port 15915; use the actual address if the device port has changed.
After a successful first installation, the installer automatically opens the network management panel in your browser. The highlighted **Management panel** button remains available after installation and updates.
Online first installation always downloads the complete `*-offline-linux-arm64.tar.gz` package with CEF. Online updates download the core package without CEF and reuse the device runtime. A missing or newly required CEF runtime is downloaded separately by the device. For local first installation, choose the complete offline package. See [package selection](../docs/user-guide/installation.md#release-packages-and-cef).
Release queries, checksum files and package downloads automatically use the computer's manual system proxy: Windows Internet Settings, macOS network settings, or Linux GNOME/KDE settings. `HTTPS_PROXY`, `HTTP_PROXY` and `ALL_PROXY` (or their lowercase forms) override desktop settings; `NO_PROXY` and desktop bypass rules are respected, including on redirects. HTTP CONNECT and SOCKS proxies are supported. PAC scripts and IPv6 proxy endpoints are currently unsupported; use a manual proxy with a hostname or IPv4 address. SSH/SFTP and downloads initiated by Frame use the device connection and network rather than the computer's HTTP proxy.
@@ -62,7 +64,7 @@ FRAMELY_INSTALLER_PREVIEW_DIR=installer/dist/previews installer/target/debug/fra
Preview requires an available GPU or software Vulkan renderer. Default release builds do not include preview support.
Installer versions are managed independently in this directory's `Cargo.toml` and `Cargo.lock`. Pushing an `installer-v<VERSION>` tag (currently `installer-v0.4.1-preview.8`) triggers `.github/workflows/installer-release.yml` to build and publish only the installer. The core uses `v<VERSION>` tags and a separate workflow. Manual Actions runs produce build artifacts only. Installer releases do not become the repository's Latest release, preserving Frame's default install/update URLs.
Installer versions are managed independently in this directory's `Cargo.toml` and `Cargo.lock`. Pushing an `installer-v<VERSION>` tag (currently `installer-v0.4.1-preview.10`) triggers `.github/workflows/installer-release.yml` to build and publish only the installer. The core uses `v<VERSION>` tags and a separate workflow. Manual Actions runs produce build artifacts only. Installer releases do not become the repository's Latest release, preserving Frame's default install/update URLs.
Actions builds Linux x64/ARM64, Windows x64, and macOS Intel/Apple Silicon. macOS produces an `.app` ZIP, Windows an EXE ZIP, and Linux a tar.gz. Apple notarization and Windows code signing are not configured; verify first-launch behavior on each system before publishing.
@@ -77,3 +79,13 @@ Discovery queries `frame.local` mDNS address records directly. It does not requi
```bash
cargo run --manifest-path installer/Cargo.toml --locked --no-default-features --example scan -- 192.168.5.0/24
```
## Export diagnostic logs
After connecting to Frame, click **Export logs** in the footer and choose a ZIP destination on your computer. You do not need to select a release or installation package. Collection runs directly over SSH with administrator access, independently of Framely’s web panel and daemon. It also works with stopped services or damaged state, and includes the installer’s current operation log. Export does not install, restart or change Framely.
The archive includes bounded recent service/plugin/CEF logs, GPU evidence, installation versions and a plugin status summary. Missing sources are listed in `report.json`. Plugin settings, inbox contents and password files are excluded; common credential patterns are masked. Review logs before sharing. Cancelling the save dialog leaves the installation untouched.
### Proxy preferences
The **Settings** tab controls downloads on the installer computer. System proxy discovery is enabled by default. An explicit HTTP/SOCKS proxy takes precedence; leave it empty to follow the system toggle. An optional HTTPS GitHub proxy prefix routes GitHub API and asset URLs as `prefix/original-URL`. Settings persist locally and apply to subsequent version checks and downloads; SSH and Frame settings are unchanged. Saving clears the release selection so the next version check uses the new settings. Package verification remains enabled.
+13 -1
View File
@@ -32,6 +32,8 @@ Rust + GPUI Kit 的桌面安装器,连接 Steam Frame,安装、更新、修
扫描、下载和 SSH 工作在后台线程运行,界面展示进度和日志。默认网络管理面板按钮使用端口 15915;设备修改端口后应使用实际地址。
首次安装成功后,安装器会自动在浏览器打开网络管理面板;高亮的“管理面板”按钮在安装和更新完成后仍可使用。
在线首次安装固定下载包含 CEF 的完整 `*-offline-linux-arm64.tar.gz` 包;在线更新下载不含 CEF 的本体包并复用设备运行库。所需 CEF 缺失或版本更换时,由设备单独下载。本地首次安装也需选择完整离线包,参见[发行包说明](../docs/zh-CN/user-guide/installation.md#发行包与-cef)。
版本查询、校验文件和压缩包下载自动读取电脑的手动系统代理:Windows Internet 设置、macOS 网络设置及 Linux GNOME/KDE 设置。`HTTPS_PROXY`、`HTTP_PROXY`、`ALL_PROXY`(也支持小写)优先于桌面设置;遵循 `NO_PROXY` 及桌面绕过规则,重定向后也会重新判断。支持 HTTP CONNECT 和 SOCKS 代理。暂不支持 PAC 脚本及 IPv6 代理地址,可使用主机名或 IPv4 地址的手动代理。SSH/SFTP 使用设备连接,Frame 主动下载使用设备网络,不使用电脑的 HTTP 代理。
@@ -62,7 +64,7 @@ FRAMELY_INSTALLER_PREVIEW_DIR=installer/dist/previews installer/target/debug/fra
预览依赖可用的 GPU 或软件 Vulkan 渲染器;默认发行构建不包含此预览功能。
安装器版本由本目录的 `Cargo.toml` 和 `Cargo.lock` 独立管理,不跟随 Framely 本体版本。推送 `installer-v<版本>` 标签(当前 `installer-v0.4.1-preview.8`)触发 `.github/workflows/installer-release.yml`,只构建并发布安装器;本体使用 `v<版本>` 标签和独立工作流。也可在 Actions 手动运行安装器工作流,仅生成构建产物。安装器 Release 不占用仓库的 Latest,以免影响 Frame 的默认安装和更新地址。
安装器版本由本目录的 `Cargo.toml` 和 `Cargo.lock` 独立管理,不跟随 Framely 本体版本。推送 `installer-v<版本>` 标签(当前 `installer-v0.4.1-preview.10`)触发 `.github/workflows/installer-release.yml`,只构建并发布安装器;本体使用 `v<版本>` 标签和独立工作流。也可在 Actions 手动运行安装器工作流,仅生成构建产物。安装器 Release 不占用仓库的 Latest,以免影响 Frame 的默认安装和更新地址。
Actions 构建 Linux x64/ARM64、Windows x64、macOS Intel/Apple Silicon。macOS 输出 `.app` ZIP,Windows 输出 EXE ZIP,Linux 输出 tar.gz。当前未配置 Apple 公证或 Windows 代码签名,发布前应分别验证系统的首次启动体验。
@@ -77,3 +79,13 @@ Actions 构建 Linux x64/ARM64、Windows x64、macOS Intel/Apple Silicon。macOS
```bash
cargo run --manifest-path installer/Cargo.toml --locked --no-default-features --example scan -- 192.168.5.0/24
```
## 导出诊断日志
连接 Frame 后,点击底部的 **导出日志**,选择电脑上的 ZIP 保存位置,无需选择发行版本或安装包。安装器通过 SSH 和管理员权限独立收集,不依赖网络面板或本体服务;服务停止、状态文件损坏时仍能导出,并包含安装器当前的操作日志。导出不会安装、重启或修改 Framely。
日志包包含有大小限制的近期服务、插件和 CEF 日志、GPU 信息、安装版本及插件状态摘要。缺失来源记录在 `report.json` 中。不包含插件设置、收件箱内容和密码文件,并过滤常见凭据格式;分享前仍应检查日志。取消保存弹窗不会改变安装状态。
### 代理设置
**设置**页控制安装器电脑的下载。默认启用系统代理;填写 HTTP/SOCKS 代理后优先使用指定地址,留空则遵循系统代理开关。可选的 HTTPS GitHub 代理以 `代理前缀/原始 URL` 转发 GitHub API 和资源请求。设置在本机保存,后续检查版本和下载时生效,不更改 SSH 或 Frame 的设置。保存会清除版本选择,下次检查版本使用新配置;包校验继续启用。
+148 -4
View File
@@ -42,11 +42,15 @@ enum Event {
Connected(Result<Connection, String>),
File(FileKind, Option<PathBuf>),
Log(String),
LogsExported(Result<Option<PathBuf>, String>),
Progress(Progress),
Done(Result<(), String>),
}
struct Installer {
page: usize,
system_proxy: bool,
http_proxy: Entity<InputState>,
github_proxy: Entity<InputState>,
chosen_action: String,
device_state: Option<Installation>,
preview: bool,
@@ -103,9 +107,18 @@ impl Installer {
.masked(masked)
})
};
let proxy_result = framely_installer::proxy::load();
let proxy_error = proxy_result
.as_ref()
.err()
.map(|_| "无法读取代理设置,请在设置页重新保存。".to_owned());
let proxies = proxy_result.unwrap_or_default();
let networks = discovery::networks();
let mut view = Self {
page: 0,
system_proxy: proxies.system,
http_proxy: input(&proxies.http, "http://127.0.0.1:7890", false),
github_proxy: input(&proxies.github, "https://your-github-proxy.example", false),
chosen_action: "install".into(),
device_state: None,
preview: cfg!(feature = "visual-test")
@@ -144,7 +157,7 @@ impl Installer {
progress: None,
logs: Vec::new(),
status: "开启 Frame 开发者模式并设置密码,将电脑和 Frame 连接到同一网络。".into(),
error: None,
error: proxy_error,
release_error: None,
connection_stage: None,
sender,
@@ -320,6 +333,20 @@ impl Installer {
self.status = progress.detail.clone();
self.progress = Some(progress);
}
Event::LogsExported(result) => {
self.busy = false;
match result {
Ok(Some(path)) => {
self.status = "日志已导出。".into();
self.notice("日志导出完成", format!("已保存到:{}", path.display()));
}
Ok(None) => self.status = "已取消导出日志。".into(),
Err(error) => {
self.status = "日志导出失败。".into();
self.notice("日志导出失败", error);
}
}
}
Event::Done(result) => {
self.busy = false;
self.error = None;
@@ -328,6 +355,17 @@ impl Installer {
} else {
"操作失败,请查看操作结果与日志。".into()
};
let first_install = result.is_ok()
&& self.chosen_action == "install"
&& self
.device_state
.as_ref()
.is_some_and(|state| !state.present);
if first_install && !self.preview {
if let Some(url) = self.manager_url() {
cx.open_url(&url);
}
}
self.queue_prompt(dialogs::Prompt::Outcome(
self.chosen_action.clone(),
result.clone(),
@@ -347,6 +385,60 @@ impl Installer {
}
self.present_prompt(window, cx);
}
fn manager_url(&self) -> Option<String> {
let completed = self
.operation_result
.as_ref()
.is_some_and(|(action, result)| result.is_ok() && action != "uninstall");
if self.connected_host.is_empty() || (self.connection.is_none() && !completed) {
return None;
}
let host = self
.connected_host
.rsplit_once(':')
.map(|(host, _)| host)
.unwrap_or(&self.connected_host)
.trim_matches(['[', ']']);
let host = if host.contains(':') {
format!("[{host}]")
} else {
host.to_owned()
};
Some(format!("http://{host}:15915/manager"))
}
fn export_logs(&mut self, cx: &mut Context<Self>) {
if self.busy {
return;
}
let Some(connection) = self.connection.clone() else {
return;
};
let password = Zeroizing::new(self.password.read(cx).value().to_string());
let sender = self.sender.clone();
self.busy = true;
self.status = "正在导出日志…".into();
let logs = self.logs.clone();
std::thread::spawn(move || {
let result = (|| -> anyhow::Result<Option<PathBuf>> {
let Some(path) = rfd::FileDialog::new()
.set_title("保存 Framely 日志包")
.set_file_name("framely-logs.zip")
.add_filter("ZIP 日志包", &["zip"])
.save_file()
else {
return Ok(None);
};
let guard = connection
.lock()
.map_err(|_| anyhow::anyhow!("设备连接不可用"))?;
remote::export_logs(&guard, &password, &path, &logs)?;
Ok(Some(path))
})()
.map_err(|e| format!("{e:#}"));
let _ = sender.send(Event::LogsExported(result));
});
cx.notify();
}
fn scan(&mut self, cx: &mut Context<Self>) {
self.cancelled.store(true, Ordering::Relaxed);
self.cancelled = Arc::new(AtomicBool::new(false));
@@ -507,6 +599,30 @@ impl Installer {
self.queue_prompt(dialogs::Prompt::Operation(self.chosen_action.clone()));
cx.notify();
}
fn save_proxy(&mut self, cx: &mut Context<Self>) {
let settings = framely_installer::proxy::DownloadSettings {
system: self.system_proxy,
http: self.http_proxy.read(cx).value().trim().to_owned(),
github: self
.github_proxy
.read(cx)
.value()
.trim()
.trim_end_matches('/')
.to_owned(),
};
match framely_installer::proxy::save(settings) {
Ok(()) => {
self.error = None;
self.release_error = None;
self.releases.clear();
self.selected = None;
self.status = "代理设置已保存,下次下载及检查版本时生效。".into();
}
Err(error) => self.error = Some(format!("保存代理设置失败:{error}")),
}
cx.notify();
}
fn navigate(&mut self, page: usize, cx: &mut Context<Self>) {
if self.busy {
return;
@@ -721,6 +837,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
(0, "devices"),
(1, "versions"),
(2, "maintenance"),
(3, "settings"),
(1, "local"),
(0, "empty"),
(0, "connecting"),
@@ -731,6 +848,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
(2, "uninstalled"),
(2, "same-version"),
(2, "update-complete"),
(2, "first-install-complete"),
(2, "operation-failed"),
] {
context.update_window(handle, |_, window, cx| {
@@ -847,10 +965,23 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
assert!(view.same_update() && view.selection_ready());
view.request_operation(cx);
assert!(view.confirmation.is_none());
} else if name == "update-complete" || name == "operation-failed" {
view.chosen_action = "update".into();
} else if matches!(
name,
"update-complete" | "first-install-complete" | "operation-failed"
) {
view.chosen_action = if name == "first-install-complete" {
"install"
} else {
"update"
}
.into();
view.connected_host = "192.168.1.42:22".into();
if name == "first-install-complete" {
view.device_state = Some(Installation::default());
}
view.sender
.send(Event::Done(if name == "update-complete" {
.send(Event::Done(if name != "operation-failed" {
Ok(())
} else {
Err("网络连接中断,请重新连接设备后重试。".into())
@@ -863,6 +994,19 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
&& view.confirmation.is_none()
&& !view.busy
);
assert_eq!(view.manager_url().is_some(), name != "operation-failed");
if name != "operation-failed" {
assert_eq!(
view.manager_url().as_deref(),
Some("http://192.168.1.42:15915/manager")
);
view.connected_host = "[fd00::42]:22".into();
assert_eq!(
view.manager_url().as_deref(),
Some("http://[fd00::42]:15915/manager")
);
view.connected_host = "192.168.1.42:22".into();
}
}
cx.notify();
});
+192
View File
@@ -3,6 +3,117 @@ use anyhow::{Result, bail, ensure};
use std::{collections::HashMap, net::IpAddr};
use url::Url;
/// Installer-only download preferences. Explicit HTTP proxy overrides automatic
/// discovery; GitHub routing rewrites only trusted GitHub source hosts.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
#[serde(default, rename_all = "camelCase", deny_unknown_fields)]
pub struct DownloadSettings {
pub system: bool,
pub http: String,
pub github: String,
}
impl Default for DownloadSettings {
fn default() -> Self {
Self {
system: true,
http: String::new(),
github: String::new(),
}
}
}
impl DownloadSettings {
pub fn validate(&self) -> Result<()> {
ensure!(
self.http.len() <= 2048 && self.github.len() <= 2048,
"代理地址过长"
);
if !self.http.is_empty() {
parse_proxy(&self.http)?;
}
if !self.github.is_empty() {
let url =
Url::parse(&self.github).map_err(|_| anyhow::anyhow!("GitHub 代理地址无效"))?;
ensure!(
url.scheme() == "https"
&& url.host_str().is_some()
&& url.username().is_empty()
&& url.password().is_none()
&& url.query().is_none()
&& url.fragment().is_none(),
"GitHub 代理必须是 HTTPS 地址,不能含账号、查询参数或片段"
);
}
Ok(())
}
pub fn route(&self, url: &Url) -> Url {
if !self.github.is_empty()
&& matches!(
url.host_str(),
Some(
"github.com"
| "api.github.com"
| "raw.githubusercontent.com"
| "objects.githubusercontent.com"
| "release-assets.githubusercontent.com"
)
)
&& !url
.as_str()
.starts_with(&format!("{}/", self.github.trim_end_matches('/')))
{
Url::parse(&format!("{}/{}", self.github.trim_end_matches('/'), url))
.expect("validated GitHub proxy")
} else {
url.clone()
}
}
pub fn proxy_for(&self, url: &Url) -> Result<Option<ureq::Proxy>> {
if !self.http.is_empty() {
return parse_proxy(&self.http).map(Some);
}
if self.system { for_url(url) } else { Ok(None) }
}
}
static DOWNLOAD_SETTINGS: std::sync::OnceLock<std::sync::RwLock<DownloadSettings>> =
std::sync::OnceLock::new();
fn active_settings() -> &'static std::sync::RwLock<DownloadSettings> {
DOWNLOAD_SETTINGS.get_or_init(|| std::sync::RwLock::new(DownloadSettings::default()))
}
pub fn current() -> DownloadSettings {
active_settings().read().unwrap().clone()
}
fn settings_path() -> Result<std::path::PathBuf> {
Ok(
directories::ProjectDirs::from("org", "Framely", "Installer")
.ok_or_else(|| anyhow::anyhow!("无法确定配置目录"))?
.config_dir()
.join("download-settings.json"),
)
}
pub fn load() -> Result<DownloadSettings> {
let path = settings_path()?;
let settings = if path.exists() {
serde_json::from_slice::<DownloadSettings>(&std::fs::read(path)?)?
} else {
DownloadSettings::default()
};
settings.validate()?;
*active_settings().write().unwrap() = settings.clone();
Ok(settings)
}
pub fn save(settings: DownloadSettings) -> Result<()> {
settings.validate()?;
let path = settings_path()?;
std::fs::create_dir_all(path.parent().unwrap())?;
let mut file = tempfile::NamedTempFile::new_in(path.parent().unwrap())?;
use std::io::Write;
file.write_all(&serde_json::to_vec_pretty(&settings)?)?;
file.as_file().sync_all()?;
file.persist(path)?;
*active_settings().write().unwrap() = settings;
Ok(())
}
#[derive(Default)]
struct Settings {
proxies: HashMap<String, String>,
@@ -558,3 +669,84 @@ mod tests {
);
}
}
#[cfg(test)]
mod download_settings_tests {
use super::*;
#[test]
fn default_preserves_system_discovery_and_old_preferences() {
assert!(DownloadSettings::default().system);
assert!(
serde_json::from_str::<DownloadSettings>("{}")
.unwrap()
.system
);
}
#[test]
fn disabled_system_and_explicit_override() {
let mut settings = DownloadSettings {
system: false,
..Default::default()
};
let target = Url::parse("https://github.com/a/b").unwrap();
assert!(settings.proxy_for(&target).unwrap().is_none());
settings.http = "http://127.0.0.1:7890".into();
settings.validate().unwrap();
assert!(settings.proxy_for(&target).unwrap().is_some());
}
#[test]
fn github_routes_only_exact_hosts_and_does_not_double_wrap_redirects() {
let settings = DownloadSettings {
github: "https://proxy.example/prefix/".into(),
..Default::default()
};
settings.validate().unwrap();
for host in [
"github.com",
"api.github.com",
"raw.githubusercontent.com",
"objects.githubusercontent.com",
"release-assets.githubusercontent.com",
] {
let original = Url::parse(&format!("https://{host}/a?x=1")).unwrap();
let routed = settings.route(&original);
assert_eq!(
routed.as_str(),
format!("https://proxy.example/prefix/{original}")
);
assert_eq!(settings.route(&routed), routed);
}
for host in ["github.com.evil.example", "example.org", "proxy.example"] {
let url = Url::parse(&format!("https://{host}/a")).unwrap();
assert_eq!(settings.route(&url), url);
}
}
#[test]
fn invalid_preferences_are_rejected_before_saving() {
for github in [
"http://proxy.example",
"https://proxy.example?q=1",
"https://u:p@proxy.example",
"https://proxy.example/#x",
] {
assert!(
DownloadSettings {
github: github.into(),
..Default::default()
}
.validate()
.is_err()
);
}
for http in ["file:///tmp/x", "http://[::1]:1234"] {
assert!(
DownloadSettings {
http: http.into(),
..Default::default()
}
.validate()
.is_err()
);
}
}
}
+7 -5
View File
@@ -30,27 +30,29 @@ pub fn validate_repo(repo: &str) -> Result<()> {
);
Ok(())
}
fn agent(url: &url::Url) -> Result<ureq::Agent> {
fn agent(url: &url::Url, settings: &crate::proxy::DownloadSettings) -> Result<ureq::Agent> {
let mut builder = ureq::AgentBuilder::new()
.try_proxy_from_env(false)
.timeout(Duration::from_secs(120))
.redirects(0);
if let Some(proxy) = crate::proxy::for_url(url)? {
if let Some(proxy) = settings.proxy_for(url)? {
builder = builder.proxy(proxy);
}
Ok(builder.build())
}
fn get(url: &str) -> Result<ureq::Response> {
let settings = crate::proxy::current();
let mut url = url::Url::parse(url)?;
for _ in 0..=5 {
ensure!(url.scheme() == "https", "下载地址必须使用 HTTPS");
// Re-evaluate bypass rules for every redirect target.
let response = agent(&url)?
.get(url.as_str())
let routed = settings.route(&url);
let response = agent(&routed, &settings)?
.get(routed.as_str())
.set("User-Agent", "Framely-Installer")
.call()?;
if (300..400).contains(&response.status()) {
url = url.join(response.header("Location").context("重定向缺少地址")?)?;
url = routed.join(response.header("Location").context("重定向缺少地址")?)?;
} else {
return Ok(response);
}
+65
View File
@@ -507,3 +507,68 @@ mod tests {
eprintln!("stages={stages:?}; error={error}");
}
}
/// Collect directly over SSH; neither the web panel nor the daemon is required.
pub fn export_logs(
connection: &Connection,
password: &str,
destination: &Path,
logs: &[String],
) -> Result<()> {
use base64::engine::general_purpose::STANDARD;
ensure!(
!password.is_empty() && !password.contains(['\n', '\r']),
"请输入有效的设备登录密码"
);
connection.session.set_timeout(60_000);
let script = include_str!("../../tools/export-diagnostics.py");
// Keep archive output private and binary-safe. The ordinary text logger
// masks password substrings, which could corrupt a base64 archive.
let mut channel = connection.session.channel_session()?;
let local_log = logs.join("\n").replace(password, "[密码已隐藏]");
let recent: String = local_log
.chars()
.rev()
.take(64 * 1024)
.collect::<Vec<_>>()
.into_iter()
.rev()
.collect();
channel.exec(&format!(
"sudo -S -p '' -- python3 -c {} --installer-log-base64 {}",
quote(script),
quote(&STANDARD.encode(recent))
))?;
channel.write_all(password.as_bytes())?;
channel.write_all(b"\n")?;
channel.flush()?;
channel.send_eof()?;
let mut output = String::new();
Read::by_ref(&mut channel)
.take(12 * 1024 * 1024)
.read_to_string(&mut output)?;
let mut error = String::new();
channel.stderr().take(4096).read_to_string(&mut error)?;
channel.wait_close()?;
ensure!(
channel.exit_status()? == 0,
"日志收集失败:{}",
error.replace(password, "[密码已隐藏]")
);
let archive: serde_json::Value =
serde_json::from_str(output.trim()).context("日志包响应无效")?;
let bytes = STANDARD.decode(archive["data"].as_str().context("日志包缺少数据")?)?;
ensure!(
bytes.len() <= 9 * 1024 * 1024 && bytes.starts_with(b"PK\x03\x04"),
"日志包格式无效"
);
let parent = destination
.parent()
.filter(|p| !p.as_os_str().is_empty())
.unwrap_or_else(|| Path::new("."));
let mut file = tempfile::NamedTempFile::new_in(parent).context("无法创建日志包")?;
file.write_all(&bytes).context("无法保存日志包")?;
file.as_file().sync_all()?;
file.persist(destination).context("无法保存日志包")?;
Ok(())
}
+31 -12
View File
@@ -1,6 +1,6 @@
use super::*;
use gpui_kit::assets::IconName;
use gpui_kit::component::Icon;
use gpui_kit::component::{Icon, switch::Switch};
use gpui_kit::prelude::FluentBuilder;
pub(super) const BG: u32 = 0x15171b;
@@ -479,6 +479,24 @@ impl Installer {
)
.into_any_element()
}
fn settings_page(&self, cx: &mut Context<Self>) -> AnyElement {
panel()
.child(heading("代理设置", "仅影响安装器检查版本与下载,不改变电脑或 Frame 的系统设置。"))
.child(div().flex().items_center().justify_between()
.child(div().flex().flex_col().gap_2().child("使用系统代理")
.child(muted("读取环境变量和系统网络设置;填写 HTTP 代理后优先使用指定地址。")))
.child(Switch::new("system-proxy").checked(self.system_proxy)
.accessibility_label("使用系统代理").disabled(self.busy)
.on_change(cx.listener(|view, checked, _, cx| { view.system_proxy = *checked; cx.notify(); }))))
.child(field("HTTP 代理", &self.http_proxy, self.busy))
.child(muted("留空时使用系统代理开关的选择。支持 HTTP 和 SOCKS 代理。"))
.child(field("GitHub 代理", &self.github_proxy, self.busy))
.child(muted("留空直接访问 GitHub。填写 HTTPS 前缀地址后,GitHub 请求按“代理地址/原始 URL”转发;仍保留包校验。"))
.when(self.error.is_some(), |this| this.child(div().text_color(rgb(0xf7a7a7)).child(self.error.clone().unwrap())))
.child(div().flex().justify_end().child(Button::new("save-proxy").primary().label("保存")
.disabled(self.busy).on_click(cx.listener(|view, _, _, cx| view.save_proxy(cx)))))
.into_any_element()
}
fn release_page(&self, cx: &mut Context<Self>) -> AnyElement {
let mut list = div()
.id("release-list")
@@ -1037,7 +1055,8 @@ impl Render for Installer {
let body = match self.page {
0 => self.device_page(cx),
1 => self.release_page(cx),
_ => self.maintenance_page(cx),
2 => self.maintenance_page(cx),
_ => self.settings_page(cx),
};
let navigation = div()
.flex()
@@ -1053,6 +1072,7 @@ impl Render for Installer {
("连接设备", IconName::Monitor),
("选择版本", IconName::Package),
("安装与维护", IconName::Wrench),
("设置", IconName::Settings),
]
.into_iter()
.enumerate()
@@ -1111,6 +1131,12 @@ impl Render for Installer {
},
)),
);
footer = footer.child(
Button::new("export-diagnostic-logs")
.label("导出日志")
.disabled(self.busy || self.connection.is_none())
.on_click(cx.listener(|view, _, _, cx| view.export_logs(cx))),
);
if self.page < 2 {
let label = if self.page == 0 && self.connection.is_none() {
"先连接设备"
@@ -1155,18 +1181,11 @@ impl Render for Installer {
view.navigate(next, cx);
})),
);
} else {
if self.connection.is_some() {
let url = format!(
"http://{}:15915",
self.connected_host
.rsplit_once(':')
.map(|(h, _)| h)
.unwrap_or(&self.connected_host)
);
} else if self.page == 2 {
if let Some(url) = self.manager_url() {
footer = footer.child(
Button::new("manager")
.ghost()
.primary()
.label("管理面板")
.on_click(move |_, _, cx| cx.open_url(&url)),
);
+22
View File
@@ -0,0 +1,22 @@
import java.lang.reflect.*;
import java.util.List;
public final class FramelyWindow {
public static void main(String[] args) throws Exception {
if(args.length!=1 || !args[0].matches("[A-Za-z][A-Za-z0-9_]*(\\.[A-Za-z0-9_]+)+")) throw new IllegalArgumentException("Expected package name");
Class<?> manager=Class.forName("android.app.ActivityTaskManager");
Object service=manager.getDeclaredMethod("getService").invoke(null);
Class<?> api=Class.forName("android.app.IActivityTaskManager");
Method tasks=api.getMethod("getTasks",int.class);
Method mode=api.getMethod("setTaskWindowingMode",int.class,int.class,boolean.class);
for(int attempt=0;attempt<20;attempt++) {
for(Object task:(List<?>)tasks.invoke(service,32)) {
Object top=task.getClass().getField("topActivity").get(task);
if(top==null || !args[0].equals(top.getClass().getMethod("getPackageName").invoke(top)))continue;
int id=task.getClass().getField("taskId").getInt(task);
if(Boolean.TRUE.equals(mode.invoke(service,id,1,true))) {System.out.println("FRAMELY_FULLSCREEN_OK");return;}
}
Thread.sleep(250);
}
throw new IllegalStateException("Target task could not enter fullscreen");
}
}
+30
View File
@@ -0,0 +1,30 @@
# Android task window helper
`FramelyWindow.java` uses the Android 11 task service to put only the requested
package's foreground task into fullscreen. A startup windowing-mode option alone
can leave a restored Lepton task in freeform mode. This helper changes task mode
without stopping the game or changing its installation, data, Android image or
host compositor. VR launches do not invoke it. It exits after success or a bounded
five-second wait; it does not prevent later manual window adjustments.
The small checked-in DEX is embedded in Framely. `window.sh` supplies ART's runtime
environment for `podman exec`; both files are mounted read-only into the container.
No APK installation or network access is required at runtime. An unsupported task
API fails explicitly instead of guessing Binder transaction numbers.
Rebuild with `bash tools/build-android-window.sh` (JDK and curl required). This
uses Google's D8 8.3.37, pinned by SHA-256. D8 is a build tool and is not shipped.
## 中文
`FramelyWindow.java` 通过 Android 11 的任务接口,只将指定包的前台任务切换为全屏。
Lepton 恢复已有任务时,仅指定启动窗口模式仍可能留下自由窗口。此助手不停止游戏,
不修改安装、数据、Android 镜像或宿主合成器。VR 启动不调用助手。成功后立即退出,
等待最多五秒,不持续限制用户之后手动调整窗口。
小型 DEX 随 Framely 内置;`window.sh` 为 `podman exec` 补充 ART 运行环境。二者以
只读方式挂载,运行时无需安装 APK 或联网。不支持的任务接口会明确失败,不猜测
Binder 调用编号。
执行 `bash tools/build-android-window.sh` 可重新生成,需要 JDK 和 curl。
构建使用 Google D8 8.3.37,并校验固定 SHA-256;安装包不包含 D8。
Binary file not shown.
+8
View File
@@ -0,0 +1,8 @@
#!/system/bin/sh
set -eu
# podman exec lacks init's ART environment. Import only the runtime paths.
for entry in $(cat /proc/$(pidof system_server)/environ | tr '\0' '\n' | grep -E '^(ANDROID_(ROOT|DATA|ART_ROOT|I18N_ROOT|TZDATA_ROOT)|BOOTCLASSPATH)='); do
export "$entry"
done
export CLASSPATH=/vendor/share/framely-window.dex
exec app_process /system/bin FramelyWindow "$@"
+82
View File
@@ -0,0 +1,82 @@
#pragma once
#include <algorithm>
#include <chrono>
#include <cmath>
#include <cstdint>
#include <vector>
inline std::chrono::steady_clock::time_point entry_event_time(std::chrono::steady_clock::time_point received,float age){
if(!std::isfinite(age)||age<0)return received;
return received-std::chrono::duration_cast<std::chrono::steady_clock::duration>(std::chrono::duration<float>(age));
}
// Overlay mouse events are authoritative: never synthesize another click from
// controller actions. Keep the initiating device/button paired until release.
struct EntryHold {
using Clock=std::chrono::steady_clock;
enum class Action { Idle, Launcher, QuickPanel };
static constexpr auto quick_panel_delay=std::chrono::milliseconds(600);
static constexpr auto feedback_delay=std::chrono::milliseconds(200);
bool pressed=false,fired=false;
unsigned device=~0u,button=0;
Clock::time_point started{},armed_since{},last_inside{};
void cancel(){pressed=false;fired=false;}
Action tick(Clock::time_point now,bool available,bool inside){
if(!pressed)return Action::Idle;
if(!available){cancel();return Action::Idle;}
if(inside)last_inside=now;
// Brief pointer jitter is tolerated, but leaving cannot activate a hold.
if(!inside){if(now-last_inside>std::chrono::milliseconds(150))cancel();return Action::Idle;}
if(!fired&&now-armed_since>=quick_panel_delay){fired=true;return Action::QuickPanel;}
return Action::Idle;
}
Action event(bool down,unsigned source,unsigned mouse_button,bool available,bool inside,Clock::time_point now,Clock::time_point received={}){
if(down){
if(available&&inside&&(!pressed||(source==device&&mouse_button==button))){pressed=true;fired=false;device=source;button=mouse_button;started=now;armed_since=received==Clock::time_point{}?now:received;last_inside=armed_since;}
return Action::Idle;
}
// Steam may omit the device on release; known other devices still cannot release this hold.
if(!pressed||(source!=device&&source!=~0u&&device!=~0u)||mouse_button!=button)return Action::Idle;
auto action=Action::Idle;
if(!fired&&available&&inside)action=now-started>=quick_panel_delay?Action::QuickPanel:Action::Launcher;
cancel();return action;
}
// A confirmed physical release without a matching overlay release must not
// become a long press. Prefer short-click behavior over inventing its duration.
Action released(bool available,bool inside){
const auto action=pressed&&!fired&&available&&inside?Action::Launcher:Action::Idle;
cancel();return action;
}
float progress(Clock::time_point now)const{
if(!pressed||now-armed_since<feedback_delay)return 0.f;
const float elapsed=std::chrono::duration<float>(now-armed_since-feedback_delay).count();
const float remaining=std::chrono::duration<float>(quick_panel_delay-feedback_delay).count();
// A tiny nonzero value reveals the track at 100ms without jumping to 1/6 full.
return std::clamp(elapsed/remaining,.001f,1.f);
}
};
inline void entry_progress_border(std::vector<uint8_t>& pixels,float progress){
if(progress<=0||pixels.size()!=128*128*4)return;
constexpr float pi=3.14159265358979323846f,half=61.5f,radius=7.1f;
constexpr float extent=half-radius,arc=pi*.5f*radius,perimeter=8*extent+4*arc;
for(int y=0;y<128;y++)for(int x=0;x<128;x++){
float dx=x-63.5f,dy=y-63.5f,qx=std::abs(dx)-extent,qy=std::abs(dy)-extent;
const float distance=std::hypot(std::max(qx,0.f),std::max(qy,0.f))+std::min(std::max(qx,qy),0.f)-radius;
const float coverage=std::clamp(2.f-std::abs(distance),0.f,1.f);
if(coverage<=0)continue;
// Arc length along the inset rounded rectangle, starting at top center.
float along;
if(dx>=extent&&dy<=-extent)along=extent+(std::atan2(dy+extent,dx-extent)+pi*.5f)*radius;
else if(dx>=extent&&dy>=extent)along=3*extent+arc+std::atan2(dy-extent,dx-extent)*radius;
else if(dx<=-extent&&dy>=extent)along=5*extent+2*arc+(std::atan2(dy-extent,dx+extent)-pi*.5f)*radius;
else if(dx<=-extent&&dy<=-extent)along=7*extent+3*arc+(std::atan2(dy+extent,dx+extent)+pi)*radius;
else if(dy<-extent)along=dx>=0?dx:perimeter+dx;
else if(dx>extent)along=2*extent+arc+dy;
else if(dy>extent)along=4*extent+2*arc-dx;
else along=6*extent+3*arc-dy;
const float alpha=coverage*(along<=progress*perimeter?1.f:.12f);
const int blue[3]={147,197,237};const int i=(y*128+x)*4;
for(int c=0;c<3;c++)pixels[i+c]=uint8_t(pixels[i+c]+(blue[c]-pixels[i+c])*alpha);
}
}
+109
View File
@@ -0,0 +1,109 @@
// Session-owned Steam Input/OpenVR -> Android bridge with reverse rumble.
#include "openvr.h"
#include <linux/uinput.h>
#include <fcntl.h>
#include <unistd.h>
#include <poll.h>
#include <signal.h>
#include <filesystem>
#include <cstdio>
#include <cstring>
#include <cerrno>
#include <cmath>
#include <algorithm>
#include <string>
#include <chrono>
#include <thread>
static volatile sig_atomic_t stopped=0;
static void stop(int){stopped=1;}
#include "gamepad_mapping.h"
#include "gamepad_steam.h"
#include "gamepad_feedback.h"
static const int axes[]={ABS_X,ABS_Y,ABS_RX,ABS_RY,ABS_Z,ABS_RZ,ABS_HAT0X,ABS_HAT0Y};
static bool event(int fd,int type,int code,int value){input_event e{};e.type=type;e.code=code;e.value=value;return write(fd,&e,sizeof e)==sizeof e;}
static bool send(int fd,const int* state){static GamepadTriggers triggers;bool ok=true;for(int k=0;k<10;k++)ok=event(fd,EV_KEY,keys[k],state[k])&&ok;for(int k=0;k<2;k++)ok=event(fd,EV_KEY,trigger_keys[k],triggers.update(k,state[14+k]))&&ok;for(int k=0;k<8;k++)ok=event(fd,EV_ABS,axes[k],state[10+k])&&ok;return event(fd,EV_SYN,SYN_REPORT,0)&&ok;}
int main(int argc,char**argv){
if((argc!=2&&argc!=4)||geteuid()==0){fprintf(stderr,"Run gamepad bridge as the Steam session user with an action manifest.\n");return 1;}
// A session request runs on a short-lived worker thread. PR_SET_PDEATHSIG
// follows that thread's lifetime, so it destroys the pad as soon as prepare
// returns. The session-owned stdin pipe and parent process own this helper.
const auto parent=getppid();
const bool steamMode=std::getenv("FRAMELY_GAMEPAD_SOURCE")&&std::string(std::getenv("FRAMELY_GAMEPAD_SOURCE"))=="steam";
SteamGamepad steam;
if(steamMode&&!steam.start(std::getenv("FRAMELY_STEAM_SDL_LIBRARY"),std::getenv("FRAMELY_STEAM_GAMEPAD_INFO"))){fprintf(stderr,"Steam Input SDL3 runtime unavailable; select Frame direct input in APK settings.\n");return 1;}
bool rumbleEnabled=!std::getenv("FRAMELY_GAMEPAD_RUMBLE")||std::string(std::getenv("FRAMELY_GAMEPAD_RUMBLE"))!="0";
auto milliseconds=[](){return uint64_t(std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now().time_since_epoch()).count());};
signal(SIGTERM,stop);signal(SIGINT,stop);signal(SIGPIPE,SIG_IGN);
vr::EVRInitError error=vr::VRInitError_None;if(!steamMode)vr::VR_Init(&error,vr::VRApplication_Overlay);if(error){fprintf(stderr,"SteamVR gamepad input unavailable: %d\n",error);return 1;}
// Different live containers must not share SteamVR's generated executable
// identity. Otherwise a second helper replaces the first app's registered PID.
bool registered=false;
// Steam Input already represents Steam's configured output. Registering an
// independent OpenVR action app here suppresses SDL's virtual-gamepad
// enumeration in this process on Frame.
auto shutdown=[&](){if(!steamMode){if(registered)vr::VRApplications()->RemoveApplicationManifest(argv[2]);vr::VR_Shutdown();}};
if(!steamMode&&argc==4){
if(vr::VRApplications()->AddApplicationManifest(argv[2],true)!=vr::VRApplicationError_None){fprintf(stderr,"Gamepad application registration failed.\n");shutdown();return 1;}
registered=true;
auto identity=vr::VRApplications()->IdentifyApplication(getpid(),argv[3]);if(identity!=vr::VRApplicationError_None){fprintf(stderr,"Gamepad application identity failed: %d (%s).\n",identity,vr::VRApplications()->GetApplicationsErrorNameFromEnum(identity));shutdown();return 1;}
}
auto*input=steamMode?nullptr:vr::VRInput();vr::VRActiveActionSet_t set{};
bool valid=steamMode||(input->SetActionManifestPath(argv[1])==vr::VRInputError_None&&input->GetActionSetHandle("/actions/framely_gamepad",&set.ulActionSet)==vr::VRInputError_None);
const char*names[]={"right_a","right_b","right_x","right_y","left_bumper","right_bumper","left_menu","right_menu","left_stickclick","right_stickclick","left_thumbstick","right_thumbstick","left_trigger","right_trigger","left_dpad_left","left_dpad_right","left_dpad_up","left_dpad_down"};
vr::VRActionHandle_t handles[18]{};
for(int k=0;!steamMode&&k<18;k++)valid= input->GetActionHandle((std::string("/actions/framely_gamepad/in/")+names[k]).c_str(),&handles[k])==vr::VRInputError_None&&valid;
if(!valid){fprintf(stderr,"Invalid gamepad action bindings.\n");shutdown();return 1;}
vr::VRActionHandle_t haptics[2]{};
for(int k=0;!steamMode&&k<2;k++)input->GetActionHandle(k?"/actions/framely_gamepad/out/right_haptic":"/actions/framely_gamepad/out/left_haptic",&haptics[k]);
int fd=open("/dev/uinput",O_RDWR|O_NONBLOCK|O_CLOEXEC);if(fd<0){perror("Gamepad /dev/uinput");shutdown();return 1;}
bool ok=ioctl(fd,UI_SET_EVBIT,EV_KEY)==0&&ioctl(fd,UI_SET_EVBIT,EV_ABS)==0&&ioctl(fd,UI_SET_EVBIT,EV_FF)==0&&ioctl(fd,UI_SET_FFBIT,FF_RUMBLE)==0;
for(auto key:keys)ok=ioctl(fd,UI_SET_KEYBIT,key)==0&&ok;
for(auto key:trigger_keys)ok=ioctl(fd,UI_SET_KEYBIT,key)==0&&ok;
for(int k=0;k<8;k++){ok=ioctl(fd,UI_SET_ABSBIT,axes[k])==0&&ok;uinput_abs_setup a{};a.code=axes[k];a.absinfo.minimum=k<4?-32768:(k<6?0:-1);a.absinfo.maximum=k<4?32767:(k<6?255:1);a.absinfo.flat=k<4?1024:0;ok=ioctl(fd,UI_ABS_SETUP,&a)==0&&ok;}
uinput_setup device{};device.id={BUS_VIRTUAL,framely_pad_vendor,framely_pad_product,0x0001};device.ff_effects_max=GamepadFeedback::capacity;strcpy(device.name,"Framely Android gamepad");
ok=ioctl(fd,UI_DEV_SETUP,&device)==0&&ioctl(fd,UI_DEV_CREATE)==0&&ok;
char sysname[128]{};ok=ioctl(fd,UI_GET_SYSNAME(sizeof sysname),sysname)>=0&&ok;
std::string node;
for(int tries=0;ok&&tries<100&&node.empty();tries++){std::error_code ec;for(auto&entry:std::filesystem::directory_iterator(std::string("/sys/class/input/")+sysname,ec)){auto name=entry.path().filename().string();if(name.rfind("event",0)==0)node="/dev/input/"+name;}if(node.empty())std::this_thread::sleep_for(std::chrono::milliseconds(20));}
if(!ok||node.empty()){fprintf(stderr,"Could not create the virtual gamepad.\n");ioctl(fd,UI_DEV_DESTROY);close(fd);shutdown();return 1;}
int witness=-1;for(int tries=0;tries<100&&witness<0;tries++){witness=open(node.c_str(),O_RDONLY|O_NONBLOCK|O_CLOEXEC);if(witness<0)std::this_thread::sleep_for(std::chrono::milliseconds(20));}
if(witness<0){perror("Gamepad event access");ioctl(fd,UI_DEV_DESTROY);close(fd);shutdown();return 1;}
printf("%s\n",node.c_str());fflush(stdout);
// Parent owns routing. Start neutral; EOF, disconnect or disabled actions release input.
bool enabled=false;std::string commands;int previous[18]{};GamepadFeedback feedback;std::array<uint16_t,2> lastRumble{};uint64_t rumbleAt=0;uint32_t source=0;bool frameConnected[2]{};
while(!stopped&&getppid()==parent){pollfd p{STDIN_FILENO,POLLIN,0};if(poll(&p,1,0)>0){char buffer[128];auto count=read(0,buffer,sizeof buffer);if(count<=0)break;commands.append(buffer,count);size_t at;while((at=commands.find('\n'))!=std::string::npos){auto command=commands.substr(0,at);commands.erase(0,at+1);if(command=="enable")enabled=true;else if(command=="disable")enabled=false;else if(command=="rumble-on")rumbleEnabled=true;else if(command=="rumble-off")rumbleEnabled=false;}if(commands.size()>128)break;}
const auto now=milliseconds();
// Android may upload effects even while unfocused. Always acknowledge the
// kernel requests; only playback is gated by foreground ownership.
for(int k=0;k<64;k++){input_event e{};if(read(fd,&e,sizeof e)!=sizeof e)break;
if(e.type==EV_UINPUT&&e.code==UI_FF_UPLOAD){uinput_ff_upload q{};q.request_id=e.value;if(ioctl(fd,UI_BEGIN_FF_UPLOAD,&q)==0){q.retval=feedback.upload(q.effect);ioctl(fd,UI_END_FF_UPLOAD,&q);}}
else if(e.type==EV_UINPUT&&e.code==UI_FF_ERASE){uinput_ff_erase q{};q.request_id=e.value;if(ioctl(fd,UI_BEGIN_FF_ERASE,&q)==0){q.retval=feedback.erase(q.effect_id);ioctl(fd,UI_END_FF_ERASE,&q);}}
else if(e.type==EV_FF)feedback.play(e.code,e.value,now);
}
int state[18]{};bool inputAvailable=steamMode;
// If Android releases its exclusive claim (e.g. InputReader restart),
// pause until it claims the node again. Do not feed other host consumers.
bool claimed=false;if(enabled){if(ioctl(witness,EVIOCGRAB,1)==0)ioctl(witness,EVIOCGRAB,0);else claimed=errno==EBUSY;}
if(steamMode){auto next=steam.read(now,enabled&&claimed);std::copy(next.begin(),next.end(),state);if(source!=steam.source()){feedback.stop();source=steam.source();lastRumble={};}}
if(!steamMode&&enabled&&claimed&&input->UpdateActionState(&set,sizeof set,1)==vr::VRInputError_None){
const auto leftIndex=vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_LeftHand);
const auto rightIndex=vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand);
const bool left=leftIndex!=vr::k_unTrackedDeviceIndexInvalid&&vr::VRSystem()->IsTrackedDeviceConnected(leftIndex);
const bool right=rightIndex!=vr::k_unTrackedDeviceIndexInvalid&&vr::VRSystem()->IsTrackedDeviceConnected(rightIndex);
if((frameConnected[0]&&!left)||(frameConnected[1]&&!right))feedback.stop();frameConnected[0]=left;frameConnected[1]=right;inputAvailable=left||right;
bool buttons[18]{};for(int k=0;k<18;k++){if(k>=10&&k<=13)continue;vr::InputDigitalActionData_t data{};if(input->GetDigitalActionData(handles[k],&data,sizeof data,vr::k_ulInvalidInputValueHandle)==vr::VRInputError_None)buttons[k]=(k==4||k==6||k==8||k>=14?left:right)&&data.bActive&&data.bState;}
for(int k=0;k<10;k++)state[k]=buttons[k];
for(int k=10;k<=13;k++){if(!(k==10||k==12?left:right))continue;vr::InputAnalogActionData_t data{};if(input->GetAnalogActionData(handles[k],&data,sizeof data,vr::k_ulInvalidInputValueHandle)!=vr::VRInputError_None||!data.bActive||!std::isfinite(data.x)||!std::isfinite(data.y))continue;if(k<=11){state[10+(k-10)*2]=std::lround(std::clamp(data.x,-1.f,1.f)*32767);state[11+(k-10)*2]=std::lround(std::clamp(-data.y,-1.f,1.f)*32767);}else state[14+k-12]=std::lround(std::clamp(data.x,0.f,1.f)*255);}
state[16]=int(buttons[15])-int(buttons[14]);state[17]=int(buttons[17])-int(buttons[16]);
}
const auto vibration=feedback.value(now,enabled&&claimed&&rumbleEnabled&&inputAvailable);
if(vibration!=lastRumble||((vibration[0]||vibration[1])&&now-rumbleAt>=100)){
if(steamMode)steam.rumble(vibration[0],vibration[1]);
lastRumble=vibration;rumbleAt=now;
}
if(!steamMode&&(vibration[0]||vibration[1]))for(int k=0;k<2;k++)if(haptics[k]!=vr::k_ulInvalidActionHandle&&vibration[k])input->TriggerHapticVibrationAction(haptics[k],0,.012f,100.f,float(vibration[k])/65535.f,vr::k_ulInvalidInputValueHandle);
if(memcmp(previous,state,sizeof state)){if(!send(fd,state))break;memcpy(previous,state,sizeof state);}
std::this_thread::sleep_for(std::chrono::milliseconds(8));
}
steam.stop();feedback.stop();int neutral[18]{};send(fd,neutral);close(witness);ioctl(fd,UI_DEV_DESTROY);close(fd);shutdown();return 0;
}
+25
View File
@@ -0,0 +1,25 @@
#pragma once
#include <linux/input.h>
#include <array>
#include <algorithm>
#include <cerrno>
#include <cstdint>
// Kernel-owned effect IDs. Keep upload/erase acknowledgements independent of
// focus so Android's InputReader cannot block while the game is in background.
class GamepadFeedback {
struct Slot { ff_effect effect{}; bool uploaded=false,playing=false; uint64_t start=0,end=0,delay=0,period=0; };
std::array<Slot,32> slots{};
public:
static constexpr int capacity=32;
int upload(const ff_effect& effect) {
if(effect.id<0||effect.id>=capacity||effect.type!=FF_RUMBLE)return -EINVAL;
auto& s=slots[effect.id];s.effect=effect;s.uploaded=true;return 0;
}
int erase(int id){if(id<0||id>=capacity)return -EINVAL;slots[id]={};return 0;}
void play(int id,int count,uint64_t now){if(id<0||id>=capacity)return;auto& s=slots[id];s.playing=count>0&&s.uploaded;if(!s.playing)return;s.start=now;s.delay=std::min<unsigned>(s.effect.replay.delay,5000);s.period=s.delay+std::min<unsigned>(s.effect.replay.length,5000);s.end=now+std::min<uint64_t>(10000,s.period*std::min(count,32));}
void stop(){for(auto& s:slots)s.playing=false;}
std::array<uint16_t,2> value(uint64_t now,bool allowed){
std::array<uint16_t,2> v{};if(!allowed){stop();return v;}
for(auto& s:slots){if(!s.playing)continue;if(now>=s.end){s.playing=false;continue;}if(now<s.start||!s.period||(now-s.start)%s.period<s.delay)continue;v[0]=std::max<uint16_t>(v[0],std::min<unsigned>(s.effect.u.rumble.strong_magnitude,32768));v[1]=std::max<uint16_t>(v[1],std::min<unsigned>(s.effect.u.rumble.weak_magnitude,32768));}return v;
}
};
+15
View File
@@ -0,0 +1,15 @@
// Bionic preload: exclusively claim only Framely's mounted virtual event node.
// Raw AArch64 syscalls avoid a glibc dependency inside Android.
#define _GNU_SOURCE
#include <stdarg.h>
#include <fcntl.h>
#include <linux/input.h>
extern int *__errno(void);
static long call(long nr,long a,long b,long c,long d){register long x0 __asm__("x0")=a;register long x1 __asm__("x1")=b;register long x2 __asm__("x2")=c;register long x3 __asm__("x3")=d;register long x8 __asm__("x8")=nr;__asm__ volatile("svc 0":"+r"(x0):"r"(x1),"r"(x2),"r"(x3),"r"(x8):"memory");return x0;}
static int same(const char*a,const char*b){while(*a&&*a==*b){a++;b++;}return *a==*b;}
static int opened(int dir,const char*p,int flags,int mode){long fd=call(56,dir,(long)p,flags,mode);if(fd<0){*__errno()=-fd;return -1;}if(same(p,"/dev/input/event250")){long r=call(29,fd,EVIOCGRAB,1,0);if(r==0){long ready=call(56,-100,(long)"/framely-gamepad-ready/ready",O_WRONLY|O_CREAT|O_TRUNC|O_CLOEXEC,0644);if(ready>=0){call(64,ready,(long)"ready\n",6,0);call(57,ready,0,0,0);}}}return fd;}
int open(const char*p,int flags,...){int mode=0;if((flags&O_CREAT)||(flags&O_TMPFILE)==O_TMPFILE){va_list ap;va_start(ap,flags);mode=va_arg(ap,int);va_end(ap);}return opened(-100,p,flags,mode);}
int open64(const char*p,int flags,...){int mode=0;if((flags&O_CREAT)||(flags&O_TMPFILE)==O_TMPFILE){va_list ap;va_start(ap,flags);mode=va_arg(ap,int);va_end(ap);}return opened(-100,p,flags,mode);}
int openat(int dir,const char*p,int flags,...){int mode=0;if((flags&O_CREAT)||(flags&O_TMPFILE)==O_TMPFILE){va_list ap;va_start(ap,flags);mode=va_arg(ap,int);va_end(ap);}return opened(dir,p,flags,mode);}
int __open_2(const char*p,int flags){return opened(-100,p,flags,0);}
int __openat_2(int dir,const char*p,int flags){return opened(dir,p,flags,0);}
+14
View File
@@ -0,0 +1,14 @@
#pragma once
#include <linux/input-event-codes.h>
// Action order: A, B, X, Y, LB, RB, View, Menu, LS, RS.
// Xbox/Android maps X to Linux 307 and Y to 308. The positional
// aliases WEST/NORTH do not match these letter names.
inline constexpr int keys[]={BTN_A,BTN_B,BTN_X,BTN_Y,BTN_TL,BTN_TR,BTN_SELECT,BTN_START,BTN_THUMBL,BTN_THUMBR};
inline constexpr int trigger_keys[]={BTN_TL2,BTN_TR2};
// Preserve analog travel while exposing Android's digital L2/R2 events.
// Press at 30/255 and release at 20/255 to avoid noisy edges.
struct GamepadTriggers {
bool down[2]{};
bool update(int side,int value){down[side]=down[side]?value>20:value>=30;return down[side];}
};
+81
View File
@@ -0,0 +1,81 @@
#pragma once
#include <dlfcn.h>
#include <cstdint>
#include <linux/input.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/ioctl.h>
#include <array>
#include <vector>
#include <fstream>
#include <string>
#include <algorithm>
#include <cstdlib>
#include <cstring>
#include <cstdio>
#include <cmath>
#include <limits>
#include <sstream>
inline constexpr unsigned framely_pad_vendor=0x0001,framely_pad_product=0xf001;
struct SteamPadInfo {int slot=-1;unsigned vendor=0,product=0;bool identified=false;};
inline std::vector<SteamPadInfo> read_steam_pad_info(std::istream& stream){
std::vector<SteamPadInfo> rows;std::string line;size_t bytes=0;
while(std::getline(stream,line)){bytes+=line.size()+1;if(bytes>65536)return {};int slot=-1;if(std::sscanf(line.c_str(),"[slot %d]",&slot)==1){if(slot<0||slot>63)return {};rows.push_back({slot});continue;}if(rows.empty())continue;auto& p=rows.back();unsigned value=0;if(std::sscanf(line.c_str(),"VID=%x",&value)==1)p.vendor=value;else if(std::sscanf(line.c_str(),"PID=%x",&value)==1){p.product=value;p.identified=true;}}
return rows;
}
inline bool allowed_steam_slot(const std::vector<SteamPadInfo>& rows,int slot){return std::any_of(rows.begin(),rows.end(),[&](auto p){return p.slot==slot&&p.identified&&p.vendor!=0&&!(p.vendor==framely_pad_vendor&&p.product==framely_pad_product);});}
inline std::array<int,18> steam_pad_state(const std::array<bool,15>& buttons,const std::array<int,6>& axes){
std::array<int,18> state{};const int indices[]={0,1,2,3,9,10,4,6,7,8};for(int k=0;k<10;k++)state[k]=buttons[indices[k]];
for(int k=0;k<4;k++)state[10+k]=std::clamp(axes[k],-32768,32767);
for(int k=0;k<2;k++)state[14+k]=std::clamp(axes[4+k],0,32767)*255/32767;
state[16]=int(buttons[14])-int(buttons[13]);state[17]=int(buttons[12])-int(buttons[11]);return state;
}
class SteamGamepad {
void* library=nullptr;
using Pad=void*;
bool (*init)(uint32_t)=nullptr;void (*quit)()=nullptr;void (*update)()=nullptr;void (*pump)()=nullptr;void (*flush)(uint32_t,uint32_t)=nullptr;
uint32_t* (*get)(int*)=nullptr;void (*freeMem)(void*)=nullptr;Pad (*openPad)(uint32_t)=nullptr;void (*closePad)(Pad)=nullptr;
const char* (*path)(uint32_t)=nullptr;bool (*button)(Pad,int)=nullptr;int16_t (*axis)(Pad,int)=nullptr;
bool (*rumblePad)(Pad,uint16_t,uint16_t,uint32_t)=nullptr;
struct Entry {uint32_t id;Pad pad;std::array<int,18> previous{};};std::vector<Entry> pads;
std::string infoPath;uint32_t selected=0,vibrating=0;uint64_t scanned=0;bool scanning=false,initialized=false;
template<class T>bool symbol(T& target,const char* name){target=reinterpret_cast<T>(dlsym(library,name));return target!=nullptr;}
bool valid(uint32_t id,const std::vector<SteamPadInfo>& info){
const char* p=path(id);if(!p||std::string(p).rfind("/dev/input/event",0)!=0)return false;
const std::string suffix=std::string(p).substr(16);if(suffix.empty()||!std::all_of(suffix.begin(),suffix.end(),[](char c){return c>='0'&&c<='9';}))return false;
int fd=::open(p,O_RDONLY|O_NONBLOCK|O_CLOEXEC);if(fd<0)return false;input_id device{};char name[128]{};const bool ok=ioctl(fd,EVIOCGID,&device)==0&&device.vendor==0x28de&&device.product==0x11ff&&ioctl(fd,EVIOCGNAME(sizeof name),name)>0;::close(fd);if(!ok)return false;
const char* at=std::strstr(name,"pad ");int slot=-1;return at&&std::sscanf(at+4,"%d",&slot)==1&&allowed_steam_slot(info,slot);
}
void scan(uint64_t now){
if(scanning&&now-scanned<500)return;scanning=true;scanned=now;std::ifstream f(infoPath);auto info=read_steam_pad_info(f);
int count=0;auto* ids=get(&count);std::vector<uint32_t> validIds;
if(ids&&count>=0&&count<=64)for(int k=0;k<count;k++)if(valid(ids[k],info))validIds.push_back(ids[k]);freeMem(ids);
for(auto it=pads.begin();it!=pads.end();){if(std::find(validIds.begin(),validIds.end(),it->id)==validIds.end()){if(vibrating==it->id){rumblePad(it->pad,0,0,0);vibrating=0;}if(selected==it->id)selected=0;closePad(it->pad);it=pads.erase(it);}else ++it;}
for(auto id:validIds)if(std::none_of(pads.begin(),pads.end(),[&](auto p){return p.id==id;})){auto p=openPad(id);if(p)pads.push_back({id,p});}
}
public:
uint32_t source()const{return selected;}
bool start(const char* lib,const char* info){
if(!lib||!info)return false;infoPath=info;library=dlopen(lib,RTLD_NOW|RTLD_LOCAL);if(!library)return false;
bool ok=symbol(init,"SDL_Init")&&symbol(quit,"SDL_Quit")&&symbol(update,"SDL_UpdateGamepads")&&symbol(pump,"SDL_PumpEvents")&&symbol(flush,"SDL_FlushEvents")&&symbol(get,"SDL_GetGamepads")&&symbol(freeMem,"SDL_free")&&symbol(openPad,"SDL_OpenGamepad")&&symbol(closePad,"SDL_CloseGamepad")&&symbol(path,"SDL_GetGamepadPathForID")&&symbol(button,"SDL_GetGamepadButton")&&symbol(axis,"SDL_GetGamepadAxis")&&symbol(rumblePad,"SDL_RumbleGamepad");if(!ok)return false;
setenv("SDL_GAMECONTROLLER_ALLOW_STEAM_VIRTUAL_GAMEPAD","1",1);setenv("SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS","1",1);setenv("SteamVirtualGamepadInfo",info,1);
// Only Steam's post-configuration evdev pads are accepted. HIDAPI must not
// additionally open the physical devices or bypass Steam's mappings.
setenv("SDL_JOYSTICK_HIDAPI","0",1);setenv("SDL_GAMECONTROLLER_IGNORE_DEVICES","0x0001/0xf001",1);
initialized=init(0x2000);return initialized;
}
std::array<int,18> read(uint64_t now,bool enabled){
std::array<int,18> result{};if(!initialized)return result;pump();flush(0,0xffff);update();scan(now);uint32_t next=selected;
for(auto& p:pads){std::array<bool,15> buttons{};std::array<int,6> axes{};for(int k=0;k<15;k++)buttons[k]=button(p.pad,k);for(int k=0;k<6;k++)axes[k]=axis(p.pad,k);auto state=steam_pad_state(buttons,axes);
bool activity=false;for(int k=0;k<10;k++)activity|=state[k]&&!p.previous[k];for(int k=10;k<16;k++)activity|=std::abs(state[k])>(k<14?8000:40)&&std::abs(state[k]-p.previous[k])>(k<14?1500:15);for(int k=16;k<18;k++)activity|=state[k]!=0&&state[k]!=p.previous[k];p.previous=state;
if(enabled&&activity)next=p.id;
}
if(!next&&!pads.empty())next=pads.front().id;
if(next!=selected){stop();selected=next;return result;}
if(enabled)for(auto& p:pads)if(p.id==selected)result=p.previous;return result;
}
bool rumble(uint16_t low,uint16_t high){if(!low&&!high){stop();return true;}for(auto& p:pads)if(p.id==selected){const bool ok=rumblePad(p.pad,low,high,250);if(ok)vibrating=p.id;return ok;}return false;}
// Cancel only feedback issued by this bridge, never unrelated Steam rumble.
void stop(){for(auto& p:pads)if(p.id==vibrating)rumblePad(p.pad,0,0,0);vibrating=0;}
~SteamGamepad(){if(initialized){stop();for(auto& p:pads)closePad(p.pad);quit();}if(library)dlclose(library);}
};
+34
View File
@@ -0,0 +1,34 @@
#pragma once
#include "launcher_gaze.h"
#include <algorithm>
struct GazeAngles {float yaw=0,pitch=0;};
inline bool gaze_head_angles(const vr::HmdMatrix34_t& head,const vr::HmdVector3_t& world,GazeAngles& out){
float local[3]{};for(int i=0;i<3;i++)for(int r=0;r<3;r++){if(!std::isfinite(head.m[r][i])||!std::isfinite(world.v[r]))return false;local[i]+=head.m[r][i]*world.v[r];}
if(local[0]*local[0]+local[1]*local[1]+local[2]*local[2]<1e-8)return false;
out={std::atan2(local[0],-local[2]),std::atan2(local[1],std::hypot(local[0],local[2]))};return true;
}
inline vr::VROverlayIntersectionParams_t gaze_world_ray(const vr::HmdMatrix34_t& head,const vr::HmdVector3_t& origin,GazeAngles a){
vr::VROverlayIntersectionParams_t ray{};ray.eOrigin=vr::TrackingUniverseStanding;ray.vSource=origin;
float local[]{std::sin(a.yaw)*std::cos(a.pitch),std::sin(a.pitch),-std::cos(a.yaw)*std::cos(a.pitch)};
for(int r=0;r<3;r++)for(int i=0;i<3;i++)ray.vDirection.v[r]+=head.m[r][i]*local[i];return ray;
}
inline bool gaze_angles_to_point(const vr::HmdMatrix34_t& head,const vr::HmdVector3_t& origin,const vr::HmdVector3_t& target,GazeAngles& angles){
vr::HmdVector3_t direction{};for(int r=0;r<3;r++)direction.v[r]=target.v[r]-origin.v[r];return gaze_head_angles(head,direction,angles);
}
inline GazeAngles gaze_correct(GazeAngles raw,const double (&m)[6]){return {float(m[0]*raw.yaw+m[1]*raw.pitch+m[2]),float(m[3]*raw.yaw+m[4]*raw.pitch+m[5])};}
// Invert the runtime's actual curved-dashboard intersection. Its coordinate
// transform API alone may describe a flat surface. Sampling this inverse is
// needed only when the target or window changes; cache the returned world point.
template<class Sample> bool gaze_target_inverse(GazeAngles seed,float u,float v,Sample sample,GazeAngles& out){
auto current=seed;float x=0,y=0;if(!sample(current,x,y))return false;
for(int n=0;n<18;n++){
float ex=x-u,ey=y-v;if(std::hypot(ex,ey)<.0003f){out=current;return true;}
constexpr float delta=.0005f;float xx,xy,yx,yy;
if(!sample({current.yaw+delta,current.pitch},xx,xy)||!sample({current.yaw,current.pitch+delta},yx,yy))return false;
float a=(xx-x)/delta,b=(yx-x)/delta,c=(xy-y)/delta,d=(yy-y)/delta,det=a*d-b*c;if(!std::isfinite(det)||std::abs(det)<1e-6)return false;
float dx=std::clamp((d*ex-b*ey)/det,-.15f,.15f),dy=std::clamp((-c*ex+a*ey)/det,-.15f,.15f);bool improved=false;
for(float factor=1;factor>=.03125f;factor*=.5f){GazeAngles next{current.yaw-factor*dx,current.pitch-factor*dy};float nx,ny;if(sample(next,nx,ny)&&std::hypot(nx-u,ny-v)<std::hypot(ex,ey)){current=next;x=nx;y=ny;improved=true;break;}}
if(!improved)return false;
}
return false;
}
+433 -39
View File
@@ -1,3 +1,4 @@
#include "include/capi/cef_dialog_handler_capi.h"
#include "include/capi/cef_app_capi.h"
#include "include/capi/cef_image_capi.h"
#include "include/capi/cef_parser_capi.h"
@@ -8,14 +9,28 @@
#include "dock_uv_geometry.h"
#include "menu_geometry.h"
#include "menu_input.h"
#include "entry_hold.h"
#include "launcher_input.h"
#include "launcher_fade.h"
#include "launcher_priority.h"
#include "launcher_pointer.h"
#include "launcher_gaze.h"
#include "gaze_geometry.h"
#include "page_scroll.h"
#include "page_scroll_injection.h"
#include "include/capi/cef_load_handler_capi.h"
#include <filesystem>
#include "overlay_placement.h"
#include "render_resolution.h"
#include "render_timing.h"
#include "paint_buffer.h"
#include "notification_geometry.h"
#include "notification_badge.h"
#include "keyboard_state.h"
#include "keyboard_input.h"
#include "brand_mask.h"
#include "ui_visibility.h"
#include "ui_feedback.h"
#include "plugin_navigation.h"
#include <GL/gl.h>
#include <GL/glx.h>
@@ -31,6 +46,7 @@
#include <mutex>
#include <thread>
#include <deque>
#include <set>
#include <unistd.h>
using json=nlohmann::json;
@@ -43,6 +59,51 @@ static Display* xdisplay=nullptr;
static GLXContext glcontext=nullptr;
static GLXPbuffer glsurface=0;
static std::atomic<unsigned> notification_badge_count{0};
static bool launcher_open=false;
static bool ui_haptics=true,ui_sounds=false;
static SteamUiSounds ui_audio;
static LauncherFade launcher_fade;
static std::chrono::steady_clock::time_point launcher_close_at{};
static LauncherDismissGuard launcher_dismiss;
static LauncherDockGuard launcher_dock;
static EntryTrigger launcher_close_button;
static LauncherStick launcher_stick;
static PageScrollStick page_scroll_stick;
static vr::VROverlayHandle_t page_scroll_target=0;
static std::chrono::steady_clock::time_point launcher_outside_at{};
static bool launcher_selected=false;
static uint64_t launcher_session=0;
static std::atomic<bool> launcher_prioritize_ui{true};
static std::atomic<bool> launcher_priority_active{false};
static std::string launcher_previous_dashboard;
static std::set<std::string> dashboard_keys;
static bool launcher_restore_previous=true,launcher_previous_menu=false;
static std::chrono::steady_clock::time_point launcher_keyboard_back_until{};
static EntryHold entry_hold;
static uint64_t entry_source_buttons=0;
static std::map<unsigned,uint64_t> entry_previous_buttons;
static bool entry_actions_ready=false;
static vr::VRActionSetHandle_t entry_set=0,gaze_set=0;
static vr::VRActionHandle_t primary_action=0,upper_action=0,aim_action=0,close_action=0,navigate_action=0;
static vr::VRInputValueHandle_t hands[2]{};
static vr::VRActionHandle_t gaze_action=0,confirm_action=0,gaze_haptic_action=0;
static LauncherGazePress gaze_press;
static bool gaze_active=false,launcher_calibrating=false;
static json gaze_correction=nullptr,gaze_preview=nullptr;
static std::string gaze_target_id;
static float gaze_target_u=.5f,gaze_target_v=.5f;
static vr::HmdVector3_t gaze_target_world{};
static bool gaze_target_cached=false;
static bool gaze_matrix(const json& config,double (&m)[6]){
if(!config.is_object()||config.value("space",std::string{})!="headAngles"||!config.contains("matrix")||!config["matrix"].is_array()||config["matrix"].size()!=6)return false;
for(int i=0;i<6;i++){if(!config["matrix"][i].is_number())return false;m[i]=config["matrix"][i].get<double>();if(!std::isfinite(m[i])||std::abs(m[i])>4)return false;}
double det=m[0]*m[4]-m[1]*m[3];return det>=.25&&det<=4&&std::abs(m[2])<=.5&&std::abs(m[5])<=.5;
}
static int gaze_feedback_hand=1;
static std::chrono::steady_clock::time_point gaze_sent{},gaze_feedback_at{};
static EntryTrigger entry_buttons[2][2];
static EntryAnalogTrigger entry_analog[2];
static EntryPointer entry_pointer;
static bool menu_open=false,keyboard_open=false,keyboard_close_pending=false;
static float notification_curve_radius=1.3f;
static bool keyboard_toolbar=false,keyboard_chars=false,keyboard_done=false;
@@ -62,18 +123,24 @@ template<class T> struct Handler {
T* acquire(){api.base.add_ref(&api.base);return &api;}
};
struct View {
std::string key,plugin,title;int width=600,height=840,render_scale=1;bool dashboard=false,shown=false,dirty=false,closing=false,closed=false;
OverlayPlacement placement;NotificationClick notification_click;std::chrono::steady_clock::time_point haptic_at{};
std::string key,plugin,title;int width=600,height=840;float render_scale=1.f;bool dashboard=false,shown=false,dirty=false,closing=false,closed=false;
OverlayPlacement placement;NotificationClick notification_click;LauncherPointer launcher_pointer;std::chrono::steady_clock::time_point haptic_at{},activation_at{};
cef_mouse_event_t pointer{};bool pointer_valid=false,stick_scrolling=false;vr::TrackedDeviceIndex_t pointer_device=vr::k_unTrackedDeviceIndexInvalid;std::chrono::steady_clock::time_point pointer_at{};
cef_file_dialog_callback_t* file_dialog=nullptr;std::string file_dialog_id;bool file_multiple=false,file_directory=false;
bool active_seen=false,notification_content=false;int browser_id=0;cef_browser_t* browser=nullptr;cef_browser_host_t* host=nullptr;
vr::VROverlayHandle_t overlay=0,thumbnail=0;GLuint textures[2]{};int texture_slot=0;bool texture_ready[2]{};std::vector<uint8_t> pixels;
vr::VROverlayHandle_t overlay=0,thumbnail=0;GLuint textures[2]{};int texture_slot=0;bool texture_ready[2]{};PaintDamage texture_damage[2];std::vector<uint8_t> pixels;
};
static std::map<std::string,std::unique_ptr<View>> views;
static View* find_browser(cef_browser_t* b){int id=b->get_identifier(b);for(auto& [key,v]:views)if(v->browser_id==id)return v.get();return nullptr;}
static Handler<cef_client_t> client;
static Handler<cef_render_handler_t> render_handler;
static Handler<cef_dialog_handler_t> dialog_handler;
static unsigned long long file_dialog_sequence=0;
static void cancel_file_dialog(View& v){if(!v.file_dialog)return;auto* callback=v.file_dialog;v.file_dialog=nullptr;v.file_dialog_id.clear();callback->cancel(callback);callback->base.release(&callback->base);}
static Handler<cef_life_span_handler_t> life_handler;
static Handler<cef_display_handler_t> display_handler;
static Handler<cef_request_handler_t> request_handler;
static Handler<cef_load_handler_t> load_handler;
static void str(cef_string_t& o,const std::string& s){cef_string_utf8_to_utf16(s.data(),s.size(),&o);}
static std::string text(const cef_string_t* s){cef_string_utf8_t o{};cef_string_utf16_to_utf8(s->str,s->length,&o);std::string r(o.str,o.length);cef_string_utf8_clear(&o);return r;}
static void execute(cef_frame_t* f,const std::string& code){if(!f||!f->is_valid(f))return;cef_string_t script{},url{};str(script,code);f->execute_java_script(f,&script,&url,1);cef_string_utf16_clear(&script);}
@@ -102,11 +169,39 @@ static json poll_http(int port){int fd=socket(AF_INET,SOCK_STREAM,0);if(fd<0)thr
// runtime's overlay mouse space, before conversion to CEF's top-left origin.
// Keep a wider curved mesh around the narrow button; transparent margins never hit input.
static constexpr int dock_canvas_width=640,dock_canvas_height=128,dock_icon_left=256;
static std::vector<uint8_t> dock_icon(bool hover,bool active){
auto source=icon(hover,active);notification_badge(source,notification_badge_count.load());std::vector<uint8_t> canvas(dock_canvas_width*dock_canvas_height*4,0);
static std::vector<uint8_t> dock_icon(bool hover,bool active,float progress=0){
auto source=icon(hover,active);entry_progress_border(source,progress);notification_badge(source,notification_badge_count.load());std::vector<uint8_t> canvas(dock_canvas_width*dock_canvas_height*4,0);
for(int row=0;row<dock_canvas_height;row++)std::copy_n(source.data()+row*128*4,128*4,canvas.data()+(row*dock_canvas_width+dock_icon_left)*4);
return canvas;
}
// Keep texture storage alive while OpenVR samples the preceding frame. Raw
// overlay replacement during a hold can disturb the image and hover target.
struct DockIconTexture {
GLuint textures[2]{};int slot=0;std::vector<uint8_t> upload;
void init(){
glGenTextures(2,textures);
for(auto texture:textures){
glBindTexture(GL_TEXTURE_2D,texture);
glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_LINEAR);glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_WRAP_S,GL_CLAMP_TO_EDGE);glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_WRAP_T,GL_CLAMP_TO_EDGE);
glTexImage2D(GL_TEXTURE_2D,0,GL_RGBA8,dock_canvas_width,dock_canvas_height,0,GL_RGBA,GL_UNSIGNED_BYTE,nullptr);
}
}
bool submit(vr::VROverlayHandle_t overlay,const std::vector<uint8_t>& pixels){
glXMakeContextCurrent(xdisplay,glsurface,glsurface,glcontext);
const int next=1-slot;glBindTexture(GL_TEXTURE_2D,textures[next]);
glPixelStorei(GL_UNPACK_ALIGNMENT,4);glPixelStorei(GL_UNPACK_ROW_LENGTH,0);
glPixelStorei(GL_UNPACK_SKIP_PIXELS,0);glPixelStorei(GL_UNPACK_SKIP_ROWS,0);
// Raster icons use top-left rows; OpenVR OpenGL textures use bottom-left.
merge_paint(upload,pixels.data(),dock_canvas_width,dock_canvas_height,0,static_cast<const cef_rect_t*>(nullptr),true);
glTexSubImage2D(GL_TEXTURE_2D,0,0,0,dock_canvas_width,dock_canvas_height,GL_RGBA,GL_UNSIGNED_BYTE,upload.data());
glFinish();vr::Texture_t texture{reinterpret_cast<void*>(uintptr_t(textures[next])),vr::TextureType_OpenGL,vr::ColorSpace_Auto};
const auto error=overlays->SetOverlayTexture(overlay,&texture);glFlush();
if(error){std::cerr<<"Dock texture submission failed "<<error<<"\n";return false;}
slot=next;return true;
}
void destroy(){glDeleteTextures(2,textures);}
};
static vr::VROverlayHandle_t active_main_window(){
static auto refreshed=std::chrono::steady_clock::time_point{};static vr::VROverlayHandle_t selected=0;
auto now=std::chrono::steady_clock::now();if(now-refreshed<std::chrono::milliseconds(500)&&selected&&overlays->IsActiveDashboardOverlay(selected))return selected;
@@ -114,9 +209,10 @@ static vr::VROverlayHandle_t active_main_window(){
overlays->FindOverlay("valve.steam.gamepadui.main",&selected);
return selected;
}
static void hover_haptic(vr::VROverlayHandle_t overlay,std::chrono::steady_clock::time_point& last){
static void hover_haptic(vr::VROverlayHandle_t overlay,std::chrono::steady_clock::time_point& last,bool activation=false){
auto now=std::chrono::steady_clock::now();if(now-last<std::chrono::milliseconds(80)||!overlays->IsOverlayVisible(overlay)||!overlays->IsHoverTargetOverlay(overlay))return;
auto e=overlays->TriggerLaserMouseHapticVibration(overlay,.012f,120.f,.15f);if(!e)last=now;else std::cerr<<"Hover haptic failed "<<overlay<<" "<<e<<"\n";
last=now;if(ui_sounds)ui_audio.play(activation);
if(ui_haptics&&!activation){auto e=overlays->TriggerLaserMouseHapticVibration(overlay,.012f,120.f,.15f);if(e)std::cerr<<"Hover haptic failed "<<overlay<<" "<<e<<"\n";}
}
static void laser_cursor(vr::VROverlayHandle_t overlay,const vr::VREvent_t& event){
if(event.eventType==vr::VREvent_MouseMove){vr::HmdVector2_t position{{event.data.mouse.x,event.data.mouse.y}};overlays->SetOverlayCursorPositionOverride(overlay,&position);}
@@ -145,7 +241,8 @@ static void show(View& v,bool shown){
if(v.key=="menu"||v.key=="notifications")update_menu_modal();
}
}
static void close_keyboard(bool hide=true){if(keyboard_open&&hide)overlays->HideKeyboard();keyboard_open=false;keyboard_close_pending=false;keyboard_toolbar=false;keyboard_chars=false;keyboard_done=false;keyboard_target=0;keyboard_menu.end(std::chrono::steady_clock::now());if(keyboard_view=="menu")update_menu_modal();if(keyboard_frame){keyboard_frame->base.release(&keyboard_frame->base);keyboard_frame=nullptr;}keyboard_view.clear();}
static void keyboard_state(bool open){if(keyboard_frame)execute(keyboard_frame,std::string("window.dispatchEvent(new CustomEvent('framely.keyboard',{detail:")+(open?"true":"false")+"}))");}
static void close_keyboard(bool hide=true){keyboard_state(false);if(keyboard_open&&hide)overlays->HideKeyboard();keyboard_open=false;keyboard_close_pending=false;keyboard_toolbar=false;keyboard_chars=false;keyboard_done=false;keyboard_target=0;keyboard_menu.end(std::chrono::steady_clock::now());if(keyboard_view=="menu")update_menu_modal();if(keyboard_frame){keyboard_frame->base.release(&keyboard_frame->base);keyboard_frame=nullptr;}keyboard_view.clear();}
static bool keyboard_event(const vr::VREvent_t& e,vr::VROverlayHandle_t source_overlay=0){
// The runtime toolbar opens the keyboard without a host.keyboard request.
if(e.eventType==vr::VREvent_KeyboardOpened_Global){
@@ -156,7 +253,7 @@ static bool keyboard_event(const vr::VREvent_t& e,vr::VROverlayHandle_t source_o
close_keyboard(false);owner->host->set_focus(owner->host,1);
keyboard_frame=owner->browser->get_focused_frame(owner->browser);keyboard_view=owner->key;
keyboard_target=target;keyboard_token=e.data.keyboard.uUserValue;keyboard_open=true;keyboard_toolbar=true;
keyboard_menu.begin(owner->key=="menu");return true;
keyboard_menu.begin(owner->key=="menu");keyboard_state(true);return true;
}
if(e.eventType!=vr::VREvent_KeyboardCharInput&&e.eventType!=vr::VREvent_KeyboardDone&&e.eventType!=vr::VREvent_KeyboardClosed&&e.eventType!=vr::VREvent_KeyboardClosed_Global)return false;
if(!keyboard_open)return true;
@@ -168,7 +265,7 @@ static bool keyboard_event(const vr::VREvent_t& e,vr::VROverlayHandle_t source_o
}else {keyboard_done=keyboard_done||e.eventType==vr::VREvent_KeyboardDone;keyboard_close_pending=true;}
return true;
}
static void close_view(View& v){if(v.closing)return;if(keyboard_view==v.key)close_keyboard();v.closing=true;if(v.key=="menu")overlays->SetOverlayFlag(v.overlay,vr::VROverlayFlags_WantsModalBehavior,false);overlays->ClearOverlayCursorPositionOverride(v.overlay);overlays->HideOverlay(v.overlay);v.host->close_browser(v.host,1);}
static void close_view(View& v){if(v.closing)return;cancel_file_dialog(v);if(keyboard_view==v.key)close_keyboard();v.closing=true;if(v.key=="menu")overlays->SetOverlayFlag(v.overlay,vr::VROverlayFlags_WantsModalBehavior,false);overlays->ClearOverlayCursorPositionOverride(v.overlay);overlays->HideOverlay(v.overlay);v.host->close_browser(v.host,1);}
static void anchor_to_head(View& v,float width,float x=0,float y=0,float z=-1.35f){vr::TrackedDevicePose_t poses[vr::k_unMaxTrackedDeviceCount]{};vr_system->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding,0,poses,vr::k_unMaxTrackedDeviceCount);if(!poses[0].bPoseIsValid)return;auto m=poses[0].mDeviceToAbsoluteTracking;for(int r=0;r<3;r++)m.m[r][3]+=m.m[r][0]*x+m.m[r][1]*y+m.m[r][2]*z;overlays->SetOverlayWidthInMeters(v.overlay,width);overlays->SetOverlayTransformAbsolute(v.overlay,vr::TrackingUniverseStanding,&m);}
static void anchor_notification(View& v){
// Let the compositor follow the HMD's render pose; a captured standing-space
@@ -183,23 +280,26 @@ static void anchor_notification(View& v){
v.placement.curve(overlays,v.overlay,toast.width,toast.radius);
}
static View& create_view(const std::string& key,const std::string& title,const std::string& url,bool dock,int width,int height,const std::string& plugin="",float physical_width=0){
if(views.count(key)){auto& v=*views.at(key);if(dock)overlays->ShowDashboard(key.c_str());else if(key!="notifications")show(v,true);return v;}
if(views.size()>=34)throw std::runtime_error("Window limit exceeded");auto v=std::make_unique<View>();v->key=key;v->plugin=plugin;v->title=title;v->dashboard=dock;v->width=width;v->height=height;v->render_scale=key=="framely.manager"?4:(key=="menu"||key=="notifications")?2:1;
if(views.count(key)){auto& v=*views.at(key);if(dock&&key!="launcher")overlays->ShowDashboard(key.c_str());else if(key!="notifications"&&key!="launcher")show(v,true);return v;}
// Use 1.5x for launcher artwork and 2x for scrolling panels. CEF readback,
// texture upload and launcher mipmap generation scale with the pixel count.
if(views.size()>=34)throw std::runtime_error("Window limit exceeded");auto v=std::make_unique<View>();v->key=key;v->plugin=plugin;v->title=title;v->dashboard=dock;v->width=width;v->height=height;v->render_scale=key=="launcher"?1.5f:(key=="framely.manager"||key=="menu"||key=="notifications")?2:1;
auto error=dock?overlays->CreateDashboardOverlay(key.c_str(),title.c_str(),&v->overlay,&v->thumbnail):overlays->CreateOverlay(key.c_str(),title.c_str(),&v->overlay);if(error)throw std::runtime_error("Overlay creation failed: "+std::to_string(error));
overlays->SetOverlayInputMethod(v->overlay,key=="notifications"?vr::VROverlayInputMethod_None:vr::VROverlayInputMethod_Mouse);vr::HmdVector2_t scale{{float(width),float(height)}};overlays->SetOverlayMouseScale(v->overlay,&scale);overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_HideLaserIntersection,false);overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_SendVRSmoothScrollEvents,true);overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_VisibleInDashboard,true);overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible,true);overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_SortWithNonSceneOverlays,false);overlays->SetOverlaySortOrder(v->overlay,0);
// Keep the runtime's full dashboard controls, including its keyboard and close buttons.
if(dock){
auto result=overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_MinimalControlBar,false);
if(key=="launcher")overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_NoDashboardTab,true);
auto result=overlays->SetOverlayFlag(v->overlay,vr::VROverlayFlags_MinimalControlBar,key=="launcher");
if(result)std::cerr<<"Dashboard controls unavailable "<<key<<" "<<result<<"\n";
for(auto flag:{vr::VROverlayFlags_EnableControlBarKeyboard,vr::VROverlayFlags_EnableControlBarClose}){
result=overlays->SetOverlayFlag(v->overlay,flag,true);
if(result)std::cerr<<"Dashboard control unavailable "<<key<<" "<<result<<"\n";
}
}
if(dock){auto pixels=icon(false,true);overlays->SetOverlayRaw(v->thumbnail,pixels.data(),128,128,4);overlays->SetOverlayWidthInMeters(v->overlay,physical_width>0?physical_width:(key=="framely.manager"?3.2f:1.2f));}else if(key!="menu"&&key!="notifications"){anchor_to_head(*v,physical_width>0?physical_width:1.0f);}
cef_window_info_t info{};info.size=sizeof(info);info.windowless_rendering_enabled=1;cef_browser_settings_t bs{};bs.size=sizeof(bs);bs.windowless_frame_rate=30;bs.background_color=0;cef_string_t uri{};str(uri,url);auto* browser=cef_browser_host_create_browser_sync(&info,&client.api,&uri,&bs,nullptr,nullptr);cef_string_utf16_clear(&uri);
if(!browser){overlays->DestroyOverlay(v->overlay);if(v->thumbnail)overlays->DestroyOverlay(v->thumbnail);throw std::runtime_error("Browser creation failed");}v->browser=browser;v->browser_id=browser->get_identifier(browser);v->host=browser->get_host(browser);glGenTextures(2,v->textures);auto* ptr=v.get();views.emplace(key,std::move(v));ptr->host->notify_screen_info_changed(ptr->host);ptr->host->was_resized(ptr->host);ptr->host->was_hidden(ptr->host,key!="notifications");if(dock)overlays->ShowDashboard(key.c_str());else if(key!="menu"&&key!="notifications")show(*ptr,true);return *ptr;
if(dock){auto pixels=icon(false,true);overlays->SetOverlayRaw(v->thumbnail,pixels.data(),128,128,4);overlays->SetOverlayWidthInMeters(v->overlay,physical_width>0?physical_width:(key=="framely.manager"?3.2f:key=="launcher"?3.6f:1.2f));}else if(key!="menu"&&key!="notifications"&&key!="launcher"){anchor_to_head(*v,physical_width>0?physical_width:1.0f);}
cef_window_info_t info{};info.size=sizeof(info);info.windowless_rendering_enabled=1;cef_browser_settings_t bs{};bs.size=sizeof(bs);bs.windowless_frame_rate=browser_frame_rate();bs.background_color=0;std::cout<<"Browser frame rate "<<key<<" "<<bs.windowless_frame_rate<<"\n";cef_string_t uri{};str(uri,url);auto* browser=cef_browser_host_create_browser_sync(&info,&client.api,&uri,&bs,nullptr,nullptr);cef_string_utf16_clear(&uri);
if(!browser){overlays->DestroyOverlay(v->overlay);if(v->thumbnail)overlays->DestroyOverlay(v->thumbnail);throw std::runtime_error("Browser creation failed");}v->browser=browser;v->browser_id=browser->get_identifier(browser);v->host=browser->get_host(browser);glGenTextures(2,v->textures);auto* ptr=v.get();views.emplace(key,std::move(v));ptr->host->notify_screen_info_changed(ptr->host);ptr->host->was_resized(ptr->host);ptr->host->was_hidden(ptr->host,key!="notifications");if(dock&&key!="launcher")overlays->ShowDashboard(key.c_str());else if(key!="menu"&&key!="notifications"&&key!="launcher")show(*ptr,true);return *ptr;
}
static void plugin_thumbnail(View& view,const std::string& encoded){
if(!view.thumbnail||encoded.empty()||encoded.size()>1400000)return;
@@ -215,9 +315,241 @@ static void plugin_thumbnail(View& view,const std::string& encoded){
for(int y=0;y<h;y++)for(int x=0;x<w;x++){int sx=std::min(width-1,int(x/scale)),sy=std::min(height-1,int(y/scale));std::copy_n(source.data()+(sy*width+sx)*4,4,pixels.data()+((y+(128-h)/2)*128+x+(128-w)/2)*4);}
overlays->SetOverlayRaw(view.thumbnail,pixels.data(),128,128,4);
}
static void commands(){std::deque<json> commands;{std::lock_guard<std::mutex> lock(queue_mutex);commands.swap(queue);}for(const auto& c:commands){try{auto kind=c.value("kind","");if(kind=="haptic"){auto key=c.value("view","");if(views.count(key)&&views.at(key)->shown&&!views.at(key)->closing)hover_haptic(views.at(key)->overlay,views.at(key)->haptic_at);}else if(kind=="manager.open"){if(views.count("framely.manager")&&views.at("framely.manager")->closing){std::lock_guard<std::mutex> lock(queue_mutex);queue.push_back(c);continue;}auto page=c.value("page",std::string{});auto& manager=create_view("framely.manager","Framely 插件管理",origin+"/manager"+((page=="catalog"||page=="updates"||page=="notification-settings")?"#"+page:""),true,1440,810);if(page=="catalog"||page=="updates"||page=="notification-settings"){auto* frame=manager.browser->get_main_frame(manager.browser);execute(frame,"location.hash="+json(page).dump()+";window.dispatchEvent(new Event(\"hashchange\"))");frame->base.release(&frame->base);}menu_open=false;}else if(kind=="agreement.decline"){auto key=c.value("view","");if(key=="menu"){menu_open=false;if(views.count("menu")){show(*views.at("menu"),false);views.at("menu")->browser->reload(views.at("menu")->browser);}}else if(views.count(key))close_view(*views.at(key));}else if(kind=="manager.close"){if(views.count("framely.manager"))close_view(*views.at("framely.manager"));}else if(kind=="menu.close"){menu_open=false;}else if(kind=="window.open"){std::string plugin=c.at("plugin"),win=c.at("window");auto key="framely.window."+plugin+"."+win;if(views.count(key)&&views.at(key)->closing){std::lock_guard<std::mutex> lock(queue_mutex);queue.push_back(c);continue;}auto spec=c.at("spec");auto& opened=create_view("framely.window."+plugin+"."+win,spec.at("title"),origin+"/window/"+plugin+"/"+win,spec.value("dockIcon",false),spec.value("width",1600),spec.value("height",900),plugin,spec.value("widthMeters",3.f));plugin_thumbnail(opened,spec.value("iconData",std::string{}));menu_open=false;}else if(kind=="window.close"){auto key="framely.window."+c.at("plugin").get<std::string>()+"."+c.at("window").get<std::string>();if(views.count(key))close_view(*views.at(key));}else if(kind=="plugin.disabled"){for(auto&[key,v]:views)if(v->plugin==c.at("plugin"))close_view(*v);}else if(kind=="notification.changed"){auto& v=create_view("notifications","Framely notifications",origin+"/notifications",false,600,360);anchor_notification(v);v.host->was_hidden(v.host,0);v.host->invalidate(v.host,PET_VIEW);}else if(kind=="keyboard"){auto key=c.value("view","menu");if(!views.count(key))continue;auto& v=*views.at(key);if(v.closing)continue;close_keyboard();v.host->set_focus(v.host,1);keyboard_frame=v.browser->get_focused_frame(v.browser);keyboard_view=key;keyboard_target=v.overlay;++keyboard_token;auto existing=c.value("existing","");if(key=="menu")overlays->SetOverlayFlag(v.overlay,vr::VROverlayFlags_WantsModalBehavior,false);auto e=overlays->ShowKeyboardForOverlay(v.overlay,c.value("password",false)?vr::k_EGamepadTextInputModePassword:vr::k_EGamepadTextInputModeNormal,c.value("multiline",false)?vr::k_EGamepadTextInputLineModeMultipleLines:vr::k_EGamepadTextInputLineModeSingleLine,vr::KeyboardFlag_Modal|vr::KeyboardFlag_Minimal|vr::KeyboardFlag_ShowArrowKeys,"Framely",4096,existing.c_str(),keyboard_token);keyboard_open=e==vr::VROverlayError_None;keyboard_menu.begin(keyboard_open&&key=="menu");if(!keyboard_open)close_keyboard();}else if(kind=="notifications.empty"){if(views.count("notifications")){views.at("notifications")->notification_content=false;show(*views.at("notifications"),false);}}}catch(const std::exception& e){std::cerr<<"Native command error: "<<e.what()<<"\n";}}
static void navigate(View& view,const std::string& hash){auto* frame=view.browser->get_main_frame(view.browser);execute(frame,"location.hash="+json(hash).dump()+";window.dispatchEvent(new Event('hashchange'))");frame->base.release(&frame->base);}
static bool launcher_dock_interaction(){
// These are Steam's Dock bar and native window controls on Frame, not app
// content. The runtime keeps ownership of their positioning and interaction.
bool hovered=false;
for(const char* key:{"valve.steam.gamepadui.bar","valve.steam.gamepadui.floatingfooter","system.systemui"}){
vr::VROverlayHandle_t overlay=0;
if(!overlays->FindOverlay(key,&overlay)&&overlays->IsOverlayVisible(overlay)&&overlays->IsHoverTargetOverlay(overlay))hovered=true;
}
bool held=false;for(auto& hand:entry_buttons)for(auto& trigger:hand)held|=trigger.held;
auto now=std::chrono::steady_clock::now();launcher_dock.observe(hovered,held,now);
if(launcher_dock.holds(now)){launcher_outside_at={};return true;}
return false;
}
static void overlay_input(View& v,const vr::VREvent_t& e){if(v.closing||(v.key=="notifications"&&!v.shown))return;if(keyboard_event(e,v.overlay))return;laser_cursor(v.overlay,e);cef_mouse_event_t mouse{};mouse.x=int(e.data.mouse.x);mouse.y=v.height-int(e.data.mouse.y);switch(e.eventType){case vr::VREvent_Modal_Cancel:if(v.key=="menu"&&!keyboard_open&&!keyboard_menu.holds(std::chrono::steady_clock::now())&&menu_button.can_cancel(std::chrono::steady_clock::now())){menu_open=false;std::cout<<"Menu closed: outside click"<<std::endl;}break;case vr::VREvent_OverlayClosed:if(v.key!="menu"&&v.key!="notifications")close_view(v);break;case vr::VREvent_ButtonPress:if(e.data.controller.button==vr::k_EButton_ApplicationMenu){auto* frame=v.browser->get_main_frame(v.browser);execute(frame,"window.dispatchEvent(new Event('framely.back'))");frame->base.release(&frame->base);}break;case vr::VREvent_FocusLeave:if(v.key!="notifications"||!v.notification_click.active)v.host->send_mouse_move_event(v.host,&mouse,1);break;case vr::VREvent_MouseMove:if(v.key!="notifications"||!v.notification_click.hold(mouse.x,mouse.y,std::chrono::steady_clock::now()))v.host->send_mouse_move_event(v.host,&mouse,0);break;case vr::VREvent_MouseButtonDown:case vr::VREvent_MouseButtonUp:{v.host->set_focus(v.host,1);auto button=e.data.mouse.button==vr::VRMouseButton_Right?MBT_RIGHT:MBT_LEFT;if(v.key=="notifications"&&button==MBT_LEFT){auto now=std::chrono::steady_clock::now();if(e.eventType==vr::VREvent_MouseButtonDown)v.notification_click.begin(mouse.x,mouse.y,now);else v.notification_click.release(mouse.x,mouse.y,now);}mouse.modifiers=e.eventType==vr::VREvent_MouseButtonDown?EVENTFLAG_LEFT_MOUSE_BUTTON:0;v.host->send_mouse_click_event(v.host,&mouse,button,e.eventType==vr::VREvent_MouseButtonUp,1);break;}case vr::VREvent_ScrollSmooth:case vr::VREvent_ScrollDiscrete:mouse.x=v.width/2;mouse.y=v.height/2;v.host->send_mouse_wheel_event(v.host,&mouse,int(e.data.scroll.xdelta*120),int(e.data.scroll.ydelta*120));break;case vr::VREvent_OverlayGamepadFocusLost:if(!keyboard_open&&!v.dashboard&&v.key!="menu"&&v.key!="notifications")close_view(v);break;default:break;}}
static std::string selected_dashboard(){
std::set<std::string> keys=dashboard_keys;keys.insert("valve.steam.gamepadui.main");keys.insert("system.systemui");
for(auto& [key,v]:views)if(v->dashboard&&!v->closing)keys.insert(key);
for(auto& key:keys){if(key=="launcher")continue;vr::VROverlayHandle_t handle=0;if(!overlays->FindOverlay(key.c_str(),&handle)&&overlays->IsActiveDashboardOverlay(handle))return key;}
return {};
}
static void observe_dashboard(const vr::VREvent_t& event){
if(event.eventType!=vr::VREvent_OverlayCreated&&event.eventType!=vr::VREvent_OverlayShown&&event.eventType!=vr::VREvent_DashboardOverlayCreated)return;
char key[1024]{};vr::EVROverlayError error{};overlays->GetOverlayKey(event.data.overlay.overlayHandle,key,sizeof(key),&error);
if(!error&&key[0]&&dashboard_keys.size()<512)dashboard_keys.insert(key);
}
static void finish_launcher_close(){
launcher_fade.reset();
if(!views.count("launcher"))return;auto& v=*views.at("launcher");
overlays->SetOverlayAlpha(v.overlay,0.f);
// Do not steal focus if Steam or the user already selected another window.
if(!overlays->IsActiveDashboardOverlay(v.overlay)){overlays->HideOverlay(v.overlay);return;}
if(launcher_restore_previous&&!launcher_previous_dashboard.empty()){
vr::VROverlayHandle_t previous=0;if(!overlays->FindOverlay(launcher_previous_dashboard.c_str(),&previous)){
overlays->ShowDashboard(launcher_previous_dashboard.c_str());menu_open=launcher_previous_menu;return;
}
}
// Unknown/destroyed previous windows are left to Steam's window selection.
overlays->HideOverlay(v.overlay);
if(!launcher_restore_previous)overlays->ShowDashboard("valve.steam.gamepadui.main");
if(launcher_restore_previous)menu_open=launcher_previous_menu;
}
static void hide_launcher(bool restore=true,bool immediate=false){
if(keyboard_view=="launcher")close_keyboard();
if(launcher_calibrating&&views.count("launcher")){auto* frame=views.at("launcher")->browser->get_main_frame(views.at("launcher")->browser);execute(frame,"location.hash='';window.dispatchEvent(new Event('hashchange'))");frame->base.release(&frame->base);}
const bool was_open=launcher_open;if(was_open)launcher_restore_previous=restore;launcher_calibrating=false;launcher_open=false;launcher_selected=false;launcher_dock.clear();launcher_stick={};
if(immediate){launcher_close_at={};finish_launcher_close();return;}
if(was_open&&views.count("launcher")&&overlays->IsActiveDashboardOverlay(views.at("launcher")->overlay)){
auto* frame=views.at("launcher")->browser->get_main_frame(views.at("launcher")->browser);
execute(frame,"window.dispatchEvent(new Event('framely.launcher.closing'))");frame->base.release(&frame->base);
auto now=std::chrono::steady_clock::now();launcher_fade.close(now);launcher_close_at=now+std::chrono::milliseconds(launcher_fade.reduced?0:240);
}
}
static void launcher_back(){
auto now=std::chrono::steady_clock::now();if(now<launcher_keyboard_back_until)return;
if(keyboard_open){launcher_keyboard_back_until=now+std::chrono::milliseconds(180);close_keyboard();return;}
if(!launcher_open||!views.count("launcher"))return;
auto& view=*views.at("launcher");auto* frame=view.browser->get_main_frame(view.browser);
execute(frame,"window.dispatchEvent(new Event('framely.back'))");frame->base.release(&frame->base);
}
static bool launcher_accepts(const vr::VREvent_t& e){
bool held=false;for(auto& hand:entry_buttons)for(auto& button:hand)held|=button.held;
return launcher_dismiss.allows(std::chrono::steady_clock::now(),held,e.eventAgeSeconds);
}
static void toggle_entry(bool launcher){
if(launcher){
if(launcher_open){hide_launcher();return;}
if(!launcher_close_at.time_since_epoch().count()||!views.count("launcher")||!overlays->IsActiveDashboardOverlay(views.at("launcher")->overlay)){launcher_previous_dashboard=selected_dashboard();launcher_previous_menu=menu_open;}launcher_restore_previous=true;
menu_open=false;if(views.count("menu"))show(*views.at("menu"),false);
auto& view=create_view("launcher","Framely launcher",origin+"/launcher",true,1440,800);
vr::VREvent_t stale{};while(overlays->PollNextOverlayEvent(view.overlay,&stale,sizeof(stale))){}
++launcher_session;launcher_close_at={};launcher_dock.clear();launcher_dismiss.opened(std::chrono::steady_clock::now());launcher_open=true;launcher_selected=false;launcher_stick={};launcher_outside_at={};
// Wake CEF before activation. A small nonzero alpha keeps Steam activation
// working without exposing the previous session's full-opacity texture.
launcher_fade.open(std::chrono::steady_clock::now());
view.host->was_hidden(view.host,0);view.host->invalidate(view.host,PET_VIEW);
overlays->SetOverlayAlpha(view.overlay,.02f);overlays->ShowOverlay(view.overlay);
overlays->ShowDashboard("launcher");
auto* frame=view.browser->get_main_frame(view.browser);execute(frame,"window.framelyLauncherSession="+std::to_string(launcher_session)+";window.dispatchEvent(new Event('framely.launcher.open'))");frame->base.release(&frame->base);
}else{hide_launcher(false);menu_open=!menu_open;if(menu_open)menu_button.opened(std::chrono::steady_clock::now());}
}
static void setup_entry_actions(){
char exe[4096]{};auto n=readlink("/proc/self/exe",exe,sizeof(exe)-1);if(n<=0)return;
auto base=std::filesystem::path(exe).parent_path();auto manifest=base/"../../share/input/actions.json";
if(!std::filesystem::exists(manifest))manifest=base/"../../native/input/actions.json";
auto* input=vr::VRInput();if(!input||!std::filesystem::exists(manifest))return;
auto error=input->SetActionManifestPath(std::filesystem::absolute(manifest).lexically_normal().c_str());if(error!=vr::VRInputError_None){std::cerr<<"Action manifest failed: "<<error<<std::endl;return;}
entry_actions_ready=input->GetActionSetHandle("/actions/entry",&entry_set)==vr::VRInputError_None&&input->GetActionHandle("/actions/entry/in/primary",&primary_action)==vr::VRInputError_None&&input->GetActionHandle("/actions/entry/in/upper",&upper_action)==vr::VRInputError_None&&input->GetActionHandle("/actions/entry/in/aim",&aim_action)==vr::VRInputError_None;
input->GetActionHandle("/actions/entry/in/close",&close_action);input->GetActionHandle("/actions/entry/in/navigate",&navigate_action);
input->GetActionSetHandle("/actions/gaze",&gaze_set);input->GetActionHandle("/actions/gaze/in/eye",&gaze_action);input->GetActionHandle("/actions/entry/in/confirm",&confirm_action);input->GetActionHandle("/actions/entry/out/gazeHaptic",&gaze_haptic_action);
input->GetInputSourceHandle("/user/hand/left",&hands[0]);input->GetInputSourceHandle("/user/hand/right",&hands[1]);
std::cout<<"Framely independent trigger bindings "<<(entry_actions_ready?"ready":"unavailable")<<std::endl;
}
static void page_scroll(float x,float y,bool active,vr::TrackedDeviceIndex_t device,std::chrono::steady_clock::time_point now){
View* target=nullptr;
if(!keyboard_open&&!launcher_open)for(auto&[key,v]:views){
if(key=="launcher"||!v->pointer_valid||!capture_view_visible(v->closing,overlays->IsOverlayVisible(v->overlay),v->dashboard,overlays->IsDashboardVisible(),overlays->IsActiveDashboardOverlay(v->overlay))||!overlays->IsHoverTargetOverlay(v->overlay))continue;
if(!target||(v->pointer_device==device&&target->pointer_device!=device)||(v->pointer_device==target->pointer_device&&v->pointer_at>target->pointer_at))target=v.get();
}
if(!target){page_scroll_stick.clear();page_scroll_target=0;return;}
if(page_scroll_target!=target->overlay){page_scroll_stick.clear();page_scroll_target=target->overlay;}
target->stick_scrolling=active&&std::isfinite(x)&&std::isfinite(y)&&std::max(std::abs(x),std::abs(y))>.18f;
auto delta=page_scroll_stick.update(x,y,target->stick_scrolling,now);
if(delta.x||delta.y){auto mouse=target->pointer;mouse.modifiers=0;target->host->send_mouse_wheel_event(target->host,&mouse,delta.x,delta.y);}
}
static bool launcher_gaze_allowed(){
if(!launcher_open||keyboard_open||!views.count("launcher")||launcher_dock_interaction())return false;
auto& v=*views.at("launcher");return !v.closing&&overlays->IsActiveDashboardOverlay(v.overlay)&&overlays->IsOverlayVisible(v.overlay)&&(launcher_calibrating||(!overlays->IsHoverTargetOverlay(v.overlay)&&!v.launcher_pointer.active));
}
static void launcher_gaze_event(const json& sample){
if(!views.count("launcher"))return;auto& v=*views.at("launcher");if(v.closing||!v.browser)return;
auto* frame=v.browser->get_main_frame(v.browser);execute(frame,"window.dispatchEvent(new CustomEvent('framely.launcher.gaze',{detail:"+sample.dump()+"}))");frame->base.release(&frame->base);
}
static void launcher_gaze(vr::IVRInput* input,bool allowed,const bool (&connected)[2],const bool (&buttons)[2],std::chrono::steady_clock::time_point now){
allowed=allowed&&launcher_gaze_allowed();
vr::VREyeTrackingData_t eye{};vr::VROverlayIntersectionParams_t ray{};vr::VROverlayIntersectionResults_t hit{};
auto sampled_at=std::chrono::steady_clock::now();
bool tracked=allowed&&gaze_action&&input->GetEyeTrackingDataRelativeToNow(gaze_action,vr::TrackingUniverseStanding,0,&eye,sizeof(eye))==vr::VRInputError_None&&launcher_gaze_ray(eye,ray);
vr::TrackedDevicePose_t poses[vr::k_unMaxTrackedDeviceCount]{};
// Use the same nominal time for gaze and head pose, rather than pairing gaze
// with a later/predicted rendering pose while the user turns their head.
if(tracked)vr_system->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding,std::chrono::duration<float>(sampled_at-std::chrono::steady_clock::now()).count(),poses,vr::k_unMaxTrackedDeviceCount);
GazeAngles raw{},expected{};tracked=tracked&&poses[0].bPoseIsValid&&gaze_head_angles(poses[0].mDeviceToAbsoluteTracking,ray.vDirection,raw);
bool target_valid=false;
if(tracked&&launcher_calibrating&&!gaze_target_id.empty()){
auto& view=*views.at("launcher");auto& head=poses[0].mDeviceToAbsoluteTracking;
auto sample=[&](GazeAngles angles,float& u,float& v){auto candidate=gaze_world_ray(head,ray.vSource,angles);vr::VROverlayIntersectionResults_t result{};bool valid=overlays->ComputeOverlayIntersection(view.overlay,&candidate,&result);u=result.vUVs.v[0];v=result.vUVs.v[1];return valid&&std::isfinite(u)&&std::isfinite(v);};
if(gaze_target_cached&&gaze_angles_to_point(head,ray.vSource,gaze_target_world,expected)){float u,v;target_valid=sample(expected,u,v)&&std::hypot(u-gaze_target_u,v-gaze_target_v)<.001f;}
if(!target_valid){
vr::HmdMatrix34_t seed_pose{};GazeAngles seed{};
if(!overlays->GetTransformForOverlayCoordinates(view.overlay,vr::TrackingUniverseStanding,{{gaze_target_u*view.width,gaze_target_v*view.height}},&seed_pose)){
vr::HmdVector3_t seed_point{{seed_pose.m[0][3],seed_pose.m[1][3],seed_pose.m[2][3]}};
bool solved=gaze_angles_to_point(head,ray.vSource,seed_point,seed)&&gaze_target_inverse(seed,gaze_target_u,gaze_target_v,sample,expected);
if(!solved){vr::HmdMatrix34_t center{};if(!overlays->GetTransformForOverlayCoordinates(view.overlay,vr::TrackingUniverseStanding,{{view.width*.5f,view.height*.5f}},&center)){vr::HmdVector3_t point{{center.m[0][3],center.m[1][3],center.m[2][3]}};solved=gaze_angles_to_point(head,ray.vSource,point,seed)&&gaze_target_inverse(seed,gaze_target_u,gaze_target_v,sample,expected);}}
if(solved){
auto candidate=gaze_world_ray(head,ray.vSource,expected);vr::VROverlayIntersectionResults_t result{};
target_valid=overlays->ComputeOverlayIntersection(view.overlay,&candidate,&result);if(target_valid){gaze_target_world=result.vPoint;gaze_target_cached=true;}
}
}
}
}
if(tracked){double matrix[6];if(gaze_matrix(launcher_calibrating?gaze_preview:gaze_correction,matrix))ray=gaze_world_ray(poses[0].mDeviceToAbsoluteTracking,ray.vSource,gaze_correct(raw,matrix));}
bool valid=tracked&&overlays->ComputeOverlayIntersection(views.at("launcher")->overlay,&ray,&hit)&&std::isfinite(hit.vUVs.v[0])&&std::isfinite(hit.vUVs.v[1])&&hit.vUVs.v[0]>=0&&hit.vUVs.v[0]<=1&&hit.vUVs.v[1]>=0&&hit.vUVs.v[1]<=1;
// Looking away during a press keeps the locked target. Tracking loss cancels.
auto edge=gaze_press.update(!launcher_calibrating&&tracked&&(valid||gaze_press.held),connected,buttons);
if(edge==LauncherGazePress::Down)gaze_feedback_hand=gaze_press.owner;
if(edge==LauncherGazePress::Cancel||(!tracked&&gaze_active)){launcher_gaze_event(!allowed||edge==LauncherGazePress::Cancel?json{{"valid",false},{"phase","cancel"}}:json{{"valid",false}});gaze_active=false;return;}
if(!tracked)return;
if(edge==LauncherGazePress::Down||edge==LauncherGazePress::Up){launcher_gaze_event({{"valid",true},{"phase",edge==LauncherGazePress::Down?"down":"up"}});gaze_sent=now;}
else if(now-gaze_sent>=std::chrono::milliseconds(16)){
auto& v=*views.at("launcher");json event=valid?json{{"valid",true},{"x",hit.vUVs.v[0]*v.width},{"y",(1-hit.vUVs.v[1])*v.height}}:json{{"valid",bool(gaze_press.held)}};
if(launcher_calibrating){event["valid"]=tracked&&target_valid;event["targetId"]=gaze_target_id;event["targetUnavailable"]=tracked&&!target_valid;event["rawAngles"]={raw.yaw,raw.pitch};event["targetAngles"]={expected.yaw,expected.pitch};event["headPose"]=json::array();for(int r=0;r<3;r++)for(int c=0;c<4;c++)event["headPose"].push_back(poses[0].mDeviceToAbsoluteTracking.m[r][c]);}
launcher_gaze_event(event);gaze_sent=now;
}
gaze_active=true;
}
static void entry_actions(vr::VROverlayHandle_t button,bool available){
if(!entry_actions_ready)return;auto* input=vr::VRInput();vr::VRActiveActionSet_t sets[2]{};sets[0].ulActionSet=entry_set;sets[1].ulActionSet=gaze_set;
// Only the eye action participates in overlay priority. Controller bindings
// keep their existing priority so Steam laser and Dock controls are preserved.
if(launcher_gaze_allowed()&&!entry_hold.pressed&&!(available&&(entry_pointer.inside||overlays->IsHoverTargetOverlay(button))))sets[1].nPriority=vr::k_nActionSetOverlayGlobalPriorityMin;
if(input->UpdateActionState(sets,sizeof(sets[0]),gaze_set?2:1)!=vr::VRInputError_None)return;
auto now=std::chrono::steady_clock::now();
// Dock ownership must be checked before reading confirm edges. Gaze focus
// alone does not own a trigger aimed at the entry, even before mouse-down
// arrives. Disabling gaze disarms it until all confirm inputs are released.
bool gaze_allowed=launcher_gaze_allowed()&&!entry_hold.pressed&&!(available&&(entry_pointer.inside||overlays->IsHoverTargetOverlay(button)));bool gaze_connected[2]{},gaze_buttons[2]{};
float stick_x=0,stick_y=0;bool stick_active=false;vr::TrackedDeviceIndex_t stick_device=vr::k_unTrackedDeviceIndexInvalid;
for(int hand=0;hand<2;hand++){
vr::InputPoseActionData_t pose{};auto device=vr_system->GetTrackedDeviceIndexForControllerRole(hand?vr::TrackedControllerRole_RightHand:vr::TrackedControllerRole_LeftHand);bool hit=available&&entry_pointer.hit(device);
bool pose_ok=available&&input->GetPoseActionDataRelativeToNow(aim_action,vr::TrackingUniverseStanding,0,&pose,sizeof(pose),hands[hand])==vr::VRInputError_None&&pose.bActive&&pose.pose.bPoseIsValid;
if(available&&!pose_ok&&device!=vr::k_unTrackedDeviceIndexInvalid){
vr::TrackedDevicePose_t tracked[vr::k_unMaxTrackedDeviceCount]{};vr_system->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseStanding,0,tracked,vr::k_unMaxTrackedDeviceCount);
char model[256]{};vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_RenderModelName_String,model,sizeof(model));
vr::RenderModel_ControllerMode_State_t mode{};vr::RenderModel_ComponentState_t tip{};
if(tracked[device].bDeviceIsConnected&&tracked[device].bPoseIsValid&&vr::VRRenderModels()->GetComponentStateForDevicePath(model,"tip",hands[hand],&mode,&tip)){
pose.pose.mDeviceToAbsoluteTracking=entry_tip_pose(tracked[device].mDeviceToAbsoluteTracking,tip.mTrackingToComponentLocal);pose_ok=true;
}
}
if(pose_ok){auto& m=pose.pose.mDeviceToAbsoluteTracking;vr::VROverlayIntersectionParams_t params{};params.eOrigin=vr::TrackingUniverseStanding;for(int r=0;r<3;r++){params.vSource.v[r]=m.m[r][3];params.vDirection.v[r]=-m.m[r][2];}vr::VROverlayIntersectionResults_t result{};hit=hit||(overlays->IsHoverTargetOverlay(button)&&overlays->ComputeOverlayIntersection(button,&params,&result)&&result.vUVs.v[0]>=float(dock_icon_left)/dock_canvas_width&&result.vUVs.v[0]<=float(dock_icon_left+128)/dock_canvas_width);}
if(hit)gaze_allowed=false;
gaze_connected[hand]=device!=vr::k_unTrackedDeviceIndexInvalid&&vr_system->IsTrackedDeviceConnected(device);
if(gaze_connected[hand]){vr::InputDigitalActionData_t confirm{};bool active=input->GetDigitalActionData(confirm_action,&confirm,sizeof(confirm),hands[hand])==vr::VRInputError_None&&confirm.bActive;gaze_buttons[hand]=active&&confirm.bState;
if(!active){char model[256]{};vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_RenderModelName_String,model,sizeof(model));vr::RenderModel_ControllerMode_State_t mode{};vr::RenderModel_ComponentState_t state{};
if(hand==1)gaze_buttons[hand]=vr::VRRenderModels()->GetComponentStateForDevicePath(model,"button_a",hands[hand],&mode,&state)&&(state.uProperties&vr::VRComponentProperty_IsPressed);
else{vr::VRControllerState_t controller{};gaze_buttons[hand]=vr_system->GetControllerState(device,&controller,sizeof(controller))&&(controller.ulButtonPressed&(vr::ButtonMaskFromId(vr::k_EButton_DPad_Down)|vr::ButtonMaskFromId(vr::k_EButton_A)));}
}
}
for(int kind=0;kind<2;kind++){vr::InputDigitalActionData_t data{};bool active=input->GetDigitalActionData(kind?upper_action:primary_action,&data,sizeof(data),hands[hand])==vr::VRInputError_None&&data.bActive;
bool down=data.bState;if(kind==0&&active)entry_analog[hand].held=down;
// Dashboard focus suppresses action data. Frame's render-model components
// read the separate physical input paths, without changing Steam bindings
// or the user's global input-override setting.
if(!active&&device!=vr::k_unTrackedDeviceIndexInvalid&&vr_system->IsTrackedDeviceConnected(device)){
char type[256]{},model[256]{};vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_ControllerType_String,type,sizeof(type));
if(std::string(type)=="frame_controller"){
vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_RenderModelName_String,model,sizeof(model));
vr::RenderModel_ControllerMode_State_t mode{};vr::RenderModel_ComponentState_t state{};
active=vr::VRRenderModels()->GetComponentStateForDevicePath(model,kind?"bumper":"trigger",hands[hand],&mode,&state);
down=active&&(state.uProperties&vr::VRComponentProperty_IsPressed);
if(active&&kind==0){
// Frame's primary trigger is analog: its animated component has no
// IsPressed flag. Calibrate its travel from the model's legacy axis 1,
// then match Steam's 50% press / 45% release thresholds.
vr::VRControllerState_t rest_input{},full_input{};full_input.rAxis[1].x=1;
vr::RenderModel_ComponentState_t rest{},full{};float pull=0;
if(vr::VRRenderModels()->GetComponentState(model,"trigger",&rest_input,&mode,&rest)&&vr::VRRenderModels()->GetComponentState(model,"trigger",&full_input,&mode,&full)&&entry_trigger_pull(rest,full,state,pull))down=entry_analog[hand].update(pull)||down;
}
}
}
if(kind==0&&!active)entry_analog[hand].held=false;
if(kind==0&&active)gaze_buttons[hand]|=down;
bool was_held=entry_buttons[hand][kind].held;
entry_buttons[hand][kind].update(active,down,hit,now);
if(!(gaze_allowed&&gaze_active)&&kind==0&&active&&down&&!was_held&&launcher_open&&!launcher_calibrating&&!hit&&!launcher_dock_interaction()&&launcher_dismiss.allows(now,true)&&views.count("launcher")&&!overlays->IsHoverTargetOverlay(views.at("launcher")->overlay))launcher_outside_at=now+std::chrono::milliseconds(60);
}
if(launcher_open&&hand==1){vr::InputDigitalActionData_t close{};bool active=input->GetDigitalActionData(close_action,&close,sizeof(close),hands[hand])==vr::VRInputError_None&&close.bActive;bool down=close.bState;
if(!active&&device!=vr::k_unTrackedDeviceIndexInvalid&&vr_system->IsTrackedDeviceConnected(device)){char model[256]{};vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_RenderModelName_String,model,sizeof(model));vr::RenderModel_ControllerMode_State_t mode{};vr::RenderModel_ComponentState_t state{};active=vr::VRRenderModels()->GetComponentStateForDevicePath(model,"button_b",hands[hand],&mode,&state);down=active&&(state.uProperties&vr::VRComponentProperty_IsPressed);}
if(launcher_close_button.update(active,down,true,now))launcher_back();
}
vr::InputAnalogActionData_t axis{};bool active=input->GetAnalogActionData(navigate_action,&axis,sizeof(axis),hands[hand])==vr::VRInputError_None&&axis.bActive;float x=axis.x,y=axis.y;
if(!active&&device!=vr::k_unTrackedDeviceIndexInvalid&&vr_system->IsTrackedDeviceConnected(device)){char model[256]{};vr_system->GetStringTrackedDeviceProperty(device,vr::Prop_RenderModelName_String,model,sizeof(model));vr::RenderModel_ControllerMode_State_t mode{};vr::RenderModel_ComponentState_t rest{},full_x{},full_y{},current{};vr::VRControllerState_t neutral{},sx{},sy{};sx.rAxis[0].x=1;sy.rAxis[0].y=1;auto* models=vr::VRRenderModels();active=models->GetComponentStateForDevicePath(model,"thumbstick",hands[hand],&mode,&current)&&models->GetComponentState(model,"thumbstick",&neutral,&mode,&rest)&&models->GetComponentState(model,"thumbstick",&sx,&mode,&full_x)&&models->GetComponentState(model,"thumbstick",&sy,&mode,&full_y)&&launcher_stick_axes(rest,full_x,full_y,current,x,y);}
// Pick a single controller and a single axis; never emit two directions.
if(active&&(!stick_active||std::max(std::abs(x),std::abs(y))>std::max(std::abs(stick_x),std::abs(stick_y)))){stick_active=true;stick_x=x;stick_y=y;stick_device=device;}
}
launcher_gaze(input,gaze_allowed,gaze_connected,gaze_buttons,now);
if(launcher_open){const bool blocked=keyboard_open||launcher_dock_interaction();int direction=launcher_stick.update(blocked?0:stick_x,blocked?0:stick_y,!blocked&&stick_active);if(direction&&views.count("launcher")){auto* frame=views.at("launcher")->browser->get_main_frame(views.at("launcher")->browser);execute(frame,"window.dispatchEvent(new CustomEvent('framely.launcher.navigate',{detail:"+std::to_string(direction)+"}))");frame->base.release(&frame->base);}}
else{launcher_stick={};launcher_close_button={};}
page_scroll(stick_x,stick_y,stick_active,stick_device,now);
if(gaze_allowed&&gaze_active)launcher_outside_at={};
if(launcher_open&&launcher_outside_at.time_since_epoch().count()&&now>=launcher_outside_at){launcher_outside_at={};if(!keyboard_open&&!launcher_dock_interaction())launcher_back();}
}
static void commands(){std::deque<json> commands;{std::lock_guard<std::mutex> lock(queue_mutex);commands.swap(queue);}for(const auto& c:commands){try{auto kind=c.value("kind","");if(kind=="feedback.settings"){ui_haptics=c.value("haptics",true);ui_sounds=c.value("sounds",false);if(!ui_sounds)ui_audio.silence();}else if(kind=="file.dialog.complete"){for(auto& [key,view]:views){auto& v=*view;if(!v.file_dialog||v.file_dialog_id!=c.value("id",std::string{}))continue;auto paths=c.value("paths",json::array());if(paths.empty()){cancel_file_dialog(v);break;}if((!v.file_multiple&&paths.size()!=1)||paths.size()>64)break;auto* callback=v.file_dialog;v.file_dialog=nullptr;v.file_dialog_id.clear();auto list=cef_string_list_alloc();for(const auto& path:paths){cef_string_t value{};str(value,path.get<std::string>());cef_string_list_append(list,&value);cef_string_utf16_clear(&value);}callback->cont(callback,list);cef_string_list_free(list);callback->base.release(&callback->base);break;}}else if(kind=="gaze.correction"){gaze_correction=c.value("calibration",json(nullptr));}else if(kind=="gaze.target"){gaze_target_id=c.value("id",std::string{});gaze_target_u=c.value("x",.5f);gaze_target_v=1-c.value("y",.5f);gaze_preview=c.value("preview",json(nullptr));gaze_target_cached=false;}else if(kind=="launcher.calibrate"){gaze_target_id.clear();gaze_target_cached=false;gaze_preview=nullptr;launcher_calibrating=c.value("active",true);if(launcher_calibrating&&!launcher_open){if(!views.count("launcher"))create_view("launcher","Framely launcher",origin+"/launcher#calibrate",true,1440,800);toggle_entry(true);}if(views.count("launcher")){auto& v=*views.at("launcher");auto* frame=v.browser->get_main_frame(v.browser);execute(frame,std::string("location.hash=")+(launcher_calibrating?"'#calibrate'":"''")+";window.dispatchEvent(new Event('hashchange'))");frame->base.release(&frame->base);}}else if(kind=="launcher.close"){if(c.contains("launcherSession")&&!c["launcherSession"].is_null()&&c["launcherSession"]!=launcher_session)continue;bool handoff=c.value("handoff",false);hide_launcher(!handoff,handoff);}else if(kind=="menu.open"){hide_launcher(false);auto& menu=create_view("menu","Framely",origin+"/",false,600,840);navigate(menu,"#plugin:"+c.at("plugin").get<std::string>());menu_open=true;launcher_open=false;menu_button.opened(std::chrono::steady_clock::now());}else if(kind=="haptic"){auto key=c.value("view","");if(views.count(key)&&views.at(key)->shown&&!views.at(key)->closing){auto& view=*views.at(key);bool activation=c.value("feedback","hover")=="activate";if(activation&&key=="launcher"&&gaze_active&&launcher_gaze_allowed()){auto now=std::chrono::steady_clock::now();if(now-view.activation_at>=std::chrono::milliseconds(80)){view.activation_at=now;if(ui_sounds)ui_audio.play(true);}}else hover_haptic(view.overlay,activation?view.activation_at:view.haptic_at,activation);}}else if(kind=="manager.open"){hide_launcher(false);if(views.count("framely.manager")&&views.at("framely.manager")->closing){std::lock_guard<std::mutex> lock(queue_mutex);queue.push_back(c);continue;}auto page=c.value("page",std::string{});auto& manager=create_view("framely.manager","Framely",origin+"/manager"+((manager_navigation_page(page)||page.rfind("plugin:",0)==0)?"#"+page:""),true,1440,810);if(page.rfind("plugin:",0)==0)navigate(manager,"#"+page);if(manager_navigation_page(page)){auto* frame=manager.browser->get_main_frame(manager.browser);execute(frame,"location.hash="+json(page).dump()+";window.dispatchEvent(new Event(\"hashchange\"))");frame->base.release(&frame->base);}menu_open=false;launcher_open=false;}else if(kind=="agreement.decline"){auto key=c.value("view","");if(key=="menu"){menu_open=false;if(views.count("menu")){show(*views.at("menu"),false);views.at("menu")->browser->reload(views.at("menu")->browser);}}else if(views.count(key))close_view(*views.at(key));}else if(kind=="manager.close"){if(views.count("framely.manager"))close_view(*views.at("framely.manager"));}else if(kind=="menu.close"){menu_open=false;}else if(kind=="window.open"){hide_launcher(false);std::string plugin=c.at("plugin"),win=c.at("window");auto key="framely.window."+plugin+"."+win;if(views.count(key)&&views.at(key)->closing){std::lock_guard<std::mutex> lock(queue_mutex);queue.push_back(c);continue;}auto spec=c.at("spec");auto& opened=create_view("framely.window."+plugin+"."+win,spec.at("title"),origin+"/window/"+plugin+"/"+win,spec.value("dockIcon",false),spec.value("width",1600),spec.value("height",900),plugin,spec.value("widthMeters",3.f));plugin_thumbnail(opened,spec.value("iconData",std::string{}));menu_open=false;launcher_open=false;}else if(kind=="window.close"){auto key="framely.window."+c.at("plugin").get<std::string>()+"."+c.at("window").get<std::string>();if(views.count(key))close_view(*views.at(key));}else if(kind=="plugin.disabled"){for(auto&[key,v]:views)if(v->plugin==c.at("plugin"))close_view(*v);}else if(kind=="notification.changed"){auto& v=create_view("notifications","Framely Line truncated
}
static void overlay_input(View& v,const vr::VREvent_t& e){if(v.closing)return;if((v.key=="notifications"||v.key=="launcher"||v.key=="menu")&&!v.shown&&e.eventType!=vr::VREvent_OverlayClosed)return;if(v.key=="launcher"&&!launcher_open&&e.eventType!=vr::VREvent_OverlayClosed)return;if(v.key=="launcher"&&!launcher_accepts(e)&&(e.eventType==vr::VREvent_Modal_Cancel||e.eventType==vr::VREvent_ButtonPress||e.eventType==vr::VREvent_MouseButtonDown||e.eventType==vr::VREvent_MouseButtonUp))return;if(keyboard_event(e,v.overlay))return;laser_cursor(v.overlay,e);cef_mouse_event_t mouse{};mouse.x=int(e.data.mouse.x);mouse.y=v.height-int(e.data.mouse.y);if(e.eventType==vr::VREvent_MouseMove||e.eventType==vr::VREvent_MouseButtonDown||e.eventType==vr::VREvent_MouseButtonUp){v.pointer=mouse;v.pointer_valid=true;v.pointer_device=e.trackedDeviceIndex;v.pointer_at=std::chrono::steady_clock::now();}switch(e.eventType){case vr::VREvent_Modal_Cancel:if(v.key=="launcher"&&!keyboard_open&&!gaze_active&&!launcher_dock_interaction()&&!overlays->IsHoverTargetOverlay(v.overlay))launcher_back();else if(v.key=="menu"&&!keyboard_open&&!keyboard_menu.holds(std::chrono::steady_clock::now())&&menu_button.can_cancel(std::chrono::steady_clock::now())){menu_open=false;std::cout<<"Menu closed: outside click"<<std::endl;}break;case vr::VREvent_OverlayClosed:if(v.key=="launcher")hide_launcher();else if(v.key!="menu"&&v.key!="notifications")close_view(v);break;case vr::VREvent_ButtonPress:if(e.data.controller.button==vr::k_EButton_ApplicationMenu){if(v.key=="launcher"){launcher_back();break;}auto* frame=v.browser->get_main_frame(v.browser);execute(frame,"window.dispatchEvent(new Event('framely.back'))");frame->base.release(&frame->base);}break;case vr::VREvent_FocusLeave:if(v.key=="launcher"&&v.launcher_pointer.holding(std::chrono::steady_clock::now()))break;if(v.key!="notifications"||!v.notification_click.active)v.host->send_mouse_move_event(v.host,&mouse,1);break;case vr::VREvent_MouseMove:if(v.key=="launcher")v.launcher_pointer.constrain(mouse.x,mouse.y,std::chrono::steady_clock::now());if(v.key!="notifications"||!v.notification_click.hold(mouse.x,mouse.y,std::chrono::steady_clock::now()))v.host->send_mouse_move_event(v.host,&mouse,0);break;case vr::VREvent_MouseButtonDown:case vr::VREvent_MouseButtonUp:{v.host->set_focus(v.host,1);auto button=e.data.mouse.button==vr::VRMouseButton_Right?MBT_RIGHT:MBT_LEFT;if(v.key=="launcher"&&button==MBT_LEFT){auto now=std::chrono::steady_clock::now();if(e.eventType==vr::VREvent_MouseButtonDown)v.launcher_pointer.begin(mouse.x,mouse.y,now);else{v.launcher_pointer.constrain(mouse.x,mouse.y,now);v.launcher_pointer.clear();}}if(v.key=="notifications"&&button==MBT_LEFT){auto now=std::chrono::steady_clock::now();if(e.eventType==vr::VREvent_MouseButtonDown)v.notification_click.begin(mouse.x,mouse.y,now);else v.notification_click.release(mouse.x,mouse.y,now);}mouse.modifiers=e.eventType==vr::VREvent_MouseButtonDown?EVENTFLAG_LEFT_MOUSE_BUTTON:0;v.host->send_mouse_click_event(v.host,&mouse,button,e.eventType==vr::VREvent_MouseButtonUp,1);break;}case vr::VREvent_ScrollSmooth:case vr::VREvent_ScrollDiscrete:if(v.stick_scrolling||keyboard_open||!v.pointer_valid)break;mouse=v.pointer;mouse.modifiers=0;v.host->send_mouse_wheel_event(v.host,&mouse,int(e.data.scroll.xdelta*120),int(e.data.scroll.ydelta*120));break;case vr::VREvent_OverlayGamepadFocusLost:if(!keyboard_open&&!v.dashboard&&v.key!="menu"&&v.key!="notifications"&&v.key!="launcher")close_view(v);break;default:break;}}
int main(int argc,char** argv){
std::cout.setf(std::ios::unitbuf);std::string initial;int port=0;for(int i=1;i+1<argc;i++){std::string s=argv[i];if(s=="--url")initial=argv[++i];else if(s=="--port")port=std::stoi(argv[++i]);else if(s=="--runtime")runtime=argv[++i];}
@@ -231,23 +563,35 @@ int main(int argc,char** argv){
vr::VR_Shutdown();
// Frame's compositor requires the Overlay application type for visible UI.
// The session agent and service gate this renderer on all native services.
vr_system=vr::VR_Init(&vr_error,vr::VRApplication_Overlay);if(vr_error){std::cerr<<"SteamVR renderer unavailable "<<vr_error<<"\n";return 3;}overlays=vr::VROverlay();
vr_system=vr::VR_Init(&vr_error,vr::VRApplication_Overlay);if(vr_error){std::cerr<<"SteamVR renderer unavailable "<<vr_error<<"\n";return 3;}overlays=vr::VROverlay();setup_entry_actions();
xdisplay=XOpenDisplay(nullptr);if(!xdisplay){vr::VR_Shutdown();return 4;}int n=0;int attrs[]={GLX_DRAWABLE_TYPE,GLX_PBUFFER_BIT,GLX_RENDER_TYPE,GLX_RGBA_BIT,None};auto* configs=glXChooseFBConfig(xdisplay,DefaultScreen(xdisplay),attrs,&n);if(!configs||!n){vr::VR_Shutdown();return 4;}int pba[]={GLX_PBUFFER_WIDTH,16,GLX_PBUFFER_HEIGHT,16,None};glsurface=glXCreatePbuffer(xdisplay,configs[0],pba);glcontext=glXCreateNewContext(xdisplay,configs[0],GLX_RGBA_TYPE,nullptr,True);XFree(configs);if(!glcontext||!glXMakeContextCurrent(xdisplay,glsurface,glsurface,glcontext)){vr::VR_Shutdown();return 4;}
cef_settings_t settings{};settings.size=sizeof(settings);settings.windowless_rendering_enabled=1;std::string locale;for(const char* key:{"LC_ALL","LC_MESSAGES","LANG"}){const char* value=std::getenv(key);if(value&&*value){locale=value;break;}}auto suffix=locale.find_first_of(".@");if(suffix!=std::string::npos)locale.erase(suffix);std::replace(locale.begin(),locale.end(),'_','-');if(locale=="C"||locale=="POSIX"||locale.empty())locale="en-US";str(settings.accept_language_list,locale+",en-US,en");str(settings.root_cache_path,runtime+"/cef-cache");str(settings.log_file,runtime+"/cef.log");if(!cef_initialize(&args,&settings,nullptr,nullptr)){vr::VR_Shutdown();return 5;}
render_handler.api.get_view_rect=[](cef_render_handler_t*,cef_browser_t* b,cef_rect_t* r){auto* v=find_browser(b);*r={0,0,v?v->width:600,v?v->height:840};};
render_handler.api.get_screen_info=[](cef_render_handler_t*,cef_browser_t* b,cef_screen_info_t* info){auto* v=find_browser(b);return render_screen_info(info,v?v->width:600,v?v->height:840,v?v->render_scale:1);};
render_handler.api.on_paint=[](cef_render_handler_t*,cef_browser_t* b,cef_paint_element_type_t type,size_t,const cef_rect_t*,const void* data,int w,int h){auto* v=find_browser(b);if(!v||v->closing||type!=PET_VIEW||w!=v->width*v->render_scale||h!=v->height*v->render_scale)return;v->pixels.resize(w*h*4);auto* source=static_cast<const uint8_t*>(data);for(int y=0;y<h;y++)std::copy_n(source+y*w*4,w*4,v->pixels.data()+(h-1-y)*w*4);v->dirty=true;};
render_handler.api.on_paint=[](cef_render_handler_t*,cef_browser_t* b,cef_paint_element_type_t type,size_t dirty_count,const cef_rect_t* dirty,const void* data,int w,int h){auto* v=find_browser(b);if(!v||v->closing||type!=PET_VIEW||w!=v->width*v->render_scale||h!=v->height*v->render_scale)return;merge_paint(v->pixels,data,w,h,dirty_count,dirty,true);for(auto& damage:v->texture_damage)damage.add(w,h,dirty_count,dirty);v->dirty=true;};
life_handler.api.on_before_popup=[](cef_life_span_handler_t*,cef_browser_t*,cef_frame_t*,int,const cef_string_t*,const cef_string_t*,cef_window_open_disposition_t,int,const cef_popup_features_t*,cef_window_info_t*,cef_client_t**,cef_browser_settings_t*,cef_dictionary_value_t**,int*){return 1;};
life_handler.api.on_before_close=[](cef_life_span_handler_t*,cef_browser_t* b){auto* v=find_browser(b);if(v){v->closed=true;v->host->base.release(&v->host->base);v->host=nullptr;v->browser->base.release(&v->browser->base);v->browser=nullptr;}};
display_handler.api.on_console_message=[](cef_display_handler_t*,cef_browser_t* b,cef_log_severity_t,const cef_string_t* message,const cef_string_t*,int){auto* v=find_browser(b);std::cout<<"UI ["<<(v?v->key:"loading")<<"] "<<text(message)<<std::endl;return 1;};
life_handler.api.on_before_close=[](cef_life_span_handler_t*,cef_browser_t* b){auto* v=find_browser(b);if(v){cancel_file_dialog(*v);v->closed=true;v->host->base.release(&v->host->base);v->host=nullptr;v->browser->base.release(&v->browser->base);v->browser=nullptr;}};
display_handler.api.on_console_message=[](cef_display_handler_t*,cef_browser_t* b,cef_log_severity_t,const cef_string_t* message,const cef_string_t*,int){auto* v=find_browser(b);if(v&&v->key=="launcher"){const auto value=text(message);if(value=="FRAMELY_LAUNCHER_REDUCED_MOTION=1")launcher_fade.reduced=true;else if(value=="FRAMELY_LAUNCHER_REDUCED_MOTION=0")launcher_fade.reduced=false;else if(value=="FRAMELY_GAZE_FOCUS"&&gaze_active&&launcher_gaze_allowed()){
auto now=std::chrono::steady_clock::now();if(now-gaze_feedback_at>=std::chrono::milliseconds(180)){gaze_feedback_at=now;if(ui_sounds)ui_audio.play();int hand=gaze_feedback_hand;auto device=vr_system->GetTrackedDeviceIndexForControllerRole(hand?vr::TrackedControllerRole_RightHand:vr::TrackedControllerRole_LeftHand);if(device==vr::k_unTrackedDeviceIndexInvalid){hand=1-hand;device=vr_system->GetTrackedDeviceIndexForControllerRole(hand?vr::TrackedControllerRole_RightHand:vr::TrackedControllerRole_LeftHand);}if(ui_haptics&&device!=vr::k_unTrackedDeviceIndexInvalid&&vr::VRInput()->TriggerHapticVibrationAction(gaze_haptic_action,0,.012f,110.f,.16f,hands[hand])!=vr::VRInputError_None)vr_system->TriggerHapticPulse(device,0,1200);}
return 1;}}std::cout<<"UI ["<<(v?v->key:"loading")<<"] "<<text(message)<<std::endl;return 1;};
load_handler.api.on_load_end=[](cef_load_handler_t*,cef_browser_t*,cef_frame_t* frame,int){inject_page_scroll(frame);};
client.api.get_load_handler=[](cef_client_t*){return load_handler.acquire();};
request_handler.api.on_before_browse=[](cef_request_handler_t*,cef_browser_t* b,cef_frame_t* f,cef_request_t* r,int,int){auto* uri=r->get_url(r);auto s=text(uri);cef_string_userfree_utf16_free(uri);auto* v=find_browser(b);return int(!allow_plugin_navigation(s,origin,!f||f->is_main(f),v&&!v->plugin.empty()));};
request_handler.api.on_render_process_terminated=[](cef_request_handler_t*,cef_browser_t* b,cef_termination_status_t,int,const cef_string_t*){auto* v=find_browser(b);if(v){std::cerr<<"Renderer crashed: "<<v->key<<"\n";close_view(*v);if(v->key=="menu")running=0;}};
client.api.get_render_handler=[](cef_client_t*){return render_handler.acquire();};client.api.get_life_span_handler=[](cef_client_t*){return life_handler.acquire();};client.api.get_display_handler=[](cef_client_t*){return display_handler.acquire();};client.api.get_request_handler=[](cef_client_t*){return request_handler.acquire();};
vr::VROverlayHandle_t button=0;auto err=overlays->CreateOverlay("framely.dock.button","Framely",&button);if(err){cef_shutdown();vr::VR_Shutdown();return 6;}auto pixels=dock_icon(false,false);overlays->SetOverlayRaw(button,pixels.data(),dock_canvas_width,dock_canvas_height,4);overlays->SetOverlayInputMethod(button,vr::VROverlayInputMethod_Mouse);vr::HmdVector2_t scale{{dock_canvas_width,dock_canvas_height}};overlays->SetOverlayMouseScale(button,&scale);vr::VROverlayIntersectionMaskPrimitive_t mask{};mask.m_nPrimitiveType=vr::OverlayIntersectionPrimitiveType_Rectangle;mask.m_Primitive.m_Rectangle={dock_icon_left,0,128,128};if(overlays->SetOverlayIntersectionMask(button,&mask,1)){std::cerr<<"Dock input mask unavailable\n";overlays->DestroyOverlay(button);cef_shutdown();vr::VR_Shutdown();return 6;}overlays->SetOverlayFlag(button,vr::VROverlayFlags_VisibleInDashboard,true);overlays->SetOverlayFlag(button,vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible,true);overlays->SetOverlayFlag(button,vr::VROverlayFlags_SortWithNonSceneOverlays,false);overlays->SetOverlaySortOrder(button,0);overlays->SetOverlayFlag(button,vr::VROverlayFlags_HideLaserIntersection,false);
request_handler.api.on_render_process_terminated=[](cef_request_handler_t*,cef_browser_t* b,cef_termination_status_t,int,const cef_string_t*){auto* v=find_browser(b);if(v){std::cerr<<"Renderer crashed: "<<v->key<<"\n";close_view(*v);if(v->key=="menu")running=0;if(v->key=="launcher")launcher_open=false;}};
dialog_handler.api.on_file_dialog=[](cef_dialog_handler_t*,cef_browser_t* b,cef_file_dialog_mode_t mode,const cef_string_t*,const cef_string_t* default_path,cef_string_list_t filters,cef_string_list_t extensions,cef_string_list_t,cef_file_dialog_callback_t* callback){
auto* v=find_browser(b);if(!v||v->key!="framely.manager"||mode==FILE_DIALOG_SAVE)return 0;
cancel_file_dialog(*v);callback->base.add_ref(&callback->base);v->file_dialog=callback;v->file_multiple=mode==FILE_DIALOG_OPEN_MULTIPLE;v->file_directory=mode==FILE_DIALOG_OPEN_FOLDER;v->file_dialog_id=std::to_string(++file_dialog_sequence)+"-"+std::to_string(std::chrono::steady_clock::now().time_since_epoch().count());
json accept=json::array();for(auto list:{filters,extensions}){if(!list)continue;for(size_t i=0;i<cef_string_list_size(list);++i){cef_string_t value{};cef_string_list_value(list,i,&value);auto filter=text(&value);cef_string_utf16_clear(&value);if(!filter.empty())accept.push_back(filter);}}
auto* frame=v->browser->get_main_frame(v->browser);execute(frame,"window.dispatchEvent(new CustomEvent('framely.fileDialog',{detail:"+json({{"id",v->file_dialog_id},{"multiple",v->file_multiple},{"directory",v->file_directory},{"accept",accept},{"defaultPath",default_path?text(default_path):std::string{}}}).dump()+"}))");frame->base.release(&frame->base);return 1;
};
client.api.get_dialog_handler=[](cef_client_t*){return dialog_handler.acquire();};client.api.get_render_handler=[](cef_client_t*){return render_handler.acquire();};client.api.get_life_span_handler=[](cef_client_t*){return life_handler.acquire();};client.api.get_display_handler=[](cef_client_t*){return display_handler.acquire();};client.api.get_request_handler=[](cef_client_t*){return request_handler.acquire();};
vr::VROverlayHandle_t button=0;auto err=overlays->CreateOverlay("framely.dock.button","Framely",&button);if(err){cef_shutdown();vr::VR_Shutdown();return 6;}auto pixels=dock_icon(false,false);DockIconTexture icon_texture;icon_texture.init();if(!icon_texture.submit(button,pixels)){icon_texture.destroy();overlays->DestroyOverlay(button);cef_shutdown();vr::VR_Shutdown();return 6;}overlays->SetOverlayInputMethod(button,vr::VROverlayInputMethod_Mouse);vr::HmdVector2_t scale{{dock_canvas_width,dock_canvas_height}};overlays->SetOverlayMouseScale(button,&scale);vr::VROverlayIntersectionMaskPrimitive_t mask{};mask.m_nPrimitiveType=vr::OverlayIntersectionPrimitiveType_Rectangle;mask.m_Primitive.m_Rectangle={dock_icon_left,0,128,128};if(overlays->SetOverlayIntersectionMask(button,&mask,1)){std::cerr<<"Dock input mask unavailable\n";overlays->DestroyOverlay(button);icon_texture.destroy();cef_shutdown();vr::VR_Shutdown();return 6;}overlays->SetOverlayFlag(button,vr::VROverlayFlags_VisibleInDashboard,true);overlays->SetOverlayFlag(button,vr::VROverlayFlags_MakeOverlaysInteractiveIfVisible,true);overlays->SetOverlayFlag(button,vr::VROverlayFlags_SortWithNonSceneOverlays,false);overlays->SetOverlaySortOrder(button,0);overlays->SetOverlayFlag(button,vr::VROverlayFlags_HideLaserIntersection,false);
try{create_view("menu","Framely",initial,false,600,840);}catch(const std::exception& e){std::cerr<<e.what()<<"\n";running=0;}
std::thread poller([port]{int failures=0;while(running){try{auto data=poll_http(port);notification_badge_count.store(data.value("notificationBadge",0u));std::lock_guard<std::mutex> lock(queue_mutex);for(const auto& c:data.at("commands")){if(queue.size()<256)queue.push_back(c);}failures=0;}catch(const std::exception& e){if(++failures>=10){std::cerr<<"Agent connection lost: "<<e.what()<<"\n";running=0;}}std::this_thread::sleep_for(std::chrono::milliseconds(100));}});
DockUVState uv{};OverlayPlacement button_placement;bool icon_active=false,icon_hover=false;unsigned icon_badge=0;vr::VROverlayHandle_t last_dock=0;bool was_visible=false;vr::HmdMatrix34_t saved_anchor{},saved_frame{};float saved_size=0;DockCurveEvidence saved_evidence{};auto button_haptic_at=std::chrono::steady_clock::time_point{};auto anchored_at=std::chrono::steady_clock::time_point{};auto sampled_at=std::chrono::steady_clock::time_point{};
while(running){auto frame_start=std::chrono::steady_clock::now();cef_do_message_loop_work();commands();vr::VREvent_t global{};while(vr_system->PollNextEvent(&global,sizeof(global))){if(global.eventType==vr::VREvent_Quit){vr_system->AcknowledgeQuit_Exiting();running=0;}keyboard_event(global);}vr::VROverlayHandle_t dock=0;vr::HmdVector2_t mouse_scale{};bool visible=!overlays->FindOverlay("valve.steam.gamepadui.bar",&dock)&&overlays->IsDashboardVisible()&&overlays->IsOverlayVisible(dock)&&!overlays->GetOverlayMouseScale(dock,&mouse_scale);
const char* steam_root=std::getenv("FRAMELY_STEAM_ROOT");if(!ui_audio.prepare(steam_root?steam_root:""))std::cerr<<"Steam UI sounds unavailable\n";
std::thread poller([port]{int failures=0;json last_feedback;json last_gaze;bool gaze_loaded=false;while(running){try{auto data=poll_http(port);notification_badge_count.store(data.value("notificationBadge",0u));launcher_prioritize_ui.store(data.value("launcher",json::object()).value("prioritizeUi",true));std::lock_guard<std::mutex> lock(queue_mutex);auto feedback=data.value("feedback",json::object());if(!feedback.is_object())feedback=json::object();if(feedback!=last_feedback){queue.push_back({{"kind","feedback.settings"},{"haptics",feedback.value("haptics",true)},{"sounds",feedback.value("sounds",false)}});last_feedback=feedback;}auto calibration=data.value("gazeCalibration",json(nullptr));if(!gaze_loaded||calibration!=last_gaze){queue.push_back({{"kind","gaze.correction"},{"calibration",calibration}});last_gaze=calibration;gaze_loaded=true;}for(const auto& c:data.at("commands")){if(queue.size()<256)queue.push_back(c);}failures=0;}catch(const std::exception& e){if(++failures>=10){std::cerr<<"Agent connection lost: "<<e.what()<<"\n";running=0;}}std::this_thread::sleep_for(std::chrono::milliseconds(100));}});
std::thread priority_worker([]{LauncherPriority priority;while(running){priority.update(launcher_priority_active.load());std::this_thread::sleep_for(std::chrono::milliseconds(100));}});
DockUVState uv{};OverlayPlacement button_placement;bool icon_active=false,icon_hover=false;unsigned icon_badge=0;int icon_progress=0;vr::VROverlayHandle_t last_dock=0;bool was_visible=false;vr::HmdMatrix34_t saved_anchor{},saved_frame{};float saved_size=0;DockCurveEvidence saved_evidence{};auto button_haptic_at=std::chrono::steady_clock::time_point{};auto anchored_at=std::chrono::steady_clock::time_point{};auto sampled_at=std::chrono::steady_clock::time_point{};
while(running){auto frame_start=std::chrono::steady_clock::now();cef_do_message_loop_work();commands();vr::VREvent_t global{};while(vr_system->PollNextEvent(&global,sizeof(global))){if(global.eventType==vr::VREvent_Quit){vr_system->AcknowledgeQuit_Exiting();running=0;}observe_dashboard(global);keyboard_event(global);}launcher_priority_active.store(launcher_open&&launcher_prioritize_ui.load());vr::VROverlayHandle_t dock=0;vr::HmdVector2_t mouse_scale{};bool visible=!overlays->FindOverlay("valve.steam.gamepadui.bar",&dock)&&overlays->IsDashboardVisible()&&overlays->IsOverlayVisible(dock)&&!overlays->GetOverlayMouseScale(dock,&mouse_scale);
if(visible&&(!was_visible||dock!=last_dock)){uv={};anchored_at={};sampled_at={};}last_dock=dock;
// Width and aspect are only ray-solver seeds; physical size comes from intersections.
float width=0,height=0;bool fresh=visible&&!overlays->GetOverlayWidthInMeters(dock,&width)&&std::isfinite(width)&&width>0&&width<10&&std::isfinite(mouse_scale.v[0])&&std::isfinite(mouse_scale.v[1])&&mouse_scale.v[0]>0&&mouse_scale.v[1]>0;
@@ -263,33 +607,80 @@ int main(int argc,char** argv){
if(!main_overlay)main_overlay=active_main_window();
if(main_overlay&&!overlays->GetOverlayMouseScale(main_overlay,&main_scale)&&!overlays->GetTransformForOverlayCoordinates(main_overlay,vr::TrackingUniverseStanding,{{main_scale.v[0]*.5f,main_scale.v[1]*.5f}},&main_pose))main=&main_pose;
if(evidence.radius>0?dock_menu_placement(anchor,size,evidence.radius,evidence.pre_curve_pitch,popup):menu_placement(anchor,size,popup,0,main)){v.placement.apply(overlays,v.overlay,popup.transform,popup.width);v.placement.curve(overlays,v.overlay,popup.width,popup.radius);show(v,menu_open);}else show(v,false);}}else if(!keyboard_menu.holds(now)){if(overlays->IsOverlayVisible(button))overlays->ClearOverlayCursorPositionOverride(button);overlays->HideOverlay(button);if(views.count("menu"))show(*views.at("menu"),false);}
if(was_visible&&!visible&&!keyboard_open&&!keyboard_menu.holds(now)){menu_button.pressed=false;menu_open=false;for(auto&[key,v]:views)if(!v->dashboard&&key!="menu"&&key!="notifications")close_view(*v);}was_visible=visible;
// Toggle once for a matched left click; never activate on a stale release.
if(was_visible&&!visible&&!keyboard_open&&!keyboard_menu.holds(now)){menu_button.pressed=false;menu_open=false;if(!overlays->IsDashboardVisible())hide_launcher(false,true);for(auto&[key,v]:views)if(!v->dashboard&&key!="menu"&&key!="notifications"&&key!="launcher")close_view(*v);}was_visible=visible;
if(launcher_close_at.time_since_epoch().count()&&now>=launcher_close_at){launcher_close_at={};if(!launcher_open)finish_launcher_close();}
// The runtime owns dashboard placement, curvature, visibility and switching.
// Never move the launcher into standing space or hide another app's overlay.
if(launcher_open)launcher_dock_interaction();
if(views.count("launcher")){
bool selected=overlays->IsActiveDashboardOverlay(views.at("launcher")->overlay);
if(launcher_open&&selected)launcher_selected=true;
if(launcher_open&&selected&&overlays->IsDashboardVisible()&&overlays->IsOverlayVisible(views.at("launcher")->overlay)&&views.at("launcher")->texture_ready[views.at("launcher")->texture_slot])launcher_fade.ready(now);
if(launcher_open||launcher_close_at.time_since_epoch().count())overlays->SetOverlayAlpha(views.at("launcher")->overlay,launcher_open?std::max(.02f,launcher_fade.value(now)):launcher_fade.value(now));
if(launcher_open&&!selected&&overlays->IsDashboardVisible()&&!launcher_dock_interaction()&&(launcher_selected||now-launcher_dismiss.opened_at>std::chrono::seconds(5))){hide_launcher(false,true);}
}
auto activate_entry=[&](EntryHold::Action action){
if(action==EntryHold::Action::Idle)return;
if(ui_sounds)ui_audio.play(true);
toggle_entry(action==EntryHold::Action::Launcher);
if(menu_open&&views.count("menu"))views.at("menu")->host->set_focus(views.at("menu")->host,1);
};
vr::VREvent_t event{};while(overlays->PollNextOverlayEvent(button,&event,sizeof(event))){
laser_cursor(button,event);
if(event.eventType==vr::VREvent_MouseMove||event.eventType==vr::VREvent_MouseButtonDown||event.eventType==vr::VREvent_MouseButtonUp)entry_pointer.move(event.trackedDeviceIndex,event.data.mouse.x,event.data.mouse.y);
if(event.eventType==vr::VREvent_FocusLeave)entry_pointer.leave();
if(event.eventType==vr::VREvent_MouseButtonDown||event.eventType==vr::VREvent_MouseButtonUp){
if(menu_button.event(event.eventType==vr::VREvent_MouseButtonDown,event.data.mouse.button==vr::VRMouseButton_Left,anchor_ok,now)){
menu_open=!menu_open;if(menu_open){menu_button.opened(now);if(views.count("menu"))views.at("menu")->host->set_focus(views.at("menu")->host,1);}
std::cout<<"Menu "<<(menu_open?"opened":"closed")<<std::endl;
// Cancel any existing gaze gesture before toggling views. This also
// covers a complete down/up pair drained in one frame and unknown devices.
if(event.eventType==vr::VREvent_MouseButtonDown&&anchor_ok&&entry_pointer.inside){
auto edge=gaze_press.cancel();if(gaze_active||edge==LauncherGazePress::Cancel)launcher_gaze_event({{"valid",false},{"phase","cancel"}});gaze_active=false;
}
const auto received=std::chrono::steady_clock::now();const bool was_pressed=entry_hold.pressed;const auto previous_started=entry_hold.started;
activate_entry(entry_hold.event(event.eventType==vr::VREvent_MouseButtonDown,event.trackedDeviceIndex,event.data.mouse.button,anchor_ok&&(event.trackedDeviceIndex==vr::k_unTrackedDeviceIndexInvalid||vr_system->IsTrackedDeviceConnected(event.trackedDeviceIndex)),entry_pointer.inside,entry_event_time(received,event.eventAgeSeconds),received));
if(entry_hold.pressed&&(!was_pressed||entry_hold.started!=previous_started)){
entry_source_buttons=0;vr::VRControllerState_t state{};
if(entry_hold.device!=vr::k_unTrackedDeviceIndexInvalid&&vr_system->GetControllerState(entry_hold.device,&state,sizeof(state))){
const auto previous=entry_previous_buttons.find(entry_hold.device);
if(previous!=entry_previous_buttons.end())entry_source_buttons=state.ulButtonPressed&~previous->second;
// An unambiguous single button is safe even if its down event arrived late.
if(!entry_source_buttons&&state.ulButtonPressed&&(state.ulButtonPressed&(state.ulButtonPressed-1))==0)entry_source_buttons=state.ulButtonPressed;
}
}
}
}
for(auto&[key,v]:views){if(v->closing)continue;if(v->dashboard){bool active=overlays->IsDashboardVisible()&&overlays->IsActiveDashboardOverlay(v->overlay)&&overlays->IsOverlayVisible(v->overlay);if(active!=v->shown){v->host->was_hidden(v->host,!active);v->shown=active;}if(!active)v->active_seen=false;if(active&&!v->active_seen){v->active_seen=true;for(auto&[other,t]:views)if(!t->dashboard&&other!="menu"&&other!="notifications"&&!keyboard_open)close_view(*t);}}
if(!anchor_ok)entry_pointer.leave();
const bool entry_connected=entry_hold.device==vr::k_unTrackedDeviceIndexInvalid||vr_system->IsTrackedDeviceConnected(entry_hold.device);
const bool entry_inside=entry_pointer.inside&&entry_pointer.device==entry_hold.device;
if(entry_hold.pressed&&entry_source_buttons){vr::VRControllerState_t state{};if(vr_system->GetControllerState(entry_hold.device,&state,sizeof(state))&&!(state.ulButtonPressed&entry_source_buttons))activate_entry(entry_hold.released(anchor_ok&&entry_connected,entry_inside));}
activate_entry(entry_hold.tick(std::chrono::steady_clock::now(),anchor_ok&&entry_connected,entry_inside));
for(auto&[key,v]:views)v->stick_scrolling=false;
entry_actions(button,anchor_ok);
if(launcher_open){bool held=false;for(auto& hand:entry_buttons)for(auto& trigger:hand)held|=trigger.held;launcher_dismiss.observe(held);}
for(auto&[key,v]:views){if(v->closing)continue;if(v->dashboard){bool active=overlays->IsDashboardVisible()&&overlays->IsActiveDashboardOverlay(v->overlay)&&overlays->IsOverlayVisible(v->overlay);if(active!=v->shown){if(!active&&key=="launcher"){if(v->launcher_pointer.active){cef_mouse_event_t outside{};outside.modifiers=EVENTFLAG_LEFT_MOUSE_BUTTON;v->host->send_mouse_move_event(v->host,&outside,0);outside.modifiers=0;v->host->send_mouse_click_event(v->host,&outside,MBT_LEFT,1,1);}v->launcher_pointer.clear();auto* frame=v->browser->get_main_frame(v->browser);execute(frame,"window.dispatchEvent(new Event('framely.launcher.cancelInput'))");frame->base.release(&frame->base);}v->host->was_hidden(v->host,!active);v->shown=active;}if(!active)v->active_seen=false;if(active&&!v->active_seen){v->active_seen=true;if(key!="launcher")for(auto&[other,t]:views)if(!t->dashboard&&other!="menu"&&other!="notifications"&&other!="launcher"&&!keyboard_open)close_view(*t);}}
while(overlays->PollNextOverlayEvent(v->overlay,&event,sizeof(event)))overlay_input(*v,event);
if(v->dirty&&!v->closing){
glXMakeContextCurrent(xdisplay,glsurface,glsurface,glcontext);
// Upload to the other texture; never redefine storage submitted this frame.
const int slot=1-v->texture_slot;const GLuint id=v->textures[slot];
auto& damage=v->texture_damage[slot];const int pixel_width=v->width*v->render_scale,pixel_height=v->height*v->render_scale;
static auto generate_mipmap=reinterpret_cast<PFNGLGENERATEMIPMAPPROC>(glXGetProcAddressARB(reinterpret_cast<const GLubyte*>("glGenerateMipmap")));
bool mipmapped=v->key=="launcher"&&generate_mipmap;
glBindTexture(GL_TEXTURE_2D,id);
glPixelStorei(GL_UNPACK_ALIGNMENT,4);glPixelStorei(GL_UNPACK_ROW_LENGTH,0);
glPixelStorei(GL_UNPACK_SKIP_PIXELS,0);glPixelStorei(GL_UNPACK_SKIP_ROWS,0);
if(!v->texture_ready[slot]){
glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,GL_LINEAR);glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MIN_FILTER,mipmapped?GL_LINEAR_MIPMAP_LINEAR:GL_LINEAR);glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_MAG_FILTER,GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_WRAP_S,GL_CLAMP_TO_EDGE);glTexParameteri(GL_TEXTURE_2D,GL_TEXTURE_WRAP_T,GL_CLAMP_TO_EDGE);
glTexImage2D(GL_TEXTURE_2D,0,GL_RGBA8,v->width*v->render_scale,v->height*v->render_scale,0,GL_BGRA,GL_UNSIGNED_BYTE,nullptr);
v->texture_ready[slot]=true;
damage.include(0,0,pixel_width,pixel_height);
}
if(!damage.empty()){
glPixelStorei(GL_UNPACK_ROW_LENGTH,pixel_width);
glTexSubImage2D(GL_TEXTURE_2D,0,damage.x,damage.y,damage.width,damage.height,GL_BGRA,GL_UNSIGNED_BYTE,v->pixels.data()+(size_t(damage.y)*pixel_width+damage.x)*4);
glPixelStorei(GL_UNPACK_ROW_LENGTH,0);damage.clear();
if(mipmapped)generate_mipmap(GL_TEXTURE_2D);
}
glTexSubImage2D(GL_TEXTURE_2D,0,0,0,v->width*v->render_scale,v->height*v->render_scale,GL_BGRA,GL_UNSIGNED_BYTE,v->pixels.data());
// glFlush queues the upload; glFinish makes the full image ready for sharing.
glFinish();vr::Texture_t texture{reinterpret_cast<void*>(uintptr_t(id)),vr::TextureType_OpenGL,vr::ColorSpace_Auto};
auto e=overlays->SetOverlayTexture(v->overlay,&texture);glFlush();
@@ -322,7 +713,7 @@ int main(int argc,char** argv){
show(*v,v->notification_content&&v->placement.valid);
}
}
{json snapshot=json::object();for(auto&[key,v]:views){if(key=="menu"||key=="framely.manager"||key.rfind("framely.window.",0)==0)snapshot[key]=capture_view_visible(v->closing,overlays->IsOverlayVisible(v->overlay),v->dashboard,overlays->IsDashboardVisible(),overlays->IsActiveDashboardOverlay(v->overlay));}std::lock_guard<std::mutex> lock(visibility_mutex);visible_views=std::move(snapshot);}
{json snapshot=json::object();for(auto&[key,v]:views){if(key=="menu"||key=="launcher"||key=="framely.manager"||key.rfind("framely.window.",0)==0)snapshot[key]=capture_view_visible(v->closing,overlays->IsOverlayVisible(v->overlay),v->dashboard,overlays->IsDashboardVisible(),overlays->IsActiveDashboardOverlay(v->overlay));}std::lock_guard<std::mutex> lock(visibility_mutex);visible_views=std::move(snapshot);}
if(keyboard_close_pending){
// A non-minimal runtime keyboard may buffer text until Done. Drain overlay
// character events first so the global Done event cannot duplicate input.
@@ -330,11 +721,14 @@ int main(int argc,char** argv){
close_keyboard(false);
}
for(auto i=views.begin();i!=views.end();){auto& v=*i->second;if(v.closed){overlays->ClearOverlayTexture(v.overlay);overlays->DestroyOverlay(v.overlay);if(v.thumbnail)overlays->DestroyOverlay(v.thumbnail);glDeleteTextures(2,v.textures);i=views.erase(i);}else ++i;}
bool hovered=anchor_ok&&overlays->IsHoverTargetOverlay(button);if(hovered&&!icon_hover)hover_haptic(button,button_haptic_at);const auto badge=notification_badge_count.load();if(icon_active!=menu_open||icon_hover!=hovered||icon_badge!=badge){icon_badge=badge;icon_active=menu_open;pixels=dock_icon(hovered,menu_open);overlays->SetOverlayRaw(button,pixels.data(),dock_canvas_width,dock_canvas_height,4);}icon_hover=hovered;
bool hovered=anchor_ok&&(entry_hold.pressed||overlays->IsHoverTargetOverlay(button));if(hovered&&!icon_hover)hover_haptic(button,button_haptic_at);const auto badge=notification_badge_count.load();const float ring=entry_hold.progress(std::chrono::steady_clock::now());const int progress=ring>0?std::max(1,int(std::lround(ring*120))):0;if(icon_progress!=progress||icon_active!=(menu_open||launcher_open)||icon_hover!=hovered||icon_badge!=badge){pixels=dock_icon(hovered,menu_open||launcher_open,progress/120.f);if(icon_texture.submit(button,pixels)){icon_progress=progress;icon_badge=badge;icon_active=menu_open||launcher_open;}}icon_hover=hovered;
// Remember source state only after draining events, to identify the actual
// newly pressed button rather than unrelated buttons held on the controller.
for(auto device:{entry_pointer.device,entry_hold.device})if(device!=vr::k_unTrackedDeviceIndexInvalid){vr::VRControllerState_t state{};if(vr_system->GetControllerState(device,&state,sizeof(state)))entry_previous_buttons[device]=state.ulButtonPressed;else entry_previous_buttons.erase(device);}
auto sync=overlays->WaitFrameSync(8);
// A timeout already waited: never append another sleep to it. Bound retries
// only for immediate API failures, so a broken sync call cannot busy-spin.
if(sync!=vr::VROverlayError_None&&sync!=vr::VROverlayError_TimedOut)std::this_thread::sleep_until(frame_start+std::chrono::milliseconds(8));
}
close_keyboard();for(auto&[key,v]:views)close_view(*v);auto deadline=std::chrono::steady_clock::now()+std::chrono::seconds(5);while(std::chrono::steady_clock::now()<deadline){cef_do_message_loop_work();bool all=true;for(auto&[key,v]:views)all&=v->closed;if(all)break;std::this_thread::sleep_for(std::chrono::milliseconds(5));}poller.join();for(auto&[key,v]:views)if(!v->closed){std::cerr<<"Browser shutdown timed out\n";_Exit(7);}for(auto&[key,v]:views){overlays->DestroyOverlay(v->overlay);if(v->thumbnail)overlays->DestroyOverlay(v->thumbnail);glDeleteTextures(2,v->textures);}views.clear();overlays->DestroyOverlay(button);cef_shutdown();vr::VR_Shutdown();glXMakeContextCurrent(xdisplay,None,None,nullptr);glXDestroyContext(xdisplay,glcontext);glXDestroyPbuffer(xdisplay,glsurface);XCloseDisplay(xdisplay);return 0;
close_keyboard();for(auto&[key,v]:views)close_view(*v);auto deadline=std::chrono::steady_clock::now()+std::chrono::seconds(5);while(std::chrono::steady_clock::now()<deadline){cef_do_message_loop_work();bool all=true;for(auto&[key,v]:views)all&=v->closed;if(all)break;std::this_thread::sleep_for(std::chrono::milliseconds(5));}poller.join();priority_worker.join();for(auto&[key,v]:views)if(!v->closed){std::cerr<<"Browser shutdown timed out\n";_Exit(7);}for(auto&[key,v]:views){overlays->DestroyOverlay(v->overlay);if(v->thumbnail)overlays->DestroyOverlay(v->thumbnail);glDeleteTextures(2,v->textures);}views.clear();overlays->DestroyOverlay(button);icon_texture.destroy();cef_shutdown();vr::VR_Shutdown();glXMakeContextCurrent(xdisplay,None,None,nullptr);glXDestroyContext(xdisplay,glcontext);glXDestroyPbuffer(xdisplay,glsurface);XCloseDisplay(xdisplay);return 0;
}
+76
View File
@@ -0,0 +1,76 @@
{
"action_sets": [
{
"name": "/actions/entry",
"usage": "leftright"
},
{
"name": "/actions/gaze",
"usage": "single"
}
],
"actions": [
{
"name": "/actions/entry/in/primary",
"type": "boolean"
},
{
"name": "/actions/entry/in/upper",
"type": "boolean"
},
{
"name": "/actions/entry/in/aim",
"type": "pose"
},
{
"name": "/actions/entry/in/close",
"type": "boolean"
},
{
"name": "/actions/entry/in/navigate",
"type": "vector2"
},
{
"name": "/actions/gaze/in/eye",
"type": "eyetracking",
"requirement": "optional"
},
{
"name": "/actions/entry/in/confirm",
"type": "boolean"
},
{
"name": "/actions/entry/out/gazeHaptic",
"type": "vibration"
}
],
"default_bindings": [
{
"controller_type": "frame_controller",
"binding_url": "frame-controller.json"
},
{
"controller_type": "generic_hmd",
"binding_url": "generic_hmd.json"
},
{
"controller_type": "frame_hmd",
"binding_url": "frame_hmd.json"
}
],
"localization": [
{
"language_tag": "en_US",
"/actions/entry": "Framely launcher",
"/actions/entry/in/primary": "Primary trigger",
"/actions/entry/in/upper": "Upper trigger",
"/actions/entry/in/aim": "Pointer",
"/actions/entry/in/close": "Close launcher (B)",
"/actions/entry/in/navigate": "Launcher navigation",
"/actions/entry/in/confirm": "Confirm gaze target (left lower button / A)",
"/actions/entry/out/gazeHaptic": "Gaze focus feedback",
"/actions/gaze": "Framely eye tracking",
"/actions/gaze/in/eye": "Eye gaze"
}
]
}
+133
View File
@@ -0,0 +1,133 @@
{
"controller_type": "frame_controller",
"name": "Framely entry controls",
"bindings": {
"/actions/entry": {
"poses": [
{
"path": "/user/hand/left/pose/tip",
"output": "/actions/entry/in/aim"
},
{
"path": "/user/hand/right/pose/tip",
"output": "/actions/entry/in/aim"
}
],
"sources": [
{
"path": "/user/hand/left/input/trigger",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/primary"
}
},
"parameters": {
"haptic_amplitude": "0",
"click_activate_threshold": "0.5",
"click_deactivate_threshold": "0.45"
}
},
{
"path": "/user/hand/left/input/bumper",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/upper"
}
},
"parameters": {
"haptic_amplitude": "0"
}
},
{
"path": "/user/hand/right/input/trigger",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/primary"
}
},
"parameters": {
"haptic_amplitude": "0",
"click_activate_threshold": "0.5",
"click_deactivate_threshold": "0.45"
}
},
{
"path": "/user/hand/right/input/bumper",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/upper"
}
},
"parameters": {
"haptic_amplitude": "0"
}
},
{
"path": "/user/hand/right/input/b",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/close"
}
}
},
{
"path": "/user/hand/left/input/thumbstick",
"mode": "joystick",
"inputs": {
"position": {
"output": "/actions/entry/in/navigate"
}
}
},
{
"path": "/user/hand/right/input/thumbstick",
"mode": "joystick",
"inputs": {
"position": {
"output": "/actions/entry/in/navigate"
}
}
},
{
"path": "/user/hand/left/input/dpad_down",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/confirm"
}
},
"parameters": {
"haptic_amplitude": "0"
}
},
{
"path": "/user/hand/right/input/a",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/entry/in/confirm"
}
},
"parameters": {
"haptic_amplitude": "0"
}
}
],
"haptics": [
{
"path": "/user/hand/left/output/haptic",
"output": "/actions/entry/out/gazeHaptic"
},
{
"path": "/user/hand/right/output/haptic",
"output": "/actions/entry/out/gazeHaptic"
}
]
}
}
}
+14
View File
@@ -0,0 +1,14 @@
{
"controller_type": "frame_hmd",
"name": "Framely eye tracking",
"bindings": {
"/actions/gaze": {
"eyetracking": [
{
"path": "/user/head/eyetracking",
"output": "/actions/gaze/in/eye"
}
]
}
}
}
@@ -0,0 +1,21 @@
# Framely's isolated virtual Android gamepad; Xbox-compatible scan codes.
key 304 BUTTON_A
key 305 BUTTON_B
key 307 BUTTON_X
key 308 BUTTON_Y
key 310 BUTTON_L1
key 311 BUTTON_R1
key 312 BUTTON_L2
key 313 BUTTON_R2
key 314 BUTTON_SELECT
key 315 BUTTON_START
key 317 BUTTON_THUMBL
key 318 BUTTON_THUMBR
axis 0x00 X flat 1024
axis 0x01 Y flat 1024
axis 0x03 Z flat 1024
axis 0x04 RZ flat 1024
axis 0x02 LTRIGGER
axis 0x05 RTRIGGER
axis 0x10 HAT_X
axis 0x11 HAT_Y
+96
View File
@@ -0,0 +1,96 @@
{
"action_sets": [
{
"name": "/actions/framely_gamepad",
"usage": "leftright"
}
],
"actions": [
{
"name": "/actions/framely_gamepad/in/left_dpad_up",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_dpad_down",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_dpad_left",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_dpad_right",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_bumper",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_menu",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/left_thumbstick",
"type": "vector2"
},
{
"name": "/actions/framely_gamepad/in/left_trigger",
"type": "vector1"
},
{
"name": "/actions/framely_gamepad/in/left_stickclick",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_a",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_b",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_x",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_y",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_bumper",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_menu",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/in/right_thumbstick",
"type": "vector2"
},
{
"name": "/actions/framely_gamepad/in/right_trigger",
"type": "vector1"
},
{
"name": "/actions/framely_gamepad/in/right_stickclick",
"type": "boolean"
},
{
"name": "/actions/framely_gamepad/out/left_haptic",
"type": "vibration"
},
{
"name": "/actions/framely_gamepad/out/right_haptic",
"type": "vibration"
}
],
"default_bindings": [
{
"controller_type": "frame_controller",
"binding_url": "bindings.json"
}
]
}
+170
View File
@@ -0,0 +1,170 @@
{
"controller_type": "frame_controller",
"name": "Framely Android gamepad",
"bindings": {
"/actions/framely_gamepad": {
"sources": [
{
"path": "/user/hand/left/input/dpad_up",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_dpad_up"
}
}
},
{
"path": "/user/hand/left/input/dpad_down",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_dpad_down"
}
}
},
{
"path": "/user/hand/left/input/dpad_left",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_dpad_left"
}
}
},
{
"path": "/user/hand/left/input/dpad_right",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_dpad_right"
}
}
},
{
"path": "/user/hand/left/input/bumper",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_bumper"
}
}
},
{
"path": "/user/hand/left/input/view",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/left_menu"
}
}
},
{
"path": "/user/hand/left/input/thumbstick",
"mode": "joystick",
"inputs": {
"position": {
"output": "/actions/framely_gamepad/in/left_thumbstick"
},
"click": {
"output": "/actions/framely_gamepad/in/left_stickclick"
}
}
},
{
"path": "/user/hand/left/input/trigger",
"mode": "trigger",
"inputs": {
"pull": {
"output": "/actions/framely_gamepad/in/left_trigger"
}
}
},
{
"path": "/user/hand/right/input/a",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_a"
}
}
},
{
"path": "/user/hand/right/input/b",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_b"
}
}
},
{
"path": "/user/hand/right/input/x",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_x"
}
}
},
{
"path": "/user/hand/right/input/y",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_y"
}
}
},
{
"path": "/user/hand/right/input/bumper",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_bumper"
}
}
},
{
"path": "/user/hand/right/input/menu",
"mode": "button",
"inputs": {
"click": {
"output": "/actions/framely_gamepad/in/right_menu"
}
}
},
{
"path": "/user/hand/right/input/thumbstick",
"mode": "joystick",
"inputs": {
"position": {
"output": "/actions/framely_gamepad/in/right_thumbstick"
},
"click": {
"output": "/actions/framely_gamepad/in/right_stickclick"
}
}
},
{
"path": "/user/hand/right/input/trigger",
"mode": "trigger",
"inputs": {
"pull": {
"output": "/actions/framely_gamepad/in/right_trigger"
}
}
}
],
"haptics": [
{
"path": "/user/hand/left/output/haptic",
"output": "/actions/framely_gamepad/out/left_haptic"
},
{
"path": "/user/hand/right/output/haptic",
"output": "/actions/framely_gamepad/out/right_haptic"
}
]
}
}
}
+14
View File
@@ -0,0 +1,14 @@
{
"controller_type": "generic_hmd",
"name": "Framely eye tracking",
"bindings": {
"/actions/gaze": {
"eyetracking": [
{
"path": "/user/head/eyetracking",
"output": "/actions/gaze/in/eye"
}
]
}
}
}
+19
View File
@@ -0,0 +1,19 @@
#pragma once
#include <algorithm>
#include <chrono>
// Only compositor alpha animates; CEF can reuse its cached texture throughout.
struct LauncherFade {
bool reduced=false,waiting=false;float from=0,to=0;int duration=0;
std::chrono::steady_clock::time_point started{};
float value(std::chrono::steady_clock::time_point now)const{
if(waiting)return 0;
if(reduced||!duration)return to;
float t=std::clamp(std::chrono::duration<float,std::milli>(now-started).count()/duration,0.f,1.f);
float eased=to>from?1-(1-t)*(1-t)*(1-t):t*t*(3-2*t);
return from+(to-from)*eased;
}
void open(std::chrono::steady_clock::time_point now){from=0;to=1;duration=320;started=now;waiting=true;}
void ready(std::chrono::steady_clock::time_point now){if(waiting){waiting=false;started=now;}}
void close(std::chrono::steady_clock::time_point now){from=value(now);waiting=false;to=0;duration=240;started=now;}
void reset(){waiting=false;from=to=0;duration=0;}
};
+23
View File
@@ -0,0 +1,23 @@
#pragma once
#include <chrono>
#include <cmath>
#include "vendor/openvr/openvr.h"
inline bool launcher_gaze_ray(const vr::VREyeTrackingData_t& eye,vr::VROverlayIntersectionParams_t& ray){
if(!eye.bActive||!eye.bValid||!eye.bTracked)return false;
double length=0;for(int i=0;i<3;i++){if(!std::isfinite(eye.vGazeOrigin.v[i])||!std::isfinite(eye.vGazeTarget.v[i]))return false;ray.vSource.v[i]=eye.vGazeOrigin.v[i];ray.vDirection.v[i]=eye.vGazeTarget.v[i]-eye.vGazeOrigin.v[i];length+=double(ray.vDirection.v[i])*ray.vDirection.v[i];}
if(!std::isfinite(length)||length<1e-8)return false;
for(float& v:ray.vDirection.v)v/=float(std::sqrt(length));ray.eOrigin=vr::TrackingUniverseStanding;return true;
}
// Release-to-arm prevents the entry press, overlapping buttons, disconnects,
// or a mode switch while held from becoming a fresh gaze click.
struct LauncherGazePress {
bool ready=false,held=false;int owner=-1;
enum Edge {None,Down,Up,Cancel};
Edge cancel(){auto edge=held?Cancel:None;ready=false;held=false;owner=-1;return edge;}
Edge update(bool enabled,const bool (&connected)[2],const bool (&buttons)[2]){
if(!enabled|| (held&&(owner<0||!connected[owner]))){return cancel();}
if(held){if(buttons[owner])return None;held=false;owner=-1;ready=!buttons[0]&&!buttons[1];return Up;}
if(!buttons[0]&&!buttons[1]){ready=true;return None;}
if(!ready)return None;ready=false;for(int hand=0;hand<2;hand++)if(connected[hand]&&buttons[hand]){owner=hand;held=true;return Down;}return None;
}
};
+97
View File
@@ -0,0 +1,97 @@
#pragma once
#include <chrono>
#include <algorithm>
#include <cmath>
#include "openvr.h"
struct EntryTrigger {
bool held=false,ready=false;
std::chrono::steady_clock::time_point last{};
bool update(bool active,bool down,bool hit,std::chrono::steady_clock::time_point now){
if(!active){held=false;ready=false;return false;}
if(!ready){held=down;ready=true;return false;}
bool rising=down&&!held;held=down;
if(!rising||!hit||now-last<std::chrono::milliseconds(180))return false;
last=now;return true;
}
};
// Steam's laser supplies the actual tip hit and originating controller. Keep
// its point while the trigger locks the pointer, until an explicit focus leave.
struct EntryPointer {
unsigned device=~0u;bool inside=false;
void move(unsigned source,float x,float y){device=source;inside=x>=256&&x<=384&&y>=0&&y<=128;}
void leave(){device=~0u;inside=false;}
bool hit(unsigned source)const{return inside&&source!=~0u&&source==device;}
};
inline vr::HmdMatrix34_t entry_tip_pose(const vr::HmdMatrix34_t& tracked,const vr::HmdMatrix34_t& tip){
vr::HmdMatrix34_t out{};
for(int r=0;r<3;r++)for(int c=0;c<4;c++){
for(int k=0;k<3;k++)out.m[r][c]+=tracked.m[r][k]*tip.m[k][c];
if(c==3)out.m[r][c]+=tracked.m[r][3];
}
return out;
}
inline float entry_rotation_angle(const vr::HmdMatrix34_t& from,const vr::HmdMatrix34_t& to){
float trace=0;for(int r=0;r<3;r++)for(int c=0;c<3;c++)trace+=from.m[r][c]*to.m[r][c];
return std::acos(std::clamp((trace-1.f)*.5f,-1.f,1.f));
}
inline bool entry_trigger_pull(const vr::RenderModel_ComponentState_t& rest,const vr::RenderModel_ComponentState_t& full,const vr::RenderModel_ComponentState_t& current,float& pull){
float travel=entry_rotation_angle(rest.mTrackingToComponentRenderModel,full.mTrackingToComponentRenderModel);
if(!std::isfinite(travel)||travel<.001f)return false;
pull=std::clamp(entry_rotation_angle(rest.mTrackingToComponentRenderModel,current.mTrackingToComponentRenderModel)/travel,0.f,1.f);return std::isfinite(pull);
}
struct EntryAnalogTrigger {
bool held=false;
bool update(float pull){held=std::isfinite(pull)&&pull>=(held?.45f:.5f);return held;}
};
// The press that opens a modal surface must not dismiss it as an outside click.
struct LauncherDismissGuard {
std::chrono::steady_clock::time_point opened_at{};bool released=false;
void opened(std::chrono::steady_clock::time_point now){opened_at=now;released=false;}
void observe(bool held){if(!held)released=true;}
bool allows(std::chrono::steady_clock::time_point now,bool held,float event_age=0){
observe(held);
return released&&now-opened_at>=std::chrono::milliseconds(300)&&
event_age>=0&&std::chrono::duration<float>(now-opened_at).count()>=event_age;
}
};
// One axis per gesture, with a dead zone and neutral re-arm. A diagonal never
// flips a category and a page together, even if its dominant axis changes.
struct LauncherStick {
bool ready=false,latched=false;
int update(float x,float y,bool active){
if(!active||!std::isfinite(x)||!std::isfinite(y)){ready=false;latched=false;return 0;}
float strength=std::max(std::abs(x),std::abs(y));
if(strength<.3f){ready=true;latched=false;return 0;}
if(!ready||latched||strength<.65f)return 0;
latched=true;
return std::abs(x)>=std::abs(y)?(x>0?1:-1):(y>0?2:-2);
}
};
inline void launcher_rotation_vector(const vr::HmdMatrix34_t& rest,const vr::HmdMatrix34_t& value,float out[3]){
float m[3][3]{};for(int r=0;r<3;r++)for(int c=0;c<3;c++)for(int k=0;k<3;k++)m[r][c]+=rest.m[k][r]*value.m[k][c];
out[0]=m[2][1]-m[1][2];out[1]=m[0][2]-m[2][0];out[2]=m[1][0]-m[0][1];
}
inline bool launcher_stick_axes(const vr::RenderModel_ComponentState_t& rest,const vr::RenderModel_ComponentState_t& full_x,const vr::RenderModel_ComponentState_t& full_y,const vr::RenderModel_ComponentState_t& current,float& x,float& y){
float a[3],b[3],v[3];launcher_rotation_vector(rest.mTrackingToComponentRenderModel,full_x.mTrackingToComponentRenderModel,a);launcher_rotation_vector(rest.mTrackingToComponentRenderModel,full_y.mTrackingToComponentRenderModel,b);launcher_rotation_vector(rest.mTrackingToComponentRenderModel,current.mTrackingToComponentRenderModel,v);
float aa=0,ab=0,bb=0,av=0,bv=0;for(int i=0;i<3;i++){aa+=a[i]*a[i];ab+=a[i]*b[i];bb+=b[i]*b[i];av+=a[i]*v[i];bv+=b[i]*v[i];}
float det=aa*bb-ab*ab;if(det<.00001f)return false;
x=std::clamp((av*bb-bv*ab)/det,-1.f,1.f);y=std::clamp((bv*aa-av*ab)/det,-1.f,1.f);return std::isfinite(x)&&std::isfinite(y);
}
// Runtime dashboard controls are outside the app surface. Preserve their drag
// gesture and delayed modal-cancel events without swallowing later empty clicks.
struct LauncherDockGuard {
std::chrono::steady_clock::time_point until{};bool dragging=false;
void observe(bool hovered,bool held,std::chrono::steady_clock::time_point now){
if(hovered&&held)dragging=true;
if(hovered||dragging)until=now+std::chrono::milliseconds(250);
if(!held)dragging=false;
}
bool holds(std::chrono::steady_clock::time_point now)const{return dragging||now<until;}
void clear(){until={};dragging=false;}
};
+18
View File
@@ -0,0 +1,18 @@
#pragma once
#include <chrono>
#include <cmath>
// Keep the initial hit during ordinary laser jitter, including a long press.
// A deliberate move or an abandoned hold releases the lock.
struct LauncherPointer {
using Time=std::chrono::steady_clock::time_point;
bool active=false,cancelled=false;int x=0,y=0;Time pressed{};
void begin(int px,int py,Time now){active=true;cancelled=false;x=px;y=py;pressed=now;}
bool holding(Time now)const{return active&&!cancelled&&now-pressed<=std::chrono::milliseconds(2500);}
bool constrain(int& px,int& py,Time now){
if(!active)return false;
if(!holding(now)||std::hypot(float(px-x),float(py-y))>36.f)cancelled=true;
if(cancelled)return false;
px=x;py=y;return true;
}
void clear(){active=false;cancelled=false;}
};
+67
View File
@@ -0,0 +1,67 @@
#pragma once
#include <algorithm>
#include <cerrno>
#include <chrono>
#include <filesystem>
#include <fstream>
#include <iostream>
#include <map>
#include <sstream>
#include <sys/resource.h>
#include <sys/stat.h>
#include <unistd.h>
// Only the native renderer and its CEF children participate. Android, terminal
// shells and desktop applications belong to the session agent, not this tree.
class LauncherPriority {
struct Task { unsigned long long born; int nice; };
struct Process { int parent; unsigned long long born; };
std::map<int,Task> saved;
bool active=false,warned=false;
int baseline=getpriority(PRIO_PROCESS,0);
std::chrono::steady_clock::time_point scanned{};
static bool stat(int id,Process& result){
std::ifstream f("/proc/"+std::to_string(id)+"/stat");std::string line;std::getline(f,line);
auto end=line.rfind(')');if(end==std::string::npos)return false;
std::istringstream s(line.substr(end+2));std::string value;
for(int field=3;field<=22;field++){if(!(s>>value))return false;try{if(field==4)result.parent=std::stoi(value);if(field==22)result.born=std::stoull(value);}catch(...){return false;}}
return true;
}
public:
static int target(int original){return std::min(original,-5);}
void update(bool enabled){
auto now=std::chrono::steady_clock::now();if(enabled==active&&(!enabled||now-scanned<std::chrono::seconds(1)))return;
const bool continuing=active;
// Include threads born since the last scan before restoring their inherited priority.
if(!enabled&&active){scanned={};update(true);}
active=enabled;scanned=now;
if(!enabled){for(auto [id,task]:saved){Process p{};if(stat(id,p)&&p.born==task.born)setpriority(PRIO_PROCESS,id,task.nice);}saved.clear();return;}
try {
std::error_code ec;auto exe=std::filesystem::read_symlink("/proc/self/exe",ec);if(ec)return;
std::map<int,Process> processes;
for(auto& entry:std::filesystem::directory_iterator("/proc",ec)){
const auto name=entry.path().filename().string();if(name.empty()||name.find_first_not_of("0123456789")!=std::string::npos)continue;
struct ::stat info{};if(::stat(entry.path().c_str(),&info)||info.st_uid!=geteuid())continue;
if(std::filesystem::read_symlink(entry.path()/"exe",ec)!=exe){ec.clear();continue;}
Process p{};int id=std::stoi(name);if(stat(id,p))processes[id]=p;
}
for(auto [pid,process]:processes){
int parent=pid;for(int i=0;i<32&&parent!=getpid();i++){auto p=processes.find(parent);if(p==processes.end()){parent=0;break;}parent=p->second.parent;}
if(parent!=getpid())continue;
for(auto& entry:std::filesystem::directory_iterator("/proc/"+std::to_string(pid)+"/task",ec)){
int id;try{id=std::stoi(entry.path().filename().string());}catch(...){continue;}
Process p{};if(!stat(id,p))continue;
auto old=saved.find(id);if(old!=saved.end()&&old->second.born!=p.born){saved.erase(old);old=saved.end();}
if(old==saved.end()){errno=0;int nice=getpriority(PRIO_PROCESS,id);if(errno)continue;
// CEF threads created during a boost inherit it; restore the baseline.
if(continuing&&nice==target(baseline))nice=baseline;
old=saved.emplace(id,Task{p.born,nice}).first;
}
if(setpriority(PRIO_PROCESS,id,target(old->second.nice))&&!warned&&errno!=ESRCH){warned=true;std::cerr<<"Launcher CPU priority unavailable (requires service LimitNICE=25)\n";}
}
}
for(auto it=saved.begin();it!=saved.end();){Process p{};if(!stat(it->first,p)||p.born!=it->second.born)it=saved.erase(it);else++it;}
} catch(const std::filesystem::filesystem_error&) { /* Child may exit during enumeration; retry next tick. */ }
}
~LauncherPriority(){update(false);}
};
+19
View File
@@ -0,0 +1,19 @@
#pragma once
#include <algorithm>
#include <chrono>
#include <cmath>
struct PageScrollDelta {int x=0,y=0;};
// Integrate speed in logical UI pixels, independently of render scale/FPS.
struct PageScrollStick {
std::chrono::steady_clock::time_point last{};float remainder=0;int axis=0;
PageScrollDelta update(float x,float y,bool active,std::chrono::steady_clock::time_point now){
float dt=last.time_since_epoch().count()?std::clamp(std::chrono::duration<float>(now-last).count(),0.f,.05f):1.f/60;
last=now;PageScrollDelta out;
if(!active||!std::isfinite(x)||!std::isfinite(y)||std::max(std::abs(x),std::abs(y))<=.18f){remainder=0;axis=0;return out;}
int next=std::abs(y)>=std::abs(x)?2:1;if(next!=axis){remainder=0;axis=next;}
float value=axis==2?y:-x;
remainder+=std::copysign((std::min(std::abs(value),1.f)-.18f)/.82f,value)*1100.f*dt;
int pixels=int(remainder);remainder-=pixels;if(axis==2)out.y=pixels;else out.x=pixels;return out;
}
void clear(){last={};remainder=0;axis=0;}
};
+11
View File
@@ -0,0 +1,11 @@
#pragma once
#include "include/capi/cef_frame_capi.h"
#include "native_scroll_script.h"
// Run in every newly loaded frame; no network request, SDK or bridge required.
inline void inject_page_scroll(cef_frame_t* frame){
if(!frame||!frame->is_valid(frame))return;
cef_string_t script{},source{};
cef_string_utf8_to_utf16(native_scroll_script,sizeof(native_scroll_script)-1,&script);
frame->execute_java_script(frame,&script,&source,1);
cef_string_utf16_clear(&script);
}
+32
View File
@@ -0,0 +1,32 @@
#pragma once
#include <algorithm>
#include <cstdint>
#include <vector>
// Each alternating GPU texture retains its own pending damage until uploaded.
// Coordinates match the vertically flipped CPU buffer, not CEF's top-left view.
struct PaintDamage {
int x=0,y=0,width=0,height=0;
bool empty() const{return width<=0||height<=0;}
void clear(){*this={};}
void include(int left,int top,int right,int bottom){
if(right<=left||bottom<=top)return;
if(!empty()){right=std::max(right,x+width);bottom=std::max(bottom,y+height);left=std::min(left,x);top=std::min(top,y);}
x=left;y=top;width=right-left;height=bottom-top;
}
template<class Rect> void add(int w,int h,size_t count,const Rect* rects){
if(!count||!rects){include(0,0,w,h);return;}
for(size_t i=0;i<count;i++){
const auto& r=rects[i];const int left=std::clamp(r.x,0,w),top=std::clamp(r.y,0,h);
const int right=int(std::clamp<long long>(static_cast<long long>(r.x)+r.width,0,w)),bottom=int(std::clamp<long long>(static_cast<long long>(r.y)+r.height,0,h));
if(right>left&&bottom>top)include(left,h-bottom,right,h-top);
}
}
};
// CEF dirty rectangles use physical pixels. Preserve unchanged pixels between
// paints, and flip only the copied rows for OpenVR's bottom-left texture origin.
template<class Rect> inline void merge_paint(std::vector<uint8_t>& pixels,const void* buffer,int width,int height,size_t count,const Rect* dirty,bool flip=false){
const size_t bytes=size_t(width)*height*4;const auto* source=static_cast<const uint8_t*>(buffer);
auto copy=[&](int left,int top,int right,int bottom){for(int y=top;y<bottom;y++)std::copy_n(source+(size_t(y)*width+left)*4,size_t(right-left)*4,pixels.data()+(size_t(flip?height-1-y:y)*width+left)*4);};
if(pixels.size()!=bytes||!count||!dirty){pixels.resize(bytes);copy(0,0,width,height);return;}
for(size_t i=0;i<count;i++){const auto& r=dirty[i];int left=std::clamp(r.x,0,width),top=std::clamp(r.y,0,height),right=int(std::clamp<long long>(static_cast<long long>(r.x)+r.width,0,width)),bottom=int(std::clamp<long long>(static_cast<long long>(r.y)+r.height,0,height));if(right>left&&bottom>top)copy(left,top,right,bottom);}
}
+4
View File
@@ -19,3 +19,7 @@ inline bool allow_plugin_navigation(const std::string& url, const std::string& o
}
return port > 0;
}
inline bool manager_navigation_page(const std::string& page) {
return page=="installed"||page=="catalog"||page=="sources"||page=="notification-settings"||page=="settings"||page=="launcher-settings"||page=="updates"||page=="about"||page=="terminal"||page=="files"||page=="apk"||page=="apk-containers"||page=="apk-cleanup"||page=="apk-settings";
}
+1 -1
View File
@@ -1,6 +1,6 @@
#pragma once
// CEF view/input coordinates stay in DIP; only the paint buffer uses this scale.
inline int render_screen_info(cef_screen_info_t* info,int width,int height,int scale){
inline int render_screen_info(cef_screen_info_t* info,int width,int height,float scale){
info->size=sizeof(*info);info->device_scale_factor=float(scale);info->depth=32;info->depth_per_component=8;info->is_monochrome=0;
info->rect={0,0,width,height};info->available_rect=info->rect;return 1;
}
+3
View File
@@ -0,0 +1,3 @@
#pragma once
// Cap CEF painting independently of headset refresh to limit pixel readback.
inline constexpr int browser_frame_rate(float = 0){return 60;}
+52
View File
@@ -0,0 +1,52 @@
#pragma once
#include <cstdint>
#include <cstdlib>
#include <dlfcn.h>
#include <string>
#include <iostream>
// Load Steam's installed SDL/audio assets; no Steam sounds are redistributed.
// Only the native UI thread owns these streams. Playback queues cached PCM and
// never spawns a process or reads files on a hover/click.
class SteamUiSounds {
struct Spec { int format, channels, freq; };
struct Clip { void* stream=nullptr; uint8_t* data=nullptr; uint32_t size=0; } clips[2];
void* library=nullptr;
bool initialized=false;
bool (*init)(uint32_t)=nullptr;
void (*quit)(uint32_t)=nullptr;
bool (*load)(const char*,Spec*,uint8_t**,uint32_t*)=nullptr;
void* (*open)(uint32_t,const Spec*,void*,void*)=nullptr;
bool (*resume)(void*)=nullptr;
bool (*put)(void*,const void*,int)=nullptr;
bool (*clear)(void*)=nullptr;
bool (*gain)(void*,float)=nullptr;
void (*destroy)(void*)=nullptr;
void (*release)(void*)=nullptr;
template<class T> bool bind(T& fn,const char* name){fn=reinterpret_cast<T>(dlsym(library,name));return fn!=nullptr;}
public:
SteamUiSounds()=default;
SteamUiSounds(const SteamUiSounds&)=delete;
~SteamUiSounds(){shutdown();}
void shutdown(){
for(auto& clip:clips){if(clip.stream&&destroy)destroy(clip.stream);if(clip.data&&release)release(clip.data);clip={};}
if(initialized&&quit)quit(0x10);initialized=false;
if(library)dlclose(library);library=nullptr;
}
bool prepare(const std::string& root){
if(root.empty())return false;
for(const auto* name:{"steamrtarm64/libSDL3.so.0","steamrt64/libSDL3.so.0"}){library=dlopen((root+"/"+name).c_str(),RTLD_NOW|RTLD_LOCAL);if(library)break;}
if(!library)return false;
if(!(bind(init,"SDL_InitSubSystem")&&bind(quit,"SDL_QuitSubSystem")&&bind(load,"SDL_LoadWAV")&&bind(open,"SDL_OpenAudioDeviceStream")&&bind(resume,"SDL_ResumeAudioStreamDevice")&&bind(put,"SDL_PutAudioStreamData")&&bind(clear,"SDL_ClearAudioStream")&&bind(gain,"SDL_SetAudioStreamGain")&&bind(destroy,"SDL_DestroyAudioStream")&&bind(release,"SDL_free"))){shutdown();return false;}
if(!init(0x10)){shutdown();return false;}initialized=true;
const char* names[]={"deck_ui_typing.wav","deck_ui_typing.wav"};
for(int i=0;i<2;++i){Spec spec{};auto& clip=clips[i];
if(!load((root+"/steamui/sounds/"+names[i]).c_str(),&spec,&clip.data,&clip.size)||!clip.size||clip.size>1024*1024){shutdown();return false;}
clip.stream=open(0xffffffffu,&spec,nullptr,nullptr);
if(!clip.stream||!gain(clip.stream,i==0?.30f:.45f)||!resume(clip.stream)){shutdown();return false;}
}
return true;
}
void silence(){if(!initialized)return;for(auto& clip:clips)clear(clip.stream);}
void play(bool activation=false){if(!initialized)return;silence();auto& clip=clips[activation?1:0];put(clip.stream,clip.data,int(clip.size));}
};
+17
View File
@@ -13,6 +13,8 @@
],
"dependencies": {
"@tabler/icons-react": "3.48.0",
"@xterm/addon-fit": "0.11.0",
"@xterm/xterm": "6.0.0",
"react": "19.2.0",
"react-dom": "19.2.0"
},
@@ -760,6 +762,21 @@
"@types/react": "^19.2.0"
}
},
"node_modules/@xterm/addon-fit": {
"version": "0.11.0",
"resolved": "https://registry.npmjs.org/@xterm/addon-fit/-/addon-fit-0.11.0.tgz",
"integrity": "sha512-jYcgT6xtVYhnhgxh3QgYDnnNMYTcf8ElbxxFzX0IZo+vabQqSPAjC3c1wJrKB5E19VwQei89QCiZZP86DCPF7g==",
"license": "MIT"
},
"node_modules/@xterm/xterm": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/@xterm/xterm/-/xterm-6.0.0.tgz",
"integrity": "sha512-TQwDdQGtwwDt+2cgKDLn0IRaSxYu1tSUjgKarSDkUM0ZNiSRXFpjxEsvc/Zgc5kq5omJ+V0a8/kIM2WD3sMOYg==",
"license": "MIT",
"workspaces": [
"addons/*"
]
},
"node_modules/csstype": {
"version": "3.2.3",
"resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz",
+2
View File
@@ -16,6 +16,8 @@
},
"dependencies": {
"@tabler/icons-react": "3.48.0",
"@xterm/addon-fit": "0.11.0",
"@xterm/xterm": "6.0.0",
"react": "19.2.0",
"react-dom": "19.2.0"
},
+20
View File
@@ -146,6 +146,24 @@ rollback_on_failure() {
}
trap rollback_on_failure ERR
systemctl stop framely-session.service framely.service 2>/dev/null || true
# Clear the uninstall guard retained by older releases only for a clean reinstall.
# Existing installations, repairs and incomplete plugin cleanup retain safe mode.
if ! $repair && [[ -z $old && -f $root/state.json ]]; then
python3 - "$root/state.json" <<'PY_REINSTALL'
import json, os, pathlib, sys
path = pathlib.Path(sys.argv[1])
state = json.loads(path.read_text())
if state.get('safeMode') is True and state.get('plugins') == {}:
state['safeMode'] = False
temporary = path.with_name('state.json.reinstall')
with temporary.open('w') as output:
os.chmod(temporary, 0o600)
json.dump(state, output, ensure_ascii=False)
output.flush()
os.fsync(output.fileno())
os.replace(temporary, path)
PY_REINSTALL
fi
ln -s "releases/$version" "$root/current.new"
mv -Tf "$root/current.new" "$root/current"
cat > /etc/systemd/system/framely.service <<EOF
@@ -182,6 +200,8 @@ ExecStart=$root/current/bin/framely session --state $root --assets $root/current
Restart=on-failure
RestartSec=5
KillMode=control-group
# Allow a bounded, reversible UI-only boost; no realtime scheduling.
LimitNICE=25
TimeoutStopSec=10
[Install]
WantedBy=multi-user.target
+1 -1
View File
@@ -12,6 +12,6 @@ installKeyboard(params=>request('keyboard',params));
window.addEventListener('pagehide',()=>{for(const p of pending.values()){clearTimeout(p.timer);p.reject(new Error('Plugin page closed'));}pending.clear();});
installHoverFeedback(()=>{void request('haptic').catch(console.error);});
installHoverFeedback(feedback=>{void request('haptic',{feedback}).catch(console.error);});
installScrollbars();
+3 -2
View File
@@ -1,5 +1,5 @@
// Shared by the host page and isolated plugin frames.
export function installHoverFeedback(pulse:()=>void){
export function installHoverFeedback(pulse:(kind:'hover'|'activate')=>void){
let hovered:Element|null=null;
function interactive(target:EventTarget|null):Element|null{
const element=target instanceof Element?target:null;
@@ -14,8 +14,9 @@ export function installHoverFeedback(pulse:()=>void){
}
return pointer;
}
function enter(e:Event){const next=interactive(e.target);if(next!==hovered){hovered=next;if(next)pulse();}}
function enter(e:Event){const next=interactive(e.target);if(next!==hovered){hovered=next;if(next)pulse('hover');}}
document.addEventListener('pointerover',enter);
document.addEventListener('click',e=>{if(interactive(e.target))pulse('activate');});
document.addEventListener('pointerout',e=>{if(interactive(e.relatedTarget)!==hovered)hovered=null;});
window.addEventListener('blur',()=>{hovered=null;});
}
+3 -1
View File
@@ -1,3 +1,5 @@
export * from './launcher';
import {launchContext} from './launcher';
export * from './visibility';
import {createVisibilityApi, type UiVisibility} from './visibility';
export * from './lifecycle';
@@ -9,7 +11,7 @@ export interface Notification {id:string;title:string;body:string;image?:string;
type Bridge={request:(op:string,p?:unknown)=>Promise<any>;subscribe:(f:(e:unknown)=>void)=>()=>void};
function bridge():Bridge{const b=(window as any).__framelyBridge;if(!b)throw new Error('This page requires the Framely plugin host');return b;}
export const framely={
ui:{...createVisibilityApi(bridge),close:():Promise<unknown>=>bridge().request('ui.close')},
ui:{launchContext,...createVisibilityApi(bridge),close:():Promise<unknown>=>bridge().request('ui.close')},
language:{get:():Promise<{preference:string;language:string}>=>bridge().request('language.get')},
call:<T=unknown>(method:string,params:unknown={}):Promise<T>=>bridge().request('call',{method,params}),
windows:{open:(window:string)=>bridge().request('window.open',{window}),close:(window:string)=>bridge().request('window.close',{window})},
+9
View File
@@ -0,0 +1,9 @@
export interface LaunchContext {source:'launcher'|'quickPanel'|'manager';trigger:'shortPress'|'menuAction';actionId?:string}
type Bridge={request:(op:string,p?:unknown)=>Promise<any>;subscribe:(f:(e:any)=>void)=>()=>void};
function bridge():Bridge{const b=(window as any).__framelyBridge;if(!b)throw new Error('This script requires the Framely plugin host');return b;}
export const launchContext={get:():Promise<LaunchContext>=>bridge().request('ui.launchContext'),onChanged:(callback:(context:LaunchContext)=>void)=>bridge().subscribe(e=>{if(e.type==='ui.launch')callback(e.data);})};
/** Register callbacks in a separate bundle named by a frontend launcher action. */
export function registerLauncherActions(actions:Record<string,(context:LaunchContext)=>unknown|Promise<unknown>>){
let busy=false;const off=bridge().subscribe(async e=>{if(e.type!=='launcher.action'||busy)return;busy=true;try{const context=e.data as LaunchContext;const action=actions[context.actionId??''];if(!action)throw new Error('Launcher action handler not registered');await action(context);await bridge().request('launcher.done');}catch(error){await bridge().request('launcher.done',{error:String(error)});}finally{busy=false;}});
void bridge().request('launcher.ready').catch(console.error);window.addEventListener('pagehide',off,{once:true});return off;
}
+4
View File
@@ -0,0 +1,4 @@
// Embedded into the native host, including localWeb and nested plugin frames.
// Shares the document guard with the SDK bootstrap to avoid duplicate gestures.
import {installScrollGestures} from './scroll-gestures';
installScrollGestures();
+37
View File
@@ -0,0 +1,37 @@
// Installed by the host bootstrap as well as the manager; old plugins benefit
// without rebuilding their own SDK. The launcher owns its separate gestures.
export function installScrollGestures(){
if((document as any).__framelyScrollGestures)return;
(document as any).__framelyScrollGestures=true;
type Drag={id:number;x:number;y:number;last:number;nodes:HTMLElement[];active:boolean;styles:string[]};
let drag:Drag|null=null,suppressClick=false,timer:ReturnType<typeof setTimeout>|null=null;
const clear=()=>{if(drag?.active){drag.nodes.forEach((n,i)=>n.style.scrollBehavior=drag!.styles[i]);try{drag.nodes[0].releasePointerCapture(drag.id);}catch{}}drag=null;};
const cancel=()=>{clear();suppressClick=false;if(timer)clearTimeout(timer);timer=null;};
const scroll=(dy:number)=>{if(!drag)return;for(const node of drag.nodes){const before=node.scrollTop;node.scrollTop+=dy;dy-=node.scrollTop-before;if(Math.abs(dy)<.5)break;}};
document.addEventListener('pointerdown',e=>{
cancel();if(e.button!==0||document.documentElement.classList.contains('launcher-view'))return;
const target=e.target instanceof Element?e.target:null;
if(!target||target.closest('input,textarea,select,[contenteditable]:not([contenteditable="false"]),[role=slider],[draggable=true],[data-framely-no-scroll-drag]'))return;
const nodes:HTMLElement[]=[];
for(let n:Element|null=target;n;n=n.parentElement){if(n instanceof HTMLElement&&n.scrollHeight>n.clientHeight+1&&/auto|scroll/.test(getComputedStyle(n).overflowY))nodes.push(n);}
const root=document.scrollingElement;if(root instanceof HTMLElement&&root.scrollHeight>root.clientHeight+1&&!nodes.includes(root))nodes.push(root);
if(nodes.length)drag={id:e.pointerId,x:e.clientX,y:e.clientY,last:e.clientY,nodes,active:false,styles:nodes.map(n=>n.style.scrollBehavior)};
},true);
document.addEventListener('pointermove',e=>{
if(!drag||e.pointerId!==drag.id)return;
if(!e.buttons){clear();return;}
const dy=e.clientY-drag.y,dx=e.clientX-drag.x;
if(!drag.active){if(Math.abs(dy)<20||Math.abs(dy)<Math.abs(dx)*1.25)return;drag.active=true;suppressClick=true;drag.nodes.forEach(n=>n.style.scrollBehavior='auto');try{drag.nodes[0].setPointerCapture(e.pointerId);}catch{}window.getSelection()?.removeAllRanges();}
e.preventDefault();e.stopImmediatePropagation();scroll(drag.last-e.clientY);drag.last=e.clientY;
},{capture:true,passive:false});
document.addEventListener('pointerup',e=>{
if(!drag||e.pointerId!==drag.id)return;
if(drag.active){e.preventDefault();e.stopImmediatePropagation();scroll(drag.last-e.clientY);timer=setTimeout(()=>{suppressClick=false;timer=null;},200);}
clear();
},true);
document.addEventListener('click',e=>{if(suppressClick){e.preventDefault();e.stopImmediatePropagation();suppressClick=false;if(timer)clearTimeout(timer);timer=null;}},true);
document.addEventListener('pointercancel',cancel,true);
document.addEventListener('lostpointercapture',()=>{if(drag?.active)clear();},true);
window.addEventListener('blur',cancel);window.addEventListener('pagehide',cancel);
document.addEventListener('visibilitychange',()=>{if(document.hidden)cancel();});
}
+2
View File
@@ -1,5 +1,7 @@
import {installScrollGestures} from './scroll-gestures';
// Shared by the manager and host bootstrap, including already-installed plugins.
export function installScrollbars(){
installScrollGestures();
if(document.getElementById('framely-scrollbars'))return;
const style=document.createElement('style');style.id='framely-scrollbars';
style.textContent=`
+5902
View File
File diff suppressed because it is too large. Load diff
+199
View File
@@ -0,0 +1,199 @@
//! Delete only storage and runtime objects attributed to one APK context.
use super::*;
use std::collections::BTreeSet;
fn absent(error: &std::io::Error) -> bool {
error.kind() == std::io::ErrorKind::NotFound
}
fn directory(path: &Path) -> Result<()> {
match fs::symlink_metadata(path) {
Ok(m) => ensure!(
m.is_dir() && m.uid() == unsafe { libc::geteuid() },
"Invalid cleanup directory"
),
Err(e) if absent(&e) => {}
Err(e) => return Err(e.into()),
}
Ok(())
}
fn remove_owned(path: &Path) -> Result<()> {
match fs::symlink_metadata(path) {
Ok(m) => {
ensure!(
m.uid() == unsafe { libc::geteuid() },
"Cleanup file belongs to another user"
);
remove_tree(path)?;
}
Err(e) if absent(&e) => {}
Err(e) => return Err(e.into()),
}
Ok(())
}
fn runtime(name: &str, baked: &Path, original: bool) -> Result<Option<String>> {
ensure!(safe(name), "Invalid container name");
let result = crate::process::command_output_timeout(
crate::process::tool("podman").args([
"inspect",
"--format",
"{{.Id}}|{{ index .Config.Labels \"STEAM_COMPAT_DATA_PATH\" }}|{{json .Mounts}}",
&format!("lepton-{name}"),
]),
Duration::from_secs(10),
true,
)?;
if !result.status.success() {
let error = String::from_utf8_lossy(&result.stderr).to_lowercase();
ensure!(
error.contains("no such") || error.contains("does not exist"),
"Cannot verify container ownership"
);
return Ok(None);
}
let text = String::from_utf8(result.stdout)?;
let mut fields = text.trim().splitn(3, '|');
let id = fields.next().context("Unknown container identity")?;
let location = fields
.next()
.context("Invalid container ownership response")?;
let mounts = fields.next().context("Missing container mounts")?;
ensure!(!id.is_empty(), "Unknown container identity");
if location.is_empty() || location == "<no value>" {
// Older direct runtimes have no compatdata label. Verify their actual
// Android data mount as well as the unambiguous original name.
ensure!(original, "Cannot verify Steam container storage");
let mounts: Vec<Value> = serde_json::from_str(mounts)?;
ensure!(
mounts.iter().any(|m| m["Destination"] == "/data"
&& m["Source"]
.as_str()
.is_some_and(|p| fs::canonicalize(p).is_ok_and(|p| p.starts_with(baked)))),
"Container data mount belongs to another location"
);
} else {
ensure!(
fs::canonicalize(Path::new(location).join("baked"))? == baked,
"Container belongs to another data location"
);
}
Ok(Some(id.to_owned()))
}
pub(super) fn delete(home: &Path, db: &mut Database, c: &Container, log: &Path) -> Result<()> {
let records: Vec<_> = db
.records
.values()
.filter(|r| r.context == c.id)
.cloned()
.collect();
let steam = root(home).join("steam");
directory(&steam)?;
directory(&steam.join("leases"))?;
for rec in &records {
let lease = steam.join("leases").join(format!("{}.json", hash(&rec.id)));
if let Ok(m) = fs::symlink_metadata(&lease) {
if m.is_file() {
ensure!(
m.len() <= 8192 && m.uid() == unsafe { libc::geteuid() },
"Invalid Steam lease file"
);
let value: Value = serde_json::from_slice(&fs::read(&lease)?)?;
ensure!(
value["app"] == rec.id,
"Steam lease belongs to another application"
);
}
}
}
let original = if c.id.starts_with("external-") {
db.root_contexts
.get(&c.baked)
.cloned()
.unwrap_or_else(|| c.name.clone())
} else {
c.id.clone()
};
let standard = home.join(".local/share/lepton/contexts").join(&c.id);
let default_location = !c.id.starts_with("external-")
&& !fs::symlink_metadata(&standard).is_ok_and(|m| m.file_type().is_symlink())
&& fs::canonicalize(&standard).is_ok_and(|p| p == standard && p.join("baked") == c.baked);
let target = if default_location {
standard
} else {
c.baked.clone()
};
let mut names = BTreeSet::from([original.clone(), c.name.clone()]);
names.extend(records.iter().filter_map(native::runtime_name));
// Resolve every name before stopping anything. A recycled Steam App ID
// pointing at different storage must never be removed.
let mut runtimes = Vec::new();
for name in names {
if let Some(id) = runtime(&name, &c.baked, name == original)? {
runtimes.push((name, id));
}
}
for (name, _) in &runtimes {
let mut owned = c.clone();
owned.name = name.clone();
stop(&owned, log)?;
}
fs::create_dir_all(&steam)?;
let ownership = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.custom_flags(libc::O_NOFOLLOW)
.mode(0o600)
.open(steam.join(format!("context-{}.lock", hash(&c.id))))?;
let deadline = Instant::now() + Duration::from_secs(5);
while unsafe { libc::flock(ownership.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } != 0 {
ensure!(
Instant::now() < deadline,
"Steam launch still owns this container; wait for it to close and retry"
);
std::thread::sleep(Duration::from_millis(100));
}
for rec in &records {
steam_shortcuts::unregister(home, rec)?;
}
ensure!(
validate_baked(&c.baked)? == c.baked,
"Container data location changed"
);
for (name, identity) in &runtimes {
if let Some(current) = runtime(name, &c.baked, *name == original)? {
ensure!(
current == *identity && !running(name),
"Container changed during deletion"
);
podman(&["rm", identity], Some(log))?;
}
}
let mut keys = BTreeSet::from([hash(&c.id)]);
for rec in &records {
let key = hash(&rec.id);
keys.insert(key.clone());
remove_owned(&root(home).join("apks").join(&key))?;
remove_owned(&steam.join(format!("native-{key}.sh")))?;
let lease = steam.join("leases").join(format!("{key}.json"));
remove_owned(&lease)?;
}
for entry in fs::read_dir(root(home).join("logs"))? {
let entry = entry?;
let name = entry.file_name().to_string_lossy().into_owned();
if entry.path() != log
&& name.ends_with(".log")
&& keys.iter().any(|key| name.starts_with(&format!("{key}-")))
{
remove_owned(&entry.path())?;
}
}
remove_tree(&target)?;
db.roots.retain(|p| p != &c.baked);
db.root_contexts.remove(&c.baked);
db.records.retain(|_, r| r.context != c.id);
db.owned_contexts.retain(|id| id != &c.id);
save(home, db)?;
// Keep the context lock inode: unlinking it can split mutual exclusion.
Ok(())
}
+549
View File
@@ -0,0 +1,549 @@
//! Session-only lifecycle monitoring; never touches package or application data.
use super::*;
use std::collections::{BTreeMap, BTreeSet};
use std::sync::OnceLock;
#[derive(Clone)]
pub(super) struct Sample {
pub(super) instance: String,
pub(super) package: String,
window: Option<bool>,
pub(super) alive: BTreeSet<String>,
}
#[derive(Default)]
struct Watch {
instance: String,
package: String,
visible: bool,
seen: bool,
absent: Option<Instant>,
closed: Option<Instant>,
}
#[derive(Clone, Copy, Debug, PartialEq)]
enum Reason {
WindowClosed,
AppExited,
}
impl Watch {
fn observe(
&mut self,
s: &Sample,
now: Instant,
automatic: bool,
close: bool,
) -> Option<Reason> {
if self.instance != s.instance || self.package != s.package {
*self = Self {
instance: s.instance.clone(),
package: s.package.clone(),
..Self::default()
};
}
if s.window == Some(true) {
self.visible = true;
self.closed = None;
} else if s.window == Some(false) && self.visible {
self.closed.get_or_insert(now);
} else if s.window.is_none() {
self.closed = None;
}
if s.alive.contains(&s.package) {
self.seen = true;
self.absent = None;
} else if self.seen && automatic {
self.absent.get_or_insert(now);
} else {
self.absent = None;
}
// A full-display window may represent an old shared context. Protect its other apps.
if s.alive.iter().any(|p| p != &s.package) {
self.absent = None;
return None;
}
if close
&& self
.closed
.is_some_and(|t| now.saturating_duration_since(t) >= Duration::from_secs(1))
{
return Some(Reason::WindowClosed);
}
if automatic
&& self
.absent
.is_some_and(|t| now.saturating_duration_since(t) >= Duration::from_secs(15))
{
return Some(Reason::AppExited);
}
None
}
fn pause(&mut self) {
self.absent = None;
self.closed = None;
}
}
const PROBE: &str = r#"
printf 'FRAMELY_ACTIVE='; getprop lepton.active_app_id
printf 'FRAMELY_WINDOW='; getprop waydroid.active_apps
printf 'FRAMELY_PROCESSES\n'
dumpsys activity processes || exit 1
printf '\nFRAMELY_LIFECYCLE_DONE\n'
"#;
fn short(args: &[&str]) -> Result<String> {
let mut cmd = crate::process::tool("podman");
cmd.args(args);
output(cmd, Duration::from_secs(3), None)
}
fn instance(c: &Container) -> Result<String> {
let text = short(&[
"inspect",
"--format",
"{{.Id}}|{{.State.StartedAt}}|{{.State.Running}}",
&format!("lepton-{}", c.name),
])?;
let text = text.trim();
ensure!(
text.ends_with("|true") && text.split('|').count() == 3,
"Container unavailable"
);
Ok(text.into())
}
fn packages(c: &Container) -> Result<BTreeSet<String>> {
let xml = fs::read_to_string(c.baked.join("data_overlay/system/packages.xml"))?;
ensure!(
xml.len() <= 16 * 1024 * 1024 && xml.contains("<packages"),
"Unknown package database"
);
let mut out = BTreeSet::new();
for tag in xml.split('<').filter(|t| t.starts_with("package ")) {
if let (Some(p), Some(path)) = (attr(tag, "name"), attr(tag, "codePath")) {
if apk_metadata::valid_package(p) && path.starts_with("/data/") {
out.insert(p.into());
}
}
}
ensure!(!out.is_empty(), "No known application packages");
Ok(out)
}
pub(super) fn idle_instance(c: &Container) -> Result<String> {
let identity = instance(c)?;
let known = packages(c)?;
let text = short(&[
"exec",
&format!("lepton-{}", c.name),
"sh",
"-c",
"dumpsys activity processes || exit 1; printf '\\nFRAMELY_IDLE_DONE\\n'",
"framely-lifecycle-idle",
])?;
ensure!(
text.starts_with("ACTIVITY MANAGER RUNNING PROCESSES")
&& text.ends_with("FRAMELY_IDLE_DONE\n"),
"Cannot verify whether applications are running"
);
ensure!(
!known.iter().any(|p| gamepad_present(&text, p)),
"An application is still running in this container; close it before Steam launch"
);
ensure!(instance(c)? == identity, "Container changed during launch");
Ok(identity)
}
pub(super) fn sample(c: &Container) -> Result<Sample> {
let identity = instance(c)?;
let text = short(&[
"exec",
&format!("lepton-{}", c.name),
"sh",
"-c",
PROBE,
"framely-lifecycle",
])?;
ensure!(
text.ends_with("FRAMELY_LIFECYCLE_DONE\n"),
"Incomplete lifecycle response"
);
let (props, processes) = text
.split_once("FRAMELY_PROCESSES\n")
.context("Unknown lifecycle response")?;
ensure!(
processes.starts_with("ACTIVITY MANAGER RUNNING PROCESSES"),
"Unknown process response"
);
let package = props
.lines()
.find_map(|l| l.strip_prefix("FRAMELY_ACTIVE="))
.context("Missing active package")?
.trim()
.to_owned();
ensure!(
apk_metadata::valid_package(&package),
"Unknown active package"
);
let window = match props
.lines()
.find_map(|l| l.strip_prefix("FRAMELY_WINDOW="))
{
Some("Waydroid") => Some(true),
Some("none") => Some(false),
_ => None,
};
let packages = packages(c)?;
ensure!(
packages.contains(&package),
"Active package missing from package database"
);
let alive = packages
.into_iter()
.filter(|p| gamepad_present(processes, p))
.collect();
// A restart during the query must not inherit the old absence/close observation.
ensure!(
instance(c)? == identity,
"Container changed while monitoring"
);
Ok(Sample {
instance: identity,
package,
window,
alive,
})
}
fn candidates(home: &Path, db: &Database) -> Vec<Container> {
let contexts: BTreeSet<_> = db
.records
.values()
.filter(|r| !r.removed)
.map(|r| r.context.clone())
.collect();
let base = home.join(".local/share/lepton/contexts");
let mut out = Vec::new();
for id in contexts {
if !safe(&id) || id.starts_with("steamlaunch-") {
continue;
}
let mut name = id.clone();
let mut baked = base.join(&id).join("baked");
if id.starts_with("external-") {
let Some(path) = db
.roots
.iter()
.find(|p| format!("external-{}", hash(&p.to_string_lossy())) == id)
else {
continue;
};
baked = path.clone();
name = db
.root_contexts
.get(path)
.cloned()
.or_else(|| path.parent()?.file_name()?.to_str().map(str::to_owned))
.unwrap_or_default();
}
if !safe(&name) || name.starts_with("steamlaunch-") {
continue;
}
let Ok(baked) = validate_baked(&baked) else {
continue;
};
out.push(Container {
id,
managed: db.owned_contexts.contains(&name),
name,
baked,
running: true,
steam: false,
});
}
let mut counts = BTreeMap::new();
for c in &out {
*counts.entry(c.name.clone()).or_insert(0) += 1;
}
out.retain(|c| counts[&c.name] == 1);
out
}
struct LaunchMark {
instance: String,
package: String,
flat: bool,
}
static LAUNCHES: Mutex<BTreeMap<String, LaunchMark>> = Mutex::new(BTreeMap::new());
pub(super) fn launched(c: &Container, a: &App) {
if let Ok(instance) = instance(c) {
LAUNCHES.lock().unwrap().insert(
c.name.clone(),
LaunchMark {
instance,
package: a.metadata.package.clone(),
flat: a.show_window.unwrap_or(!a.metadata.vr),
},
);
}
}
#[derive(Default)]
pub(super) struct Monitor {
watches: BTreeMap<String, Watch>,
}
impl Monitor {
pub(super) fn tick(&mut self, home: &Path, now: Instant) -> Result<()> {
if MUTATION.try_lock().is_err() {
for w in self.watches.values_mut() {
w.pause();
}
return Ok(());
}
let db = load(home)?;
if !db.auto_stop_container && !db.stop_container_on_close {
self.watches.clear();
return Ok(());
}
let mut cs = candidates(home, &db);
let known: BTreeSet<_> = cs.iter().map(|c| c.name.clone()).collect();
LAUNCHES.lock().unwrap().retain(|n, _| known.contains(n));
let Ok(running) = short(&["ps", "--format", "{{.Names}}|{{.Pid}}"]) else {
self.watches.clear();
return Ok(());
};
let running: BTreeSet<_> = running
.lines()
.filter_map(|row| {
let (name, pid) = row.split_once('|')?;
runtime_pid_alive(pid)
.then(|| name.strip_prefix("lepton-"))
.flatten()
})
.collect();
cs.retain(|c| running.contains(c.name.as_str()));
let names: BTreeSet<_> = cs.iter().map(|c| c.name.clone()).collect();
self.watches.retain(|n, _| names.contains(n));
for c in cs {
if db
.records
.values()
.any(|r| r.context == c.id && r.pending.is_some())
{
self.watches.remove(&c.name);
continue;
}
let Ok(s) = sample(&c) else {
self.watches.remove(&c.name);
continue;
};
if !db
.records
.values()
.any(|r| r.context == c.id && !r.removed && r.metadata.package == s.package)
{
self.watches.remove(&c.name);
continue;
}
let w = self.watches.entry(c.name.clone()).or_default();
if let Some(mark) = LAUNCHES.lock().unwrap().remove(&c.name) {
if mark.instance == s.instance && mark.package == s.package {
*w = Watch {
instance: mark.instance,
package: mark.package,
visible: mark.flat,
seen: true,
..Watch::default()
};
}
}
let Some(reason) =
w.observe(&s, now, db.auto_stop_container, db.stop_container_on_close)
else {
continue;
};
// Match mutation exclusion in operate(), including other Framely CLI processes.
let Ok(_guard) = MUTATION.try_lock() else {
w.pause();
continue;
};
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(root(home).join("operation.lock"))?;
if unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } != 0 {
w.pause();
continue;
}
let latest = load(home)?;
if (reason == Reason::AppExited && !latest.auto_stop_container)
|| (reason == Reason::WindowClosed && !latest.stop_container_on_close)
{
w.pause();
continue;
}
if latest
.records
.values()
.any(|r| r.context == c.id && r.pending.is_some())
|| !latest
.records
.values()
.any(|r| r.context == c.id && !r.removed && r.metadata.package == s.package)
{
w.pause();
continue;
}
let Ok(fresh) = sample(&c) else {
w.pause();
continue;
};
if fresh.instance != s.instance
|| fresh.package != s.package
|| fresh.alive.iter().any(|p| p != &s.package)
|| (reason == Reason::WindowClosed && fresh.window != Some(false))
|| (reason == Reason::AppExited && !fresh.alive.is_empty())
{
w.pause();
continue;
}
let log = root(home).join("logs").join(format!(
"{}-lifecycle-{}.log",
hash(&c.id),
now_secs()
));
fs::write(&log, format!("Stopping container: {reason:?}\n"))?;
if let Err(e) = stop(&c, &log) {
eprintln!("APK lifecycle stop failed for {}: {e:#}", c.name);
}
self.watches.remove(&c.name);
}
Ok(())
}
}
fn now_secs() -> u64 {
super::now()
}
static STARTED: OnceLock<()> = OnceLock::new();
pub(super) fn start() {
STARTED.get_or_init(|| {
std::thread::spawn(|| {
let mut monitor = Monitor::default();
loop {
if let Ok(home) = crate::steam::home() {
if let Err(e) = monitor.tick(&home, Instant::now()) {
eprintln!("APK lifecycle monitor: {e:#}");
}
}
std::thread::sleep(Duration::from_secs(2));
}
});
});
}
#[cfg(test)]
mod tests {
use super::*;
fn s(visible: Option<bool>, alive: &[&str]) -> Sample {
Sample {
instance: "boot1".into(),
package: "app.one".into(),
window: visible,
alive: alive.iter().map(|p| p.to_string()).collect(),
}
}
#[test]
fn automatic_exit_requires_confirmed_absence_and_preserves_background_apps() {
let mut w = Watch::default();
let n = Instant::now();
assert_eq!(w.observe(&s(Some(true), &["app.one"]), n, true, true), None);
assert_eq!(
w.observe(
&s(Some(true), &["app.one"]),
n + Duration::from_secs(60),
true,
true
),
None
);
assert_eq!(
w.observe(&s(Some(true), &[]), n + Duration::from_secs(61), true, true),
None
);
assert_eq!(
w.observe(&s(Some(true), &[]), n + Duration::from_secs(75), true, true),
None
);
assert_eq!(
w.observe(&s(Some(true), &[]), n + Duration::from_secs(76), true, true),
Some(Reason::AppExited)
);
w.pause();
assert_eq!(
w.observe(&s(Some(true), &[]), n + Duration::from_secs(90), true, true),
None
);
}
#[test]
fn native_window_close_is_independent_of_auto_exit_and_headless_windows_do_not_close() {
let n = Instant::now();
let mut w = Watch::default();
assert_eq!(
w.observe(&s(Some(false), &["app.one"]), n, false, true),
None
);
assert_eq!(
w.observe(
&s(Some(false), &["app.one"]),
n + Duration::from_secs(60),
false,
true
),
None
);
w.observe(&s(Some(true), &["app.one"]), n, false, true);
w.observe(&s(Some(false), &["app.one"]), n, false, true);
assert_eq!(
w.observe(
&s(Some(false), &["app.one"]),
n + Duration::from_secs(1),
false,
true
),
Some(Reason::WindowClosed)
);
assert_eq!(
w.observe(
&s(Some(false), &["app.one"]),
n + Duration::from_secs(2),
false,
false
),
None
);
}
#[test]
fn restart_shared_apps_and_unknown_queries_cancel_stop() {
let n = Instant::now();
let mut w = Watch::default();
w.observe(&s(Some(true), &["app.one"]), n, true, true);
w.observe(&s(Some(false), &[]), n, true, true);
assert_eq!(
w.observe(
&s(Some(false), &["app.two"]),
n + Duration::from_secs(20),
true,
true
),
None
);
w.observe(&s(None, &[]), n + Duration::from_secs(21), true, true);
assert_eq!(
w.observe(
&s(Some(false), &["app.one"]),
n + Duration::from_secs(22),
true,
true
),
None
);
let mut restarted = s(Some(false), &[]);
restarted.instance = "boot2".into();
assert_eq!(
w.observe(&restarted, n + Duration::from_secs(40), true, true),
None
);
}
}
+437
View File
@@ -0,0 +1,437 @@
//! Steam invokes its Lepton compatibility tool; a private entry adapter preserves
//! existing storage/input settings without replacing any system/Steam files.
use super::*;
use std::os::unix::process::CommandExt;
const NATIVE_HOOKS: &str = r#"
# The session service has verified the installed package before starting Steam.
# Do not let native APK/depot timestamps reinstall or clear that installation.
function is_app_baked() { return 0; }
function get_app_mount_dir() { print "${FRAMELY_NATIVE_MOUNT:?}"; }
function get_app_activity() { print "${FRAMELY_NATIVE_ACTIVITY:?}"; }
# Android may otherwise reuse its desktop/freeform launch preference. Select
# fullscreen before creating the activity, rather than resizing it afterwards.
function run_app_commands() {
local APP_ID="${1:-$(get_app_id)}"
local APP_ACTIVITY="${2:-$(get_app_activity)}"
if app_wants_flatscreen; then
print "am start -S --windowingMode 1 ${APP_ID}/${APP_ACTIVITY} && /system/bin/sh /vendor/share/framely-window.sh ${APP_ID}"
else
print "am start -S ${APP_ID}/${APP_ACTIVITY}"
fi
}
function get_app_hash() { extract_app_hash; }
function get_app_last_depot_version() { extract_app_last_depot_version; }
function clear_baked_app_data() { println 'Framely: keeping installed application data'; }
# Separate native APK overlays in older shared contexts. Keep the installed
# directory (including extracted libraries/splits), rather than hiding it with
# a directory containing only the staged base APK.
if [[ -n "${FRAMELY_NATIVE_APK_DIR:-}" ]]; then
framely_native_mounts="$(declare -f setup_mounts)"
framely_native_lower='APP_APK_DIR="$(dirname "$(get_apk_path)")"'
framely_native_upper='$(get_baked_app_data_dir)/app_overlay'
[[ "$framely_native_mounts" == *"$framely_native_lower"* && "$framely_native_mounts" == *"$framely_native_upper"* ]] || { echo 'Unsupported native APK mounts; keeping application data unchanged' >&2; exit 64; }
framely_native_mounts="${framely_native_mounts//"$framely_native_lower"/'APP_APK_DIR="${FRAMELY_NATIVE_APK_DIR:?}"'}"
framely_native_mounts="${framely_native_mounts//"$framely_native_upper"/'${FRAMELY_NATIVE_OVERLAY:?}/upper'}"
function app_workdir() { print "${FRAMELY_NATIVE_OVERLAY:?}/work"; }
eval "$framely_native_mounts"
unset framely_native_mounts framely_native_lower framely_native_upper
fi
"#;
pub(super) fn script(source: &str) -> Result<String> {
let adapted = direct_launch_script(source)?;
let include = "source \"${SCRIPT_DIR}/liblepton/liblepton.sh\"";
// Append native overrides immediately before the entry's case statement,
// after the shared resource, orientation and optional input hooks.
let marker = "case \"${COMMAND}\" in";
ensure!(
source.matches(marker).count() == 1 && source.contains("function teardown()"),
"Unsupported native Lepton entry; keeping the existing installation unchanged"
);
ensure!(adapted.contains(include), "Missing native Lepton library");
Ok(adapted.replacen(marker, &format!("{NATIVE_HOOKS}\n{marker}"), 1))
}
pub(super) fn runtime_name(r: &Record) -> Option<String> {
r.steam_binding.as_ref().filter(|b| b.native)?;
r.steam_app_id
.filter(|id| *id >= 0x80000000)
.map(|id| format!("steamlaunch-{id}"))
}
pub(super) fn prepare(
home: &Path,
id: &str,
app_id: u32,
) -> Result<(Container, App, Value, fs::File)> {
let _guard = MUTATION
.try_lock()
.map_err(|_| anyhow::anyhow!("Another APK operation is running"))?;
let _lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(init(home)?.join("operation.lock"))?;
ensure!(
unsafe { libc::flock(_lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another APK operation is running"
);
let mut db = load(home)?;
let r = db.records.get(id).context("Unknown APK entry")?;
ensure!(
r.steam_launch
&& r.steam_binding.as_ref().is_some_and(|b| b.native)
&& r.steam_app_id == Some(app_id),
"Steam APK binding changed; refresh the entry and retry"
);
// Steam's launcher closes inherited descriptors. Keep this lock in the
// session service, which owns it until the launch and container have ended.
fs::create_dir_all(root(home).join("steam"))?;
let ownership = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(
root(home)
.join("steam")
.join(format!("context-{}.lock", hash(&r.context))),
)?;
ensure!(
unsafe { libc::flock(ownership.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another application is starting or running in this container"
);
let (a, mut c) = app(home, &db, id)?;
ensure!(
a.installed && a.state_known && a.pending.is_none(),
"APK installation is unavailable or an operation is pending"
);
let component = launch_component(&a)?;
// Also guard the original name: registration can occur while the old launch
// is still running, and two runtime names must never share an overlay.
let original = if c.id.starts_with("external-") {
db.root_contexts
.get(&c.baked)
.cloned()
.context("Unknown external container name")?
} else {
c.id.clone()
};
ensure!(
c.name == original || !running(&c.name),
"This application is already running through Steam"
);
let mut installer = c.clone();
installer.name = original;
let idle = if running(&installer.name) {
Some(lifecycle::idle_instance(&installer)?)
} else {
None
};
c.name = format!("steamlaunch-{app_id}");
c.steam = false;
let xml = fs::read_to_string(c.baked.join("data_overlay/system/packages.xml"))?;
let mount = xml
.split('<')
.filter(|t| t.starts_with("package "))
.find(|t| attr(t, "name") == Some(&a.metadata.package))
.and_then(|t| attr(t, "codePath"))
.filter(|p| p.starts_with("/data/") && !p.split('/').any(|x| x == ".."))
.context("Cannot verify the installed APK mount; no application data was changed")?;
let runner = runner(home)?;
let path = root(home)
.join("steam")
.join(format!("native-{}.sh", hash(id)));
fs::create_dir_all(path.parent().unwrap())?;
steam_shortcuts::write_owned(
&path,
script(&fs::read_to_string(&runner)?)?.as_bytes(),
0o700,
)?;
storage::prepare(&c.baked)?;
let media = c.baked.join("data_overlay/media/0");
let adopted = c.baked.parent().unwrap().join("external");
let external = if fs::read_link(&media).is_ok_and(|target| target == adopted) {
ensure!(!adopted.is_symlink(), "Unexpected external media link");
adopted
} else {
c.baked.join("external")
};
let flat = a.show_window.unwrap_or(!a.metadata.vr);
let (window_dex, window_script) = window_runtime(home)?;
let mut env = json!({
"FRAMELY_WINDOW_DEX": window_dex,
"FRAMELY_WINDOW_SCRIPT": window_script,
"FRAMELY_LEPTON_DIR":runner.parent().context("Missing Lepton directory")?,
"STEAM_COMPAT_DATA_PATH":c.baked.parent().context("Missing application data")?,
"FRAMELY_NATIVE_MOUNT":mount,
"FRAMELY_NATIVE_ACTIVITY":component.split_once('/').context("Invalid component")?.1,
"FRAMELY_NATIVE_LAUNCH":"true",
"FRAMELY_EXTERNAL_MEDIA_DIR":external,
"FRAMELY_SHADER_CACHE_DIR":c.baked.join("shadercache"),
"FRAMELY_BACKGROUND_BOOT":"false",
"FRAMELY_WINDOW_ORIENTATION":a.orientation.as_deref().unwrap_or("auto"),
"APP_WANTS_FLATSCREEN":if flat {"true"}else{"false"},
"LEPTON_NO_CLEANUP":"true", "TERM":"dumb"
});
let installed_dir = c
.baked
.join("data_overlay")
.join(mount.trim_start_matches("/data/"));
if installed_dir.is_dir() {
let installed_dir = fs::canonicalize(installed_dir)?;
ensure!(
installed_dir.starts_with(fs::canonicalize(c.baked.join("data_overlay"))?),
"Installed APK directory escapes its data location"
);
env["FRAMELY_NATIVE_APK_DIR"] = json!(installed_dir);
env["FRAMELY_NATIVE_OVERLAY"] = json!(c
.baked
.join(format!("native-apk-{}", hash(&a.metadata.package))));
}
// Older releases left the headless installation container alive. Transfer
// only an unchanged, idle instance after validating the native launch setup.
if let Some(identity) = idle {
ensure!(
lifecycle::idle_instance(&installer)? == identity,
"Container changed during launch"
);
stop(
&installer,
&root(home)
.join("logs")
.join(format!("{}-native-handoff.log", hash(id))),
)?;
}
if db.gamepad_enabled {
let m =
crate::gamepad::prepare(&root(home), &c.name, &db.gamepad_source, db.gamepad_rumble)?;
crate::gamepad::select_target(&c.name, &a.metadata.package)?;
for (k, v) in [
("FRAMELY_GAMEPAD_EVENT", json!(m.event)),
("FRAMELY_GAMEPAD_GRAB", json!(m.grab)),
("FRAMELY_GAMEPAD_LAYOUT", json!(m.layout)),
("FRAMELY_GAMEPAD_READY", json!(m.ready)),
("FRAMELY_GAMEPAD_TOKEN", json!(m.token)),
] {
env[k] = v;
}
}
db.records.get_mut(id).unwrap().steam_app_id = Some(app_id);
save(home, &db)?;
Ok((
c,
a,
json!({"script":path,"env":env,"transientGeneration":db.records[id].steam_transient_generation}),
ownership,
))
}
pub(super) fn run(app: &str, token: &str, command: &[String]) -> Result<()> {
ensure!(
unsafe { libc::geteuid() } != 0,
"Native APK launch must run as the Steam session user"
);
let home = crate::steam::home()?;
let expected = runner(&home)?;
let entry = command
.len()
.checked_sub(4)
.context("Unexpected native Lepton command")?;
ensure!(
fs::canonicalize(&command[entry])? == fs::canonicalize(&expected)?
&& command[entry + 1] == "waitforexitandrun"
&& command[entry + 2] == "--",
"Unexpected native Lepton command"
);
if entry != 0 {
// %command% includes Steam's launch wrapper and reaper. Retain both;
// replacing the whole command would lose native lifecycle ownership.
ensure!(
entry == 8
&& Path::new(&command[0])
.file_name()
.is_some_and(|s| s == "steam-launch-wrapper")
&& Path::new(&command[4])
.file_name()
.is_some_and(|s| s == "reaper")
&& command[1] == "--oom-score-adjust"
&& command[2].parse::<i32>().is_ok()
&& command[3] == "--"
&& command[5] == "SteamLaunch"
&& command[6].starts_with("AppId=")
&& command[7] == "--",
"Unsupported Steam launch wrapper; keeping application data unchanged"
);
for i in [0, 4] {
let path = fs::canonicalize(&command[i])?;
ensure!(
path.starts_with(fs::canonicalize(home.join(".local/share/Steam"))?),
"Unexpected Steam launch runtime"
);
}
}
let r = load(&home)?
.records
.get(app)
.cloned()
.context("Unknown APK entry")?;
ensure!(
r.steam_token.as_deref() == Some(token),
"Invalid native APK token"
);
let apk = steam_shortcuts::native_apk(&home, app);
ensure!(
fs::canonicalize(&command[entry + 3])? == fs::canonicalize(&apk)?,
"Unexpected APK launch target"
);
let response = steam_bridge::native_call(
app,
token,
r.steam_app_id.context("Missing Steam APK App ID")?,
)?;
let path = response["script"]
.as_str()
.context("Missing native entry")?;
ensure!(
Path::new(path)
== root(&home)
.join("steam")
.join(format!("native-{}.sh", hash(app))),
"Invalid native entry path"
);
let mut arguments = command.to_vec();
arguments[entry] = path.to_owned();
let mut cmd = Command::new(&arguments[0]);
cmd.args(&arguments[1..])
.env_remove("FRAMELY_STEAM_APP_ID")
.env("SteamAppId", r.steam_app_id.unwrap().to_string());
for (k, v) in response["env"]
.as_object()
.context("Missing native environment")?
{
cmd.env(k, v.as_str().context("Invalid native environment value")?);
}
Err(cmd.exec().into())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn native_shared_context_uses_complete_installed_directory_and_separate_overlay() {
let source = format!(
r#"
function print() {{ printf '%s\n' "$*"; }}
function setup_mounts() {{
APP_APK_DIR="$(dirname "$(get_apk_path)")"
local APP_OVERLAY_UPPERDIR="$(get_baked_app_data_dir)/app_overlay"
print "$APP_APK_DIR|$APP_OVERLAY_UPPERDIR|$(app_workdir)"
}}
{NATIVE_HOOKS}
setup_mounts
"#
);
for package in ["one", "two"] {
let out = Command::new("bash")
.args(["-c", &source])
.env(
"FRAMELY_NATIVE_APK_DIR",
format!("/baked/data_overlay/app/{package}"),
)
.env("FRAMELY_NATIVE_OVERLAY", format!("/baked/native-{package}"))
.output()
.unwrap();
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert_eq!(String::from_utf8(out.stdout).unwrap().trim(), format!("/baked/data_overlay/app/{package}|/baked/native-{package}/upper|/baked/native-{package}/work"));
}
}
#[test]
fn native_hooks_keep_storage_and_selected_activity_after_early_exit() {
let t = tempfile::tempdir().unwrap();
let lib = t.path().join("lepton/liblepton");
fs::create_dir_all(&lib).unwrap();
fs::write(
lib.join("liblepton.sh"),
r#"
function data_mount_path() { echo "$TEST_DATA"; }
function setup_props() { :; }
function props_file() { echo "$TEST_PROPS"; }
function setup_mounts() {
rm -rf "$(data_mount_path)/media/0"
mkdir -p "$(data_mount_path)/media"
ln -s "${STEAM_COMPAT_DATA_PATH}/external" "$(data_mount_path)/media/0"
}
function setup_podman_mounts() { setup_mounts; }
function podman_mount_entry() { :; }
function print() { printf '%s\n' "$*"; }
function println() { print "$@"; }
"#,
)
.unwrap();
let source = r#"#!/bin/bash
set -euo pipefail
COMMAND=waitforexitandrun
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
source "${SCRIPT_DIR}/liblepton/liblepton.sh"
function teardown() { clear_baked_app_data 'early exit'; }
case "${COMMAND}" in
waitforexitandrun)
is_app_baked
setup_podman_mounts
get_app_mount_dir
get_app_activity
run_app_commands test.Package test.Selected
teardown
;;
esac
"#;
let entry = t.path().join("entry.sh");
fs::write(&entry, script(source).unwrap()).unwrap();
let compat = t.path().join("context");
let data = compat.join("baked/data_overlay");
let download = data.join("media/0/Android/data/test/files/download.part");
fs::create_dir_all(download.parent().unwrap()).unwrap();
fs::write(&download, b"resume-me").unwrap();
let save = data.join("data/test/save");
fs::create_dir_all(save.parent().unwrap()).unwrap();
fs::write(&save, b"saved game").unwrap();
for flat in [true, false] {
let out = Command::new("bash")
.arg(&entry)
.env("FRAMELY_LEPTON_DIR", lib.parent().unwrap())
.env("STEAM_COMPAT_DATA_PATH", &compat)
.env("FRAMELY_EXTERNAL_MEDIA_DIR", compat.join("baked/external"))
.env("FRAMELY_SHADER_CACHE_DIR", compat.join("baked/shadercache"))
.env("FRAMELY_NATIVE_LAUNCH", "true")
.env("FRAMELY_NATIVE_MOUNT", "/data/app/test")
.env("FRAMELY_NATIVE_ACTIVITY", "test.Selected")
.env("APP_WANTS_FLATSCREEN", if flat { "true" } else { "false" })
.env("TEST_DATA", &data)
.env("TEST_PROPS", t.path().join("props"))
.output()
.unwrap();
assert!(
out.status.success(),
"{}",
String::from_utf8_lossy(&out.stderr)
);
assert!(String::from_utf8_lossy(&out.stdout).contains("test.Selected"));
let expected = if flat {
"am start -S --windowingMode 1 test.Package/test.Selected"
} else {
"am start -S test.Package/test.Selected"
};
assert!(String::from_utf8_lossy(&out.stdout).contains(expected));
assert_eq!(fs::read(&save).unwrap(), b"saved game");
assert_eq!(fs::read(&download).unwrap(), b"resume-me");
}
assert!(script("unknown future native entry").is_err());
}
}
+819
View File
@@ -0,0 +1,819 @@
//! Steam-owned wrapper lifetime. Only the session service launches/controls APKs.
use super::steam_shortcuts as shortcuts;
use super::*;
use crate::ipc;
use std::os::unix::fs::OpenOptionsExt;
use std::{
collections::BTreeMap,
io::{BufRead, BufReader, Read},
os::unix::net::{UnixListener, UnixStream},
sync::{
atomic::{AtomicBool, Ordering},
mpsc,
},
};
type Progress = Arc<dyn Fn(Value) + Send + Sync>;
struct Pending {
ticket: u64,
progress: Progress,
result: mpsc::Sender<std::result::Result<Value, String>>,
}
static PENDING: Mutex<BTreeMap<String, Pending>> = Mutex::new(BTreeMap::new());
static STARTING: Mutex<std::collections::BTreeSet<String>> =
Mutex::new(std::collections::BTreeSet::new());
static STOPPED: AtomicBool = AtomicBool::new(false);
extern "C" fn interrupted(_: libc::c_int) {
STOPPED.store(true, Ordering::Relaxed);
}
#[derive(Serialize, Deserialize)]
struct Lease {
app: String,
token: String,
pid: u32,
signature: String,
instance: String,
}
fn leases(home: &Path) -> PathBuf {
root(home).join("steam/leases")
}
fn lease_path(home: &Path, id: &str) -> PathBuf {
leases(home).join(format!("{}.json", hash(id)))
}
fn signature(pid: u32) -> Option<String> {
if !runtime_pid_alive(&pid.to_string()) {
return None;
}
let stat = fs::read_to_string(format!("/proc/{pid}/stat")).ok()?;
let start = stat.rsplit_once(')')?.1.split_whitespace().nth(19)?;
let boot = fs::read_to_string("/proc/sys/kernel/random/boot_id").ok()?;
Some(format!("{}:{start}", boot.trim()))
}
fn runtime() -> Result<PathBuf> {
let uid = unsafe { libc::geteuid() };
ensure!(uid != 0, "Steam APK wrapper must run as the session user");
let p = PathBuf::from(format!("/run/user/{uid}/framely-apk-steam"));
fs::create_dir_all(&p)?;
let m = fs::symlink_metadata(&p)?;
ensure!(
m.is_dir() && m.uid() == uid,
"Invalid Steam wrapper runtime directory"
);
fs::set_permissions(&p, fs::Permissions::from_mode(0o700))?;
Ok(p)
}
fn socket() -> Result<PathBuf> {
Ok(runtime()?.join("control.sock"))
}
fn read_request(stream: &mut UnixStream) -> Result<Value> {
let mut bytes = Vec::new();
BufReader::new(stream)
.take(8193)
.read_until(b'\n', &mut bytes)?;
ensure!(
bytes.len() <= 8192 && bytes.last() == Some(&b'\n'),
"Invalid Steam wrapper request"
);
Ok(serde_json::from_slice(&bytes)?)
}
fn peer(stream: &UnixStream) -> Result<u32> {
let mut c: libc::ucred = unsafe { std::mem::zeroed() };
let mut len = std::mem::size_of::<libc::ucred>() as libc::socklen_t;
ensure!(
unsafe {
libc::getsockopt(
stream.as_raw_fd(),
libc::SOL_SOCKET,
libc::SO_PEERCRED,
&mut c as *mut _ as *mut _,
&mut len,
)
} == 0
&& c.uid == unsafe { libc::geteuid() }
&& c.pid > 0,
"Invalid Steam wrapper peer"
);
Ok(c.pid as u32)
}
fn record(home: &Path, id: &str, token: &str) -> Result<Record> {
let db = load(home)?;
let r = db.records.get(id).context("Unknown Steam APK entry")?;
ensure!(
r.steam_token.as_deref() == Some(token),
"Invalid Steam APK entry token"
);
Ok(r.clone())
}
pub(super) fn current_instance(c: &Container) -> Result<Option<String>> {
let mut cmd = crate::process::tool("podman");
cmd.args([
"inspect",
"--format",
"{{/*SteamBridge*/}}{{.Id}}|{{.State.StartedAt}}|{{.State.Running}}|{{.State.Pid}}",
&format!("lepton-{}", c.name),
]);
let text = match output(cmd, Duration::from_secs(3), None) {
Ok(text) => text,
Err(error) => {
// Lepton removes its transient Podman object when stopped. Only
// Podman's explicit "absent" exit code is safe to treat as stopped;
// permission/storage/runtime errors must not authorize a new boot.
let exists = crate::process::command_output_timeout(
crate::process::tool("podman").args([
"container",
"exists",
&format!("lepton-{}", c.name),
]),
Duration::from_secs(3),
false,
)?;
if exists.status.code() == Some(1) {
return Ok(None);
}
return Err(error.context("Cannot verify Steam APK container state"));
}
};
let fields: Vec<_> = text.trim().split('|').collect();
ensure!(
fields.len() == 4
&& !fields[0].is_empty()
&& !fields[1].is_empty()
&& matches!(fields[2], "true" | "false"),
"Unknown Steam container state"
);
let pid = fields[3]
.parse::<u32>()
.context("Unknown container process")?;
if fields[2] == "false" || pid == 0 || !runtime_pid_alive(&pid.to_string()) {
return Ok(None);
}
Ok(Some(fields[..3].join("|")))
}
fn instance(c: &Container) -> Result<String> {
current_instance(c)?.context("APK container has stopped")
}
fn save_lease(home: &Path, l: &Lease) -> Result<()> {
fs::create_dir_all(leases(home))?;
fs::set_permissions(leases(home), fs::Permissions::from_mode(0o700))?;
let p = lease_path(home, &l.app);
let tmp = p.with_extension(format!("{}.tmp", std::process::id()));
let mut file = fs::OpenOptions::new()
.write(true)
.create_new(true)
.mode(0o600)
.open(&tmp)?;
file.write_all(&serde_json::to_vec(l)?)?;
file.sync_all()?;
fs::rename(tmp, p)?;
Ok(())
}
fn load_lease(home: &Path, id: &str) -> Result<Lease> {
let p = lease_path(home, id);
ensure!(
fs::metadata(&p)?.len() <= 8192,
"Invalid Steam wrapper lease"
);
Ok(serde_json::from_slice(&fs::read(p)?)?)
}
fn owned_status(home: &Path, l: &Lease) -> Result<Value> {
let db = load(home)?;
if db.records.get(&l.app).is_none_or(|r| r.removed) {
return Ok(json!({"owned":false}));
}
let (_, c) = app(home, &db, &l.app)?;
if current_instance(&c)?.as_deref() != Some(&l.instance) {
return Ok(json!({"owned":false}));
}
let s = lifecycle::sample(&c)?;
let alive = s.alive.contains(&db.records[&l.app].metadata.package);
Ok(json!({"owned":true,"alive":alive}))
}
/// Stop only the app owned by this exact container instance. Other installed
/// applications in an old shared context retain their processes and data.
fn stop_owned(home: &Path, l: &Lease) -> Result<()> {
let _guard = MUTATION
.try_lock()
.map_err(|_| anyhow::anyhow!("Another APK operation is running"))?;
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(root(home).join("operation.lock"))?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another APK operation is running"
);
let db = load(home)?;
if db.records.get(&l.app).is_none_or(|r| r.removed) {
return Ok(());
}
let r = record(home, &l.app, &l.token)?;
ensure!(
!db.records
.values()
.any(|r| r.context == db.records[&l.app].context && r.pending.is_some()),
"APK operation is pending"
);
let (a, c) = app(home, &db, &l.app)?;
if current_instance(&c)?.as_deref() != Some(&l.instance) {
return Ok(());
}
let log = root(home)
.join("logs")
.join(format!("{}-steam-stop-{}.log", hash(&l.app), now()));
fs::write(
&log,
"Steam wrapper stopped; preserving installed application data\n",
)?;
let before = lifecycle::sample(&c)?;
crate::gamepad::stop_app(&c.name, &r.metadata.package);
if before.package == a.metadata.package {
podman(
&[
"exec",
&format!("lepton-{}", c.name),
"setprop",
"waydroid.active_apps",
"none",
],
Some(&log),
)?;
}
podman(
&[
"exec",
&format!("lepton-{}", c.name),
"am",
"force-stop",
"--user",
"0",
&a.metadata.package,
],
Some(&log),
)?;
let after = lifecycle::sample(&c)?;
if after.instance == l.instance && after.alive.is_empty() {
stop(&c, &log)?;
}
Ok(())
}
fn handle(home: &Path, pid: u32, v: Value) -> Result<Value> {
let id = v["app"].as_str().context("Missing Steam APK entry")?;
let token = v["token"]
.as_str()
.context("Missing Steam APK entry token")?;
match v["method"].as_str() {
Some("native.prepare") => {
let r = record(home, id, token)?;
ensure!(
!r.removed && r.steam_launch && shortcuts::linked(home, &r),
"Steam launch is disabled"
);
let app_id = v["steamAppId"]
.as_u64()
.and_then(|v| u32::try_from(v).ok())
.filter(|v| *v >= 0x80000000)
.context("Launch this APK entry through Steam")?;
let (c, a, response, ownership) = super::native::prepare(home, id, app_id)?;
let owner_signature = signature(pid).context("Steam launch exited")?;
let home = home.to_owned();
let id = id.to_owned();
let token = token.to_owned();
let transient_generation = response["transientGeneration"].as_str().map(str::to_owned);
let gamepad_event = response["env"]["FRAMELY_GAMEPAD_EVENT"]
.as_str()
.map(PathBuf::from);
std::thread::spawn(move || {
let result = (|| -> Result<Value> {
let deadline = Instant::now() + Duration::from_secs(120);
let creation_deadline = Instant::now() + Duration::from_secs(45);
let mut observation = "waiting for container creation".to_owned();
loop {
ensure!(
signature(pid).as_deref() == Some(&owner_signature),
"Native Lepton launch exited; inspect the APK log"
);
ensure!(
Instant::now() < deadline,
"Native Lepton startup timed out: {observation}; inspect the APK log"
);
let instance = current_instance(&c)?;
if instance.is_none() {
if let Some(event) = &gamepad_event {
ensure!(event.exists(), "Virtual gamepad disappeared before Lepton created its container; retry the launch");
}
ensure!(Instant::now() < creation_deadline, "Lepton did not create its container; inspect the native Lepton startup log");
}
if let Some(instance) = instance {
match lifecycle::sample(&c) {
Ok(s) => {
observation = format!(
"active package {}, target process present={}",
s.package,
s.alive.contains(&a.metadata.package)
);
if s.package == a.metadata.package
&& s.alive.contains(&a.metadata.package)
{
save_lease(
&home,
&Lease {
app: id.clone(),
token: token.clone(),
pid,
signature: owner_signature.clone(),
instance,
},
)?;
if crate::gamepad::current(&c.name).is_some() {
crate::gamepad::activate(&c.name, &a.metadata.package)?;
}
return Ok(json!({"started":true,"native":true}));
}
}
Err(e) => observation = format!("lifecycle check failed: {e:#}"),
}
}
std::thread::sleep(Duration::from_millis(500));
}
})();
if let Err(e) = &result {
// Also report launches made directly from Steam, which
// have no pending panel job to receive this error.
eprintln!(
"Native APK startup failed for {} (owner PID {pid}): {e:#}",
c.name
);
}
// A failed Podman run can leave Lepton waiting for a create
// event forever. End only this verified, still-uncreated launch;
// never interrupt a container that has already booted.
if result.is_err() && matches!(current_instance(&c), Ok(None)) {
if signature(pid).as_deref() == Some(&owner_signature) {
unsafe {
libc::kill(pid as i32, libc::SIGTERM);
}
}
crate::gamepad::stop_context(&c.name);
}
if let Some(p) = PENDING.lock().unwrap().remove(&id) {
if result.is_ok() {
(p.progress)(json!({"phase":"started"}));
}
let _ = p.result.send(result.map_err(|e| format!("{e:#}")));
}
// Preserve storage ownership after reporting startup success.
// Steam drops inherited fds, so the service retains this lock
// through exit and the container's eventual shutdown.
while signature(pid).as_deref() == Some(&owner_signature)
|| !matches!(current_instance(&c), Ok(None))
{
std::thread::sleep(Duration::from_millis(500));
}
// The native Lepton entry may remove its container before the
// lease watcher runs. Release its virtual device here, while
// we still hold the context lock, so a later launch cannot be
// affected by an old helper or have its new device removed.
crate::gamepad::stop_context(&c.name);
drop(ownership);
// A generation protects a newer launch from an old exit. A
// persistent entry switched to transient mode has no generation.
let _ = shortcuts::cleanup_transient(&home, &id, transient_generation.as_deref());
});
Ok(response)
}
Some("start") => {
let r = record(home, id, token)?;
ensure!(
!r.removed && r.steam_launch && shortcuts::linked(home, &r),
"Steam launch is disabled for this APK"
);
let app_id = v["steamAppId"]
.as_u64()
.and_then(|v| u32::try_from(v).ok())
.filter(|v| *v >= 0x80000000)
.context("Launch this APK entry through Steam")?;
if let Ok(old) = load_lease(home, id) {
ensure!(
signature(old.pid).as_deref() != Some(&old.signature),
"This APK already has an active Steam wrapper"
);
}
let entry_lock = shortcuts::wrapper(home, id).with_extension("launch.lock");
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(entry_lock)?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Steam APK launch is already in progress"
);
let db = load(home)?;
let (_a, c) = app(home, &db, id)?;
ensure!(current_instance(&c)?.is_none(),"Close the running container before its first Steam launch; existing applications will not be restarted automatically");
let progress = PENDING
.lock()
.unwrap()
.get(id)
.map(|p| p.progress.clone())
.unwrap_or_else(|| Arc::new(|_| {}));
let signature = signature(pid).context("Steam wrapper exited before launch")?;
let owner_home = home.to_owned();
let owner_app = id.to_owned();
let owner_token = token.to_owned();
let owner_context = c.clone();
let marked = std::sync::atomic::AtomicBool::new(false);
let owner_progress: Progress = Arc::new(move |v| {
if matches!(v["phase"].as_str(), Some("launching" | "started"))
&& !marked.load(Ordering::Relaxed)
{
if let Ok(instance) = instance(&owner_context) {
let lease = Lease {
app: owner_app.clone(),
token: owner_token.clone(),
pid,
signature: signature.clone(),
instance,
};
if save_lease(&owner_home, &lease).is_ok() {
marked.store(true, Ordering::Relaxed);
}
}
}
progress(v);
});
let launched = operate_internal(
home,
"launch",
&json!({"app":id}),
Cancellation::default(),
owner_progress,
Some(app_id),
);
let response = launched.and_then(|_| {
let lease =
load_lease(home, id).context("Cannot record the Steam-owned container")?;
ensure!(
lease.pid == pid && instance(&c)? == lease.instance,
"Steam-owned container changed during startup"
);
Ok(json!({"started":true}))
});
if response.is_err() {
if let Ok(lease) = load_lease(home, id) {
if lease.pid == pid && stop_owned(home, &lease).is_ok() {
let _ = fs::remove_file(lease_path(home, id));
}
}
}
if let Some(p) = PENDING.lock().unwrap().remove(id) {
let _ = p.result.send(
response
.as_ref()
.map(Clone::clone)
.map_err(|e| format!("{e:#}")),
);
}
response
}
Some("status") | Some("stop") => {
let l = load_lease(home, id)?;
ensure!(
l.pid == pid && l.token == token && signature(pid).as_deref() == Some(&l.signature),
"Steam wrapper lease does not belong to this process"
);
if v["method"] == "stop" {
stop_owned(home, &l)?;
let _ = fs::remove_file(lease_path(home, id));
Ok(json!(true))
} else {
owned_status(home, &l)
}
}
_ => bail!("Invalid Steam wrapper method"),
}
}
pub(super) fn start_session() -> Result<()> {
let home = crate::steam::home()?;
let dir = runtime()?;
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(dir.join("server.lock"))?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Steam APK bridge is already running"
);
let path = socket()?;
if path.exists() {
ensure!(
fs::symlink_metadata(&path)?.file_type().is_socket(),
"Invalid Steam APK socket"
);
fs::remove_file(&path)?;
}
let listener = UnixListener::bind(&path)?;
fs::set_permissions(path, fs::Permissions::from_mode(0o600))?;
std::thread::spawn(move || {
let _lock = lock;
let workers = Arc::new(std::sync::atomic::AtomicUsize::new(0));
for stream in listener.incoming() {
let Ok(mut stream) = stream else { continue };
if workers.fetch_add(1, Ordering::Relaxed) >= 8 {
workers.fetch_sub(1, Ordering::Relaxed);
continue;
}
let home = home.clone();
let workers = workers.clone();
std::thread::spawn(move || {
let _ = stream.set_read_timeout(Some(Duration::from_secs(5)));
let _ = stream.set_write_timeout(Some(Duration::from_secs(5)));
let result = peer(&stream).and_then(|pid| {
read_request(&mut stream).and_then(|v| {
let id = v["app"].as_str().unwrap_or("").to_owned();
let start = v["method"] == "start" || v["method"] == "native.prepare";
if start {
record(&home, &id, v["token"].as_str().unwrap_or(""))?;
ensure!(
STARTING.lock().unwrap().insert(id.clone()),
"Steam APK launch is already in progress"
);
}
let result = handle(&home, pid, v);
if start {
if result.is_err() {
if let Some(p) = PENDING.lock().unwrap().remove(&id) {
let _ = p
.result
.send(Err(format!("{:#}", result.as_ref().unwrap_err())));
}
}
STARTING.lock().unwrap().remove(&id);
}
result
})
});
let _ = ipc::write(&mut stream, &ipc::response(result));
workers.fetch_sub(1, Ordering::Relaxed);
});
}
});
let home = crate::steam::home()?;
std::thread::spawn(move || loop {
if let Ok(files) = fs::read_dir(leases(&home)) {
for entry in files.flatten().take(64) {
if entry.path().extension().is_none_or(|s| s != "json")
|| !entry
.metadata()
.is_ok_and(|m| m.is_file() && m.len() <= 8192)
{
continue;
}
let Ok(bytes) = fs::read(entry.path()) else {
continue;
};
let Ok(l) = serde_json::from_slice::<Lease>(&bytes) else {
continue;
};
if entry.path() != lease_path(&home, &l.app) {
continue;
}
if signature(l.pid).as_deref() != Some(&l.signature) {
if load(&home).is_ok_and(|db| !db.records.contains_key(&l.app)) {
let _ = fs::remove_file(entry.path());
continue;
}
if stop_owned(&home, &l).is_ok() {
let _ = fs::remove_file(entry.path());
}
}
}
}
std::thread::sleep(Duration::from_secs(2));
});
Ok(())
}
fn focus_owned(home: &Path, lease: &Lease, progress: &Progress) -> Result<Value> {
let _guard = MUTATION
.try_lock()
.map_err(|_| anyhow::anyhow!("Another APK operation is running"))?;
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(root(home).join("operation.lock"))?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another APK operation is running"
);
let db = load(home)?;
let (a, c) = app(home, &db, &lease.app)?;
ensure!(
signature(lease.pid).as_deref() == Some(&lease.signature)
&& current_instance(&c)?.as_deref() == Some(&lease.instance),
"Previous Steam launch is closing; retry after it stops"
);
let log =
root(home)
.join("logs")
.join(format!("{}-steam-focus-{}.log", hash(&lease.app), now()));
launch_with_started(&c, &a, &log, || progress(json!({"phase":"started"})))?;
if crate::gamepad::current(&c.name).is_some() {
crate::gamepad::activate(&c.name, &a.metadata.package)?;
}
Ok(json!({"started":true,"reused":true}))
}
pub(super) fn request_launch(
home: &Path,
id: &str,
progress: Progress,
cancel: &Cancellation,
) -> Result<Value> {
let db = load(home)?;
let r = db.records.get(id).context("APK entry not found")?;
ensure!(
r.steam_launch && shortcuts::linked(home, r),
"Steam entry is missing; re-enable Steam launch in APK management"
);
let binding = r.steam_binding.as_ref().context("Missing Steam binding")?;
if let Ok(lease) = load_lease(home, id) {
if signature(lease.pid).as_deref() == Some(&lease.signature) {
return cancel.commit(|| {
shortcuts::rpc(home, "run-game", Some(&binding.game_id))?;
progress(json!({"cancellable":false}));
focus_owned(home, &lease, &progress)
});
}
}
let (tx, rx) = mpsc::channel();
let ticket = rand::random::<u64>();
{
let mut p = PENDING.lock().unwrap();
ensure!(
!p.contains_key(id) && !STARTING.lock().unwrap().contains(id),
"This APK is already launching through Steam"
);
p.insert(
id.into(),
Pending {
ticket,
progress: progress.clone(),
result: tx,
},
);
}
let result = (|| {
cancel.commit(|| shortcuts::rpc(home, "run-game", Some(&binding.game_id)))?;
progress(json!({"cancellable":false}));
progress(json!({"phase":"starting"}));
let deadline = Instant::now() + Duration::from_secs(120);
loop {
match rx.recv_timeout(Duration::from_millis(250)) {
Ok(result) => return result.map_err(anyhow::Error::msg),
Err(mpsc::RecvTimeoutError::Disconnected) => bail!("Steam APK launch connection closed"),
Err(mpsc::RecvTimeoutError::Timeout) => ensure!(Instant::now()<deadline,"Steam did not start the APK entry. Check its compatibility and launch options in Steam."),
}
}
})();
{
let mut pending = PENDING.lock().unwrap();
if pending.get(id).is_some_and(|p| p.ticket == ticket) {
pending.remove(id);
}
}
result
}
pub(super) fn native_call(app: &str, token: &str, app_id: u32) -> Result<Value> {
call_with_id(app, token, "native.prepare", 15, Some(app_id))
}
fn call(app: &str, token: &str, method: &str, timeout: u64) -> Result<Value> {
call_with_id(app, token, method, timeout, None)
}
fn call_with_id(
app: &str,
token: &str,
method: &str,
timeout: u64,
owner: Option<u32>,
) -> Result<Value> {
let mut s = UnixStream::connect(socket()?).context("Framely UI session is unavailable")?;
s.set_read_timeout(Some(Duration::from_secs(timeout)))?;
s.set_write_timeout(Some(Duration::from_secs(5)))?;
let app_id = owner.or_else(|| {
std::env::var("SteamAppId")
.ok()
.and_then(|s| s.parse::<u32>().ok())
});
ipc::write(
&mut s,
&json!({"method":method,"app":app,"token":token,"steamAppId":app_id}),
)?;
let r = ipc::read(&mut s)?;
if let Some(e) = r["error"].as_str() {
bail!("{e}")
}
Ok(r["result"].clone())
}
pub(crate) fn run(app: &str, token: &str) -> Result<()> {
STOPPED.store(false, Ordering::Relaxed);
unsafe {
libc::signal(
libc::SIGTERM,
interrupted as *const () as libc::sighandler_t,
);
libc::signal(libc::SIGINT, interrupted as *const () as libc::sighandler_t);
libc::signal(libc::SIGHUP, interrupted as *const () as libc::sighandler_t);
}
// Duplicate shortcut executions cannot interfere with an existing wrapper.
let home = crate::steam::home()?;
let p = shortcuts::wrapper(&home, app).with_extension("owner.lock");
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(p)?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"This APK already has an active Steam wrapper"
);
call(app, token, "start", 180)?;
let mut absent = None;
while !STOPPED.load(Ordering::Relaxed) {
match call(app, token, "status", 5) {
Ok(v) if v["owned"] == false => return Ok(()),
Ok(v) if v["alive"] == false => {
let t = *absent.get_or_insert_with(Instant::now);
if t.elapsed() >= Duration::from_secs(15) {
break;
}
}
_ => absent = None,
}
for _ in 0..20 {
if STOPPED.load(Ordering::Relaxed) {
break;
}
std::thread::sleep(Duration::from_millis(100));
}
}
// The session's persisted owner-PID monitor also handles SIGKILL and reconnects
// across Framely updates. A failed stop request must not trigger a reinstall.
let _ = call(app, token, "stop", 35);
Ok(())
}
#[cfg(test)]
pub(super) fn test_request(home: &Path, app: &str, token: &str, method: &str) -> Result<Value> {
if method == "focus" {
let progress: Progress = Arc::new(|_| {});
return focus_owned(home, &load_lease(home, app)?, &progress);
}
handle(
home,
std::process::id(),
json!({"app":app,"token":token,"method":method,"steamAppId":0x92345678u32}),
)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn owner_signature_is_bound_to_process_start() {
let pid = std::process::id();
let a = signature(pid).unwrap();
assert_eq!(signature(pid), Some(a));
assert!(signature(u32::MAX).is_none());
}
#[test]
fn unix_peer_and_bounded_requests() {
let (mut a, mut b) = UnixStream::pair().unwrap();
assert_eq!(peer(&a).unwrap(), std::process::id());
ipc::write(&mut b, &json!({"method":"status"})).unwrap();
assert_eq!(read_request(&mut a).unwrap()["method"], "status");
b.write_all(&vec![b'x'; 8193]).unwrap();
assert!(read_request(&mut a).is_err());
}
}
#[cfg(test)]
pub(super) fn test_adopt(home: &Path, id: &str, token: &str) -> Result<()> {
let db = load(home)?;
let (_, c) = app(home, &db, id)?;
save_lease(
home,
&Lease {
app: id.into(),
token: token.into(),
pid: std::process::id(),
signature: signature(std::process::id()).unwrap(),
instance: instance(&c)?,
},
)
}
+32
View File
@@ -0,0 +1,32 @@
async function(p) {
const executable = d => d.strShortcutExe?.replace(/^"|"$/g, '').replace('/./', '/');
const details = id => new Promise((resolve, reject) => {
let sub, settled = false;
const timer = setTimeout(() => { sub?.unregister(); reject(Error('Details timed out')); }, 3000);
sub = SteamClient.Apps.RegisterForAppDetails(id, d => { settled = true; clearTimeout(timer); sub?.unregister(); resolve(d); });
// Steam may invoke a cached callback synchronously.
if (settled) sub?.unregister();
});
let apps, app;
for (let n = 0; n < 10; n++) {
apps = Array.from(appStore.m_mapApps.values());
const matches = apps.filter(a => a.display_name === 'Devkit Game: ' + p.game);
app = matches.length === 1 ? matches[0] : apps.find(a => a.appid === p.previous);
if (app) break;
if (n < 9) await new Promise(r => setTimeout(r, 100));
}
if (app) {
if (app.appid < 2147483648) throw Error('Missing owned shortcut');
const d = await details(app.appid);
if (executable(d) !== p.exe) throw Error('Shortcut target does not match owned APK');
return { id: app.appid };
}
// A previous attempt may have renamed the entry before persisting its ID.
// Recover by exact executable ownership, never by a user-visible app name.
const shortcuts = apps.filter(a => a.appid >= 2147483648);
if (shortcuts.length > 256) throw Error('Too many shortcuts to recover owned entry');
const rows = await Promise.allSettled(shortcuts.map(async a => ({ id: a.appid, details: await details(a.appid) })));
const owned = rows.filter(r => r.status === 'fulfilled' && executable(r.value.details) === p.exe);
if (owned.length !== 1) throw Error('Missing or ambiguous owned shortcut');
return { id: owned[0].value.id };
}
+562
View File
@@ -0,0 +1,562 @@
//! Valve Devkit IPC registration; never edits Steam's live shortcuts database.
use super::*;
use std::os::unix::fs::OpenOptionsExt;
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub(super) struct Binding {
pub game_id: String,
#[serde(default)]
pub native: bool,
#[serde(default)]
pub revision: String,
}
pub(super) fn game_id(id: &str) -> String {
format!("framely{}", hash(id))
}
pub(super) fn native_apk(home: &Path, id: &str) -> PathBuf {
home.join("devkit-game").join(game_id(id)).join("base.apk")
}
pub(super) fn wrapper(home: &Path, id: &str) -> PathBuf {
home.join("devkit-game").join(game_id(id)).join("launch.sh")
}
pub(super) fn quote(s: &str) -> String {
format!("'{}'", s.replace('\'', "'\\''"))
}
pub(super) fn write_owned(p: &Path, bytes: &[u8], mode: u32) -> Result<()> {
let parent = p.parent().context("Missing entry parent")?;
ensure!(
fs::symlink_metadata(parent)?.is_dir(),
"Invalid Devkit entry directory"
);
if let Ok(m) = fs::symlink_metadata(p) {
ensure!(
m.is_file() && !m.file_type().is_symlink(),
"Invalid Devkit entry file"
);
}
let tmp = parent.join(format!(
".framely-{}.tmp",
hex::encode(rand::random::<[u8; 16]>())
));
let mut f = fs::OpenOptions::new()
.write(true)
.create_new(true)
.mode(mode)
.open(&tmp)?;
f.write_all(bytes)?;
f.sync_all()?;
fs::rename(&tmp, p)?;
Ok(())
}
/// Same authenticated local pipe protocol as Valve's steam-devkit-rpc.
/// Token and complete command must never be logged.
pub(super) fn rpc(home: &Path, command: &str, id: Option<&str>) -> Result<String> {
ensure!(
matches!(
command,
"create-shortcut" | "list-shortcuts" | "run-game" | "delete-shortcut"
),
"Invalid Devkit command"
);
if let Some(id) = id {
ensure!(
!id.is_empty() && id.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_'),
"Invalid Devkit game ID"
);
}
let steam = home.join(".steam");
let token_path = steam.join("steam.token");
ensure!(
fs::metadata(&token_path)?.len() <= 256,
"Invalid Steam authentication file"
);
let token = fs::read_to_string(token_path)?;
let token = token.trim();
ensure!(
!token.is_empty() && token.bytes().all(|b| b.is_ascii_hexdigit()),
"Invalid Steam authentication token"
);
let pid = fs::read_to_string(steam.join("steam.pid"))?;
ensure!(runtime_pid_alive(pid.trim()), "Steam is not running");
// Steam's Devkit response writer accepts /tmp paths, but silently ignores
// responses in the application's persistent home directory on Frame.
// Match Valve's helper, using a private directory independent of TMPDIR.
let directory = tempfile::Builder::new()
.prefix("framely-steam-rpc-")
.tempdir_in("/tmp")?;
fs::set_permissions(directory.path(), fs::Permissions::from_mode(0o700))?;
let response = directory.path().join("response");
let mut q = url::form_urlencoded::Serializer::new(String::new());
q.append_pair(
"response",
response.to_str().context("Invalid response path")?,
);
if let Some(id) = id {
q.append_pair("gameid", id);
}
q.append_pair(
"directory",
home.join("devkit-game")
.to_str()
.context("Invalid Devkit path")?,
);
let pipe_path = steam.join("steam.pipe");
ensure!(
fs::metadata(&pipe_path)?.file_type().is_fifo(),
"Steam IPC pipe is unavailable"
);
let mut pipe = fs::OpenOptions::new()
.write(true)
.custom_flags(libc::O_NONBLOCK)
.open(pipe_path)
.context("Steam IPC is unavailable")?;
let command = format!(
"devkit-1 steam://devkit-1/{token}/{command}/?{}\n",
q.finish()
);
ensure!(command.len() < 4096, "Devkit request too large");
pipe.write_all(command.as_bytes())?;
drop(pipe);
let error = response.with_extension("error");
let lock = response.with_extension("lock");
let result = (|| {
let deadline = Instant::now() + Duration::from_secs(10);
loop {
if error.exists() {
ensure!(
fs::metadata(&error)?.len() <= 8192,
"Invalid Steam response"
);
bail!("Steam Devkit: {}", fs::read_to_string(&error)?.trim());
}
if response.exists() && !lock.exists() {
ensure!(
fs::metadata(&response)?.len() <= 65536,
"Steam response too large"
);
return Ok(fs::read_to_string(&response)?);
}
ensure!(
Instant::now() < deadline,
"Steam did not acknowledge the Devkit request; keep Steam awake and retry"
);
std::thread::sleep(Duration::from_millis(50));
}
})();
for p in [&response, &error, &lock] {
let _ = fs::remove_file(p);
}
result
}
pub(super) fn linked(home: &Path, r: &Record) -> bool {
r.steam_binding.as_ref().is_some_and(|b| {
b.game_id == game_id(&r.id)
&& if b.native {
native_apk(home, &r.id).is_file()
} else {
wrapper(home, &r.id).is_file()
}
})
}
pub(super) fn register(home: &Path, a: &App, r: &mut Record) -> Result<()> {
ensure!(
a.installed && a.state_known && !a.steam,
"Only installed sideloaded APKs can use a Steam entry"
);
let token = r
.steam_token
.get_or_insert_with(|| hex::encode(rand::random::<[u8; 32]>()))
.clone();
let game = game_id(&a.id);
let p = wrapper(home, &a.id);
let dir = p.parent().unwrap();
fs::create_dir_all(dir)?;
ensure!(
fs::symlink_metadata(dir)?.is_dir(),
"Invalid Steam entry directory"
);
fs::set_permissions(dir, fs::Permissions::from_mode(0o700))?;
let db = load(home)?;
let (_, c) = app(home, &db, &a.id)?;
let apk = installed(home, &c)?
.into_iter()
.find(|(m, _)| m.package == a.metadata.package)
.map(|(_, p)| p)
.context("Installed APK is unavailable; existing data was not changed")?;
store_apk(&apk, dir)?;
// A stable APK target lets Steam own the actual Lepton compatibility launch.
for (suffix, value) in [
("argv", json!(["./base.apk"])),
("env", json!({"LEPTON_NO_CLEANUP":"true"})),
(
"settings",
json!({"compat_tool":"fauxdroid","steam_play":"0"}),
),
] {
write_owned(
&home
.join("devkit-game")
.join(format!("{game}-{suffix}.json")),
&serde_json::to_vec(&value)?,
0o600,
)?;
}
let marker = dir.join("lepton-show-flatscreen");
if a.show_window.unwrap_or(!a.metadata.vr) {
write_owned(&marker, b"", 0o600)?;
} else if marker.exists() {
fs::remove_file(&marker)?;
}
r.steam_binding = Some(Binding {
game_id: game.clone(),
native: true,
revision: revision(a),
});
rpc(home, "create-shortcut", Some(&game))?;
let v: Value = serde_json::from_str(&rpc(home, "list-shortcuts", None)?)?;
ensure!(
v["version"] == 2
&& v["gameids"]
.as_array()
.is_some_and(|v| v.iter().any(|v| v == &game)),
"Steam did not register the APK entry"
);
let launch = format!(
"/var/lib/framely/current/bin/framely apk-native --app {} --token {} -- %command%",
quote(&a.id),
quote(&token)
);
let icon = icon_file(dir, &a.metadata)?;
r.steam_app_id = Some(super::steam_ui::configure(
&game,
r.steam_app_id,
&a.metadata.name,
icon.as_deref(),
&launch,
&native_apk(home, &a.id),
)?);
r.steam_binding = Some(Binding {
game_id: game,
native: true,
revision: revision(a),
});
Ok(())
}
pub(super) fn unregister(home: &Path, r: &Record) -> Result<()> {
if let Some(b) = &r.steam_binding {
ensure!(b.game_id == game_id(&r.id), "Invalid Steam APK binding");
if b.native {
if let Some(app_id) = r.steam_app_id {
steam_ui::clear_artwork(app_id, &native_apk(home, &r.id))?;
}
}
rpc(home, "delete-shortcut", Some(&b.game_id))?;
// Remove only our fixed configuration files, so the Devkit sync cannot
// re-register a disabled entry. Never recursively remove user content.
for suffix in ["argv", "settings", "env"] {
let p = home
.join("devkit-game")
.join(format!("{}-{suffix}.json", b.game_id));
if p.exists() {
fs::remove_file(p)?;
}
}
let p = wrapper(home, &r.id);
if p.exists() {
fs::remove_file(&p)?;
}
for name in [
"base.apk",
"icon.png",
"icon.webp",
"icon.jpg",
"lepton-show-flatscreen",
] {
let file = p.parent().unwrap().join(name);
if file.exists() {
ensure!(
fs::symlink_metadata(&file)?.is_file(),
"Invalid owned Steam file"
);
fs::remove_file(file)?;
}
}
let _ = fs::remove_dir(p.parent().unwrap());
}
Ok(())
}
fn revision(a: &App) -> String {
hash(&json!({"metadata":a.metadata,"showWindow":a.show_window}).to_string())
}
fn icon_file(dir: &Path, metadata: &Metadata) -> Result<Option<PathBuf>> {
use base64::Engine;
let Some(icon) = metadata.icon.as_deref() else {
return Ok(None);
};
let Some((prefix, data)) = icon.split_once(",") else {
return Ok(None);
};
ensure!(
matches!(
prefix,
"data:image/png;base64" | "data:image/jpeg;base64" | "data:image/webp;base64"
),
"Unsupported APK icon"
);
ensure!(data.len() <= 8 * 1024 * 1024, "APK icon is too large");
let bytes = base64::engine::general_purpose::STANDARD.decode(data)?;
let mut reader = image::ImageReader::new(std::io::Cursor::new(bytes)).with_guessed_format()?;
let mut limits = image::Limits::default();
limits.max_image_width = Some(4096);
limits.max_image_height = Some(4096);
limits.max_alloc = Some(64 * 1024 * 1024);
reader.limits(limits);
let picture = reader.decode()?.thumbnail(512, 512);
let path = dir.join("icon.png");
let mut png = std::io::Cursor::new(Vec::new());
picture.write_to(&mut png, image::ImageFormat::Png)?;
write_owned(&path, &png.into_inner(), 0o600)?;
Ok(Some(path))
}
// Preference and registration are separate: Steam can be asleep while the
// default-on choice remains enabled. An explicit opt-out is never auto-enabled.
pub(super) fn wanted(r: &Record) -> bool {
r.steam_preference
.unwrap_or(r.steam_launch || r.steam_token.is_none())
}
pub(super) fn ensure_registered(home: &Path, id: &str, force: bool) -> Result<bool> {
let _guard = MUTATION
.try_lock()
.map_err(|_| anyhow::anyhow!("Another APK operation is running"))?;
let directory = init(home)?;
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(directory.join("operation.lock"))?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another APK operation is running"
);
let mut db = load(home)?;
if db.records.get(id).is_some_and(|r| !wanted(r)) {
return Ok(false);
}
let (a, _) = app(home, &db, id)?;
if a.steam {
return Ok(false);
}
ensure!(
a.installed && a.state_known && a.pending.is_none(),
"Application state is unavailable for Steam registration"
);
ensure!(
!a.metadata.activities.is_empty() || a.activity.is_some(),
"No launch activity is available for Steam registration"
);
record_app(&mut db, &a);
let retain = db.retain_steam_entries;
let rec = db.records.get_mut(id).context("Missing APK record")?;
if !retain && !context_busy(home, rec) {
rec.steam_transient_generation = Some(hex::encode(rand::random::<[u8; 16]>()));
rec.steam_transient_expires = now() + 180;
}
rec.steam_preference = Some(true);
if !force
&& rec.steam_launch
&& linked(home, rec)
&& rec
.steam_binding
.as_ref()
.is_some_and(|b| b.native && b.revision == revision(&a))
{
save(home, &db)?;
return Ok(true);
}
let result = register(home, &a, rec);
rec.steam_launch = result.is_ok();
rec.steam_registration_error = result.as_ref().err().map(|e| format!("{e:#}"));
save(home, &db)?;
result?;
Ok(true)
}
static AUTO_WAKE: std::sync::OnceLock<std::sync::mpsc::SyncSender<()>> = std::sync::OnceLock::new();
pub(super) fn wake_registration() {
if let Some(sender) = AUTO_WAKE.get() {
let _ = sender.try_send(());
}
}
pub(super) fn synchronize(home: &Path) -> Result<()> {
// Query Steam once per pass, before inventory scanning; unavailable Steam
// defers registration without blocking UI startup or starting any container.
let v: Value = serde_json::from_str(&rpc(home, "list-shortcuts", None)?)?;
ensure!(v["version"] == 2, "Unknown Steam Devkit registry");
let registered: std::collections::BTreeSet<String> =
serde_json::from_value(v["gameids"].clone())?;
let db = load(home)?;
let cs = containers(home, &db);
let (inventory, _) = apps(home, &db, &cs, false);
for a in inventory {
if !a.installed
|| !a.state_known
|| a.steam
|| a.pending.is_some()
|| (a.metadata.activities.is_empty() && a.activity.is_none())
{
continue;
}
if db.records.get(&a.id).is_some_and(|r| !wanted(r)) {
continue;
}
if !db.retain_steam_entries {
let _ = cleanup_transient(home, &a.id, None);
continue;
}
let force = !registered.contains(&game_id(&a.id));
if !force
&& db.records.get(&a.id).is_some_and(|r| {
r.steam_preference == Some(true)
&& r.steam_launch
&& linked(home, r)
&& r.steam_binding
.as_ref()
.is_some_and(|b| b.native && b.revision == revision(&a))
})
{
continue;
}
let _ = ensure_registered(home, &a.id, force);
}
Ok(())
}
fn context_busy(home: &Path, r: &Record) -> bool {
if running(&r.context) || native::runtime_name(r).is_some_and(|name| running(&name)) {
return true;
}
let path = root(home)
.join("steam")
.join(format!("context-{}.lock", hash(&r.context)));
if !path.exists() {
return false;
}
let Ok(file) = fs::OpenOptions::new().write(true).open(path) else {
return true;
};
unsafe { libc::flock(file.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) != 0 }
}
pub(super) fn cleanup_transient(home: &Path, id: &str, completed: Option<&str>) -> Result<()> {
let _guard = MUTATION
.try_lock()
.map_err(|_| anyhow::anyhow!("Another APK operation is running"))?;
let directory = init(home)?;
let lock = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(directory.join("operation.lock"))?;
ensure!(
unsafe { libc::flock(lock.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } == 0,
"Another APK operation is running"
);
let mut db = load(home)?;
if db.retain_steam_entries {
return Ok(());
}
let Some(r) = db.records.get(id) else {
return Ok(());
};
if r.steam_binding.is_none() || r.pending.is_some() {
return Ok(());
}
if let Some(generation) = completed {
if r.steam_transient_generation.as_deref() != Some(generation) {
return Ok(());
}
} else if now() < r.steam_transient_expires {
return Ok(());
}
fs::create_dir_all(directory.join("steam"))?;
let ownership = fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(false)
.mode(0o600)
.open(
directory
.join("steam")
.join(format!("context-{}.lock", hash(&r.context))),
)?;
if unsafe { libc::flock(ownership.as_raw_fd(), libc::LOCK_EX | libc::LOCK_NB) } != 0
|| containers(home, &db)
.iter()
.any(|c| c.id == r.context && (c.running || wrapper_active(&c.name)))
{
return Ok(());
}
unregister(home, r)?;
let r = db.records.get_mut(id).unwrap();
r.steam_launch = false;
r.steam_binding = None;
r.steam_app_id = None;
r.steam_registration_error = None;
r.steam_transient_generation = None;
r.steam_transient_expires = 0;
save(home, &db)
}
pub(super) fn start_auto_registration() {
let (tx, rx) = std::sync::mpsc::sync_channel(1);
if AUTO_WAKE.set(tx).is_err() {
return;
}
std::thread::spawn(move || loop {
if let Ok(home) = crate::steam::home() {
let _ = synchronize(&home);
}
let _ = rx.recv_timeout(Duration::from_secs(20));
for _ in 0..64 {
if rx.try_recv().is_err() {
break;
}
}
});
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn preferences_migrate_default_on_and_preserve_legacy_explicit_disables() {
let mut r = Record::default();
assert!(wanted(&r));
let mut value = serde_json::to_value(&r).unwrap();
value.as_object_mut().unwrap().remove("steamPreference");
assert!(wanted(&serde_json::from_value::<Record>(value).unwrap()));
r.steam_token = Some("legacy".into());
assert!(!wanted(&r));
r.steam_launch = true;
assert!(wanted(&r));
r.steam_preference = Some(false);
assert!(!wanted(&r));
r.steam_preference = Some(true);
r.steam_launch = false;
assert!(wanted(&r));
}
#[test]
fn devkit_ids_are_stable_safe_and_unique() {
let a = game_id("ctx/com.test.app");
assert_eq!(a, game_id("ctx/com.test.app"));
assert_ne!(a, game_id("other/com.test.app"));
assert!(a.bytes().all(|b| b.is_ascii_alphanumeric()));
}
#[test]
fn owned_entry_rejects_symlinks() {
let t = tempfile::tempdir().unwrap();
let target = t.path().join("data");
fs::write(&target, b"preserve").unwrap();
let p = t.path().join("launch.sh");
std::os::unix::fs::symlink(&target, &p).unwrap();
assert!(write_owned(&p, b"replace", 0o700).is_err());
assert_eq!(fs::read(target).unwrap(), b"preserve");
}
}
+210
View File
@@ -0,0 +1,210 @@
//! Local Steam UI API: metadata and launch options, never edits live VDF files.
use super::*;
use std::{
io::Read,
net::{SocketAddr, TcpStream},
};
use tungstenite::{client, protocol::WebSocketConfig, Message};
#[cfg(test)]
thread_local! {pub(super) static TEST_RESULT: std::cell::RefCell<Option<Value>>= const {std::cell::RefCell::new(None)};}
pub(crate) fn evaluate(expression: &str) -> Result<Value> {
#[cfg(test)]
if let Some(value) = TEST_RESULT.with(|v| v.borrow().clone()) {
return Ok(value);
}
let agent = ureq::AgentBuilder::new()
.timeout(Duration::from_secs(3))
.build();
let mut bytes = Vec::new();
agent
.get("http://127.0.0.1:8080/json")
.call()
.context("Steam UI connection is unavailable; keep Steam awake and retry")?
.into_reader()
.take(1024 * 1024 + 1)
.read_to_end(&mut bytes)?;
ensure!(
bytes.len() <= 1024 * 1024,
"Steam UI discovery response is too large"
);
let pages: Vec<Value> = serde_json::from_slice(&bytes)?;
let page = pages
.iter()
.find(|p| {
p["title"] == "SharedJSContext"
&& p["url"]
.as_str()
.is_some_and(|u| u.starts_with("https://steamloopback.host/"))
})
.context("Steam library UI is not ready; keep Steam awake and retry")?;
let address = url::Url::parse(
page["webSocketDebuggerUrl"]
.as_str()
.context("Missing Steam UI endpoint")?,
)?;
ensure!(
address.scheme() == "ws"
&& address.host_str() == Some("127.0.0.1")
&& address.port() == Some(8080)
&& address.path().starts_with("/devtools/page/"),
"Invalid Steam UI endpoint"
);
let stream = TcpStream::connect_timeout(
&SocketAddr::from(([127, 0, 0, 1], 8080)),
Duration::from_secs(3),
)?;
stream.set_read_timeout(Some(Duration::from_secs(6)))?;
stream.set_write_timeout(Some(Duration::from_secs(3)))?;
let (mut ws, _) = client(address.as_str(), stream)
.map_err(|_| anyhow::anyhow!("Cannot connect to Steam UI"))?;
ws.set_config(|c| {
*c = WebSocketConfig::default()
.max_message_size(Some(4 * 1024 * 1024))
.max_frame_size(Some(4 * 1024 * 1024));
});
ws.send(Message::Text(
json!({"id":1,"method":"Runtime.evaluate","params":{
"expression":expression,"returnByValue":true,"awaitPromise":true
}})
.to_string()
.into(),
))?;
let deadline = Instant::now() + Duration::from_secs(8);
loop {
ensure!(Instant::now() < deadline, "Steam UI request timed out");
let message = ws
.read()
.map_err(|_| anyhow::anyhow!("Steam UI request failed"))?;
if let Message::Text(text) = message {
let v: Value = serde_json::from_str(&text)?;
if v["id"] != 1 {
continue;
}
// Do not return JavaScript exception descriptions: they can contain launch tokens.
ensure!(
v.get("error").is_none() && v["result"].get("exceptionDetails").is_none(),
"Steam UI operation failed"
);
return Ok(v["result"]["result"]["value"].clone());
}
}
}
pub(super) fn configure(
game: &str,
previous: Option<u32>,
name: &str,
icon: Option<&Path>,
launch: &str,
executable: &Path,
) -> Result<u32> {
let art = artwork(icon)?;
let parameters = json!({"game":game,"previous":previous,"name":name,
"icon":icon,"launch":launch,"exe":executable,"art":art});
let expression = format!(
r#"(async()=>{{
const p={parameters};
const owned=await ({lookup})(p);
const id=owned.id;
SteamClient.Apps.SetShortcutLaunchOptions(id,p.launch);
SteamClient.Apps.SetShortcutName(id,p.name);
if(p.icon) SteamClient.Apps.SetShortcutIcon(id,p.icon);
for(const a of p.art){{
try{{await SteamClient.Apps.SetCustomArtworkForApp(id,a.data,'png',a.kind)}}
catch(e){{
await new Promise(r=>setTimeout(r,200));
await SteamClient.Apps.SetCustomArtworkForApp(id,a.data,'png',a.kind);
}}
}}
return id;
}})()"#,
lookup = include_str!("steam_shortcut_lookup.js")
);
let result = evaluate(&expression)?;
result
.as_u64()
.and_then(|v| u32::try_from(v).ok())
.filter(|v| *v >= 0x80000000)
.context("Invalid Steam APK App ID")
}
fn artwork(icon: Option<&Path>) -> Result<Vec<Value>> {
use base64::Engine;
let Some(path) = icon else { return Ok(vec![]) };
let image = image::open(path)?.to_rgba8();
let mut out = Vec::new();
for (kind, w, h) in [(0, 600, 900), (1, 1280, 720), (3, 920, 430), (4, 512, 512)] {
let mut canvas = image::RgbaImage::from_pixel(w, h, image::Rgba([22, 24, 27, 255]));
let size = if kind == 4 {
512
} else {
(w.min(h) * 3 / 5).min(360)
};
let icon = image::imageops::thumbnail(&image, size, size);
image::imageops::overlay(
&mut canvas,
&icon,
((w - icon.width()) / 2) as i64,
((h - icon.height()) / 2) as i64,
);
let mut bytes = std::io::Cursor::new(Vec::new());
image::DynamicImage::ImageRgba8(canvas).write_to(&mut bytes, image::ImageFormat::Png)?;
out.push(json!({"kind":kind,"data":base64::engine::general_purpose::STANDARD.encode(bytes.into_inner())}));
}
Ok(out)
}
pub(super) fn clear_artwork(app_id: u32, executable: &Path) -> Result<()> {
ensure!(app_id >= 0x80000000, "Invalid owned Steam shortcut ID");
let parameters = json!({"id":app_id,"exe":executable});
evaluate(&format!(
r#"(async()=>{{
const p={parameters};
const app=appStore.m_mapApps.get(p.id);
if(!app) return;
let sub;
const details=await new Promise((resolve,reject)=>{{
const timer=setTimeout(()=>{{sub?.unregister();reject(Error('Details timed out'))}},3000);
sub=SteamClient.Apps.RegisterForAppDetails(p.id,d=>{{clearTimeout(timer);sub?.unregister();resolve(d)}});
}});
sub?.unregister();
const exe=details.strShortcutExe?.replace(/^"|"$/g,'').replace('/./','/');
if(exe!==p.exe) throw Error('Shortcut target does not match owned APK');
for(const kind of [0,1,3,4]) await SteamClient.Apps.ClearCustomArtworkForApp(p.id,kind);
await SteamClient.Apps.SetShortcutIcon(p.id,'');
}})()"#
))?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn steam_artwork_has_matching_aspect_ratios_and_never_crops_icon() {
use base64::Engine;
let t = tempfile::tempdir().unwrap();
let p = t.path().join("icon.png");
image::RgbaImage::from_pixel(128, 64, image::Rgba([230, 30, 20, 255]))
.save(&p)
.unwrap();
let art = artwork(Some(&p)).unwrap();
assert_eq!(art.len(), 4);
for (a, expected) in art
.iter()
.zip([(600, 900), (1280, 720), (920, 430), (512, 512)])
{
let b = base64::engine::general_purpose::STANDARD
.decode(a["data"].as_str().unwrap())
.unwrap();
let i = image::load_from_memory(&b).unwrap().to_rgba8();
assert_eq!(i.dimensions(), expected);
assert_eq!(
i.get_pixel(expected.0 / 2, expected.1 / 2).0,
[230, 30, 20, 255]
);
}
assert!(artwork(None).unwrap().is_empty());
}
}
+164
View File
@@ -0,0 +1,164 @@
//! Resource and Mesa cache directories remain inside the backed-up context,
//! but outside data_overlay so downloads do not pay OverlayFS write costs.
use anyhow::{ensure, Result};
use std::{fs, path::Path, process::Command};
pub(super) fn prepare(baked: &Path) -> Result<()> {
ensure!(baked.is_absolute(), "Container data path must be absolute");
ensure!(
!baked.is_symlink(),
"Container data directory cannot be a link"
);
let cache = baked.join("shadercache");
ensure!(
!cache.is_symlink(),
"Shader cache directory cannot be a link"
);
fs::create_dir_all(cache)?;
Ok(())
}
pub(super) fn configure(command: &mut Command, baked: &Path, adopted: bool) {
// An inherited Steam compat path can make Lepton relocate a development
// context. Only adopted Steam contexts should receive that variable.
command
.env_remove("FRAMELY_EXTERNAL_MEDIA_DIR")
.env_remove("STEAM_COMPAT_SHADER_PATH")
.env("FRAMELY_SHADER_CACHE_DIR", baked.join("shadercache"));
if !adopted {
command
.env_remove("STEAM_COMPAT_DATA_PATH")
.env("FRAMELY_EXTERNAL_MEDIA_DIR", baked.join("external"));
}
}
pub(super) const HOOKS: &str = r#"
function framely_prepare_external_media() {
local media="$(data_mount_path)/media/0"
local external="${FRAMELY_EXTERNAL_MEDIA_DIR:?}"
[[ "$external" == /* && "$external" != "$media" && ! -L "$external" ]] || {
echo "Invalid Android external storage directory" >&2; return 64;
}
if [[ -e "$external" && ! -d "$external" ]]; then
echo "Android external storage is not a directory" >&2; return 64
fi
if [[ -L "$media" ]]; then
[[ "$(readlink "$media")" == "$external" && -d "$external" ]] || {
echo "Unexpected Android media link; refusing to replace it" >&2; return 64;
}
return 0
fi
if [[ -d "$media" ]]; then
if [[ -z "$(find "$media" -mindepth 1 -maxdepth 1 -print -quit)" ]]; then
rmdir -- "$media" || return
else
if [[ -d "$external" ]]; then
[[ -z "$(find "$external" -mindepth 1 -maxdepth 1 -print -quit)" ]] || {
echo "Both Android media locations contain data; refusing to discard either" >&2; return 64;
}
rmdir -- "$external" || return
fi
# Both paths belong to the same context filesystem. Rename keeps
# partial downloads, checkpoints and file ownership intact.
mv -T -- "$media" "$external" || return
fi
elif [[ -e "$media" ]]; then
echo "Invalid Android media location" >&2; return 64
fi
mkdir -p -- "$external" "$(dirname "$media")" || return
ln -s -- "$external" "$media"
}
"#;
#[cfg(test)]
mod tests {
use super::*;
use std::os::unix::{fs::symlink, fs::MetadataExt};
fn migrate(data: &Path, external: &Path) -> bool {
Command::new("bash")
.args(["-euc", &format!("function data_mount_path() {{ echo \"$TEST_DATA\"; }}\n{HOOKS}\nframely_prepare_external_media")])
.env("TEST_DATA", data)
.env("FRAMELY_EXTERNAL_MEDIA_DIR", external)
.env("BASH_ENV", "/dev/null")
.status()
.unwrap()
.success()
}
#[test]
fn resource_migration_preserves_inodes_and_resumes_after_interruption() {
let dir = tempfile::tempdir().unwrap();
let data = dir.path().join("data_overlay");
let external = dir.path().join("external");
let resource = Path::new("Android/data/game/files/resource.part");
let original = data.join("media/0").join(resource);
fs::create_dir_all(original.parent().unwrap()).unwrap();
fs::write(&original, b"unfinished download").unwrap();
fs::write(original.with_file_name("checkpoint"), b"offset=19").unwrap();
let inode = fs::metadata(&original).unwrap().ino();
assert!(migrate(&data, &external));
assert_eq!(fs::metadata(external.join(resource)).unwrap().ino(), inode);
assert!(migrate(&data, &external));
assert_eq!(fs::read(&original).unwrap(), b"unfinished download");
assert_eq!(
fs::read(original.with_file_name("checkpoint")).unwrap(),
b"offset=19"
);
// Power loss after rename but before symlink creation is recoverable.
fs::remove_file(data.join("media/0")).unwrap();
assert!(migrate(&data, &external));
assert_eq!(fs::metadata(&original).unwrap().ino(), inode);
}
#[test]
fn migration_refuses_conflicting_data_and_unexpected_links() {
let dir = tempfile::tempdir().unwrap();
let data = dir.path().join("data_overlay");
let media = data.join("media/0");
let external = dir.path().join("external");
fs::create_dir_all(&media).unwrap();
fs::create_dir(&external).unwrap();
fs::write(media.join("resource"), b"original").unwrap();
fs::write(external.join("resource"), b"other").unwrap();
assert!(!migrate(&data, &external));
assert_eq!(fs::read(media.join("resource")).unwrap(), b"original");
assert_eq!(fs::read(external.join("resource")).unwrap(), b"other");
fs::remove_dir_all(&media).unwrap();
symlink(dir.path(), &media).unwrap();
assert!(!migrate(&data, &external));
assert_eq!(fs::read_link(&media).unwrap(), dir.path());
fs::remove_file(&media).unwrap();
fs::remove_dir_all(&external).unwrap();
symlink(dir.path(), &external).unwrap();
assert!(!migrate(&data, &external));
}
#[test]
fn cache_is_persistent_and_adopted_contexts_keep_their_compat_path() {
let dir = tempfile::tempdir().unwrap();
let baked = dir.path().join("baked");
prepare(&baked).unwrap();
let cache = baked.join("shadercache/compiled");
fs::write(&cache, b"shader").unwrap();
prepare(&baked).unwrap();
assert_eq!(fs::read(&cache).unwrap(), b"shader");
for adopted in [false, true] {
let mut command = Command::new("true");
command.env("STEAM_COMPAT_DATA_PATH", "/steam/compat");
configure(&mut command, &baked, adopted);
let env: std::collections::BTreeMap<_, _> = command.get_envs().collect();
assert_eq!(
env[std::ffi::OsStr::new("STEAM_COMPAT_DATA_PATH")],
adopted.then_some(std::ffi::OsStr::new("/steam/compat"))
);
assert_eq!(
env[std::ffi::OsStr::new("FRAMELY_EXTERNAL_MEDIA_DIR")],
(!adopted).then_some(baked.join("external").as_os_str())
);
}
fs::remove_dir_all(baked.join("shadercache")).unwrap();
symlink(dir.path(), baked.join("shadercache")).unwrap();
assert!(prepare(&baked).is_err());
}
}
+918
View File
@@ -0,0 +1,918 @@
//! Bounded Android binary XML/resource reader. No APK code is executed.
use anyhow::{bail, ensure, Context, Result};
use base64::{engine::general_purpose::STANDARD, Engine};
use serde::{Deserialize, Serialize};
use std::{collections::BTreeMap, fs::File, io::Read, path::Path};
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Metadata {
pub package: String,
pub name: String,
pub version: String,
pub version_code: u64,
pub min_sdk: u32,
pub activities: Vec<String>,
pub declared_activities: Vec<String>,
pub icon: Option<String>,
pub abis: Vec<String>,
pub vr: bool,
}
fn u16at(b: &[u8], p: usize) -> Result<u16> {
Ok(u16::from_le_bytes(
b.get(p..p + 2)
.context("Truncated APK metadata")?
.try_into()?,
))
}
fn u32at(b: &[u8], p: usize) -> Result<u32> {
Ok(u32::from_le_bytes(
b.get(p..p + 4)
.context("Truncated APK metadata")?
.try_into()?,
))
}
fn string_len(b: &[u8], p: &mut usize, utf8: bool) -> Result<usize> {
if utf8 {
let a = *b.get(*p).context("Invalid string length")?;
*p += 1;
if a & 128 != 0 {
let v =
((a as usize & 127) << 8) | *b.get(*p).context("Invalid string length")? as usize;
*p += 1;
Ok(v)
} else {
Ok(a as usize)
}
} else {
let a = u16at(b, *p)?;
*p += 2;
if a & 0x8000 != 0 {
let v = ((a as usize & 0x7fff) << 16) | u16at(b, *p)? as usize;
*p += 2;
Ok(v)
} else {
Ok(a as usize)
}
}
}
// Android resource pools can encode supplementary characters as two UTF-8
// surrogate code units (CESU-8), rather than one standard four-byte sequence.
// Decode only those extensions; malformed UTF-8 and unpaired surrogates remain
// errors instead of silently replacing package metadata.
fn android_utf8(b: &[u8]) -> Result<String> {
if let Ok(s) = std::str::from_utf8(b) {
return Ok(s.to_owned());
}
let mut units = Vec::new();
let mut remaining = b;
while !remaining.is_empty() {
match std::str::from_utf8(remaining) {
Ok(s) => {
units.extend(s.encode_utf16());
break;
}
Err(e) => {
let valid = e.valid_up_to();
units.extend(std::str::from_utf8(&remaining[..valid])?.encode_utf16());
remaining = &remaining[valid..];
if remaining.starts_with(&[0xc0, 0x80]) {
// Modified UTF-8's encoding of NUL.
units.push(0);
remaining = &remaining[2..];
} else if remaining.len() >= 3
&& remaining[0] == 0xed
&& (0xa0..=0xbf).contains(&remaining[1])
&& (0x80..=0xbf).contains(&remaining[2])
{
units.push(
((remaining[0] as u16 & 15) << 12)
| ((remaining[1] as u16 & 63) << 6)
| (remaining[2] as u16 & 63),
);
remaining = &remaining[3..];
} else {
bail!("Invalid Android resource string encoding");
}
}
}
}
String::from_utf16(&units).context("Unpaired surrogate in Android resource string")
}
fn strings(b: &[u8]) -> Result<Vec<String>> {
let count = u32at(b, 8)? as usize;
ensure!(count <= 262144, "APK string pool is too large");
let utf8 = u32at(b, 16)? & 256 != 0;
let start = u32at(b, 20)? as usize;
let header = u16at(b, 2)? as usize;
let styles = u32at(b, 12)? as usize;
let style_start = u32at(b, 24)? as usize;
ensure!(
header >= 28 && start >= header + (count + styles) * 4 && start <= b.len(),
"Invalid APK string pool layout"
);
let end = if style_start == 0 {
b.len()
} else {
style_start
};
ensure!(
end >= start && end <= b.len(),
"Invalid APK string data bounds"
);
let data = &b[..end];
(0..count)
.map(|i| {
let mut p = start
.checked_add(u32at(b, header + i * 4)? as usize)
.context("Invalid string offset")?;
let n = string_len(data, &mut p, utf8)?;
if utf8 {
let bytes = string_len(data, &mut p, true)?;
let s = android_utf8(data.get(p..p + bytes).context("Invalid APK string")?)
.with_context(|| format!("Invalid APK string pool entry {i}"))?;
ensure!(data.get(p + bytes) == Some(&0), "Unterminated APK string");
// Older AAPT versions truncate encoded lengths to 15 bits.
ensure!(
s.encode_utf16().count() & 0x7fff == n,
"Invalid APK string length"
);
Ok(s)
} else {
let bytes = data.get(p..p + n * 2).context("Invalid UTF16 string")?;
ensure!(
u16at(data, p + n * 2)? == 0,
"Unterminated UTF16 APK string"
);
Ok(String::from_utf16(
&bytes
.chunks_exact(2)
.map(|s| u16::from_le_bytes([s[0], s[1]]))
.collect::<Vec<_>>(),
)?)
}
})
.collect()
}
fn chunks(b: &[u8], mut p: usize) -> Result<Vec<&[u8]>> {
let mut out = Vec::new();
while p < b.len() {
let n = u32at(b, p + 4)? as usize;
ensure!(n >= 8 && n <= b.len() - p, "Invalid APK chunk size");
out.push(&b[p..p + n]);
p += n;
}
Ok(out)
}
#[derive(Clone)]
enum Val {
Text(String),
Ref(u32),
Int(u32),
}
fn val(b: &[u8], p: usize, s: &[String]) -> Result<Val> {
let typ = *b.get(p + 3).context("Invalid value")?;
let v = u32at(b, p + 4)?;
value(typ, v, s)
}
fn value(typ: u8, v: u32, s: &[String]) -> Result<Val> {
Ok(match typ {
3 => Val::Text(
s.get(v as usize)
.context("Invalid string reference")?
.clone(),
),
1 => Val::Ref(v),
_ => Val::Int(v),
})
}
fn icon_mime(path: &str) -> Option<&'static str> {
if path.ends_with(".png") {
Some("image/png")
} else if path.ends_with(".webp") {
Some("image/webp")
} else if path.ends_with(".jpg") || path.ends_with(".jpeg") {
Some("image/jpeg")
} else {
None
}
}
fn resource_image_rank(value: &Val, density: u16) -> Option<(bool, u16)> {
let raster = match value {
Val::Text(path) if path.starts_with("res/") => icon_mime(path).is_some(),
Val::Ref(_) => false,
_ => return None,
};
// Any-dpi XML is not a bitmap. Prefer a full raster launcher icon over
// unsupported adaptive/vector XML, then the highest packaged density.
Some((
raster,
match density {
0 => 160,
0xfffe | 0xffff => 0,
d => d,
},
))
}
fn resources(b: &[u8]) -> Result<BTreeMap<u32, Val>> {
let mut map = BTreeMap::new();
let mut image_ranks = BTreeMap::new();
let mut pool = Vec::new();
for c in chunks(b, u16at(b, 2)? as usize)? {
match u16at(c, 0)? {
1 => pool = strings(c)?,
0x200 => {
let pkg = u32at(c, 8)?;
for t in chunks(c, u16at(c, 2)? as usize)? {
if u16at(t, 0)? != 0x201 {
continue;
}
let type_offset = if u16at(c, 2)? >= 288 {
u32at(c, 284)?
} else {
0
};
let id = (*t.get(8).context("Invalid resource type")? as u32)
.checked_add(type_offset)
.context("Invalid APK resource type offset")?;
ensure!(id > 0 && id <= 255, "Invalid APK resource type ID");
let flags = *t.get(9).context("Invalid resource type flags")?;
if flags & !3 != 0 {
continue;
}
ensure!(flags != 3, "Conflicting APK resource offset formats");
let count = u32at(t, 12)? as usize;
let start = u32at(t, 16)? as usize;
let h = u16at(t, 2)? as usize;
// ResTable_config starts at byte 20; density is byte 14.
let density = if h >= 36 && u32at(t, 20)? >= 16 {
u16at(t, 34)?
} else {
0
};
ensure!(count <= 65536, "Too many APK resources");
let stride = if flags == 2 { 2 } else { 4 };
ensure!(
h >= 20 && start >= h + count * stride && start <= t.len(),
"Invalid APK resource entry table"
);
for i in 0..count {
let (index, offset) = match flags {
1 => (
u16at(t, h + i * 4)? as u32,
u16at(t, h + i * 4 + 2)? as usize * 4,
),
2 => {
let offset = u16at(t, h + i * 2)?;
if offset == u16::MAX {
continue;
}
(i as u32, offset as usize * 4)
}
_ => {
let offset = u32at(t, h + i * 4)?;
if offset == u32::MAX {
continue;
}
(i as u32, offset as usize)
}
};
let e = start + offset as usize;
let size = u16at(t, e)? as usize;
let entry_flags = u16at(t, e + 2)?;
if entry_flags & 1 != 0 {
continue;
}
let key = (pkg << 24) | (id << 16) | index;
let v = if entry_flags & 8 != 0 {
value((entry_flags >> 8) as u8, u32at(t, e + 4)?, &pool)?
} else {
ensure!(size >= 8, "Invalid APK resource entry size");
val(t, e + size, &pool)?
};
if let Some(rank) = resource_image_rank(&v, density) {
if image_ranks
.get(&key)
.is_none_or(|previous| rank > *previous)
{
image_ranks.insert(key, rank);
map.insert(key, v);
}
} else {
// Labels and other text retain their existing fallback;
// selecting a larger icon must not change their language.
map.entry(key).or_insert(v);
}
}
}
}
_ => {}
}
}
Ok(map)
}
fn text(v: Option<&Val>, r: &BTreeMap<u32, Val>) -> String {
let mut v = v;
for _ in 0..16 {
match v {
Some(Val::Text(s)) => return s.clone(),
Some(Val::Int(n)) => return n.to_string(),
Some(Val::Ref(id)) => v = r.get(id),
None => break,
}
}
String::new()
}
fn numeric(v: Option<&Val>) -> u32 {
match v {
Some(Val::Int(n)) => *n,
Some(Val::Text(s)) => s.parse().unwrap_or(0),
_ => 0,
}
}
pub fn valid_package(s: &str) -> bool {
s.len() <= 255
&& s.contains('.')
&& s.split('.').all(|p| {
!p.is_empty()
&& p.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_')
&& !p.as_bytes()[0].is_ascii_digit()
})
}
fn activity(p: &str, n: &str) -> String {
if n.starts_with('.') {
format!("{p}{n}")
} else if !n.contains('.') {
format!("{p}.{n}")
} else {
n.into()
}
}
fn xml(b: &[u8], r: &BTreeMap<u32, Val>) -> Result<Metadata> {
ensure!(u16at(b, 0)? == 3, "APK manifest must be Android binary XML");
let mut m = Metadata::default();
let mut pool = Vec::new();
let mut stack: Vec<String> = Vec::new();
let mut current = None::<(String, bool, bool, bool, bool)>;
let mut label = None;
let mut icon = None;
let mut app_enabled = true;
for c in chunks(b, u16at(b, 2)? as usize)? {
match u16at(c, 0)? {
1 => pool = strings(c)?,
0x102 => {
let tag = pool
.get(u32at(c, 20)? as usize)
.context("Invalid XML element")?
.clone();
let start = 16 + u16at(c, 24)? as usize;
let stride = u16at(c, 26)? as usize;
let count = u16at(c, 28)? as usize;
ensure!(stride >= 20 && count <= 4096, "Invalid XML attributes");
let mut attrs = BTreeMap::new();
for i in 0..count {
let p = start + i * stride;
let name = pool
.get(u32at(c, p + 4)? as usize)
.context("Invalid XML attribute")?
.clone();
attrs.insert(name, val(c, p + 12, &pool)?);
}
match tag.as_str() {
"manifest" => {
m.package = text(attrs.get("package"), r);
m.version = text(attrs.get("versionName"), r);
m.version_code = numeric(attrs.get("versionCode")) as u64
| ((numeric(attrs.get("versionCodeMajor")) as u64) << 32);
}
"uses-sdk" => m.min_sdk = numeric(attrs.get("minSdkVersion")),
"application" => {
label = attrs.get("label").cloned();
icon = attrs.get("icon").cloned();
app_enabled = attrs.get("enabled").is_none_or(|v| numeric(Some(v)) != 0);
}
"activity" | "activity-alias" => {
let n = activity(&m.package, &text(attrs.get("name"), r));
let enabled = app_enabled
&& attrs.get("enabled").is_none_or(|v| numeric(Some(v)) != 0)
&& attrs.get("exported").is_none_or(|v| numeric(Some(v)) != 0);
m.declared_activities.push(n.clone());
current = Some((n, enabled, false, false, false));
}
"intent-filter" => {
if let Some(a) = current.as_mut() {
a.2 = false;
a.3 = false;
}
}
"action" => {
if let Some(a) = current.as_mut() {
if text(attrs.get("name"), r) == "android.intent.action.MAIN" {
a.2 = true;
}
}
}
"category" => {
let name = text(attrs.get("name"), r);
if let Some(a) = current.as_mut() {
if [
"android.intent.category.LAUNCHER",
"android.intent.category.LEANBACK_LAUNCHER",
"com.oculus.intent.category.VR",
]
.contains(&name.as_str())
{
a.3 = true;
}
}
if name == "com.oculus.intent.category.VR" {
m.vr = true;
}
}
"meta-data" => {
let name = text(attrs.get("name"), r);
if name == "com.samsung.android.vr.application.mode"
|| name == "com.oculus.supportedDevices"
{
m.vr = true;
}
}
_ => {}
}
stack.push(tag);
}
0x103 => {
let tag = stack.pop().context("Unbalanced APK XML")?;
if tag == "intent-filter" {
if let Some(a) = current.as_mut() {
a.4 |= a.2 && a.3;
}
}
if tag == "activity" || tag == "activity-alias" {
if let Some((n, enabled, main, launcher, matched)) = current.take() {
if enabled && (matched || main && launcher) {
m.activities.push(n);
}
}
}
}
_ => {}
}
}
ensure!(valid_package(&m.package), "Invalid APK package name");
m.name = text(label.as_ref(), r);
if m.name.is_empty() {
m.name = m.package.clone();
}
if m.version.is_empty() {
m.version = m.version_code.to_string();
}
let path = text(icon.as_ref(), r);
if path.starts_with("res/") {
m.icon = Some(path);
}
m.activities.sort();
m.activities.dedup();
Ok(m)
}
fn entry(z: &mut zip::ZipArchive<File>, name: &str, max: u64) -> Result<Vec<u8>> {
let mut f = z.by_name(name)?;
ensure!(f.size() <= max, "APK metadata exceeds size limit");
let mut b = Vec::new();
f.by_ref().take(max + 1).read_to_end(&mut b)?;
ensure!(b.len() as u64 <= max, "APK metadata exceeds size limit");
Ok(b)
}
pub fn read(path: &Path) -> Result<Metadata> {
let mut z = zip::ZipArchive::new(File::open(path)?).context("Invalid APK archive")?;
ensure!(z.len() <= 65536, "Too many APK files");
let r = match entry(&mut z, "resources.arsc", 64 * 1024 * 1024) {
Ok(b) => resources(&b).context("Cannot parse APK resource table")?,
Err(e) => {
if z.by_name("resources.arsc").is_ok() {
return Err(e);
}
BTreeMap::new()
}
};
let b = entry(&mut z, "AndroidManifest.xml", 8 * 1024 * 1024)?;
let mut m = xml(&b, &r).context("Cannot parse APK manifest")?;
if let Some(path) = m.icon.take() {
let mime = icon_mime(&path);
if let Some(mime) = mime {
if let Ok(b) = entry(&mut z, &path, 2 * 1024 * 1024) {
m.icon = Some(format!("data:{mime};base64,{}", STANDARD.encode(b)));
}
}
}
for i in 0..z.len() {
let f = z.by_index(i)?;
if let Some(p) = f.name().strip_prefix("lib/") {
if let Some((abi, _)) = p.split_once('/') {
if !m.abis.contains(&abi.to_string()) {
m.abis.push(abi.into());
}
}
}
}
if !m.abis.is_empty()
&& !m
.abis
.iter()
.any(|a| a == "arm64-v8a" || a == "armeabi-v7a")
{
bail!("APK has no compatible ARM libraries");
}
Ok(m)
}
#[cfg(test)]
mod tests {
use super::*;
fn utf8_pool(entries: &[(u8, &[u8])]) -> Vec<u8> {
let start = 28 + entries.len() * 4;
let mut data = Vec::new();
let mut offsets = Vec::new();
for (units, bytes) in entries {
offsets.push(data.len() as u32);
data.extend([*units, bytes.len() as u8]);
data.extend(*bytes);
data.push(0);
}
let mut pool = Vec::new();
pool.extend(1u16.to_le_bytes());
pool.extend(28u16.to_le_bytes());
pool.extend(((start + data.len()) as u32).to_le_bytes());
pool.extend((entries.len() as u32).to_le_bytes());
pool.extend(0u32.to_le_bytes());
pool.extend(256u32.to_le_bytes());
pool.extend((start as u32).to_le_bytes());
pool.extend(0u32.to_le_bytes());
for offset in offsets {
pool.extend(offset.to_le_bytes());
}
pool.extend(data);
pool
}
#[test]
fn android_resource_strings_accept_cesu8_and_standard_utf8() {
// Moonlight V+ resources start with CESU-8 emoji, e.g. "🌐 Bitrate".
let pool = utf8_pool(&[
(10, b"\xed\xa0\xbc\xed\xbc\x90 Bitrate"),
(5, "中文 🌸".as_bytes()),
(3, b"a\xc0\x80b"),
]);
assert_eq!(strings(&pool).unwrap(), ["🌐 Bitrate", "中文 🌸", "a\0b"]);
for invalid in [
&b"\xed\xa0\xbc"[..], // Unpaired high surrogate.
&b"\xed\xbc\x90"[..], // Unpaired low surrogate.
&b"\xed\xa0"[..],
&b"\xff"[..],
&b"\xc0\xaf"[..], // Overlong encoding must not be accepted.
&b"\xf4\x90\x80\x80"[..],
] {
assert!(strings(&utf8_pool(&[(1, invalid)])).is_err());
}
assert!(strings(&utf8_pool(&[(1, b"two")])).is_err());
let mut unterminated = utf8_pool(&[(1, b"a")]);
*unterminated.last_mut().unwrap() = 1;
assert!(strings(&unterminated).is_err());
}
#[test]
fn utf16_resource_strings_and_string_bounds() {
let units: Vec<u16> = "中文 🌸".encode_utf16().collect();
let mut pool = utf8_pool(&[]);
pool[8..12].copy_from_slice(&1u32.to_le_bytes());
pool[16..20].copy_from_slice(&0u32.to_le_bytes());
pool[20..24].copy_from_slice(&32u32.to_le_bytes());
pool.extend(0u32.to_le_bytes());
pool.extend((units.len() as u16).to_le_bytes());
for unit in units {
pool.extend(unit.to_le_bytes());
}
pool.extend(0u16.to_le_bytes());
let len = pool.len() as u32;
pool[4..8].copy_from_slice(&len.to_le_bytes());
assert_eq!(strings(&pool).unwrap(), ["中文 🌸"]);
pool.pop();
assert!(strings(&pool).is_err());
let mut pool = utf8_pool(&[(1, b"a")]);
pool[20..24].copy_from_slice(&0u32.to_le_bytes());
assert!(strings(&pool).is_err());
let mut pool = utf8_pool(&[(1, b"a")]);
pool[28..32].copy_from_slice(&u32::MAX.to_le_bytes());
assert!(strings(&pool).is_err());
}
#[test]
fn launcher_icon_uses_high_density_raster_independent_of_table_order() {
let names = [
"res/mipmap-mdpi/icon.png",
"res/mipmap-xxxhdpi/icon.png",
"res/mipmap-xhdpi/icon.png",
"res/mipmap-anydpi-v26/icon.xml",
];
for order in [[0, 1, 2, 3], [3, 2, 1, 0]] {
let mut package = vec![0; 288];
package[0..2].copy_from_slice(&0x200u16.to_le_bytes());
package[2..4].copy_from_slice(&288u16.to_le_bytes());
package[8..12].copy_from_slice(&127u32.to_le_bytes());
for i in order {
let mut table = vec![0; 40];
table[0..2].copy_from_slice(&0x201u16.to_le_bytes());
table[2..4].copy_from_slice(&40u16.to_le_bytes());
table[8] = 1;
table[12..16].copy_from_slice(&1u32.to_le_bytes());
table[16..20].copy_from_slice(&44u32.to_le_bytes());
table[20..24].copy_from_slice(&20u32.to_le_bytes());
table[34..36].copy_from_slice(&[160u16, 640, 320, 0xfffe][i].to_le_bytes());
table.extend(0u32.to_le_bytes());
table.extend(8u16.to_le_bytes());
table.extend(0u16.to_le_bytes());
table.extend(0u32.to_le_bytes());
table.extend([8, 0, 0, 3]);
table.extend((i as u32).to_le_bytes());
let len = table.len() as u32;
table[4..8].copy_from_slice(&len.to_le_bytes());
package.extend(table);
}
let len = package.len() as u32;
package[4..8].copy_from_slice(&len.to_le_bytes());
let mut resource = vec![0; 12];
resource[0..2].copy_from_slice(&2u16.to_le_bytes());
resource[2..4].copy_from_slice(&12u16.to_le_bytes());
resource.extend(utf8_pool(
&names
.iter()
.map(|n| (n.len() as u8, n.as_bytes()))
.collect::<Vec<_>>(),
));
resource.extend(package);
let len = resource.len() as u32;
resource[4..8].copy_from_slice(&len.to_le_bytes());
let parsed = resources(&resource).unwrap();
assert_eq!(text(parsed.get(&0x7f010000), &parsed), names[1]);
}
}
#[test]
fn resource_offsets_and_compact_entries() {
for flags in [0u8, 1, 2] {
for compact in [false, true] {
let mut table = vec![0; 20];
table[0..2].copy_from_slice(&0x201u16.to_le_bytes());
table[2..4].copy_from_slice(&20u16.to_le_bytes());
table[8] = 1;
table[9] = flags;
let count: u32 = if flags == 1 { 1 } else { 6 };
table[12..16].copy_from_slice(&count.to_le_bytes());
match flags {
1 => {
table.extend(5u16.to_le_bytes());
table.extend(0u16.to_le_bytes());
}
2 => {
for _ in 0..5 {
table.extend(u16::MAX.to_le_bytes());
}
table.extend(0u16.to_le_bytes());
}
_ => {
for _ in 0..5 {
table.extend(u32::MAX.to_le_bytes());
}
table.extend(0u32.to_le_bytes());
}
}
let start = table.len() as u32;
table[16..20].copy_from_slice(&start.to_le_bytes());
table.extend((if compact { 123u16 } else { 8 }).to_le_bytes());
table.extend((if compact { 0x308u16 } else { 0 }).to_le_bytes());
table.extend(0u32.to_le_bytes());
if !compact {
table.extend([8, 0, 0, 3]);
table.extend(0u32.to_le_bytes());
}
let len = table.len() as u32;
table[4..8].copy_from_slice(&len.to_le_bytes());
let mut package = vec![0; 288];
package[0..2].copy_from_slice(&0x200u16.to_le_bytes());
package[2..4].copy_from_slice(&288u16.to_le_bytes());
package[8..12].copy_from_slice(&127u32.to_le_bytes());
package[284..288].copy_from_slice(&2u32.to_le_bytes());
package.extend(table);
let len = package.len() as u32;
package[4..8].copy_from_slice(&len.to_le_bytes());
let mut resource = vec![0; 12];
resource[0..2].copy_from_slice(&2u16.to_le_bytes());
resource[2..4].copy_from_slice(&12u16.to_le_bytes());
resource.extend(utf8_pool(&[(5, b"Label")]));
resource.extend(package);
let len = resource.len() as u32;
resource[4..8].copy_from_slice(&len.to_le_bytes());
let parsed = resources(&resource).unwrap();
assert_eq!(text(parsed.get(&0x7f030005), &parsed), "Label");
resource.pop();
assert!(resources(&resource).is_err());
}
}
}
#[test]
fn inspect_apk_with_cesu8_resources() {
use std::io::Write;
let d = tempfile::tempdir().unwrap();
let p = d.path().join("emoji.apk");
fixture(&p, true, 42);
let manifest = entry(
&mut zip::ZipArchive::new(File::open(&p).unwrap()).unwrap(),
"AndroidManifest.xml",
8 * 1024 * 1024,
)
.unwrap();
let pool = utf8_pool(&[(2, b"\xed\xa0\xbc\xed\xbc\x90")]);
let mut resources = Vec::new();
resources.extend(2u16.to_le_bytes());
resources.extend(12u16.to_le_bytes());
resources.extend(((12 + pool.len()) as u32).to_le_bytes());
resources.extend(0u32.to_le_bytes());
resources.extend(pool);
let mut z = zip::ZipWriter::new(File::create(&p).unwrap());
for (name, bytes) in [
("AndroidManifest.xml", manifest),
("resources.arsc", resources),
] {
z.start_file(name, zip::write::SimpleFileOptions::default())
.unwrap();
z.write_all(&bytes).unwrap();
}
z.finish().unwrap();
let m = read(&p).unwrap();
assert_eq!(m.package, "com.example.app");
assert_eq!(m.name, "Example");
assert_eq!(m.activities, ["com.example.app.Main"]);
// Exercise the same binary upload -> inspection -> review path as the
// PC management panel, without running or installing the APK.
let bytes = std::fs::read(&p).unwrap();
let home = d.path().join("home");
std::fs::create_dir(&home).unwrap();
let upload_dir = crate::apk::upload_dir(&home, bytes.len() as u64).unwrap();
let uploads = crate::uploads::Uploads::default();
let upload = uploads.start_in(bytes.len() as u64, &upload_dir).unwrap();
let id = upload["upload"].as_str().unwrap();
uploads.append(id, 0, &bytes).unwrap();
let staged = uploads.take(id).unwrap();
let review =
crate::apk::inspect(&home, &staged.path, &crate::jobs::Cancellation::default())
.unwrap();
assert_eq!(review["metadata"]["name"], "Example");
assert!(review["ticket"].is_string());
}
#[test]
fn package_and_activity_validation() {
assert!(valid_package("com.example.app"));
for p in ["../x", "com..app", "com.1app", "app", "com.app;rm"] {
assert!(!valid_package(p));
}
assert_eq!(activity("com.a", ".Main"), "com.a.Main");
}
#[test]
fn malformed_chunks_and_resource_cycles_fail_safely() {
assert!(chunks(&[0; 8], 0).is_err());
let r = BTreeMap::from([(1, Val::Ref(2)), (2, Val::Ref(1))]);
assert_eq!(text(Some(&Val::Ref(1)), &r), "");
}
}
#[cfg(test)]
pub(crate) fn fixture(path: &Path, launch: bool, version: u32) {
fixture_named(path, launch, version, "com.example.app");
}
#[cfg(test)]
pub(crate) fn fixture_named(path: &Path, launch: bool, version: u32, package: &str) {
use std::io::Write;
fn chunk(kind: u16, header: u16, body: &[u8]) -> Vec<u8> {
let mut b = Vec::new();
b.extend(kind.to_le_bytes());
b.extend(header.to_le_bytes());
b.extend(((body.len() + 8) as u32).to_le_bytes());
b.extend(body);
b
}
let names = [
"manifest",
"package",
package,
"versionCode",
"versionName",
"1.0",
"application",
"label",
"Example",
"activity",
"name",
".Main",
"intent-filter",
"action",
"android.intent.action.MAIN",
"category",
"android.intent.category.LAUNCHER",
"enabled",
];
let mut data = Vec::new();
let mut offsets = Vec::new();
for s in names {
offsets.push(data.len() as u32);
data.push(s.len() as u8);
data.push(s.len() as u8);
data.extend(s.as_bytes());
data.push(0);
}
while data.len() % 4 != 0 {
data.push(0)
}
let mut pool = Vec::new();
pool.extend((names.len() as u32).to_le_bytes());
pool.extend(0u32.to_le_bytes());
pool.extend(256u32.to_le_bytes());
pool.extend((28 + names.len() as u32 * 4).to_le_bytes());
pool.extend(0u32.to_le_bytes());
for o in offsets {
pool.extend(o.to_le_bytes())
}
pool.extend(data);
let mut body = chunk(1, 28, &pool);
fn start(tag: u32, attrs: &[(u32, u8, u32)]) -> Vec<u8> {
let mut b = Vec::new();
b.extend(1u32.to_le_bytes());
b.extend(u32::MAX.to_le_bytes());
b.extend(u32::MAX.to_le_bytes());
b.extend(tag.to_le_bytes());
b.extend(20u16.to_le_bytes());
b.extend(20u16.to_le_bytes());
b.extend((attrs.len() as u16).to_le_bytes());
b.extend([0; 6]);
for (name, typ, value) in attrs {
b.extend(u32::MAX.to_le_bytes());
b.extend(name.to_le_bytes());
b.extend(u32::MAX.to_le_bytes());
b.extend(8u16.to_le_bytes());
b.push(0);
b.push(*typ);
b.extend(value.to_le_bytes());
}
chunk(0x102, 16, &b)
}
fn end(tag: u32) -> Vec<u8> {
let mut b = Vec::new();
b.extend(1u32.to_le_bytes());
b.extend(u32::MAX.to_le_bytes());
b.extend(u32::MAX.to_le_bytes());
b.extend(tag.to_le_bytes());
chunk(0x103, 16, &b)
}
body.extend(start(0, &[(1, 3, 2), (3, 0x10, version), (4, 3, 5)]));
body.extend(start(6, &[(7, 3, 8)]));
body.extend(start(9, &[(10, 3, 11)]));
if launch {
body.extend(start(12, &[]));
body.extend(start(13, &[(10, 3, 14)]));
body.extend(end(13));
body.extend(start(15, &[(10, 3, 16)]));
body.extend(end(15));
body.extend(end(12));
}
body.extend(end(9));
body.extend(end(6));
body.extend(end(0));
let xml = chunk(3, 8, &body);
let mut z = zip::ZipWriter::new(File::create(path).unwrap());
z.start_file(
"AndroidManifest.xml",
zip::write::SimpleFileOptions::default(),
)
.unwrap();
z.write_all(&xml).unwrap();
z.finish().unwrap();
}
#[cfg(test)]
mod manifest_tests {
use super::*;
#[test]
fn launchers_labels_versions_and_services() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("a.apk");
fixture(&p, true, 42);
let m = read(&p).unwrap();
assert_eq!(m.package, "com.example.app");
assert_eq!(m.name, "Example");
assert_eq!(m.version_code, 42);
assert_eq!(m.activities, vec!["com.example.app.Main"]);
fixture(&p, false, 43);
assert!(read(&p).unwrap().activities.is_empty());
}
#[test]
fn corrupt_zip_and_xml_are_rejected() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("a.apk");
std::fs::write(&p, b"not an APK").unwrap();
assert!(read(&p).is_err());
for n in 0..100 {
assert!(xml(&vec![0; n], &BTreeMap::new()).is_err());
}
}
}
+351
View File
@@ -0,0 +1,351 @@
//! User-session applications: XDG desktop entries and installed Lepton packages.
use anyhow::{Context, Result};
use serde::Serialize;
use std::{
collections::{BTreeMap, BTreeSet},
fs,
path::{Path, PathBuf},
};
#[derive(Clone, Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct App {
pub id: String,
pub name: String,
pub kind: &'static str,
pub icon: Option<String>,
pub steam_app_id: Option<u32>,
pub launch_unavailable: Option<String>,
#[serde(skip)]
target: Target,
}
#[derive(Clone, Debug)]
enum Target {
ManagedLepton(String),
Desktop(PathBuf),
}
fn entries(input: &str) -> BTreeMap<String, String> {
let mut active = false;
let mut out = BTreeMap::new();
for line in input.lines() {
let line = line.trim();
if line.starts_with('[') {
active = line == "[Desktop Entry]";
continue;
}
if active && !line.starts_with('#') {
if let Some((k, v)) = line.split_once('=') {
out.insert(k.trim().into(), v.trim().into());
}
}
}
out
}
fn data_home(home: &Path) -> PathBuf {
std::env::var_os("XDG_DATA_HOME")
.map(PathBuf::from)
.filter(|p| p.is_absolute())
.unwrap_or_else(|| home.join(".local/share"))
}
fn data_dirs(home: &Path) -> Vec<PathBuf> {
let mut dirs = vec![data_home(home)];
dirs.extend(
std::env::var("XDG_DATA_DIRS")
.unwrap_or_else(|_| "/usr/local/share:/usr/share".into())
.split(':')
.map(PathBuf::from)
.filter(|p| p.is_absolute()),
);
for p in [
home.join(".local/share/flatpak/exports/share"),
PathBuf::from("/var/lib/flatpak/exports/share"),
] {
if !dirs.contains(&p) {
dirs.push(p);
}
}
dirs
}
fn icon_file(path: &Path) -> Option<String> {
let bytes = fs::read(path).ok()?;
if bytes.len() > 1024 * 1024 {
return None;
}
let mime = if bytes.starts_with(b"\x89PNG\r\n\x1a\n") {
"image/png"
} else if bytes.starts_with(&[0xff, 0xd8, 0xff]) {
"image/jpeg"
} else if path.extension().is_some_and(|e| e == "svg")
&& std::str::from_utf8(&bytes).ok()?.contains("<svg")
{
"image/svg+xml"
} else {
return None;
};
use base64::Engine;
Some(format!(
"data:{mime};base64,{}",
base64::engine::general_purpose::STANDARD.encode(bytes)
))
}
fn icon(home: &Path, name: &str, dirs: &[PathBuf]) -> Option<String> {
let path = Path::new(name);
if path.is_absolute() {
return icon_file(path);
}
if name.contains('/') || name.is_empty() {
return None;
}
for base in std::iter::once(home.join(".icons")).chain(dirs.iter().map(|d| d.join("icons"))) {
for theme in ["hicolor", "breeze", "breeze-dark", "Adwaita"] {
for size in ["256x256", "128x128", "64x64", "48x48", "scalable", "32x32"] {
for ext in ["png", "svg"] {
if let Some(icon) = icon_file(
&base
.join(theme)
.join(size)
.join("apps")
.join(format!("{name}.{ext}")),
) {
return Some(icon);
}
}
}
}
}
dirs.iter().find_map(|d| {
["png", "svg", "xpm"]
.iter()
.find_map(|ext| icon_file(&d.join("pixmaps").join(format!("{name}.{ext}"))))
})
}
fn files(base: &Path, dir: &Path, depth: usize, out: &mut Vec<(String, PathBuf)>) {
if depth > 8 {
return;
}
if let Ok(entries) = fs::read_dir(dir) {
for entry in entries.flatten() {
let p = entry.path();
if entry.file_type().is_ok_and(|t| t.is_dir()) {
files(base, &p, depth + 1, out);
} else if p.extension().is_some_and(|e| e == "desktop") {
if let Ok(relative) = p.strip_prefix(base) {
out.push((relative.to_string_lossy().replace('/', "-"), p));
}
}
}
}
}
fn desktop_apps(home: &Path, dirs: &[PathBuf], steam: &BTreeSet<u32>) -> Vec<App> {
let mut seen = BTreeSet::new();
let mut apps = Vec::new();
let desktops = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default();
for dir in dirs {
let base = dir.join("applications");
let mut candidates = Vec::new();
files(&base, &base, 0, &mut candidates);
candidates.sort();
for (id, path) in candidates {
if !seen.insert(id.clone()) {
continue;
}
let Ok(content) = fs::read_to_string(&path) else {
continue;
};
if content.len() > 128 * 1024 {
continue;
}
let v = entries(&content);
let get = |k: &str| v.get(k).map(String::as_str).unwrap_or("");
if get("Type") != "Application"
|| get("Hidden") == "true"
|| get("NoDisplay") == "true"
|| get("Exec").is_empty()
{
continue;
}
let matches = |list: &str| {
list.split(';')
.any(|item| !item.is_empty() && desktops.split(':').any(|d| d == item))
};
if !get("OnlyShowIn").is_empty() && !matches(get("OnlyShowIn"))
|| matches(get("NotShowIn"))
{
continue;
}
if !get("TryExec").is_empty() {
let t = Path::new(get("TryExec"));
let exists = if t.is_absolute() {
t.is_file()
} else {
std::env::var_os("PATH").is_some_and(|paths| {
std::env::split_paths(&paths).any(|d| d.join(t).is_file())
})
};
if !exists {
continue;
}
}
// Steam already owns its game shortcuts and helper runtimes.
if get("Exec").split_whitespace().any(|word| {
word.trim_matches('"')
.strip_prefix("steam://rungameid/")
.and_then(|s| s.parse::<u32>().ok())
.is_some_and(|id| steam.contains(&id))
}) || id == "valve-steamvr.desktop"
|| id == "Lepton Development.desktop"
{
continue;
}
let locale = std::env::var("LC_MESSAGES")
.or_else(|_| std::env::var("LANG"))
.unwrap_or_default();
let locale = locale.split('.').next().unwrap_or("");
let language = locale.split('_').next().unwrap_or("");
let name = v
.get(&format!("Name[{locale}]"))
.or_else(|| v.get(&format!("Name[{language}]")))
.or_else(|| v.get("Name"))
.filter(|n| !n.is_empty());
let Some(name) = name else {
continue;
};
apps.push(App {
id,
name: name.clone(),
kind: "desktop",
icon: icon(home, get("Icon"), dirs),
steam_app_id: None,
launch_unavailable: None,
target: Target::Desktop(path),
});
}
}
apps
}
fn lepton_apps(home: &Path) -> Vec<App> {
crate::apk::launcher(home)
.into_iter()
.filter_map(|v| {
let id = v["id"].as_str()?.to_owned();
Some(App {
id: id.clone(),
name: v["name"].as_str()?.into(),
kind: "lepton",
icon: v["icon"].as_str().map(str::to_owned),
steam_app_id: v["steamAppId"].as_u64().and_then(|v| u32::try_from(v).ok()),
launch_unavailable: v["launchUnavailable"].as_str().map(str::to_owned),
target: Target::ManagedLepton(id),
})
})
.collect()
}
pub fn discover(home: &Path) -> Vec<App> {
let ids = crate::steam::discover(home)
.into_iter()
.map(|a| a.id)
.collect();
let mut apps = desktop_apps(home, &data_dirs(home), &ids);
apps.extend(lepton_apps(home));
apps.sort_by(|a, b| a.name.cmp(&b.name));
apps
}
pub fn launch(home: &Path, id: &str) -> Result<()> {
let app = discover(home)
.into_iter()
.find(|a| format!("{}:{}", a.kind, a.id) == id)
.context("Application is no longer installed")?;
if let Some(reason) = app.launch_unavailable {
anyhow::bail!("{reason}");
}
launch_target(app.target)
}
fn launch_target(target: Target) -> Result<()> {
match target {
Target::ManagedLepton(id) => crate::apk::launch_app(&crate::steam::home()?, &id)?,
Target::Desktop(path) => {
crate::process::launch_handoff(
crate::process::tool("gio").arg("launch").arg(path),
std::time::Duration::from_secs(10),
)
.map_err(|error| anyhow::anyhow!("Desktop launch failed: {error:#}"))?;
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn xdg_priority_hidden_overrides_and_steam_duplicates() {
let dir = tempfile::tempdir().unwrap();
let a = dir.path().join("first");
let b = dir.path().join("second");
for p in [&a, &b] {
fs::create_dir_all(p.join("applications")).unwrap();
}
fs::write(
a.join("applications/hidden.desktop"),
"[Desktop Entry]\nHidden=true",
)
.unwrap();
fs::write(
b.join("applications/hidden.desktop"),
"[Desktop Entry]\nType=Application\nName=Hidden\nExec=test",
)
.unwrap();
fs::write(
a.join("applications/game.desktop"),
"[Desktop Entry]\nType=Application\nName=Game\nExec=steam steam://rungameid/42",
)
.unwrap();
fs::write(a.join("applications/terminal.desktop"),"[Other]\nName=Wrong\n[Desktop Entry]\nType=Application\nName=Terminal\nExec=terminal %U\nTerminal=true").unwrap();
let apps = desktop_apps(dir.path(), &[a, b], &BTreeSet::from([42]));
assert_eq!(apps.len(), 1);
assert_eq!(apps[0].id, "terminal.desktop");
}
#[test]
fn lepton_only_installed_third_party_packages() {
let dir = tempfile::tempdir().unwrap();
let runner = dir
.path()
.join(".local/share/Steam/steamapps/common/Lepton");
fs::create_dir_all(&runner).unwrap();
fs::write(runner.join("lepton"), "").unwrap();
let data = dir
.path()
.join(".local/share/lepton/contexts/test/baked/data_overlay");
fs::create_dir_all(data.join("system")).unwrap();
fs::create_dir_all(data.join("app/example")).unwrap();
crate::apk_metadata::fixture(&data.join("app/example/base.apk"), true, 1);
fs::write(data.join("system/packages.xml"),"<packages><package name=\"com.example.app\" codePath=\"/data/app/example\"/><package name=\"com.android.system\" codePath=\"/system/app/system\"/><package name=\"com.removed.app\" codePath=\"/data/app/missing\"/></packages>").unwrap();
let apps = lepton_apps(dir.path());
assert_eq!(apps.len(), 1);
assert_eq!(apps[0].id, "test/com.example.app");
}
#[test]
fn desktop_launch_handoff_uses_literal_arguments() {
use std::os::unix::fs::PermissionsExt;
let dir = tempfile::tempdir().unwrap();
let tools = dir.path().join("tools");
fs::create_dir(&tools).unwrap();
for name in ["gio", "podman"] {
fs::write(tools.join(name),format!("#!/bin/sh\nif [ \"$1\" = inspect ]; then echo true; exit 0; fi\nprintf '%s\\n' \"$@\" > '{}'/{}-args\n",dir.path().display(),name)).unwrap();
fs::set_permissions(tools.join(name), fs::Permissions::from_mode(0o755)).unwrap();
}
crate::process::TEST_TOOLS.with(|p| *p.borrow_mut() = Some(tools));
let path = dir.path().join("app; literal.desktop");
launch_target(Target::Desktop(path.clone())).unwrap();
assert_eq!(
fs::read_to_string(dir.path().join("gio-args")).unwrap(),
format!("launch\n{}\n", path.display())
);
crate::process::TEST_TOOLS.with(|p| *p.borrow_mut() = None);
}
#[test]
fn unknown_id_never_launches() {
let dir = tempfile::tempdir().unwrap();
assert!(launch(dir.path(), "desktop:../../arbitrary").is_err());
}
}
+57
View File
@@ -0,0 +1,57 @@
use anyhow::{ensure, Context, Result};
use serde_json::Value;
use std::{path::Path, process::Command};
pub fn collect(state: &Path) -> Result<Value> {
let output = Command::new("python3")
.args([
"-c",
include_str!("../tools/export-diagnostics.py"),
"--state",
])
.arg(state)
.output()
.context("Could not collect diagnostics")?;
ensure!(
output.status.success(),
"Diagnostic export failed: {}",
String::from_utf8_lossy(&output.stderr)
);
serde_json::from_slice(&output.stdout).context("Invalid diagnostic archive")
}
#[cfg(test)]
mod tests {
use super::*;
use base64::{engine::general_purpose::STANDARD, Engine};
use std::io::{Cursor, Read};
#[test]
fn exports_without_a_running_daemon_and_with_corrupt_state() {
let state = tempfile::tempdir().unwrap();
std::fs::create_dir(state.path().join("logs")).unwrap();
std::fs::write(state.path().join("state.json"), "corrupt").unwrap();
std::fs::write(
state.path().join("logs/demo.log"),
"useful error\npassword=not-public",
)
.unwrap();
let result = collect(state.path()).unwrap();
let bytes = STANDARD.decode(result["data"].as_str().unwrap()).unwrap();
let mut archive = zip::ZipArchive::new(Cursor::new(bytes)).unwrap();
let mut log = String::new();
archive
.by_name("logs/demo.log")
.unwrap()
.read_to_string(&mut log)
.unwrap();
assert!(log.contains("useful error"));
assert!(!log.contains("not-public"));
assert!(archive.by_name("report.json").is_ok());
assert!(archive.by_name("renderer/gpu.json").is_ok());
assert_eq!(
std::fs::read_to_string(state.path().join("state.json")).unwrap(),
"corrupt"
);
}
}
+198
View File
@@ -0,0 +1,198 @@
use anyhow::{ensure, Context, Result};
use serde_json::{json, Value};
use std::{
fs,
path::{Path, PathBuf},
time::UNIX_EPOCH,
};
pub fn roots(home: &Path) -> Vec<(String, PathBuf)> {
let mut roots = vec![
("下载".into(), home.join("Downloads")),
("主目录".into(), home.into()),
("桌面".into(), home.join("Desktop")),
("文档".into(), home.join("Documents")),
("临时目录".into(), PathBuf::from("/tmp")),
];
if let Some(user) = home.file_name() {
if let Ok(devices) = fs::read_dir(Path::new("/run/media").join(user)) {
roots.extend(
devices
.flatten()
.filter(|e| e.path().is_dir())
.map(|e| (e.file_name().to_string_lossy().into_owned(), e.path())),
);
}
}
roots
.into_iter()
.filter_map(|(name, path)| {
path.canonicalize()
.ok()
.filter(|p| p.is_dir())
.map(|p| (name, p))
})
.collect()
}
fn checked_roots(roots: &[(String, PathBuf)], path: &Path) -> Result<PathBuf> {
let path = path
.canonicalize()
.context("文件或目录不存在,或无权访问")?;
ensure!(
roots.iter().any(|(_, root)| path.starts_with(root)),
"只能选择用户目录、临时目录或已挂载存储中的文件"
);
Ok(path)
}
pub fn checked(home: &Path, path: &Path) -> Result<PathBuf> {
checked_roots(&roots(home), path)
}
pub fn list(home: &Path, params: &Value) -> Result<Value> {
let roots = roots(home);
let default = roots.first().context("没有可访问的目录")?.1.clone();
let path = checked_roots(
&roots,
Path::new(
params["path"]
.as_str()
.filter(|p| !p.is_empty())
.unwrap_or(default.to_str().context("Invalid file path")?),
),
)?;
ensure!(path.is_dir(), "请选择目录");
let query = params["query"].as_str().unwrap_or("").to_lowercase();
ensure!(query.len() <= 1024, "搜索内容过长");
let hidden = params["hidden"] == true;
let extensions: Vec<String> = params["extensions"]
.as_array()
.into_iter()
.flatten()
.filter_map(|v| v.as_str().map(str::to_lowercase))
.collect();
ensure!(
extensions.len() <= 128
&& extensions
.iter()
.all(|s| s.starts_with('.') && s.len() <= 128),
"Invalid file filters"
);
let offset = params["offset"].as_u64().unwrap_or(0) as usize;
let mut entries = vec![];
let mut skipped = 0;
for (index, entry) in fs::read_dir(&path).context("无法读取目录")?.enumerate() {
ensure!(index < 50000, "目录文件过多,请选择更具体的目录");
let Ok(entry) = entry else {
skipped += 1;
continue;
};
let name = entry.file_name().to_string_lossy().into_owned();
if (!hidden && name.starts_with('.')) || !name.to_lowercase().contains(&query) {
continue;
}
let Ok(target) = checked_roots(&roots, &entry.path()) else {
skipped += 1;
continue;
};
let Ok(meta) = fs::metadata(&target) else {
skipped += 1;
continue;
};
if !meta.is_file() && !meta.is_dir() {
continue;
}
if !meta.is_dir()
&& (params["directoryOnly"] == true
|| (!extensions.is_empty()
&& !extensions
.iter()
.any(|ext| name.to_lowercase().ends_with(ext))))
{
continue;
}
entries.push(json!({"name":name,"path":entry.path(),"directory":meta.is_dir(),"size":meta.len(),"modified":meta.modified().ok().and_then(|t|t.duration_since(UNIX_EPOCH).ok()).map(|t|t.as_secs())}));
}
entries.sort_by(|a, b| {
b["directory"]
.as_bool()
.cmp(&a["directory"].as_bool())
.then_with(|| {
a["name"]
.as_str()
.unwrap()
.to_lowercase()
.cmp(&b["name"].as_str().unwrap().to_lowercase())
})
.then_with(|| a["name"].as_str().cmp(&b["name"].as_str()))
});
let total = entries.len();
let parent = path.parent().and_then(|p| checked_roots(&roots, p).ok());
Ok(
json!({"path":path,"parent":parent,"roots":roots.iter().map(|(name,path)|json!({"name":name,"path":path})).collect::<Vec<_>>(),"entries":entries.into_iter().skip(offset).take(200).collect::<Vec<_>>(),"total":total,"offset":offset,"skipped":skipped}),
)
}
pub fn selection(home: &Path, params: &Value) -> Result<Vec<PathBuf>> {
let paths = params["paths"]
.as_array()
.context("Missing selected files")?;
ensure!(paths.len() <= 64, "选择的文件过多");
paths
.iter()
.map(|p| {
let path = checked(
home,
Path::new(p.as_str().context("Invalid selected file")?),
)?;
if params["directory"] == true {
ensure!(path.is_dir(), "请选择目录");
} else {
ensure!(path.is_file(), "请选择文件");
fs::File::open(&path).context("无法读取所选文件")?;
}
Ok(path)
})
.collect()
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn browsing_filters_sorts_and_keeps_selection_within_roots() {
let home = tempfile::tempdir().unwrap();
fs::create_dir(home.path().join("Downloads")).unwrap();
fs::create_dir(home.path().join("Downloads/Z folder")).unwrap();
fs::write(home.path().join("Downloads/a.apk"), b"apk").unwrap();
fs::write(home.path().join("Downloads/.hidden"), b"hidden").unwrap();
std::os::unix::fs::symlink("/etc/passwd", home.path().join("Downloads/escape")).unwrap();
let listed = list(home.path(), &json!({})).unwrap();
assert_eq!(listed["total"], 2);
assert_eq!(listed["entries"][0]["name"], "Z folder");
assert_eq!(
list(home.path(), &json!({"query":"A.APK"})).unwrap()["total"],
1
);
assert_eq!(
list(home.path(), &json!({"hidden":true})).unwrap()["total"],
3
);
assert!(selection(
home.path(),
&json!({"paths":[home.path().join("Downloads/escape")]})
)
.is_err());
assert!(selection(
home.path(),
&json!({"paths":[home.path().join("Downloads/a.apk")]})
)
.is_ok());
assert!(selection(
home.path(),
&json!({"paths":[home.path().join("Downloads")]})
)
.is_err());
assert!(selection(
home.path(),
&json!({"paths":[home.path().join("Downloads")],"directory":true})
)
.is_ok());
}
}
+439
View File
@@ -0,0 +1,439 @@
//! Optional, session-user-only input bridges. Each running container retains its pad.
use anyhow::{ensure, Context, Result};
use std::{
collections::BTreeMap,
fs,
io::{BufRead, BufReader, Read, Write},
os::unix::fs::{FileTypeExt, OpenOptionsExt, PermissionsExt},
path::{Path, PathBuf},
process::{Child, ChildStdin, Command, Stdio},
sync::{Mutex, OnceLock},
time::{Duration, Instant},
};
#[derive(Clone)]
pub struct Mount {
pub context: String,
pub token: String,
pub event: PathBuf,
pub grab: PathBuf,
pub layout: PathBuf,
pub ready: PathBuf,
}
struct Bridge {
mount: Mount,
child: Child,
input: ChildStdin,
package: Option<String>,
enabled: bool,
}
#[derive(Default)]
struct Bridges {
contexts: BTreeMap<String, Bridge>,
active: Option<String>,
}
static BRIDGE: Mutex<Bridges> = Mutex::new(Bridges {
contexts: BTreeMap::new(),
active: None,
});
impl Bridge {
fn pause(&mut self) -> Result<()> {
writeln!(self.input, "disable")?;
self.enabled = false;
Ok(())
}
fn update(&mut self, alive: Option<bool>, focused: bool) -> Result<()> {
// Activity/process records can disappear briefly during game updates,
// splash-screen handoffs or a query timeout. Keep the mounted device;
// only neutralize input until the selected app is foreground again.
let enabled = alive != Some(false) && focused && claimed(&self.mount.ready);
if self.enabled != enabled {
writeln!(self.input, "{}", if enabled { "enable" } else { "disable" })?;
self.enabled = enabled;
}
Ok(())
}
}
static SESSION: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
pub fn session_started() {
SESSION.store(true, std::sync::atomic::Ordering::Relaxed);
}
static WATCHER: OnceLock<()> = OnceLock::new();
impl Drop for Bridge {
fn drop(&mut self) {
let _ = writeln!(self.input, "disable");
// A watcher may already have reaped an exited helper. Never signal
// that recycled PID while removing its cached mount.
if self.child.try_wait().ok().flatten().is_none() {
unsafe {
libc::kill(self.child.id() as i32, libc::SIGTERM);
}
}
let began = Instant::now();
while began.elapsed() < Duration::from_millis(500) {
if self.child.try_wait().ok().flatten().is_some() {
break;
}
std::thread::sleep(Duration::from_millis(10));
}
let _ = self.child.kill();
let _ = self.child.wait();
let _ = fs::remove_dir_all(&self.mount.ready);
}
}
pub fn stop() {
let mut bridges = BRIDGE.lock().unwrap();
bridges.active = None;
bridges.contexts.clear();
}
pub fn set_rumble_enabled(enabled: bool) {
let mut bridges = BRIDGE.lock().unwrap();
for bridge in bridges.contexts.values_mut() {
let _ = writeln!(
bridge.input,
"{}",
if enabled { "rumble-on" } else { "rumble-off" }
);
}
}
pub fn stop_context(context: &str) {
let mut bridges = BRIDGE.lock().unwrap();
if bridges.active.as_deref() == Some(context) {
bridges.active = None;
}
bridges.contexts.remove(context);
}
pub fn stop_app(context: &str, package: &str) {
let mut bridges = BRIDGE.lock().unwrap();
if let Some(bridge) = bridges.contexts.get_mut(context) {
if bridge.package.as_deref() == Some(package) {
let _ = bridge.pause();
bridge.package = None;
if bridges.active.as_deref() == Some(context) {
bridges.active = None;
}
}
}
}
pub fn current(context: &str) -> Option<Mount> {
let mut bridges = BRIDGE.lock().unwrap();
if bridges
.contexts
.get_mut(context)
.is_some_and(|b| b.child.try_wait().ok().flatten().is_some())
{
bridges.contexts.remove(context);
if bridges.active.as_deref() == Some(context) {
bridges.active = None;
}
}
bridges.contexts.get(context).map(|b| b.mount.clone())
}
pub fn prepare(storage: &Path, context: &str, source: &str, rumble: bool) -> Result<Mount> {
ensure!(
matches!(source, "steam" | "frame"),
"Invalid gamepad input source"
);
ensure!(SESSION.load(std::sync::atomic::Ordering::Relaxed),"Gamepad launch requires the UI session; open the APK from the management panel or launcher");
ensure!(
unsafe { libc::geteuid() } != 0,
"Gamepad input must run as the Steam session user"
);
let current = current(context);
{
let mut bridges = BRIDGE.lock().unwrap();
bridges.active = None;
for bridge in bridges.contexts.values_mut() {
bridge.pause()?;
}
if let Some(bridge) = bridges.contexts.get_mut(context) {
bridge.package = None;
}
}
if let Some(mount) = current {
return Ok(mount);
}
let exe = std::env::current_exe()?;
let distribution = exe
.parent()
.and_then(Path::parent)
.context("Missing Framely runtime directory")?;
let helper = distribution.join("lib/openvr/framely-gamepad");
let grab = distribution.join("lib/openvr/libframely-gamepad-grab.so");
let manifest = distribution.join("share/input/gamepad/actions.json");
let layout = distribution.join("share/input/gamepad/Vendor_0001_Product_f001.kl");
ensure!(
helper.is_file() && grab.is_file() && manifest.is_file() && layout.is_file(),
"Gamepad input runtime is missing; install a complete Framely build"
);
let token = hex::encode(rand::random::<[u8; 16]>());
let ready = storage.join(format!("gamepad-{token}"));
fs::create_dir(&ready)?;
fs::set_permissions(&ready, fs::Permissions::from_mode(0o733))?;
let app_key = format!("framely.gamepad.{token}");
let app_manifest = ready.join("application.vrmanifest");
fs::write(
&app_manifest,
serde_json::to_vec(&serde_json::json!({
"applications":[{"app_key":app_key,"launch_type":"binary","is_self_identified":true,
"binary_path_linux_arm":helper,"binary_path_linux":helper,"action_manifest_path":manifest,
"strings":{"en_us":{"name":"Framely gamepad input"}}}]
}))?,
)?;
fs::set_permissions(&app_manifest, fs::Permissions::from_mode(0o600))?;
let log = fs::OpenOptions::new()
.append(true)
.create(true)
.mode(0o600)
.open(storage.join("logs/gamepad.log"))?;
let home = crate::steam::home()?;
let steam = if home.join(".local/share/Steam").exists() {
home.join(".local/share/Steam")
} else {
home.join(".steam/steam")
};
let mut child = Command::new(helper)
.env("FRAMELY_GAMEPAD_SOURCE", source)
.env("FRAMELY_GAMEPAD_RUMBLE", if rumble { "1" } else { "0" })
.env(
"FRAMELY_STEAM_SDL_LIBRARY",
steam.join("steamrtarm64/libSDL3.so.0"),
)
.env(
"FRAMELY_STEAM_GAMEPAD_INFO",
steam.join("config/virtualgamepadinfo.txt"),
)
.arg(manifest)
.arg(&app_manifest)
.arg(&app_key)
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.stderr(log)
.spawn()?;
let input = child.stdin.take().context("Missing gamepad control pipe")?;
let stdout = child
.stdout
.take()
.context("Missing gamepad readiness pipe")?;
let (tx, rx) = std::sync::mpsc::channel();
std::thread::spawn(move || {
let mut line = String::new();
let result = BufReader::new(stdout).read_line(&mut line).map(|_| line);
let _ = tx.send(result);
});
let event = rx
.recv_timeout(Duration::from_secs(8))
.context("Gamepad input did not become ready")
.and_then(|v| v.map_err(Into::into))
.map(|s| PathBuf::from(s.trim()));
let mut bridge = Bridge {
mount: Mount {
context: context.into(),
token,
event: PathBuf::new(),
grab,
layout,
ready,
},
child,
input,
package: None,
enabled: false,
};
let event = event?;
ensure!(
valid_node(&event) && fs::metadata(&event)?.file_type().is_char_device(),
"Invalid gamepad event device"
);
bridge.mount.event = event;
let mount = bridge.mount.clone();
BRIDGE
.lock()
.unwrap()
.contexts
.insert(context.into(), bridge);
WATCHER.get_or_init(|| {
std::thread::spawn(|| loop {
std::thread::sleep(Duration::from_millis(700));
let target = {
let mut bridges = BRIDGE.lock().unwrap();
bridges
.contexts
.retain(|_, b| b.child.try_wait().ok().flatten().is_none());
if bridges
.active
.as_ref()
.is_some_and(|context| !bridges.contexts.contains_key(context))
{
bridges.active = None;
}
bridges
.active
.as_ref()
.and_then(|context| bridges.contexts.get(context))
.and_then(|b| b.package.as_ref().map(|p| (b.mount.clone(), p.clone())))
};
let Some((mount, package)) = target else {
continue;
};
let (alive, focused) = crate::apk::gamepad_health(&mount.context, &package);
let mut bridges = BRIDGE.lock().unwrap();
if bridges.active.as_deref() != Some(&mount.context) {
continue;
}
let Some(bridge) = bridges
.contexts
.get_mut(&mount.context)
.filter(|b| b.mount.token == mount.token && b.package.as_deref() == Some(&package))
else {
continue;
};
if bridge.child.try_wait().ok().flatten().is_some()
|| bridge.update(alive, focused).is_err()
{
eprintln!("Gamepad bridge exited for container {}", mount.context);
bridges.contexts.remove(&mount.context);
bridges.active = None;
}
});
});
Ok(mount)
}
pub fn activate(context: &str, package: &str) -> Result<()> {
let mount = current(context).context("Gamepad input is no longer running")?;
let began = Instant::now();
while !claimed(&mount.ready) && began.elapsed() < Duration::from_secs(3) {
std::thread::sleep(Duration::from_millis(30));
}
ensure!(
claimed(&mount.ready),
"Android did not claim the virtual gamepad; restart the container and retry"
);
select_target(context, package)
}
/// Select routing before native startup acknowledgement. The watcher still
/// requires the target activity to be foreground and Android to claim the pad.
pub fn select_target(context: &str, package: &str) -> Result<()> {
let mount = current(context).context("Gamepad input is no longer running")?;
let mut bridges = BRIDGE.lock().unwrap();
let bridge = bridges
.contexts
.get_mut(context)
.filter(|b| b.mount.token == mount.token)
.context("Gamepad input is no longer running")?;
bridge.package = Some(package.into());
bridges.active = Some(context.into());
Ok(())
}
fn claimed(directory: &Path) -> bool {
let Ok(file) = fs::OpenOptions::new()
.read(true)
.custom_flags(libc::O_NOFOLLOW | libc::O_NONBLOCK)
.open(directory.join("ready"))
else {
return false;
};
if !file.metadata().is_ok_and(|m| m.is_file() && m.len() == 6) {
return false;
}
let mut data = String::new();
file.take(16).read_to_string(&mut data).is_ok() && data == "ready\n"
}
fn valid_node(p: &Path) -> bool {
p.parent() == Some(Path::new("/dev/input"))
&& p.file_name().and_then(|s| s.to_str()).is_some_and(|s| {
s.strip_prefix("event")
.is_some_and(|n| !n.is_empty() && n.bytes().all(|c| c.is_ascii_digit()))
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn temporary_game_handoffs_neutralize_input_without_disconnect() {
let directory = tempfile::tempdir().unwrap();
let mut child = Command::new("sh")
.args([
"-c",
"while IFS= read -r line; do printf '%s\n' \"$line\"; done",
])
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.spawn()
.unwrap();
let input = child.stdin.take().unwrap();
let mut output = BufReader::new(child.stdout.take().unwrap());
let id = child.id();
let mut bridge = Bridge {
mount: Mount {
context: "test".into(),
token: "same-device".into(),
event: PathBuf::from("/dev/input/event999"),
grab: PathBuf::new(),
layout: PathBuf::new(),
ready: directory.path().into(),
},
child,
input,
package: Some("com.example.game".into()),
enabled: false,
};
let mut read = || {
let mut line = String::new();
output.read_line(&mut line).unwrap();
line
};
// Native routing may be selected before Android boots. Foreground
// alone must not enable a device Android has not yet claimed.
bridge.update(Some(true), true).unwrap();
assert!(!bridge.enabled);
fs::write(directory.path().join("ready"), "ready\n").unwrap();
bridge.update(Some(true), false).unwrap();
assert!(!bridge.enabled);
bridge.update(Some(true), true).unwrap();
assert_eq!(read(), "enable\n");
bridge.update(Some(false), false).unwrap();
assert_eq!(read(), "disable\n");
bridge.update(None, false).unwrap();
assert!(bridge.child.try_wait().unwrap().is_none());
assert!(claimed(&bridge.mount.ready));
bridge.update(Some(true), true).unwrap();
assert_eq!(read(), "enable\n");
bridge.pause().unwrap();
assert_eq!(read(), "disable\n");
assert_eq!(bridge.child.id(), id);
assert_eq!(bridge.mount.token, "same-device");
assert!(bridge.child.try_wait().unwrap().is_none());
}
#[test]
fn readiness_requires_a_regular_acknowledgement() {
let dir = tempfile::tempdir().unwrap();
let path = dir.path().join("ready");
assert!(!claimed(dir.path()));
fs::write(&path, "ready\n").unwrap();
assert!(claimed(dir.path()));
fs::write(&path, "not ready\n").unwrap();
assert!(!claimed(dir.path()));
fs::remove_file(&path).unwrap();
std::os::unix::fs::symlink("/dev/zero", &path).unwrap();
assert!(!claimed(dir.path()));
fs::remove_file(&path).unwrap();
use std::os::unix::ffi::OsStrExt;
let name = std::ffi::CString::new(path.as_os_str().as_bytes()).unwrap();
assert_eq!(unsafe { libc::mkfifo(name.as_ptr(), 0o600) }, 0);
assert!(!claimed(dir.path()));
}
#[test]
fn only_event_nodes_are_accepted() {
assert!(valid_node(Path::new("/dev/input/event5")));
for path in [
"/dev/input/event",
"/dev/uinput",
"/dev/input/../event5",
"/dev/input/event5/child",
"/tmp/event5",
] {
assert!(!valid_node(Path::new(path)));
}
}
}
+28
View File
@@ -19,6 +19,12 @@ pub fn write(stream: &mut impl Write, v: &Value) -> Result<()> {
stream.flush()?;
Ok(())
}
pub(crate) fn response(result: Result<Value>) -> Value {
match result {
Ok(v) => json!({"result":v}),
Err(e) => json!({"error":format!("{e:#}")}),
}
}
pub fn call(path: &Path, method: &str, params: Value) -> Result<Value> {
call_timeout(path, method, params, Duration::from_secs(90))
}
@@ -38,6 +44,28 @@ pub fn call_timeout(path: &Path, method: &str, params: Value, timeout: Duration)
mod tests {
use super::*;
#[test]
fn service_errors_keep_the_cause_across_ipc() {
let dir = tempfile::tempdir().unwrap();
let socket = dir.path().join("service.sock");
let listener = std::os::unix::net::UnixListener::bind(&socket).unwrap();
let worker = std::thread::spawn(move || {
let (mut stream, _) = listener.accept().unwrap();
let request = read(&mut stream).unwrap();
assert_eq!(request["method"], "install.batch");
let result = Err(anyhow::anyhow!("Permission denied (os error 13)"))
.context("安装插件 test.plugin 失败")
.context("批量安装失败,已恢复原版本和启用状态");
write(&mut stream, &response(result)).unwrap();
});
let error = call(&socket, "install.batch", json!({})).unwrap_err();
let message = error.to_string();
assert!(message.contains("批量安装失败,已恢复原版本和启用状态"));
assert!(message.contains("test.plugin"));
assert!(message.contains("Permission denied (os error 13)"));
worker.join().unwrap();
}
#[test]
fn package_messages_can_exceed_previous_transport_limit() {
let request = json!({"method":"install","params":{"package":"A".repeat(97 * 1024 * 1024)}});
+31 -2
View File
@@ -110,7 +110,7 @@ impl Jobs {
fn create(&self, kind: &str) -> Result<(String, Cancellation, bool)> {
let mut state = self.state.lock().unwrap();
Self::expire(&mut state);
if kind.starts_with("catalog:") {
if kind.starts_with("catalog:") || kind == "apk:list" {
if let Some((id, job)) = state.jobs.iter().find(|(_, j)| {
j.active && j.public["kind"] == kind && !j.cancel.flag.load(Ordering::Acquire)
}) {
@@ -157,11 +157,29 @@ impl Jobs {
.public
.clone())
}
pub fn active_apk(&self) -> Value {
let state = self.state.lock().unwrap();
state
.jobs
.iter()
.find(|(_, job)| {
job.public["kind"] == "apk:operation"
&& !matches!(
job.public["phase"].as_str(),
Some("done" | "failed" | "cancelled")
)
})
.map(|(id, _)| json!({"job":id}))
.unwrap_or(json!({"job":null}))
}
pub fn cancel(&self, id: &str) -> Result<Value> {
let cancel = {
let state = self.state.lock().unwrap();
let j = state.jobs.get(id).context("任务不存在")?;
ensure!(j.public["kind"] != "install", "安装已经开始,不能中途取消");
ensure!(
j.public["kind"] != "install" && j.public["cancellable"] != false,
"安装已经开始,不能中途取消"
);
j.cancel.clone()
};
// Serialize cancellation with state-changing commits, never with the jobs lock held.
@@ -615,6 +633,17 @@ mod tests {
panic!("job timeout");
}
#[test]
fn submitted_apk_operations_reject_cancellation_without_waiting_for_worker() {
let jobs = Jobs::default();
let (id, _, _) = jobs.create("apk:operation").unwrap();
assert_eq!(jobs.active_apk()["job"], id);
jobs.patch(&id, json!({"cancellable":false,"phase":"installing"}));
assert!(jobs.cancel(&id).is_err());
assert_eq!(jobs.status(&id).unwrap()["phase"], "installing");
jobs.patch(&id, json!({"phase":"done"}));
assert_eq!(jobs.active_apk()["job"], Value::Null);
}
#[test]
fn cancellation_and_limits_do_not_allow_unreviewed_install() {
let jobs = Jobs::default();
let (a, _, _) = jobs.create("inspect").unwrap();
Loaded 100 of 212 files, more files were not shown because too many files have changed in this diff. Show more