Files
Toastconcern--FrameStudio/docs/README.md
T
ToastconcernandClaude Opus 5.5 3469b77ca3 Frame Home on a PC with SteamVR (Windows, Linux); thumbnails from the spawn
- src/home_platform.h: what Frame Home and the panel need from the system (paths, finding and stopping each
  other, running a tool, restarting, priorities) for SteamOS, Windows and Linux PCs. On a PC the environments are
  Frame Studio's My Environments; Frame Home's own files in %LOCALAPPDATA%\Frame Home (Windows).
- src/openvr_loader.cpp: a PC build finds SteamVR's own OpenVR library at run time (openvrpaths.vrpath), so it runs
  on any PC with SteamVR; Vulkan through volk. CMake: FRAME_HOME_PC (default on Windows and x86-64 Linux); the Steam
  Frame build is unchanged.
- Windows: Frame Home is SteamVR's home app; SteamVR's classic environment shows a 360-degree picture of the current
  home from its spawn (frame-home --panorama --spawn, made by the panel when the home changes) instead of Aurora
  while Frame Home starts. Linux PCs: the Steam Frame's compositor layer, as on the headset.
- frame/pc: install-frame-home-pc.ps1 (+ .bat): online through SteamVR's API or offline in its config files; the
  SteamVR settings it changes are saved and restored exactly on -Uninstall (tested in a sandbox both ways).
  frame-switcher --uninstall. Studio: Properties > Headset > This PC installs it from pc/ beside Studio.
- Packaging and CI: pc/ in the Windows x64 and Linux x64 Studio downloads; FrameHome-PC-windows-x64.zip.
- Thumbnails come from where Frame Home starts you (the first spawn, eyes 1.6 m up): Studio's saves and the
  panel's (frame-home --snapshot --spawn).
- docs/pc-steamvr.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-21 14:37:49 -05:00

1.3 KiB

Frame Studio and Frame Home documentation

Guide What it covers
Getting started What the two programs are, system requirements, downloads, first launch, a 5-minute walkthrough
Preparing the Steam Frame Developer mode, SSH, the headset's address, an SSH key and a frame entry
Installing Frame Home Three ways to install, what goes where, updating, uninstalling, the off switch
Using Frame Home The Environments panel, adding environments, moving around, every setting
Environments and .fenv The .fenv format, converting homes with fenv-tool, per-world settings and tuning
Performance How Frame Home reaches 120 fps, checking it, fixing stutter, Studio's own pacing
Frame Studio guide The Studio window, tools and panels
Bundles Several environments in one .fbundle file
Frame Home on a PC Your homes as SteamVR's environment on a Windows or Linux PC
Building from source Building on each system, the CI, the headset side, the repository layout
Troubleshooting Symptoms and fixes, logs, the self-test