Compare commits

...
Author SHA1 Message Date
toorux e8e5ab3d77 Release v0.6.0 2026-10-07 20:00:50 +08:00
toorux dc1bd07145 Release APK operation locks explicitly and isolate integration tests 2026-10-07 20:00:50 +08:00
toorux 4005216a42 Enlarge file manager icons across all grid sizes 2026-10-07 19:33:44 +08:00
toorux 425983a5fb Redesign media viewer with floating bottom controls and blank-space dismissal 2026-10-07 19:32:54 +08:00
toorux cb67ac5607 Add fullscreen media viewer and download unsupported files on open 2026-10-07 19:10:55 +08:00
toorux 6cb70b8098 Add lazy image and video thumbnails to file icon views 2026-10-07 18:59:36 +08:00
toorux 79db4a80fc Show complete folder names in file sidebar tree 2026-10-07 18:44:54 +08:00
toorux 6a0e302fd6 Remember folder sorting and add global file icon views 2026-10-07 18:43:37 +08:00
toorux cbf285d957 Update bilingual README feature overview 2026-10-07 18:37:10 +08:00
toorux a3d751541a Release v0.5.1-preview.4 2026-10-07 18:12:30 +08:00
toorux 9c7dc06bad Add opt-in per-app framebuffer compatibility fix 2026-10-07 18:07:23 +08:00
toorux be36694719 feat(gamepad): add configurable trigger button threshold defaulting to 80 percent 2026-10-07 17:43:35 +08:00
toorux 786c8b7928 Increase upload chunks to 16 MiB 2026-10-07 16:43:15 +08:00
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
toorux c59fab881a Release 0.4.3-preview.1 with notification inbox and headset interaction fixes 2026-10-05 12:53:07 +08:00
toorux 4108d4e5be Show update confirmation in a modal and release 0.4.2-preview.12 2026-10-05 01:05:10 +08:00
toorux 1c6e36e63b Hide disabled apps in quick panel and release 0.4.2-preview.11 2026-10-05 00:45:57 +08:00
toorux 799433e041 Let plugins close their own surfaces and provide window chrome 2026-10-05 00:44:05 +08:00
toorux e02fde75f4 Automate verified updates and detect installer system proxies 2026-10-05 00:16:01 +08:00
toorux c4f672cba7 Embed installer icons and remove external assets from archives 2026-10-04 23:51:37 +08:00
toorux e54689bff6 Split CEF runtime packages and release preview updates 2026-10-04 23:32:36 +08:00
toorux fb1f67f39f Refresh app icons and add plugin library shortcut 2026-10-04 22:57:32 +08:00
toorux f5089e9bea Add UI visibility events and installer dialogs with live progress 2026-10-04 22:13:37 +08:00
toorux 1226d2de1c Add core update channels and correct Framely wordmark 2026-10-04 21:33:46 +08:00
toorux 14a15f8a2c Make English the default repository documentation
Keep Simplified Chinese translations in README.zh-CN.md and docs/zh-CN, update language navigation, and align generated plugin and release-package documentation.
2026-10-04 21:16:07 +08:00
308 changed files with 33348 additions and 2520 deletions

No files matched your search

+5 -5
View File
@@ -63,8 +63,8 @@ jobs:
run: |
bash tools/package-release.sh target/cef
mkdir -p release-assets
archive=$(find release -maxdepth 1 -name 'framely-*-linux-arm64.tar.gz' -print -quit)
cp "$archive" release-assets/
archive=$(find release -maxdepth 1 -name 'framely-*-linux-arm64.tar.gz' ! -name '*-offline-linux-arm64.tar.gz' ! -name 'framely-cef-*' -print -quit)
cp release/*.tar.gz release/framely-cef.json release-assets/
cp tools/bootstrap.py release-assets/bootstrap.py
cp install.sh release-assets/install.sh
"$CARGO_TARGET_DIR/release/framely" release-manifest --archive "$archive" --url "https://github.com/$RELEASE_REPO/releases/download/$RELEASE_TAG/$(basename "$archive")" --output release-assets/framely-release.json --changelog "Framely $RELEASE_TAG"
@@ -93,8 +93,8 @@ jobs:
RELEASE_TAG: ${{ github.ref_name }}
run: |
cd release-assets
sha256sum -- *.tar.gz bootstrap.py install.sh framely-release.json > SHA256SUMS
printf 'Framely %s\n\nInstall on Frame over SSH using the repository install.sh.\n\nSHA256SUMS verifies downloaded archives; each Framely archive also includes an internal SHA256SUMS.\n' "$RELEASE_TAG" > release-notes.txt
sha256sum -- *.tar.gz bootstrap.py install.sh framely-release.json framely-cef.json > SHA256SUMS
printf 'Framely %s\n\nFirst install: choose the complete *-offline-linux-arm64.tar.gz package. Updates: choose the smaller Framely package without CEF. A separate framely-cef-* archive is available for runtime downloads.\n\nInstall on Frame over SSH using the repository install.sh. SHA256SUMS verifies archives; each archive also includes internal checksums.\n' "$RELEASE_TAG" > release-notes.txt
prerelease=false
latest=true
if [[ "$RELEASE_TAG" == *-* ]]; then
@@ -102,5 +102,5 @@ jobs:
latest=false
fi
gh release create "$RELEASE_TAG" --verify-tag --title "Framely $RELEASE_TAG" --notes-file release-notes.txt --draft --latest=false --prerelease="$prerelease"
gh release upload "$RELEASE_TAG" -- *.tar.gz SHA256SUMS bootstrap.py install.sh framely-release.json
gh release upload "$RELEASE_TAG" -- *.tar.gz SHA256SUMS bootstrap.py install.sh framely-release.json framely-cef.json
gh release edit "$RELEASE_TAG" --draft=false --latest="$latest" --prerelease="$prerelease"
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.2-preview.6"
version = "0.6.0"
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.2-preview.6"
version = "0.6.0"
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
-75
View File
@@ -1,75 +0,0 @@
# Framely
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/branding/framely-logo-light.svg">
<img src="assets/branding/framely-logo.svg" alt="Framely" width="320" height="77">
</picture>
[简体中文](README.md)
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.
## 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:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
```
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
```
Runtime packages include 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.
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.
## Documentation
Start at the [documentation index](docs/en/README.md):
- [Install, update, repair, roll back, and uninstall](docs/en/user-guide/installation.md)
- [Basic usage](docs/en/user-guide/basic-usage.md) · [Install and manage plugins](docs/en/user-guide/plugins.md)
- [Network management panel](docs/en/user-guide/network-panel.md)
- [Plugin development through publishing](docs/en/developer-guide/README.md) · [Publish plugins and sources](docs/en/developer-guide/publishing.md)
- [SDK API](docs/en/developer-guide/sdk.md) · [Manifest configuration](docs/en/developer-guide/manifest.md) · [Lifecycle](docs/en/plugin-lifecycle.md)
- [Plugin template](templates/plugin/README.en.md) · [Showcase example](examples/showcase/README.en.md)
- [Core release maintenance](docs/en/releases.md) · [Build the installer](installer/README.en.md)
## Create a plugin
Install Node.js 22 and npm on your development computer, clone this repository, and run:
```bash
node tools/plugin-dev.mjs init ../my-plugin yourname.my-plugin
cd ../my-plugin
npm install
npm run dev
npm run build
```
The generated project includes React pages, a Python backend, persistent storage, lifecycle callbacks, the SDK, and build tools. Browser preview does not start the backend; see the development guide for packaging and testing on Frame.
## Build and validate
Building the core from source requires Linux, Rust, Node.js, C/C++, and OpenGL/X11 development libraries. The production native host uses the pinned Linux ARM64 CEF version.
```bash
npm ci
npm run typecheck
npm run build
cargo test --locked
bash tools/test-native.sh
python3 -m unittest discover -s tests -p 'test_*.py'
```
See [release maintenance](docs/en/releases.md) for CEF builds, integration tests, and publishing commands. Plugins support `steamos` and `root`; hash verification is not a security review, so check the source and runtime user.
## License
Original Framely code, including the core, installer, SDK, template, and repository examples, uses **AGPL-3.0-only**; see [LICENSE](LICENSE). Third-party dependencies and vendored files retain their respective licenses.
AGPL allows commercial use. Distribution requires complete corresponding source under the license; modified software that interacts with users over a network must also offer source to those users. Release source corresponds to the repository's `v<VERSION>` or `installer-v<VERSION>` tags. Redistributors must provide modifications and build scripts matching their binaries.
+51 -26
View File
@@ -5,43 +5,68 @@
<img src="assets/branding/framely-logo.svg" alt="Framely" width="320" height="77">
</picture>
[English](README.en.md)
[简体中文](README.zh-CN.md)
Steam Frame 的 React 插件管理器:Rust 核心服务、独立 CEF/OpenVR 宿主、网络管理面板和电脑端安装器。可管理插件、来源、窗口、通知和更新。
> Framely is still under rapid development. Features and interfaces may change between preview releases. Android app and game compatibility depends on Lepton and the app itself.
## 安装
Framely provides a unified spatial launcher for Steam Frame and a management panel available both inside the headset and in a PC browser.
目标为 Linux ARM64 Steam Frame。电脑端从 [Releases](https://github.com/SteamFramelyHomebrew/framely/releases) 下载对应平台的 `Framely Installer`,连接设备后安装本体。也可在 Frame 的 SSH 终端安装最新正式版:
- **Unified launcher**: launch Android apps in Lepton, Linux desktop applications, local Steam games, and games available through Steam Remote Play.
- **APK sideloading and management**: install, update, and uninstall APKs, manage application containers and data, and provide controller input mapping and rumble feedback for Android games that support controllers.
- **Plugin installation and management**: install and manage Framely plugins, browse the plugin library, and extend Frame with additional features.
- **Remote management from your PC**: access Frame's management panel in a PC browser to manage files, APKs, and plugins. Upload, download, and edit files, and preview common image and video formats.
- **Web terminal**: use an interactive terminal running on Frame, execute shell commands, and connect to other devices with `ssh`. The web terminal does not require an SSH connection to Frame.
Framely uses a Rust core service and a separate CEF/OpenVR host, with a desktop installer for setup. It also manages plugin 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. 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
```
安装 Preview 时指定实际已发布的标签:
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
```
运行包包含 CEF,设备无需 Node.js 或 Rust。安装会请求 sudo;不会自动解除 SteamOS 只读保护。打开 SteamVR Dashboard 的 Framely Dock 图标进入快捷菜单,从“设置 → 管理插件”打开管理窗口。
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.
网络面板默认端口 `15915`,手机/电脑访问 `http://设备IP:15915`。未配置密码时首次访问必须设置并确认密码,保存后登录。设备密码与面板密码相互独立。
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.
从 [文档首页](docs/README.md) 开始:
## Documentation
- [安装、更新、修复、回滚与卸载](docs/user-guide/installation.md)
- [基本使用](docs/user-guide/basic-usage.md) · [插件安装与管理](docs/user-guide/plugins.md)
- [网络管理面板](docs/user-guide/network-panel.md)
- [插件开发到发布完整流程](docs/developer-guide/README.md) · [发布插件和插件源](docs/developer-guide/publishing.md)
- [SDK API](docs/developer-guide/sdk.md) · [Manifest 配置](docs/developer-guide/manifest.md) · [生命周期](docs/plugin-lifecycle.md)
- [插件模板](templates/plugin/README.md) · [功能展示示例](examples/showcase/README.md)
- [本体发行维护](docs/releases.md) · [安装器构建](installer/README.md)
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)
- [Plugin template](templates/plugin/README.md) · [Showcase example](examples/showcase/README.md)
- [Core release maintenance](docs/releases.md) · [Build the installer](installer/README.md)
开发机准备 Node.js 22 和 npm,克隆本仓库后执行:
## Create a plugin
Install Node.js 22 and npm on your development computer, clone this repository, and run:
```bash
node tools/plugin-dev.mjs init ../my-plugin yourname.my-plugin
@@ -51,11 +76,11 @@ npm run dev
npm run build
```
生成项目包含 React 页面、Python 后端、数据保存、生命周期回调、SDK 和构建工具。浏览器预览不启动后端;打包与实际 Frame 测试见开发指南。
The generated project includes React pages, a Python backend, persistent storage, lifecycle callbacks, the SDK, and build tools. Browser preview does not start the backend; see the development guide for packaging and testing on Frame.
## 构建与验证
## Build and validate
本体源码在 Linux 构建,需要 Rust、Node.js、C/C++ 和 OpenGL/X11 开发库,生产原生宿主使用锁定版本的 Linux ARM64 CEF。
Building the core from source requires Linux, Rust, Node.js, C/C++, and OpenGL/X11 development libraries. The production native host uses the pinned Linux ARM64 CEF version.
```bash
npm ci
@@ -66,10 +91,10 @@ bash tools/test-native.sh
python3 -m unittest discover -s tests -p 'test_*.py'
```
CEF 构建、集成测试和发布命令见[发行维护](docs/releases.md)。插件支持 `steamos` 和 `root`;哈希校验不代表安全审核,应核对来源和运行用户。
See [release maintenance](docs/releases.md) for CEF builds, integration tests, and publishing commands. Plugins support `steamos` and `root`; hash verification is not a security review, so check the source and runtime user.
## 许可证
## License
Framely 原创代码,包括本体、安装器、SDK、模板和仓库示例,采用 **AGPL-3.0-only**,全文见 [LICENSE](LICENSE)。第三方依赖和 vendored 文件保留各自许可证。
Original Framely code, including the core, installer, SDK, template, and repository examples, uses **AGPL-3.0-only**; see [LICENSE](LICENSE). Third-party dependencies and vendored files retain their respective licenses.
AGPL 允许商业使用;分发需按许可提供完整对应源码,修改后通过网络与用户交互还须向这些用户提供源码。发行源码对应本仓库的 `v<版本>` 或 `installer-v<版本>` 标签;重新分发者须提供与自己二进制匹配的修改和构建脚本。
AGPL allows commercial use. Distribution requires complete corresponding source under the license; modified software that interacts with users over a network must also offer source to those users. Release source corresponds to the repository's `v<VERSION>` or `installer-v<VERSION>` tags. Redistributors must provide modifications and build scripts matching their binaries.
+100
View File
@@ -0,0 +1,100 @@
# Framely
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/branding/framely-logo-light.svg">
<img src="assets/branding/framely-logo.svg" alt="Framely" width="320" height="77">
</picture>
[English](README.md)
> Framely 目前仍在快速迭代中,功能和界面可能随预览版本调整。安卓应用与游戏的兼容性取决于 Lepton 和应用本身。
Framely 为 Steam Frame 提供统一的空间启动台,以及可在头显内和 PC 浏览器中使用的管理面板。
- **统一启动入口**:启动 Lepton 中的安卓应用、Linux 桌面程序、Steam 本地游戏和 Steam 远程畅玩游戏。
- **APK 侧载与管理**:安装、更新和卸载 APK,管理应用容器与数据;为支持手柄的安卓游戏提供手柄输入映射和振动反馈。
- **插件安装与管理**:安装和管理 Framely 插件,通过插件库发现并扩展功能。
- **PC 网页远程管理**:在 PC 浏览器中访问 Frame 的管理面板,管理设备文件、APK 和插件,支持文件上传、下载、编辑及常见图片和视频预览。
- **网页终端**:通过管理面板操作 Frame 的交互式终端,支持 Shell 命令和使用 `ssh` 连接其他设备,无需先通过 SSH 连接 Frame。
Framely 使用 Rust 核心服务和独立的 CEF/OpenVR 宿主,并提供电脑端安装器,也可管理插件来源、窗口、通知和更新。
![Framely 空间启动台](docs/images/launcher.png)
![Framely 插件库](docs/images/plugin-library.png)
## 安装
目标设备为 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
```
安装 Preview 时指定实际已发布的标签:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.5-preview.2
```
将示例标签替换为需要安装的已发布版本,并在提示时输入 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`。未配置密码时首次访问必须设置并确认密码,保存后登录。设备密码与面板密码相互独立。
## 文档
从 [文档首页](docs/zh-CN/README.md) 开始:
- [安装、更新、修复、回滚与卸载](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)
- [插件模板](templates/plugin/README.zh-CN.md) · [功能展示示例](examples/showcase/README.zh-CN.md)
- [本体发行维护](docs/zh-CN/releases.md) · [安装器构建](installer/README.zh-CN.md)
## 创建插件
开发机准备 Node.js 22 和 npm,克隆本仓库后执行:
```bash
node tools/plugin-dev.mjs init ../my-plugin yourname.my-plugin
cd ../my-plugin
npm install
npm run dev
npm run build
```
生成项目包含 React 页面、Python 后端、数据保存、生命周期回调、SDK 和构建工具。浏览器预览不启动后端;打包与实际 Frame 测试见开发指南。
## 构建与验证
本体源码在 Linux 构建,需要 Rust、Node.js、C/C++ 和 OpenGL/X11 开发库,生产原生宿主使用锁定版本的 Linux ARM64 CEF。
```bash
npm ci
npm run typecheck
npm run build
cargo test --locked
bash tools/test-native.sh
python3 -m unittest discover -s tests -p 'test_*.py'
```
CEF 构建、集成测试和发布命令见[发行维护](docs/zh-CN/releases.md)。插件支持 `steamos` 和 `root`;哈希校验不代表安全审核,应核对来源和运行用户。
## 许可证
Framely 原创代码,包括本体、安装器、SDK、模板和仓库示例,采用 **AGPL-3.0-only**,全文见 [LICENSE](LICENSE)。第三方依赖和 vendored 文件保留各自许可证。
AGPL 允许商业使用;分发需按许可提供完整对应源码,修改后通过网络与用户交互还须向这些用户提供源码。发行源码对应本仓库的 `v<版本>` 或 `installer-v<版本>` 标签;重新分发者须提供与自己二进制匹配的修改和构建脚本。
+7 -7
View File
@@ -1,18 +1,18 @@
# Framely 品牌资源 / Branding assets
# Framely branding assets / 品牌资源
像素窗口小精灵是本体和安装器的统一标识。`framely-mark.svg` 和 `framely-logo.svg` 为透明底深色版本,`*-light.svg` 用于深色背景;`framely-app-icon.svg` 为浅蓝底应用图标。字标已转成路径,无需安装字体。
The pixel window sprite is the shared identity for Framely and its installer. `framely-mark.svg` and `framely-logo.svg` are dark artwork on transparent backgrounds; `*-light.svg` variants are for dark surfaces. `framely-app-icon.svg` uses a charcoal tile with a sky blue sprite. Square marks center the window body, allowing the left tail to extend outward; the native Dock sprite is 10% smaller. The wordmark uses vector paths and needs no font installation.
The pixel window sprite is the shared identity for Framely and its installer. `framely-mark.svg` and `framely-logo.svg` are dark artwork on transparent backgrounds; `*-light.svg` variants are for dark surfaces. `framely-app-icon.svg` is the application tile on sky blue. The wordmark uses vector paths and needs no font installation.
修改 SVG 后,在仓库根目录重新生成 PNG、Windows ICO 和原生入口图形,并一同提交生成文件:
像素窗口小精灵是本体和安装器的统一标识。`framely-mark.svg` 和 `framely-logo.svg` 为透明底深色版本,`*-light.svg` 用于深色背景;`framely-app-icon.svg` 为黑底蓝色应用图标。正方形图标以窗口主体居中,尾巴向左伸出;原生插件入口中的图形缩小 10%。字标已转成路径,无需安装字体。
After editing the SVGs, regenerate PNGs, the Windows ICO and native Dock artwork from the repository root, then commit the generated files together:
修改 SVG 后,在仓库根目录重新生成 PNG、Windows ICO 和原生入口图形,并一同提交生成文件:
```bash
npm ci
npm run branding:build
```
macOS 打包时使用系统 `iconutil` 从 PNG 自动生成 `.icns`。运行时无需 Node.js;品牌资源采用仓库的 AGPL-3.0-only 许可证。
macOS packaging uses the system `iconutil` to generate `.icns` from the PNGs. Runtime does not require Node.js. These brand assets use the repository's AGPL-3.0-only license.
macOS 打包时使用系统 `iconutil` 从 PNG 自动生成 `.icns`。运行时无需 Node.js;品牌资源采用仓库的 AGPL-3.0-only 许可证。
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.6 KiB

+3 -3
View File
@@ -1,8 +1,8 @@
<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 32 32" role="img" aria-labelledby="title desc" color="#17191c">
<title id="title">Framely</title>
<desc id="desc">Charcoal pixel window sprite on a sky blue application tile.</desc>
<desc id="desc">Sky blue pixel window sprite on a charcoal application tile, centered on its window body.</desc>
<g shape-rendering="crispEdges">
<rect width="32" height="32" rx="3" fill="#93c5ed" shape-rendering="geometricPrecision"/>
<path fill="#17191c" fill-rule="evenodd" transform="translate(3.4 4) scale(1.2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
<rect width="32" height="32" rx="3" fill="#17191c" shape-rendering="geometricPrecision"/>
<path fill="#93c5ed" fill-rule="evenodd" transform="translate(1.6 4) scale(1.2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 658 B

After

Width:  |  Height:  |  Size: 687 B

+2 -2
View File
@@ -1,8 +1,8 @@
<svg xmlns="http://www.w3.org/2000/svg" width="1600" height="384" viewBox="0 0 100 24" role="img" aria-labelledby="title desc" color="#93c5ed">
<svg xmlns="http://www.w3.org/2000/svg" width="1664" height="384" viewBox="0 0 104 24" role="img" aria-labelledby="title desc" color="#93c5ed">
<title id="title">Framely</title>
<desc id="desc">Pixel window sprite with the framely wordmark drawn as vector pixels.</desc>
<g shape-rendering="crispEdges">
<path fill="currentColor" fill-rule="evenodd" transform="translate(1.5 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
<path fill="currentColor" transform="translate(29 5.25) scale(1.5)" d="M2 0h3v1h-3Z M1 1h2v1h-2Z M1 2h2v1h-2Z M0 3h4v1h-4Z M1 4h2v1h-2Z M1 5h2v1h-2Z M1 6h2v1h-2Z M7 2h2v1h-2Z M10 2h2v1h-2Z M7 3h3v1h-3Z M7 4h2v1h-2Z M7 5h2v1h-2Z M7 6h2v1h-2Z M15 2h3v1h-3Z M17 3h2v1h-2Z M15 4h4v1h-4Z M14 5h2v1h-2Z M17 5h2v1h-2Z M15 6h4v1h-4Z M21 2h2v1h-2Z M24 2h1v1h-1Z M21 3h5v1h-5Z M21 4h2v1h-2Z M24 4h2v1h-2Z M21 5h2v1h-2Z M24 5h2v1h-2Z M21 6h2v1h-2Z M24 6h2v1h-2Z M29 2h3v1h-3Z M28 3h2v1h-2Z M31 3h2v1h-2Z M28 4h5v1h-5Z M28 5h2v1h-2Z M29 6h4v1h-4Z M35 0h2v1h-2Z M35 1h2v1h-2Z M35 2h2v1h-2Z M35 3h2v1h-2Z M35 4h2v1h-2Z M35 5h2v1h-2Z M36 6h3v1h-3Z M42 2h2v1h-2Z M45 2h2v1h-2Z M42 3h2v1h-2Z M45 3h2v1h-2Z M42 4h2v1h-2Z M45 4h2v1h-2Z M43 5h4v1h-4Z M45 6h2v1h-2Z M44 7h2v1h-2Z M42 8h3v1h-3Z"/>
<path fill="currentColor" transform="translate(29 5.25) scale(1.5)" d="M2 0h3v1h-3Z M1 1h2v1h-2Z M1 2h2v1h-2Z M0 3h4v1h-4Z M1 4h2v1h-2Z M1 5h2v1h-2Z M1 6h2v1h-2Z M7 2h2v1h-2Z M10 2h2v1h-2Z M7 3h3v1h-3Z M7 4h2v1h-2Z M7 5h2v1h-2Z M7 6h2v1h-2Z M15 2h3v1h-3Z M17 3h2v1h-2Z M15 4h4v1h-4Z M14 5h2v1h-2Z M17 5h2v1h-2Z M15 6h4v1h-4Z M21 2h2v1h-2Z M24 2h2v1h-2Z M21 3h7v1h-7Z M21 4h2v1h-2Z M24 4h1v1h-1Z M26 4h2v1h-2Z M21 5h2v1h-2Z M24 5h1v1h-1Z M26 5h2v1h-2Z M21 6h2v1h-2Z M24 6h1v1h-1Z M26 6h2v1h-2Z M31 2h3v1h-3Z M30 3h2v1h-2Z M33 3h2v1h-2Z M30 4h5v1h-5Z M30 5h2v1h-2Z M31 6h4v1h-4Z M37 0h2v1h-2Z M37 1h2v1h-2Z M37 2h2v1h-2Z M37 3h2v1h-2Z M37 4h2v1h-2Z M37 5h2v1h-2Z M38 6h3v1h-3Z M44 2h2v1h-2Z M47 2h2v1h-2Z M44 3h2v1h-2Z M47 3h2v1h-2Z M44 4h2v1h-2Z M47 4h2v1h-2Z M45 5h4v1h-4Z M47 6h2v1h-2Z M46 7h2v1h-2Z M44 8h3v1h-3Z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

+2 -2
View File
@@ -1,8 +1,8 @@
<svg xmlns="http://www.w3.org/2000/svg" width="1600" height="384" viewBox="0 0 100 24" role="img" aria-labelledby="title desc" color="#17191c">
<svg xmlns="http://www.w3.org/2000/svg" width="1664" height="384" viewBox="0 0 104 24" role="img" aria-labelledby="title desc" color="#17191c">
<title id="title">Framely</title>
<desc id="desc">Pixel window sprite with the framely wordmark drawn as vector pixels.</desc>
<g shape-rendering="crispEdges">
<path fill="currentColor" fill-rule="evenodd" transform="translate(1.5 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
<path fill="currentColor" transform="translate(29 5.25) scale(1.5)" d="M2 0h3v1h-3Z M1 1h2v1h-2Z M1 2h2v1h-2Z M0 3h4v1h-4Z M1 4h2v1h-2Z M1 5h2v1h-2Z M1 6h2v1h-2Z M7 2h2v1h-2Z M10 2h2v1h-2Z M7 3h3v1h-3Z M7 4h2v1h-2Z M7 5h2v1h-2Z M7 6h2v1h-2Z M15 2h3v1h-3Z M17 3h2v1h-2Z M15 4h4v1h-4Z M14 5h2v1h-2Z M17 5h2v1h-2Z M15 6h4v1h-4Z M21 2h2v1h-2Z M24 2h1v1h-1Z M21 3h5v1h-5Z M21 4h2v1h-2Z M24 4h2v1h-2Z M21 5h2v1h-2Z M24 5h2v1h-2Z M21 6h2v1h-2Z M24 6h2v1h-2Z M29 2h3v1h-3Z M28 3h2v1h-2Z M31 3h2v1h-2Z M28 4h5v1h-5Z M28 5h2v1h-2Z M29 6h4v1h-4Z M35 0h2v1h-2Z M35 1h2v1h-2Z M35 2h2v1h-2Z M35 3h2v1h-2Z M35 4h2v1h-2Z M35 5h2v1h-2Z M36 6h3v1h-3Z M42 2h2v1h-2Z M45 2h2v1h-2Z M42 3h2v1h-2Z M45 3h2v1h-2Z M42 4h2v1h-2Z M45 4h2v1h-2Z M43 5h4v1h-4Z M45 6h2v1h-2Z M44 7h2v1h-2Z M42 8h3v1h-3Z"/>
<path fill="currentColor" transform="translate(29 5.25) scale(1.5)" d="M2 0h3v1h-3Z M1 1h2v1h-2Z M1 2h2v1h-2Z M0 3h4v1h-4Z M1 4h2v1h-2Z M1 5h2v1h-2Z M1 6h2v1h-2Z M7 2h2v1h-2Z M10 2h2v1h-2Z M7 3h3v1h-3Z M7 4h2v1h-2Z M7 5h2v1h-2Z M7 6h2v1h-2Z M15 2h3v1h-3Z M17 3h2v1h-2Z M15 4h4v1h-4Z M14 5h2v1h-2Z M17 5h2v1h-2Z M15 6h4v1h-4Z M21 2h2v1h-2Z M24 2h2v1h-2Z M21 3h7v1h-7Z M21 4h2v1h-2Z M24 4h1v1h-1Z M26 4h2v1h-2Z M21 5h2v1h-2Z M24 5h1v1h-1Z M26 5h2v1h-2Z M21 6h2v1h-2Z M24 6h1v1h-1Z M26 6h2v1h-2Z M31 2h3v1h-3Z M30 3h2v1h-2Z M33 3h2v1h-2Z M30 4h5v1h-5Z M30 5h2v1h-2Z M31 6h4v1h-4Z M37 0h2v1h-2Z M37 1h2v1h-2Z M37 2h2v1h-2Z M37 3h2v1h-2Z M37 4h2v1h-2Z M37 5h2v1h-2Z M38 6h3v1h-3Z M44 2h2v1h-2Z M47 2h2v1h-2Z M44 3h2v1h-2Z M47 3h2v1h-2Z M44 4h2v1h-2Z M47 4h2v1h-2Z M45 5h4v1h-4Z M47 6h2v1h-2Z M46 7h2v1h-2Z M44 8h3v1h-3Z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.4 KiB

+2 -2
View File
@@ -1,7 +1,7 @@
<svg xmlns="http://www.w3.org/2000/svg" width="384" height="384" viewBox="0 0 24 24" role="img" aria-labelledby="title desc" color="#93c5ed">
<title id="title">Framely</title>
<desc id="desc">Sky blue pixel window sprite for dark backgrounds.</desc>
<desc id="desc">Pixel window sprite with two square eyes and a raised hand.</desc>
<g shape-rendering="crispEdges">
<path fill="currentColor" fill-rule="evenodd" transform="translate(1.5 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
<path fill="currentColor" fill-rule="evenodd" transform="translate(0 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 548 B

After

Width:  |  Height:  |  Size: 555 B

+1 -1
View File
@@ -2,6 +2,6 @@
<title id="title">Framely</title>
<desc id="desc">Pixel window sprite with two square eyes and a raised hand.</desc>
<g shape-rendering="crispEdges">
<path fill="currentColor" fill-rule="evenodd" transform="translate(1.5 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
<path fill="currentColor" fill-rule="evenodd" transform="translate(0 2)" d="M6 3H18V4H19V14H18V15H16V16H15V17H13V15H10V16H9V17H7V15H6V14H5V10H3V9H2V8H3V9H5V4H6Z M7 6H17V13H7Z M14 4H15V5H14Z M16 4H17V5H16Z M9 8H11V10H9Z M13 10H15V12H13Z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 557 B

After

Width:  |  Height:  |  Size: 555 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 184 B

After

Width:  |  Height:  |  Size: 189 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 270 B

After

Width:  |  Height:  |  Size: 278 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 327 B

After

Width:  |  Height:  |  Size: 348 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 408 B

After

Width:  |  Height:  |  Size: 414 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 482 B

After

Width:  |  Height:  |  Size: 480 B

+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.
+29 -26
View File
@@ -1,37 +1,40 @@
# Framely 文档
# Framely documentation
[English](en/README.md)
[简体中文](zh-CN/README.md)
Framely 是 Steam Frame 的插件管理器,包含设备端服务、SteamVR 界面、网络管理面板和电脑端安装器。
Framely manages plugins on Steam Frame through device services, a SteamVR interface, a web panel, and a desktop installer.
## 用户指南
## User guides
按顺序阅读即可完成安装并使用第一个插件。
1. [Install, update, repair and uninstall](user-guide/installation.md): desktop installer, SSH, Preview builds, local packages and rollback.
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.
1. [安装、更新、修复与卸载](user-guide/installation.md):桌面安装器、SSH、Preview、本地包、回滚。
2. [基本使用](user-guide/basic-usage.md):Dock 入口、管理窗口、启停、收藏、安全模式。
3. [安装与管理插件](user-guide/plugins.md):商店、来源、订阅、本地包和更新。
4. [网络管理面板](user-guide/network-panel.md):地址、首次密码、登录、手机/电脑使用。
## Plugin development and publishing
## 插件开发与发布
- [Complete workflow](developer-guide/README.md): scaffold → preview → backend → package → device testing → publish.
- [SDK API](developer-guide/sdk.md) · [Manifest configuration](developer-guide/manifest.md) · [Lifecycle](plugin-lifecycle.md)
- [Publish plugins and catalogs](developer-guide/publishing.md): default GitHub URLs, custom URLs/hashes, catalog history and database registration.
- [Plugin template](../templates/plugin/README.md): React and Python, generated projects or in-repository editing.
- [Showcase plugin](../examples/showcase/README.md): additional UI and device examples.
- [完整流程](developer-guide/README.md):生成项目 → 浏览器预览 → 后端 → 打包 → 实机测试 → 发布。
- [SDK API](developer-guide/sdk.md) · [Manifest 配置说明](developer-guide/manifest.md) · [生命周期](plugin-lifecycle.md)
- [发布插件与插件源](developer-guide/publishing.md):GitHub 默认地址生成、自定义地址与哈希、目录历史、数据库登记。
- [可用插件模板](../templates/plugin/README.md):React + Python,脚手架与仓库内编辑两种使用方式。
- [功能展示插件](../examples/showcase/README.md):更多 UI 和设备交互示例。
## Technical references
## 技术参考
| 参考 | 内容 |
| Reference | Contents |
| --- | --- |
| [清单、SDK 与后端协议](plugin-development.md) | Manifest 字段、窗口、通知、JSON RPC、打包规则 |
| [生命周期](plugin-lifecycle.md) | 安装、更新、启动、停止、卸载及恢复钩子 |
| [依赖与冲突](plugin-relationships.md) | 版本范围、来源选择、可选依赖、独占资源 |
| [源订阅格式](source-subscriptions.md) | JSON 格式、刷新、地址变更及去重 |
| [语言与翻译](localization.md) | 语言包、文案键、社区翻译 |
| [Plugin development reference](plugin-development.md) | Manifest, windows, notifications, JSON RPC and packaging |
| [Lifecycle](plugin-lifecycle.md) | Install, update, start, stop, uninstall and recovery hooks |
| [Dependencies and conflicts](plugin-relationships.md) | Version ranges, source selection and exclusive resources |
| [Source subscriptions](source-subscriptions.md) | JSON format, refresh, URL changes and deduplication |
| [Localization](localization.md) | Language packs and community translations |
## 维护者资料
## Maintainer documentation
- [Framely 发行与更新机制](releases.md)
- [电脑端安装器构建](../installer/README.md)
- [Framely releases and updates](releases.md)
- [Desktop installer](../installer/README.md)
- [Space launcher](launcher.md)
- [Launcher actions and host compatibility](developer-guide/launcher.md)
+39 -35
View File
@@ -1,12 +1,12 @@
# 插件开发到发布:完整流程
# Plugin development to publication
[English](../en/developer-guide/README.md)
[简体中文](../zh-CN/developer-guide/README.md)
[文档首页](../README.md) · [发布指南](publishing.md)
[Documentation](../README.md) · [Publishing](publishing.md)
## 1. 准备开发环境
## 1. Prepare the development environment
开发机准备 Git、Node.js 22、npm;发布指南中的临时清单脚本还需要 Python 3。本体 CLI 使用 Linux 专用接口,源码打包命令需在安装 Rust 的 Linux/WSL 环境执行,不能直接在 Windows/macOS 原生编译本体。也可将清单和 payload 拷到 Frame,使用已安装的 CLI 打包。设备端无需 Node.js/Rust,Python 后端依赖设备的 Python 3。开发机可以用于界面预览和打包,VR 交互必须在 Frame 验证。
Install Git, Node.js 22 and npm. The publishing Manifest script also needs Python 3. The core CLI uses Linux-specific interfaces, so source packaging requires Rust on Linux/WSL, not native Windows/macOS compilation. Alternatively copy Manifest/payload to Frame and use its installed CLI. Device users do not need Node.js/Rust; Python backends use device Python 3. Preview and packaging work on the development computer; VR interaction requires Frame.
```bash
git clone https://github.com/SteamFramelyHomebrew/framely.git
@@ -17,42 +17,42 @@ npm install
npm run dev
```
这里的 `yourname.my-plugin` 是示例 ID,发布前换成你自己的稳定命名空间。脚手架拒绝覆盖已有目录,复制 SDK 和构建工具,生成后不依赖原 Framely 仓库的位置。将生成项目放入自己的 Git 仓库,并提交 `package-lock.json` 和 vendored SDK;不要提交 `node_modules/`、`payload/`、发行包和密码。
Replace the example ID with your own stable namespace. The scaffold refuses to overwrite directories and copies the SDK and tools, so the resulting project does not depend on the original repository location. Create your plugin Git repository and commit `package-lock.json` and the vendored SDK. Do not commit `node_modules/`, `payload/`, archives or passwords.
## 2. 认识模板
## 2. Understand the template
| 文件 | 用途 |
| File | Purpose |
| --- | --- |
| `manifest.json` | ID、名称、版本、运行用户、页面、生命周期、依赖 |
| `page.tsx` | React 快捷页和独立窗口 |
| `backend.py` | Python 后端及数据保存 |
| `vendor/framely-sdk/` | UI、桥接接口和 Python 协议辅助库 |
| `dev.mjs` | 构建和本地预览工具 |
| `LICENSE` | AGPLv3 许可证全文 |
| `manifest.json` | Identity, version, runtime user, pages, lifecycle and dependencies |
| `page.tsx` | React quick page and independent window |
| `backend.py` | Python backend and persistent settings |
| `vendor/framely-sdk/` | UI, bridge API and Python protocol helper |
| `dev.mjs` | Build and local preview |
| `LICENSE` | Full AGPLv3 text |
模板的“读取/保存”使用 `settings.get` / `settings.set`,内容保存在后端的 `FRAMELY_DATA_DIR/settings.json`。它还演示打开 `main` 窗口、发送通知、启动/停止和安装/更新/卸载回调。默认身份 `steamos`,默认按需启动。
Read/save uses `settings.get` / `settings.set` with `FRAMELY_DATA_DIR/settings.json`. The template opens the `main` window, sends notifications and demonstrates install/update/start/stop/uninstall callbacks. It defaults to `steamos` and on-demand startup.
## 3. 修改清单与界面
## 3. Edit Manifest and UI
先修改 `manifest.json` 中的 ID、作者、名称、描述、版本、标签和 `changelog`。使用完整 SemVer,例如 `0.1.0`、`0.2.0-preview.1`;已发布版本不覆盖。
Set the ID, author, name, description, version, tags and changelog. Use full SemVer such as `0.1.0` or `0.2.0-preview.1`; never overwrite a published version.
`ui.quickPage` 和 `ui.windows.main.entry` 指向构建后的 `page.js`。页面通过 `registerPlugin({QuickPage, WindowPage})` 注册。窗口 key 必须与清单一致。`files` 留空,打包时自动计算哈希。
`ui.quickPage` and `ui.windows.main.entry` refer to built `page.js`. Register components with `registerPlugin({QuickPage, WindowPage})`, matching declared keys. Leave `files` empty; packaging computes hashes.
在浏览器打开 `http://127.0.0.1:5173`;修改页面后自动重载。预览只模拟窗口和通知,不启动 Python 后端,不拥有 Frame 权限;读取/保存按钮在预览中报出后端不可用是正常情况。不要据此声称设备功能已验收。
Preview at `http://127.0.0.1:5173`, with automatic reload. Preview simulates windows and notifications, without Python backends or device privileges. Read/save therefore reports backend unavailability; this is expected and is not device validation.
UI 与后端 API 见 [SDK 文档](sdk.md),字段、默认值和范围见 [Manifest 配置](manifest.md);窗口与商店资料补充见[插件开发参考](../plugin-development.md)。
See [SDK API](sdk.md), [Manifest configuration](manifest.md) and the [development reference](../plugin-development.md).
## 4. 实现后端与生命周期
## 4. Implement backend and lifecycle
后端 stdin/stdout 使用逐行 JSON RPC;stdout 仅输出协议,调试日志输出 stderr。Python 模板使用 `framely.serve` 处理请求、错误和生命周期。修改业务逻辑时校验参数长度与类型,并返回能由 JSON 序列化的结果。
Backend stdin/stdout use newline-delimited JSON RPC. Reserve stdout for protocol messages and log to stderr. Python `framely.serve` handles requests, exceptions and hooks. Validate parameter types and lengths and return JSON-serializable values.
写数据使用 `FRAMELY_DATA_DIR`,不要写到插件载荷或 Framely 程序目录。升级、回退和运行用户变更的状态迁移由插件设计;`steamos` 与 `root` 对应不同的数据目录。普通功能优先使用 `steamos`,确需系统权限时才使用 `root` 并解释原因。
Write to `FRAMELY_DATA_DIR`, not plugin payload or Framely binaries. Design migrations for updates, older versions and runtime-user changes. `steamos` and `root` have separate data directories. Prefer `steamos`; explain any required root privileges.
安装/更新钩子应可重复执行;停止/卸载时释放本插件持有的外部资源。关闭 UI 窗口不等于停止后端,React effect 清理不能替代后端钩子。系统依赖不会由 Framely 自动安装,需在说明中写清。[生命周期参考](../plugin-lifecycle.md)
Make install/update hooks repeatable and release owned external resources on stop/uninstall. Closing UI does not stop the backend; React effect cleanup cannot replace backend hooks. System dependencies are not installed automatically. See [lifecycle](../plugin-lifecycle.md).
## 5. 构建、打包、校验
## 5. Build, package and verify
在插件项目中执行:
Inside your plugin:
```bash
npm run build
@@ -61,24 +61,28 @@ cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify yourname.my-plugin-0.1.0.framely
```
将 `FRAMELY_REPO` 换成开发机上的 Framely 仓库绝对路径。也可在 Frame 使用已安装的 `/var/lib/framely/current/bin/framely pack` / `verify`,这些离线操作无需 sudo。
Set the repository's actual absolute path. Alternatively use installed `/var/lib/framely/current/bin/framely pack` / `verify` on Frame; these offline commands do not need sudo.
`payload/` 只放要分发的页面、后端、Python 协议库及必要资源。构建会复制 `backend.py`、`framely.py`;额外图标等资源需要自行放入该目录。打包检查入口、路径、清单和哈希,不允许软链接或额外包内文件。
Include only distributable pages, backend, Python helper and resources in `payload/`. Build copies `backend.py` and `framely.py`; add icons and other assets yourself. Packaging checks entries, paths, Manifest and hashes, rejecting symlinks and undeclared extra archive files.
## 6. 安装到 Frame 测试
## 6. Test on Frame
将包下载到手机/电脑,进入网络面板,在“插件”的本地导入入口上传并确认;或通过 SSH 复制到 Frame 后执行:
Import the package through the web panel and review confirmation, or transfer it and run on Frame:
```bash
sudo /var/lib/framely/current/bin/framely install ./yourname.my-plugin-0.1.0.framely --approve
```
首次协议确认后再管理插件。测试读取/保存、窗口和通知,停用再启用,重启后读回数据;修改版本后测试更新和数据保留,最后测试卸载钩子。涉及 VR 键盘、手柄或硬件的功能,记录实际 Frame 验证结果。
Accept the terms before management. Test read/save, windows and notifications, disabling/re-enabling, persistent data after reboot, updates after a version bump, and uninstall cleanup. Record actual device checks for VR input, controllers and hardware.
日志可通过 Framely 状态与 systemd 日志检查;后台插件 stdout 不应混入调试文字。更完整的安装操作见[用户教程](../user-guide/plugins.md)。
Inspect Framely status and systemd logs. Do not mix debug messages into backend stdout. See [installation](../user-guide/plugins.md).
## 7. 发布
## 7. Publish
GitHub Release 默认使用标签 `v<version>` 和附件 `<id>-<version>.framely`,源码清单可以省略 `downloadUrl`。社区登记会自动拼接地址;打包前按[发布指南](publishing.md)生成包含最终地址的临时清单,因为当前 `framely pack` 不会自己读取仓库地址。自定义下载地址再显式填写 `downloadUrl`。随后公开 Release、上传包,提供使用说明、运行用户、更新记录和实际测试范围,再自行托管插件源或登记固定源码提交。社区数据库还需校验整包预期哈希和字段兼容性。
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.
后续更新:提升版本号 → 重新生成发布清单(自定义地址时更新地址)→ 构建打包并校验 → 实机验证 → 新 Release → 更新来源登记。不要替换旧版本附件。
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.
+59 -53
View File
@@ -1,19 +1,19 @@
# Manifest 配置说明
# Manifest configuration
[English](../en/developer-guide/manifest.md)
[简体中文](../zh-CN/developer-guide/manifest.md)
[开发流程](README.md) · [SDK](sdk.md) · [生命周期](../plugin-lifecycle.md)
[Development](README.md) · [SDK](sdk.md) · [Lifecycle](../plugin-lifecycle.md)
项目根目录 `manifest.json` 描述插件;打包后同名文件位于包内。字段采用 camelCase,安装包清单拒绝未知字段,不要添加已废弃的 `permissions`。以[模板清单](../../templates/plugin/manifest.json)为起点。
The repository-root `manifest.json` describes a plugin and is included in its archive. Fields use camelCase. Package Manifests reject unknown fields; do not add retired `permissions`. Start from the [template](../../templates/plugin/manifest.json).
## 最小示例
## Minimal example
```json
{
"schemaVersion": 1,
"apiVersion": 1,
"id": "yourname.my-plugin",
"name": "我的插件",
"name": "My plugin",
"version": "0.1.0",
"author": "Your name",
"backend": {"entry": "backend.py", "runAs": "steamos"},
@@ -22,75 +22,81 @@
}
```
源码清单的 `files` 留空;`framely pack` 遍历 payload 并生成实际文件哈希。至少一个载荷文件,每个入口必须存在于 payload。完整模板见 [manifest.json](../../templates/plugin/manifest.json)。
Leave source `files` empty. `framely pack` scans payload and supplies hashes. At least one payload file is required; all declared entries must be included. See the [complete template](../../templates/plugin/manifest.json).
## 顶层字段
## Top-level fields
| 字段 | 要求与默认值 |
| Field | Requirements/default |
| --- | --- |
| `schemaVersion` / `apiVersion` | 必填,目前均为 `1` |
| `id` | 必填,最多 80 字符;允许小写字母、数字、点、短横线、下划线;不能以点开头,禁止 `..`;脚手架要求字母/数字开头,推荐 `namespace.name` |
| `name` / `author` | 必填且非空,各最多 120 字节 |
| `version` | 必填,最多 64 字节,仅 ASCII 字母、数字和 `.-+`;建议完整 SemVer,声明关系时必须 SemVer |
| `description` | 简介,默认空字符串;社区数据库要求最多 4096 字节 |
| `details` / `changelog` | 详细说明/本版本变化,默认空字符串;分别最多 32768 / 16384 字节 |
| `tags` | 标签字符串数组,默认空;最多 12 项,每项非空且最多 80 字节;用于搜索与筛选 |
| `icon` | 可选,payload 内 PNG 路径;最大 1 MiB、1024×1024 |
| `screenshots` | 默认空数组,最多 8 个 payload 内 PNG/JPEG 路径 |
| `authorUrl` / `documentationUrl` / `homepage` | 可选 HTTP/HTTPS 地址,禁止 URL 内用户名密码 |
| `downloadUrl` | 可选,固定版本 HTTPS 包下载地址;GitHub 数据库源码可省略,按仓库/版本/ID 拼接,社区登记的包内需补全;见发布指南 |
| `publish` | 可选外部商店图片配置,见下文 |
| `backend` / `lifecycle` / `ui` | 可选,配置后端、钩子和页面 |
| `dependencies` / `optionalDependencies` / `conflicts` | 默认空对象,见关系参考 |
| `exclusiveResources` | 默认空数组,禁止同时启用占用同名资源的插件 |
| `files` | 必填对象,打包自动生成路径到 SHA256 的映射,最多 2048 个文件 |
| `schemaVersion` / `apiVersion` | Required, currently both 1 |
| `id` | Required, max 80 characters; lowercase letters/digits/dots/hyphens/underscores; no leading dot or `..`; the scaffold requires a letter/digit first; prefer `namespace.name` |
| `name` / `author` | Required, nonempty, max 120 bytes each |
| `version` | Required, max 64 bytes, ASCII letters/digits and `.-+` only; full SemVer recommended and required when declaring relationships |
| `description` | Short summary, default empty; database registration limits it to 4096 bytes |
| `details` / `changelog` | Full description/version changes, default empty; max 32768 / 16384 bytes respectively |
| `tags` | String array, default empty; max 12 nonempty entries of at most 80 bytes each; search/filter tags |
| `icon` | Optional payload PNG path, max 1 MiB and 1024×1024 |
| `screenshots` | Default empty; up to eight payload PNG/JPEG paths |
| `authorUrl` / `documentationUrl` / `homepage` | Optional HTTP/HTTPS links, no embedded credentials |
| `downloadUrl` | Optional fixed-version HTTPS package URL; GitHub database source may omit it for repository/version/ID derivation, but community packages need the resolved URL; see publishing |
| `publish` | Optional external plugin library image configuration |
| `backend` / `lifecycle` / `ui` | Optional backend/hooks/pages |
| `dependencies` / `optionalDependencies` / `conflicts` | Default empty maps |
| `exclusiveResources` | Default empty array; matching names prevent simultaneous enabling |
| `files` | Required path-to-SHA256 map, generated during packaging, max 2048 files |
旧 `category` 字段仅兼容读取,不再导出;新插件使用 `tags`。`downloadSha256` 是数据库源码登记专用的整包 SHA256,不能放入严格校验的包内清单。默认 GitHub Release 模式从附件 `digest` 读取整包哈希;自定义 HTTPS 地址需要填写源码专用哈希,打包时移除。省略源码 `downloadUrl` 时,社区登记会补全,但当前 `framely pack` 不会自动补全;[发布指南](publishing.md)提供临时清单命令。社区登记还有比本体严格的 ID、简介长度等校验,不能将本体校验通过等同于登记成功。
Legacy `category` is accepted only for compatibility and no longer exported; use tags. `downloadSha256` is a database source-registration field for whole-package SHA256, not a package field. Default GitHub Releases use asset digests; custom HTTPS URLs require a declared source hash, removed before packaging. The database resolves omitted source `downloadUrl`, but current `framely pack` does not. See [publishing](publishing.md) for a temporary-Manifest command. Database IDs and description lengths have stricter constraints than core validation; passing the core does not guarantee registration.
## `backend`
## Backend
| 字段 | 说明 |
| Field | Meaning |
| --- | --- |
| `entry` | 必填,包内可执行入口,脚本需有效 shebang |
| `args` | 默认空数组,最多 64 项,每项最多 4096 字节且无 NUL;每项是独立参数,不是 Shell 命令 |
| `runAs` | `steamos`(默认)或 `root` |
| `autostart` | 默认 false,按需启动;true 表示启动时常驻 |
| `restart` | `on-failure`(默认)或 `never` |
| `restartLimit` | 连续失败阈值 1–10,默认 3 |
| `memoryLimitMiB` | 内存上限,默认 512 MiB;1–4294967295 的整数,不能用 0 或 null 取消限制 |
| `entry` | Required executable payload entry; scripts need a valid shebang |
| `args` | Default empty; at most 64 independent args, each ≤4096 bytes without NUL; not a shell command |
| `runAs` | `steamos` (default) or `root` |
| `autostart` | false by default for on-demand startup; true for resident startup |
| `restart` | `on-failure` (default) or `never` |
| `restartLimit` | Consecutive failure threshold 1–10, default 3 |
| `memoryLimitMiB` | Memory limit, default 512 MiB; integer 1–4294967295, no 0/null for unlimited memory |
省略 backend 可制作纯 UI 插件。系统/Python 第三方依赖不会自动安装。运行用户变化需用户确认,数据目录按运行身份区分,不自动迁移。
Omit backend for UI-only plugins. System/third-party Python dependencies are not installed automatically. Runtime-user changes require confirmation and use separate data directories without automatic migration.
`backend.memoryLimitMiB` 映射到 systemd 的 `MemoryMax`,限制后端及其所有子进程的合计内存;它是上限,不会预分配内存。独立生命周期钩子沿用该值,没有后端的钩子使用 512 MiB。安装计划、CLI 和已安装插件管理页展示上限。省略或填写 512 时打包省略该字段,保持旧包兼容;使用其他值需要支持此字段的新版宿主及插件数据库。
`backend.memoryLimitMiB` maps to systemd `MemoryMax` for the combined memory of the backend and all its child processes. It is a ceiling, not a memory reservation. Independent lifecycle hooks inherit this limit; hooks without a backend use 512 MiB. The install plan, CLI and installed-plugin management view display the limit. Omitted or explicit 512 values are omitted when packing to preserve compatibility with older hosts; other values require a host and plugin database supporting this field.
例如,为较长回放声明 2 GiB:
For example, declare 2 GiB for a longer replay buffer:
```json
{"backend": {"entry": "backend", "memoryLimitMiB": 2048}}
```
## `ui`
## UI
`quickPage` 是可选包内页面 bundle 路径;`windows` 默认空对象,最多 8 个窗口,key 必须是合法 ID。每个窗口:
Optional `quickPage` points to a payload bundle. `windows` defaults to an empty map with at most eight windows; keys must be valid IDs:
| 字段 | 说明 |
| Field | Meaning |
| --- | --- |
| `entry` / `title` | 必填;入口需在 payload;标题非空且最多 120 字节 |
| `dockIcon` | 默认 false,true 为独立 Dock 窗口 |
| `width` / `height` | 默认 1600×900;宽 640–2560,高 360–1440 |
| `widthMeters` | 默认 3.0;有效值 0.4–4.0 米。源码可读取 null,但打包会省略,再读取采用默认 3.0 |
| `localWeb` | 默认 false;特殊本机网页窗口由后端 `window.get` 提供 localhost URL |
| `entry` / `title` | Required payload entry and nonempty title ≤120 bytes |
| `dockIcon` | false by default; true creates a Dock window |
| `width` / `height` | Default 1600×900; width 640–2560, height 360–1440 |
| `widthMeters` | Default 3.0; finite 0.4–4.0 meters. Source null is accepted but omitted during packaging, then reads back as default 3.0 |
| `localWeb` | false by default; specialized localhost windows obtain a URL from backend `window.get` |
`localWeb` 只支持 Frame 本机打开,后端 `window.get` 参数为 `{window: key}`,返回 `{url: "http://localhost:<port>/framely-window/<key>"}`;不得有查询串、锚点或使用管理面板端口。它使用本机网页所需的不同 sandbox 标志。普通 React 插件无需 `localWeb`。窗口 key 与 `framely.windows.open(key)` 及注册的组件映射一致。尺寸在重新打开窗口时生效。
`localWeb` opens on Frame only: backend `window.get` receives `{window: key}` and returns `{url: "http://localhost:<port>/framely-window/<key>"}` without query/fragment or the management port. It uses different sandbox flags for local web apps. Ordinary React plugins do not need `localWeb`. Match window keys to `framely.windows.open(key)` and component registration. Size changes apply when reopening.
## `lifecycle`
## Lifecycle
`onInstall`、`onUpdate`、`onUninstall`、`onCrashCleanup` 是可选 `{entry, args?}` 独立命令;`onStart` / `onStop` 是默认 false 的布尔开关,需要 backend。`timeoutSeconds` 默认 10,范围 1–15 秒。`runAs` 可选,有后端时必须与后端一致,纯 UI 插件独立钩子可用它声明身份。独立命令的 `args` 限制与 backend 相同。执行时机、失败行为和上下文见[生命周期](../plugin-lifecycle.md)。
`onInstall`, `onUpdate`, `onUninstall`, `onCrashCleanup` are optional independent `{entry, args?}` commands. `onStart` / `onStop` are booleans defaulting to false and require a backend. `timeoutSeconds` is 1–15, default 10. Optional `runAs` must match the backend when present and can specify identity for UI-only standalone hooks. Standalone command `args` have the same limits as backend args. See [lifecycle](../plugin-lifecycle.md) for timing, errors and context.
## 发布资料与关系
## Publication and relationships
`publish.icon` 为 HTTPS 外部图标 URL,`publish.screenshots` 为最多 8 个 HTTPS 截图 URL。包内 `icon` 和 `screenshots` 是文件路径,不能混用。下载地址优先使用 `downloadUrl`,同版本内容必须保持不变。[发布指南](publishing.md)
`publish.icon` is an external HTTPS icon, `publish.screenshots` contains up to eight external HTTPS images. Package `icon` and `screenshots` are paths; do not confuse them. Download URLs prefer `downloadUrl`; published versions must remain immutable. See [publishing](publishing.md).
依赖值可为版本范围字符串,或 `{version, source}`;source 是 HTTPS `catalog.json` 地址。冲突值是版本范围。可选依赖缺失不阻止安装,独占资源只按作者声明校验。[依赖与冲突](../plugin-relationships.md)
Dependencies use ranges or `{version, source}`, with source pointing to an HTTPS catalog. Conflicts use ranges. Missing optional dependencies do not prevent installation; exclusive resources rely on author declarations. See [relationships](../plugin-relationships.md).
清单 JSON 最大 256 KiB,载荷路径最多 512 字节。载荷路径仅允许 ASCII 字母、数字及 `/._-+`,禁止绝对路径、空段、`.`、`..`、软链接和未声明的附加包文件。清单通过校验后,运行权限仍需用户判断;文件哈希不代表插件安全审核。
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)
+39 -39
View File
@@ -1,24 +1,24 @@
# 发布插件与插件源
# Publish plugins and catalogs
[English](../en/developer-guide/publishing.md)
[简体中文](../zh-CN/developer-guide/publishing.md)
[文档首页](../README.md) · [开发全流程](README.md)
[Documentation](../README.md) · [Development workflow](README.md)
## GitHub Release 默认地址
## Default GitHub Release URL
公开 GitHub 插件仓库的**源码 `manifest.json` 可以省略 `downloadUrl`**。社区数据库从登记的仓库地址、版本和插件 ID 自动生成:
A public GitHub plugin repository's **source `manifest.json` may omit `downloadUrl`**. The community database derives it from the registered repository, version and plugin ID:
```text
https://github.com/<owner>/<repo>/releases/download/v<version>/<id>-<version>.framely
```
例如仓库 `yourname/my-plugin`、ID `yourname.my-plugin`、版本 `0.1.0` 对应标签 `v0.1.0` 和附件 `yourname.my-plugin-0.1.0.framely`。仓库名不必与 ID 相同。必须真正省略字段;空字符串或 null 不表示自动生成。不要使用 `latest`,不要替换同版本附件。
Repository `yourname/my-plugin`, ID `yourname.my-plugin`, version `0.1.0` means tag `v0.1.0` and asset `yourname.my-plugin-0.1.0.framely`. Repository names need not match IDs. Omit the field entirely; empty strings or null do not select automatic generation. Avoid `latest` and never replace same-version assets.
源码登记与打包有一项区别:数据库会补全源码清单的下载地址,并要求**包内清单含相同的最终 `downloadUrl`**。当前 `framely pack` 只计算载荷哈希,不读取 Git remote、不自动拼接 Release URL。若源码省略该字段,打包前生成临时清单;无需把地址手写回源码。
Source registration and packaging differ: the database normalizes the source URL and requires **the same final `downloadUrl` in the packaged Manifest**. Current `framely pack` computes payload hashes but does not inspect Git remotes or derive Release URLs. If your source omits the field, prepare a temporary Manifest before packaging; you do not need to write the URL back into source.
## 生成发布包
## Prepare the release package
先按[开发流程](README.md)创建插件、执行 `npm run build`,在自己的插件 Git 仓库配置正确的 GitHub `origin`。以下命令在插件目录执行,从源码生成 `.framely-build/manifest.json`,支持 HTTPS、SSH 两种常用 remote 写法;已有显式 `downloadUrl` 会保留,源码不会改写:
Follow the [development workflow](README.md), run `npm run build`, and configure the plugin repository's GitHub `origin`. Run this inside your plugin to create `.framely-build/manifest.json`. It supports common HTTPS/SSH remotes, preserves explicit `downloadUrl`, and leaves source unchanged:
```bash
python3 - <<'PY'
@@ -48,7 +48,7 @@ print(manifest['downloadUrl'])
PY
```
`.framely-build/` 是临时输出,应加入插件 `.gitignore`。模板已忽略它。包名必须与默认规则一致;在插件目录继续执行:
Ignore temporary `.framely-build/` in your plugin Git repository; the template already does so. Asset filenames must match the default rule. Continue inside your plugin:
```bash
FRAMELY_REPO=/absolute/path/to/framely
@@ -59,42 +59,42 @@ cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify "dist/$PLUGIN_ID-$PLUGIN_VERSION.framely"
```
提交源码、SDK、锁文件和许可证,将该提交标记为 `v<version>`;创建对应 GitHub Release,上传 `dist/` 内的 `.framely`,并公开 Release。包内清单和源码登记清单在补全默认地址、去掉源码专用字段后应一致。用于登记的 submodule 必须指向这个实际发布版本的源码提交。
Commit source, SDK, lockfile and license; tag that commit `v<version>`, create its GitHub Release, upload the `.framely` from `dist/`, and publish. Source and packaged declarations must match after normalizing the default URL and removing registration-only fields. Pin database submodules to the actual released source commit.
发行说明包含功能和使用方法、运行用户及 root 的原因、依赖、变化、实际 Frame 测试和已知限制。提供与包匹配的源码和构建脚本,遵守模板、SDK及依赖许可证。
Release notes describe usage, runtime user and reasons for root, dependencies, changes, actual Frame tests and limitations. Provide matching source/build scripts and comply with template, SDK and dependency licenses.
### 整包哈希与自定义地址
### Whole-package hashes and custom URLs
| 方式 | 源码登记 | 校验的预期整包哈希 |
| Method | Source registration | Expected whole-package hash |
| --- | --- | --- |
| 默认 GitHub Release | 省略 `downloadUrl`;标签和附件遵守上述命名 | 从对应 Release 附件的 `digest` 读取 SHA256,无需手写 |
| 显式固定 GitHub Release | 填 `downloadUrl`,可改变标签或附件名 | 未提供 `downloadSha256` 时读取 Release digest;显式提供时以该哈希校验 |
| 其他 HTTPS 下载地址 | 填 `downloadUrl` 和 `downloadSha256` | 使用源码登记中声明的 64 位整包 SHA256 |
| Default GitHub Release | Omit `downloadUrl`; use the tag/asset naming above | Read SHA256 from the Release asset `digest`; no handwritten hash needed |
| Explicit fixed GitHub Release | Set `downloadUrl` to choose a different tag/asset name | Read Release digest if `downloadSha256` is absent; otherwise validate against the declared hash |
| Other HTTPS download | Set `downloadUrl` and `downloadSha256` | Use the declared 64-character whole-package SHA256 |
自动地址模式即使另填 `downloadSha256`,也必须与 Release digest 相同。缺少 Release digest、附件未公开、无法下载或哈希不符会阻止登记,不会退回到信任刚下载的文件。
Automatic URLs always require a Release digest, even when a hash is supplied, and both must match. Missing digests, unpublished/missing assets, download failures or hash mismatches block registration; there is no fallback to trusting the downloaded bytes.
`downloadSha256` 只属于数据库源码登记,指完整 `.framely` 的哈希;不是载荷的 `files` 哈希,也不是 Framely 包内字段。先生成包,执行 `sha256sum dist/<id>-<version>.framely`,再把结果写入源码登记。打包必须移除它,上面的临时清单命令已处理;不要向包内写入自身哈希。直接给 `framely pack` 传含此字段的源码清单会被未知字段校验拒绝。
`downloadSha256` belongs only to database source registration, covers the complete `.framely`, and differs from payload `files` hashes. It is not a Framely package field. Build first, run `sha256sum dist/<id>-<version>.framely`, then add it to source registration. Remove it before packaging, as the temporary-Manifest command does. Do not embed a package's own hash inside it. Passing source containing this field directly to `framely pack` fails unknown-field validation.
### 图标与窗口兼容
### Icons and window compatibility
社区数据库的图标通常只需顶层 `icon: "icon.png"`:同一路径 PNG 同时提交到源码仓库和 `payload/`。数据库从登记的仓库、固定提交及路径生成 GitHub Raw 地址,并下载比较包内图标;不需要额外填写 `publish.icon`。自行托管目录的图片由 `publish.icon` / `publish.screenshots` 提供固定 HTTPS 地址。[商店资料参考](../plugin-development.md#商店资料与图标)
For the community database, set top-level `icon: "icon.png"` and include the same PNG path in source and payload. The database derives a GitHub Raw URL from the pinned repository/commit/path and verifies it against the packaged icon; `publish.icon` is unnecessary. Self-hosted catalogs use fixed HTTPS `publish.icon` / `publish.screenshots`. See [plugin library metadata](../plugin-development.md).
社区数据库支持窗口 `entry`、`title`、`dockIcon`、`localWeb`、`width`、`height`、`widthMeters`。像素宽度为整数 640–2560,高度为整数 360–1440,物理宽度按本体 float32 规则校验 0.4–4.0 米。源码省略尺寸时,数据库会按 1600×900、3 米补全,与 pack 输出一致;自定义尺寸也会参与源码和包内清单比较,未声明的变化会被拒绝。模板包含的默认独立窗口已通过实际打包和数据库校验;登记仍需完成整包哈希、归属及其他字段检查。
The community database supports window `entry`, `title`, `dockIcon`, `localWeb`, `width`, `height`, `widthMeters`. Pixel width is an integer 640–2560, height an integer 360–1440, and physical width follows the core's float32 validation for 0.4–4.0 meters. Omitted dimensions normalize to 1600×900 and 3 meters, matching pack output. Custom dimensions participate in source/package comparison; undeclared changes are rejected. The template's default standalone window passed actual packaging and database validation. Registration still requires whole-package hash, ownership and other field checks.
## 方式一:自行托管插件源
## Option 1: host your own catalog
自托管不要求社区登记,也不要求 GitHub Release digest。可以省略包内 `downloadUrl`,由 `framely catalog` 使用 `--base-url` 与实际包文件名拼接;填写时优先采用包内地址。若包名来自默认 GitHub 规则,按前述方式发布即可。
Self-hosting requires neither community registration nor GitHub Release digests. You may omit packaged `downloadUrl`: `framely catalog` joins `--base-url` with the actual archive filename. Explicit package URLs take precedence. For default GitHub names, use the workflow above.
把要保留的各版本 `.framely` 放入 `packages/`,在 Framely 仓库执行:
Put all versions to retain in `packages/`. From the Framely repository:
```bash
mkdir -p target/plugin-catalog
cargo run --locked -- catalog --name '我的插件源' --base-url https://example.org/packages --packages ./packages --output ./target/plugin-catalog/catalog.json
cargo run --locked -- catalog --name 'My source' --base-url https://example.org/packages --packages ./packages --output ./target/plugin-catalog/catalog.json
```
将 `example.org` 换成实际 HTTPS 地址。CLI 计算完整包的 SHA256并生成 JSON,不上传包、不复制图片。没有外部 `publish.icon` 时,本地 CLI 不会把包内图标转换成商店 URL。
Replace `example.org` with your HTTPS address. The CLI computes whole-package SHA256 and generates JSON; it does not upload packages or copy images. Without external `publish.icon`, the local CLI does not convert a packaged icon into a plugin library URL.
**上传整个生成目录,不能只上传 `catalog.json`:**
**Upload the entire generated directory, not only `catalog.json`:**
```text
catalog.json
@@ -103,15 +103,15 @@ plugins/
versions.json
```
主目录每个 ID 一条推荐最新版;历史条目在相对 `plugins/<ID>/versions.json`,不包含主目录当前条目。每次生成需提供要保留的所有版本,本地 CLI 不合并之前的历史。社区数据库会延续之前发布的历史,当前每插件最多保留 19 个历史条目。不要混淆两种工具的保留规则。
The main catalog has one recommended entry per ID. Relative `plugins/<ID>/versions.json` contains historical entries, excluding the current main entry. Supply every retained version each time; the CLI does not merge prior history. The community database does preserve previous history, currently up to 19 historical entries per plugin. These retention rules differ.
将目录放在 HTTPS 静态服务,用户添加完整 `catalog.json` URL;各条目指向的包和图片也必须可访问。多个渠道可再发布[源订阅文件](../source-subscriptions.md)。
Host the catalog over HTTPS and share its full `catalog.json` URL. Package/image URLs must also be reachable. Multiple channels may use a [source subscription](../source-subscriptions.md).
## 方式二:登记社区数据库
## Option 2: register in the community database
登记入口为 [framely-plugin-database](https://github.com/SteamFramelyHomebrew/framely-plugin-database),具体规则以其 [CONTRIBUTING.md](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md) 和当前校验器为准。源码根目录须有 `manifest.json`,作者 Release 及附件须先公开,登记使用 Git submodule 固定提交;数据库不镜像包或证明源码与二进制可复现一致。
Use [framely-plugin-database](https://github.com/SteamFramelyHomebrew/framely-plugin-database) and its current [CONTRIBUTING.md](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md)/validator. Plugin roots require `manifest.json`. Publish the author's Release/assets first, then register pinned Git submodule commits. The database does not mirror packages or establish reproducible source/binary equivalence.
首次登记:先 fork 数据库,使用自己 fork 的同名 `testing` 分支:
Fork the database and use your fork's matching `testing` branch:
```bash
git clone --branch testing https://github.com/yourname/framely-plugin-database.git
@@ -123,11 +123,11 @@ git commit -m 'Add yourname.my-plugin 0.1.0'
git push origin testing
```
向上游 `testing` 提交 PR,附实际 Frame 测试记录。只改 `.gitmodules` 与 `plugins/<ID>` 的 submodule 固定提交,其他文件变更不会走登记自动合并。
Open a PR to upstream `testing` with actual Frame test records. Change only `.gitmodules` and `plugins/<ID>` submodule pins; ordinary file changes do not qualify for registration auto-merge.
数据库 ID 要求 `namespace.name`:小写字母和数字,名称部分可带点、连字符;它比本体 ID 校验严格。路径必须是 `plugins/<ID>`,仓库必须是公开 GitHub 仓库。首次登记确认仓库归属和作者维护权限;命名空间绑定 GitHub 所有者数字 ID,每个所有者最多五个历史前缀,删除插件不释放归属。已登记 ID 不能换源仓库。协作者需要可验证的 write/maintain/admin 权限,不能以 manifest 的 `author` 或 Git 提交作者替代。[完整归属规则](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md#插件归属与自动合并)
Database IDs use `namespace.name`, lowercase letters/digits and dots/hyphens in the name, stricter than core IDs. Paths must be `plugins/<ID>` and source repositories public GitHub repositories. Initial registration verifies ownership and maintenance permission. Namespaces bind to GitHub owner numeric IDs; each owner may reserve at most five historical prefixes, and removal does not release ownership. Registered IDs cannot change source repositories. Collaborators require verifiable write/maintain/admin permission; Manifest authors or Git commit authors do not establish permission. See [full ownership rules](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md#插件归属与自动合并).
更新登记:
Update registration:
```bash
git -C plugins/yourname.my-plugin fetch --tags
@@ -137,8 +137,8 @@ git commit -m 'Update yourname.my-plugin to 0.2.0'
git push origin testing
```
stable 对应数据库 `main`,testing 对应 `testing`。自动合并要求 `testing → testing` 或 `main → main`,跨渠道 PR 留给人工处理。测试后按数据库规则提升到稳定渠道;`publish` 是生成分支,不提交插件变更。
Stable corresponds to `main`, testing to `testing`. Auto-merge requires `testing → testing` or `main → main`; cross-channel PRs require manual handling. Promote after tests under database rules. `publish` is generated, not a target for plugin changes.
## 发布后验证
## Verify publication
检查用户实际能访问的包、目录、图标、历史选择、确认安装、更新及数据保留。只有本体 `verify` 通过还不够,登记还须通过数据库对源码、整包哈希和字段的检查。后续按“提升版本 → 重新生成临时清单 → 构建打包 → 实机测试 → 新 Release → 更新固定登记”发布;不要覆盖旧附件。
Check public packages/catalogs/icons/history, installation confirmation, updates and retained data. Core `verify` alone is insufficient: registration must pass database source, whole-package hash and field checks. For updates: bump version → regenerate temporary Manifest → build/package → device test → new Release → update the source pin. Never overwrite old assets.
+92 -49
View File
@@ -1,36 +1,37 @@
# SDK API 文档
# SDK API reference
[English](../en/developer-guide/sdk.md)
[简体中文](../zh-CN/developer-guide/sdk.md)
[开发流程](README.md) · [Manifest](manifest.md) · [生命周期](../plugin-lifecycle.md)
[Development](README.md) · [Manifest](manifest.md) · [Lifecycle](../plugin-lifecycle.md)
SDK 源码位于 `sdk/src/index.tsx`、`sdk/src/lifecycle.ts` 和 `sdk/python/framely.py`。页面从 `@framely/sdk` 导入,Python 协议库由构建工具复制到 `payload/framely.py`。
Sources are `sdk/src/index.tsx`, `sdk/src/lifecycle.ts` and `sdk/python/framely.py`. Import page APIs from `@framely/sdk`; build copies the Python helper into `payload/framely.py`.
## 页面注册
## Register pages
```tsx
import {registerPlugin, Section} from '@framely/sdk';
function QuickPage() {return <Section title="我的插件">快捷内容</Section>;}
function MainWindow() {return <Section title="主窗口">详细内容</Section>;}
function QuickPage() {return <Section title="My plugin">Quick content</Section>;}
function MainWindow() {return <Section title="Main window">Details</Section>;}
registerPlugin({QuickPage, windows: {main: MainWindow}});
```
`QuickPage` 必填。`WindowPage` 是独立窗口的默认组件;`windows` 可按清单窗口 key 指定不同组件。没有对应组件时回退到 `WindowPage`,再回退到 `QuickPage`;`quick` 用于快捷页路由,避免将它用作窗口 key。页面运行在宿主的 sandbox iframe,宿主先建立桥接再加载你的 bundle。注册函数会挂载 React、基础样式和滚动条。
`QuickPage` is required. `WindowPage` is the default independent-window component; `windows` maps declared keys to different components. Missing keys fall back to `WindowPage`, then `QuickPage`. Avoid window key `quick`, which is used by the quick-page route. Pages run in host sandbox iframes, with the bridge installed before your bundle. Registration mounts React, base styles and scrollbars.
## 宿主接口 `framely`
## Host API: `framely`
| API | 参数与返回 | 用途 |
| API | Parameters/result | Purpose |
| --- | --- | --- |
| `framely.call<T>(method, params = {})` | `Promise<T>` | 调用本插件后端方法;错误会 reject |
| `framely.windows.open(key)` | 窗口 key;异步结果 | 打开已在 Manifest 声明的窗口 |
| `framely.windows.close(key)` | 窗口 key;异步结果 | 关闭窗口,不停用后端 |
| `framely.notifications.send(notification)` | 通知对象;异步结果 | 发送或按 ID 更新通知 |
| `framely.notifications.remove(id)` | 通知 ID;异步结果 | 撤回通知 |
| `framely.dependencies()` | `Promise<DependencyStatus[]>` | 查询本插件声明的依赖状态 |
| `framely.language.get()` | `Promise<{preference, language}>` | 获取语言偏好和当前生效语言 |
| `framely.onEvent(callback)` | 返回取消订阅函数 | 接收宿主转发的事件 |
| `framely.call<T>(method, params = {})` | `Promise<T>` | Call your backend; failures reject |
| `framely.windows.open(key)` | Declared key; asynchronous result | Open a declared window |
| `framely.windows.close(key)` | Key; asynchronous result | Close a window without disabling the backend |
| `framely.notifications.send(notification)` | Notification; asynchronous result | Send or replace by ID |
| `framely.notifications.remove(id)` | Notification ID; asynchronous result | Close the popup and remove the inbox copy |
| `framely.notifications.dismiss(id)` | Notification ID; asynchronous result | Close the popup, retaining the inbox copy |
| `framely.dependencies()` | `Promise<DependencyStatus[]>` | Query declared dependency state |
| `framely.language.get()` | `Promise<{preference, language}>` | Language preference and effective language |
| `framely.onEvent(callback)` | Unsubscribe function | Receive forwarded events |
所有调用只通过插件桥接,不提供管理员 API 或跨插件后端调用。用 `try/catch` 或 `.catch` 处理失败,异步操作期间禁用重复提交。
These use the plugin bridge, not administrator APIs or other plugins' backends. Handle failures and prevent duplicate submissions while waiting.
```tsx
try {
@@ -39,56 +40,80 @@ try {
} catch (error) {console.error(error);}
```
## 通知
## Notifications
```tsx
await framely.notifications.send({
id: 'task', title: '完成', body: '文件已处理', durationMs: 8000,
actions: [{id: 'open', label: '打开', icon: '↗'}],
id: 'task', title: 'Done', body: 'File processed', inbox: true, durationMs: 8000,
actions: [{id: 'open', label: 'Open', icon: '↗'}],
});
```
`id`、`title`、`body` 必填。`image` 可选,接受 PNG/JPEG data URL 或 HTTPS URL,字符串最大 1 MiB。`actions` 最多 3 项,每项有 `id`、`label`、`icon`。`durationMs` 范围 1000–60000,省略时默认 8000 ms。`id` 和按钮 `id` 遵循本体 ID 规则,按钮 ID 在同一通知内不得重复;`title` 最大 160 字节、`body` 4096 字节、按钮 `label` 非空且最多 80 字节、`icon` 最多 16 字节。每插件每 10 秒最多发送 10 次,全局最多 64 条同时存在的通知;同 ID 更新不额外占队列位置。
`id`, `title`, `body` are required. `inbox` defaults to `false`: with popups enabled, only notifications explicitly sent with `inbox: true` appear in the quick panel's Notifications tab. Inbox messages survive popup expiry, closing the popup, plugin disable/restart, and Framely restart. They are removed by an action's policy, explicit removal, or plugin uninstall. Restored inbox messages do not replay as popups.
按钮动作调用后端 `notification.action`,参数 `{id, action}`;同时转发 `notification.action` 页面事件。无后端插件可只监听页面事件。同一 ID 用于更新,调用 remove 撤回。
| Field | Default | Behavior |
| --- | --- | --- |
| `inbox` | `false` | Save the message in the inbox; user popup settings may also require saving it |
| `durationMs` | `8000` | Popup countdown in milliseconds; `1000-60000`, or `0` to stay open until dismissed |
| `actions[].closeOnClick` | `true` | Close the popup after this action succeeds |
| `actions[].removeFromInboxOnClick` | `true` | Remove the inbox copy after this action succeeds |
User notification settings take priority over sender preferences. If the global popup switch or this plugin's popup switch is off, Framely suppresses the popup and saves the message in the inbox even when `inbox` is false. Reading the inbox clears the launcher unread badge but leaves messages and actions available. Plugins cannot override popup or badge settings.
The two action policies are independent. For a status button that keeps the message, set both to `false`:
```tsx
await framely.notifications.send({
id: 'capture', title: 'Recording', body: 'Recording is in progress.',
inbox: true, durationMs: 0,
actions: [{id: 'status', label: 'View status',
closeOnClick: false, removeFromInboxOnClick: false}],
});
```
Popups display the remaining auto-close countdown; inbox entries show their received time. Closing a popup keeps its saved inbox copy. `remove(id)` withdraws both copies; `dismiss(id)` closes only the popup. Reuse the same ID to replace a message and restart its countdown. Failed actions leave the message available for retry. Buttons use their text `label`; the legacy `icon` string remains optional for compatibility.
Optional `image` accepts PNG/JPEG data URLs or HTTPS, up to a 1 MiB string. At most three actions, each with required `id` and `label`. Notification/action IDs follow core ID rules; action IDs must be unique within a notification. Title is at most 160 bytes, body 4096, nonempty action label 80, and optional action icon 16. Each plugin may send at most ten notifications per ten seconds; the global queue permits 64 simultaneous popups and 256 saved inbox messages. When full, sending a new message fails; remove older messages first. Replacing an existing ID does not occupy another slot.
Buttons invoke backend `notification.action` with `{id, action}` and forward a page event of the same name after a successful backend response. UI-only plugins can listen for the event. A disabled plugin's saved messages remain readable and removable, but their action buttons are disabled until it is enabled again.
## React hooks
| Hook | 返回与行为 |
| Hook | Result/behavior |
| --- | --- |
| `useBackend<T>(method, params = {})` | `{data, error, loading, call}`;不会自动发起请求,主动调用 `call()`;该调用失败仍会抛出异常 |
| `usePluginEvent(callback)` | 自动订阅并在页面卸载时取消订阅 |
| `useDependencies()` | `{items, error}`;自动加载依赖并在 `dependencies.changed` 时刷新 |
| `useBackend<T>(method, params = {})` | `{data, error, loading, call}`; requests are explicit through `call()`, which still throws on failure |
| `usePluginEvent(callback)` | Automatically subscribes and unsubscribes on unmount |
| `useDependencies()` | `{items, error}`; loads automatically and refreshes on `dependencies.changed` |
手动订阅时通过 React effect 返回取消函数:
Return the unsubscribe function from an effect:
```tsx
React.useEffect(() => framely.onEvent(event => console.log(event)), []);
```
`DependencyStatus` 包含 `id`、`required`、`constraint`、`version`、`enabled`、`matches`、`available` 和可选 `state.phase`。`constraint` 为版本范围字符串或 `{version, source}`;未安装时 `version` 为 null。[关系参考](../plugin-relationships.md)
`DependencyStatus` includes `id`, `required`, `constraint`, `version`, `enabled`, `matches`, `available`, optional `state.phase`. Constraint is a range string or `{version, source}`; uninstalled versions are null. See [relationships](../plugin-relationships.md).
宿主语言变化转发 `{type: "language.changed", data: {preference, language}}`;依赖变化转发 `{type: "dependencies.changed"}`。`onEvent` 的类型为 unknown,访问字段前应做类型检查。Python `emit("progress", {...})` 转发为 `{type: "progress", data: {...}}`。
Language changes emit `{type: "language.changed", data: {preference, language}}`; dependency changes emit `{type: "dependencies.changed"}`. `onEvent` is typed as unknown, so narrow the type before reading fields. Python `emit("progress", {...})` becomes `{type: "progress", data: {...}}`.
## UI 控件
## UI components
| 组件 | 主要属性 |
| Component | Main props |
| --- | --- |
| `Section` | `title`、`children` |
| `Button` | 标准 React button 属性,包括 `onClick`、`disabled` |
| `Toggle` | `label`、`checked`、`onChange(boolean)`;可选 `description`、`disabled` |
| `Slider` | `label`、`value`、`onChange(number)`;默认 `min=0`、`max=100`、`step=1` |
| `TextField` | `label`、`value`、`onChange(string)`;可选 `multiline`、`password`、`placeholder`、`disabled` |
| `Select` | `label`、`options: {value,label}[]`、`value`、`onChange`、`disabled` |
| `Tabs` | `tabs: {id,label}[]`、`value`、`onChange(id)` |
| `Notice` | `children`;`error=true` 显示错误 |
| `Section` | `title`, `children` |
| `Button` | Standard React button props, including `onClick`, `disabled` |
| `Toggle` | `label`, `checked`, `onChange(boolean)`; optional description/disabled |
| `Slider` | `label`, `value`, `onChange(number)`; defaults min 0, max 100, step 1 |
| `TextField` | `label`, `value`, `onChange(string)`; multiline/password/placeholder/disabled |
| `Select` | `label`, `{value,label}[]` options, value/onChange/disabled |
| `Tabs` | `{id,label}[]` tabs, value/onChange |
| `Notice` | children; error styling with `error=true` |
`Select` 默认单选,`value` 为 string;设置 `multiple` 时 `value` 为 string[],回调返回数组,可使用 `emptyLabel` 和 `clearLabel`。下拉在页面内渲染,适配离屏 CEF。
Select is single-valued by default. With `multiple`, value and callback use string arrays; `emptyLabel` and `clearLabel` customize labels. Menus render inside the page for off-screen CEF.
标准输入控件在 Frame 中自动连接 SteamVR 键盘,标准可交互控件自动获得悬停反馈。自定义控件应使用正确 ARIA role,可增加 `data-framely-interactive`。网页不自行控制其他窗口、手柄或系统账号。
Native input controls automatically use the SteamVR keyboard on Frame, and standard interactive controls get hover feedback. Custom controls need suitable ARIA roles and may use `data-framely-interactive`. Pages do not independently control other views, controllers or system accounts.
## Python 后端 SDK
## Python backend helper
```python
from framely import serve, emit
@@ -102,12 +127,30 @@ def dispatch(method, params):
serve(dispatch)
```
`serve(dispatch, lifecycle=None)` 读取逐行请求、调用处理器,并把返回值或异常转换成 JSON 响应。`emit(event, data)` 输出事件,页面侧收到 `{type, data}`;`notification` 事件可主动发送通知。日志写 stderr,stdout 专用于协议。生命周期字典写法见[生命周期文档](../plugin-lifecycle.md)。
`serve(dispatch, lifecycle=None)` reads newline-delimited requests and translates returns/exceptions into responses. `emit(event, data)` emits events forwarded as `{type, data}`; `notification` can send notifications. Log to stderr; stdout is protocol-only. See [lifecycle callbacks](../plugin-lifecycle.md).
## TypeScript 生命周期辅助 API
## TypeScript lifecycle helpers
从 `@framely/sdk/lifecycle` 导入 `registerLifecycle`、`LifecycleContext`、`LifecyclePhase`、`LifecycleCallbacks`。`registerLifecycle(callbacks)` 返回异步 `(method, context)` dispatcher;把保留的生命周期方法交给它处理。它不实现 stdin/stdout 协议、不启动进程,也不赋予网页后台权限。
Import `registerLifecycle`, `LifecycleContext`, `LifecyclePhase`, `LifecycleCallbacks` from `@framely/sdk/lifecycle`. Registration returns an asynchronous `(method, context)` dispatcher for reserved lifecycle methods. It does not provide stdin/stdout transport, launch a backend or grant page privileges.
## 预览与权限边界
## Preview and privilege boundaries
`npm run dev` 只模拟窗口、通知及部分桥接调用;后端、真实依赖状态、VR 输入、振动和身份行为需要实机测试。插件页面不能直接调用管理面板 API,也不能调用 `framely.lifecycle.*` 保留方法。SDK 本身不声明权限,运行用户由 Manifest 决定。
Development preview simulates windows, notifications and some bridge operations. Test backend calls, real dependencies, VR inputs, haptics and runtime identity on the device. Pages cannot directly call management APIs or reserved `framely.lifecycle.*` methods. Runtime identity is configured in Manifest, not granted by the SDK.
## Headset visibility and capture pause
`framely.ui.getVisibility()` returns `{ known, captureObscured, pageVisible, sequence, sessionId }`. `framely.ui.onVisibilityChanged(callback, onError?)` subscribes and immediately queries the current snapshot; it returns an unsubscribe function. `useVisibility()` provides the same fields and `error`. Capture visibility combines the actual visibility of the quick panel, manager and every plugin window, excluding notifications and dock icons. Remote browser pages have `pageVisible: false` and cannot report headset visibility.
Declare `backend.uiVisibilityEvents: true` to receive the reserved JSON-line RPC `framely.ui.visibility` at startup and on changes, independently of mounted pages. Reply with the request id. The backend snapshot includes `known`, `captureObscured`, `sequence` and `views`; `pageVisible` is frontend-only. A native heartbeat missing for more than two seconds makes `known` false. Capture backends should pause on `!known || captureObscured`. Existing backends do not receive this RPC without opting in. Node/TS can use `registerVisibility` from `@framely/sdk/visibility`; Python supports `serve(dispatch, visibility=callback)`.
`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.
-35
View File
@@ -1,35 +0,0 @@
# Framely documentation
[简体中文](../README.md)
Framely manages plugins on Steam Frame through device services, a SteamVR interface, a web panel, and a desktop installer.
## User guides
1. [Install, update, repair and uninstall](user-guide/installation.md): desktop installer, SSH, Preview builds, local packages and rollback.
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): store, sources, subscriptions, local packages and updates.
4. [Network panel](user-guide/network-panel.md): address, first password setup, login and phone/desktop access.
## Plugin development and publishing
- [Complete workflow](developer-guide/README.md): scaffold → preview → backend → package → device testing → publish.
- [SDK API](developer-guide/sdk.md) · [Manifest configuration](developer-guide/manifest.md) · [Lifecycle](plugin-lifecycle.md)
- [Publish plugins and catalogs](developer-guide/publishing.md): default GitHub URLs, custom URLs/hashes, catalog history and database registration.
- [Plugin template](../../templates/plugin/README.en.md): React and Python, generated projects or in-repository editing.
- [Showcase plugin](../../examples/showcase/README.en.md): additional UI and device examples.
## Technical references
| Reference | Contents |
| --- | --- |
| [Plugin development reference](plugin-development.md) | Manifest, windows, notifications, JSON RPC and packaging |
| [Lifecycle](plugin-lifecycle.md) | Install, update, start, stop, uninstall and recovery hooks |
| [Dependencies and conflicts](plugin-relationships.md) | Version ranges, source selection and exclusive resources |
| [Source subscriptions](source-subscriptions.md) | JSON format, refresh, URL changes and deduplication |
| [Localization](localization.md) | Language packs and community translations |
## Maintainer documentation
- [Framely releases and updates](releases.md)
- [Desktop installer](../../installer/README.en.md)
-84
View File
@@ -1,84 +0,0 @@
# Plugin development to publication
[简体中文](../../developer-guide/README.md)
[Documentation](../README.md) · [Publishing](publishing.md)
## 1. Prepare the development environment
Install Git, Node.js 22 and npm. The publishing Manifest script also needs Python 3. The core CLI uses Linux-specific interfaces, so source packaging requires Rust on Linux/WSL, not native Windows/macOS compilation. Alternatively copy Manifest/payload to Frame and use its installed CLI. Device users do not need Node.js/Rust; Python backends use device Python 3. Preview and packaging work on the development computer; VR interaction requires Frame.
```bash
git clone https://github.com/SteamFramelyHomebrew/framely.git
cd framely
node tools/plugin-dev.mjs init ../my-plugin yourname.my-plugin
cd ../my-plugin
npm install
npm run dev
```
Replace the example ID with your own stable namespace. The scaffold refuses to overwrite directories and copies the SDK and tools, so the resulting project does not depend on the original repository location. Create your plugin Git repository and commit `package-lock.json` and the vendored SDK. Do not commit `node_modules/`, `payload/`, archives or passwords.
## 2. Understand the template
| File | Purpose |
| --- | --- |
| `manifest.json` | Identity, version, runtime user, pages, lifecycle and dependencies |
| `page.tsx` | React quick page and independent window |
| `backend.py` | Python backend and persistent settings |
| `vendor/framely-sdk/` | UI, bridge API and Python protocol helper |
| `dev.mjs` | Build and local preview |
| `LICENSE` | Full AGPLv3 text |
Read/save uses `settings.get` / `settings.set` with `FRAMELY_DATA_DIR/settings.json`. The template opens the `main` window, sends notifications and demonstrates install/update/start/stop/uninstall callbacks. It defaults to `steamos` and on-demand startup.
## 3. Edit Manifest and UI
Set the ID, author, name, description, version, tags and changelog. Use full SemVer such as `0.1.0` or `0.2.0-preview.1`; never overwrite a published version.
`ui.quickPage` and `ui.windows.main.entry` refer to built `page.js`. Register components with `registerPlugin({QuickPage, WindowPage})`, matching declared keys. Leave `files` empty; packaging computes hashes.
Preview at `http://127.0.0.1:5173`, with automatic reload. Preview simulates windows and notifications, without Python backends or device privileges. Read/save therefore reports backend unavailability; this is expected and is not device validation.
See [SDK API](sdk.md), [Manifest configuration](manifest.md) and the [development reference](../plugin-development.md).
## 4. Implement backend and lifecycle
Backend stdin/stdout use newline-delimited JSON RPC. Reserve stdout for protocol messages and log to stderr. Python `framely.serve` handles requests, exceptions and hooks. Validate parameter types and lengths and return JSON-serializable values.
Write to `FRAMELY_DATA_DIR`, not plugin payload or Framely binaries. Design migrations for updates, older versions and runtime-user changes. `steamos` and `root` have separate data directories. Prefer `steamos`; explain any required root privileges.
Make install/update hooks repeatable and release owned external resources on stop/uninstall. Closing UI does not stop the backend; React effect cleanup cannot replace backend hooks. System dependencies are not installed automatically. See [lifecycle](../plugin-lifecycle.md).
## 5. Build, package and verify
Inside your plugin:
```bash
npm run build
FRAMELY_REPO=/absolute/path/to/framely
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest manifest.json --payload payload --output yourname.my-plugin-0.1.0.framely
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify yourname.my-plugin-0.1.0.framely
```
Set the repository's actual absolute path. Alternatively use installed `/var/lib/framely/current/bin/framely pack` / `verify` on Frame; these offline commands do not need sudo.
Include only distributable pages, backend, Python helper and resources in `payload/`. Build copies `backend.py` and `framely.py`; add icons and other assets yourself. Packaging checks entries, paths, Manifest and hashes, rejecting symlinks and undeclared extra archive files.
## 6. Test on Frame
Import the package through the web panel and review confirmation, or transfer it and run on Frame:
```bash
sudo /var/lib/framely/current/bin/framely install ./yourname.my-plugin-0.1.0.framely --approve
```
Accept the terms before management. Test read/save, windows and notifications, disabling/re-enabling, persistent data after reboot, updates after a version bump, and uninstall cleanup. Record actual device checks for VR input, controllers and hardware.
Inspect Framely status and systemd logs. Do not mix debug messages into backend stdout. See [installation](../user-guide/plugins.md).
## 7. Publish
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.
-96
View File
@@ -1,96 +0,0 @@
# Manifest configuration
[简体中文](../../developer-guide/manifest.md)
[Development](README.md) · [SDK](sdk.md) · [Lifecycle](../plugin-lifecycle.md)
The repository-root `manifest.json` describes a plugin and is included in its archive. Fields use camelCase. Package Manifests reject unknown fields; do not add retired `permissions`. Start from the [template](../../../templates/plugin/manifest.json).
## Minimal example
```json
{
"schemaVersion": 1,
"apiVersion": 1,
"id": "yourname.my-plugin",
"name": "My plugin",
"version": "0.1.0",
"author": "Your name",
"backend": {"entry": "backend.py", "runAs": "steamos"},
"ui": {"quickPage": "page.js"},
"files": {}
}
```
Leave source `files` empty. `framely pack` scans payload and supplies hashes. At least one payload file is required; all declared entries must be included. See the [complete template](../../../templates/plugin/manifest.json).
## Top-level fields
| Field | Requirements/default |
| --- | --- |
| `schemaVersion` / `apiVersion` | Required, currently both 1 |
| `id` | Required, max 80 characters; lowercase letters/digits/dots/hyphens/underscores; no leading dot or `..`; the scaffold requires a letter/digit first; prefer `namespace.name` |
| `name` / `author` | Required, nonempty, max 120 bytes each |
| `version` | Required, max 64 bytes, ASCII letters/digits and `.-+` only; full SemVer recommended and required when declaring relationships |
| `description` | Short summary, default empty; database registration limits it to 4096 bytes |
| `details` / `changelog` | Full description/version changes, default empty; max 32768 / 16384 bytes respectively |
| `tags` | String array, default empty; max 12 nonempty entries of at most 80 bytes each; search/filter tags |
| `icon` | Optional payload PNG path, max 1 MiB and 1024×1024 |
| `screenshots` | Default empty; up to eight payload PNG/JPEG paths |
| `authorUrl` / `documentationUrl` / `homepage` | Optional HTTP/HTTPS links, no embedded credentials |
| `downloadUrl` | Optional fixed-version HTTPS package URL; GitHub database source may omit it for repository/version/ID derivation, but community packages need the resolved URL; see publishing |
| `publish` | Optional external store image configuration |
| `backend` / `lifecycle` / `ui` | Optional backend/hooks/pages |
| `dependencies` / `optionalDependencies` / `conflicts` | Default empty maps |
| `exclusiveResources` | Default empty array; matching names prevent simultaneous enabling |
| `files` | Required path-to-SHA256 map, generated during packaging, max 2048 files |
Legacy `category` is accepted only for compatibility and no longer exported; use tags. `downloadSha256` is a database source-registration field for whole-package SHA256, not a package field. Default GitHub Releases use asset digests; custom HTTPS URLs require a declared source hash, removed before packaging. The database resolves omitted source `downloadUrl`, but current `framely pack` does not. See [publishing](publishing.md) for a temporary-Manifest command. Database IDs and description lengths have stricter constraints than core validation; passing the core does not guarantee registration.
## Backend
| Field | Meaning |
| --- | --- |
| `entry` | Required executable payload entry; scripts need a valid shebang |
| `args` | Default empty; at most 64 independent args, each ≤4096 bytes without NUL; not a shell command |
| `runAs` | `steamos` (default) or `root` |
| `autostart` | false by default for on-demand startup; true for resident startup |
| `restart` | `on-failure` (default) or `never` |
| `restartLimit` | Consecutive failure threshold 1–10, default 3 |
| `memoryLimitMiB` | Memory limit, default 512 MiB; integer 1–4294967295, no 0/null for unlimited memory |
Omit backend for UI-only plugins. System/third-party Python dependencies are not installed automatically. Runtime-user changes require confirmation and use separate data directories without automatic migration.
`backend.memoryLimitMiB` maps to systemd `MemoryMax` for the combined memory of the backend and all its child processes. It is a ceiling, not a memory reservation. Independent lifecycle hooks inherit this limit; hooks without a backend use 512 MiB. The install plan, CLI and installed-plugin management view display the limit. Omitted or explicit 512 values are omitted when packing to preserve compatibility with older hosts; other values require a host and plugin database supporting this field.
For example, declare 2 GiB for a longer replay buffer:
```json
{"backend": {"entry": "backend", "memoryLimitMiB": 2048}}
```
## UI
Optional `quickPage` points to a payload bundle. `windows` defaults to an empty map with at most eight windows; keys must be valid IDs:
| Field | Meaning |
| --- | --- |
| `entry` / `title` | Required payload entry and nonempty title ≤120 bytes |
| `dockIcon` | false by default; true creates a Dock window |
| `width` / `height` | Default 1600×900; width 640–2560, height 360–1440 |
| `widthMeters` | Default 3.0; finite 0.4–4.0 meters. Source null is accepted but omitted during packaging, then reads back as default 3.0 |
| `localWeb` | false by default; specialized localhost windows obtain a URL from backend `window.get` |
`localWeb` opens on Frame only: backend `window.get` receives `{window: key}` and returns `{url: "http://localhost:<port>/framely-window/<key>"}` without query/fragment or the management port. It uses different sandbox flags for local web apps. Ordinary React plugins do not need `localWeb`. Match window keys to `framely.windows.open(key)` and component registration. Size changes apply when reopening.
## Lifecycle
`onInstall`, `onUpdate`, `onUninstall`, `onCrashCleanup` are optional independent `{entry, args?}` commands. `onStart` / `onStop` are booleans defaulting to false and require a backend. `timeoutSeconds` is 1–15, default 10. Optional `runAs` must match the backend when present and can specify identity for UI-only standalone hooks. Standalone command `args` have the same limits as backend args. See [lifecycle](../plugin-lifecycle.md) for timing, errors and context.
## Publication and relationships
`publish.icon` is an external HTTPS icon, `publish.screenshots` contains up to eight external HTTPS images. Package `icon` and `screenshots` are paths; do not confuse them. Download URLs prefer `downloadUrl`; published versions must remain immutable. See [publishing](publishing.md).
Dependencies use ranges or `{version, source}`, with source pointing to an HTTPS catalog. Conflicts use ranges. Missing optional dependencies do not prevent installation; exclusive resources rely on author declarations. See [relationships](../plugin-relationships.md).
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.
-144
View File
@@ -1,144 +0,0 @@
# Publish plugins and catalogs
[简体中文](../../developer-guide/publishing.md)
[Documentation](../README.md) · [Development workflow](README.md)
## Default GitHub Release URL
A public GitHub plugin repository's **source `manifest.json` may omit `downloadUrl`**. The community database derives it from the registered repository, version and plugin ID:
```text
https://github.com/<owner>/<repo>/releases/download/v<version>/<id>-<version>.framely
```
Repository `yourname/my-plugin`, ID `yourname.my-plugin`, version `0.1.0` means tag `v0.1.0` and asset `yourname.my-plugin-0.1.0.framely`. Repository names need not match IDs. Omit the field entirely; empty strings or null do not select automatic generation. Avoid `latest` and never replace same-version assets.
Source registration and packaging differ: the database normalizes the source URL and requires **the same final `downloadUrl` in the packaged Manifest**. Current `framely pack` computes payload hashes but does not inspect Git remotes or derive Release URLs. If your source omits the field, prepare a temporary Manifest before packaging; you do not need to write the URL back into source.
## Prepare the release package
Follow the [development workflow](README.md), run `npm run build`, and configure the plugin repository's GitHub `origin`. Run this inside your plugin to create `.framely-build/manifest.json`. It supports common HTTPS/SSH remotes, preserves explicit `downloadUrl`, and leaves source unchanged:
```bash
python3 - <<'PY'
import json, re, subprocess
from pathlib import Path
manifest = json.loads(Path('manifest.json').read_text(encoding='utf-8'))
manifest.pop('downloadSha256', None) # Source registration only; never package it.
if 'downloadUrl' not in manifest:
remote = subprocess.check_output(
['git', 'remote', 'get-url', 'origin'], text=True
).strip()
match = re.fullmatch(
r'(?:https://github\.com/|git@github\.com:|ssh://git@github\.com/)'
r'([A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?)(?:\.git)?/?', remote
)
if not match:
raise SystemExit('Use a GitHub origin or set downloadUrl explicitly.')
manifest['downloadUrl'] = (
f"https://github.com/{match[1]}/releases/download/v{manifest['version']}/"
f"{manifest['id']}-{manifest['version']}.framely"
)
output = Path('.framely-build/manifest.json')
output.parent.mkdir(parents=True, exist_ok=True)
output.write_text(json.dumps(manifest, ensure_ascii=False, indent=2) + '\n', encoding='utf-8')
print(manifest['downloadUrl'])
PY
```
Ignore temporary `.framely-build/` in your plugin Git repository; the template already does so. Asset filenames must match the default rule. Continue inside your plugin:
```bash
FRAMELY_REPO=/absolute/path/to/framely
PLUGIN_ID=$(python3 -c 'import json; print(json.load(open("manifest.json"))["id"])')
PLUGIN_VERSION=$(python3 -c 'import json; print(json.load(open("manifest.json"))["version"])')
mkdir -p dist
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest .framely-build/manifest.json --payload payload --output "dist/$PLUGIN_ID-$PLUGIN_VERSION.framely"
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify "dist/$PLUGIN_ID-$PLUGIN_VERSION.framely"
```
Commit source, SDK, lockfile and license; tag that commit `v<version>`, create its GitHub Release, upload the `.framely` from `dist/`, and publish. Source and packaged declarations must match after normalizing the default URL and removing registration-only fields. Pin database submodules to the actual released source commit.
Release notes describe usage, runtime user and reasons for root, dependencies, changes, actual Frame tests and limitations. Provide matching source/build scripts and comply with template, SDK and dependency licenses.
### Whole-package hashes and custom URLs
| Method | Source registration | Expected whole-package hash |
| --- | --- | --- |
| Default GitHub Release | Omit `downloadUrl`; use the tag/asset naming above | Read SHA256 from the Release asset `digest`; no handwritten hash needed |
| Explicit fixed GitHub Release | Set `downloadUrl` to choose a different tag/asset name | Read Release digest if `downloadSha256` is absent; otherwise validate against the declared hash |
| Other HTTPS download | Set `downloadUrl` and `downloadSha256` | Use the declared 64-character whole-package SHA256 |
Automatic URLs always require a Release digest, even when a hash is supplied, and both must match. Missing digests, unpublished/missing assets, download failures or hash mismatches block registration; there is no fallback to trusting the downloaded bytes.
`downloadSha256` belongs only to database source registration, covers the complete `.framely`, and differs from payload `files` hashes. It is not a Framely package field. Build first, run `sha256sum dist/<id>-<version>.framely`, then add it to source registration. Remove it before packaging, as the temporary-Manifest command does. Do not embed a package's own hash inside it. Passing source containing this field directly to `framely pack` fails unknown-field validation.
### Icons and window compatibility
For the community database, set top-level `icon: "icon.png"` and include the same PNG path in source and payload. The database derives a GitHub Raw URL from the pinned repository/commit/path and verifies it against the packaged icon; `publish.icon` is unnecessary. Self-hosted catalogs use fixed HTTPS `publish.icon` / `publish.screenshots`. See [store metadata](../plugin-development.md).
The community database supports window `entry`, `title`, `dockIcon`, `localWeb`, `width`, `height`, `widthMeters`. Pixel width is an integer 640–2560, height an integer 360–1440, and physical width follows the core's float32 validation for 0.4–4.0 meters. Omitted dimensions normalize to 1600×900 and 3 meters, matching pack output. Custom dimensions participate in source/package comparison; undeclared changes are rejected. The template's default standalone window passed actual packaging and database validation. Registration still requires whole-package hash, ownership and other field checks.
## Option 1: host your own catalog
Self-hosting requires neither community registration nor GitHub Release digests. You may omit packaged `downloadUrl`: `framely catalog` joins `--base-url` with the actual archive filename. Explicit package URLs take precedence. For default GitHub names, use the workflow above.
Put all versions to retain in `packages/`. From the Framely repository:
```bash
mkdir -p target/plugin-catalog
cargo run --locked -- catalog --name 'My source' --base-url https://example.org/packages --packages ./packages --output ./target/plugin-catalog/catalog.json
```
Replace `example.org` with your HTTPS address. The CLI computes whole-package SHA256 and generates JSON; it does not upload packages or copy images. Without external `publish.icon`, the local CLI does not convert a packaged icon into a store URL.
**Upload the entire generated directory, not only `catalog.json`:**
```text
catalog.json
plugins/
yourname.my-plugin/
versions.json
```
The main catalog has one recommended entry per ID. Relative `plugins/<ID>/versions.json` contains historical entries, excluding the current main entry. Supply every retained version each time; the CLI does not merge prior history. The community database does preserve previous history, currently up to 19 historical entries per plugin. These retention rules differ.
Host the catalog over HTTPS and share its full `catalog.json` URL. Package/image URLs must also be reachable. Multiple channels may use a [source subscription](../source-subscriptions.md).
## Option 2: register in the community database
Use [framely-plugin-database](https://github.com/SteamFramelyHomebrew/framely-plugin-database) and its current [CONTRIBUTING.md](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md)/validator. Plugin roots require `manifest.json`. Publish the author's Release/assets first, then register pinned Git submodule commits. The database does not mirror packages or establish reproducible source/binary equivalence.
Fork the database and use your fork's matching `testing` branch:
```bash
git clone --branch testing https://github.com/yourname/framely-plugin-database.git
cd framely-plugin-database
git submodule add https://github.com/yourname/my-plugin.git plugins/yourname.my-plugin
git -C plugins/yourname.my-plugin checkout v0.1.0
git add .gitmodules plugins/yourname.my-plugin
git commit -m 'Add yourname.my-plugin 0.1.0'
git push origin testing
```
Open a PR to upstream `testing` with actual Frame test records. Change only `.gitmodules` and `plugins/<ID>` submodule pins; ordinary file changes do not qualify for registration auto-merge.
Database IDs use `namespace.name`, lowercase letters/digits and dots/hyphens in the name, stricter than core IDs. Paths must be `plugins/<ID>` and source repositories public GitHub repositories. Initial registration verifies ownership and maintenance permission. Namespaces bind to GitHub owner numeric IDs; each owner may reserve at most five historical prefixes, and removal does not release ownership. Registered IDs cannot change source repositories. Collaborators require verifiable write/maintain/admin permission; Manifest authors or Git commit authors do not establish permission. See [full ownership rules](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md#插件归属与自动合并).
Update registration:
```bash
git -C plugins/yourname.my-plugin fetch --tags
git -C plugins/yourname.my-plugin checkout v0.2.0
git add plugins/yourname.my-plugin
git commit -m 'Update yourname.my-plugin to 0.2.0'
git push origin testing
```
Stable corresponds to `main`, testing to `testing`. Auto-merge requires `testing → testing` or `main → main`; cross-channel PRs require manual handling. Promote after tests under database rules. `publish` is generated, not a target for plugin changes.
## Verify publication
Check public packages/catalogs/icons/history, installation confirmation, updates and retained data. Core `verify` alone is insufficient: registration must pass database source, whole-package hash and field checks. For updates: bump version → regenerate temporary Manifest → build/package → device test → new Release → update the source pin. Never overwrite old assets.
-113
View File
@@ -1,113 +0,0 @@
# SDK API reference
[简体中文](../../developer-guide/sdk.md)
[Development](README.md) · [Manifest](manifest.md) · [Lifecycle](../plugin-lifecycle.md)
Sources are `sdk/src/index.tsx`, `sdk/src/lifecycle.ts` and `sdk/python/framely.py`. Import page APIs from `@framely/sdk`; build copies the Python helper into `payload/framely.py`.
## Register pages
```tsx
import {registerPlugin, Section} from '@framely/sdk';
function QuickPage() {return <Section title="My plugin">Quick content</Section>;}
function MainWindow() {return <Section title="Main window">Details</Section>;}
registerPlugin({QuickPage, windows: {main: MainWindow}});
```
`QuickPage` is required. `WindowPage` is the default independent-window component; `windows` maps declared keys to different components. Missing keys fall back to `WindowPage`, then `QuickPage`. Avoid window key `quick`, which is used by the quick-page route. Pages run in host sandbox iframes, with the bridge installed before your bundle. Registration mounts React, base styles and scrollbars.
## Host API: `framely`
| API | Parameters/result | Purpose |
| --- | --- | --- |
| `framely.call<T>(method, params = {})` | `Promise<T>` | Call your backend; failures reject |
| `framely.windows.open(key)` | Declared key; asynchronous result | Open a declared window |
| `framely.windows.close(key)` | Key; asynchronous result | Close a window without disabling the backend |
| `framely.notifications.send(notification)` | Notification; asynchronous result | Send or replace by ID |
| `framely.notifications.remove(id)` | Notification ID; asynchronous result | Withdraw notification |
| `framely.dependencies()` | `Promise<DependencyStatus[]>` | Query declared dependency state |
| `framely.language.get()` | `Promise<{preference, language}>` | Language preference and effective language |
| `framely.onEvent(callback)` | Unsubscribe function | Receive forwarded events |
These use the plugin bridge, not administrator APIs or other plugins' backends. Handle failures and prevent duplicate submissions while waiting.
```tsx
try {
const result = await framely.call<{text: string}>('settings.get');
console.log(result.text);
} catch (error) {console.error(error);}
```
## Notifications
```tsx
await framely.notifications.send({
id: 'task', title: 'Done', body: 'File processed', durationMs: 8000,
actions: [{id: 'open', label: 'Open', icon: '↗'}],
});
```
`id`, `title`, `body` are required. Optional `image` accepts PNG/JPEG data URLs or HTTPS, up to a 1 MiB string. At most three actions, each with `id`, `label`, `icon`. `durationMs` is 1000–60000; omission defaults to 8000 ms. Notification/action IDs follow core ID rules; action IDs must be unique within a notification. Title is at most 160 bytes, body 4096, nonempty action label 80, and action icon 16. Each plugin may send at most ten notifications per ten seconds; the global queue permits 64 concurrent notifications. Updating an existing ID does not occupy another slot.
Buttons invoke backend `notification.action` with `{id, action}` and forward a page event of the same name. UI-only plugins can listen for the event. Reuse an ID to update; remove it to withdraw.
## React hooks
| Hook | Result/behavior |
| --- | --- |
| `useBackend<T>(method, params = {})` | `{data, error, loading, call}`; requests are explicit through `call()`, which still throws on failure |
| `usePluginEvent(callback)` | Automatically subscribes and unsubscribes on unmount |
| `useDependencies()` | `{items, error}`; loads automatically and refreshes on `dependencies.changed` |
Return the unsubscribe function from an effect:
```tsx
React.useEffect(() => framely.onEvent(event => console.log(event)), []);
```
`DependencyStatus` includes `id`, `required`, `constraint`, `version`, `enabled`, `matches`, `available`, optional `state.phase`. Constraint is a range string or `{version, source}`; uninstalled versions are null. See [relationships](../plugin-relationships.md).
Language changes emit `{type: "language.changed", data: {preference, language}}`; dependency changes emit `{type: "dependencies.changed"}`. `onEvent` is typed as unknown, so narrow the type before reading fields. Python `emit("progress", {...})` becomes `{type: "progress", data: {...}}`.
## UI components
| Component | Main props |
| --- | --- |
| `Section` | `title`, `children` |
| `Button` | Standard React button props, including `onClick`, `disabled` |
| `Toggle` | `label`, `checked`, `onChange(boolean)`; optional description/disabled |
| `Slider` | `label`, `value`, `onChange(number)`; defaults min 0, max 100, step 1 |
| `TextField` | `label`, `value`, `onChange(string)`; multiline/password/placeholder/disabled |
| `Select` | `label`, `{value,label}[]` options, value/onChange/disabled |
| `Tabs` | `{id,label}[]` tabs, value/onChange |
| `Notice` | children; error styling with `error=true` |
Select is single-valued by default. With `multiple`, value and callback use string arrays; `emptyLabel` and `clearLabel` customize labels. Menus render inside the page for off-screen CEF.
Native input controls automatically use the SteamVR keyboard on Frame, and standard interactive controls get hover feedback. Custom controls need suitable ARIA roles and may use `data-framely-interactive`. Pages do not independently control other views, controllers or system accounts.
## Python backend helper
```python
from framely import serve, emit
def dispatch(method, params):
if method == 'ping':
emit('progress', {'percent': 100})
return {'ok': True}
raise ValueError('Unknown method')
serve(dispatch)
```
`serve(dispatch, lifecycle=None)` reads newline-delimited requests and translates returns/exceptions into responses. `emit(event, data)` emits events forwarded as `{type, data}`; `notification` can send notifications. Log to stderr; stdout is protocol-only. See [lifecycle callbacks](../plugin-lifecycle.md).
## TypeScript lifecycle helpers
Import `registerLifecycle`, `LifecycleContext`, `LifecyclePhase`, `LifecycleCallbacks` from `@framely/sdk/lifecycle`. Registration returns an asynchronous `(method, context)` dispatcher for reserved lifecycle methods. It does not provide stdin/stdout transport, launch a backend or grant page privileges.
## Preview and privilege boundaries
Development preview simulates windows, notifications and some bridge operations. Test backend calls, real dependencies, VR inputs, haptics and runtime identity on the device. Pages cannot directly call management APIs or reserved `framely.lifecycle.*` methods. Runtime identity is configured in Manifest, not granted by the SDK.
-36
View File
@@ -1,36 +0,0 @@
# Languages and community translation
[简体中文](../localization.md)
Framely includes Simplified Chinese and English. Choose a language at the top of Settings; automatic follows the system and manual choices persist. Unsupported languages and missing translations fall back to built-in English.
## Create a language file
Download the English template from Settings or copy `ui/locales/en-US.json`. Use UTF-8 JSON:
```json
{
"schemaVersion": 1,
"locale": "fr-FR",
"name": "Français",
"messages": {"语言": "Langue", "保存": "Enregistrer", "启用 {0}": "Activer {0}"}
}
```
- Use a locale code such as `en-US`, `zh-CN`, `fr-FR`; `auto` is not a file locale.
- Name the language in that language.
- Message keys are stable: translate values only, never keys.
- Preserve all `{0}`, `{1}` placeholders; their positions may change.
- Partial translations fall back to English; empty strings are valid translations.
- Translate whole sentences for natural usage, taking fragment whitespace into account.
- Files contain text only, not executable code or interpreted HTML. Limits: 1 MiB/3000 entries per file and 50 imported files.
## Install
In Settings → Language, install the JSON, then select it. Reimporting the same locale replaces that language file.
Files live in `/var/lib/framely/locales/<locale>.json`. Administrators may place matching filenames there directly and refresh the panel. Invalid files are skipped and named in settings. Plugin names, descriptions, tags and pages remain the plugin author's responsibility; host language files do not translate them.
## Validate the project
Run `node tools/test-localization.mjs` for English coverage, placeholders, system matching, manual preferences and fallback behavior.
-106
View File
@@ -1,106 +0,0 @@
# Plugin development reference
[简体中文](../plugin-development.md)
Start with the [workflow](developer-guide/README.md), [SDK](developer-guide/sdk.md), [Manifest](developer-guide/manifest.md) and [publishing](developer-guide/publishing.md).
The Dock quick menu has Favorites/Installed/Settings tabs; management opens a separate Dock window. Installation and sources are handled there. See `examples/showcase` and `sdk/src/index.tsx`. Release `tools/source` includes UI/SDK/examples/template/tools. Bundle pages into browser JS and call `registerPlugin({QuickPage, WindowPage})`. The host installs the bridge first. Ordinary bundled page iframes use `sandbox="allow-scripts"` with opaque origins and cannot call administrator HTTP APIs.
## Manifest and identities
```json
{
"schemaVersion": 1, "apiVersion": 1,
"id": "example.plugin", "name": "Example", "author": "Developer", "version": "1.0.0",
"description": "Example plugin",
"backend": {"entry": "backend.py", "runAs": "steamos", "autostart": false},
"ui": {"quickPage": "page.js", "windows": {"main": {"entry": "page.js", "title": "Example", "dockIcon": true}}},
"files": {}
}
```
Backend is optional. Runtime users are `steamos` (default) or `root`; autostart defaults false. Retired `permissions` is unsupported; windows, notifications and networking need no declarations. Backend networking uses the device; ordinary pages permit HTTP/HTTPS and WebSockets.
IDs permit lowercase letters, numbers, dots, hyphens, underscores. Payload paths permit ASCII letters/numbers and `/._-+`, never absolute paths, empty/dot/dot-dot segments. Packaging supplies files hashes. Entries must be hashed; executable scripts need shebangs, e.g. `/usr/bin/python3`. Framely does not install system/Python dependencies.
Published versions are immutable. User changes select `/var/lib/framely/data/<id>/<identity>`; old data remains without automatic migration, and reinstalling the old identity can access it again.
## React bridge
```tsx
import {framely, registerPlugin, Button, Section} from '@framely/sdk';
function QuickPage() {
return <Section title="Example">
<Button onClick={() => framely.windows.open('main')}>Open</Button>
<Button onClick={() => framely.call('save', {text: 'hello'})}>Save</Button>
<Button onClick={() => framely.notifications.send({id: 'download', title: 'Done', body: 'Downloaded', durationMs: 8000, actions: [{id:'open',label:'Open',icon:'↗'}]})}>Notify</Button>
</Section>;
}
registerPlugin({QuickPage});
```
Keys must match Manifest. Closing windows does not stop backend. IDs update/withdraw notifications. Images accept PNG/JPEG data URL ≤1 MiB or HTTPS. At most three actions, 1–60 seconds and ten sends per ten seconds/plugin. `onEvent` returns unsubscribe and receives `{type,data}`. Each window has its own event cursor. Input focuses the native keyboard rather than web prompts.
## Backend protocol
Newline-delimited JSON on stdin/stdout; logs on stderr, rotating around 2 MiB. Messages ≤64 KiB; 5-second input or 15-second response timeouts stop the backend and allow later retry.
```json
{"id":1,"method":"save","params":{"text":"hello"}}
{"id":1,"result":{"saved":"hello"}}
{"id":2,"error":"Unknown method"}
{"event":"progress","data":{"percent":50}}
```
Environment includes plugin ID, data directory and the user's HOME. Notification actions invoke `notification.action` with `{id,action}` and also reach pages; UI-only plugins can listen. Backend `notification` events send notifications under the same limits.
## Packaging and catalogs
```bash
framely pack --manifest manifest.json --payload payload --output example.plugin-1.0.0.framely
framely verify example.plugin-1.0.0.framely
framely catalog --name 'My plugins' --base-url https://example.org/plugins --packages ./packages --output ./packages/catalog.json
```
Archives contain Manifest and hashed payload only, without keys/signatures. Host the main catalog and relative history JSON. Authors can host packages on GitHub Releases. Current first initialization includes community stable/testing sources. Origins remain explicit; same-ID plugins in other sources do not silently replace existing origins. HTTP needs explicit development permission; up to five validated redirects, without HTTPS downgrade.
## Hover feedback
Interactive controls automatically receive one hover pulse per entry, excluding disabled/inert controls and movement between their children. Supported elements include buttons, links, inputs, interactive ARIA roles/focusable controls or pointer cursors. Custom controls may mark `data-framely-interactive`. Native feedback uses the current hit controller, 12 ms/120 Hz/amplitude 0.15 with at least 80 ms spacing. Pages cannot target other windows/controllers.
## Metadata and publication
Manifest supports payload PNG icon ≤1 MiB/1024×1024, details/tags/changelog and up to eight PNG/JPEG screenshots. Icons appear in lists/Dock; missing icons use the default. Optional `authorUrl`, `documentationUrl`, `homepage` are credential-free HTTP/HTTPS links, preserved in state/catalog. Author URLs link author labels; device default browsers open external pages.
```json
{
"downloadUrl": "https://github.com/author/plugin/releases/download/v1.0.0/plugin.framely",
"publish": {"icon": "https://github.com/author/plugin/releases/download/v1.0.0/icon.png", "screenshots": ["https://github.com/author/plugin/releases/download/v1.0.0/screen.png"]}
}
```
The fragment above shows explicit URLs; GitHub registration source may omit `downloadUrl`, deriving repository, `v<version>` and `<id>-<version>.framely`. The packaged Manifest still requires the final URL; current pack does not derive it. See [publishing](developer-guide/publishing.md) for temporary-Manifest commands. Community icons normally use top-level `icon`, with derived and verified pinned Raw URLs, without `publish.icon`. The local catalog CLI uses external `publish` images and does not export packaged image paths; absent external icons use the store default. Community registration pins submodule commits, obtains expected SHA256 from Release digests or source `downloadSha256`, then validates downloaded package hashes, declarations and payloads. Generated channels provide catalog/history JSON without mirroring packages/images. It does not execute author code or establish reproducible source/binary equivalence.
Catalog CLI only emits JSON, preferring `downloadUrl` over base URL/filename and using external publish images. It does not copy resources. Stores filter keywords/tags/origins/states, retain session caches on failures and install reviewed bytes without downloading again after confirmation.
## Scaffold and preview
```bash
node tools/plugin-dev.mjs init ./my-plugin example.my-plugin
cd my-plugin
npm install
npm run dev
npm run build
```
Release tool location: `tools/source/tools/plugin-dev.mjs`. Preview binds `127.0.0.1:5173` and reloads changes, simulating windows/notifications only. Backend calls, identities, keyboards and haptics require Frame. SDK includes Section/Button/Toggle/Slider/TextField/Select/Tabs/Notice/useBackend/usePluginEvent; window maps can register different components. See [SDK](developer-guide/sdk.md).
## Windows, tags and history
Default windows are 1600×900 and 3 meters, with width 640–2560, height 360–1440, physical width 0.4–4.0. Reopen to apply changes. A `localWeb` window asks backend `window.get` for `http://localhost:<port>/framely-window/<key>`; this is a loading mode, not a permission.
Use tags instead of legacy category, accepted only for compatibility. Database `tags.json` aggregates, deduplicates and sorts current channel tags; each channel is separate, clients merge sources locally. Tags change automatically with releases.
Packages/dependencies/uploads stage in `/tmp/framely-package-*`, removed on completion/cancel/failure. Idle uploads/reviews expire after 15 minutes, checked every 30 seconds.
Main `catalog.json` has one latest entry per ID. `plugins/<ID>/versions.json` contains `{schemaVersion:1,id,versions:[...]}` without that main entry. Details load history on demand, as does resolution when latest fails a range. Unknown catalog fields are ignored while known fields are checked; changed required semantics need a schema bump. Package Manifests remain strict. See [relationships](plugin-relationships.md), [subscriptions](source-subscriptions.md) and [lifecycle](plugin-lifecycle.md).
-86
View File
@@ -1,86 +0,0 @@
# Plugin lifecycle
[简体中文](../plugin-lifecycle.md)
Lifecycle is scheduled by the root core, but hooks run as the plugin's declared user, defaulting to `steamos`. Standalone hooks must match backend identity. UI-only plugins can set `lifecycle.runAs` for standalone commands; users see this identity during installation.
```json
{
"backend": {"entry": "backend.py", "runAs": "steamos", "autostart": false, "restart": "on-failure", "restartLimit": 3},
"lifecycle": {
"onInstall": {"entry": "backend.py"},
"onUpdate": {"entry": "backend.py"},
"onStart": true, "onStop": true,
"onUninstall": {"entry": "backend.py"},
"onCrashCleanup": {"entry": "backend.py", "args": ["--cleanup"]},
"timeoutSeconds": 10
}
}
```
All hooks are optional. Command entries must be hashed payload files, never shell strings or outside paths. Hooks do not introduce extra network/identity permissions. Timeouts are per hook, 1–15 seconds, default 10.
| Hook | Timing and execution |
| --- | --- |
| `onInstall` | Standalone command before first activation |
| `onUpdate` | Target version's command after stopping the old backend, before activation; includes downgrades |
| `onStart` | `framely.lifecycle.start` RPC after backend launch, before business calls |
| `onStop` | `framely.lifecycle.stop` before process termination during disabling, restart, updates, uninstall or normal manager shutdown |
| `onUninstall` | Standalone command after stopping backend, before removing payload |
| `onCrashCleanup` | Standalone cleanup after crashes, signals, OOM, timeouts or initialization failure |
Closing UI unmounts React, not the backend. Effects clean page subscriptions/leases, not backend resources. On-demand/autostart determines startup timing; restart policy handles failures after startup.
## Context and SDK
```ts
interface LifecycleContext {
pluginId: string;
phase: 'onInstall'|'onUpdate'|'onStart'|'onStop'|'onUninstall'|'onCrashCleanup';
reason: string;
version: string;
previousVersion: string|null;
dataDir: string;
exit: {reason:string;exitCode?:number|null;signal?:number|null;oom?:boolean;message?:string}|null;
}
```
Standalone commands read `FRAMELY_LIFECYCLE` and JSON `FRAMELY_LIFECYCLE_CONTEXT`. Backends and commands receive `FRAMELY_PLUGIN_ID`, `FRAMELY_PLUGIN_VERSION`, `FRAMELY_DATA_DIR` and the runtime user's HOME. Standalone stdout/stderr are logs; exit 0 means success. Backend hooks reply with result/error. Pages cannot call reserved `framely.lifecycle.*` methods.
The Python helper is copied from `@framely/sdk/python` into `framely.py`, without extra pip dependencies:
```python
from framely import serve
def initialize(context):
# Keep operations repeatable and limited to this plugin's resources.
return {'ready': True}
def cleanup(context):
return {'cleaned': True}
def dispatch(method, params):
return {'ok': True}
serve(dispatch, {
'onInstall': initialize, 'onUpdate': initialize,
'onStart': initialize, 'onStop': cleanup,
'onUninstall': cleanup, 'onCrashCleanup': cleanup,
})
```
With a standalone hook environment, the helper calls that hook and exits instead of entering RPC. TypeScript backends can use `registerLifecycle` from `@framely/sdk/lifecycle` in their existing dispatcher; it does not provide process launch or JSON-line transport. Page exports include context types, not backend privileges.
## Failure, cleanup and recovery
Failed install/update commands prevent activation. If installation/update starts a backend immediately (resident or previously running), failed initialization restores the previous version/current link; first installation is undone. First installation of an on-demand plugin normally runs onInstall only. Its onStart runs when a page opens or a business call starts the backend; failure then follows startup recovery, without undoing a previously completed installation. Failed downgrade initialization restores the version used before downgrade. Files can be restored, but migrations and hardware operations cannot be automatically reversed. Make migrations repeatable, use backups/temporary files/atomic replacement, and retain compatibility with the preceding version.
Failed/timed-out `onStop` is logged but the process group is still stopped. Crashes close plugin windows/notifications before standalone cleanup; cleanup failure does not suppress errors or future recovery. Cleanup must not depend on crashed memory or destructors. Remove owned resources only; do not restart SteamVR or delete other plugins' files.
Failed `onUninstall` retains the plugin and allows retry or explicit force removal. Force still attempts bounded cleanup and removes the payload afterward; data remains unless the core's explicit purge option is used. It cannot guarantee restoration of external settings.
Restart defaults to `on-failure`; `never` reports failure without retrying. Limits are 1–10, default 3 consecutive failures, reset after 60 seconds stable operation. Delays are 1, 2, 4, 8, 16, 32 seconds, capped at 32. Exit 0 and manager-directed stops do not count as failures. Exit codes, signals, systemd OOM and timeouts appear in status/logs.
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.
-48
View File
@@ -1,48 +0,0 @@
# Dependencies and conflicts
[简体中文](../plugin-relationships.md)
```json
{
"dependencies": {
"example.shared-api": "^1.0.0",
"example.camera-api": {"version": ">=1.2.0 <2.0.0", "source": "https://example.org/plugins/catalog.json"}
},
"optionalDependencies": {"example.notifications": "^1.0.0"},
"conflicts": {"example.other-camera": "*"},
"exclusiveResources": ["steamvr.passthrough-color"]
}
```
All four fields are optional. Relationship-declaring plugins and matched dependency/conflict targets use valid SemVer. Ranges support exact versions, `^`, `~`, `*` and comma/space comparison conjunctions. `1.2.0` is exact; `>=1.2.0 <2.0.0` requires both. `||` is unsupported. Self-dependencies, duplicate required/optional entries, contradictory conflicts and repeated exclusive resources are rejected.
`source` is an HTTPS catalog URL, not a subscription or package. Compatible installed versions/sources are reused first. Without explicit source, the originating catalog is preferred; otherwise choose explicitly. An unavailable explicit source is not silently replaced. New explicit sources join the confirmation plan; disabled sources need enabling first. Removing a source retains installed origin URLs for matching.
Local packages with no default source require selecting missing dependency sources:
```bash
framely install plugin.framely --source my-source --approve
framely install plugin.framely --dependency-source example.shared-api=https://example.org/catalog.json --approve
```
Dependency-source flags may repeat, cannot override explicit Manifest sources, and use the UI's resolver. Add `--approve-run-as` only after reviewing an identity change.
The main catalog contains one recommended entry per ID, with history in relative `plugins/<ID>/versions.json`. Users may select old versions or reinstall. ID/version/hash/relations are rechecked. Resolution reuses installed matches, otherwise the first matching source entry. Incompatible constraints, cycles or missing required dependencies stop installation. Missing optional dependencies neither prevent installation nor install automatically.
Plans disclose packages, versions, sources, users, added sources, dependency enabling and conflict disabling. Confirmed operations use the same verified bytes; changed device/source state requires another inspection. Plans allow at most 32 plugins without a total package/expanded-size cap. Download/verify first, then install sequentially and check reverse dependencies.
Persistent transaction logs restore links, origins/enabled state, undo newly added packages and attempt to restart previous backends on failure. Startup recovers interrupted transactions. Data remains; file rollback cannot undo migrations or hardware effects, so make them repeatable and recoverable.
Enabling confirms required dependencies and conflicting plugins to disable. Either side's conflict declaration prevents simultaneous enabling, not installation. Matching exclusive resources work likewise. Disabling/removing a base plugin requires confirming dependent disabling; dependents are not automatically removed.
Backends start in dependency order after base `onStart` succeeds; absent hooks use process startup. Stops reverse that order. Crashed bases pause running dependents in a waiting state without counting dependent failures, then resume them after recovery. Disabled/non-restarting bases need user action.
```tsx
import {framely, useDependencies} from '@framely/sdk';
const states = await framely.dependencies();
// In React: const {items, error} = useDependencies();
```
Only declared required/optional dependencies are returned, with version/enabling/range/availability/runtime state. Changes emit `dependencies.changed`. No cross-plugin backend calls or extra privileges are granted. Conflicts/resources depend on author declarations, not arbitrary file/device detection.
There is no manual plugin rollback API; old-version installation uses the normal plan and `onUpdate`. Transaction recovery is failure handling, not a version picker. Keep same-ID/version content immutable.
-71
View File
@@ -1,71 +0,0 @@
# Framely releases and updates
[简体中文](../releases.md)
Plugin catalogs and device-update sources are separate settings. Current initialization adds community stable/testing catalogs, subject to server availability. The distributor preconfigures device updates; About offers check/download/install/rollback. Without a source, use a release package. Packages do not require signatures or public keys.
## Update descriptors
After building an archive, generate a plain JSON descriptor containing version, architecture, URL, size and SHA256:
```bash
framely release-manifest --archive "./framely-0.2.0-<build>-linux-arm64.tar.gz" --url "https://example.org/releases/framely-0.2.0-<build>-linux-arm64.tar.gz" --output ./framely-release.json --changelog 'Release changes'
```
Publish archive/descriptor on HTTPS. Downloads allow up to five validated redirects without HTTPS downgrade. Configure the complete descriptor URL from a maintenance terminal:
```bash
framely call system.source.save '{"source":{"url":"https://example.org/framely-release.json"}}'
```
This is a distributor interface, not an ordinary settings item. The official engine and desktop installer initialize `https://github.com/SteamFramelyHomebrew/framely/releases/latest/download/framely-release.json` only when no source is configured, preserving existing sources. Hashes establish content consistency; identity depends on trusted sources, not signatures.
Updates verify API/architecture, length, SHA256, safe extraction and internal `SHA256SUMS`. Downloads do not block the core. After user confirmation, a separate systemd helper switches releases and restarts Framely only. Log: `/var/lib/framely/logs/update.log`. Failed installation attempts to restore release/state; the UI can return to the preceding release.
Sources contain URL only. Legacy signed descriptors/envelopes/public-key fields are unsupported. Rollback preserves plugin data without downgrading its format. Device upgrades, rollback and reboot still need real validation beyond local tests.
## Recovery after SteamOS updates
Management state resides at `/home/.framely/state`, including state, update source, logs, release links, Steam username and Framely UID. `/var/lib/framely` is a compatibility link. Old state migrates after writers stop; conflicting copies cause a stop rather than overwrite.
Accounts/services depend on OS configuration. When writable, `sudo bash /home/.framely/repair.sh` restores links, account, service files and startup from the retained, verified release without another download. It invokes the current release's `install.sh --repair` without creating releases or changing the previous-version record. UID conflicts or changes stop recovery. It never disables read-only protection automatically.
Deleted `/home` data cannot be recovered. OS updates may require manual intervention. After rolling back to a release without repair support, use a newer supporting package. Before stable publication, validate actual OS-update recovery, state/data/UIDs/services and SteamVR compatibility.
## GitHub Actions
Device and installer share the repository with independent versions/tags/workflows:
- Device: root Cargo version, `v<version>` (currently `v0.4.2-preview.6`), `.github/workflows/release.yml`, Linux ARM64 and pinned CEF.
- Installer: `installer/Cargo.toml`, `installer-v<version>` (currently `installer-v0.4.1-preview.4`), `.github/workflows/installer-release.yml`, Linux x64/ARM64, Windows x64, macOS Intel/Apple Silicon, pinned GPUI Kit.
Versions need not match or ship together. Update the relevant Cargo.lock with version changes. Installer package/macOS versions use the installer version.
Both workflows cache dependencies/builds by product/platform/toolchain/configuration, including failed builds. Installer uses `installer/target`; device CI uses `target/cargo`, separate from `target/cef`, for tests and packaging. Branch pushes do not build releases; matching tags or manual runs do. Tags may restore default-branch caches, not another tag's private cache. A manual main run can prime cache and builds artifacts only. Cold builds/toolchain changes need compilation; inspect cache steps rather than assuming a hit.
```bash
# After committing and pushing the intended source:
git tag v0.4.2-preview.6
git push origin v0.4.2-preview.6
# Independent installer release:
git tag installer-v0.4.1-preview.4
git push origin installer-v0.4.1-preview.4
```
Prerelease suffixes create GitHub Prereleases without Latest. Installer releases are never Latest. Only stable device releases become Latest, keeping default installer/update URLs on the device product. The desktop installer filters device archive names and does not mistake ARM64 installer packages for device runtimes. Download desktop installers from their explicit installer tags.
Only tags publish. After every product build succeeds, publication creates a draft, uploads assets/checksums, then makes it public. Failed drafts are not stable download targets. Manual runs leave Actions artifacts only.
Device attachments include the runtime archive, `framely-release.json`, `bootstrap.py`, `install.sh` and `SHA256SUMS`. Installer releases have five platform packages and checksums only. Desktop installers download archive/checksums without user-managed scripts.
External checksums cover downloaded archives; internal checksums cover extracted payload. Neither independently proves author identity. Online installation trusts the chosen repository/HTTPS, local installation the supplied archive/checksums. Redirects never downgrade HTTPS.
The entry fetches the release engine. Default is latest stable; `--version TAG` chooses that Release for both engine and package and works for Preview-only repositories. Locally run `python3 tools/bootstrap.py install --archive /path/package.tar.gz --checksums /path/SHA256SUMS`. Updating requires existing installation; selecting the same installed release repairs it, another version installs while retaining state.
Installation initializes the official update descriptor URL only if no source is configured, preserving existing sources for future in-app updates.
## Unified uninstallation
Scripts and desktop UI expose one uninstall operation. It stops session/downloads, then calls root-only `prepare-uninstall --approve`: persistently disable plugins, stop them in dependency order, run uninstall hooks, remove payloads. Only complete success removes services/core/runtime. Failure retains Framely, restores session access and leaves plugins disabled for troubleshooting/retry. There is no skip-failed-plugin manager uninstall.
Root maintenance can uninstall before consent or after revocation; pages do not expose the maintenance method. Settings/data/accounts remain, and external side effects are not guaranteed reversible. Old releases without this endpoint need updating first.
-26
View File
@@ -1,26 +0,0 @@
# Plugin source subscriptions
[简体中文](../source-subscriptions.md)
In Sources → Source subscriptions, paste an HTTPS JSON URL, preview and confirm:
```json
{
"schemaVersion": 1,
"name": "Community sources",
"sources": [
{"id":"stable", "name":"Stable", "url":"https://example.org/stable/catalog.json"},
{"id":"testing", "name":"Testing", "url":"https://example.org/testing/catalog.json"}
]
}
```
Source IDs must remain stable and unique within a subscription. Duplicate URLs, nested subscriptions, HTTP or credential-bearing URLs are forbidden. Limits: 100 sources/512 KiB per subscription, 20 subscriptions/200 sources per device. Subscriptions aggregate catalog URLs, not packages or images.
Automatic refresh defaults to daily and can be disabled or triggered manually. The running session checks due entries at startup, uses ETag/Last-Modified, and follows at most five HTTPS redirects. Failures preserve persisted source lists and retry with exponential backoff from one minute up to one day.
New sources join automatically; names update. URL changes keep the old address until confirmed. Refreshing also refreshes catalogs. Catalog caches are session-local; offline catalogs after restart are not guaranteed.
Canonical URLs deduplicate references from subscriptions and manual additions. Removing a subscription/source removes only its reference; sources disappear only without references. Installed plugins, origins and data remain; origins do not silently switch.
Disabled preferences persist across refresh/removal/readdition. Manage subscription URL changes through pending changes. Refreshing changes source metadata and update hints, never automatically installs, updates or enables plugins.
-29
View File
@@ -1,29 +0,0 @@
# Basic usage
[简体中文](../../user-guide/basic-usage.md)
[Documentation](../README.md) · [Installation](installation.md)
## Quick menu and manager
Click Framely in the SteamVR Dashboard Dock. First use requires accepting the terms and privacy statement; plugins do not automatically start before consent.
- **Favorites**: open favorite plugin quick pages.
- **Installed**: browse local plugins and their pages.
- **Settings**: language, safe mode and the plugin manager entry.
The manager opens a separate large window with navigation for plugins, store, sources, settings and About. Installation, updates and source management happen here. A phone or computer can also use the [network panel](network-panel.md).
## Plugins and windows
Enable, disable or favorite plugins in the list. Enabled means available for use; backends normally start on demand. Only plugins declaring `autostart` remain resident after startup. Closing a plugin window generally does not disable its backend. Dependency or conflict problems are explained, and affected plugins are shown before changes.
Dock windows use SteamVR close controls. Temporary windows may be destroyed when switching views. Individual plugin interfaces and behavior are maintained by their developers.
## Settings and diagnostics
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.
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.
-98
View File
@@ -1,98 +0,0 @@
# Install, update, repair and uninstall
[简体中文](../../user-guide/installation.md)
[Documentation](../README.md) · [Next: basic usage](basic-usage.md)
## Before installation
The target is Linux ARM64 Steam Frame. The development baseline is SteamOS VR 0.4.2 and SteamVR build 20260928.6175029; other versions need validation. The runtime includes CEF, so users do not need Node.js or Rust on the device.
Connect your computer and Frame to the same network. Enable developer mode and SSH on Frame, and prepare the `steamos` account password. Verify the SSH fingerprint. Installation uses sudo to create an account, systemd services and release directories. It does not automatically disable SteamOS read-only protection; it stops if required directories cannot be written.
## Option 1: desktop installer
1. Download the appropriate installer from an `installer-v<version>` entry in [Releases](https://github.com/SteamFramelyHomebrew/framely/releases). Linux uses tar.gz, Windows an EXE ZIP, and macOS an application ZIP.
2. Extract and run it. Scan for the device or enter its IP and SSH port.
3. Verify the fingerprint, enter `steamos` and its password, connect, and select a Framely device release.
4. Enable testing releases to select a Preview. Installer and device versions are independent.
5. Confirm the device, version and operation on the maintenance page. Alternatively, select a local device archive and its external `SHA256SUMS`.
On Linux, run `bash install-desktop-entry.sh` from the extracted installer directory to add an entry with the Framely icon to your user application menu. The entry points to that directory; run the script again after moving it.
Downloads are checked locally and again on the device. Passwords are not saved in configuration. Observe startup and rendering on Frame after installation.
## Option 2: install from Frame's SSH terminal
Run these commands **on Frame**. To install the latest stable release:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
```
To select a Preview or another tag:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3
```
Replace the example with an existing device release tag. An explicit tag selects the engine and package from that Release and works without a stable release. Without a tag, the latest stable release is selected. Enter the sudo password when prompted.
## Option 3: local archive
Download `framely-<version-and-build>-linux-arm64.tar.gz`, the external `SHA256SUMS`, and `bootstrap.py` from the same Release. Place them together on Frame:
```bash
python3 bootstrap.py install --archive "./framely-<version-and-build>-linux-arm64.tar.gz" --checksums ./SHA256SUMS
```
Angle brackets are placeholders; substitute the actual filename. The engine verifies, stages and extracts under `/home`, then checks internal hashes, avoiding the device's limited `/tmp`.
## Verify installation
```bash
systemctl is-active framely.service framely-session.service
/var/lib/framely/current/bin/framely --version
sudo /var/lib/framely/current/bin/framely status
```
Both services should be `active`. Open SteamVR Dashboard and find Framely in the Dock. Read and accept the terms and privacy statement before managing plugins. Continue with the [plugin installation guide](plugins.md).
## Update and rollback
When an update source is configured, check, download and confirm an update in **About**. Alternatively, use the desktop installer or run on Frame:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- update --version v0.4.2-preview.3
```
Updates preserve plugins, settings and data, retain the previous release, and restart Framely only. Preview updates require an explicit tag or local package; the default stable source does not automatically select Preview builds.
Choose rollback in About, or run:
```bash
sudo bash /var/lib/framely/current/rollback.sh
```
Rollback preserves plugin data but does not guarantee conversion of newer data formats to older ones.
## Repair and logs
SteamOS updates may reset system accounts and services. State persists under `/home/.framely/state`; `/var/lib/framely` is a compatibility entry. If system configuration is writable and `/home` remains intact:
```bash
sudo bash /home/.framely/repair.sh
sudo journalctl -u framely -u framely-session --no-pager -n 100
```
Repair restores accounts and services from the retained release and stops on UID conflicts. It cannot restore deleted `/home` data. Recovery after SteamOS updates still requires device validation.
## Uninstall
Use the desktop maintenance page or run:
```bash
sudo bash /var/lib/framely/current/uninstall.sh
```
Uninstallation disables and uninstalls every plugin, including uninstall hooks, before removing Framely programs and services. Failed plugin cleanup retains Framely and reports an error; resolve it and retry. Settings, plugin data and the dedicated account remain. External changes made by third-party plugins cannot always be automatically undone.
-37
View File
@@ -1,37 +0,0 @@
# Network management panel
[简体中文](../../user-guide/network-panel.md)
[Documentation](../README.md) · [Plugin installation](plugins.md)
## Find the address
The panel is enabled by default on IPv4 port `15915` and does not require SteamVR to run. Connect your phone/computer to Frame's network and open:
```text
http://DEVICE_IP:15915
```
Settings → Network panel shows current IP addresses and full URLs. The desktop installer also provides an entry after connecting. If no IP is detected, check Wi-Fi/Ethernet. Port conflicts are reported in settings.
## First password setup
With no configured password, first access shows setup only and does not expose management APIs. Enter at least eight characters and confirm the password, save, then log in. Password setup may precede terms acceptance; consent is still required to manage plugins.
A randomly salted PBKDF2 hash is stored, survives reboot, and is not displayed by the UI. Unauthenticated setup cannot overwrite an existing password. The panel password is independent of SSH/sudo credentials.
Change passwords from authenticated settings or the device's native manager. If forgotten, prefer changing it from Frame's native window. Existing passwords are retained; a previously configured password with verification explicitly disabled retains that choice. The panel uses HTTP: use a trusted network and do not forward the port directly to the public internet.
## Available operations
Manage sources and subscriptions, browse the store, upload local packages, confirm installation, enable/disable plugins, change settings and check device updates. Backends always run on Frame; uploading a file transfers it from your phone/computer.
VR windows, controller vibration and SteamVR keyboard need headset validation; a browser cannot replace those interactions. Some external links open in the device's default browser.
## Port changes, shutdown and expired sessions
Change the port or switch in Settings → Network panel. Password/authentication changes invalidate old sessions; use the new address after a port change. Turning the panel off disconnects web access without closing the native manager.
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.
-56
View File
@@ -1,56 +0,0 @@
# Install and manage plugins
[简体中文](../../user-guide/plugins.md)
[Documentation](../README.md) · [Network panel](network-panel.md)
## Install from the store
1. Open **Store** in the manager. Current code initializes community stable/testing sources; availability depends on the actual service and device configuration. If no catalog is available, add a developer's complete HTTPS `catalog.json` URL in Sources.
2. Filter by keywords, tags, source or installation state.
3. Open details and review author, description, changes, runtime user and dependencies. The recommended version is shown first; history loads on demand.
4. Install or inspect the selected version. Read the confirmation after download, verification and dependency resolution.
5. Check actual package runtime users, including any root dependencies, then confirm. Enable or open the plugin from the installed list.
Catalog runtime users are informational; final confirmation uses the downloaded package. `steamos` runs as the Steam session user; `root` can change system and device settings. Hashes check content, not developer identity or safety.
## Sources and subscriptions
For one catalog, add a name and `https://.../catalog.json` URL in Sources, test the connection, then save.
For multiple catalogs, add a subscription JSON URL in Source subscriptions, preview its sources, then confirm. A subscription is different from a catalog. Refreshing it changes source lists and metadata, not installed plugins.
Disabling or deleting a source does not uninstall its plugins. Subscription URL changes require confirmation. See the [subscription reference](../source-subscriptions.md).
## Import a file or package URL
Packages use the `.framely` extension and need no manual extraction. Open import in the manager's Plugins page:
- **Local file**: select a downloaded `.framely` file on your phone/computer in the web panel; it uploads and is verified.
- **Package URL**: paste a fixed-version HTTPS download URL from the author and wait for verification.
Both require reviewing confirmation, with an additional confirmation for changed runtime users. Device tar.gz archives and ordinary ZIP files are not plugin packages.
You can also install from Frame's SSH terminal:
```bash
sudo /var/lib/framely/current/bin/framely install ./plugin.framely --approve
```
Add `--approve-run-as` only when you have verified that changing the runtime user is intended. CLI approval does not assess the source's trustworthiness.
## Updates, older versions and removal
Open details for plugins marked updatable, review changes and confirm. Select history to inspect an older version. Switching sources is explicitly disclosed. Settings and favorites are generally retained; a different runtime user uses a different data directory and does not automatically migrate the old one.
Uninstall through the management dialog. Hooks handle external cleanup and saved data is retained. Do not remove system plugin directories manually. Disabling stops use without removing programs or data.
## Troubleshooting
| Symptom | Action |
| --- | --- |
| Empty store | Check enabled sources, connectivity and filters |
| Download/hash failure | Check network and URL; download again without bypassing verification |
| Missing history | The source may lack its history file; use latest or a trusted local old package |
| Cannot enable | Read dependency/conflict errors and install required plugins |
| Repeated crashes | Disable, inspect logs, use safe mode if needed, and report to the author |
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

+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.
+18 -22
View File
@@ -1,40 +1,36 @@
# 界面语言与社区翻译
# Languages and community translation
[English](en/localization.md)
[简体中文](zh-CN/localization.md)
Framely 内置简体中文和英语。在“设置”顶部选择语言;默认跟随系统语言,手动选择会保存在设备配置中。找不到对应语言时使用英语。语言文件缺少某条翻译时,该条内容回退到内置英语。
Framely includes Simplified Chinese and English. Choose a language at the top of Settings; automatic follows the system and manual choices persist. Unsupported languages and missing translations fall back to built-in English.
## 制作语言文件
## Create a language file
从设置下载英文模板,或复制 `ui/locales/en-US.json`。文件是 UTF-8 JSON:
Download the English template from Settings or copy `ui/locales/en-US.json`. Use UTF-8 JSON:
```json
{
"schemaVersion": 1,
"locale": "fr-FR",
"name": "Français",
"messages": {
"语言": "Langue",
"保存": "Enregistrer",
"启用 {0}": "Activer {0}"
}
"messages": {"语言": "Langue", "保存": "Enregistrer", "启用 {0}": "Activer {0}"}
}
```
- `locale` 使用语言代码,例如 `en-US`、`zh-CN`、`fr-FR`。不能使用 `auto`。
- `name` 使用该语言自己的名称,显示在语言选择列表中。
- `messages` 左侧是稳定的文案键,不要翻译或改写左侧;右侧才是译文。
- `{0}`、`{1}` 等是运行时参数。可以调整位置,但不能增删占位符。
- 可以先提供部分翻译,其余条目显示英语。空字符串是有效译文,不视为缺失。
- 按目标语言习惯重写整句,结合实际操作理解按钮和状态。部分键是句子片段,注意保留必要的空格。
- 文件只包含文本,不执行代码,也不解释 HTML。单文件最多 1 MiB、3000 条翻译,最多导入 50 个语言文件。
- Use a locale code such as `en-US`, `zh-CN`, `fr-FR`; `auto` is not a file locale.
- Name the language in that language.
- Message keys are stable: translate values only, never keys.
- Preserve all `{0}`, `{1}` placeholders; their positions may change.
- Partial translations fall back to English; empty strings are valid translations.
- Translate whole sentences for natural usage, taking fragment whitespace into account.
- Files contain text only, not executable code or interpreted HTML. Limits: 1 MiB/3000 entries per file and 50 imported files.
## 安装
## Install
在“设置 → 语言”点击“安装语言文件”,选择 JSON 文件。导入后在语言列表中选择它;再次导入相同语言代码会更新原文件。
In Settings → Language, install the JSON, then select it. Reimporting the same locale replaces that language file.
安装后的文件位于 `/var/lib/framely/locales/<locale>.json`。也可以由管理员直接放入此目录,文件名必须与 `locale` 一致;刷新管理面板后读取。损坏的文件会跳过,并在设置中显示文件名。插件作者提供的名称、介绍、标签及插件页面由各插件维护,宿主语言文件不会自动翻译这些内容。
Files live in `/var/lib/framely/locales/<locale>.json`. Administrators may place matching filenames there directly and refresh the panel. Invalid files are skipped and named in settings. Plugin names, descriptions, tags and pages remain the plugin author's responsibility; host language files do not translate them.
## 项目校验
## Validate the project
执行 `node tools/test-localization.mjs` 检查内置英语是否覆盖全部界面文案键、占位符是否一致,以及系统语言匹配、手动选择和缺失翻译回退。
Run `node tools/test-localization.mjs` for English coverage, placeholders, system matching, manual preferences and fallback behavior.
+35 -81
View File
@@ -1,64 +1,49 @@
# 插件开发参考
# Plugin development reference
[English](en/plugin-development.md)
[简体中文](zh-CN/plugin-development.md)
第一次开发请先阅读[完整开发流程](developer-guide/README.md)和[发布指南](developer-guide/publishing.md)。
Start with the [workflow](developer-guide/README.md), [SDK](developer-guide/sdk.md), [Manifest](developer-guide/manifest.md) and [publishing](developer-guide/publishing.md).
Dock 右侧快捷入口为与主窗口同朝向的弧面临时浮层,常用/已安装/设置三个底部 tab;插件管理从设置打开独立的原生 Dock 大窗口。安装表单与插件源设置只在管理窗口中出现。
The Dock quick menu has Favorites/Installed/Settings tabs; management opens a separate Dock window. Installation and sources are handled there. See `examples/showcase` and `sdk/src/index.tsx`. Release `tools/source` includes UI/SDK/examples/template/tools. Bundle pages into browser JS and call `registerPlugin({QuickPage, WindowPage})`. The host installs the bridge first. Ordinary bundled page iframes use `sandbox="allow-scripts"` with opaque origins and cannot call administrator HTTP APIs.
示例源码在 `examples/showcase`;React SDK 在 `sdk/src/index.tsx`。发行包 `tools/source` 提供完整 UI/SDK 示例构建工作区。插件页面需要自行打包为浏览器 JS,调用 `registerPlugin({QuickPage, WindowPage})` 挂载 React,宿主先加载桥接 bootstrap。普通 bundle 插件 iframe 为 `sandbox="allow-scripts"` 的独立不透明来源;通过父窗口转发被允许的 SDK 请求,不能直接调用管理员 HTTP API。
## Manifest
## Manifest and identities
```json
{
"schemaVersion": 1,
"apiVersion": 1,
"id": "example.plugin",
"name": "Example",
"author": "Developer",
"version": "1.0.0",
"schemaVersion": 1, "apiVersion": 1,
"id": "example.plugin", "name": "Example", "author": "Developer", "version": "1.0.0",
"description": "Example plugin",
"backend": {"entry": "backend.py", "runAs": "steamos", "autostart": false},
"ui": {
"quickPage": "page.js",
"windows": {"main": {"entry": "page.js", "title": "Example", "dockIcon": true}}
},
"ui": {"quickPage": "page.js", "windows": {"main": {"entry": "page.js", "title": "Example", "dockIcon": true}}},
"files": {}
}
```
`backend` 可省略。`runAs` 只支持 `steamos` 和 `root`,省略时为 `steamos`;`autostart` 默认 false。不再使用 `permissions` 字段,窗口、通知和联网无需权限声明。后端使用设备网络,普通插件页面允许 HTTP/HTTPS 请求及 WebSocket。
Backend is optional. Runtime users are `steamos` (default) or `root`; autostart defaults false. Retired `permissions` is unsupported; windows, notifications and networking need no declarations. Backend networking uses the device; ordinary pages permit HTTP/HTTPS and WebSockets.
ID 只允许小写字母、数字、点、短横线、下划线;载荷路径限 ASCII 字母/数字、`/._-+`,禁止绝对路径、空段、`.`、`..`。入口必须在 files 中;pack 会自动计算 files,不必手写哈希。后端入口须可直接执行,脚本需要正确 shebang(示例 `/usr/bin/python3`)。Python/系统依赖不会由 Framely 自动下载。
IDs permit lowercase letters, numbers, dots, hyphens, underscores. Payload paths permit ASCII letters/numbers and `/._-+`, never absolute paths, empty/dot/dot-dot segments. Packaging supplies files hashes. Entries must be hashed; executable scripts need shebangs, e.g. `/usr/bin/python3`. Framely does not install system/Python dependencies.
版本不可覆盖,相同版本再次发布需要使用新版本号。运行身份变化会选择新的数据目录 `/var/lib/framely/data/<id>/<identity>`;旧身份数据保留,安装使用旧身份的版本可恢复访问,不自动跨身份迁移文件。
Published versions are immutable. User changes select `/var/lib/framely/data/<id>/<identity>`; old data remains without automatic migration, and reinstalling the old identity can access it again.
## React API
## React bridge
```tsx
import {framely, registerPlugin, Button, Section} from '@framely/sdk';
function QuickPage() {
return <Section title="Example">
<Button onClick={() => framely.windows.open('main')}>打开窗口</Button>
<Button onClick={() => framely.call('save', {text: 'hello'})}>保存</Button>
<Button onClick={() => framely.notifications.send({
id: 'download', title: '完成', body: '下载已完成',
durationMs: 8000, actions: [{id: 'open', label: '打开', icon: '↗'}]
})}>发送通知</Button>
<Button onClick={() => framely.windows.open('main')}>Open</Button>
<Button onClick={() => framely.call('save', {text: 'hello'})}>Save</Button>
<Button onClick={() => framely.notifications.send({id: 'download', title: 'Done', body: 'Downloaded', durationMs: 8000, actions: [{id:'open',label:'Open',icon:'↗'}]})}>Notify</Button>
</Section>;
}
registerPlugin({QuickPage});
```
窗口 key 必须在 manifest 中声明;`framely.windows.close(key)` 关闭。关闭页面不会停止后端。通知 ID 用于更新/撤回;`framely.notifications.remove(id)` 撤回。图片为 PNG/JPEG data URL(最多 1 MB)或 HTTPS URL。时长 1–60 秒,每插件每 10 秒最多 10 次发送。
Keys must match Manifest. Closing windows does not stop backend. IDs update/withdraw notifications. Images accept PNG/JPEG data URL ≤1 MiB or HTTPS. At most three actions, 1–60 seconds and ten sends per ten seconds/plugin. `onEvent` returns unsubscribe and receives `{type,data}`. Each window has its own event cursor. Input focuses the native keyboard rather than web prompts.
`framely.onEvent(callback)` 返回取消订阅函数;接收 `{type, data}`。多个窗口分别按游标接收同一后台事件。文本输入框获得焦点时请求 SteamVR 虚拟键盘,完成后通过原生 setter 触发 React input/change;不使用网页 prompt。
## Backend protocol
## 后端协议
每行一个 JSON,stdin 请求、stdout 响应。stdout 只写协议,日志写 stderr(单文件最多约 2 MiB,保留一份轮转备份)。每条消息最多 64 KiB,输入写入超时 5 秒或响应超时 15 秒会停止后端,下次打开可重试。
Newline-delimited JSON on stdin/stdout; logs on stderr, rotating around 2 MiB. Messages ≤64 KiB; 5-second input or 15-second response timeouts stop the backend and allow later retry.
```json
{"id":1,"method":"save","params":{"text":"hello"}}
@@ -67,9 +52,9 @@ registerPlugin({QuickPage});
{"event":"progress","data":{"percent":50}}
```
系统传入 `FRAMELY_PLUGIN_ID`、`FRAMELY_DATA_DIR` 和对应身份 HOME。通知按钮向后端调用 `notification.action`,参数 `{id, action}`。后端主动发送通知使用 `{"event":"notification","data":{...通知...}}`,受同一 manifest 与频率限制。
Environment includes plugin ID, data directory and the user's HOME. Notification actions invoke `notification.action` with `{id,action}` and also reach pages; UI-only plugins can listen. Backend `notification` events send notifications under the same limits.
## 打包与源发布
## Packaging and catalogs
```bash
framely pack --manifest manifest.json --payload payload --output example.plugin-1.0.0.framely
@@ -77,51 +62,28 @@ framely verify example.plugin-1.0.0.framely
framely catalog --name 'My plugins' --base-url https://example.org/plugins --packages ./packages --output ./packages/catalog.json
```
包中包含 manifest.json 和文件载荷,files 记录每个载荷的 SHA256;不生成公钥或签名。只支持 manifest.json 与清单中声明的载荷文件,拒绝未声明的附加文件。
Archives contain Manifest and hashed payload only, without keys/signatures. Host the main catalog and relative history JSON. Authors can host packages on GitHub Releases. Current first initialization includes community stable/testing sources. Origins remain explicit; same-ID plugins in other sources do not silently replace existing origins. HTTP needs explicit development permission; up to five validated redirects, without HTTPS downgrade.
源需静态托管 catalog.json 及相对路径下的 plugins/<ID>/versions.json;插件包可放在作者自己的 GitHub Release。在插件源管理中添加目录完整 URL;当前代码首次初始化加入社区 stable/testing 来源,实际内容以服务器为准。目录条目有版本、下载 URL、SHA256。每个源独立显示,插件记录所选来源;另一个源同 ID 不会静默替换。HTTP 必须用户明确允许;目录和包支持最多五次重定向,HTTPS 不允许降级为 HTTP。
## Hover feedback
### 悬停反馈
Interactive controls automatically receive one hover pulse per entry, excluding disabled/inert controls and movement between their children. Supported elements include buttons, links, inputs, interactive ARIA roles/focusable controls or pointer cursors. Custom controls may mark `data-framely-interactive`. Native feedback uses the current hit controller, 12 ms/120 Hz/amplitude 0.15 with at least 80 ms spacing. Pages cannot target other windows/controllers.
Framely 主页面和插件 iframe 自动为可交互控件提供轻微的手柄振动,插件无需自行触发。进入按钮、链接、输入控件、可操作 ARIA role、可聚焦控件或 `cursor:pointer` 区域时触发一次;同一控件的子元素之间移动不会重复触发,禁用或 inert 控件不触发。自定义 React 控件应采用正确的 ARIA role,也可以加 `data-framely-interactive` 标记。
## Metadata and publication
振动由 OpenVR 的当前激光控制器执行(12 ms、120 Hz、幅度 0.15),宿主只接受当前可见且被激光命中的视图,限制相邻脉冲间隔为 80 ms。插件发出的反馈消息由 iframe 宿主绑定到实际视图,不能指定另一个窗口或手柄。
## 商店资料与图标
Manifest 可声明 `icon`(载荷内 PNG,最多 1 MiB、1024×1024)、`details`、`tags`、`screenshots`(最多 8 个载荷内 PNG/JPEG 路径)、`changelog`。这些文件会和页面一样加入文件哈希清单。图标用于插件列表和插件独立窗口的原生 Dock 缩略图,省略时使用默认拼图图标。
清单还支持三个可选网页地址,未填写的入口不显示:`authorUrl`(作者主页)、`documentationUrl`(插件文档)、`homepage`(插件主页)。地址必须是 HTTP 或 HTTPS,可包含文档锚点,不接受带用户名密码的链接。这些字段会保留在安装后的清单,并由 `framely catalog` 导出到商店目录;作者主页链接直接显示在作者名称上,未提供时作者名称为普通文本;商店列表、详情、管理弹窗和安装确认使用相同行为。文档和插件主页保留独立入口,点击后由系统默认浏览器打开。
```json
{
"authorUrl": "https://github.com/author",
"documentationUrl": "https://github.com/author/plugin#readme",
"homepage": "https://github.com/author/plugin"
}
```
插件仓库可声明发布信息:
Manifest supports payload PNG icon ≤1 MiB/1024×1024, details/tags/changelog and up to eight PNG/JPEG screenshots. Icons appear in lists/Dock; missing icons use the default. Optional `authorUrl`, `documentationUrl`, `homepage` are credential-free HTTP/HTTPS links, preserved in state/catalog. Author URLs link author labels; device default browsers open external pages.
```json
{
"downloadUrl": "https://github.com/author/plugin/releases/download/v1.0.0/plugin.framely",
"publish": {
"icon": "https://github.com/author/plugin/releases/download/v1.0.0/icon.png",
"screenshots": ["https://github.com/author/plugin/releases/download/v1.0.0/screen.png"]
}
"publish": {"icon": "https://github.com/author/plugin/releases/download/v1.0.0/icon.png", "screenshots": ["https://github.com/author/plugin/releases/download/v1.0.0/screen.png"]}
}
```
上述为显式地址示例,`downloadUrl` 并非源码必填字段:GitHub 社区登记可按仓库、`v<version>` 和 `<id>-<version>.framely` 自动生成。包内仍需最终地址,当前 pack 不会自动读取 Git remote;按[发布指南](developer-guide/publishing.md)生成临时清单即可。社区图标通常只需 `icon`,数据库从固定源码提交生成并校验 Raw 地址;无需额外 `publish.icon`。本地 catalog CLI 使用 `publish` 外部图片,省略时不会导出包内图标/截图,商店采用默认图标。包内资源仍用于已安装插件。
The fragment above shows explicit URLs; GitHub registration source may omit `downloadUrl`, deriving repository, `v<version>` and `<id>-<version>.framely`. The packaged Manifest still requires the final URL; current pack does not derive it. See [publishing](developer-guide/publishing.md) for temporary-Manifest commands. Community icons normally use top-level `icon`, with derived and verified pinned Raw URLs, without `publish.icon`. The local catalog CLI uses external `publish` images and does not export packaged image paths; absent external icons use the plugin library default. Community registration pins submodule commits, obtains expected SHA256 from Release digests or source `downloadSha256`, then validates downloaded package hashes, declarations and payloads. Generated channels provide catalog/history JSON without mirroring packages/images. It does not execute author code or establish reproducible source/binary equivalence.
插件数据库只登记 submodule 固定提交,读取该提交的清单,补全默认下载地址,先取得 Release digest 或源码 `downloadSha256` 中的预期整包哈希,再下载并比对 SHA256、清单声明和载荷。发布分支提供各渠道目录及历史版本 JSON,不保存插件包或图片,不需要 entries 登记。数据库 CI 自动展示版本和运行用户变化,发布时禁止同 ID、版本更换 SHA256;不执行作者代码,不要求逐插件人工源码审核,也不验证源码与二进制可复现关系。
Catalog CLI only emits JSON, preferring `downloadUrl` over base URL/filename and using external publish images. It does not copy resources. The plugin library filters keywords/tags/origins/states, retains session caches on failures and installs reviewed bytes without downloading again after confirmation.
`framely catalog` 也只生成 JSON:下载 URL 优先使用 `downloadUrl`,没有该字段时采用 `--base-url` 加包文件名。图标与截图来自 `publish` 的外部 URL,不复制资源。商店支持关键词、标签、来源、已安装和可更新筛选;源暂时不可用时显示会话缓存。安装使用已经校验的同一份包,不在确认后重新下载。
后端默认按失败自动恢复,包括已经启动的按需插件;可用 `backend.restart: "never"` 关闭。默认第三次连续失败后停用,运行稳定一分钟后重置计数,详见[生命周期](plugin-lifecycle.md)。
## 脚手架与预览
## Scaffold and preview
```bash
node tools/plugin-dev.mjs init ./my-plugin example.my-plugin
@@ -131,22 +93,14 @@ npm run dev
npm run build
```
发行包中的工具位置为 `tools/source/tools/plugin-dev.mjs`。预览监听本机 127.0.0.1:5173,修改页面后自动重载;它不会启动后端或获得 Frame 系统权限。窗口和通知在浏览器里模拟,身份、键盘、振动及后台调用仍需安装到设备测试。
Release tool location: `tools/source/tools/plugin-dev.mjs`. Preview binds `127.0.0.1:5173` and reloads changes, simulating windows/notifications only. Backend calls, identities, keyboards and haptics require Frame. SDK includes Section/Button/Toggle/Slider/TextField/Select/Tabs/Notice/useBackend/usePluginEvent; window maps can register different components. See [SDK](developer-guide/sdk.md).
SDK 提供 `Section`、`Button`、`Toggle`、`Slider`、`TextField`、`Select`、`Tabs`、`Notice`、`useBackend`、`usePluginEvent`。Select 使用页面内弹层,兼容离屏 CEF。`registerPlugin` 还可传入 `windows: {main: Component, other: Component}` 为多个声明窗口选择不同 React 页面。
## Windows, tags and history
通知按钮向后端发送 `notification.action`,同时广播给当前打开的插件页面,事件为 `{type:'notification.action',data:{id,action}}`;无后端插件可以通过 `framely.onEvent` 接收。
Default windows are 1600×900 and 3 meters, with width 640–2560, height 360–1440, physical width 0.4–4.0. Reopen to apply changes. A `localWeb` window asks backend `window.get` for `http://localhost:<port>/framely-window/<key>`; this is a loading mode, not a permission.
插件安装、更新、停止和异常恢复的约定见[生命周期开发说明](plugin-lifecycle.md)。
Use tags instead of legacy category, accepted only for compatibility. Database `tags.json` aggregates, deduplicates and sorts current channel tags; each channel is separate, clients merge sources locally. Tags change automatically with releases.
窗口可选声明 `width`、`height`(逻辑像素)和 `widthMeters`(VR 物理宽度,米)。默认 1600×900(16:9)、VR 宽度 3 米;像素范围为宽 640–2560、高 360–1440,物理宽度 0.4–4.0 米。示例:`{"entry":"page.js","title":"温控","dockIcon":true,"width":1600,"height":900,"widthMeters":3.0}`。尺寸在重新打开窗口时生效。
Packages/dependencies/uploads stage in `/tmp/framely-package-*`, removed on completion/cancel/failure. Idle uploads/reviews expire after 15 minutes, checked every 30 seconds.
依赖、可选依赖、冲突和独占资源见[插件关系](plugin-relationships.md),多个插件源聚合见[源订阅](source-subscriptions.md)。
插件只使用 `tags` 描述用途,不再使用分类;为兼容已发布的包,旧 `category` 字段读取时忽略,新的清单及目录不再导出它。插件数据库每次生成目录时同时生成 `tags.json`,格式为 `{ "schemaVersion": 1, "tags": ["工具", "温控"] }`,聚合当前目录全部插件的标签、精确去重并排序。stable/testing 分别生成自己的标签文件,不生成跨渠道并集;程序加载多个源后在本地聚合去重。标签随插件更新自动增删,无须手工维护。
上传的插件包、商店下载及其依赖包暂存于 `/tmp/framely-package-*`,确认安装后才写入插件目录。取消、安装完成或失败后删除暂存包;未完成上传和待确认安装包闲置 15 分钟后过期,每 30 秒清理一次。
本机网页窗口在 `ui.windows.<key>` 设置 `localWeb: true`,宿主通过后端 `window.get` 获取窗口 URL;这是窗口加载方式,不是权限声明。URL 使用 `http://localhost:<端口>/framely-window/<key>`。普通窗口无需设置此项。
商店主目录 `catalog.json` 中每个插件 ID 仅出现一次,代表最新版。历史条目存放在相对目录 `plugins/<插件ID>/versions.json`,格式为 `{ "schemaVersion": 1, "id": "作者.插件", "versions": [...] }`;版本条目沿用目录条目的字段,列表不包含主目录的最新版。商店进入详情时按需读取历史,依赖解析仅在最新版不满足范围时读取历史。附加目录字段可扩展,读取端忽略未知字段,但校验已知字段;改变必需语义应升级 `schemaVersion`。插件安装包清单仍严格校验。
Main `catalog.json` has one latest entry per ID. `plugins/<ID>/versions.json` contains `{schemaVersion:1,id,versions:[...]}` without that main entry. Details load history on demand, as does resolution when latest fails a range. Unknown catalog fields are ignored while known fields are checked; changed required semantics need a schema bump. Package Manifests remain strict. See [relationships](plugin-relationships.md), [subscriptions](source-subscriptions.md) and [lifecycle](plugin-lifecycle.md).
+36 -41
View File
@@ -1,23 +1,16 @@
# 插件生命周期
# Plugin lifecycle
[English](en/plugin-lifecycle.md)
[简体中文](zh-CN/plugin-lifecycle.md)
生命周期由 root 核心服务调度,但钩子使用插件声明的运行身份;省略身份为 `steamos`。有后端时,独立钩子与后端身份必须一致;纯 UI 插件可在 `lifecycle.runAs` 声明身份,安装时展示运行用户。
Lifecycle is scheduled by the root core, but hooks run as the plugin's declared user, defaulting to `steamos`. Standalone hooks must match backend identity. UI-only plugins can set `lifecycle.runAs` for standalone commands; users see this identity during installation.
```json
{
"backend": {
"entry": "backend.py",
"runAs": "steamos",
"autostart": false,
"restart": "on-failure",
"restartLimit": 3
},
"backend": {"entry": "backend.py", "runAs": "steamos", "autostart": false, "restart": "on-failure", "restartLimit": 3},
"lifecycle": {
"onInstall": {"entry": "backend.py"},
"onUpdate": {"entry": "backend.py"},
"onStart": true,
"onStop": true,
"onStart": true, "onStop": true,
"onUninstall": {"entry": "backend.py"},
"onCrashCleanup": {"entry": "backend.py", "args": ["--cleanup"]},
"timeoutSeconds": 10
@@ -25,22 +18,20 @@
}
```
所有钩子可省略。独立命令的 entry 必须是包内文件并包含在 files 哈希清单;不能指定 shell 字符串或包外路径。没有为插件增加身份或网络权限。timeoutSeconds 为 1–15 秒,默认 10 秒,每个钩子分别计时。
All hooks are optional. Command entries must be hashed payload files, never shell strings or outside paths. Hooks do not introduce extra network/identity permissions. Timeouts are per hook, 1–15 seconds, default 10.
| 钩子 | 执行时机与方式 |
| Hook | Timing and execution |
| --- | --- |
| onInstall | 第一次安装,新版本激活前执行独立命令 |
| onUpdate | 更新或回退,停止旧后端后、新版本激活前执行目标版本的独立命令 |
| onStart | 启动后端后发送 `framely.lifecycle.start` RPC,成功后才接受业务调用 |
| onStop | 禁用、重启、更新、回退、卸载和管理器正常退出时,停止进程前发送 `framely.lifecycle.stop` RPC |
| onUninstall | 停止后端后、删除包前执行独立命令 |
| onCrashCleanup | 异常退出、信号、OOM、调用超时或初始化失败后,由独立进程执行清理 |
| `onInstall` | Standalone command before first activation |
| `onUpdate` | Target version's command after stopping the old backend, before activation; includes downgrades |
| `onStart` | `framely.lifecycle.start` RPC after backend launch, before business calls |
| `onStop` | `framely.lifecycle.stop` before process termination during disabling, restart, updates, uninstall or normal manager shutdown |
| `onUninstall` | Standalone command after stopping backend, before removing payload |
| `onCrashCleanup` | Standalone cleanup after crashes, signals, OOM, timeouts or initialization failure |
关闭快捷菜单或大窗口只卸载对应 React 页面,不停止后端。React effect 清理仍用于页面订阅、预览租约等;不能替代后端生命周期。按需启动与 autostart 是启动时机,restart 是已经启动后发生失败的恢复策略。
Closing UI unmounts React, not the backend. Effects clean page subscriptions/leases, not backend resources. On-demand/autostart determines startup timing; restart policy handles failures after startup.
## 上下文与 SDK
所有回调收到以下上下文:
## Context and SDK
```ts
interface LifecycleContext {
@@ -54,42 +45,46 @@ interface LifecycleContext {
}
```
独立命令读取 `FRAMELY_LIFECYCLE` 与 JSON 编码的 `FRAMELY_LIFECYCLE_CONTEXT`。所有后端与命令均有 `FRAMELY_PLUGIN_ID`、`FRAMELY_PLUGIN_VERSION`、`FRAMELY_DATA_DIR` 及对应身份 HOME。独立命令 stdout/stderr 是日志,退出码 0 表示成功;后端钩子按普通 JSON 行协议回复 result 或 error。`framely.lifecycle.*` 为核心服务保留,插件业务 API 不能调用。
Standalone commands read `FRAMELY_LIFECYCLE` and JSON `FRAMELY_LIFECYCLE_CONTEXT`. Backends and commands receive `FRAMELY_PLUGIN_ID`, `FRAMELY_PLUGIN_VERSION`, `FRAMELY_DATA_DIR` and the runtime user's HOME. Standalone stdout/stderr are logs; exit 0 means success. Backend hooks reply with result/error. Pages cannot call reserved `framely.lifecycle.*` methods.
Python SDK 位于 `@framely/sdk/python`,构建时复制为载荷中的 `framely.py`,不需额外 pip 依赖:
The Python helper is copied from `@framely/sdk/python` into `framely.py`, without extra pip dependencies:
```python
from framely import serve
def initialize(context):
# 可重复执行;仅操作本插件的数据和资源。
return {"ready": True}
# Keep operations repeatable and limited to this plugin's resources.
return {'ready': True}
def cleanup(context):
return {"cleaned": True}
return {'cleaned': True}
def dispatch(method, params):
return {"ok": True}
return {'ok': True}
serve(dispatch, {
"onInstall": initialize, "onUpdate": initialize,
"onStart": initialize, "onStop": cleanup,
"onUninstall": cleanup, "onCrashCleanup": cleanup,
'onInstall': initialize, 'onUpdate': initialize,
'onStart': initialize, 'onStop': cleanup,
'onUninstall': cleanup, 'onCrashCleanup': cleanup,
})
```
SDK 检测独立钩子环境时只执行相应回调并退出,不进入 RPC 循环。TypeScript 后端可从 `@framely/sdk/lifecycle` 导入 `registerLifecycle` 和类型,将保留方法交给返回的 dispatcher;它不负责启动进程或实现 JSON 行传输。网页侧 SDK 也导出上下文类型,但不提供后端运行权限。
With a standalone hook environment, the helper calls that hook and exits instead of entering RPC. TypeScript backends can use `registerLifecycle` from `@framely/sdk/lifecycle` in their existing dispatcher; it does not provide process launch or JSON-line transport. Page exports include context types, not backend privileges.
## 失败、清理与恢复
## Failure, cleanup and recovery
安装或更新的命令钩子失败时不激活新版本。若安装/更新当时需要启动后端(常驻或原本在运行),初始化失败也恢复原版本与 current 链接;初次安装则撤销安装。按需插件首次安装通常只执行 onInstall,onStart 在首次打开页面/业务调用等实际启动时执行;此时失败走启动恢复,不会追溯撤销之前已完成的安装。回退的初始化失败时恢复回退前的版本。文件版本可恢复,数据迁移和设备操作无法自动撤销:迁移应可重复执行、采用备份/临时文件与原子替换,并保持上一版本能读取数据。
Failed install/update commands prevent activation. If installation/update starts a backend immediately (resident or previously running), failed initialization restores the previous version/current link; first installation is undone. First installation of an on-demand plugin normally runs onInstall only. Its onStart runs when a page opens or a business call starts the backend; failure then follows startup recovery, without undoing a previously completed installation. Failed downgrade initialization restores the version used before downgrade. Files can be restored, but migrations and hardware operations cannot be automatically reversed. Make migrations repeatable, use backups/temporary files/atomic replacement, and retain compatibility with the preceding version.
onStop 失败或超时会记录错误,仍会停止整个插件进程组。崩溃后先关闭该插件的窗口、通知,再执行 onCrashCleanup;清理失败不会阻止错误记录或后续恢复。崩溃清理必须是独立命令,无法依赖已经崩溃进程里的内存、析构器或回调。确认资源属于本插件后再删除;不要重启 SteamVR 或删除其他插件的文件。
Failed/timed-out `onStop` is logged but the process group is still stopped. Crashes close plugin windows/notifications before standalone cleanup; cleanup failure does not suppress errors or future recovery. Cleanup must not depend on crashed memory or destructors. Remove owned resources only; do not restart SteamVR or delete other plugins' files.
onUninstall 失败保留插件并展示错误,用户可重试或选择强制卸载。强制卸载仍尝试有超时限制的清理,随后移除插件包;用户数据默认保留,仅 purge 删除。强制卸载不能保证外部设备设置已还原。
Failed `onUninstall` retains the plugin and allows retry or explicit force removal. Force still attempts bounded cleanup and removes the payload afterward; data remains unless the core's explicit purge option is used. It cannot guarantee restoration of external settings.
restart 默认为 on-failure;never 只记录失败,不自动重启。restartLimit 默认为 3,范围 1–10,达到连续失败阈值后停用;失败计数在后端稳定运行 60 秒后重置。重试等待为 1、2、4、8、16、32 秒,最多 32 秒。正常自主退出(退出码 0)不重启;管理器主动停止也不计入失败。退出码、信号、systemd OOM 和调用超时记录在状态与日志中。
Restart defaults to `on-failure`; `never` reports failure without retrying. Limits are 1–10, default 3 consecutive failures, reset after 60 seconds stable operation. Delays are 1, 2, 4, 8, 16, 32 seconds, capped at 32. Exit 0 and manager-directed stops do not count as failures. Exit codes, signals, systemd OOM and timeouts appear in status/logs.
状态包含 starting、running、stopping、stopped、recovering、failed 等阶段,并发管理操作沿核心服务的串行调度执行。管理器正常 SIGTERM/SIGINT 会尝试逐个停止插件;强制终止、断电不能保证任何钩子执行。清理应同时可在下次启动时安全恢复。
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.
日志页面合并展示后端日志与 lifecycle 日志;每种日志保留当前 2 MiB 与上一份。安装失败且插件尚未登记时,可从 `/var/lib/framely/logs/<id>.lifecycle.log` 查看。运行身份的数据目录为 `/var/lib/framely/data/<id>/<身份>/`(自定义核心数据目录时相应变化)。
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)
+16 -23
View File
@@ -1,15 +1,12 @@
# 插件依赖与冲突(Framely 0.4)
# Dependencies and conflicts
[English](en/plugin-relationships.md)
[简体中文](zh-CN/plugin-relationships.md)
```json
{
"dependencies": {
"example.shared-api": "^1.0.0",
"example.camera-api": {
"version": ">=1.2.0 <2.0.0",
"source": "https://example.org/plugins/catalog.json"
}
"example.camera-api": {"version": ">=1.2.0 <2.0.0", "source": "https://example.org/plugins/catalog.json"}
},
"optionalDependencies": {"example.notifications": "^1.0.0"},
"conflicts": {"example.other-camera": "*"},
@@ -17,39 +14,35 @@
}
```
四个字段都可省略。声明关系的插件使用合法 SemVer;作为依赖或冲突版本匹配目标的插件也应使用 SemVer。版本范围支持精确版本、`^`、`~`、`*` 和逗号/空白分隔的比较条件。`1.2.0` 表示精确匹配;`>=1.2.0 <2.0.0` 表示两个条件同时满足,不支持 `||`。拒绝自身依赖、重复必需/可选声明、依赖与冲突矛盾和重复独占资源。
All four fields are optional. Relationship-declaring plugins and matched dependency/conflict targets use valid SemVer. Ranges support exact versions, `^`, `~`, `*` and comma/space comparison conjunctions. `1.2.0` is exact; `>=1.2.0 <2.0.0` requires both. `||` is unsupported. Self-dependencies, duplicate required/optional entries, contradictory conflicts and repeated exclusive resources are rejected.
`source` 必须是 HTTPS 插件目录 URL,不是订阅或包下载 URL。优先复用版本与来源满足要求的已安装插件;未声明来源时优先当前插件所在源,其他来源必须明确选择。指定来源不可用或没有匹配版本时不换源。明确依赖源尚未添加时,进入安装计划统一确认;已停用的源需用户先启用。删除源后保留已安装插件的来源 URL 记录,以便依赖约束继续识别其来源。
`source` is an HTTPS catalog URL, not a subscription or package. Compatible installed versions/sources are reused first. Without explicit source, the originating catalog is preferred; otherwise choose explicitly. An unavailable explicit source is not silently replaced. New explicit sources join the confirmation plan; disabled sources need enabling first. Removing a source retains installed origin URLs for matching.
本地包没有默认来源时,未安装依赖需要选择来源;也可通过 CLI 指定已添加源 ID:
Local packages with no default source require selecting missing dependency sources:
```bash
framely install plugin.framely --source my-source --approve
framely install plugin.framely \
--dependency-source example.shared-api=https://example.org/catalog.json \
--approve
framely install plugin.framely --dependency-source example.shared-api=https://example.org/catalog.json --approve
```
`--dependency-source` 可重复使用,不能覆盖清单中的明确来源。CLI 和界面使用同一解析器。需要接受已有插件运行用户变化时再加 `--approve-run-as`。
Dependency-source flags may repeat, cannot override explicit Manifest sources, and use the UI's resolver. Add `--approve-run-as` only after reviewing an identity change.
主目录每个插件 ID 只出现一次,历史版本来自相对路径 `plugins/<ID>/versions.json`;主目录版本是推荐版本。用户可选择旧版本安装或重新安装当前版本;包的 ID、版本、哈希及依赖均重新校验。依赖解析优先复用已安装版本,否则选取源中第一个满足约束的版本。多个版本/来源约束无法同时满足、出现循环依赖、缺少必需依赖时停止。缺失可选依赖不阻止安装,也不自动安装。
The main catalog contains one recommended entry per ID, with history in relative `plugins/<ID>/versions.json`. Users may select old versions or reinstall. ID/version/hash/relations are rechecked. Resolution reuses installed matches, otherwise the first matching source entry. Incompatible constraints, cycles or missing required dependencies stop installation. Missing optional dependencies neither prevent installation nor install automatically.
安装计划展示所有包、版本、来源、运行用户、新增源、依赖启用和冲突停用。确认后使用同一份已校验包;设备插件/来源状态改变后要求重新检查。最多 32 个插件,不限制插件包大小或解压后的总大小。先完成下载和校验,再依次安装,检查反向依赖,防止更新破坏已有依赖方。
Plans disclose packages, versions, sources, users, added sources, dependency enabling and conflict disabling. Confirmed operations use the same verified bytes; changed device/source state requires another inspection. Plans allow at most 32 plugins without a total package/expanded-size cap. Download/verify first, then install sequentially and check reverse dependencies.
批量操作记录持久事务日志;失败恢复版本链接、来源和启用状态,撤销本次新增的包安装,并尝试恢复此前运行的后端。安装期间管理器意外退出时,下次启动恢复原记录。用户数据保留;生命周期迁移和设备操作不能由文件版本回退自动撤销,插件必须设计可重复执行、可恢复的迁移。
Persistent transaction logs restore links, origins/enabled state, undo newly added packages and attempt to restart previous backends on failure. Startup recovers interrupted transactions. Data remains; file rollback cannot undo migrations or hardware effects, so make them repeatable and recoverable.
启用时统一确认需要启用的必需依赖及需要停用的冲突插件。冲突按任意一方声明处理,允许同时安装,禁止同时启用;同名独占资源同样禁止同时启用。停用/卸载基础插件需确认一起停用依赖方,依赖方不会被自动卸载。
Enabling confirms required dependencies and conflicting plugins to disable. Either side's conflict declaration prevents simultaneous enabling, not installation. Matching exclusive resources work likewise. Disabling/removing a base plugin requires confirming dependent disabling; dependents are not automatically removed.
后端按依赖顺序启动,`onStart` 成功才启动依赖方;没有该钩子的后端沿用进程启动成功判断。停止顺序相反。关闭页面不停止后端。基础后端异常时暂停正在运行的依赖方,进入“等待依赖”,不累计依赖方失败次数;基础后端恢复后重新按顺序启动。基础后端被停用或禁止重启时等待用户处理。
SDK 提供:
Backends start in dependency order after base `onStart` succeeds; absent hooks use process startup. Stops reverse that order. Crashed bases pause running dependents in a waiting state without counting dependent failures, then resume them after recovery. Disabled/non-restarting bases need user action.
```tsx
import {framely, useDependencies} from '@framely/sdk';
const states = await framely.dependencies();
// React 页面:const {items, error} = useDependencies();
// In React: const {items, error} = useDependencies();
```
只返回当前插件声明的必需/可选依赖,含版本、启用状态、约束是否满足、后端是否可用和运行阶段。依赖状态变化触发 `dependencies.changed` 事件;不开放跨插件后端调用,不增加运行权限。独占资源和 conflicts 都依赖作者声明,不自动检测任意文件或设备冲突。
Only declared required/optional dependencies are returned, with version/enabling/range/availability/runtime state. Changes emit `dependencies.changed`. No cross-plugin backend calls or extra privileges are granted. Conflicts/resources depend on author declarations, not arbitrary file/device detection.
不提供插件手动回滚接口;安装旧版本统一走正常安装计划和 `onUpdate`。安装失败的事务恢复仍保留,不是用户选择版本的入口。同 ID 同版本必须保持发布内容不变。
There is no manual plugin rollback API; old-version installation uses the normal plan and `onUpdate`. Transaction recovery is failure handling, not a version picker. Keep same-ID/version content immutable.
+37 -42
View File
@@ -1,78 +1,73 @@
# Framely 发行与更新
# Framely releases and updates
[English](en/releases.md)
[简体中文](zh-CN/releases.md)
插件源和 Framely 自身更新源是独立设置。当前代码首次初始化加入社区 stable/testing 来源;目录能否访问以实际服务为准。Framely 更新服务由发行者预配置,管理窗口“关于”提供检查、下载、安装和回滚;尚未配置时使用发行安装包更新。插件和 Framely 发行包均不要求签名或公钥。
Plugin catalogs and device-update sources are separate settings. Current initialization adds community stable/testing catalogs, subject to server availability. The distributor preconfigures device updates; About offers check/download/install/rollback. Without a source, use a release package. Packages do not require signatures or public keys.
构建发行包后生成包含版本、架构、下载地址、长度与 SHA256 的普通 JSON 更新清单:
## Update descriptors
After building an archive, generate a plain JSON descriptor containing version, architecture, URL, size and SHA256:
```bash
framely release-manifest \
--archive "./framely-0.2.0-<build>-linux-arm64.tar.gz" \
--url "https://example.org/releases/framely-0.2.0-<build>-linux-arm64.tar.gz" \
--output ./framely-release.json \
--changelog '本次更新说明'
framely release-manifest --archive "./framely-0.2.0-<build>-linux-arm64.tar.gz" --url "https://example.org/releases/framely-0.2.0-<build>-linux-arm64.tar.gz" --output ./framely-release.json --changelog 'Release changes'
```
将包与清单发布到 HTTPS 静态服务;下载最多跟随五次经过 URL 校验的重定向,不允许从 HTTPS 降级到 HTTP。发行维护终端配置清单完整 URL:
Publish archive/descriptor on HTTPS. Downloads allow up to five validated redirects without HTTPS downgrade. Configure the complete descriptor URL from a maintenance terminal:
```bash
framely call system.source.save '{"source":{"url":"https://example.org/framely-release.json"}}'
```
此接口用于发行维护,不作为普通用户设置项。当前官方安装引擎和桌面安装器会在更新源尚未配置时写入 `https://github.com/SteamFramelyHomebrew/framely/releases/latest/download/framely-release.json`,已有配置保留。哈希用于检查下载内容一致性,发行者身份依赖更新源;不再通过签名验证。
This is a distributor interface, not an ordinary settings item. The official engine and desktop installer initialize `https://github.com/SteamFramelyHomebrew/framely/releases/latest/download/framely-release.json` only when no source is configured, preserving existing sources. Hashes establish content consistency; identity depends on trusted sources, not signatures.
更新依次检查 API/架构兼容、声明长度、SHA256,安全解压后检查发行包自身 SHA256SUMS;下载不阻塞核心服务。用户确认安装后,独立 systemd 助手切换发行版本,只重启 Framely 服务。日志在 `/var/lib/framely/logs/update.log`。安装失败会尝试恢复原发行和安装前状态;UI 可回滚上一版本。
Updates verify API/architecture, length, SHA256, safe extraction and internal `SHA256SUMS`. Downloads do not block the core. After user confirmation, a separate systemd helper switches releases and restarts Framely only. Log: `/var/lib/framely/logs/update.log`. Failed installation attempts to restore release/state; the UI can return to the preceding release.
更新源仅包含 URL,发行清单使用普通 JSON,不支持旧签名包、签名信封或公钥字段。回滚切换上一发行版本,保留插件数据,不进行旧版格式迁移。
Sources still contain URL only. The separate `database.updateChannel` preference is `stable` (default) or `testing`, so older versions can continue reading the existing update source during rollback. Set it through `framely call system.channel.save '{"channel":"testing"}'`, or use About. Changing the source or channel invalidates previously checked/downloaded releases. Legacy signed descriptors/envelopes/public-key fields are unsupported. Rollback preserves plugin data without downgrading its format. Device upgrades, rollback and reboot still need real validation beyond local tests.
设备上的实际升级/回滚和重启恢复需要验收;本地自动测试验证无签名格式、包边界和插件安装更新,不能代替设备服务切换测试。
For the official GitHub `releases/latest/download/framely-release.json` source, checks query the repository Release list, filter strictly by channel, and choose the highest SemVer tag with a device archive and descriptor. Drafts, installer tags and releases missing either asset are skipped. No matching release is reported as an empty channel, including Preview-only repositories checked on Stable. The descriptor must match the selected tag, archive URL and size. Custom HTTPS descriptor URLs remain direct sources; their version must match the selected channel, so distributors need to configure the corresponding descriptor URL.
## SteamOS 更新后的恢复
## Recovery after SteamOS updates
安装器将整个管理目录保存在 `/home/.framely/state`,包括 `state.json`、更新源、日志、当前/上一发行链接、Steam 用户名和 Framely 账号 UID;`/var/lib/framely` 仅作兼容链接。旧安装会在停止服务后迁移。两份状态冲突时停止,不自动覆盖任何一份。
Management state resides at `/home/.framely/state`, including state, update source, logs, release links, Steam username and Framely UID. `/var/lib/framely` is a compatibility link. Old state migrates after writers stop; conflicting copies cause a stop rather than overwrite.
系统服务和账号仍依赖 SteamOS 系统配置,操作系统更新后可能需要手动修复。在系统配置可写时运行 `sudo bash /home/.framely/repair.sh`;无需重新下载发行包,恢复兼容链接、专用账号、服务文件和开机启动。修复先校验保留的发行,再使用当前发行的 `install.sh --repair`,不创建发行或改写上一版本记录。保存的账号 UID 若被占用或现有账号 UID 已变化则停止,避免错误地接管旧数据。系统只读时停止,不自动解除保护。
Accounts/services depend on OS configuration. When writable, `sudo bash /home/.framely/repair.sh` restores links, account, service files and startup from the retained, verified release without another download. It invokes the current release's `install.sh --repair` without creating releases or changing the previous-version record. UID conflicts or changes stop recovery. It never disables read-only protection automatically.
该机制不能恢复已被系统清除的 `/home` 数据,也不保证操作系统更新后无需人工操作。回滚到不支持修复模式的旧发行后,需要使用支持该模式的新发行包恢复安装。正式发布前应进行一次真实 SteamOS 更新,验证设置、插件数据、账号身份、服务恢复和 SteamVR 宿主兼容性。
Deleted `/home` data cannot be recovered. OS updates may require manual intervention. After rolling back to a release without repair support, use a newer supporting package. Before stable publication, validate actual OS-update recovery, state/data/UIDs/services and SteamVR compatibility.
## GitHub Actions 发布
## GitHub Actions
Framely 和桌面安装器保留在同一仓库,使用独立的版本号、标签和发布工作流:
Device and installer share the repository with independent versions/tags/workflows:
- Framely:版本由根 `Cargo.toml` 定义,标签为 `v<版本>`(当前 `v0.4.2-preview.6`);`.github/workflows/release.yml` 只构建 Frame Linux ARM64 发行,使用锁定的 CEF 并执行自动检查。
- 安装器:版本由 `installer/Cargo.toml` 定义,标签为 `installer-v<版本>`(当前 `installer-v0.4.1-preview.4`);`.github/workflows/installer-release.yml` 只构建 Linux x64/ARM64、Windows x64、macOS x64/ARM64 的原生安装器,使用锁定的 GPUI Kit。
- Device: root Cargo version, `v<version>` (currently `v0.6.0`), `.github/workflows/release.yml`, Linux ARM64 and pinned CEF.
- Installer: `installer/Cargo.toml`, `installer-v<version>` (currently `installer-v0.4.1-preview.10`), `.github/workflows/installer-release.yml`, Linux x64/ARM64, Windows x64, macOS Intel/Apple Silicon, pinned GPUI Kit.
两个版本不需要相同,也不需要同时发布。修改各自版本时同步对应的 `Cargo.lock`;安装器包名及 macOS 应用版本使用安装器版本。
Versions need not match or ship together. Update the relevant Cargo.lock with version changes. Installer package/macOS versions use the installer version.
两个工作流均缓存 Cargo 下载的依赖和已编译的依赖产物,按产品、系统、架构、Rust 工具链及依赖配置区分。安装器使用 `installer/target`;本体在 CI 使用 `target/cargo`,与单独缓存的 `target/cef` 分开,测试和发行打包共用同一 Cargo 目录。失败构建也会保存已完成的依赖编译。
普通分支推送不触发发行构建;只有对应产品的标签推送或手动运行会触发。缓存恢复、编译和缓存保存均在同一次构建内完成。GitHub 允许标签构建读取默认分支的缓存,不允许一个标签读取另一个标签的专属缓存;需要跨标签复用时,可手动在 `main` 运行一次对应工作流来生成默认分支缓存,该运行只生成构建产物,不发布 Release。首次构建、没有可访问的缓存或工具链变化后仍需重新编译,缓存命中情况见 “Cache Cargo dependencies and build artifacts” 步骤。
Both workflows cache dependencies/builds by product/platform/toolchain/configuration, including failed builds. Installer uses `installer/target`; device CI uses `target/cargo`, separate from `target/cef`, for tests and packaging. Branch pushes do not build releases; matching tags or manual runs do. Tags may restore default-branch caches, not another tag's private cache. A manual main run can prime cache and builds artifacts only. Cold builds/toolchain changes need compilation; inspect cache steps rather than assuming a hit.
```bash
# 提交并推送代码后,选择需要发布的产品
git tag v0.4.2-preview.6
git push origin v0.4.2-preview.6
# 独立发布安装器,不触发 Framely 构建
git tag installer-v0.4.1-preview.4
git push origin installer-v0.4.1-preview.4
# After committing and pushing the intended source:
git tag v0.6.0
git push origin v0.6.0
# Independent installer release:
git tag installer-v0.4.1-preview.10
git push origin installer-v0.4.1-preview.10
```
带 `-preview.N` 等预发布后缀的标签会发布为 GitHub Prerelease,不设置为 Latest。安装器 Release 始终设置为非 Latest;只有 Framely 正式 Release 设置为 Latest。因此设备安装入口和默认更新清单的 `releases/latest/download/...` 继续指向 Framely 本体。安装器读取发行列表时按本体包名筛选,不把 Linux ARM64 安装器误当成设备发行包。安装器下载应使用具体的 `installer-v<版本>` Release。
Prerelease suffixes create GitHub Prereleases without Latest. Installer releases are never Latest. Only stable device releases become Latest, keeping default installer/update URLs on the device product. The desktop installer filters device archive names and does not mistake ARM64 installer packages for device runtimes. Download desktop installers from their explicit installer tags.
只有标签触发会发布。各工作流在自己的构建全部成功后创建草稿 Release,上传本产品产物及外部 `SHA256SUMS`,最后公开草稿。Framely Release 额外包含 `bootstrap.py`、入口脚本和更新清单;安装器 Release 只包含五个平台的安装器包和校验文件。失败的草稿不作为最新稳定版提供下载。手动触发用于验证,仅保留 Actions artifacts。
Only tags publish. After every product build succeeds, publication creates a draft, uploads assets/checksums, then makes it public. Failed drafts are not stable download targets. Manual runs leave Actions artifacts only.
Framely 本体 Release 附件用途:`framely-*-linux-arm64.tar.gz` 为设备运行包;`framely-release.json` 为内置更新功能的版本清单;`install.sh` 是命令行入口,调用 `bootstrap.py` 完成下载、校验和维护;`SHA256SUMS` 为附件校验清单。桌面安装器只需自动下载运行包和校验清单,用户无需手动下载脚本。安装器的五个平台包发布在独立的安装器 Release 中。
Device attachments include the core archive without CEF, the complete `*-offline-linux-arm64.tar.gz` archive, a separate `framely-cef-*` runtime archive, `framely-release.json`, `framely-cef.json`, `bootstrap.py`, `install.sh` and `SHA256SUMS`. The update descriptor always targets the core archive. First installation selects the complete offline archive. CEF is verified and shared under `/home/.framely/cef/<runtime-id>`; missing or newly required runtimes download separately, and previous runtimes remain available for rollback. See [package selection and runtime recovery](user-guide/installation.md#release-packages-and-cef). Installer releases have five platform packages and checksums only. Desktop installers download archive/checksums without user-managed scripts.
外部 `SHA256SUMS` 包含压缩包哈希,校验传输内容;包内同名文件校验解压后的载荷。哈希不能独立证明作者身份,在线安装依赖指定 GitHub 仓库与 HTTPS;本地安装依赖用户提供的可信包与校验文件。下载遵循 HTTPS 重定向,不允许降级。
External checksums cover downloaded archives; internal checksums cover extracted payload. Neither independently proves author identity. Online installation trusts the chosen repository/HTTPS, local installation the supplied archive/checksums. Redirects never downgrade HTTPS.
入口脚本从 Release 下载设备引擎;在线安装默认选择最新正式版,也支持 `--version TAG`。指定标签时,入口从该 Release 下载 `bootstrap.py`,引擎再选择同标签运行包;入口脚本本身来自用户下载或 curl 指定的位置,可在仅有 Preview、尚无正式版时安装预发布版本。本地使用 `python3 tools/bootstrap.py install --archive /path/package.tar.gz --checksums /path/SHA256SUMS`。更新要求已经安装;指定已安装版本会修复服务,指定其他版本会安装目标发行,保留状态。
The entry fetches the release engine. Default is latest stable; `--version TAG` chooses that Release for both engine and package and works for Preview-only repositories. Locally run `python3 tools/bootstrap.py install --archive /path/package.tar.gz --checksums /path/SHA256SUMS`. Updating requires existing installation; selecting the same installed release repairs it, another version installs while retaining state.
安装器将官方更新清单地址预配置到尚未配置更新源的设备;既有更新源保留。之后可继续通过 Framely 内置更新界面更新。
Installation initializes the official update descriptor URL only if no source is configured, preserving existing sources for future in-app updates.
## 统一卸载
## Unified uninstallation
脚本和桌面安装器均只有一个卸载选项。`uninstall.sh` 先停止会话及下载工作,再通过 root 专用 `prepare-uninstall --approve` 请求核心服务:持久停用所有插件、按依赖顺序停止插件、执行各插件 `onUninstall`,移除插件包。全部完成后才取消 Framely 自启、停止核心并移除程序。失败时保留本体并恢复会话,插件保持停用,允许处理原因后重试;不支持跳过失败插件强制卸载本体。
Scripts and desktop UI expose one uninstall operation. It stops session/downloads, then calls root-only `prepare-uninstall --approve`: persistently disable plugins, stop them in dependency order, run uninstall hooks, remove payloads. Only complete success removes services/core/runtime. Failure retains Framely, restores session access and leaves plugins disabled for troubleshooting/retry. There is no skip-failed-plugin manager uninstall.
协议尚未确认或已撤回也允许 root 通过此专用维护接口卸载;普通会话及插件界面不开放该接口。保存的设置、插件数据和系统账号保留,不承诺清除外部副作用。旧发行没有该接口时需先更新。
Root maintenance can uninstall before consent or after revocation; pages do not expose the maintenance method. Settings/data/accounts remain, and external side effects are not guaranteed reversible. Old releases without this endpoint need updating first.
+11 -11
View File
@@ -1,26 +1,26 @@
# 插件源订阅(Framely 0.4)
# Plugin source subscriptions
[English](en/source-subscriptions.md)
[简体中文](zh-CN/source-subscriptions.md)
在管理窗口“插件源 → 源订阅”粘贴 HTTPS JSON 地址,预览后确认添加:
In Sources → Source subscriptions, paste an HTTPS JSON URL, preview and confirm:
```json
{
"schemaVersion": 1,
"name": "Framely 社区源",
"name": "Community sources",
"sources": [
{"id":"stable", "name":"社区稳定版", "url":"https://example.org/stable/catalog.json"},
{"id":"testing", "name":"社区测试版", "url":"https://example.org/testing/catalog.json"}
{"id":"stable", "name":"Stable", "url":"https://example.org/stable/catalog.json"},
{"id":"testing", "name":"Testing", "url":"https://example.org/testing/catalog.json"}
]
}
```
每个源 id 在订阅内唯一且稳定,用于识别地址变更。禁止重复 URL、嵌套订阅、HTTP、带认证信息的 URL,最多 100 个源、512 KiB;每台设备最多 20 个订阅、200 个插件源。目录、包、图片继续由各源或作者托管,订阅只聚合目录地址。
Source IDs must remain stable and unique within a subscription. Duplicate URLs, nested subscriptions, HTTP or credential-bearing URLs are forbidden. Limits: 100 sources/512 KiB per subscription, 20 subscriptions/200 sources per device. Subscriptions aggregate catalog URLs, not packages or images.
默认每天自动刷新,也可关闭自动刷新或立即刷新。自动检查在 Framely 会话运行期间进行,启动后检查到期项;支持 ETag/Last-Modified 和最多五次 HTTPS 重定向。离线/失败保留已持久化的上次成功源列表,记录错误,按一分钟起的指数退避重试,最多一天。
Automatic refresh defaults to daily and can be disabled or triggered manually. The running session checks due entries at startup, uses ETag/Last-Modified, and follows at most five HTTPS redirects. Failures preserve persisted source lists and retry with exponential backoff from one minute up to one day.
新增源自动纳入;名称自动更新。相同 id 的 URL 改变时保留旧地址,显示待确认变更,确认后才采用新地址。刷新订阅后同时刷新插件目录。目录缓存沿用会话内缓存,重启后的离线商店不保证有目录缓存。
New sources join automatically; names update. URL changes keep the old address until confirmed. Refreshing also refreshes catalogs. Catalog caches are session-local; offline catalogs after restart are not guaranteed.
目录 URL 规范化后去重,一个源可由多个订阅和手动添加共同引用。删除订阅或移除订阅中的源只移除对应引用;没有任何引用才从源列表移除。已安装插件、来源记录和数据保留,不静默切换来源。
Canonical URLs deduplicate references from subscriptions and manual additions. Removing a subscription/source removes only its reference; sources disappear only without references. Installed plugins, origins and data remain; origins do not silently switch.
可在插件源列表单独停用源,刷新不会重新开启;即使移除后又加入同一 URL,也保留停用偏好。订阅源的 URL 在待确认变更中管理。刷新只更新源列表、商店资料和更新提示,不自动安装、更新或启用插件。
Disabled preferences persist across refresh/removal/readdition. Manage subscription URL changes through pending changes. Refreshing changes source metadata and update hints, never automatically installs, updates or enables plugins.
+182
View File
@@ -0,0 +1,182 @@
# 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.
L2/R2 digital button activation is adjustable in **APK Manager → Settings**, from 1% to 100%, with an 80% default. Both triggers use this threshold with either Steam Input or Frame direct input. Analog trigger travel is unaffected. Saving applies to running bridges immediately; release occurs five percentage points below the selected threshold (at 0% for thresholds below 5%).
## Per-app graphics compatibility
Under **Manage app → Advanced settings**, **Framebuffer compatibility fix** is off by default. Enable it only for games that play sound but show a black screen (tested with Rock Kingdom on the current Mesa/Zink driver). Restart the app after changing it. The GLES layer validates framebuffer status after texture attachment, only in the selected application; other apps, system drivers, game files and saved data remain unchanged. Turning it off restores the normal rendering path on the next app launch. It is a targeted workaround, not a general graphics or performance enhancement.
+60 -16
View File
@@ -1,29 +1,73 @@
# 基本使用
# Basic usage
[English](../en/user-guide/basic-usage.md)
[简体中文](../zh-CN/user-guide/basic-usage.md)
[文档首页](../README.md) · [安装指南](installation.md)
[Documentation](../README.md) · [Installation](installation.md)
## 快捷菜单与管理窗口
## Quick menu and manager
在 SteamVR Dashboard 点击 Framely Dock 图标打开快捷菜单。首次访问需阅读并同意协议及隐私声明;未同意时插件不会自动启动。
Click Framely in the SteamVR Dashboard Dock. First use requires accepting the terms and privacy statement; plugins do not automatically start before consent.
- **常用**:打开收藏的插件快捷页。
- **已安装**:查看本机插件,进入插件页面。
- **设置**:语言、安全模式和“管理插件”入口。
- **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 Settings → Updates page. Install language files and download the language template from the manager’s Settings page.
“管理插件”打开独立大窗口,左侧导航进入插件、商店、插件源、设置和关于。安装、更新及来源管理在这里完成;电脑或手机也可使用[网络管理面板](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
在插件列表启用、停用或收藏插件。启用表示允许使用;默认后端按需启动,只有声明 `autostart` 的插件会常驻。关闭插件窗口通常不会停用后台功能。依赖不满足或有冲突时,界面会给出原因,并在变更前显示受影响插件。
Enable, disable or favorite plugins in the list. Enabled means available for use; backends normally start on demand. Only plugins declaring `autostart` remain resident after startup. Closing a plugin window generally does not disable its backend. Dependency or conflict problems are explained, and affected plugins are shown before changes.
带 Dock 图标的独立窗口由 SteamVR 提供关闭控件;临时窗口可能在切换界面时销毁。不同插件的 UI 和功能由各自开发者决定。
Dock windows use SteamVR close controls. Temporary windows may be destroyed when switching views. Individual plugin interfaces and behavior are maintained by their developers.
## 设置与诊断
## Settings and diagnostics
设置中可修改语言、网络面板及代理。HTTP 代理和 GitHub 代理各有开关,保存地址不会自动启用代理。
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. 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.
日志排查命令见[安装指南](installation.md#修复与日志)。界面能打开不代表所有插件都正常;先逐个启用,确认运行身份与来源可信。
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 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.
Notification popups display an auto-close countdown when the sender sets a duration. Closing a popup keeps any saved inbox copy. Remove a saved message from Notifications with its trash button. Action buttons close and remove messages by default; senders can configure different behavior. Ordinary notifications are not saved unless the sender opts in, except when popups are disabled.
The **Allow notifications** switch at the top of Notifications controls all floating popups. When off, new notifications are saved in the inbox even if the sender did not request it; active popups are also moved to the inbox. Turning popups back on does not replay old messages.
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.
+47 -35
View File
@@ -1,54 +1,66 @@
# 安装、更新、修复与卸载
# Install, update, repair and uninstall
[English](../en/user-guide/installation.md)
[简体中文](../zh-CN/user-guide/installation.md)
[文档首页](../README.md) · [下一步:基本使用](basic-usage.md)
[Documentation](../README.md) · [Next: basic usage](basic-usage.md)
## 安装前
## Before installation
目标设备为 Linux ARM64 Steam Frame。当前开发基线为 SteamOS VR 0.4.2、SteamVR build 20260928.6175029;其他系统版本需验证。运行包自带 CEF,设备使用时无需安装 Node.js 或 Rust。
The target is Linux ARM64 Steam Frame. The development baseline is SteamOS VR 0.4.2 and SteamVR build 20260928.6175029; other versions need validation. The complete offline installation package includes CEF, so users do not need Node.js or Rust on the device.
电脑与 Frame 连接同一网络,在 Frame 开启开发者模式并启用 SSH,准备 Steam 用户 `steamos` 的登录密码。安装会使用 sudo 创建账号、systemd 服务和发行目录;请核对 SSH 指纹。安装器不会自动解除 SteamOS 只读保护;实际所需目录不可写时会停止。
Connect your computer and Frame to the same network. Enable developer mode and SSH on Frame, and prepare the `steamos` account password. Verify the SSH fingerprint. Installation uses sudo to create an account, systemd services and release directories. It does not automatically disable SteamOS read-only protection; it stops if required directories cannot be written.
## 方式一:电脑端安装器
## Option 1: desktop installer
1. 从 [Framely Releases](https://github.com/SteamFramelyHomebrew/framely/releases) 的 `installer-v<版本>` 下载适合电脑的安装器。Linux 为 tar.gz,Windows 为 EXE ZIP,macOS 为应用 ZIP。
2. 解压并运行,扫描设备或手动填写设备 IP 与 SSH 端口。
3. 核对指纹,填写 `steamos` 和密码,连接后选择 Framely 本体发行版本。
4. 如果要安装 Preview,开启显示测试版;安装器版本与设备版版本相互独立。
5. 在“安装与维护”确认设备、目标版本及操作,等待完成。也可选择本地运行包和对应的外部 `SHA256SUMS`。
1. Download the appropriate installer from an `installer-v<version>` entry in [Releases](https://github.com/SteamFramelyHomebrew/framely/releases). Linux uses tar.gz, Windows an EXE ZIP, and macOS an application ZIP.
2. Extract and run it. Scan for the device or enter its IP and SSH port.
3. Verify the fingerprint, enter `steamos` and its password, connect, and select a Framely device release.
4. Enable testing releases to select a Preview. Installer and device versions are independent.
5. Confirm the device, version and operation on the maintenance page. Alternatively, select a local device archive and its external `SHA256SUMS`.
Linux 用户可在安装器解压目录执行 `bash install-desktop-entry.sh`,把带 Framely 图标的入口添加到当前用户的应用菜单。入口指向解压目录;移动目录后需重新执行脚本。
On Linux, run `bash install-desktop-entry.sh` from the extracted installer directory to add an entry with the Framely icon to your user application menu. The entry points to that directory; run the script again after moving it.
安装器会校验下载内容,并在设备端再次校验。密码不保存到配置文件。连接后仍需在实际设备上观察 Framely 的启动和显示。
Downloads are checked locally and again on the device. Passwords are not saved in configuration. Observe startup and rendering on Frame after installation.
## 方式二:在 Frame 的 SSH 终端安装
## Option 2: install from Frame's SSH terminal
以下命令在 **Frame 上** 执行。默认安装最新正式版:
Run these commands **on Frame**. To install the latest stable release:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
```
指定 Preview 或其他标签:
To select a Preview or another tag:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3
```
将示例标签换成 Releases 中实际存在的本体标签。指定标签时从该 Release 下载引擎和包,不要求已有正式版;不指定标签时使用最新正式版。终端会按需请求 sudo 密码。
Replace the example with an existing device release tag. An explicit tag selects the engine and package from that Release and works without a stable release. Without a tag, the latest stable release is selected. Enter the sudo password when prompted.
## 方式三:本地发行包
## Option 3: local archive
下载设备运行包 `framely-<版本及构建号>-linux-arm64.tar.gz`、外部 `SHA256SUMS` 和同一 Release 的 `bootstrap.py`,放入 Frame 的同一目录:
Download `framely-<version-and-build>-offline-linux-arm64.tar.gz`, the external `SHA256SUMS`, and `bootstrap.py` from the same Release. Place them together on Frame:
```bash
python3 bootstrap.py install --archive "./framely-<版本及构建号>-linux-arm64.tar.gz" --checksums ./SHA256SUMS
python3 bootstrap.py install --archive "./framely-<version-and-build>-offline-linux-arm64.tar.gz" --checksums ./SHA256SUMS
```
尖括号是占位符,执行前替换为真实文件名。引擎校验后在 `/home` 暂存、解压并检查包内哈希,避免耗尽设备的 `/tmp`。
Angle brackets are placeholders; substitute the actual filename. The engine verifies, stages and extracts under `/home`, then checks internal hashes, avoiding the device's limited `/tmp`.
## 验证安装
## Release packages and CEF
Each device release provides three archives:
- `framely-<version-and-build>-offline-linux-arm64.tar.gz`: complete offline package including CEF; always used for first installation.
- `framely-<version-and-build>-linux-arm64.tar.gz`: core package without CEF; selected automatically for updates by the desktop installer, SSH engine and in-app updater.
- `framely-cef-<runtime-id>-linux-arm64.tar.gz`: separate CEF runtime, available as an online download. `framely-cef.json` provides its URL, size and SHA256.
CEF is stored under `/home/.framely/cef/<runtime-id>`. Updates reuse the exact verified runtime; matching CEF files from older full installations migrate automatically. If the required runtime is missing or a release changes CEF, the core installation downloads the separate matching CEF archive over HTTPS and verifies its size, SHA256 and internal checksums. A complete offline package supplies the runtime without downloading it.
Each release refers to its own CEF version, so rollback retains the previous runtime. Repair verifies it; uninstall removes the CEF cache with the programs. Local first installation must use the offline package. Local updates can use the core package when its required CEF is already installed; otherwise runtime recovery needs network access.
## Verify installation
```bash
systemctl is-active framely.service framely-session.service
@@ -56,43 +68,43 @@ systemctl is-active framely.service framely-session.service
sudo /var/lib/framely/current/bin/framely status
```
两个服务正常应显示 `active`。打开 SteamVR Dashboard,在 Dock 找到 Framely;首次使用需阅读用户协议和隐私声明。之后按[插件安装教程](plugins.md)添加第一个插件。
Both services should be `active`. Open SteamVR Dashboard and find Framely in the Dock. Read and accept the terms and privacy statement before managing plugins. Continue with the [plugin installation guide](plugins.md).
## 更新与回滚
## Update and rollback
已配置更新服务时,从管理窗口“关于”检查、下载并确认安装。也可以用桌面安装器,或在 Frame 执行:
When an update source is configured, choose **Stable** or **Testing** in **About → Framely update**, then check, download and confirm installation. Stable checks stable releases only; Testing checks prereleases such as Preview, Beta and RC. The channel preference persists on the device. Switching channels clears the previous candidate and download, so check and download again before installation. Alternatively, use the desktop installer or run on Frame:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- update --version v0.4.2-preview.3
```
更新保留插件、设置和数据,并保留前一个发行用于回滚;只重启 Framely。Preview 更新需要明确指定标签或本地包,默认正式版更新地址不会自动选择 Preview。
Updates preserve plugins, settings and data, retain the previous release, and restart Framely only. The default channel is Stable; choose Testing for in-app Preview updates. Command-line Preview updates still require an explicit tag or local package. Switching back to Stable can select an older version; the UI identifies this before installation. Rollback does not migrate newer plugin data formats.
需要回滚时,从“关于”选择上一版本,或执行:
Choose rollback in About, or run:
```bash
sudo bash /var/lib/framely/current/rollback.sh
```
回滚本体保留插件数据,但不保证将新版本的数据格式转换为旧格式。
Rollback preserves plugin data but does not guarantee conversion of newer data formats to older ones.
## 修复与日志
## Repair and logs
SteamOS 更新可能重置账号和系统服务。管理数据保存在 `/home/.framely/state`,`/var/lib/framely` 为兼容入口。在系统配置可写且 `/home` 数据仍存在时执行:
SteamOS updates may reset system accounts and services. State persists under `/home/.framely/state`; `/var/lib/framely` is a compatibility entry. If system configuration is writable and `/home` remains intact:
```bash
sudo bash /home/.framely/repair.sh
sudo journalctl -u framely -u framely-session --no-pager -n 100
```
修复会使用已保留的发行恢复账号及服务;UID 冲突时停止。它不能找回已删除的 `/home` 数据,SteamOS 更新后的恢复仍需实机验证。
Repair restores accounts and services from the retained release and stops on UID conflicts. It cannot restore deleted `/home` data. Recovery after SteamOS updates still requires device validation.
## 卸载
## Uninstall
桌面安装器“安装与维护”提供卸载,也可直接执行:
Use the desktop maintenance page or run:
```bash
sudo bash /var/lib/framely/current/uninstall.sh
```
卸载先停用并卸载全部插件、执行其卸载钩子,成功后再移除 Framely 程序和服务。某个插件清理失败会保留 Framely并报错,处理后重试。已保存的设置、插件数据和专用账号保留;不承诺自动清除第三方插件在其他位置造成的修改。
Uninstallation disables and uninstalls every plugin, including uninstall hooks, before removing Framely programs and services. Failed plugin cleanup retains Framely and reports an error; resolve it and retry. Settings, plugin data and the dedicated account remain. External changes made by third-party plugins cannot always be automatically undone.
+20 -18
View File
@@ -1,37 +1,39 @@
# 网络管理面板
# Network management panel
[English](../en/user-guide/network-panel.md)
[简体中文](../zh-CN/user-guide/network-panel.md)
[文档首页](../README.md) · [插件安装](plugins.md)
[Documentation](../README.md) · [Plugin installation](plugins.md)
## 找到地址
## Find the address
网络面板默认开启,监听 IPv4 端口 `15915`,不依赖 SteamVR 正在运行。手机/电脑与 Frame 连接同一网络,在浏览器打开:
The panel is enabled by default on IPv4 port `15915` and does not require SteamVR to run. Connect your phone/computer to Frame's network and open:
```text
http://设备IP:15915
http://DEVICE_IP:15915
```
管理窗口“设置 → 网络管理面板”显示设备当前 IP 和完整地址,也可在桌面安装器连接设备后使用网络面板入口。没有检测到 IP 时先检查 Wi-Fi/网线;端口被占用时设置中会提示错误。
Settings → Network panel shows current IP addresses and full URLs. The desktop installer also provides an entry after connecting. If no IP is detected, check Wi-Fi/Ethernet. Port conflicts are reported in settings.
## 首次设置密码
## First password setup
尚未配置访问密码时,首次访问只显示设置页面,不能进入管理 API。输入至少 8 个字符的密码并再次确认,保存后使用该密码登录。密码设置可以先于用户协议确认;登录后仍需阅读并同意协议才能管理插件。
With no configured password, first access shows setup only and does not expose management APIs. Enter at least eight characters and confirm the password, save, then log in. Password setup may precede terms acceptance; consent is still required to manage plugins.
密码以带随机盐的 PBKDF2 哈希保存,重启保留,不会在界面中回显。首次设置入口不能覆盖已有密码。网络面板密码和设备 SSH/sudo 密码相互独立。
A randomly salted PBKDF2 hash is stored, survives reboot, and is not displayed by the UI. Unauthenticated setup cannot overwrite an existing password. The panel password is independent of SSH/sudo credentials.
后续在已登录的设置页面修改密码,或从设备原生界面修改。忘记密码时优先从 Frame 的原生管理窗口设置新密码。已有版本的密码保留;用户已明确关闭密码验证且已有密码记录的配置保持其选择。网络面板使用 HTTP,请只在可信网络使用,不要把端口直接转发到公网。
Change passwords from authenticated settings or the device's native manager. If forgotten, prefer changing it from Frame's native window. Existing passwords are retained; a previously configured password with verification explicitly disabled retains that choice. The panel uses HTTP: use a trusted network and do not forward the port directly to the public internet.
## 可以做什么
## Available operations
登录后可以管理来源和订阅、浏览商店、导入本地插件包、确认安装、启停插件、修改设置及检查本体更新。插件后端始终运行在 Frame,上传本地包只是从手机/电脑把文件传到设备。
Manage sources and subscriptions, browse the plugin library, upload local packages, confirm installation, enable/disable plugins, change settings and check device updates. Backends always run on Frame; uploading a file transfers it from your phone/computer.
VR 窗口、手柄振动和 SteamVR 虚拟键盘需要头显端验收;浏览器无法替代这些设备交互。部分外部链接由设备默认浏览器打开。
VR windows, controller vibration and SteamVR keyboard need headset validation; a browser cannot replace those interactions. Some external links open in the device's default browser.
## 更改端口、关闭与登录过期
## Port changes, shutdown and expired sessions
在“设置 → 网络管理面板”修改端口或开关,保存后生效。修改认证设置或密码会使旧登录会话失效;端口改变后访问新的地址,关闭面板后网络连接断开。本机原生界面不因此关闭。
Change the port or switch in Settings → Network panel. Password/authentication changes invalidate old sessions; use the new address after a port change. Turning the panel off disconnects web access without closing the native manager.
会话服务重启也会使旧登录失效,需要重新登录。保存完全相同的设置不会撤销当前会话。错误密码验证有速率限制,提示尝试过多时稍后再试。
Restarting the session service also invalidates old logins. Saving identical settings retains the session. Incorrect password checks are rate-limited; retry later when asked.
无法访问时检查设备 IP 是否变化、两台设备是否处于可互通的网络、面板是否开启以及端口是否正确。设置/密码保存在 `/home/.framely/state`,卸载本体保留这些状态,重装后可能仍需原密码。
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.
+31 -31
View File
@@ -1,56 +1,56 @@
# 安装与管理插件
# Install and manage plugins
[English](../en/user-guide/plugins.md)
[简体中文](../zh-CN/user-guide/plugins.md)
[文档首页](../README.md) · [网络面板](network-panel.md)
[Documentation](../README.md) · [Network panel](network-panel.md)
## 从商店安装
## Install from the plugin library
1. 打开管理窗口“商店”。当前代码首次初始化加入社区 stable/testing 来源;来源内容取决于服务和设备配置。没有目录或插件时,进入“插件源”添加开发者提供的完整 HTTPS `catalog.json` 地址。
2. 可按关键词、标签、来源或安装状态筛选。
3. 打开详情,查看作者、介绍、更新记录、运行用户和依赖。默认显示推荐版本,历史版本会按需加载。
4. 点击安装或检查所选版本。下载、校验和依赖解析完成后,阅读确认页。
5. 检查包内实际运行用户以及依赖带来的 root 权限,确认后安装。安装后在插件列表启用或打开。
1. Open **Plugin library** in the manager. Current code initializes community stable/testing sources; availability depends on the actual service and device configuration. If no catalog is available, add a developer's complete HTTPS `catalog.json` URL in Sources.
2. Filter by keywords, tags, source or installation state.
3. Open details and review author, description, changes, runtime user and dependencies. The recommended version is shown first; history loads on demand.
4. Install or inspect the selected version. Read the confirmation after download, verification and dependency resolution.
5. Check actual package runtime users, including any root dependencies, then confirm. Enable or open the plugin from the installed list.
商店提供的运行用户只是目录资料,最终确认以下载包内声明为准。`steamos` 使用 Steam 会话用户,`root` 可修改系统和设备设置。包哈希用于校验内容,不等于对作者身份或安全性的担保。
Catalog runtime users are informational; final confirmation uses the downloaded package. `steamos` runs as the Steam session user; `root` can change system and device settings. Hashes check content, not developer identity or safety.
## 添加源与订阅
## Sources and subscriptions
单个目录地址:在“插件源”添加名称和 `https://.../catalog.json`,测试连接后保存。
For one catalog, add a name and `https://.../catalog.json` URL in Sources, test the connection, then save.
多个源的订阅:在“源订阅”粘贴开发者提供的订阅 JSON 地址,预览所含来源后确认添加。它和单个目录不是同一种文件。订阅刷新仅更新来源和商店资料,不自动安装或更新插件。
For multiple catalogs, add a subscription JSON URL in Source subscriptions, preview its sources, then confirm. A subscription is different from a catalog. Refreshing it changes source lists and metadata, not installed plugins.
停用或删除来源不会自动卸载已安装插件;订阅管理的 URL 变更需另行确认。格式与刷新行为见[源订阅参考](../source-subscriptions.md)。
Disabling or deleting a source does not uninstall its plugins. Subscription URL changes require confirmation. See the [subscription reference](../source-subscriptions.md).
## 导入本地包或包 URL
## Import a file or package URL
插件包扩展名为 `.framely`,无需自行解压。进入管理窗口“插件”,打开导入入口:
Packages use the `.framely` extension and need no manual extraction. Open import in the manager's Plugins page:
- **本地文件**:在手机/电脑网络面板选择本机下载的 `.framely` 文件;文件上传后校验。
- **包 URL**:粘贴作者提供的固定版本 HTTPS 下载地址,等待下载和检查。
- **Local file**: select a downloaded `.framely` file on your phone/computer in the web panel; it uploads and is verified.
- **Package URL**: paste a fixed-version HTTPS download URL from the author and wait for verification.
两种方式都需要阅读安装确认,涉及运行用户变更时另行确认。导入的是插件包;Framely 本体 tar.gz 和普通 ZIP 不能作为插件安装。
Both require reviewing confirmation, with an additional confirmation for changed runtime users. Device tar.gz archives and ordinary ZIP files are not plugin packages.
在 Frame 的 SSH 终端也可安装:
You can also install from Frame's SSH terminal:
```bash
sudo /var/lib/framely/current/bin/framely install ./plugin.framely --approve
```
只有在确认旧版到新版确实需要改变运行用户时才增加 `--approve-run-as`。命令行不会代替你判断来源是否可信。
Add `--approve-run-as` only when you have verified that changing the runtime user is intended. CLI approval does not assess the source's trustworthiness.
## 更新、选择旧版与卸载
## Updates, older versions and removal
商店提示“可更新”时进入详情,查看变化后按安装确认流程更新。需要旧版时,在详情选择历史版本再检查;换来源也会明确提示。设置和收藏通常保留,但运行用户改变会使用另一份数据目录,不自动迁移旧身份的数据。
Open details for plugins marked updatable, review changes and confirm. Select history to inspect an older version. Switching sources is explicitly disclosed. Settings and favorites are generally retained; a different runtime user uses a different data directory and does not automatically migrate the old one.
从插件管理弹窗卸载。卸载钩子负责清理该插件的外部资源,保存的数据保留;不要直接删除系统中的插件目录。停用只停止使用,不卸载程序和数据。
Uninstall through the management dialog. Hooks handle external cleanup and saved data is retained. Do not remove system plugin directories manually. Disabling stops use without removing programs or data.
## 常见问题
## Troubleshooting
| 现象 | 处理 |
| Symptom | Action |
| --- | --- |
| 商店空白 | 检查是否添加并启用了来源、连接能否成功、筛选是否过窄 |
| 下载或校验失败 | 检查网络和包地址,重新下载;不要跳过哈希校验 |
| 历史版本不可用 | 来源可能没有历史文件,可先安装最新版或导入可信旧包 |
| 插件无法启用 | 查看依赖、冲突和错误说明,确认其他必要插件已安装 |
| 插件反复崩溃 | 停用后检查日志,必要时进入安全模式,再向插件作者反馈 |
| Empty plugin library | Check enabled sources, connectivity and filters |
| Download/hash failure | Check network and URL; download again without bypassing verification |
| Missing history | The source may lack its history file; use latest or a trusted local old package |
| Cannot enable | Read dependency/conflict errors and install required plugins |
| Repeated crashes | Disable, inspect logs, use safe mode if needed, and report to the author |
+75
View File
@@ -0,0 +1,75 @@
# 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 not scanned in the background.
**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. Full previews and downloads read content after explicit selection; icon views read only visible media to generate lazy thumbnails. There is no background directory media scan. Test media are generated fixtures; development and validation do not read or upload private 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.
File sorting (name, size or modification time, including ascending/descending order) is remembered separately for each folder. The **View** menu switches between a list and small, medium or large icons; this choice applies to all folders. Preferences are saved on Frame and restored when reopening the panel in a browser or headset. Icon views lazily generate thumbnails for visible images and videos using browser decoding, with at most two concurrent jobs. Videos use a frame around one second. Thumbnails are cached in bounded memory while the page remains open and refreshed when file metadata changes. Scrolling out of view cancels pending work; unsupported formats or decoding failures retain the file-type icon. No FFmpeg or whole-folder media scan is used.
Clicking an image or video opens a full-panel viewer. Use the wheel or zoom buttons to zoom, drag the content to pan, and use Previous/Next or the arrow keys to browse the image/video files in the current displayed list. Fit to window resets the view; Esc closes it. Video playback controls remain available. If browser decoding fails, download the file from the viewer. UTF-8 text up to 5 MiB still opens in the editor; binary files, unsupported encodings and larger files download directly when clicked.
The viewer controls are grouped in a floating capsule centered at the bottom, with the filename below. Clicking blank space closes the viewer; clicking media or controls and dragging to pan do not.
+42
View File
@@ -0,0 +1,42 @@
# Framely 文档
[English](../README.md)
Framely 是 Steam Frame 的插件管理器,包含设备端服务、SteamVR 界面、网络管理面板和电脑端安装器。
## 用户指南
按顺序阅读即可完成安装并使用第一个插件。
1. [安装、更新、修复与卸载](user-guide/installation.md):桌面安装器、SSH、Preview、本地包、回滚。
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):用户终端会话、文件操作、回收站、传输与预览。
## 插件开发与发布
- [完整流程](developer-guide/README.md):生成项目 → 浏览器预览 → 后端 → 打包 → 实机测试 → 发布。
- [SDK API](developer-guide/sdk.md) · [Manifest 配置说明](developer-guide/manifest.md) · [生命周期](plugin-lifecycle.md)
- [发布插件与插件源](developer-guide/publishing.md):GitHub 默认地址生成、自定义地址与哈希、目录历史、数据库登记。
- [可用插件模板](../../templates/plugin/README.zh-CN.md):React + Python,脚手架与仓库内编辑两种使用方式。
- [功能展示插件](../../examples/showcase/README.zh-CN.md):更多 UI 和设备交互示例。
## 技术参考
| 参考 | 内容 |
| --- | --- |
| [清单、SDK 与后端协议](plugin-development.md) | Manifest 字段、窗口、通知、JSON RPC、打包规则 |
| [生命周期](plugin-lifecycle.md) | 安装、更新、启动、停止、卸载及恢复钩子 |
| [依赖与冲突](plugin-relationships.md) | 版本范围、来源选择、可选依赖、独占资源 |
| [源订阅格式](source-subscriptions.md) | JSON 格式、刷新、地址变更及去重 |
| [语言与翻译](localization.md) | 语言包、文案键、社区翻译 |
## 维护者资料
- [Framely 发行与更新机制](releases.md)
- [电脑端安装器构建](../../installer/README.zh-CN.md)
- [空间启动台](launcher.md)
- [启动台操作与本体兼容](developer-guide/launcher.md)
+88
View File
@@ -0,0 +1,88 @@
# 插件开发到发布:完整流程
[English](../../developer-guide/README.md)
[文档首页](../README.md) · [发布指南](publishing.md)
## 1. 准备开发环境
开发机准备 Git、Node.js 22、npm;发布指南中的临时清单脚本还需要 Python 3。本体 CLI 使用 Linux 专用接口,源码打包命令需在安装 Rust 的 Linux/WSL 环境执行,不能直接在 Windows/macOS 原生编译本体。也可将清单和 payload 拷到 Frame,使用已安装的 CLI 打包。设备端无需 Node.js/Rust,Python 后端依赖设备的 Python 3。开发机可以用于界面预览和打包,VR 交互必须在 Frame 验证。
```bash
git clone https://github.com/SteamFramelyHomebrew/framely.git
cd framely
node tools/plugin-dev.mjs init ../my-plugin yourname.my-plugin
cd ../my-plugin
npm install
npm run dev
```
这里的 `yourname.my-plugin` 是示例 ID,发布前换成你自己的稳定命名空间。脚手架拒绝覆盖已有目录,复制 SDK 和构建工具,生成后不依赖原 Framely 仓库的位置。将生成项目放入自己的 Git 仓库,并提交 `package-lock.json` 和 vendored SDK;不要提交 `node_modules/`、`payload/`、发行包和密码。
## 2. 认识模板
| 文件 | 用途 |
| --- | --- |
| `manifest.json` | ID、名称、版本、运行用户、页面、生命周期、依赖 |
| `page.tsx` | React 快捷页和独立窗口 |
| `backend.py` | Python 后端及数据保存 |
| `vendor/framely-sdk/` | UI、桥接接口和 Python 协议辅助库 |
| `dev.mjs` | 构建和本地预览工具 |
| `LICENSE` | AGPLv3 许可证全文 |
模板的“读取/保存”使用 `settings.get` / `settings.set`,内容保存在后端的 `FRAMELY_DATA_DIR/settings.json`。它还演示打开 `main` 窗口、发送通知、启动/停止和安装/更新/卸载回调。默认身份 `steamos`,默认按需启动。
## 3. 修改清单与界面
先修改 `manifest.json` 中的 ID、作者、名称、描述、版本、标签和 `changelog`。使用完整 SemVer,例如 `0.1.0`、`0.2.0-preview.1`;已发布版本不覆盖。
`ui.quickPage` 和 `ui.windows.main.entry` 指向构建后的 `page.js`。页面通过 `registerPlugin({QuickPage, WindowPage})` 注册。窗口 key 必须与清单一致。`files` 留空,打包时自动计算哈希。
在浏览器打开 `http://127.0.0.1:5173`;修改页面后自动重载。预览只模拟窗口和通知,不启动 Python 后端,不拥有 Frame 权限;读取/保存按钮在预览中报出后端不可用是正常情况。不要据此声称设备功能已验收。
UI 与后端 API 见 [SDK 文档](sdk.md),字段、默认值和范围见 [Manifest 配置](manifest.md);窗口与插件库资料补充见[插件开发参考](../plugin-development.md)。
## 4. 实现后端与生命周期
后端 stdin/stdout 使用逐行 JSON RPC;stdout 仅输出协议,调试日志输出 stderr。Python 模板使用 `framely.serve` 处理请求、错误和生命周期。修改业务逻辑时校验参数长度与类型,并返回能由 JSON 序列化的结果。
写数据使用 `FRAMELY_DATA_DIR`,不要写到插件载荷或 Framely 程序目录。升级、回退和运行用户变更的状态迁移由插件设计;`steamos` 与 `root` 对应不同的数据目录。普通功能优先使用 `steamos`,确需系统权限时才使用 `root` 并解释原因。
安装/更新钩子应可重复执行;停止/卸载时释放本插件持有的外部资源。关闭 UI 窗口不等于停止后端,React effect 清理不能替代后端钩子。系统依赖不会由 Framely 自动安装,需在说明中写清。[生命周期参考](../plugin-lifecycle.md)
## 5. 构建、打包、校验
在插件项目中执行:
```bash
npm run build
FRAMELY_REPO=/absolute/path/to/framely
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest manifest.json --payload payload --output yourname.my-plugin-0.1.0.framely
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify yourname.my-plugin-0.1.0.framely
```
将 `FRAMELY_REPO` 换成开发机上的 Framely 仓库绝对路径。也可在 Frame 使用已安装的 `/var/lib/framely/current/bin/framely pack` / `verify`,这些离线操作无需 sudo。
`payload/` 只放要分发的页面、后端、Python 协议库及必要资源。构建会复制 `backend.py`、`framely.py`;额外图标等资源需要自行放入该目录。打包检查入口、路径、清单和哈希,不允许软链接或额外包内文件。
## 6. 安装到 Frame 测试
将包下载到手机/电脑,进入网络面板,在“插件”的本地导入入口上传并确认;或通过 SSH 复制到 Frame 后执行:
```bash
sudo /var/lib/framely/current/bin/framely install ./yourname.my-plugin-0.1.0.framely --approve
```
首次协议确认后再管理插件。测试读取/保存、窗口和通知,停用再启用,重启后读回数据;修改版本后测试更新和数据保留,最后测试卸载钩子。涉及 VR 键盘、手柄或硬件的功能,记录实际 Frame 验证结果。
日志可通过 Framely 状态与 systemd 日志检查;后台插件 stdout 不应混入调试文字。更完整的安装操作见[用户教程](../user-guide/plugins.md)。
## 7. 发布
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`。没有已知来源的旧调用默认标记为快捷面板。
+102
View File
@@ -0,0 +1,102 @@
# Manifest 配置说明
[English](../../developer-guide/manifest.md)
[开发流程](README.md) · [SDK](sdk.md) · [生命周期](../plugin-lifecycle.md)
项目根目录 `manifest.json` 描述插件;打包后同名文件位于包内。字段采用 camelCase,安装包清单拒绝未知字段,不要添加已废弃的 `permissions`。以[模板清单](../../../templates/plugin/manifest.json)为起点。
## 最小示例
```json
{
"schemaVersion": 1,
"apiVersion": 1,
"id": "yourname.my-plugin",
"name": "我的插件",
"version": "0.1.0",
"author": "Your name",
"backend": {"entry": "backend.py", "runAs": "steamos"},
"ui": {"quickPage": "page.js"},
"files": {}
}
```
源码清单的 `files` 留空;`framely pack` 遍历 payload 并生成实际文件哈希。至少一个载荷文件,每个入口必须存在于 payload。完整模板见 [manifest.json](../../../templates/plugin/manifest.json)。
## 顶层字段
| 字段 | 要求与默认值 |
| --- | --- |
| `schemaVersion` / `apiVersion` | 必填,目前均为 `1` |
| `id` | 必填,最多 80 字符;允许小写字母、数字、点、短横线、下划线;不能以点开头,禁止 `..`;脚手架要求字母/数字开头,推荐 `namespace.name` |
| `name` / `author` | 必填且非空,各最多 120 字节 |
| `version` | 必填,最多 64 字节,仅 ASCII 字母、数字和 `.-+`;建议完整 SemVer,声明关系时必须 SemVer |
| `description` | 简介,默认空字符串;社区数据库要求最多 4096 字节 |
| `details` / `changelog` | 详细说明/本版本变化,默认空字符串;分别最多 32768 / 16384 字节 |
| `tags` | 标签字符串数组,默认空;最多 12 项,每项非空且最多 80 字节;用于搜索与筛选 |
| `icon` | 可选,payload 内 PNG 路径;最大 1 MiB、1024×1024 |
| `screenshots` | 默认空数组,最多 8 个 payload 内 PNG/JPEG 路径 |
| `authorUrl` / `documentationUrl` / `homepage` | 可选 HTTP/HTTPS 地址,禁止 URL 内用户名密码 |
| `downloadUrl` | 可选,固定版本 HTTPS 包下载地址;GitHub 数据库源码可省略,按仓库/版本/ID 拼接,社区登记的包内需补全;见发布指南 |
| `publish` | 可选外部插件库图片配置,见下文 |
| `backend` / `lifecycle` / `ui` | 可选,配置后端、钩子和页面 |
| `dependencies` / `optionalDependencies` / `conflicts` | 默认空对象,见关系参考 |
| `exclusiveResources` | 默认空数组,禁止同时启用占用同名资源的插件 |
| `files` | 必填对象,打包自动生成路径到 SHA256 的映射,最多 2048 个文件 |
旧 `category` 字段仅兼容读取,不再导出;新插件使用 `tags`。`downloadSha256` 是数据库源码登记专用的整包 SHA256,不能放入严格校验的包内清单。默认 GitHub Release 模式从附件 `digest` 读取整包哈希;自定义 HTTPS 地址需要填写源码专用哈希,打包时移除。省略源码 `downloadUrl` 时,社区登记会补全,但当前 `framely pack` 不会自动补全;[发布指南](publishing.md)提供临时清单命令。社区登记还有比本体严格的 ID、简介长度等校验,不能将本体校验通过等同于登记成功。
## `backend`
| 字段 | 说明 |
| --- | --- |
| `entry` | 必填,包内可执行入口,脚本需有效 shebang |
| `args` | 默认空数组,最多 64 项,每项最多 4096 字节且无 NUL;每项是独立参数,不是 Shell 命令 |
| `runAs` | `steamos`(默认)或 `root` |
| `autostart` | 默认 false,按需启动;true 表示启动时常驻 |
| `restart` | `on-failure`(默认)或 `never` |
| `restartLimit` | 连续失败阈值 1–10,默认 3 |
| `memoryLimitMiB` | 内存上限,默认 512 MiB;1–4294967295 的整数,不能用 0 或 null 取消限制 |
省略 backend 可制作纯 UI 插件。系统/Python 第三方依赖不会自动安装。运行用户变化需用户确认,数据目录按运行身份区分,不自动迁移。
`backend.memoryLimitMiB` 映射到 systemd 的 `MemoryMax`,限制后端及其所有子进程的合计内存;它是上限,不会预分配内存。独立生命周期钩子沿用该值,没有后端的钩子使用 512 MiB。安装计划、CLI 和已安装插件管理页展示上限。省略或填写 512 时打包省略该字段,保持旧包兼容;使用其他值需要支持此字段的新版宿主及插件数据库。
例如,为较长回放声明 2 GiB:
```json
{"backend": {"entry": "backend", "memoryLimitMiB": 2048}}
```
## `ui`
`quickPage` 是可选包内页面 bundle 路径;`windows` 默认空对象,最多 8 个窗口,key 必须是合法 ID。每个窗口:
| 字段 | 说明 |
| --- | --- |
| `entry` / `title` | 必填;入口需在 payload;标题非空且最多 120 字节 |
| `dockIcon` | 默认 false,true 为独立 Dock 窗口 |
| `width` / `height` | 默认 1600×900;宽 640–2560,高 360–1440 |
| `widthMeters` | 默认 3.0;有效值 0.4–4.0 米。源码可读取 null,但打包会省略,再读取采用默认 3.0 |
| `localWeb` | 默认 false;特殊本机网页窗口由后端 `window.get` 提供 localhost URL |
`localWeb` 只支持 Frame 本机打开,后端 `window.get` 参数为 `{window: key}`,返回 `{url: "http://localhost:<port>/framely-window/<key>"}`;不得有查询串、锚点或使用管理面板端口。它使用本机网页所需的不同 sandbox 标志。普通 React 插件无需 `localWeb`。窗口 key 与 `framely.windows.open(key)` 及注册的组件映射一致。尺寸在重新打开窗口时生效。
## `lifecycle`
`onInstall`、`onUpdate`、`onUninstall`、`onCrashCleanup` 是可选 `{entry, args?}` 独立命令;`onStart` / `onStop` 是默认 false 的布尔开关,需要 backend。`timeoutSeconds` 默认 10,范围 1–15 秒。`runAs` 可选,有后端时必须与后端一致,纯 UI 插件独立钩子可用它声明身份。独立命令的 `args` 限制与 backend 相同。执行时机、失败行为和上下文见[生命周期](../plugin-lifecycle.md)。
## 发布资料与关系
`publish.icon` 为 HTTPS 外部图标 URL,`publish.screenshots` 为最多 8 个 HTTPS 截图 URL。包内 `icon` 和 `screenshots` 是文件路径,不能混用。下载地址优先使用 `downloadUrl`,同版本内容必须保持不变。[发布指南](publishing.md)
依赖值可为版本范围字符串,或 `{version, source}`;source 是 HTTPS `catalog.json` 地址。冲突值是版本范围。可选依赖缺失不阻止安装,独占资源只按作者声明校验。[依赖与冲突](../plugin-relationships.md)
清单 JSON 最大 256 KiB,载荷路径最多 512 字节。载荷路径仅允许 ASCII 字母、数字及 `/._-+`,禁止绝对路径、空段、`.`、`..`、软链接和未声明的附加包文件。清单通过校验后,运行权限仍需用户判断;文件哈希不代表插件安全审核。
`backend.uiVisibilityEvents`(boolean,默认 false):订阅宿主专用 `framely.ui.visibility` RPC。后端必须及时回复;通知无需页面挂载。该字段需要支持可见性事件的新版宿主。
## 启动台操作与本体兼容
[启动台操作与本体兼容](launcher.md)
+144
View File
@@ -0,0 +1,144 @@
# 发布插件与插件源
[English](../../developer-guide/publishing.md)
[文档首页](../README.md) · [开发全流程](README.md)
## GitHub Release 默认地址
公开 GitHub 插件仓库的**源码 `manifest.json` 可以省略 `downloadUrl`**。社区数据库从登记的仓库地址、版本和插件 ID 自动生成:
```text
https://github.com/<owner>/<repo>/releases/download/v<version>/<id>-<version>.framely
```
例如仓库 `yourname/my-plugin`、ID `yourname.my-plugin`、版本 `0.1.0` 对应标签 `v0.1.0` 和附件 `yourname.my-plugin-0.1.0.framely`。仓库名不必与 ID 相同。必须真正省略字段;空字符串或 null 不表示自动生成。不要使用 `latest`,不要替换同版本附件。
源码登记与打包有一项区别:数据库会补全源码清单的下载地址,并要求**包内清单含相同的最终 `downloadUrl`**。当前 `framely pack` 只计算载荷哈希,不读取 Git remote、不自动拼接 Release URL。若源码省略该字段,打包前生成临时清单;无需把地址手写回源码。
## 生成发布包
先按[开发流程](README.md)创建插件、执行 `npm run build`,在自己的插件 Git 仓库配置正确的 GitHub `origin`。以下命令在插件目录执行,从源码生成 `.framely-build/manifest.json`,支持 HTTPS、SSH 两种常用 remote 写法;已有显式 `downloadUrl` 会保留,源码不会改写:
```bash
python3 - <<'PY'
import json, re, subprocess
from pathlib import Path
manifest = json.loads(Path('manifest.json').read_text(encoding='utf-8'))
manifest.pop('downloadSha256', None) # Source registration only; never package it.
if 'downloadUrl' not in manifest:
remote = subprocess.check_output(
['git', 'remote', 'get-url', 'origin'], text=True
).strip()
match = re.fullmatch(
r'(?:https://github\.com/|git@github\.com:|ssh://git@github\.com/)'
r'([A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?)(?:\.git)?/?', remote
)
if not match:
raise SystemExit('Use a GitHub origin or set downloadUrl explicitly.')
manifest['downloadUrl'] = (
f"https://github.com/{match[1]}/releases/download/v{manifest['version']}/"
f"{manifest['id']}-{manifest['version']}.framely"
)
output = Path('.framely-build/manifest.json')
output.parent.mkdir(parents=True, exist_ok=True)
output.write_text(json.dumps(manifest, ensure_ascii=False, indent=2) + '\n', encoding='utf-8')
print(manifest['downloadUrl'])
PY
```
`.framely-build/` 是临时输出,应加入插件 `.gitignore`。模板已忽略它。包名必须与默认规则一致;在插件目录继续执行:
```bash
FRAMELY_REPO=/absolute/path/to/framely
PLUGIN_ID=$(python3 -c 'import json; print(json.load(open("manifest.json"))["id"])')
PLUGIN_VERSION=$(python3 -c 'import json; print(json.load(open("manifest.json"))["version"])')
mkdir -p dist
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- pack --manifest .framely-build/manifest.json --payload payload --output "dist/$PLUGIN_ID-$PLUGIN_VERSION.framely"
cargo run --manifest-path "$FRAMELY_REPO/Cargo.toml" --locked -- verify "dist/$PLUGIN_ID-$PLUGIN_VERSION.framely"
```
提交源码、SDK、锁文件和许可证,将该提交标记为 `v<version>`;创建对应 GitHub Release,上传 `dist/` 内的 `.framely`,并公开 Release。包内清单和源码登记清单在补全默认地址、去掉源码专用字段后应一致。用于登记的 submodule 必须指向这个实际发布版本的源码提交。
发行说明包含功能和使用方法、运行用户及 root 的原因、依赖、变化、实际 Frame 测试和已知限制。提供与包匹配的源码和构建脚本,遵守模板、SDK及依赖许可证。
### 整包哈希与自定义地址
| 方式 | 源码登记 | 校验的预期整包哈希 |
| --- | --- | --- |
| 默认 GitHub Release | 省略 `downloadUrl`;标签和附件遵守上述命名 | 从对应 Release 附件的 `digest` 读取 SHA256,无需手写 |
| 显式固定 GitHub Release | 填 `downloadUrl`,可改变标签或附件名 | 未提供 `downloadSha256` 时读取 Release digest;显式提供时以该哈希校验 |
| 其他 HTTPS 下载地址 | 填 `downloadUrl` 和 `downloadSha256` | 使用源码登记中声明的 64 位整包 SHA256 |
自动地址模式即使另填 `downloadSha256`,也必须与 Release digest 相同。缺少 Release digest、附件未公开、无法下载或哈希不符会阻止登记,不会退回到信任刚下载的文件。
`downloadSha256` 只属于数据库源码登记,指完整 `.framely` 的哈希;不是载荷的 `files` 哈希,也不是 Framely 包内字段。先生成包,执行 `sha256sum dist/<id>-<version>.framely`,再把结果写入源码登记。打包必须移除它,上面的临时清单命令已处理;不要向包内写入自身哈希。直接给 `framely pack` 传含此字段的源码清单会被未知字段校验拒绝。
### 图标与窗口兼容
社区数据库的图标通常只需顶层 `icon: "icon.png"`:同一路径 PNG 同时提交到源码仓库和 `payload/`。数据库从登记的仓库、固定提交及路径生成 GitHub Raw 地址,并下载比较包内图标;不需要额外填写 `publish.icon`。自行托管目录的图片由 `publish.icon` / `publish.screenshots` 提供固定 HTTPS 地址。[插件库资料参考](../plugin-development.md#插件库资料与图标)
社区数据库支持窗口 `entry`、`title`、`dockIcon`、`localWeb`、`width`、`height`、`widthMeters`。像素宽度为整数 640–2560,高度为整数 360–1440,物理宽度按本体 float32 规则校验 0.4–4.0 米。源码省略尺寸时,数据库会按 1600×900、3 米补全,与 pack 输出一致;自定义尺寸也会参与源码和包内清单比较,未声明的变化会被拒绝。模板包含的默认独立窗口已通过实际打包和数据库校验;登记仍需完成整包哈希、归属及其他字段检查。
## 方式一:自行托管插件源
自托管不要求社区登记,也不要求 GitHub Release digest。可以省略包内 `downloadUrl`,由 `framely catalog` 使用 `--base-url` 与实际包文件名拼接;填写时优先采用包内地址。若包名来自默认 GitHub 规则,按前述方式发布即可。
把要保留的各版本 `.framely` 放入 `packages/`,在 Framely 仓库执行:
```bash
mkdir -p target/plugin-catalog
cargo run --locked -- catalog --name '我的插件源' --base-url https://example.org/packages --packages ./packages --output ./target/plugin-catalog/catalog.json
```
将 `example.org` 换成实际 HTTPS 地址。CLI 计算完整包的 SHA256并生成 JSON,不上传包、不复制图片。没有外部 `publish.icon` 时,本地 CLI 不会把包内图标转换成插件库 URL。
**上传整个生成目录,不能只上传 `catalog.json`:**
```text
catalog.json
plugins/
yourname.my-plugin/
versions.json
```
主目录每个 ID 一条推荐最新版;历史条目在相对 `plugins/<ID>/versions.json`,不包含主目录当前条目。每次生成需提供要保留的所有版本,本地 CLI 不合并之前的历史。社区数据库会延续之前发布的历史,当前每插件最多保留 19 个历史条目。不要混淆两种工具的保留规则。
将目录放在 HTTPS 静态服务,用户添加完整 `catalog.json` URL;各条目指向的包和图片也必须可访问。多个渠道可再发布[源订阅文件](../source-subscriptions.md)。
## 方式二:登记社区数据库
登记入口为 [framely-plugin-database](https://github.com/SteamFramelyHomebrew/framely-plugin-database),具体规则以其 [CONTRIBUTING.md](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md) 和当前校验器为准。源码根目录须有 `manifest.json`,作者 Release 及附件须先公开,登记使用 Git submodule 固定提交;数据库不镜像包或证明源码与二进制可复现一致。
首次登记:先 fork 数据库,使用自己 fork 的同名 `testing` 分支:
```bash
git clone --branch testing https://github.com/yourname/framely-plugin-database.git
cd framely-plugin-database
git submodule add https://github.com/yourname/my-plugin.git plugins/yourname.my-plugin
git -C plugins/yourname.my-plugin checkout v0.1.0
git add .gitmodules plugins/yourname.my-plugin
git commit -m 'Add yourname.my-plugin 0.1.0'
git push origin testing
```
向上游 `testing` 提交 PR,附实际 Frame 测试记录。只改 `.gitmodules` 与 `plugins/<ID>` 的 submodule 固定提交,其他文件变更不会走登记自动合并。
数据库 ID 要求 `namespace.name`:小写字母和数字,名称部分可带点、连字符;它比本体 ID 校验严格。路径必须是 `plugins/<ID>`,仓库必须是公开 GitHub 仓库。首次登记确认仓库归属和作者维护权限;命名空间绑定 GitHub 所有者数字 ID,每个所有者最多五个历史前缀,删除插件不释放归属。已登记 ID 不能换源仓库。协作者需要可验证的 write/maintain/admin 权限,不能以 manifest 的 `author` 或 Git 提交作者替代。[完整归属规则](https://github.com/SteamFramelyHomebrew/framely-plugin-database/blob/testing/CONTRIBUTING.md#插件归属与自动合并)
更新登记:
```bash
git -C plugins/yourname.my-plugin fetch --tags
git -C plugins/yourname.my-plugin checkout v0.2.0
git add plugins/yourname.my-plugin
git commit -m 'Update yourname.my-plugin to 0.2.0'
git push origin testing
```
stable 对应数据库 `main`,testing 对应 `testing`。自动合并要求 `testing → testing` 或 `main → main`,跨渠道 PR 留给人工处理。测试后按数据库规则提升到稳定渠道;`publish` 是生成分支,不提交插件变更。
## 发布后验证
检查用户实际能访问的包、目录、图标、历史选择、确认安装、更新及数据保留。只有本体 `verify` 通过还不够,登记还须通过数据库对源码、整包哈希和字段的检查。后续按“提升版本 → 重新生成临时清单 → 构建打包 → 实机测试 → 新 Release → 更新固定登记”发布;不要覆盖旧附件。
+163
View File
@@ -0,0 +1,163 @@
# SDK API 文档
[English](../../developer-guide/sdk.md)
[开发流程](README.md) · [Manifest](manifest.md) · [生命周期](../plugin-lifecycle.md)
SDK 源码位于 `sdk/src/index.tsx`、`sdk/src/lifecycle.ts` 和 `sdk/python/framely.py`。页面从 `@framely/sdk` 导入,Python 协议库由构建工具复制到 `payload/framely.py`。
## 页面注册
```tsx
import {registerPlugin, Section} from '@framely/sdk';
function QuickPage() {return <Section title="我的插件">快捷内容</Section>;}
function MainWindow() {return <Section title="主窗口">详细内容</Section>;}
registerPlugin({QuickPage, windows: {main: MainWindow}});
```
`QuickPage` 必填。`WindowPage` 是独立窗口的默认组件;`windows` 可按清单窗口 key 指定不同组件。没有对应组件时回退到 `WindowPage`,再回退到 `QuickPage`;`quick` 用于快捷页路由,避免将它用作窗口 key。页面运行在宿主的 sandbox iframe,宿主先建立桥接再加载你的 bundle。注册函数会挂载 React、基础样式和滚动条。
## 宿主接口 `framely`
| API | 参数与返回 | 用途 |
| --- | --- | --- |
| `framely.call<T>(method, params = {})` | `Promise<T>` | 调用本插件后端方法;错误会 reject |
| `framely.windows.open(key)` | 窗口 key;异步结果 | 打开已在 Manifest 声明的窗口 |
| `framely.windows.close(key)` | 窗口 key;异步结果 | 关闭窗口,不停用后端 |
| `framely.notifications.send(notification)` | 通知对象;异步结果 | 发送或按 ID 更新通知 |
| `framely.notifications.remove(id)` | 通知 ID;异步结果 | 关闭弹窗并移除收件箱副本 |
| `framely.notifications.dismiss(id)` | 通知 ID;异步结果 | 仅关闭弹窗,保留收件箱副本 |
| `framely.dependencies()` | `Promise<DependencyStatus[]>` | 查询本插件声明的依赖状态 |
| `framely.language.get()` | `Promise<{preference, language}>` | 获取语言偏好和当前生效语言 |
| `framely.onEvent(callback)` | 返回取消订阅函数 | 接收宿主转发的事件 |
所有调用只通过插件桥接,不提供管理员 API 或跨插件后端调用。用 `try/catch` 或 `.catch` 处理失败,异步操作期间禁用重复提交。
```tsx
try {
const result = await framely.call<{text: string}>('settings.get');
console.log(result.text);
} catch (error) {console.error(error);}
```
## 通知
```tsx
await framely.notifications.send({
id: 'task', title: '完成', body: '文件已处理', inbox: true, durationMs: 8000,
actions: [{id: 'open', label: '打开', icon: '↗'}],
});
```
`id`、`title`、`body` 必填。`inbox` 默认 `false`:浮窗启用时,只有明确设置 `inbox: true` 的通知才进入快捷面板的“通知”收件箱。收件箱消息在弹窗到期、关闭弹窗、插件停用或重启、本体重启后都会保留;按钮策略、主动移除或卸载插件会移除消息。重启后恢复的收件箱消息不会重新弹出。
| 字段 | 默认值 | 行为 |
| --- | --- | --- |
| `inbox` | `false` | 保存到收件箱;用户浮窗设置也可要求保存 |
| `durationMs` | `8000` | 弹窗自动关闭倒计时,单位毫秒;支持 `1000-60000`,`0` 表示持续显示直到主动关闭 |
| `actions[].closeOnClick` | `true` | 此按钮操作成功后关闭弹窗 |
| `actions[].removeFromInboxOnClick` | `true` | 此按钮操作成功后移除收件箱副本 |
用户的通知设置优先于发送方偏好。全局浮窗或此插件的浮窗开关关闭时,Framely 不展示弹窗,并将消息转存到收件箱,即使 `inbox` 是 `false`。查看收件箱会清除启动图标的未读角标,但保留消息及按钮。插件不能覆盖用户的浮窗和角标设置。
两个按钮策略独立配置。例如查看状态后仍要保留消息,可将两个字段均设为 `false`:
```tsx
await framely.notifications.send({
id: 'capture', title: '录制中', body: '当前录制正在进行。',
inbox: true, durationMs: 0,
actions: [{id: 'status', label: '查看状态',
closeOnClick: false, removeFromInboxOnClick: false}],
});
```
弹窗显示剩余关闭时间,收件箱显示接收时间。关闭弹窗保留其收件箱副本。`framely.notifications.remove(id)` 同时撤回弹窗和收件箱消息;`framely.notifications.dismiss(id)` 仅关闭弹窗。重复发送同 ID 会替换消息并重新开始倒计时。按钮操作失败时保留消息供重试。按钮使用 `label` 文字显示,旧版 `icon` 字符串保持可选兼容。
`image` 可选,接受 PNG/JPEG data URL 或 HTTPS URL,字符串最大 1 MiB。`actions` 最多 3 项,每项必填 `id`、`label`。通知和按钮 ID 遵循本体 ID 规则,按钮 ID 在同一通知内不得重复;`title` 最大 160 字节、`body` 4096 字节、按钮 `label` 非空且最多 80 字节、可选 `icon` 最多 16 字节。每插件每 10 秒最多发送 10 次,全局最多 64 个同时显示的弹窗及 256 条收件箱消息。达到上限后,新消息发送会报错,请先移除旧消息;替换同 ID 不额外占用位置。
按钮调用后端 `notification.action`,参数为 `{id, action}`;后端调用成功后转发同名页面事件。纯前端插件可以监听该事件。插件停用时,其收件箱消息仍可查看和移除,操作按钮需重新启用插件后使用。
## React hooks
| Hook | 返回与行为 |
| --- | --- |
| `useBackend<T>(method, params = {})` | `{data, error, loading, call}`;不会自动发起请求,主动调用 `call()`;该调用失败仍会抛出异常 |
| `usePluginEvent(callback)` | 自动订阅并在页面卸载时取消订阅 |
| `useDependencies()` | `{items, error}`;自动加载依赖并在 `dependencies.changed` 时刷新 |
手动订阅时通过 React effect 返回取消函数:
```tsx
React.useEffect(() => framely.onEvent(event => console.log(event)), []);
```
`DependencyStatus` 包含 `id`、`required`、`constraint`、`version`、`enabled`、`matches`、`available` 和可选 `state.phase`。`constraint` 为版本范围字符串或 `{version, source}`;未安装时 `version` 为 null。[关系参考](../plugin-relationships.md)
宿主语言变化转发 `{type: "language.changed", data: {preference, language}}`;依赖变化转发 `{type: "dependencies.changed"}`。`onEvent` 的类型为 unknown,访问字段前应做类型检查。Python `emit("progress", {...})` 转发为 `{type: "progress", data: {...}}`。
## UI 控件
| 组件 | 主要属性 |
| --- | --- |
| `Section` | `title`、`children` |
| `Button` | 标准 React button 属性,包括 `onClick`、`disabled` |
| `Toggle` | `label`、`checked`、`onChange(boolean)`;可选 `description`、`disabled` |
| `Slider` | `label`、`value`、`onChange(number)`;默认 `min=0`、`max=100`、`step=1` |
| `TextField` | `label`、`value`、`onChange(string)`;可选 `multiline`、`password`、`placeholder`、`disabled` |
| `Select` | `label`、`options: {value,label}[]`、`value`、`onChange`、`disabled` |
| `Tabs` | `tabs: {id,label}[]`、`value`、`onChange(id)` |
| `Notice` | `children`;`error=true` 显示错误 |
`Select` 默认单选,`value` 为 string;设置 `multiple` 时 `value` 为 string[],回调返回数组,可使用 `emptyLabel` 和 `clearLabel`。下拉在页面内渲染,适配离屏 CEF。
标准输入控件在 Frame 中自动连接 SteamVR 键盘,标准可交互控件自动获得悬停反馈。自定义控件应使用正确 ARIA role,可增加 `data-framely-interactive`。网页不自行控制其他窗口、手柄或系统账号。
## Python 后端 SDK
```python
from framely import serve, emit
def dispatch(method, params):
if method == 'ping':
emit('progress', {'percent': 100})
return {'ok': True}
raise ValueError('Unknown method')
serve(dispatch)
```
`serve(dispatch, lifecycle=None)` 读取逐行请求、调用处理器,并把返回值或异常转换成 JSON 响应。`emit(event, data)` 输出事件,页面侧收到 `{type, data}`;`notification` 事件可主动发送通知。日志写 stderr,stdout 专用于协议。生命周期字典写法见[生命周期文档](../plugin-lifecycle.md)。
## TypeScript 生命周期辅助 API
从 `@framely/sdk/lifecycle` 导入 `registerLifecycle`、`LifecycleContext`、`LifecyclePhase`、`LifecycleCallbacks`。`registerLifecycle(callbacks)` 返回异步 `(method, context)` dispatcher;把保留的生命周期方法交给它处理。它不实现 stdin/stdout 协议、不启动进程,也不赋予网页后台权限。
## 预览与权限边界
`npm run dev` 只模拟窗口、通知及部分桥接调用;后端、真实依赖状态、VR 输入、振动和身份行为需要实机测试。插件页面不能直接调用管理面板 API,也不能调用 `framely.lifecycle.*` 保留方法。SDK 本身不声明权限,运行用户由 Manifest 决定。
## 头显可见性与自动暂停
`framely.ui.getVisibility()` 返回 `{ known, captureObscured, pageVisible, sequence, sessionId }`。`framely.ui.onVisibilityChanged(callback, onError?)` 订阅后立即查询当前状态,返回取消订阅函数;`useVisibility()` 提供同样状态及 `error`。`captureObscured` 为原生快捷面板、Framely 管理器和全部插件窗口的真实可见性并集,排除通知和 dock 图标。`pageVisible` 表示当前插件所在原生视图可见;远程浏览器始终为 false。浏览器不能上报或修改头显状态。
录像后端应在 manifest 中声明 `backend.uiVisibilityEvents: true`,处理宿主专用 JSON-line RPC `framely.ui.visibility`,正常回复请求 id。参数包含 `known`、`captureObscured`、`sequence` 和 `views`,不包含前端专属的 `pageVisible`。启动后首次通知包含当前状态,之后在状态变化时通知。原生宿主超过两秒没有心跳时,`known` 变为 false;录像应在 `!known || captureObscured` 时暂停。页面关闭不影响后端通知。旧插件默认不订阅。Node/TS 可从 `@framely/sdk/visibility` 使用 `registerVisibility`,Python `serve(dispatch, visibility=callback)` 支持相同通知。
```ts
const off = framely.ui.onVisibilityChanged(state => {
console.log(state.known, state.captureObscured, state.pageVisible);
});
// 页面卸载时调用 off()
```
`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 客户端界面;该接口不可用时,本机游戏仍可使用。
+40
View File
@@ -0,0 +1,40 @@
# 界面语言与社区翻译
[English](../localization.md)
Framely 内置简体中文和英语。在“设置”顶部选择语言;默认跟随系统语言,手动选择会保存在设备配置中。找不到对应语言时使用英语。语言文件缺少某条翻译时,该条内容回退到内置英语。
## 制作语言文件
从设置下载英文模板,或复制 `ui/locales/en-US.json`。文件是 UTF-8 JSON:
```json
{
"schemaVersion": 1,
"locale": "fr-FR",
"name": "Français",
"messages": {
"语言": "Langue",
"保存": "Enregistrer",
"启用 {0}": "Activer {0}"
}
}
```
- `locale` 使用语言代码,例如 `en-US`、`zh-CN`、`fr-FR`。不能使用 `auto`。
- `name` 使用该语言自己的名称,显示在语言选择列表中。
- `messages` 左侧是稳定的文案键,不要翻译或改写左侧;右侧才是译文。
- `{0}`、`{1}` 等是运行时参数。可以调整位置,但不能增删占位符。
- 可以先提供部分翻译,其余条目显示英语。空字符串是有效译文,不视为缺失。
- 按目标语言习惯重写整句,结合实际操作理解按钮和状态。部分键是句子片段,注意保留必要的空格。
- 文件只包含文本,不执行代码,也不解释 HTML。单文件最多 1 MiB、3000 条翻译,最多导入 50 个语言文件。
## 安装
在“设置 → 语言”点击“安装语言文件”,选择 JSON 文件。导入后在语言列表中选择它;再次导入相同语言代码会更新原文件。
安装后的文件位于 `/var/lib/framely/locales/<locale>.json`。也可以由管理员直接放入此目录,文件名必须与 `locale` 一致;刷新管理面板后读取。损坏的文件会跳过,并在设置中显示文件名。插件作者提供的名称、介绍、标签及插件页面由各插件维护,宿主语言文件不会自动翻译这些内容。
## 项目校验
执行 `node tools/test-localization.mjs` 检查内置英语是否覆盖全部界面文案键、占位符是否一致,以及系统语言匹配、手动选择和缺失翻译回退。
+152
View File
@@ -0,0 +1,152 @@
# 插件开发参考
[English](../plugin-development.md)
第一次开发请先阅读[完整开发流程](developer-guide/README.md)和[发布指南](developer-guide/publishing.md)。
Dock 右侧快捷入口为与主窗口同朝向的弧面临时浮层,常用/已安装/设置三个底部 tab;插件管理从设置打开独立的原生 Dock 大窗口。安装表单与插件源设置只在管理窗口中出现。
示例源码在 `examples/showcase`;React SDK 在 `sdk/src/index.tsx`。发行包 `tools/source` 提供完整 UI/SDK 示例构建工作区。插件页面需要自行打包为浏览器 JS,调用 `registerPlugin({QuickPage, WindowPage})` 挂载 React,宿主先加载桥接 bootstrap。普通 bundle 插件 iframe 为 `sandbox="allow-scripts"` 的独立不透明来源;通过父窗口转发被允许的 SDK 请求,不能直接调用管理员 HTTP API。
## Manifest
```json
{
"schemaVersion": 1,
"apiVersion": 1,
"id": "example.plugin",
"name": "Example",
"author": "Developer",
"version": "1.0.0",
"description": "Example plugin",
"backend": {"entry": "backend.py", "runAs": "steamos", "autostart": false},
"ui": {
"quickPage": "page.js",
"windows": {"main": {"entry": "page.js", "title": "Example", "dockIcon": true}}
},
"files": {}
}
```
`backend` 可省略。`runAs` 只支持 `steamos` 和 `root`,省略时为 `steamos`;`autostart` 默认 false。不再使用 `permissions` 字段,窗口、通知和联网无需权限声明。后端使用设备网络,普通插件页面允许 HTTP/HTTPS 请求及 WebSocket。
ID 只允许小写字母、数字、点、短横线、下划线;载荷路径限 ASCII 字母/数字、`/._-+`,禁止绝对路径、空段、`.`、`..`。入口必须在 files 中;pack 会自动计算 files,不必手写哈希。后端入口须可直接执行,脚本需要正确 shebang(示例 `/usr/bin/python3`)。Python/系统依赖不会由 Framely 自动下载。
版本不可覆盖,相同版本再次发布需要使用新版本号。运行身份变化会选择新的数据目录 `/var/lib/framely/data/<id>/<identity>`;旧身份数据保留,安装使用旧身份的版本可恢复访问,不自动跨身份迁移文件。
## React API
```tsx
import {framely, registerPlugin, Button, Section} from '@framely/sdk';
function QuickPage() {
return <Section title="Example">
<Button onClick={() => framely.windows.open('main')}>打开窗口</Button>
<Button onClick={() => framely.call('save', {text: 'hello'})}>保存</Button>
<Button onClick={() => framely.notifications.send({
id: 'download', title: '完成', body: '下载已完成',
durationMs: 8000, actions: [{id: 'open', label: '打开', icon: '↗'}]
})}>发送通知</Button>
</Section>;
}
registerPlugin({QuickPage});
```
窗口 key 必须在 manifest 中声明;`framely.windows.close(key)` 关闭。关闭页面不会停止后端。通知 ID 用于更新/撤回;`framely.notifications.remove(id)` 撤回。图片为 PNG/JPEG data URL(最多 1 MB)或 HTTPS URL。时长 1–60 秒,每插件每 10 秒最多 10 次发送。
`framely.onEvent(callback)` 返回取消订阅函数;接收 `{type, data}`。多个窗口分别按游标接收同一后台事件。文本输入框获得焦点时请求 SteamVR 虚拟键盘,完成后通过原生 setter 触发 React input/change;不使用网页 prompt。
## 后端协议
每行一个 JSON,stdin 请求、stdout 响应。stdout 只写协议,日志写 stderr(单文件最多约 2 MiB,保留一份轮转备份)。每条消息最多 64 KiB,输入写入超时 5 秒或响应超时 15 秒会停止后端,下次打开可重试。
```json
{"id":1,"method":"save","params":{"text":"hello"}}
{"id":1,"result":{"saved":"hello"}}
{"id":2,"error":"Unknown method"}
{"event":"progress","data":{"percent":50}}
```
系统传入 `FRAMELY_PLUGIN_ID`、`FRAMELY_DATA_DIR` 和对应身份 HOME。通知按钮向后端调用 `notification.action`,参数 `{id, action}`。后端主动发送通知使用 `{"event":"notification","data":{...通知...}}`,受同一 manifest 与频率限制。
## 打包与源发布
```bash
framely pack --manifest manifest.json --payload payload --output example.plugin-1.0.0.framely
framely verify example.plugin-1.0.0.framely
framely catalog --name 'My plugins' --base-url https://example.org/plugins --packages ./packages --output ./packages/catalog.json
```
包中包含 manifest.json 和文件载荷,files 记录每个载荷的 SHA256;不生成公钥或签名。只支持 manifest.json 与清单中声明的载荷文件,拒绝未声明的附加文件。
源需静态托管 catalog.json 及相对路径下的 plugins/<ID>/versions.json;插件包可放在作者自己的 GitHub Release。在插件源管理中添加目录完整 URL;当前代码首次初始化加入社区 stable/testing 来源,实际内容以服务器为准。目录条目有版本、下载 URL、SHA256。每个源独立显示,插件记录所选来源;另一个源同 ID 不会静默替换。HTTP 必须用户明确允许;目录和包支持最多五次重定向,HTTPS 不允许降级为 HTTP。
### 悬停反馈
Framely 主页面和插件 iframe 自动为可交互控件提供轻微的手柄振动,插件无需自行触发。进入按钮、链接、输入控件、可操作 ARIA role、可聚焦控件或 `cursor:pointer` 区域时触发一次;同一控件的子元素之间移动不会重复触发,禁用或 inert 控件不触发。自定义 React 控件应采用正确的 ARIA role,也可以加 `data-framely-interactive` 标记。
振动由 OpenVR 的当前激光控制器执行(12 ms、120 Hz、幅度 0.15),宿主只接受当前可见且被激光命中的视图,限制相邻脉冲间隔为 80 ms。插件发出的反馈消息由 iframe 宿主绑定到实际视图,不能指定另一个窗口或手柄。
## 插件库资料与图标
Manifest 可声明 `icon`(载荷内 PNG,最多 1 MiB、1024×1024)、`details`、`tags`、`screenshots`(最多 8 个载荷内 PNG/JPEG 路径)、`changelog`。这些文件会和页面一样加入文件哈希清单。图标用于插件列表和插件独立窗口的原生 Dock 缩略图,省略时使用默认拼图图标。
清单还支持三个可选网页地址,未填写的入口不显示:`authorUrl`(作者主页)、`documentationUrl`(插件文档)、`homepage`(插件主页)。地址必须是 HTTP 或 HTTPS,可包含文档锚点,不接受带用户名密码的链接。这些字段会保留在安装后的清单,并由 `framely catalog` 导出到插件库目录;作者主页链接直接显示在作者名称上,未提供时作者名称为普通文本;插件库列表、详情、管理弹窗和安装确认使用相同行为。文档和插件主页保留独立入口,点击后由系统默认浏览器打开。
```json
{
"authorUrl": "https://github.com/author",
"documentationUrl": "https://github.com/author/plugin#readme",
"homepage": "https://github.com/author/plugin"
}
```
插件仓库可声明发布信息:
```json
{
"downloadUrl": "https://github.com/author/plugin/releases/download/v1.0.0/plugin.framely",
"publish": {
"icon": "https://github.com/author/plugin/releases/download/v1.0.0/icon.png",
"screenshots": ["https://github.com/author/plugin/releases/download/v1.0.0/screen.png"]
}
}
```
上述为显式地址示例,`downloadUrl` 并非源码必填字段:GitHub 社区登记可按仓库、`v<version>` 和 `<id>-<version>.framely` 自动生成。包内仍需最终地址,当前 pack 不会自动读取 Git remote;按[发布指南](developer-guide/publishing.md)生成临时清单即可。社区图标通常只需 `icon`,数据库从固定源码提交生成并校验 Raw 地址;无需额外 `publish.icon`。本地 catalog CLI 使用 `publish` 外部图片,省略时不会导出包内图标/截图,插件库采用默认图标。包内资源仍用于已安装插件。
插件数据库只登记 submodule 固定提交,读取该提交的清单,补全默认下载地址,先取得 Release digest 或源码 `downloadSha256` 中的预期整包哈希,再下载并比对 SHA256、清单声明和载荷。发布分支提供各渠道目录及历史版本 JSON,不保存插件包或图片,不需要 entries 登记。数据库 CI 自动展示版本和运行用户变化,发布时禁止同 ID、版本更换 SHA256;不执行作者代码,不要求逐插件人工源码审核,也不验证源码与二进制可复现关系。
`framely catalog` 也只生成 JSON:下载 URL 优先使用 `downloadUrl`,没有该字段时采用 `--base-url` 加包文件名。图标与截图来自 `publish` 的外部 URL,不复制资源。插件库支持关键词、标签、来源、已安装和可更新筛选;源暂时不可用时显示会话缓存。安装使用已经校验的同一份包,不在确认后重新下载。
后端默认按失败自动恢复,包括已经启动的按需插件;可用 `backend.restart: "never"` 关闭。默认第三次连续失败后停用,运行稳定一分钟后重置计数,详见[生命周期](plugin-lifecycle.md)。
## 脚手架与预览
```bash
node tools/plugin-dev.mjs init ./my-plugin example.my-plugin
cd my-plugin
npm install
npm run dev
npm run build
```
发行包中的工具位置为 `tools/source/tools/plugin-dev.mjs`。预览监听本机 127.0.0.1:5173,修改页面后自动重载;它不会启动后端或获得 Frame 系统权限。窗口和通知在浏览器里模拟,身份、键盘、振动及后台调用仍需安装到设备测试。
SDK 提供 `Section`、`Button`、`Toggle`、`Slider`、`TextField`、`Select`、`Tabs`、`Notice`、`useBackend`、`usePluginEvent`。Select 使用页面内弹层,兼容离屏 CEF。`registerPlugin` 还可传入 `windows: {main: Component, other: Component}` 为多个声明窗口选择不同 React 页面。
通知按钮向后端发送 `notification.action`,同时广播给当前打开的插件页面,事件为 `{type:'notification.action',data:{id,action}}`;无后端插件可以通过 `framely.onEvent` 接收。
插件安装、更新、停止和异常恢复的约定见[生命周期开发说明](plugin-lifecycle.md)。
窗口可选声明 `width`、`height`(逻辑像素)和 `widthMeters`(VR 物理宽度,米)。默认 1600×900(16:9)、VR 宽度 3 米;像素范围为宽 640–2560、高 360–1440,物理宽度 0.4–4.0 米。示例:`{"entry":"page.js","title":"温控","dockIcon":true,"width":1600,"height":900,"widthMeters":3.0}`。尺寸在重新打开窗口时生效。
依赖、可选依赖、冲突和独占资源见[插件关系](plugin-relationships.md),多个插件源聚合见[源订阅](source-subscriptions.md)。
插件只使用 `tags` 描述用途,不再使用分类;为兼容已发布的包,旧 `category` 字段读取时忽略,新的清单及目录不再导出它。插件数据库每次生成目录时同时生成 `tags.json`,格式为 `{ "schemaVersion": 1, "tags": ["工具", "温控"] }`,聚合当前目录全部插件的标签、精确去重并排序。stable/testing 分别生成自己的标签文件,不生成跨渠道并集;程序加载多个源后在本地聚合去重。标签随插件更新自动增删,无须手工维护。
上传的插件包、插件库下载及其依赖包暂存于 `/tmp/framely-package-*`,确认安装后才写入插件目录。取消、安装完成或失败后删除暂存包;未完成上传和待确认安装包闲置 15 分钟后过期,每 30 秒清理一次。
本机网页窗口在 `ui.windows.<key>` 设置 `localWeb: true`,宿主通过后端 `window.get` 获取窗口 URL;这是窗口加载方式,不是权限声明。URL 使用 `http://localhost:<端口>/framely-window/<key>`。普通窗口无需设置此项。
插件库主目录 `catalog.json` 中每个插件 ID 仅出现一次,代表最新版。历史条目存放在相对目录 `plugins/<插件ID>/versions.json`,格式为 `{ "schemaVersion": 1, "id": "作者.插件", "versions": [...] }`;版本条目沿用目录条目的字段,列表不包含主目录的最新版。插件库进入详情时按需读取历史,依赖解析仅在最新版不满足范围时读取历史。附加目录字段可扩展,读取端忽略未知字段,但校验已知字段;改变必需语义应升级 `schemaVersion`。插件安装包清单仍严格校验。
+99
View File
@@ -0,0 +1,99 @@
# 插件生命周期
[English](../plugin-lifecycle.md)
生命周期由 root 核心服务调度,但钩子使用插件声明的运行身份;省略身份为 `steamos`。有后端时,独立钩子与后端身份必须一致;纯 UI 插件可在 `lifecycle.runAs` 声明身份,安装时展示运行用户。
```json
{
"backend": {
"entry": "backend.py",
"runAs": "steamos",
"autostart": false,
"restart": "on-failure",
"restartLimit": 3
},
"lifecycle": {
"onInstall": {"entry": "backend.py"},
"onUpdate": {"entry": "backend.py"},
"onStart": true,
"onStop": true,
"onUninstall": {"entry": "backend.py"},
"onCrashCleanup": {"entry": "backend.py", "args": ["--cleanup"]},
"timeoutSeconds": 10
}
}
```
所有钩子可省略。独立命令的 entry 必须是包内文件并包含在 files 哈希清单;不能指定 shell 字符串或包外路径。没有为插件增加身份或网络权限。timeoutSeconds 为 1–15 秒,默认 10 秒,每个钩子分别计时。
| 钩子 | 执行时机与方式 |
| --- | --- |
| onInstall | 第一次安装,新版本激活前执行独立命令 |
| onUpdate | 更新或回退,停止旧后端后、新版本激活前执行目标版本的独立命令 |
| onStart | 启动后端后发送 `framely.lifecycle.start` RPC,成功后才接受业务调用 |
| onStop | 禁用、重启、更新、回退、卸载和管理器正常退出时,停止进程前发送 `framely.lifecycle.stop` RPC |
| onUninstall | 停止后端后、删除包前执行独立命令 |
| onCrashCleanup | 异常退出、信号、OOM、调用超时或初始化失败后,由独立进程执行清理 |
关闭快捷菜单或大窗口只卸载对应 React 页面,不停止后端。React effect 清理仍用于页面订阅、预览租约等;不能替代后端生命周期。按需启动与 autostart 是启动时机,restart 是已经启动后发生失败的恢复策略。
## 上下文与 SDK
所有回调收到以下上下文:
```ts
interface LifecycleContext {
pluginId: string;
phase: 'onInstall'|'onUpdate'|'onStart'|'onStop'|'onUninstall'|'onCrashCleanup';
reason: string;
version: string;
previousVersion: string|null;
dataDir: string;
exit: {reason:string;exitCode?:number|null;signal?:number|null;oom?:boolean;message?:string}|null;
}
```
独立命令读取 `FRAMELY_LIFECYCLE` 与 JSON 编码的 `FRAMELY_LIFECYCLE_CONTEXT`。所有后端与命令均有 `FRAMELY_PLUGIN_ID`、`FRAMELY_PLUGIN_VERSION`、`FRAMELY_DATA_DIR` 及对应身份 HOME。独立命令 stdout/stderr 是日志,退出码 0 表示成功;后端钩子按普通 JSON 行协议回复 result 或 error。`framely.lifecycle.*` 为核心服务保留,插件业务 API 不能调用。
Python SDK 位于 `@framely/sdk/python`,构建时复制为载荷中的 `framely.py`,不需额外 pip 依赖:
```python
from framely import serve
def initialize(context):
# 可重复执行;仅操作本插件的数据和资源。
return {"ready": True}
def cleanup(context):
return {"cleaned": True}
def dispatch(method, params):
return {"ok": True}
serve(dispatch, {
"onInstall": initialize, "onUpdate": initialize,
"onStart": initialize, "onStop": cleanup,
"onUninstall": cleanup, "onCrashCleanup": cleanup,
})
```
SDK 检测独立钩子环境时只执行相应回调并退出,不进入 RPC 循环。TypeScript 后端可从 `@framely/sdk/lifecycle` 导入 `registerLifecycle` 和类型,将保留方法交给返回的 dispatcher;它不负责启动进程或实现 JSON 行传输。网页侧 SDK 也导出上下文类型,但不提供后端运行权限。
## 失败、清理与恢复
安装或更新的命令钩子失败时不激活新版本。若安装/更新当时需要启动后端(常驻或原本在运行),初始化失败也恢复原版本与 current 链接;初次安装则撤销安装。按需插件首次安装通常只执行 onInstall,onStart 在首次打开页面/业务调用等实际启动时执行;此时失败走启动恢复,不会追溯撤销之前已完成的安装。回退的初始化失败时恢复回退前的版本。文件版本可恢复,数据迁移和设备操作无法自动撤销:迁移应可重复执行、采用备份/临时文件与原子替换,并保持上一版本能读取数据。
onStop 失败或超时会记录错误,仍会停止整个插件进程组。崩溃后先关闭该插件的窗口、通知,再执行 onCrashCleanup;清理失败不会阻止错误记录或后续恢复。崩溃清理必须是独立命令,无法依赖已经崩溃进程里的内存、析构器或回调。确认资源属于本插件后再删除;不要重启 SteamVR 或删除其他插件的文件。
onUninstall 失败保留插件并展示错误,用户可重试或选择强制卸载。强制卸载仍尝试有超时限制的清理,随后移除插件包;用户数据默认保留,仅 purge 删除。强制卸载不能保证外部设备设置已还原。
restart 默认为 on-failure;never 只记录失败,不自动重启。restartLimit 默认为 3,范围 1–10,达到连续失败阈值后停用;失败计数在后端稳定运行 60 秒后重置。重试等待为 1、2、4、8、16、32 秒,最多 32 秒。正常自主退出(退出码 0)不重启;管理器主动停止也不计入失败。退出码、信号、systemd OOM 和调用超时记录在状态与日志中。
状态包含 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)
+55
View File
@@ -0,0 +1,55 @@
# 插件依赖与冲突(Framely 0.4)
[English](../plugin-relationships.md)
```json
{
"dependencies": {
"example.shared-api": "^1.0.0",
"example.camera-api": {
"version": ">=1.2.0 <2.0.0",
"source": "https://example.org/plugins/catalog.json"
}
},
"optionalDependencies": {"example.notifications": "^1.0.0"},
"conflicts": {"example.other-camera": "*"},
"exclusiveResources": ["steamvr.passthrough-color"]
}
```
四个字段都可省略。声明关系的插件使用合法 SemVer;作为依赖或冲突版本匹配目标的插件也应使用 SemVer。版本范围支持精确版本、`^`、`~`、`*` 和逗号/空白分隔的比较条件。`1.2.0` 表示精确匹配;`>=1.2.0 <2.0.0` 表示两个条件同时满足,不支持 `||`。拒绝自身依赖、重复必需/可选声明、依赖与冲突矛盾和重复独占资源。
`source` 必须是 HTTPS 插件目录 URL,不是订阅或包下载 URL。优先复用版本与来源满足要求的已安装插件;未声明来源时优先当前插件所在源,其他来源必须明确选择。指定来源不可用或没有匹配版本时不换源。明确依赖源尚未添加时,进入安装计划统一确认;已停用的源需用户先启用。删除源后保留已安装插件的来源 URL 记录,以便依赖约束继续识别其来源。
本地包没有默认来源时,未安装依赖需要选择来源;也可通过 CLI 指定已添加源 ID:
```bash
framely install plugin.framely --source my-source --approve
framely install plugin.framely \
--dependency-source example.shared-api=https://example.org/catalog.json \
--approve
```
`--dependency-source` 可重复使用,不能覆盖清单中的明确来源。CLI 和界面使用同一解析器。需要接受已有插件运行用户变化时再加 `--approve-run-as`。
主目录每个插件 ID 只出现一次,历史版本来自相对路径 `plugins/<ID>/versions.json`;主目录版本是推荐版本。用户可选择旧版本安装或重新安装当前版本;包的 ID、版本、哈希及依赖均重新校验。依赖解析优先复用已安装版本,否则选取源中第一个满足约束的版本。多个版本/来源约束无法同时满足、出现循环依赖、缺少必需依赖时停止。缺失可选依赖不阻止安装,也不自动安装。
安装计划展示所有包、版本、来源、运行用户、新增源、依赖启用和冲突停用。确认后使用同一份已校验包;设备插件/来源状态改变后要求重新检查。最多 32 个插件,不限制插件包大小或解压后的总大小。先完成下载和校验,再依次安装,检查反向依赖,防止更新破坏已有依赖方。
批量操作记录持久事务日志;失败恢复版本链接、来源和启用状态,撤销本次新增的包安装,并尝试恢复此前运行的后端。安装期间管理器意外退出时,下次启动恢复原记录。用户数据保留;生命周期迁移和设备操作不能由文件版本回退自动撤销,插件必须设计可重复执行、可恢复的迁移。
启用时统一确认需要启用的必需依赖及需要停用的冲突插件。冲突按任意一方声明处理,允许同时安装,禁止同时启用;同名独占资源同样禁止同时启用。停用/卸载基础插件需确认一起停用依赖方,依赖方不会被自动卸载。
后端按依赖顺序启动,`onStart` 成功才启动依赖方;没有该钩子的后端沿用进程启动成功判断。停止顺序相反。关闭页面不停止后端。基础后端异常时暂停正在运行的依赖方,进入“等待依赖”,不累计依赖方失败次数;基础后端恢复后重新按顺序启动。基础后端被停用或禁止重启时等待用户处理。
SDK 提供:
```tsx
import {framely, useDependencies} from '@framely/sdk';
const states = await framely.dependencies();
// React 页面:const {items, error} = useDependencies();
```
只返回当前插件声明的必需/可选依赖,含版本、启用状态、约束是否满足、后端是否可用和运行阶段。依赖状态变化触发 `dependencies.changed` 事件;不开放跨插件后端调用,不增加运行权限。独占资源和 conflicts 都依赖作者声明,不自动检测任意文件或设备冲突。
不提供插件手动回滚接口;安装旧版本统一走正常安装计划和 `onUpdate`。安装失败的事务恢复仍保留,不是用户选择版本的入口。同 ID 同版本必须保持发布内容不变。
+86
View File
@@ -0,0 +1,86 @@
# Framely 发行与更新
[English](../releases.md)
插件源和 Framely 自身更新源是独立设置。当前代码首次初始化加入社区 stable/testing 来源;目录能否访问以实际服务为准。Framely 更新服务由发行者预配置,管理窗口“关于”提供检查、下载、安装和回滚;尚未配置时使用发行安装包更新。插件和 Framely 发行包均不要求签名或公钥。
构建发行包后生成包含版本、架构、下载地址、长度与 SHA256 的普通 JSON 更新清单:
```bash
framely release-manifest \
--archive "./framely-0.2.0-<build>-linux-arm64.tar.gz" \
--url "https://example.org/releases/framely-0.2.0-<build>-linux-arm64.tar.gz" \
--output ./framely-release.json \
--changelog '本次更新说明'
```
将包与清单发布到 HTTPS 静态服务;下载最多跟随五次经过 URL 校验的重定向,不允许从 HTTPS 降级到 HTTP。发行维护终端配置清单完整 URL:
```bash
framely call system.source.save '{"source":{"url":"https://example.org/framely-release.json"}}'
```
此接口用于发行维护,不作为普通用户设置项。当前官方安装引擎和桌面安装器会在更新源尚未配置时写入 `https://github.com/SteamFramelyHomebrew/framely/releases/latest/download/framely-release.json`,已有配置保留。哈希用于检查下载内容一致性,发行者身份依赖更新源;不再通过签名验证。
更新依次检查 API/架构兼容、声明长度、SHA256,安全解压后检查发行包自身 SHA256SUMS;下载不阻塞核心服务。用户确认安装后,独立 systemd 助手切换发行版本,只重启 Framely 服务。日志在 `/var/lib/framely/logs/update.log`。安装失败会尝试恢复原发行和安装前状态;UI 可回滚上一版本。
更新源仍仅包含 URL;渠道独立保存在 `database.updateChannel`,取值为 `stable`(默认正式版)或 `testing`(测试版),旧版本回滚时仍能读取原更新源。可通过“关于”选择,或执行 `framely call system.channel.save '{"channel":"testing"}'`。修改更新源或渠道会清除原候选版本和已下载包。发行清单使用普通 JSON,不支持旧签名包、签名信封或公钥字段。回滚切换上一发行版本,保留插件数据,不进行旧版格式迁移。
设备上的实际升级/回滚和重启恢复需要验收;本地自动测试验证无签名格式、包边界和插件安装更新,不能代替设备服务切换测试。
官方 GitHub `releases/latest/download/framely-release.json` 更新源会查询仓库 Release 列表,按渠道严格筛选,选择带本体包和清单的最高 SemVer 标签;跳过草稿、安装器标签和附件不完整的发行。没有匹配版本时显示该渠道暂无发行,包括只有 Preview 时检查正式版的情况。清单必须与所选标签、包地址和长度一致。自定义 HTTPS 清单地址仍直接读取,其版本必须属于所选渠道;发行者需要配置相应渠道的清单 URL。
## SteamOS 更新后的恢复
安装器将整个管理目录保存在 `/home/.framely/state`,包括 `state.json`、更新源、日志、当前/上一发行链接、Steam 用户名和 Framely 账号 UID;`/var/lib/framely` 仅作兼容链接。旧安装会在停止服务后迁移。两份状态冲突时停止,不自动覆盖任何一份。
系统服务和账号仍依赖 SteamOS 系统配置,操作系统更新后可能需要手动修复。在系统配置可写时运行 `sudo bash /home/.framely/repair.sh`;无需重新下载发行包,恢复兼容链接、专用账号、服务文件和开机启动。修复先校验保留的发行,再使用当前发行的 `install.sh --repair`,不创建发行或改写上一版本记录。保存的账号 UID 若被占用或现有账号 UID 已变化则停止,避免错误地接管旧数据。系统只读时停止,不自动解除保护。
该机制不能恢复已被系统清除的 `/home` 数据,也不保证操作系统更新后无需人工操作。回滚到不支持修复模式的旧发行后,需要使用支持该模式的新发行包恢复安装。正式发布前应进行一次真实 SteamOS 更新,验证设置、插件数据、账号身份、服务恢复和 SteamVR 宿主兼容性。
## 本体包与独立 CEF
每次构建生成不含 CEF 的本体包 `framely-<版本及构建号>-linux-arm64.tar.gz`、完整离线包 `framely-<版本及构建号>-offline-linux-arm64.tar.gz`、独立运行库 `framely-cef-<运行库标识>-linux-arm64.tar.gz`。更新清单 `framely-release.json` 固定指向不含 CEF 的本体包;首次安装固定选择完整离线包。`framely-cef.json` 提供独立 CEF 的 HTTPS 下载地址、大小及 SHA256。
CEF 按内容哈希保存在 `/home/.framely/cef/<运行库标识>`,更新时复用;旧安装中相同的运行库自动迁移。所需运行库缺失或 CEF 版本更换时单独下载并校验,各发行的运行库保留用于回滚。完整包可离线提供 CEF。参见[发行包与运行库恢复](user-guide/installation.md#发行包与-cef)。
## GitHub Actions 发布
Framely 和桌面安装器保留在同一仓库,使用独立的版本号、标签和发布工作流:
- Framely:版本由根 `Cargo.toml` 定义,标签为 `v<版本>`(当前 `v0.6.0`);`.github/workflows/release.yml` 只构建 Frame Linux ARM64 发行,使用锁定的 CEF 并执行自动检查。
- 安装器:版本由 `installer/Cargo.toml` 定义,标签为 `installer-v<版本>`(当前 `installer-v0.4.1-preview.10`);`.github/workflows/installer-release.yml` 只构建 Linux x64/ARM64、Windows x64、macOS x64/ARM64 的原生安装器,使用锁定的 GPUI Kit。
两个版本不需要相同,也不需要同时发布。修改各自版本时同步对应的 `Cargo.lock`;安装器包名及 macOS 应用版本使用安装器版本。
两个工作流均缓存 Cargo 下载的依赖和已编译的依赖产物,按产品、系统、架构、Rust 工具链及依赖配置区分。安装器使用 `installer/target`;本体在 CI 使用 `target/cargo`,与单独缓存的 `target/cef` 分开,测试和发行打包共用同一 Cargo 目录。失败构建也会保存已完成的依赖编译。
普通分支推送不触发发行构建;只有对应产品的标签推送或手动运行会触发。缓存恢复、编译和缓存保存均在同一次构建内完成。GitHub 允许标签构建读取默认分支的缓存,不允许一个标签读取另一个标签的专属缓存;需要跨标签复用时,可手动在 `main` 运行一次对应工作流来生成默认分支缓存,该运行只生成构建产物,不发布 Release。首次构建、没有可访问的缓存或工具链变化后仍需重新编译,缓存命中情况见 “Cache Cargo dependencies and build artifacts” 步骤。
```bash
# 提交并推送代码后,选择需要发布的产品
git tag v0.6.0
git push origin v0.6.0
# 独立发布安装器,不触发 Framely 构建
git tag installer-v0.4.1-preview.10
git push origin installer-v0.4.1-preview.10
```
带 `-preview.N` 等预发布后缀的标签会发布为 GitHub Prerelease,不设置为 Latest。安装器 Release 始终设置为非 Latest;只有 Framely 正式 Release 设置为 Latest。因此设备安装入口和默认更新清单的 `releases/latest/download/...` 继续指向 Framely 本体。安装器读取发行列表时按本体包名筛选,不把 Linux ARM64 安装器误当成设备发行包。安装器下载应使用具体的 `installer-v<版本>` Release。
只有标签触发会发布。各工作流在自己的构建全部成功后创建草稿 Release,上传本产品产物及外部 `SHA256SUMS`,最后公开草稿。Framely Release 额外包含 `bootstrap.py`、入口脚本和更新清单;安装器 Release 只包含五个平台的安装器包和校验文件。失败的草稿不作为最新稳定版提供下载。手动触发用于验证,仅保留 Actions artifacts。
Framely 本体 Release 附件用途:`framely-*-linux-arm64.tar.gz` 为不含 CEF 的更新包,`framely-*-offline-linux-arm64.tar.gz` 为首次安装用的完整离线包,`framely-cef-*` 为独立运行库,`framely-cef.json` 提供运行库下载信息;`framely-release.json` 为内置更新功能的版本清单;`install.sh` 是命令行入口,调用 `bootstrap.py` 完成下载、校验和维护;`SHA256SUMS` 为附件校验清单。桌面安装器只需自动下载运行包和校验清单,用户无需手动下载脚本。安装器的五个平台包发布在独立的安装器 Release 中。
外部 `SHA256SUMS` 包含压缩包哈希,校验传输内容;包内同名文件校验解压后的载荷。哈希不能独立证明作者身份,在线安装依赖指定 GitHub 仓库与 HTTPS;本地安装依赖用户提供的可信包与校验文件。下载遵循 HTTPS 重定向,不允许降级。
入口脚本从 Release 下载设备引擎;在线安装默认选择最新正式版,也支持 `--version TAG`。指定标签时,入口从该 Release 下载 `bootstrap.py`,引擎再选择同标签运行包;入口脚本本身来自用户下载或 curl 指定的位置,可在仅有 Preview、尚无正式版时安装预发布版本。本地使用 `python3 tools/bootstrap.py install --archive /path/package.tar.gz --checksums /path/SHA256SUMS`。更新要求已经安装;指定已安装版本会修复服务,指定其他版本会安装目标发行,保留状态。
安装器将官方更新清单地址预配置到尚未配置更新源的设备;既有更新源保留。之后可继续通过 Framely 内置更新界面更新。
## 统一卸载
脚本和桌面安装器均只有一个卸载选项。`uninstall.sh` 先停止会话及下载工作,再通过 root 专用 `prepare-uninstall --approve` 请求核心服务:持久停用所有插件、按依赖顺序停止插件、执行各插件 `onUninstall`,移除插件包。全部完成后才取消 Framely 自启、停止核心并移除程序。失败时保留本体并恢复会话,插件保持停用,允许处理原因后重试;不支持跳过失败插件强制卸载本体。
协议尚未确认或已撤回也允许 root 通过此专用维护接口卸载;普通会话及插件界面不开放该接口。保存的设置、插件数据和系统账号保留,不承诺清除外部副作用。旧发行没有该接口时需先更新。
+26
View File
@@ -0,0 +1,26 @@
# 插件源订阅(Framely 0.4)
[English](../source-subscriptions.md)
在管理窗口“插件源 → 源订阅”粘贴 HTTPS JSON 地址,预览后确认添加:
```json
{
"schemaVersion": 1,
"name": "Framely 社区源",
"sources": [
{"id":"stable", "name":"社区稳定版", "url":"https://example.org/stable/catalog.json"},
{"id":"testing", "name":"社区测试版", "url":"https://example.org/testing/catalog.json"}
]
}
```
每个源 id 在订阅内唯一且稳定,用于识别地址变更。禁止重复 URL、嵌套订阅、HTTP、带认证信息的 URL,最多 100 个源、512 KiB;每台设备最多 20 个订阅、200 个插件源。目录、包、图片继续由各源或作者托管,订阅只聚合目录地址。
默认每天自动刷新,也可关闭自动刷新或立即刷新。自动检查在 Framely 会话运行期间进行,启动后检查到期项;支持 ETag/Last-Modified 和最多五次 HTTPS 重定向。离线/失败保留已持久化的上次成功源列表,记录错误,按一分钟起的指数退避重试,最多一天。
新增源自动纳入;名称自动更新。相同 id 的 URL 改变时保留旧地址,显示待确认变更,确认后才采用新地址。刷新订阅后同时刷新插件目录。目录缓存沿用会话内缓存,重启后的离线插件库不保证有目录缓存。
目录 URL 规范化后去重,一个源可由多个订阅和手动添加共同引用。删除订阅或移除订阅中的源只移除对应引用;没有任何引用才从源列表移除。已安装插件、来源记录和数据保留,不静默切换来源。
可在插件源列表单独停用源,刷新不会重新开启;即使移除后又加入同一 URL,也保留停用偏好。订阅源的 URL 在待确认变更中管理。刷新只更新源列表、插件库资料和更新提示,不自动安装、更新或启用插件。
+156
View File
@@ -0,0 +1,156 @@
# 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 包数据库。
在“APK 管理 → 设置”中可调节 L2/R2 按键触发行程,范围 1%~100%,默认 80%。两个扳机共用该设置,Steam Input 和 Frame 直连均适用,不改变模拟轴的完整行程。保存后立即应用到正在运行的转发进程;松开阈值比按下低 5 个百分点,设置低于 5% 时在归零后松开。
## 单应用图形兼容
在**管理应用 → 高级设置**中,“帧缓冲兼容修复”默认关闭。仅为有声音但黑屏的游戏开启(已在当前 Mesa/Zink 驱动下验证洛克王国),修改后需重启应用。GLES 修复层只在所选应用中,于绑定纹理后检查帧缓冲状态,不改变其他应用、系统驱动、游戏文件或存档。关闭后,下次启动恢复正常渲染路径。这是针对特定问题的兼容措施,并非通用画质或性能优化。
+77
View File
@@ -0,0 +1,77 @@
# 基本使用
[English](../../user-guide/basic-usage.md)
[文档首页](../README.md) · [安装指南](installation.md)
## 快捷菜单与管理窗口
在 SteamVR Dashboard 点击 Framely Dock 图标打开快捷菜单。首次访问需阅读并同意协议及隐私声明;未同意时插件不会自动启动。
- **常用**:打开收藏的插件快捷页。
- **已安装**:查看已启用的本机插件,进入插件页面。
- **通知**:查看收件箱消息和更新提醒,并控制悬浮通知。
- **设置**:选择已安装的语言、切换安全模式,或打开“管理插件”和“检查更新”。“检查更新”打开管理窗口的设置 → 更新页面;安装语言文件和下载语言模板在管理窗口的设置中进行。
“管理插件”打开独立大窗口,顶部进入插件、APK、终端、文件与设置五个区域。安装、更新及来源管理在这里完成;电脑或手机也可使用[网络管理面板](network-panel.md)。
## 插件启停与窗口
在插件列表启用、停用或收藏插件。启用表示允许使用;默认后端按需启动,只有声明 `autostart` 的插件会常驻。关闭插件窗口通常不会停用后台功能。依赖不满足或有冲突时,界面会给出原因,并在变更前显示受影响插件。
带 Dock 图标的独立窗口由 SteamVR 提供关闭控件;临时窗口可能在切换界面时销毁。不同插件的 UI 和功能由各自开发者决定。
## 设置与诊断
设置中可修改语言、网络面板及代理。HTTP 代理和 GitHub 代理各有开关,保存地址不会自动启用代理。
“安全模式”暂停第三方插件,适合出现故障时检查;排查后再退出安全模式。在“设置 → 关于”查看本体版本和协议,在“设置 → 更新”检查更新。撤回协议会停用全部插件,再次同意后需要手动启用。
在“设置 → 更新”选择正式版或测试版渠道并检查更新,点击“下载并安装”并确认一次:Framely 下载、校验发行包后自动开始安装。下载和校验分别显示阶段提示与实际字节进度。下载或校验失败时停止安装并显示原因。插件和数据保留,Framely 界面会暂时关闭并重新启动。
日志排查命令见[安装指南](installation.md#修复与日志)。界面能打开不代表所有插件都正常;先逐个启用,确认运行身份与来源可信。
## 通知收件箱与自动更新检查
快捷面板的“通知”标签展示明确设置为进入收件箱的消息,浮窗启用时,普通通知默认不保存;浮窗关闭时会转存到收件箱。浮动通知显示自动关闭倒计时,关闭浮动通知会保留已保存的收件箱副本;收件箱里的删除按钮会移除消息。通知按钮默认在操作成功后关闭弹窗并移除收件箱副本,发送方可以分别修改这两个行为。
“通知”顶部的“允许通知”开关控制全局浮窗。关闭后,新通知即使没有声明进入收件箱也会保存到这里,正在显示的浮窗也会转存。重新开启不会重新弹出旧消息。
悬浮通知跟随头显,显示在视野内右上方。激光命中区域与实际卡片对齐,短按按钮可容忍小幅追踪抖动。
管理窗口的“通知设置”提供全局“悬浮通知”和“启动图标角标”开关,并为 Framely 本体(包括更新提醒)及所有已安装插件(包括已停用插件)提供独立的“角标”和“悬浮”开关。全局开关优先,关闭后仍保留各应用偏好。Framely Dock 启动图标的角标统计允许显示角标来源的未读收件箱消息,超过 99 显示 `99+`;实际打开通知标签后消除角标,隐藏的头显面板不会自动标记已读。查看消息不会删除消息,也不会关闭其操作按钮。设置和已读状态均会保存并在重启后恢复。
本体默认在启动约 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 窗口,后续仍进行启动存活检查。运行中的容器即使已隐藏应用窗口也会复用,不再仅因之前游戏退出就重启。
+110
View File
@@ -0,0 +1,110 @@
# 安装、更新、修复与卸载
[English](../../user-guide/installation.md)
[文档首页](../README.md) · [下一步:基本使用](basic-usage.md)
## 安装前
目标设备为 Linux ARM64 Steam Frame。当前开发基线为 SteamOS VR 0.4.2、SteamVR build 20260928.6175029;其他系统版本需验证。完整离线安装包自带 CEF,设备使用时无需安装 Node.js 或 Rust。
电脑与 Frame 连接同一网络,在 Frame 开启开发者模式并启用 SSH,准备 Steam 用户 `steamos` 的登录密码。安装会使用 sudo 创建账号、systemd 服务和发行目录;请核对 SSH 指纹。安装器不会自动解除 SteamOS 只读保护;实际所需目录不可写时会停止。
## 方式一:电脑端安装器
1. 从 [Framely Releases](https://github.com/SteamFramelyHomebrew/framely/releases) 的 `installer-v<版本>` 下载适合电脑的安装器。Linux 为 tar.gz,Windows 为 EXE ZIP,macOS 为应用 ZIP。
2. 解压并运行,扫描设备或手动填写设备 IP 与 SSH 端口。
3. 核对指纹,填写 `steamos` 和密码,连接后选择 Framely 本体发行版本。
4. 如果要安装 Preview,开启显示测试版;安装器版本与设备版版本相互独立。
5. 在“安装与维护”确认设备、目标版本及操作,等待完成。也可选择本地运行包和对应的外部 `SHA256SUMS`。
Linux 用户可在安装器解压目录执行 `bash install-desktop-entry.sh`,把带 Framely 图标的入口添加到当前用户的应用菜单。入口指向解压目录;移动目录后需重新执行脚本。
安装器会校验下载内容,并在设备端再次校验。密码不保存到配置文件。连接后仍需在实际设备上观察 Framely 的启动和显示。
## 方式二:在 Frame 的 SSH 终端安装
以下命令在 **Frame 上** 执行。默认安装最新正式版:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install
```
指定 Preview 或其他标签:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3
```
将示例标签换成 Releases 中实际存在的本体标签。指定标签时从该 Release 下载引擎和包,不要求已有正式版;不指定标签时使用最新正式版。终端会按需请求 sudo 密码。
## 方式三:本地发行包
下载完整离线包 `framely-<版本及构建号>-offline-linux-arm64.tar.gz`、外部 `SHA256SUMS` 和同一 Release 的 `bootstrap.py`,放入 Frame 的同一目录:
```bash
python3 bootstrap.py install --archive "./framely-<版本及构建号>-offline-linux-arm64.tar.gz" --checksums ./SHA256SUMS
```
尖括号是占位符,执行前替换为真实文件名。引擎校验后在 `/home` 暂存、解压并检查包内哈希,避免耗尽设备的 `/tmp`。
## 发行包与 CEF
每个本体 Release 提供三种压缩包:
- `framely-<版本及构建号>-offline-linux-arm64.tar.gz`:包含 CEF 的完整离线包,首次安装固定使用此包。
- `framely-<版本及构建号>-linux-arm64.tar.gz`:不含 CEF 的本体包;桌面安装器、SSH 引擎及本体更新器在更新时自动选择此包。
- `framely-cef-<运行库标识>-linux-arm64.tar.gz`:单独的 CEF 运行库,提供在线下载;`framely-cef.json` 包含下载 URL、大小和 SHA256。
CEF 保存在 `/home/.framely/cef/<运行库标识>`。更新复用经过校验的对应运行库;旧完整安装中相同的 CEF 文件会自动迁移。所需运行库缺失或发行更换 CEF 时,本体安装流程通过 HTTPS 下载单独的匹配 CEF 包,并校验大小、SHA256 和包内哈希。完整离线包直接提供运行库,无需下载 CEF。
各发行引用自己的 CEF 版本,回滚时仍保留之前的运行库;修复会校验运行库,卸载则与程序一起移除 CEF 缓存。本地首次安装必须选择完整离线包;本地更新可使用不含 CEF 的包,前提是对应运行库已安装,否则恢复运行库需要联网。
## 验证安装
```bash
systemctl is-active framely.service framely-session.service
/var/lib/framely/current/bin/framely --version
sudo /var/lib/framely/current/bin/framely status
```
两个服务正常应显示 `active`。打开 SteamVR Dashboard,在 Dock 找到 Framely;首次使用需阅读用户协议和隐私声明。之后按[插件安装教程](plugins.md)添加第一个插件。
## 更新与回滚
已配置更新服务时,在“关于 → Framely 更新”选择“正式版”或“测试版”,再检查、下载并确认安装。正式版只检查正式 Release,测试版只检查 Preview、Beta、RC 等预发布版本;渠道选择保存在设备上。切换渠道会清除原候选版本和已下载包,需要重新检查和下载。也可以用桌面安装器,或在 Frame 执行:
```bash
curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- update --version v0.4.2-preview.3
```
更新保留插件、设置和数据,并保留前一个发行用于回滚;只重启 Framely。默认渠道为正式版;在本体内选择测试版即可检查 Preview。命令行更新 Preview 仍需明确指定标签或本地包。切回正式版时可能选到比当前版本更旧的发行,界面会在安装前提示;回滚不会迁移新版插件数据格式。
需要回滚时,从“关于”选择上一版本,或执行:
```bash
sudo bash /var/lib/framely/current/rollback.sh
```
回滚本体保留插件数据,但不保证将新版本的数据格式转换为旧格式。
## 修复与日志
SteamOS 更新可能重置账号和系统服务。管理数据保存在 `/home/.framely/state`,`/var/lib/framely` 为兼容入口。在系统配置可写且 `/home` 数据仍存在时执行:
```bash
sudo bash /home/.framely/repair.sh
sudo journalctl -u framely -u framely-session --no-pager -n 100
```
修复会使用已保留的发行恢复账号及服务;UID 冲突时停止。它不能找回已删除的 `/home` 数据,SteamOS 更新后的恢复仍需实机验证。
## 卸载
桌面安装器“安装与维护”提供卸载,也可直接执行:
```bash
sudo bash /var/lib/framely/current/uninstall.sh
```
卸载先停用并卸载全部插件、执行其卸载钩子,成功后再移除 Framely 程序和服务。某个插件清理失败会保留 Framely并报错,处理后重试。已保存的设置、插件数据和专用账号保留;不承诺自动清除第三方插件在其他位置造成的修改。
+39
View File
@@ -0,0 +1,39 @@
# 网络管理面板
[English](../../user-guide/network-panel.md)
[文档首页](../README.md) · [插件安装](plugins.md)
## 找到地址
网络面板默认开启,监听 IPv4 端口 `15915`,不依赖 SteamVR 正在运行。手机/电脑与 Frame 连接同一网络,在浏览器打开:
```text
http://设备IP:15915
```
管理窗口“设置 → 网络管理面板”显示设备当前 IP 和完整地址,也可在桌面安装器连接设备后使用网络面板入口。没有检测到 IP 时先检查 Wi-Fi/网线;端口被占用时设置中会提示错误。
## 首次设置密码
尚未配置访问密码时,首次访问只显示设置页面,不能进入管理 API。输入至少 8 个字符的密码并再次确认,保存后使用该密码登录。密码设置可以先于用户协议确认;登录后仍需阅读并同意协议才能管理插件。
密码以带随机盐的 PBKDF2 哈希保存,重启保留,不会在界面中回显。首次设置入口不能覆盖已有密码。网络面板密码和设备 SSH/sudo 密码相互独立。
后续在已登录的设置页面修改密码,或从设备原生界面修改。忘记密码时优先从 Frame 的原生管理窗口设置新密码。已有版本的密码保留;用户已明确关闭密码验证且已有密码记录的配置保持其选择。网络面板使用 HTTP,请只在可信网络使用,不要把端口直接转发到公网。
## 可以做什么
登录后可以管理来源和订阅、浏览插件库、导入本地插件包、确认安装、启停插件、修改设置及检查本体更新。插件后端始终运行在 Frame,上传本地包只是从手机/电脑把文件传到设备。
VR 窗口、手柄振动和 SteamVR 虚拟键盘需要头显端验收;浏览器无法替代这些设备交互。部分外部链接由设备默认浏览器打开。
## 更改端口、关闭与登录过期
在“设置 → 网络管理面板”修改端口或开关,保存后生效。修改认证设置或密码会使旧登录会话失效;端口改变后访问新的地址,关闭面板后网络连接断开。本机原生界面不因此关闭。
会话服务重启也会使旧登录失效,需要重新登录。保存完全相同的设置不会撤销当前会话。错误密码验证有速率限制,提示尝试过多时稍后再试。
无法访问时检查设备 IP 是否变化、两台设备是否处于可互通的网络、面板是否开启以及端口是否正确。设置/密码保存在 `/home/.framely/state`,卸载本体保留这些状态,重装后可能仍需原密码。
顶部切换器提供插件、APK、终端、文件与设置;设备地址默认打开插件。[终端与文件](terminal-and-files.md)提供用户 Shell 会话、上传下载、编辑、压缩及预览,复用相同登录和端口。
+56
View File
@@ -0,0 +1,56 @@
# 安装与管理插件
[English](../../user-guide/plugins.md)
[文档首页](../README.md) · [网络面板](network-panel.md)
## 从插件库安装
1. 打开管理窗口“插件库”。当前代码首次初始化加入社区 stable/testing 来源;来源内容取决于服务和设备配置。没有目录或插件时,进入“插件源”添加开发者提供的完整 HTTPS `catalog.json` 地址。
2. 可按关键词、标签、来源或安装状态筛选。
3. 打开详情,查看作者、介绍、更新记录、运行用户和依赖。默认显示推荐版本,历史版本会按需加载。
4. 点击安装或检查所选版本。下载、校验和依赖解析完成后,阅读确认页。
5. 检查包内实际运行用户以及依赖带来的 root 权限,确认后安装。安装后在插件列表启用或打开。
插件库提供的运行用户只是目录资料,最终确认以下载包内声明为准。`steamos` 使用 Steam 会话用户,`root` 可修改系统和设备设置。包哈希用于校验内容,不等于对作者身份或安全性的担保。
## 添加源与订阅
单个目录地址:在“插件源”添加名称和 `https://.../catalog.json`,测试连接后保存。
多个源的订阅:在“源订阅”粘贴开发者提供的订阅 JSON 地址,预览所含来源后确认添加。它和单个目录不是同一种文件。订阅刷新仅更新来源和插件库资料,不自动安装或更新插件。
停用或删除来源不会自动卸载已安装插件;订阅管理的 URL 变更需另行确认。格式与刷新行为见[源订阅参考](../source-subscriptions.md)。
## 导入本地包或包 URL
插件包扩展名为 `.framely`,无需自行解压。进入管理窗口“插件”,打开导入入口:
- **本地文件**:在手机/电脑网络面板选择本机下载的 `.framely` 文件;文件上传后校验。
- **包 URL**:粘贴作者提供的固定版本 HTTPS 下载地址,等待下载和检查。
两种方式都需要阅读安装确认,涉及运行用户变更时另行确认。导入的是插件包;Framely 本体 tar.gz 和普通 ZIP 不能作为插件安装。
在 Frame 的 SSH 终端也可安装:
```bash
sudo /var/lib/framely/current/bin/framely install ./plugin.framely --approve
```
只有在确认旧版到新版确实需要改变运行用户时才增加 `--approve-run-as`。命令行不会代替你判断来源是否可信。
## 更新、选择旧版与卸载
插件库提示“可更新”时进入详情,查看变化后按安装确认流程更新。需要旧版时,在详情选择历史版本再检查;换来源也会明确提示。设置和收藏通常保留,但运行用户改变会使用另一份数据目录,不自动迁移旧身份的数据。
从插件管理弹窗卸载。卸载钩子负责清理该插件的外部资源,保存的数据保留;不要直接删除系统中的插件目录。停用只停止使用,不卸载程序和数据。
## 常见问题
| 现象 | 处理 |
| --- | --- |
| 插件库空白 | 检查是否添加并启用了来源、连接能否成功、筛选是否过窄 |
| 下载或校验失败 | 检查网络和包地址,重新下载;不要跳过哈希校验 |
| 历史版本不可用 | 来源可能没有历史文件,可先安装最新版或导入可信旧包 |
| 插件无法启用 | 查看依赖、冲突和错误说明,确认其他必要插件已安装 |
| 插件反复崩溃 | 停用后检查日志,必要时进入安全模式,再向插件作者反馈 |
@@ -0,0 +1,77 @@
# 终端与文件
[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`。日志可能包含应用信息,分享前请检查。
文件排序(名称、大小或修改时间,以及升序/降序)按文件夹分别记忆。“展示方式”可切换列表、小图标、中图标和大图标,此选项对所有文件夹统一生效。偏好保存在 Frame,重新打开浏览器或头显管理面板时恢复。图标视图仅为当前可见的图片和视频按需生成缩略图,使用浏览器解码,最多同时处理两项。视频截取约第 1 秒的画面。缩略图使用有上限的页面内存缓存,文件元数据变化后重新生成;滚出可视区域会取消待处理任务。不支持的格式或解码失败时保留文件类型图标。不使用 FFmpeg,也不扫描整个文件夹的媒体。
点击图片或视频会打开全屏遮罩预览。使用滚轮或缩放按钮缩放,拖动画面移动,通过上一个/下一个或方向键切换当前展示列表中的图片、视频。“适应窗口”恢复初始视图,Esc 关闭;视频保留播放控制。浏览器无法解码时,可在预览中下载文件。5 MiB 以内的 UTF-8 文本仍在编辑器中打开;二进制文件、不支持的编码及更大的文件点击后直接下载。
查看器操作集中在底部居中的悬浮胶囊条中,文件名在下方居中显示。点击空白区域关闭;点击媒体、操作按钮或拖动画面不会误关闭。
-7
View File
@@ -1,7 +0,0 @@
# SDK showcase
[简体中文](README.md)
Demonstrates a React quick page, persistent data, separate windows, and notifications. It is a plugin development reference and is not automatically enabled when Framely is installed.
Run `npm ci && npm run build` at the repository root to generate `payload/page.js` and `payload/backend.py`, then package and install as described in the [plugin development reference](../../docs/en/plugin-development.md). `payload/icon.png` is the example's source icon.
+4 -4
View File
@@ -1,7 +1,7 @@
# SDK 示例
# SDK showcase
[English](README.en.md)
[简体中文](README.zh-CN.md)
展示 React 快捷页面、持久数据、独立窗口和通知。它是插件开发参考,不会随 Framely 安装自动启用。
Demonstrates a React quick page, persistent data, separate windows, and notifications. It is a plugin development reference and is not automatically enabled when Framely is installed.
在仓库根目录执行 `npm ci && npm run build` 生成 `payload/page.js` 和 `payload/backend.py`,然后按 [插件开发文档](../../docs/plugin-development.md) 打包和安装。`payload/icon.png` 是示例的源图标。
Run `npm ci && npm run build` at the repository root to generate `payload/page.js` and `payload/backend.py`, then package and install as described in the [plugin development reference](../../docs/plugin-development.md). `payload/icon.png` is the example's source icon.
+7
View File
@@ -0,0 +1,7 @@
# SDK 示例
[English](README.md)
展示 React 快捷页面、持久数据、独立窗口和通知。它是插件开发参考,不会随 Framely 安装自动启用。
在仓库根目录执行 `npm ci && npm run build` 生成 `payload/page.js` 和 `payload/backend.py`,然后按 [插件开发文档](../../docs/zh-CN/plugin-development.md) 打包和安装。`payload/icon.png` 是示例的源图标。
+1 -1
View File
@@ -1,4 +1,4 @@
import React,{useState} from 'react';
import {registerPlugin,framely,Section,Button} from '@framely/sdk';
function Page(){const [text,setText]=useState('');const [result,setResult]=useState('');const [count,setCount]=useState(0);async function run(f:()=>Promise<unknown>){try{setResult(JSON.stringify(await f(),null,2));}catch(e){setResult(String(e));}}return <><Section title="Framely 功能测试"><small>每个按钮都调用正式 SDK。</small><p><Button onClick={()=>setCount(n=>n+1)}>点击计数:{count}</Button><Button onClick={()=>void run(()=>framely.call('identity'))}>读取后端身份</Button></p></Section><Section title="输入与持久化"><input placeholder="点击后打开 Steam 虚拟键盘" value={text} onChange={e=>setText(e.target.value)}/><Button onClick={()=>void run(()=>framely.call('save',{text}))}>保存</Button><Button onClick={()=>void run(()=>framely.call('read'))}>读取</Button></Section><Section title="窗口"><Button onClick={()=>void run(()=>framely.windows.open('main'))}>打开原生 Dock 窗口</Button><Button onClick={()=>void run(()=>framely.windows.open('temporary'))}>打开临时窗口</Button><Button onClick={()=>void run(()=>framely.windows.close('main'))}>关闭大窗口</Button><Button onClick={()=>void run(()=>framely.windows.close('temporary'))}>关闭临时窗口</Button></Section><Section title="通知"><Button onClick={()=>void run(()=>framely.notifications.send({id:'showcase',title:'Framely 通知测试',body:'一张图片和三个按钮。重复发送会更新这条通知。',image:'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+aN1kAAAAASUVORK5CYII=',durationMs:15000,actions:[{id:'ok',label:'确认',icon:'✓'},{id:'save',label:'保存',icon:'↓'},{id:'more',label:'详情',icon:'⋯'}]}))}>发送通知</Button><Button onClick={()=>void run(()=>framely.notifications.remove('showcase'))}>撤回</Button></Section><pre style={{whiteSpace:'pre-wrap',fontSize:16}}>{result}</pre><Section title="滚动测试">{Array.from({length:12},(_,i)=><p key={i}>测试条目 {i+1}</p>)}</Section></>}
function Page(){const [text,setText]=useState('');const [result,setResult]=useState('');const [count,setCount]=useState(0);async function run(f:()=>Promise<unknown>){try{setResult(JSON.stringify(await f(),null,2));}catch(e){setResult(String(e));}}return <><Section title="Framely 功能测试"><small>每个按钮都调用正式 SDK。</small><p><Button onClick={()=>setCount(n=>n+1)}>点击计数:{count}</Button><Button onClick={()=>void run(()=>framely.call('identity'))}>读取后端身份</Button></p></Section><Section title="输入与持久化"><input placeholder="点击后打开 Steam 虚拟键盘" value={text} onChange={e=>setText(e.target.value)}/><Button onClick={()=>void run(()=>framely.call('save',{text}))}>保存</Button><Button onClick={()=>void run(()=>framely.call('read'))}>读取</Button></Section><Section title="窗口"><Button onClick={()=>void run(()=>framely.windows.open('main'))}>打开原生 Dock 窗口</Button><Button onClick={()=>void run(()=>framely.windows.open('temporary'))}>打开临时窗口</Button><Button onClick={()=>void run(()=>framely.windows.close('main'))}>关闭大窗口</Button><Button onClick={()=>void run(()=>framely.windows.close('temporary'))}>关闭临时窗口</Button></Section><Section title="通知"><Button onClick={()=>void run(()=>framely.notifications.send({id:'showcase',inbox:true,title:'Framely 通知测试',body:'一张图片和三个按钮。重复发送会更新这条通知。',image:'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+aN1kAAAAASUVORK5CYII=',durationMs:15000,actions:[{id:'ok',label:'确认',icon:'✓'},{id:'save',label:'保存',icon:'↓'},{id:'more',label:'详情',icon:'⋯'}]}))}>发送通知</Button><Button onClick={()=>void run(()=>framely.notifications.remove('showcase'))}>撤回</Button></Section><pre style={{whiteSpace:'pre-wrap',fontSize:16}}>{result}</pre><Section title="滚动测试">{Array.from({length:12},(_,i)=><p key={i}>测试条目 {i+1}</p>)}</Section></>}
registerPlugin({QuickPage:Page,WindowPage:Page});
+14 -1
View File
@@ -1985,7 +1985,7 @@ dependencies = [
[[package]]
name = "framely-installer"
version = "0.4.1-preview.4"
version = "0.4.1-preview.10"
dependencies = [
"anyhow",
"base64 0.22.1",
@@ -2003,6 +2003,7 @@ dependencies = [
"tempfile",
"ureq",
"url",
"winreg",
"winresource",
"zeroize",
]
@@ -6549,6 +6550,17 @@ dependencies = [
"windows-sys 0.61.2",
]
[[package]]
name = "socks"
version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f0c3dbbd9ae980613c6dd8e28a9407b50509d3803b57624d5dfe8315218cd58b"
dependencies = [
"byteorder",
"libc",
"winapi",
]
[[package]]
name = "spin"
version = "0.9.9"
@@ -7450,6 +7462,7 @@ dependencies = [
"rustls-pki-types",
"serde",
"serde_json",
"socks",
"url",
"webpki-roots 0.26.11",
]
+5 -2
View File
@@ -1,6 +1,6 @@
[package]
name = "framely-installer"
version = "0.4.1-preview.4"
version = "0.4.1-preview.10"
edition = "2024"
license = "AGPL-3.0-only"
@@ -22,7 +22,7 @@ serde = { version = "1", features = ["derive"] }
serde_json = "1"
sha2 = "0.10"
hex = "0.4"
ureq = { version = "2.12", features = ["json"] }
ureq = { version = "2.12", features = ["json", "socks-proxy"] }
url = "2"
ssh2 = { version = "0.9", features = ["vendored-openssl"] }
if-addrs = "0.13"
@@ -33,6 +33,9 @@ tempfile = "3"
zeroize = "1"
directories = "6"
[target.'cfg(target_os = "windows")'.dependencies]
winreg = "=0.55.0"
[build-dependencies]
winresource = "=0.1.31"
-71
View File
@@ -1,71 +0,0 @@
# Framely Installer
[简体中文](README.md)
A Rust + GPUI Kit desktop installer that connects to Steam Frame to install, update, repair, roll back, and uninstall Framely. The default release repository is `SteamFramelyHomebrew/framely`.
## License
Original installer code uses **GNU Affero General Public License v3.0 only** (`AGPL-3.0-only`). See [LICENSE](../LICENSE); release packages include it. Third-party dependencies retain their own licenses. AGPL allows commercial use and requires complete corresponding source when distributing software under its terms.
Corresponding source is available in the [SteamFramelyHomebrew/framely](https://github.com/SteamFramelyHomebrew/framely) repository at `installer-v<VERSION>` tags. Build instructions follow below. Redistributors of modified versions must provide source and necessary build scripts matching their binaries.
Only one installer instance can run per user; additional instances exit immediately. The title bar supports dragging and window controls. macOS uses system window buttons; Linux/Windows use GPUI Kit or system controls. Closing the last window exits the application and releases the instance lock.
## Usage
1. Enable developer mode and set a password on Frame. Connect the computer and device to the same LAN.
2. Discovery prioritizes `192.168.*` subnets, with at most 1024 addresses per scan. Name discovery and IP probing run together. Only devices whose hostname is `frame` are listed, with SSH availability indicated. Other devices and addresses without a confirmed name are omitted. Manual IP and SSH port entry is always available.
3. Check the SSH handshake and displayed host fingerprint, then enter credentials. The default user is `steamos`. Changed saved fingerprints cause the connection to be rejected. After verifying a device reinstall, you can remove its entry from `known-hosts.json` in the configuration directory.
4. Select a release or a local `framely-*-linux-arm64.tar.gz` together with its external `SHA256SUMS` or matching `.sha256` file. Local packages do not require GitHub access. Prereleases are hidden by default.
5. Choose an operation on Install & Maintenance and confirm. The installer does not disable SteamOS root filesystem read-only protection; it stops with an error when required directories are not writable.
After local verification, built-in SSH/SFTP uploads the package. The device verifies it again and extracts it safely. Passwords are used only in memory and are not written to configuration, command arguments, or environment variables. Operations provide the sudo password through SSH standard input. SSH and sudo use the same entered password, matching the default Frame account configuration.
Uninstall has one path: disable all plugins and run their uninstall hooks before removing Framely services and binaries. If any hook fails, Framely remains installed with plugins disabled for repair and retry. Settings, plugin data, and dedicated accounts remain. Changes plugins made elsewhere may remain. Update older releases that lack `prepare-uninstall` before uninstalling.
Available operations depend on device state. An uninstalled device offers installation only. An installed device opens maintenance with update, repair, and uninstall; rollback is offered only when a previous release exists. Repair, rollback, and uninstall require no package selection. Install/update without a package returns to version selection. Selecting the exact installed package prompts repair instead of updating again. State is re-read before execution to reject stale actions. Changing devices, versions, or files clears prior confirmation, and navigation is disabled during operations.
After an operation, maintenance shows a separate success/failure card and a reconnect button. Success states which operation completed; failure shows the cause. Logs remain available for diagnosis. The SSH connection and installed-version snapshot are discarded; reconnect before another operation.
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.
## Build
Linux requires C/C++ build tools, CMake, pkg-config, and development libraries for Fontconfig/Freetype, X11/XCB, XKBCommon, Wayland, and Vulkan. macOS requires Xcode command-line tools. Windows requires MSVC, CMake, and Perl for built-in OpenSSL. GPUI Kit is pinned to 0.7.0; matching dependencies are locked in `Cargo.lock`.
```bash
cargo test --manifest-path installer/Cargo.toml --locked --no-default-features --lib
cargo check --manifest-path installer/Cargo.toml --locked
cargo run --manifest-path installer/Cargo.toml --locked
cargo build --manifest-path installer/Cargo.toml --locked --release
```
Set `CARGO_TARGET_DIR` to use another build-output directory; packaging also reads this variable. By default, packaging reads `installer/target/release/framely-installer`. CI requires no override.
```bash
INSTALLER_PLATFORM=linux-x64 python3 tools/package-installer.py
```
The UI shares Framely's dark surfaces, thin borders, and pale blue selection state. It has Connect device, Select version, and Install & Maintenance pages. Connection progress covers SSH, authentication, permission checks, version retrieval, and fingerprint storage. Failures show their cause and restore retry controls. Next-step buttons explain missing device/package requirements. Render simulated pages and connecting, failure, and success states without connecting to a real device:
```bash
cargo build --manifest-path installer/Cargo.toml --locked --features visual-test
FRAMELY_INSTALLER_PREVIEW_DIR=installer/dist/previews installer/target/debug/framely-installer
```
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.4`) 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.
The titlebar and application icons share the pixel logo. Windows builds embed the ICO in the EXE; macOS packaging uses the system `iconutil` to generate and configure `.icns`. On Linux, run `bash install-desktop-entry.sh` from the extracted archive to register an icon-bearing entry in the current user's application menu. The entry points to that directory; rerun the script after moving it.
Automated tests and Actions builds validate software and artifacts. Discovery, login, permissions, update, rollback, and uninstall still need acceptance testing on actual computers and Frame hardware.
Discovery queries `frame.local` mDNS address records directly. It does not require an advertised SSH service or system DNS support for `.local`. Run the same discovery logic independently for diagnosis:
```bash
cargo run --manifest-path installer/Cargo.toml --locked --no-default-features --example scan -- 192.168.5.0/24
```
+47 -27
View File
@@ -1,38 +1,46 @@
# Framely Installer
[English](README.en.md)
[简体中文](README.zh-CN.md)
Rust + GPUI Kit 的桌面安装器,连接 Steam Frame,安装、更新、修复、回滚和卸载 Framely。默认发行仓库为 `SteamFramelyHomebrew/framely`。
A Rust + GPUI Kit desktop installer that connects to Steam Frame to install, update, repair, roll back, and uninstall Framely. The default release repository is `SteamFramelyHomebrew/framely`.
## 许可证
## License
安装器原创代码采用 **GNU Affero General Public License v3.0 only**(`AGPL-3.0-only`)。源码仓库内的全文见 [LICENSE](../LICENSE),发行包内附带 `LICENSE`;第三方依赖保留各自的许可证。AGPL 允许商业使用,分发时须按许可证提供完整对应源码。
Original installer code uses **GNU Affero General Public License v3.0 only** (`AGPL-3.0-only`). See [LICENSE](../LICENSE); release packages include it. Third-party dependencies retain their own licenses. AGPL allows commercial use and requires complete corresponding source when distributing software under its terms.
对应源码位于 [SteamFramelyHomebrew/framely](https://github.com/SteamFramelyHomebrew/framely) 的 `installer-v<版本>` 标签,构建说明见下文。重新分发修改版时,须提供与所发布二进制匹配的源码及必要构建脚本。
Corresponding source is available in the [SteamFramelyHomebrew/framely](https://github.com/SteamFramelyHomebrew/framely) repository at `installer-v<VERSION>` tags. Build instructions follow below. Redistributors of modified versions must provide source and necessary build scripts matching their binaries.
同一用户只能运行一个安装器实例;重复启动会直接退出。顶部标题栏支持拖拽移动及窗口操作;macOS 使用系统窗口按钮,Linux/Windows 使用 GPUI Kit 标题栏按钮或系统提供的按钮。关闭最后一个窗口会退出程序并释放实例锁。
Only one installer instance can run per user; additional instances exit immediately. The title bar supports dragging and window controls. macOS uses system window buttons; Linux/Windows use GPUI Kit or system controls. Closing the last window exits the application and releases the instance lock.
## 使用
## Usage
1. 在 Frame 开启开发者模式并设置密码;电脑和设备连接同一局域网。
2. 默认优先扫描 `192.168.*` 网段(每次最多 1024 个地址)。名称发现和 IP 探测同时开始;只列出主机名为 `frame` 的设备,并标注 SSH 是否可用。其他设备和无法确认名称的地址不会显示。手动 IP 和 SSH 端口始终可用。
3. 检查 SSH 握手,核实显示的主机指纹,再输入账号密码登录。用户名默认 `steamos`。已保存的指纹发生变化时拒绝连接;核实设备重装后可手动移除配置目录中的对应 `known-hosts.json` 条目。
4. 从 Releases 选择版本,或选择本地 `framely-*-linux-arm64.tar.gz` 和压缩包外部的 `SHA256SUMS`(也可选择对应 `.sha256` 文件)。本地包不需要访问 GitHub。默认隐藏测试版。
5. 在“安装与维护”选择操作并确认。安装器不会解除 SteamOS 根分区的只读保护,所需目录不可写时会报错停止。
1. Enable developer mode and set a password on Frame. Connect the computer and device to the same LAN.
2. Discovery prioritizes `192.168.*` subnets, with at most 1024 addresses per scan. Name discovery and IP probing run together. Only devices whose hostname is `frame` are listed, with SSH availability indicated. Other devices and addresses without a confirmed name are omitted. Manual IP and SSH port entry is always available.
3. Check the SSH handshake and displayed host fingerprint, then enter credentials. The default user is `steamos`. Changed saved fingerprints cause the connection to be rejected. After verifying a device reinstall, you can remove its entry from `known-hosts.json` in the configuration directory.
4. Select a release or a local `framely-*-linux-arm64.tar.gz` together with its external `SHA256SUMS` or matching `.sha256` file. Local packages do not require GitHub access. Prereleases are hidden by default.
5. Choose an operation on Install & Maintenance and confirm the device, version and action in the modal dialog. Cancel or press Esc to return without executing. Errors and operation results also appear in dialogs. SSH fingerprint verification stays on the connection page. The installer does not disable SteamOS root filesystem read-only protection; it stops with an error when required directories are not writable.
本机校验完成后使用内置 SSH/SFTP 上传,设备端再次校验并安全解压。密码只在内存中使用,不写入配置文件,不作为命令参数或环境变量传输;操作通过 SSH 标准输入向 sudo 提交密码。SSH 登录和 sudo 密码使用同一输入,适用于 Frame 默认账号配置。
During execution, the main page shows download, transfer and device-operation progress. Downloads and SFTP transfers report actual bytes and percentages; local packages skip downloading. The device reports verification, staging, extraction, service configuration and startup checks. Extraction reports actual bytes; steps without a measurable total show an indeterminate indicator and the current step. Logs remain available on the same page. Completion is reported only after the operation and post-operation checks succeed.
卸载只有一个入口:先停用全部插件并运行卸载钩子,全部成功后才移除 Framely 服务和程序。失败时保留本体、禁用插件,供修复后重试。保存的设置、插件数据和专用账号保留;不承诺清除插件在其他位置造成的修改。旧发行若不支持 `prepare-uninstall`,应先更新到支持此接口的新发行。
After local verification, built-in SSH/SFTP uploads the package. The device verifies it again and extracts it safely. Passwords are used only in memory and are not written to configuration, command arguments, or environment variables. Operations provide the sudo password through SSH standard input. SSH and sudo use the same entered password, matching the default Frame account configuration.
连接成功后按设备状态提供操作:未安装时仅提供安装;已安装时默认进入维护页面,提供更新、修复与卸载;设备存在上一发行版本时才提供回滚。修复、回滚和卸载无需选择在线或本地包;安装和更新缺少包时,“选择版本”按钮会返回版本页面。选择与当前安装完全相同的包时提示使用修复,不重复更新。执行前会重新读取设备状态,拒绝过期操作;连接其他设备、切换版本或文件时清除旧确认,操作期间禁止切换页面。
Uninstall has one path: disable all plugins and run their uninstall hooks before removing Framely services and binaries. If any hook fails, Framely remains installed with plugins disabled for repair and retry. Settings, plugin data, and dedicated accounts remain. Changes plugins made elsewhere may remain. Update older releases that lack `prepare-uninstall` before uninstalling.
操作结束后在维护页面顶部显示独立的成功/失败结果卡片及重新连接按钮。成功明确显示对应操作完成,失败显示原因;日志继续保留用于排查。结束后丢弃 SSH 连接及已安装版本快照,重新连接才能再次操作。
Available operations depend on device state. An uninstalled device offers installation only. An installed device opens maintenance with update, repair, and uninstall; rollback is offered only when a previous release exists. Repair, rollback, and uninstall require no package selection. Install/update without a package returns to version selection. Selecting the exact installed package prompts repair instead of updating again. State is re-read before execution to reject stale actions. Changing devices, versions, or files clears prior confirmation, and navigation is disabled during operations.
扫描、下载和 SSH 工作在后台线程运行,界面展示进度和日志。默认网络管理面板按钮使用端口 15915;设备修改端口后应使用实际地址。
After an operation, maintenance shows a separate success/failure card and a reconnect button. Success states which operation completed; failure shows the cause. Logs remain available for diagnosis. The SSH connection and installed-version snapshot are discarded; reconnect before another operation.
## 构建
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.
Linux 需要 C/C++ 构建工具、CMake、pkg-config、Fontconfig/Freetype、X11/XCB、XKBCommon、Wayland 和 Vulkan 开发库。macOS 需要 Xcode 命令行工具;Windows 需要 MSVC、CMake 和 Perl(用于内置 OpenSSL)。GPUI Kit 固定为 0.7.0,配套依赖由 `Cargo.lock` 锁定。
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.
## Build
Linux requires C/C++ build tools, CMake, pkg-config, and development libraries for Fontconfig/Freetype, X11/XCB, XKBCommon, Wayland, and Vulkan. macOS requires Xcode command-line tools. Windows requires MSVC, CMake, and Perl for built-in OpenSSL. GPUI Kit is pinned to 0.7.0; matching dependencies are locked in `Cargo.lock`.
```bash
cargo test --manifest-path installer/Cargo.toml --locked --no-default-features --lib
@@ -41,31 +49,43 @@ cargo run --manifest-path installer/Cargo.toml --locked
cargo build --manifest-path installer/Cargo.toml --locked --release
```
可配置 `CARGO_TARGET_DIR` 将构建产物放入其他目录,打包工具也会读取此设置。默认读取 `installer/target/release/framely-installer`,CI 构建时无需配置此变量。
Set `CARGO_TARGET_DIR` to use another build-output directory; packaging also reads this variable. By default, packaging reads `installer/target/release/framely-installer`. CI requires no override.
```bash
INSTALLER_PLATFORM=linux-x64 python3 tools/package-installer.py
```
界面采用与 Framely 一致的深色、细边框和淡蓝色选中状态,分为连接设备、选择版本、安装与维护三个页面。连接时显示建立 SSH、认证、权限检查、版本读取及指纹保存的进度;失败在页面中显示原因,并恢复按钮以便重试。未连接设备或未选择安装包时,下一步按钮说明当前缺少的条件。可用模拟数据渲染页面以及连接中、失败和成功状态的预览图,不连接真实设备:
The UI shares Framely's dark surfaces, thin borders, and pale blue selection state. It has Connect device, Select version, and Install & Maintenance pages. Connection progress covers SSH, authentication, permission checks, version retrieval, and fingerprint storage. Failures show their cause and restore retry controls. Next-step buttons explain missing device/package requirements. Render simulated pages and connecting, failure, and success states without connecting to a real device:
```bash
cargo build --manifest-path installer/Cargo.toml --locked --features visual-test
FRAMELY_INSTALLER_PREVIEW_DIR=installer/dist/previews installer/target/debug/framely-installer
```
预览依赖可用的 GPU 或软件 Vulkan 渲染器;默认发行构建不包含此预览功能。
Preview requires an available GPU or software Vulkan renderer. Default release builds do not include preview support.
安装器版本由本目录的 `Cargo.toml` 和 `Cargo.lock` 独立管理,不跟随 Framely 本体版本。推送 `installer-v<版本>` 标签(当前 `installer-v0.4.1-preview.4`)触发 `.github/workflows/installer-release.yml`,只构建并发布安装器;本体使用 `v<版本>` 标签和独立工作流。也可在 Actions 手动运行安装器工作流,仅生成构建产物。安装器 Release 不占用仓库的 Latest,以免影响 Frame 的默认安装和更新地址。
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 构建 Linux x64/ARM64、Windows x64、macOS Intel/Apple Silicon。macOS 输出 `.app` ZIP,Windows 输出 EXE ZIP,Linux 输出 tar.gz。当前未配置 Apple 公证或 Windows 代码签名,发布前应分别验证系统的首次启动体验。
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.
安装器标题栏和应用图标使用统一的像素 Logo。Windows 构建将 ICO 嵌入 EXE,macOS 打包使用系统 `iconutil` 生成并配置 `.icns`。Linux 解压后可在解压目录执行 `bash install-desktop-entry.sh`,把带图标的入口注册到当前用户的应用菜单;入口指向该目录,移动后需重新执行脚本。
The titlebar and application icons share the pixel logo. Windows builds embed the ICO in the EXE; macOS packaging uses the system `iconutil` to generate and configure `.icns`. On Linux, run `bash install-desktop-entry.sh` from the extracted archive to register an icon-bearing entry in the current user's application menu. The entry points to that directory; rerun the script after moving it.
所有自动测试和 Actions 构建只能验证软件及产物;仍需在真实电脑和 Frame 上完成扫描、登录、权限、升级回滚及卸载验收。
Installer archives do not include a separate `assets` directory. The UI logo is embedded in the executable; the Linux registration script embeds its menu icon, while macOS keeps its application icon inside the `.app` bundle.
扫描会直接查询 `frame.local` 的 mDNS 地址记录,不要求设备广播 SSH 服务,也不依赖电脑的系统 DNS 支持 `.local`。可单独运行与界面相同的发现逻辑进行诊断:
Automated tests and Actions builds validate software and artifacts. Discovery, login, permissions, update, rollback, and uninstall still need acceptance testing on actual computers and Frame hardware.
Discovery queries `frame.local` mDNS address records directly. It does not require an advertised SSH service or system DNS support for `.local`. Run the same discovery logic independently for diagnosis:
```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.
+91
View File
@@ -0,0 +1,91 @@
# Framely Installer
[English](README.md)
Rust + GPUI Kit 的桌面安装器,连接 Steam Frame,安装、更新、修复、回滚和卸载 Framely。默认发行仓库为 `SteamFramelyHomebrew/framely`。
## 许可证
安装器原创代码采用 **GNU Affero General Public License v3.0 only**(`AGPL-3.0-only`)。源码仓库内的全文见 [LICENSE](../LICENSE),发行包内附带 `LICENSE`;第三方依赖保留各自的许可证。AGPL 允许商业使用,分发时须按许可证提供完整对应源码。
对应源码位于 [SteamFramelyHomebrew/framely](https://github.com/SteamFramelyHomebrew/framely) 的 `installer-v<版本>` 标签,构建说明见下文。重新分发修改版时,须提供与所发布二进制匹配的源码及必要构建脚本。
同一用户只能运行一个安装器实例;重复启动会直接退出。顶部标题栏支持拖拽移动及窗口操作;macOS 使用系统窗口按钮,Linux/Windows 使用 GPUI Kit 标题栏按钮或系统提供的按钮。关闭最后一个窗口会退出程序并释放实例锁。
## 使用
1. 在 Frame 开启开发者模式并设置密码;电脑和设备连接同一局域网。
2. 默认优先扫描 `192.168.*` 网段(每次最多 1024 个地址)。名称发现和 IP 探测同时开始;只列出主机名为 `frame` 的设备,并标注 SSH 是否可用。其他设备和无法确认名称的地址不会显示。手动 IP 和 SSH 端口始终可用。
3. 检查 SSH 握手,核实显示的主机指纹,再输入账号密码登录。用户名默认 `steamos`。已保存的指纹发生变化时拒绝连接;核实设备重装后可手动移除配置目录中的对应 `known-hosts.json` 条目。
4. 从 Releases 选择版本,或选择本地 `framely-*-linux-arm64.tar.gz` 和压缩包外部的 `SHA256SUMS`(也可选择对应 `.sha256` 文件)。本地包不需要访问 GitHub。默认隐藏测试版。
5. 在“安装与维护”选择操作,在弹窗中核对设备、版本和操作后确认;取消或按 Esc 返回,不会执行。错误和操作结果也使用弹窗。SSH 指纹确认仍保留在连接页面。安装器不会解除 SteamOS 根分区的只读保护,所需目录不可写时会报错停止。
执行时主页面显示下载、传输和设备操作进度。在线下载与 SFTP 传输显示实际字节数和百分比;本地安装包跳过下载。设备端依次回报校验、准备目录、解压、配置服务和启动检查等步骤。解压显示实际字节进度,无法计算总量的步骤显示运行指示与当前步骤,日志保留在同一页面。只有操作及后续检查成功后才显示完成。
本机校验完成后使用内置 SSH/SFTP 上传,设备端再次校验并安全解压。密码只在内存中使用,不写入配置文件,不作为命令参数或环境变量传输;操作通过 SSH 标准输入向 sudo 提交密码。SSH 登录和 sudo 密码使用同一输入,适用于 Frame 默认账号配置。
卸载只有一个入口:先停用全部插件并运行卸载钩子,全部成功后才移除 Framely 服务和程序。失败时保留本体、禁用插件,供修复后重试。保存的设置、插件数据和专用账号保留;不承诺清除插件在其他位置造成的修改。旧发行若不支持 `prepare-uninstall`,应先更新到支持此接口的新发行。
连接成功后按设备状态提供操作:未安装时仅提供安装;已安装时默认进入维护页面,提供更新、修复与卸载;设备存在上一发行版本时才提供回滚。修复、回滚和卸载无需选择在线或本地包;安装和更新缺少包时,“选择版本”按钮会返回版本页面。选择与当前安装完全相同的包时提示使用修复,不重复更新。执行前会重新读取设备状态,拒绝过期操作;连接其他设备、切换版本或文件时清除旧确认,操作期间禁止切换页面。
操作结束后在维护页面顶部显示独立的成功/失败结果卡片及重新连接按钮。成功明确显示对应操作完成,失败显示原因;日志继续保留用于排查。结束后丢弃 SSH 连接及已安装版本快照,重新连接才能再次操作。
扫描、下载和 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 代理。
## 构建
Linux 需要 C/C++ 构建工具、CMake、pkg-config、Fontconfig/Freetype、X11/XCB、XKBCommon、Wayland 和 Vulkan 开发库。macOS 需要 Xcode 命令行工具;Windows 需要 MSVC、CMake 和 Perl(用于内置 OpenSSL)。GPUI Kit 固定为 0.7.0,配套依赖由 `Cargo.lock` 锁定。
```bash
cargo test --manifest-path installer/Cargo.toml --locked --no-default-features --lib
cargo check --manifest-path installer/Cargo.toml --locked
cargo run --manifest-path installer/Cargo.toml --locked
cargo build --manifest-path installer/Cargo.toml --locked --release
```
可配置 `CARGO_TARGET_DIR` 将构建产物放入其他目录,打包工具也会读取此设置。默认读取 `installer/target/release/framely-installer`,CI 构建时无需配置此变量。
```bash
INSTALLER_PLATFORM=linux-x64 python3 tools/package-installer.py
```
界面采用与 Framely 一致的深色、细边框和淡蓝色选中状态,分为连接设备、选择版本、安装与维护三个页面。连接时显示建立 SSH、认证、权限检查、版本读取及指纹保存的进度;失败在页面中显示原因,并恢复按钮以便重试。未连接设备或未选择安装包时,下一步按钮说明当前缺少的条件。可用模拟数据渲染页面以及连接中、失败和成功状态的预览图,不连接真实设备:
```bash
cargo build --manifest-path installer/Cargo.toml --locked --features visual-test
FRAMELY_INSTALLER_PREVIEW_DIR=installer/dist/previews installer/target/debug/framely-installer
```
预览依赖可用的 GPU 或软件 Vulkan 渲染器;默认发行构建不包含此预览功能。
安装器版本由本目录的 `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 代码签名,发布前应分别验证系统的首次启动体验。
安装器标题栏和应用图标使用统一的像素 Logo。Windows 构建将 ICO 嵌入 EXE,macOS 打包使用系统 `iconutil` 生成并配置 `.icns`。Linux 解压后可在解压目录执行 `bash install-desktop-entry.sh`,把带图标的入口注册到当前用户的应用菜单;入口指向该目录,移动后需重新执行脚本。
安装器压缩包不包含独立的 `assets` 目录。界面 Logo 内嵌在可执行文件中,Linux 注册脚本内嵌菜单图标,macOS 的应用图标保存在 `.app` 内部。
所有自动测试和 Actions 构建只能验证软件及产物;仍需在真实电脑和 Frame 上完成扫描、登录、权限、升级回滚及卸载验收。
扫描会直接查询 `frame.local` 的 mDNS 地址记录,不要求设备广播 SSH 服务,也不依赖电脑的系统 DNS 支持 `.local`。可单独运行与界面相同的发现逻辑进行诊断:
```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 的设置。保存会清除版本选择,下次检查版本使用新配置;包校验继续启用。
+5 -2
View File
@@ -3,7 +3,7 @@
set -euo pipefail
base=$(cd -- "$(dirname -- "$0")" && pwd)
python3 - "$base" <<'PY'
import os, pathlib, shutil
import os, pathlib
base = pathlib.Path(__import__('sys').argv[1])
binary = base / 'framely-installer'
if not binary.is_file():
@@ -13,7 +13,10 @@ apps = data / 'applications'
icons = data / 'icons/hicolor/scalable/apps'
apps.mkdir(parents=True, exist_ok=True)
icons.mkdir(parents=True, exist_ok=True)
shutil.copy2(base / 'assets/branding/framely-app-icon.svg', icons / 'org.framely.installer.svg')
icon = None # Embedded by tools/package-installer.py.
if icon is None:
icon = (base.parent / 'assets/branding/framely-app-icon.svg').read_bytes()
(icons / 'org.framely.installer.svg').write_bytes(icon)
# Desktop entries parse backslash escapes before parsing the quoted Exec value.
quoted = str(binary).replace('%', '%%').replace('\\', '\\\\')
for character in ('"', '`', '$'):
+108
View File
@@ -0,0 +1,108 @@
use super::*;
use gpui_kit::component::dialog::DialogButtonProps;
use gpui_kit::prelude::FluentBuilder;
#[derive(Clone, PartialEq, Eq)]
pub(super) enum Prompt {
Operation(String),
Notice(String, String),
Outcome(String, Result<(), String>),
}
impl Installer {
pub(super) fn queue_prompt(&mut self, prompt: Prompt) {
if !self.prompts.contains(&prompt) {
self.prompts.push_back(prompt);
}
}
pub(super) fn notice(&mut self, title: impl Into<String>, message: impl Into<String>) {
self.queue_prompt(Prompt::Notice(title.into(), message.into()));
}
pub(super) fn present_prompt(&mut self, window: &mut Window, cx: &mut Context<Self>) {
if window.has_active_dialog(cx) {
return;
}
let Some(prompt) = self.prompts.pop_front() else {
return;
};
if let Prompt::Operation(action) = &prompt {
if self.confirmation.as_ref() != Some(action) {
return;
}
}
let device = self.connected_host.clone();
let version = if self.local {
self.archive.as_ref().map(|p| p.display().to_string())
} else {
self.selected
.and_then(|i| self.releases.get(i))
.map(|r| r.tag_name.clone())
};
let view = cx.entity().downgrade();
window.open_alert_dialog(cx, move |dialog, _, _| {
let close_view = view.clone();
let action_view = view.clone();
let (title, message, ok, cancel) = match &prompt {
Prompt::Operation(action) => (
format!("确认{}?", ui::action_label(action)),
if action == "uninstall" {
"将停用并卸载所有插件,然后移除 Framely。插件卸载失败时保留本体;已保存的数据保留。".into()
} else {
"设备上的 Framely 服务可能会暂时中断,插件和已保存的数据会保留。".into()
},
format!("确认{}", ui::action_label(action)),
true,
),
Prompt::Notice(title, message) => (title.clone(), message.clone(), "知道了".into(), false),
Prompt::Outcome(action, result) => (
format!("{}{}", ui::action_label(action), if result.is_ok() { "完成" } else { "失败" }),
match result {
Ok(()) if action == "uninstall" => "Framely 已卸载。已保存的数据保留;重新连接后可再次安装。".into(),
Ok(()) => "操作已完成。请重新连接设备,读取最新版本和可用操作。".into(),
Err(error) => format!("{error}\n\n可关闭弹窗查看日志,重新连接设备后再试。"),
},
"返回设备连接".into(),
false,
),
};
let close_prompt = prompt.clone();
let action_prompt = prompt.clone();
dialog
.width(px(540.))
.close_button(true)
.title(title)
.child(
div().id("installer-prompt-content").flex().flex_col().gap_3()
.max_h(px(360.)).overflow_y_scroll().text_sm()
.when(matches!(prompt, Prompt::Operation(_)), |body| {
body.child(format!("设备:{device}"))
.when(matches!(&prompt, Prompt::Operation(action) if maintenance::requires_package(action)), |body| {
body.child(format!("版本 / 安装包:{}", version.as_deref().unwrap_or("未选择")))
})
})
.child(message),
)
.button_props(DialogButtonProps::default().ok_text(ok).cancel_text("取消").show_cancel(cancel))
.on_ok(move |_, _, cx| {
let _ = action_view.update(cx, |view, cx| match &action_prompt {
Prompt::Operation(action) if view.confirmation.as_ref() == Some(action) => view.operate(cx),
Prompt::Outcome(_, _) => view.navigate(0, cx),
_ => {}
});
true
})
.on_close(move |_, _, cx| {
let _ = close_view.update(cx, |view, cx| {
if let Prompt::Operation(action) = &close_prompt {
if view.confirmation.as_ref() == Some(action) {
view.confirmation = None;
}
}
cx.notify();
});
})
});
}
}
+2
View File
@@ -1,6 +1,8 @@
pub mod discovery;
pub mod instance;
pub mod maintenance;
pub mod progress;
pub mod proxy;
pub mod release;
pub mod remote;
pub const DEFAULT_REPO: &str = "SteamFramelyHomebrew/framely";
+365 -17
View File
@@ -3,6 +3,7 @@ use framely_installer::{
DEFAULT_REPO,
discovery::{self, Device},
maintenance::{self, Installation},
progress::{Progress, Stage},
release::{self, Release},
remote::{self, Connection, Credentials, Probe},
};
@@ -16,6 +17,7 @@ use gpui_kit::{
*,
};
use std::{
collections::VecDeque,
path::PathBuf,
sync::{
Arc, Mutex,
@@ -40,10 +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,
@@ -69,7 +76,9 @@ struct Installer {
scan_id: u64,
cancelled: Arc<AtomicBool>,
confirmation: Option<String>,
prompts: VecDeque<dialogs::Prompt>,
operation_result: Option<(String, Result<(), String>)>,
progress: Option<Progress>,
logs: Vec<String>,
status: String,
error: Option<String>,
@@ -98,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")
@@ -134,10 +152,12 @@ impl Installer {
scan_id: 0,
cancelled: Arc::new(AtomicBool::new(false)),
confirmation: None,
prompts: VecDeque::new(),
operation_result: None,
progress: None,
logs: Vec::new(),
status: "开启 Frame 开发者模式并设置密码,将电脑和 Frame 连接到同一网络。".into(),
error: None,
error: proxy_error,
release_error: None,
connection_stage: None,
sender,
@@ -187,7 +207,7 @@ impl Installer {
.timer(Duration::from_millis(100))
.await;
if weak
.update(cx, |view: &mut Installer, cx| view.poll(cx))
.update_in(cx, |view: &mut Installer, window, cx| view.poll(window, cx))
.is_err()
{
break;
@@ -197,7 +217,7 @@ impl Installer {
.detach();
view
}
fn poll(&mut self, cx: &mut Context<Self>) {
fn poll(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let mut changed = false;
while let Ok(event) = self.receiver.try_recv() {
changed = true;
@@ -225,6 +245,7 @@ impl Installer {
}
Err(error) => {
self.status = error.clone();
self.notice("扫描失败", error.clone());
self.error = Some(error);
}
}
@@ -239,6 +260,10 @@ impl Installer {
}
Err(error) => {
self.status = error.clone();
self.notice(
"无法加载在线版本",
format!("可刷新重试,或选择本地安装包。\n\n{error}"),
);
self.release_error =
Some(format!("无法加载在线版本,可重试或选择本地安装包。{error}"));
}
@@ -253,6 +278,7 @@ impl Installer {
}
Err(error) => {
self.status = error.clone();
self.notice("SSH 连接检查失败", error.clone());
self.error = Some(error);
}
}
@@ -281,6 +307,7 @@ impl Installer {
}
Err(error) => {
self.status = error.clone();
self.notice("设备登录失败", error.clone());
self.error = Some(error);
}
}
@@ -302,6 +329,24 @@ impl Installer {
self.logs.remove(0);
}
}
Event::Progress(progress) => {
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;
@@ -310,6 +355,21 @@ 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(),
));
self.operation_result = Some((self.chosen_action.clone(), result));
// Avoid presenting a stale version or reusing an interrupted SSH channel.
self.connection = None;
@@ -323,6 +383,61 @@ impl Installer {
if changed {
cx.notify();
}
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);
@@ -356,6 +471,7 @@ impl Installer {
let Ok(port) = port else {
self.status = "SSH 端口无效".into();
self.error = Some(self.status.clone());
self.notice("无法检查连接", self.status.clone());
cx.notify();
return;
};
@@ -365,6 +481,7 @@ impl Installer {
self.device_state = None;
self.confirmation = None;
self.operation_result = None;
self.progress = None;
self.status = "正在检查 SSH 连接…".into();
self.probe = None;
self.connected_host = format!("{host}:{port}");
@@ -386,11 +503,13 @@ impl Installer {
self.probe = None;
self.status = "地址已变化,请重新检查 SSH。".into();
self.error = Some(self.status.clone());
self.notice("设备地址已变化", self.status.clone());
cx.notify();
return;
}
if self.password.read(cx).value().is_empty() {
self.error = Some("请输入设备登录密码".into());
self.notice("无法登录设备", "请输入设备登录密码。");
cx.notify();
return;
}
@@ -436,7 +555,7 @@ impl Installer {
} else {
self.selected
.and_then(|i| self.releases.get(i))
.is_some_and(|r| release::package(r).is_ok())
.is_some_and(|r| release::package_for(r, &self.chosen_action).is_ok())
}
}
fn action_available(&self, action: &str) -> bool {
@@ -453,7 +572,7 @@ impl Installer {
} else {
self.selected
.and_then(|i| self.releases.get(i))
.and_then(|r| release::package(r).ok())
.and_then(|r| release::package_for(r, "update").ok())
.map(|(package, _)| package.name.as_str())
};
self.chosen_action == "update"
@@ -465,6 +584,7 @@ impl Installer {
}
fn request_operation(&mut self, cx: &mut Context<Self>) {
if self.busy
|| self.confirmation.is_some()
|| self.connection.is_none()
|| !self.action_available(&self.chosen_action)
|| self.same_update()
@@ -476,6 +596,31 @@ impl Installer {
return;
}
self.confirmation = Some(self.chosen_action.clone());
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>) {
@@ -485,6 +630,7 @@ impl Installer {
if page == 2 && self.connection.is_none() && !self.preview {
self.page = 0;
self.error = Some("请先连接 Frame,再进行安装或维护".into());
self.notice("请先连接设备", "请先连接 Frame,再进行安装或维护。");
cx.notify();
return;
}
@@ -521,11 +667,13 @@ impl Installer {
|| (maintenance::requires_package(&action) && !self.selection_ready())
{
self.error = Some("操作条件已变化,请重新选择操作或版本".into());
self.notice("无法执行操作", "操作条件已变化,请重新选择操作或版本。");
cx.notify();
return;
}
let Some(connection) = self.connection.clone() else {
self.status = "请先连接设备".into();
self.notice("请先连接设备", "连接后重新选择操作。");
cx.notify();
return;
};
@@ -539,6 +687,7 @@ impl Installer {
self.error = None;
self.logs.clear();
self.operation_result = None;
self.progress = Some(Progress::new(Stage::Prepare, "正在准备操作…"));
self.status = format!("正在执行 {action}…");
let sender = self.sender.clone();
std::thread::spawn(move || {
@@ -547,6 +696,9 @@ impl Installer {
let mut log = |line| {
let _ = sender.send(Event::Log(line));
};
let mut progress = |value| {
let _ = sender.send(Event::Progress(value));
};
let (archive, sums) = if matches!(action.as_str(), "install" | "update") {
if local {
(
@@ -556,18 +708,30 @@ impl Installer {
} else {
let selected =
selected.ok_or_else(|| anyhow::anyhow!("请选择 Release 版本"))?;
let (package, checksum) = release::package(&selected)?;
let (package, checksum) = release::package_for(&selected, &action)?;
let archive = folder.path().join(&package.name);
let sums = folder.path().join("SHA256SUMS");
release::download(checksum, &sums, &mut log)?;
release::download(package, &archive, &mut log)?;
let total = checksum
.size
.checked_add(package.size)
.ok_or_else(|| anyhow::anyhow!("下载长度无效"))?;
log(format!("下载 {}", package.name));
for (asset, path, offset) in
[(checksum, &sums, 0), (package, &archive, checksum.size)]
{
release::download(asset, path, &mut |mut value| {
value.completed += offset;
value.total = Some(total);
progress(value);
})?;
}
(Some(archive), Some(sums))
}
} else {
(None, None)
};
if let (Some(archive), Some(sums)) = (&archive, &sums) {
release::verify(archive, sums)?;
release::verify_with_progress(archive, sums, &mut progress)?;
log("电脑端 SHA256 校验通过,开始传输;设备端将再次校验。".into());
}
remote::operate(
@@ -580,6 +744,7 @@ impl Installer {
repo: &repo,
},
&mut log,
&mut progress,
)
})()
.map_err(|e| format!("{e:#}"));
@@ -593,6 +758,7 @@ impl Drop for Installer {
self.cancelled.store(true, Ordering::Relaxed);
}
}
mod dialogs;
mod ui;
fn transparent_window_root(window: &mut Window, cx: &mut App) {
@@ -639,6 +805,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
gpui_kit::platform::current_headless_renderer,
);
context.update(initialize_theme);
context.update(|cx| cx.set_reduce_motion(true));
let (handle, view) = context.update(|cx| {
gpui_kit::open_window(
WindowOptions {
@@ -670,6 +837,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
(0, "devices"),
(1, "versions"),
(2, "maintenance"),
(3, "settings"),
(1, "local"),
(0, "empty"),
(0, "connecting"),
@@ -680,10 +848,18 @@ 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| {
window.close_all_dialogs(cx);
view.update(cx, |view, cx| {
view.prompts.clear();
view.confirmation = None;
view.error = None;
view.release_error = None;
view.operation_result = None;
view.progress = None;
view.page = page;
view.local = name == "local";
if name == "empty" {
@@ -697,7 +873,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
view.sender
.send(Event::ConnectionStage("正在验证用户名和密码…".into()))
.unwrap();
view.poll(cx);
view.poll(window, cx);
assert!(view.busy && view.connection_stage.is_some());
} else if name == "connection-error" {
view.sender
@@ -705,7 +881,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
"SSH 登录失败:请检查用户名和密码,并确认已开启开发者模式".into(),
)))
.unwrap();
view.poll(cx);
view.poll(window, cx);
assert!(!view.busy && view.connection_stage.is_none() && view.error.is_some());
} else if name == "connected" {
view.connected_host = "192.168.1.42:22".into();
@@ -722,7 +898,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
},
})))
.unwrap();
view.poll(cx);
view.poll(window, cx);
assert!(
view.connection.is_some()
&& !view.busy
@@ -736,7 +912,7 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
view.sender
.send(Event::Releases(Err("GitHub API: status code 404".into())))
.unwrap();
view.poll(cx);
view.poll(window, cx);
assert!(!view.busy && view.error.is_none() && view.release_error.is_some());
}
if name == "installed-no-package" {
@@ -789,22 +965,48 @@ 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())
}))
.unwrap();
view.poll(cx);
view.poll(window, cx);
assert!(
view.operation_result.is_some()
&& view.connection.is_none()
&& 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();
});
@@ -816,6 +1018,152 @@ fn preview_pages(dir: PathBuf) -> anyhow::Result<()> {
.capture_screenshot(handle)?
.save(dir.join(format!("installer-{name}.png")))?;
}
// Exercise actual modal hit testing, cancellation and stale confirmation.
for action in ["install", "update", "repair", "rollback", "uninstall"] {
context.update_window(handle, |_, window, cx| {
window.close_all_dialogs(cx);
view.update(cx, |view, cx| {
view.page = 2;
view.busy = false;
view.operation_result = None;
view.progress = None;
view.prompts.clear();
view.confirmation = None;
view.error = None;
view.release_error = None;
view.status = "已连接 192.168.1.42:frame · 0.4.0".into();
view.local = false;
view.selected = Some(0);
view.releases[0].tag_name = "v0.4.1".into();
view.device_state = Some(Installation {
present: action != "install",
current_version: (action != "install").then(|| "0.4.0".into()),
previous_version: Some("0.3.9".into()),
});
view.connection = Some(Arc::new(Mutex::new(Connection {
session: ssh2::Session::new().unwrap(),
host: "192.168.1.42".into(),
user: "steamos".into(),
version: "frame · 0.4.0".into(),
installation: view.device_state.clone().unwrap(),
})));
view.chosen_action = action.into();
view.request_operation(cx);
view.request_operation(cx);
assert_eq!(
view.prompts.len(),
1,
"double activation must not queue two confirmations"
);
view.poll(window, cx);
assert!(view.confirmation.is_some());
});
window.render_frame(cx);
assert!(window.has_active_dialog(cx));
assert!(window.find("dialog").visible());
window.click("step-0", cx);
assert_eq!(
view.read(cx).page,
2,
"modal must block background navigation"
);
})?;
context.run_until_parked();
context.update_window(handle, |_, window, cx| window.render_frame(cx))?;
context
.capture_screenshot(handle)?
.save(dir.join(format!("installer-confirm-{action}.png")))?;
context.update_window(handle, |_, window, cx| {
window.within("dialog").click("cancel", cx);
window.render_frame(cx);
assert!(!window.has_active_dialog(cx));
assert!(view.read(cx).confirmation.is_none() && !view.read(cx).busy);
view.update(cx, |view, cx| {
view.request_operation(cx);
view.poll(window, cx);
});
window.render_frame(cx);
window.press("escape", cx);
window.render_frame(cx);
assert!(!window.has_active_dialog(cx));
assert!(view.read(cx).confirmation.is_none() && !view.read(cx).busy);
view.update(cx, |view, cx| {
view.request_operation(cx);
view.poll(window, cx);
});
window.render_frame(cx);
window.within("dialog").click("close", cx);
window.render_frame(cx);
assert!(!window.has_active_dialog(cx));
assert!(view.read(cx).confirmation.is_none() && !view.read(cx).busy);
view.update(cx, |view, cx| {
view.request_operation(cx);
view.poll(window, cx);
});
window.render_frame(cx);
view.update(cx, |view, _| {
view.device_state = None;
});
window.within("dialog").click("ok", cx);
assert!(
!view.read(cx).busy,
"stale confirmation must not start SSH operations"
);
view.update(cx, |view, cx| view.poll(window, cx));
window.render_frame(cx);
assert!(
window.has_active_dialog(cx),
"stale confirmation must show an error dialog"
);
window.within("dialog").click("ok", cx);
window.render_frame(cx);
assert!(!window.has_active_dialog(cx));
})?;
}
for (stage, name) in [
(Stage::Download, "download"),
(Stage::Verify, "verify"),
(Stage::Transfer, "transfer"),
(Stage::Install, "install"),
] {
context.update_window(handle, |_, window, cx| {
view.update(cx, |view, cx| {
view.chosen_action = "install".into();
view.error = None;
view.release_error = None;
view.busy = true;
view.local = false;
view.logs = vec!["电脑端 SHA256 校验通过。".into()];
let mut progress = Progress::new(
stage,
match stage {
Stage::Download => "framely-0.4.1-linux-arm64.tar.gz",
Stage::Verify => "校验本地安装包 SHA256",
Stage::Transfer => "framely-0.4.1-linux-arm64.tar.gz",
_ => "解压并校验发行文件",
},
);
if stage != Stage::Verify {
progress.completed = 25 * 1048576;
progress.total = Some(100 * 1048576);
}
if stage == Stage::Install {
progress.step = Some((3, 5));
}
view.sender.send(Event::Progress(progress)).unwrap();
view.poll(window, cx);
assert_eq!(view.progress.as_ref().unwrap().stage, stage);
});
window.render_frame(cx);
assert!(window.find("operation-progress").visible());
})?;
context.run_until_parked();
context.update_window(handle, |_, window, cx| window.render_frame(cx))?;
context
.capture_screenshot(handle)?
.save(dir.join(format!("installer-progress-{name}.png")))?;
}
eprintln!("Installer modal and progress checks passed.");
Ok(())
}
+4 -3
View File
@@ -27,9 +27,10 @@ impl Installation {
}
}
pub fn same_package(&self, name: &str) -> bool {
self.current_version
.as_ref()
.is_some_and(|version| name == format!("framely-{version}-linux-arm64.tar.gz"))
self.current_version.as_ref().is_some_and(|version| {
name == format!("framely-{version}-linux-arm64.tar.gz")
|| name == format!("framely-{version}-offline-linux-arm64.tar.gz")
})
}
}
pub fn requires_package(action: &str) -> bool {
+209
View File
@@ -0,0 +1,209 @@
use anyhow::{Result, ensure};
use serde::Deserialize;
use std::{
io::{Read, Write},
time::{Duration, Instant},
};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Stage {
Prepare,
Download,
Verify,
Transfer,
Install,
}
#[derive(Clone, Debug)]
pub struct Progress {
pub stage: Stage,
pub detail: String,
pub completed: u64,
pub total: Option<u64>,
pub step: Option<(u8, u8)>,
}
impl Progress {
pub fn new(stage: Stage, detail: impl Into<String>) -> Self {
Self {
stage,
detail: detail.into(),
completed: 0,
total: None,
step: None,
}
}
pub fn fraction(&self) -> Option<f32> {
self.total
.filter(|total| *total > 0)
.map(|total| (self.completed.min(total) as f64 / total as f64) as f32)
}
}
// Report small files too, throttle large streams, and only report completion
// after checking the exact byte count. The same path handles HTTPS and SFTP.
pub fn copy(
reader: &mut impl Read,
writer: &mut impl Write,
total: u64,
stage: Stage,
detail: &str,
report: &mut dyn FnMut(Progress),
) -> Result<()> {
let mut value = Progress::new(stage, detail);
value.total = Some(total);
report(value.clone());
let mut block = [0; 256 * 1024];
let mut last = Instant::now();
loop {
let n = reader.read(&mut block)?;
if n == 0 {
break;
}
ensure!(value.completed + n as u64 <= total, "传输超过声明长度");
writer.write_all(&block[..n])?;
value.completed += n as u64;
if last.elapsed() >= Duration::from_millis(200) {
report(value.clone());
last = Instant::now();
}
}
ensure!(value.completed == total, "传输未完成");
writer.flush()?;
report(value);
Ok(())
}
#[derive(Deserialize)]
struct DeviceStep {
step: String,
completed: Option<u64>,
total: Option<u64>,
}
#[derive(Default)]
pub struct DeviceProgress {
pending: String,
}
impl DeviceProgress {
pub fn push(&mut self, chunk: &str, report: &mut dyn FnMut(Progress)) -> Vec<String> {
let mut logs = Vec::new();
self.pending.push_str(chunk);
while let Some(end) = self.pending.find('\n') {
let line: String = self.pending.drain(..=end).collect();
let Some(json) = line.trim().strip_prefix("FRAMELY_PROGRESS ") else {
logs.push(line);
continue;
};
let Ok(step) = serde_json::from_str::<DeviceStep>(json) else {
continue;
};
let (index, detail) = match step.step.as_str() {
"verify" => (1, "设备端校验安装包"),
"stage" => (2, "准备设备安装目录"),
"extract" => (3, "解压并校验发行文件"),
"configure" => (4, "配置账号、安装文件与系统服务"),
"cef-download" => (4, "设备下载 CEF 运行库"),
"activate" => (5, "启动服务并检查安装状态"),
_ => continue,
};
if step
.total
.is_some_and(|total| total == 0 || step.completed.unwrap_or(0) > total)
{
continue;
}
let mut value = Progress::new(
if step.step == "cef-download" {
Stage::Download
} else {
Stage::Install
},
detail,
);
if step.step != "cef-download" {
value.step = Some((index, 5));
}
value.completed = step.completed.unwrap_or(0);
value.total = step.total;
report(value);
}
if self.pending.len() > 8192 {
logs.push(std::mem::take(&mut self.pending));
}
logs
}
pub fn finish(&mut self) -> String {
let pending = std::mem::take(&mut self.pending);
if pending.trim().starts_with("FRAMELY_PROGRESS ") {
String::new()
} else {
pending
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn byte_progress_reports_small_files_and_rejects_incomplete_or_oversized_streams() {
let mut reports = Vec::new();
let mut output = Vec::new();
copy(
&mut &b"payload"[..],
&mut output,
7,
Stage::Transfer,
"package",
&mut |p| reports.push(p),
)
.unwrap();
assert_eq!(output, b"payload");
assert_eq!(reports.first().unwrap().completed, 0);
assert_eq!(reports.last().unwrap().fraction(), Some(1.0));
for declared in [6, 8] {
let mut reports = Vec::new();
assert!(
copy(
&mut &b"payload"[..],
&mut Vec::new(),
declared,
Stage::Download,
"package",
&mut |p| reports.push(p)
)
.is_err()
);
assert!(reports.iter().all(|p| p.fraction() != Some(1.0)));
}
assert_eq!(Progress::new(Stage::Install, "working").fraction(), None);
}
#[test]
fn device_progress_handles_split_lines_and_rejects_invalid_events() {
let mut decoder = DeviceProgress::default();
let mut reports = Vec::new();
let mut report = |p| reports.push(p);
assert_eq!(
decoder.push("service output\nFRAMELY_PRO", &mut report),
["service output\n"]
);
decoder.push("GRESS {\"step\":\"extract\",\"completed\":2,", &mut report);
decoder.push(
"\"total\":8}\nFRAMELY_PROGRESS {\"step\":\"configure\"}\n",
&mut report,
);
decoder.push("FRAMELY_PROGRESS {\"step\":\"unknown\"}\nFRAMELY_PROGRESS {\"step\":\"extract\",\"completed\":9,\"total\":8}\n", &mut report);
assert_eq!(reports.len(), 2);
assert_eq!(reports[0].fraction(), Some(0.25));
assert_eq!(reports[0].step, Some((3, 5)));
assert_eq!(reports[1].step, Some((4, 5)));
assert_eq!(reports[1].fraction(), None);
decoder.push(
"FRAMELY_PROGRESS {\"step\":\"cef-download\",\"completed\":50,\"total\":100}\n",
&mut |p| reports.push(p),
);
assert_eq!(reports[2].stage, Stage::Download);
assert_eq!(reports[2].fraction(), Some(0.5));
assert_eq!(reports[2].step, None);
}
}
Loaded 100 of 308 files, more files were not shown because too many files have changed in this diff. Show more