mirror of
https://github.com/lhns/steam-frame-nix.git
synced 2026-10-06 03:00:13 +02:00
Clearer file names and layout; docs/development.md
- steam-keyboard-patch.nix -> vr-keyboard-extra-keys.nix (option
keyboard.vr.extraKeys), helper.mjs -> xdotool-helper.mjs;
homeManagerModules.steam-keyboard-patch stays as an alias.
- vr-keyboard: panel.js/unpatch-panel.js/relay.mjs ->
suggestions-panel/{patch,unpatch}.js + relay.mjs; decoder.js ->
swipe-decoder.js; build.nix split into dictionary.nix and check.nix.
- modules/lib -> modules/steam-ui-patches/lib (the UI patch library).
- docs/development.md: repository layout (what runs where), runtime names.
Patch names, user services and state files are unchanged.
This commit is contained in:
Pierre Kisters committed
1 parent
b3d93e8526
commit
5d15902ba1
40 files changed
+330
-161
No files matched your search
@@ -0,0 +1,128 @@
|
||||
# Development
|
||||
|
||||
Which file does what and where it runs, for working on steam-frame-nix
|
||||
itself. Writing your own patches: [UI patches](ui-patches.md).
|
||||
|
||||
## Conventions
|
||||
|
||||
- `modules/<name>.nix` is `homeManagerModules.<name>`; files only it uses
|
||||
are in `modules/<name>/`.
|
||||
- `patch.js` / `unpatch.js`: a runtime patch of a web page and the
|
||||
expression that reverts it. A module with several patches has one
|
||||
directory per patch (`launcher-menu/grid/`,
|
||||
`vr-keyboard/suggestions-panel/`).
|
||||
- `*.js` in `modules/` is browser JavaScript evaluated in Steam's or
|
||||
SteamVR's pages (single expressions, no imports); `*.mjs` is a Node
|
||||
program (user service, test or script).
|
||||
- `check.nix` is the module's flake check (`nix flake check`, attribute
|
||||
`checks.<system>.<name>`); `tests/*.test.mjs` are run by it.
|
||||
- Runtime names (patch names, user services, state files) are listed
|
||||
[below](#runtime-names); they stay stable when files move.
|
||||
|
||||
Where things run:
|
||||
|
||||
| Tag | Where |
|
||||
|---|---|
|
||||
| **Steam** | Steam's UI, page `SharedJSContext`, DevTools `127.0.0.1:8080` |
|
||||
| **SteamVR** | SteamVR's dashboard (`vrwebhelper`), page `systemui`, DevTools `127.0.0.1:8087` |
|
||||
| **service** | systemd user service (outer Steam/VR session) |
|
||||
| **switch** | Home Manager activation (`home-manager switch`) |
|
||||
| **build** | Nix build time |
|
||||
| **app** | started with an app (launcher, `LD_PRELOAD`, autostart) |
|
||||
| **test** | `nix flake check` |
|
||||
| **dev** | run by hand from a checkout |
|
||||
|
||||
## Repository layout
|
||||
|
||||
```text
|
||||
flake.nix homeManagerModules, packages/apps (cleanup), checks, template
|
||||
install.sh install / uninstall / cleanup (curl | bash; also the
|
||||
steam-frame-nix-cleanup package and the debugger arm step)
|
||||
template/ `nix flake init -t` / installer config: flake.nix, home.nix
|
||||
docs/ one page per feature; ui-patches.md for patch authors
|
||||
scripts/
|
||||
check-signatures.mjs dev: check signatures.json against the installed Steam
|
||||
webpack-modules.mjs dev: webpack module extraction (used by check-signatures)
|
||||
vr-keyboard-replay.mjs dev: replay recorded swipes through the swipe decoder
|
||||
modules/
|
||||
session.nix switch: outer bus/runtime dir, user services on switch
|
||||
cleanup.nix switch: `cleanup --orphans`; steam-frame-nix-cleanup on PATH
|
||||
cleanup/package.nix build: install.sh as a command (cleanup, steamvr-debugger-arm)
|
||||
cleanup/check.nix test: install.sh cleanup on fake home/runtime dirs
|
||||
portal.nix Steam session portal config (session.portalFix)
|
||||
keyboard-layout.nix gamescope-session drop-in with XKB_DEFAULT_* (keyboard.layout)
|
||||
clipboard-sync.nix app: KDE autostart of clipboard-sync (clipboardSync)
|
||||
hidden-apps.nix Hidden=true desktop entries (launcherMenu.hiddenApps)
|
||||
keyring.nix app: launchers sharing the KDE wallet (keyring)
|
||||
docker.nix service: rootless dockerd (docker)
|
||||
firefox.nix Flatpak prefs extension and launcher entry (firefox)
|
||||
firefox/launcher.nix app: launcher script (desktop profile, fullscreen fix)
|
||||
firefox/check.nix test: launcher against a fake flatpak
|
||||
jellyfin.nix desktop entry with flatpak run options (jellyfin.hardwareDecoding)
|
||||
jellyfin/mpv-hwdec-shim.c app: LD_PRELOAD shim, hwdec auto* -> v4l2m2m-copy
|
||||
jellyfin/shim.nix build: the shim as lib/mpv-hwdec-shim.so
|
||||
jellyfin/check.nix test: shim ELF and rewriting
|
||||
steam-ui-patches.nix service steam-ui-patches: runs the injector (uiPatches.*)
|
||||
steam-ui-patches/
|
||||
injector.mjs service: injects/re-injects/reverts patches over DevTools
|
||||
lib/default.nix build: mkPatch (wraps a patch.js with the library)
|
||||
lib/finders.js Steam+SteamVR: signature lookup of webpack modules/React fibers
|
||||
lib/hooks.js Steam+SteamVR: shared method hooks (e.g. SendMessage)
|
||||
lib/signatures.json build+dev: per-patch signatures (also check-signatures)
|
||||
steamvr-debugger.nix service steamvr-webhelper-debugger: DevTools port 8087
|
||||
launcher-menu.nix the VR "+" menu (launcherMenu.*), icon fallbacks
|
||||
launcher-menu/
|
||||
order/ Steam: sort the list
|
||||
pinned-desktop/ Steam: pin Desktop above/below the list
|
||||
launch/ Steam: close on launch, debounce
|
||||
grid/ Steam: programs as a grid of tiles
|
||||
show-all/ Steam: all programs without Developer Mode
|
||||
icon-fallbacks.sh switch: hints for iconFallbacks (read-only)
|
||||
vr-keyboard-extra-keys.nix Esc/Ctrl/Alt/arrows etc. (keyboard.vr.extraKeys)
|
||||
vr-keyboard-extra-keys/
|
||||
patch.js, unpatch.js Steam: the extra bottom row and key routing
|
||||
xdotool-helper.mjs service steam-keyboard-patch: own injector + xdotool keys
|
||||
vr-keyboard.nix swipe, suggestions, Backspace drag (keyboard.vr)
|
||||
vr-keyboard/
|
||||
patch.js, unpatch.js Steam: gestures, text model, suggestion strip
|
||||
swipe-decoder.js Steam (argument of patch.js): swipe path -> words
|
||||
textmodel.js Steam (argument of patch.js): what the keyboard typed
|
||||
corrector.js Steam (argument of patch.js): corrections, completions
|
||||
suggestions-panel/
|
||||
patch.js, unpatch.js SteamVR: the strip as a panel above/below the keyboard
|
||||
relay.mjs service vr-keyboard-relay: strip state Steam <-> SteamVR
|
||||
dictionary.nix, gen-dict.py build: dictionary from wordfreq + Hunspell
|
||||
check.nix, tests/ test (also built before the patch): text model,
|
||||
corrector, swipe-decoder accuracy
|
||||
dashboard-windows.nix, dashboard-windows/ SteamVR: window scale/distance limits
|
||||
steam-close-button.nix, steam-close-button/ SteamVR: X on the Steam window
|
||||
window-curvature.nix, window-curvature/ SteamVR: curvature wheel
|
||||
frame-controls.nix, frame-controls/ SteamVR: window control bar
|
||||
```
|
||||
|
||||
## Runtime names
|
||||
|
||||
Patch names appear in the journal, key `signatures.json` and name the
|
||||
state files (`~/.local/state/steam-frame-nix/ui-patches/<name>.json`), so
|
||||
they are kept even where a file name says more:
|
||||
|
||||
| Module | Option | Patches (page) | User services |
|
||||
|---|---|---|---|
|
||||
| `launcher-menu` | `launcherMenu` | `launcher-menu-{order,pinned-desktop,launch,grid,show-all}` (Steam) | `steam-ui-patches` |
|
||||
| `vr-keyboard` | `keyboard.vr` | `vr-keyboard` (Steam), `vr-keyboard-panel` = `suggestions-panel/` (SteamVR) | `steam-ui-patches`, `vr-keyboard-relay` |
|
||||
| `vr-keyboard-extra-keys` | `keyboard.vr.extraKeys` | `steam-keyboard-patch` (Steam) | `steam-keyboard-patch` |
|
||||
| `dashboard-windows` | `dashboard.windows` | `dashboard-windows` (SteamVR) | `steam-ui-patches` |
|
||||
| `steam-close-button` | `dashboard.steamCloseButton` | `steam-close-button` (SteamVR, state) | `steam-ui-patches` |
|
||||
| `window-curvature` | `dashboard.windowCurvature` | `window-curvature` (SteamVR) | `steam-ui-patches` |
|
||||
| `frame-controls` | `dashboard.frameControls` | `frame-controls` (SteamVR, state) | `steam-ui-patches` |
|
||||
| `steamvr-debugger` | `steamvrDebugger` | | `steamvr-webhelper-debugger` |
|
||||
|
||||
Log of all patches:
|
||||
`journalctl --user -u steam-ui-patches -u steam-keyboard-patch -u vr-keyboard-relay`.
|
||||
|
||||
## Checks
|
||||
|
||||
```sh
|
||||
nix flake check # all checks, on aarch64-linux
|
||||
nix shell nixpkgs#nodejs -c node scripts/check-signatures.mjs --strict # on the Frame
|
||||
```
|
||||
Reference in new issue
Block a user