mirror of
https://github.com/Toastconcern/FrameStudio.git
synced 2026-10-29 03:02:30 +01:00
Getting started, headset setup, installing and using Frame Home, the .fenv format and fenv-tool, performance, building, troubleshooting, and an index. Stubs for the Studio guide and bundles. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
15 lines
1.2 KiB
Markdown
15 lines
1.2 KiB
Markdown
# Frame Studio and Frame Home documentation
|
|
|
|
| Guide | What it covers |
|
|
|---|---|
|
|
| [Getting started](getting-started.md) | What the two programs are, system requirements, downloads, first launch, a 5-minute walkthrough |
|
|
| [Preparing the Steam Frame](headset-setup.md) | Developer mode, SSH, the headset's address, an SSH key and a `frame` entry |
|
|
| [Installing Frame Home](install-frame-home.md) | Three ways to install, what goes where, updating, uninstalling, the off switch |
|
|
| [Using Frame Home](using-frame-home.md) | The Environments panel, adding environments, moving around, every setting |
|
|
| [Environments and .fenv](environments-and-fenv.md) | The `.fenv` format, converting homes with `fenv-tool`, per-world settings and tuning |
|
|
| [Performance](performance.md) | How Frame Home reaches 120 fps, checking it, fixing stutter, Studio's own pacing |
|
|
| [Frame Studio guide](studio-guide.md) | The Studio window, tools and panels (being written) |
|
|
| [Bundles](bundles.md) | Several environments in one `.fbundle` file (being written) |
|
|
| [Building from source](building.md) | Building on each system, the CI, the headset side, the repository layout |
|
|
| [Troubleshooting](troubleshooting.md) | Symptoms and fixes, logs, the self-test |
|