mirror of
https://github.com/Toastconcern/FrameStudio.git
synced 2026-10-29 04:02:56 +01:00
ToastconcernandClaude Opus 4.8
d22cc04cb3
On the Steam Frame a layer inside SteamVR's compositor draws the home where it would draw Aurora, so the home is the environment itself: at boot, during game loads, behind the Steam menu, with the controllers and passthrough, and it steps aside for a game the instant it opens. On a PC this was faked with SteamVR's home-app slot and a flat 360 photo in the gaps, which launched and handed off like an app and showed a picture, not the live home. This does it properly on any PC that runs SteamVR, the Frame's way: - Windows: the compositor is Direct3D 11, so the layer is a proxy d3d11.dll beside the compositor (layer/ frame_home_layer_d3d11.cpp, built from the .def that forwards every other export to the real d3d11.dll, kept as fh_d3d11real.dll). It wraps the compositor's device, finds Aurora's draws by their shader bytecode and draws the home over the sky, leaving the floor and stars off; everything else passes straight through. Pure pass-through in any process that isn't vrcompositor. - The home's frames cross from Frame Home (Vulkan) to the compositor (D3D11): the layer owns kSlots shared textures and hands Frame Home their NT handles over a named pipe; Frame Home imports them (VK_KHR_external_memory_win32) and renders into them. No cross-API lock — a slot is published only once the GPU has finished it and the four rotate, as on Linux. The shared State stays Frame Home's. - The Environments panel runs frame-home --system and keeps it alive (one at a time, a pid file across panel restarts), the same systemEnv path as the Frame. The installer places/removes the proxy and marks the layer with a root/layer folder, in place of the old home-app registration and background pictures. - Safe like the Vulkan layer: no home, or one stale over half a second, and the compositor draws Aurora as usual; the layer turns itself off after two unhealthy compositor starts, and root/layer/off turns it off by hand. Linux keeps its Vulkan layer (unchanged). Verified without a headset on the null driver: the proxy loads and wraps the compositor without crashing, recognises Aurora's shaders, and the frame hand-over completes (Frame Home connects, imports the textures, renders). The compositor only draws the environment while presenting to a headset, so the final on-headset image is the one step the null driver can't exercise. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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 |