Framely

简体中文

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, connect to the device, and install Framely. Alternatively, run this in the Frame SSH terminal to install the latest stable release:

curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install

For a Preview release, specify an actual published tag:

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:

• Install, update, repair, roll back, and uninstall
• Basic usage · Install and manage plugins
• Network management panel
• Plugin development through publishing · Publish plugins and sources
• SDK API · Manifest configuration · Lifecycle
• Plugin template · Showcase example
• Core release maintenance · Build the installer

Create a plugin

Install Node.js 22 and npm on your development computer, clone this repository, and run:

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.

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 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. 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.