frame-developer-tools

This repository contains various developer-related tools and test programs. These are not meant to ship on user's headsets, and are meant to be a living repository that is constantly updated and improved to provide a good developer experience.

To download this repository on your frame, simply clone it:

git clone git@gitlab.steamos.cloud:deckard/frame-developer-tools ~/frame-developer-tools

I suggest using ssh-agent forwarding to give your frame access to your SSH keys. Either connect to your frame via ssh -A steamos@frame or create a stanza in your ~/.ssh/config file like:

Host frame
    ForwardAgent yes

perfetto

Perfetto is a system profiling tool from Google. We provide a simplified wrapper to start profiling and save a useful trace out to /tmp that can be drag-and-dropped onto https://ui.perfetto.dev. Perfetto has a large number of configuration options, we provide a standard system.cfg configuration for quickstart use. You can pass a configuration name to the wrapper script, e.g. perfetto.sh system_no_ftrace. Feel free to add more configurations as appropriate.

To copy the trace from your frame to your local machine, use something like scp steamvr@amosXXXX.local:/tmp/*.pftrace ..

gpuvis

gpuvis is another system profiling tool. The simplest way to use gpuvis is to RDP in and run get_trace.sh which will pop up a gpuvis window with the collected trace immediately.

gfxreconstruct

gfxreconstruct is a tool for capturing and replaying graphics API calls. Our replay_gfxreconstruct.sh script provides a convenient wrapper for replaying a trace, simply pass the trace as the first argument.

gamescope helpers

There are some convenient scripts for launching X11/Wayland apps inside gamescope inside of SteamVR.