Files
Frametop--frametop/pack/release-notes.md
T
DeeJanuz 4d4825bf9a Install: hand tracking is an install option, in releases too
install.sh offers hand tracking (step 9/12, yes by default; --no-hands skips it,
and --yes installs it only when sudo runs without a prompt). Installed, it runs
with the Frametop desktop (HANDS_MODE=frametop), unless the settings already say
always. get.sh, pack/install-release.sh and the FrameDrop window pass --no-hands,
and the window has a hand tracking box that needs the password like the eye
tracker's.

The release image builds ft-camd and ft-hands (with ncnn at the tag
hands/Makefile pins), and hands/run.sh install doesn't build in a release, so
it only sets ft-camd's file capabilities and installs the units. The release
workflow's smoke test checks both binaries. Docs drop "deferred" and describe
the gestures and the Hands page.
2026-10-13 22:22:37 -06:00

1.4 KiB

Install

On a Steam Frame (SteamOS, VR variant). Download Frametop.zip below (about 1.1 GB), then either:

  • With FrameDrop on a PC: drop Frametop.zip on your paired headset. In the headset, open Frametop in your library and press Play.
  • On the headset: unpack Frametop.zip (in the desktop's Dolphin or Konsole) and run Frametop/frametop-install.sh.
  • In a terminal on the headset: curl -fsSL https://frametop.github.io/frametop/get.sh | bash -s -- --release

A window asks what to install, and your SteamOS password for the three optional parts that need it (hand tracking, our own eye tracker, and the Bluetooth fixes); the password is only used for this install. Nothing is compiled on the headset. Restart SteamVR once afterwards.

Before installing, the installer checks your SteamOS build against the builds Frametop was tested on, and stops if this release is known not to work there.

To show another computer's monitors as screens (remote displays), set that computer up once with its host kit: Windows, Mac, or Linux. The README's Remote displays section has the steps.