SteamFramelyHomebrew--framely/docs

Framely documentation

简体中文

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: desktop installer, SSH, Preview builds, local packages and rollback.
2. Basic usage: Dock, manager, enabling plugins, favorites and safe mode.
3. Install and manage plugins: plugin library, sources, subscriptions, local packages and updates.
4. Network panel: address, first password setup, login and phone/desktop access.
5. APK Manager: sideload installation, updates, containers, retained data and cleanup.
6. Terminal and files: user-owned terminal sessions, file operations, recycle bin, transfers and previews.

Plugin development and publishing

• Complete workflow: scaffold → preview → backend → package → device testing → publish.
• SDK API · Manifest configuration · Lifecycle
• Publish plugins and catalogs: default GitHub URLs, custom URLs/hashes, catalog history and database registration.
• Plugin template: React and Python, generated projects or in-repository editing.
• Showcase plugin: additional UI and device examples.

Technical references

Reference	Contents
Plugin development reference	Manifest, windows, notifications, JSON RPC and packaging
Lifecycle	Install, update, start, stop, uninstall and recovery hooks
Dependencies and conflicts	Version ranges, source selection and exclusive resources
Source subscriptions	JSON format, refresh, URL changes and deduplication
Localization	Language packs and community translations

Maintainer documentation

• Framely releases and updates

• Desktop installer

• Space launcher

• Launcher actions and host compatibility