diff options
Diffstat (limited to 'desktop/modules/deckit/README.md')
| -rw-r--r-- | desktop/modules/deckit/README.md | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/desktop/modules/deckit/README.md b/desktop/modules/deckit/README.md index abfd7be..51aed37 100644 --- a/desktop/modules/deckit/README.md +++ b/desktop/modules/deckit/README.md @@ -1,12 +1,28 @@ # deckit -One settings page, under Desktop, for deck-it (the tablet dashboard, its own -repo): whether it starts at login, and its `~/.config/deck-it/config.toml`. +Four settings pages, in their own deck-it sidebar group, for deck-it (the +tablet dashboard, its own repo): whether it starts at login, and its +`~/.config/deck-it/config.toml`. + +- General (`DeckItModule`, `DeckItGeneralPage`): the config path, Start + (start at login, Wi-Fi address), Display and Advanced (ports, Hyprland + config, fallback icon theme). Its header carries deck-it's state and + Restart. +- Dashboard (`DeckItDashboardModule`, `DeckItDashboardPage`): the Modules + toggles, the dashboard's action icons, and Hardware. +- Windows (`DeckItWindowsModule`, `DeckItWindowsPage`): the launchers and the + workspaces the Windows tab shows. +- Services (`DeckItServicesModule`, `DeckItServicesPage`): OBS, the LLM + dashboard URL, the K1C's Moonraker and the build VM host. + +The four pages edit one draft, `DeckIt.store`, as the Mail pages do: each has +a SaveBar, and Save or Discard on any page acts on all of them. Each module +lists its own fields, so a search lands on the page that holds the field. The config file is a sparse override. deck-it merges it over its shipped -`config.toml` key by key, so this page writes only what differs, and an +`config.toml` key by key, so these pages write only what differs, and an emptied field unsets the key and brings the default back. The defaults come -from `deck-it defaults` (JSON), run once when the page first loads, so they +from `deck-it defaults` (JSON), run once when deck-it's settings first load, so they are never copied here; deck-it must be on PATH (`~/bin/deck-it`, a link to the repo's launcher). The draft rules are the settings window's, through sbbuilder's `Store` and `Toml.js`, which gained plain decimals for the display @@ -25,8 +41,8 @@ the list; the order is the button order on the tablet. deck-it reads its config once at start, so a save applies on Restart deck-it, which runs `deck-it stop` and then the login command. -While the page is open it polls `deck-it status` (JSON: server, display, -waiting, tablet, extend) every 2s and shows one line in the page header, +While the General page is open it polls `deck-it status` (JSON: server, display, +waiting, tablet, extend) every 2s and shows one line in that page's header, beside Restart and Save, as the Wallpaper engine page does: green when the server runs with a tablet tunnelled (and the display streams, if enabled), yellow while starting or waiting for the tablet, red when stopped. A Restart's |