# hyprland-headless-stream-plugin A Nix flake that runs a **headless Hyprland session** and publishes its frames on a **persistent Unix socket**, so any process that can open a socket can see the screen without owning a display. Two parts: - **NixOS module** — `services.hyprland-headless-stream`: starts Hyprland with no physical monitor, and a small frame server beside it. - **Package** — `hhstream` — the frame server (publishes frames) and its client (reads them). Pure Python standard library. ```nix { inputs.hhstream.url = "git+https:///git//hyprland-headless-stream-plugin.git"; # in your host config imports = [ inputs.hhstream.nixosModules.default ]; services.hyprland-headless-stream = { enable = true; outputs = [ { name = "HEADLESS-1"; width = 1280; height = 720; refresh = 30; } ]; }; } ``` Then any consumer: ```bash hhstream-client --socket /run/hyprland-headless-stream/stream.sock --count 1 --out frame.png ``` The socket is a plain file descriptor: the server serves every client that connects, and keeps running when one disconnects. | Document | What it is | |---|---| | `docs/CONTRACT.md` | the wire protocol and the module surface — the interface other people build against | | `docs/ARCHITECTURE.md` | how the pieces fit: compositor, capture, server, client | | `README.dev.md` | how to build, test and hack on it | Status: work in progress — the module and the test suite are being built.