diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 56 insertions, 11 deletions
@@ -1,21 +1,66 @@ # deck-it -A tablet dashboard, stream-deck, and second monitor for a Slackware-current -Hyprland desktop, themed by -[unified-desktop-theme](https://git.danix.xyz/unified-desktop-theme/). +Turns an Android tablet into a second monitor, a stream-deck and an always-on +control surface for a Slackware Hyprland desktop. -An Android tablet shows an always-on control surface served over `adb reverse`, -plus a virtual Hyprland monitor streamed with wayvnc and shown in AVNC. The -surface is a module system: system stats, music, windows, OBS, LLM usage and -build status plug in independently. +A web page on the tablet has tabs for system stats, music, windows, OBS and +LLM/build status. A second headless output is streamed to AVNC as an extra +monitor. Everything runs on the PC and reaches the tablet through `adb reverse`; +there is no cloud, account or app-store install. -Status: in development. The design is in -`docs/superpowers/specs/`, the plan in `docs/superpowers/plans/`. +## Requirements + +**PC** +- Slackware-current with Hyprland (Lua or classic config) +- Python 3.11+ (`python3`) +- `websocket-client` (obs-websocket) +- `adb`, `wayvnc`, `openssl` +- `playerctl`, `wpctl` (PipeWire), `wtype` +- optional: `qrencode` for Wi-Fi pairing + +**Tablet** +- Android with USB debugging or Wireless debugging +- [AVNC](https://github.com/gujjwal00/avnc) for the extended display +- a Chromium-based browser for the web app (install it from the menu) + +## Install + +```sh +git clone https://git.danix.xyz/deck-it ~/Programming/GIT/deck-it +cp ~/Programming/GIT/deck-it/config.toml ~/.config/deck-it/config.toml # optional +~/Programming/GIT/deck-it/deck-it +``` + +The launcher creates the headless output, starts wayvnc and the server, tunnels +them to the tablet, and opens the dashboard and AVNC. `deck-it stop` tears it +down. + +Over Wi-Fi, pair once and pass the tablet's Wireless debugging address: + +```sh +deck-it pair +deck-it wifi 192.168.1.50:41234 +``` + +## Usage + +- Tabs: **Dashboard** (draggable/resizable cards), **Windows**, **OBS**. Swipe + the content sideways to change tab. +- `deck-it install` prints the `exec-once` line for hypr-theme's autostart. +- Configuration lives in `config.toml`: workspaces, launcher icons, OBS + websocket, llm-cost-dashboard URL, build VM host, hardware overrides. +- The OBS tab is a stream-deck: scenes, sources, audio sliders, transitions. + Long-press a source to open its properties dialog in OBS. +- The Windows tab has workspaces, icon launchers, and a per-window `⋮` menu to + close it or move it to another desktop. ## License -Not decided yet. Portions derived from tabdeck are MIT; see `NOTICE` and -`LICENSE.tabdeck`. +Copyright (C) 2026 Danilo M. <danix@danix.xyz> + +GPLv2 only. See [LICENSE](LICENSE) for the full text. Portions derived from +tabdeck (MIT) are noted in [LICENSE.tabdeck](LICENSE.tabdeck) and +[NOTICE](NOTICE). ## Development Approach |