SteamFramelyHomebrew--framely/README.md

Framely

English

Steam Frame 的 React 插件管理器：Rust 核心服务、独立 CEF/OpenVR 宿主、网络管理面板和电脑端安装器。可管理插件、来源、窗口、通知和更新。

安装

目标为 Linux ARM64 Steam Frame。电脑端从 Releases 下载对应平台的 Framely Installer，连接设备后安装本体。也可在 Frame 的 SSH 终端安装最新正式版：

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

安装 Preview 时指定实际已发布的标签：

curl -fsSL https://raw.githubusercontent.com/SteamFramelyHomebrew/framely/main/install.sh | bash -s -- install --version v0.4.2-preview.3

运行包包含 CEF，设备无需 Node.js 或 Rust。安装会请求 sudo；不会自动解除 SteamOS 只读保护。打开 SteamVR Dashboard 的 Framely Dock 图标进入快捷菜单，从“设置 → 管理插件”打开管理窗口。

网络面板默认端口 15915，手机/电脑访问 http://设备IP:15915。未配置密码时首次访问必须设置并确认密码，保存后登录。设备密码与面板密码相互独立。

文档

从 文档首页 开始：

• 安装、更新、修复、回滚与卸载
• 基本使用 · 插件安装与管理
• 网络管理面板
• 插件开发到发布完整流程 · 发布插件和插件源
• SDK API · Manifest 配置 · 生命周期
• 插件模板 · 功能展示示例
• 本体发行维护 · 安装器构建

创建插件

开发机准备 Node.js 22 和 npm，克隆本仓库后执行：

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。

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 构建、集成测试和发布命令见发行维护。插件支持 steamos 和 root；哈希校验不代表安全审核，应核对来源和运行用户。

许可证

Framely 原创代码，包括本体、安装器、SDK、模板和仓库示例，采用 AGPL-3.0-only，全文见 LICENSE。第三方依赖和 vendored 文件保留各自许可证。

AGPL 允许商业使用；分发需按许可提供完整对应源码，修改后通过网络与用户交互还须向这些用户提供源码。发行源码对应本仓库的 v<版本> 或 installer-v<版本> 标签；重新分发者须提供与自己二进制匹配的修改和构建脚本。