mirror of
https://github.com/Toastconcern/FrameStudio.git
synced 2026-10-29 00:02:23 +01:00
Docs follow the Headset menu and tab; tune's usage and settings comments corrected
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
701486a98f
commit
5b449908e4
8 files changed
+16
-16
No files matched your search
@@ -11,10 +11,10 @@ headset runs, and lets you edit, save and send them to the headset.
|
||||
1. **Download** Frame Studio for your computer from the Releases page (**Latest build**, or a version release) and
|
||||
unpack it. See [Getting started](docs/getting-started.md).
|
||||
2. **Prepare the headset** once: developer mode, SSH and a key. See [Preparing the Steam Frame](docs/headset-setup.md).
|
||||
3. **Install Frame Home**: in Studio, **Frame > Install on Steam Frame...**, then **Install**.
|
||||
3. **Install Frame Home**: in Studio, **Headset > Install on Steam Frame...**, then **Install Frame Home**.
|
||||
See [Installing Frame Home](docs/install-frame-home.md).
|
||||
4. **Open a home**: **File > Open Home...** and pick a Meta home `.apk`, a `.fenv` or a model.
|
||||
5. **Send it**: **Frame > Send to Frame**. Put the headset on: you are standing in it.
|
||||
5. **Send it**: **Headset > Send to Frame**. Put the headset on: you are standing in it.
|
||||
|
||||
## Downloads
|
||||
|
||||
|
||||
@@ -111,7 +111,7 @@ Frame Home, which Studio installs for you. Keep the two together.
|
||||
## A first walkthrough (about 5 minutes)
|
||||
|
||||
Before you start, set up the headset once: [headset-setup.md](headset-setup.md). Then install Frame Home on it with
|
||||
**Frame > Install on Steam Frame...** (see [install-frame-home.md](install-frame-home.md)).
|
||||
**Headset > Install on Steam Frame...** (see [install-frame-home.md](install-frame-home.md)).
|
||||
|
||||
### 1. Open a home
|
||||
|
||||
@@ -149,7 +149,7 @@ copy somewhere else.
|
||||
### 4. Send it to the headset
|
||||
|
||||
1. Put the headset on, or at least make sure it is on and connected to your network.
|
||||
2. Choose **Frame > Send to Frame**.
|
||||
2. Choose **Headset > Send to Frame**.
|
||||
3. Studio saves the home as one `.fenv`, copies it to the headset and makes it the current environment. Its
|
||||
progress shows in the Studio window.
|
||||
|
||||
|
||||
@@ -128,7 +128,7 @@ it cannot connect, check the address and that SSH is on. See [troubleshooting.md
|
||||
|
||||
You do not have to use the name `frame`:
|
||||
|
||||
- In Studio, **Frame > Install on Steam Frame...** has a **Headset** field. Type an SSH alias or
|
||||
- In Studio, **Headset > Install on Steam Frame...** has a **Headset** field. Type an SSH alias or
|
||||
`steamos@<address>`. Studio remembers it and uses it for **Send to Frame** too.
|
||||
- The installers take `--host` (Linux, macOS) or ask for the address (Windows). See
|
||||
[install-frame-home.md](install-frame-home.md).
|
||||
|
||||
@@ -8,18 +8,18 @@ Before you start, the headset needs developer mode and SSH: see [headset-setup.m
|
||||
|
||||
## Way 1: from Frame Studio
|
||||
|
||||
1. Choose **Frame > Install on Steam Frame...**.
|
||||
1. Open the Inspector's **Headset** tab (on the right), or choose **Headset > Install on Steam Frame...**, which opens it.
|
||||
2. In **Headset**, type the headset's address: an SSH alias such as `frame`, or `steamos@<address>`, for example
|
||||
`steamos@192.168.1.50`. Studio remembers it.
|
||||
3. Under **Environments**, choose what to copy along:
|
||||
3. Under **Environments to install**, choose what to copy along:
|
||||
- **The open home** (if one is open). It is saved as a `.fenv` first if it isn't one already.
|
||||
- **Add .fenv...** adds more environment files.
|
||||
- With nothing chosen, only Frame Home is installed. Environments already on the headset stay.
|
||||
4. Click **Install**. The window shows each step and, at the end, "Installed".
|
||||
4. Click **Install Frame Home**. The tab shows each step and, at the end, "Installed".
|
||||
|
||||
Environments already on the headset with the same name and size are not copied again.
|
||||
|
||||
**Restore SteamVR's environment** in the same window uninstalls (see [Uninstalling](#uninstalling)).
|
||||
**Restore SteamVR's Environment** in the same tab uninstalls (see [Uninstalling](#uninstalling)).
|
||||
|
||||
Studio connects without asking for passwords, so it needs an SSH key (see [headset-setup.md](headset-setup.md)).
|
||||
|
||||
@@ -153,7 +153,7 @@ Frame Home.
|
||||
|
||||
| From | Do this |
|
||||
|---|---|
|
||||
| Studio | **Frame > Install on Steam Frame...**, then **Restore SteamVR's environment** |
|
||||
| Studio | **Headset > Install on Steam Frame...**, then **Restore SteamVR's Environment** |
|
||||
| Windows | `powershell -ExecutionPolicy Bypass -File install-frame-home.ps1 -Uninstall` |
|
||||
| Linux, macOS | `sh install-frame-home.sh --uninstall` |
|
||||
| On the headset | `sh payload/install.sh uninstall` |
|
||||
|
||||
@@ -71,7 +71,7 @@ ssh frame
|
||||
| Windows: "ssh is not recognized", or Studio says "install OpenSSH or Git for Windows" | Turn on **OpenSSH Client** in **Settings > Apps > Optional features**, or install Git for Windows |
|
||||
| "... isn't a Steam Frame" | The address points at another computer |
|
||||
|
||||
In Studio, the address is the **Headset** field in **Frame > Install on Steam Frame...**. Studio remembers it.
|
||||
In Studio, the address is the **Headset** field in **Headset > Install on Steam Frame...**. Studio remembers it.
|
||||
|
||||
## Install failed
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ Over SSH (`ssh frame`) you can do the same with the panel's program:
|
||||
|
||||
Every environment lives in `~/frame-home/envs` on the headset. Ways to put one there:
|
||||
|
||||
- From Frame Studio: **Frame > Send to Frame** (the open home), or **Frame > Install on Steam Frame...** (any
|
||||
- From Frame Studio: **Headset > Send to Frame** (the open home), or **Headset > Install on Steam Frame...** (any
|
||||
`.fenv` files).
|
||||
- With the stand-alone installer: drop `.fenv` files on `Install Frame Home.bat`, or list them after
|
||||
`install-frame-home.sh`. See [install-frame-home.md](install-frame-home.md).
|
||||
|
||||
+1
-1
@@ -471,6 +471,6 @@ int main(int argc, char** argv) {
|
||||
" fenv-tool upgrade file.fenv... re-bake with this build (keeps world, edits, sound, picture)\n"
|
||||
" fenv-tool report [--json] <home.apk | home.fenv | footprint.apk+vista.apk>... what it costs and what's wrong with it\n"
|
||||
" fenv-tool settings <home.fenv | home.apk> [JSON | --clear] a world's own settings, shown or set\n"
|
||||
" fenv-tool tune [--seconds 30] [--late 0.01] [--cool 88] [--dry-run] <home.fenv | home.apk> its best settings on this headset, stored in it\n");
|
||||
" fenv-tool tune [--seconds 30] [--late 0.01] [--cool 80] [--dry-run] <home.fenv | home.apk> its best settings on this headset, stored in it\n");
|
||||
return 2;
|
||||
}
|
||||
+3
-3
@@ -1,7 +1,7 @@
|
||||
#pragma once
|
||||
// Frame Home's performance and quality settings: ~/frame-home/settings.json on the Steam Frame. Frame Home reads it
|
||||
// when it starts and again whenever it changes; the Environments panel (Settings) and Frame Studio (Frame > Headset
|
||||
// Settings) edit it. Frame Home writes how it's doing to stats.json beside it for those two to show.
|
||||
// when it starts and again whenever it changes; the Environments panel (Settings) and Frame Studio (Edit > Settings,
|
||||
// its Steam Frame part) edit it. Frame Home writes how it's doing to stats.json beside it for those two to show.
|
||||
#include "core/tinyjson.h"
|
||||
|
||||
#include <algorithm>
|
||||
@@ -119,7 +119,7 @@ struct PerfSettings {
|
||||
};
|
||||
|
||||
// Frame Home's debug tools: ~/frame-home/debug.json, beside settings.json. The Environments panel's Debug page and
|
||||
// Frame Studio (Frame > Headset Debug) edit it and Frame Home applies it within a second. They're for finding out
|
||||
// Frame Studio (Debug > Headset Debug) edit it and Frame Home applies it within a second. They're for finding out
|
||||
// why a home looks or runs wrong, not for keeping: Frame Home clears the file each time it starts.
|
||||
struct DebugSettings {
|
||||
int view = 0; // HslRenderer::DebugView: 0 normal, 1 wireframe, 2 meshes, 3 GPU cost, 4 overdraw
|
||||
|
||||
Reference in new issue
Block a user