hypr-console

A Lenovo Legion Go running Hyprland as a desktop, driven entirely by its controller. No Game Mode and no Plasma: a compositor, a bar, a menu, an on-screen keyboard, panels and a guide, every one of them reachable with two thumbs.

Two things hold it up. desktop.conf is the whole inventory -- packages, files, services, masked units -- and console apply is the only thing that installs any of it, so a restart cannot lose a fix nobody wrote down. And the controller is emulated from a capture of the real one, so what a button does can be tried on a laptop in a second rather than over ssh.

console check / apply / save     where the machine has drifted, put it back,
                                 take a file edited in place back into source
just test / desktop / checks     here, nested at the device's own size, and
                                 every feature it has grown
just deploy                      push it to the device and apply it

The tree

desktop.conf    the whole inventory
files/          the content of every file it names, at the same path
crates/         every program on the device, in one workspace
docs/           why each thing is the way it is
migrations/     what a machine is told when the manifest stops naming something
scenarios/      presses a person would make, replayed
theme/          palette.toml, the one place a colour is chosen
tools/          the lint suite, and what a deploy runs

docs

• button-contract.md -- what the buttons promise
• console-ui.md -- what a surface on this machine is
• panels.md -- how a panel is built
• programs.md -- how a program is built
• checks.md -- one check to a feature
• flows.md -- the long way round, across features
• emulator.md -- the controller, in software
• desktop.md -- the desktop on a machine that is not the device
• deploy.md -- what a deploy is
• migrations.md -- what the manifest cannot say
• theme.md -- the palette, and the one place it is chosen
• screen.md -- size, brightness, and being left alone
• sky.md -- the wallpapers
• files.md -- the file browser
• downloads.md -- getting something off the net
• browser.md -- the pad, in a page
• voice.md -- dictation
• notifications.md -- what the desktop has said
• rename.md -- why nothing here is called legion
• forks.md -- the two programs not in this repository
• pictures/ -- the menu, the panels, the keyboard, the guide

crates

• console-applications -- the menu
• console-browser-extension -- the add-on this desktop puts in its browser
• console-button-guide -- what every button does
• console-core-atomic-writes -- writing a file so a machine that stops has a whole one
• console-core-colour -- colours, and how far apart two of them are
• console-core-external-programs -- every program this desktop runs and did not write
• console-core-localization -- everything a person reads, in the language they read
• console-core-never -- the error of a function that cannot fail
• console-core-number-conversion -- the one place a number changes width
• console-core-reconnect -- reaching again for something that has gone
• console-cpu-boost -- the processors, asked to hurry while somebody waits
• console-default-applications -- what this desktop opens things with
• console-device -- the handheld, reached from this checkout
• console-downloads -- something off the net, into the folders this device plays out of
• console-events -- one subscription per source, and everybody else is told
• console-files -- the files, as something the front of the machine can walk
• console-home-screen -- what is on the wallpaper, and where the thumb is on it
• console-input-controller -- input in, a doing out; it opens no device
• console-input-dictation -- speaking instead of typing
• console-input-focus -- input, claimed by whatever is in front of you
• console-input-gamepad -- a Legion Go you can press, on a machine that is not one
• console-input-keyboard -- the on-screen keyboard, and the one crate with a licence of its own
• console-input-mapping -- where the buttons are on a device that is not this one
• console-input-pointer -- a pointer made of nothing, for the checks to press with
• console-input-touchscreen -- a finger put down at a place on the picture
• console-launcher -- the program the menu is
• console-manifest-engine -- console, the apply engine
• console-manifest-migrations -- what a machine has to be told, because the manifest cannot say it
• console-manifest-publish -- builds this copy
• console-media-viewer -- a photograph and a film, on the machine that holds them
• console-music -- the music: what it draws, what it lists, what it presses
• console-music-player -- and what makes the sound: ffmpeg into pw-cat, answering on MPRIS
• console-notifications -- what the desktop has said, kept where somebody can look
• console-onscreen -- whether something is on the screen, asked of the compositor
• console-palette -- spends the palette into every file that holds a colour
• console-panel -- a panel: tabs across the top, and under them only what that tab is about
• console-panels -- one program, holding every panel
• console-program-contract -- what a program here is: words in, doings out
• console-program-lifetime -- how long a started program lives, said at the call site
• console-program-runtime -- the loop that carries out what a program decided
• console-repository -- where the repository is, from anywhere inside it
• console-response-times -- how long the machine kept somebody waiting
• console-screen -- the device's screen, read out of the compositor's own file
• console-session -- which session has the screen, and how to get to the other one
• console-settings -- what Legion right opens
• console-status-bar -- what the bar says about the machine
• console-test-checks -- the checks, one module to a feature
• console-test-desktop -- this desktop, in a window, on another machine
• console-test-flows -- the long way round, on purpose
• console-test-stages -- where a check can run, and what can be seen from there
• console-wallpaper -- the sky: which wallpaper is up, and why

tools

• console-deploy -- put this checkout on the device and bring it to match
• console-migrate -- move a device still called legion over to the console names
• just pull -- take what was changed on the device back into this checkout
• cargo run --bin allow-uinput -- let this machine make input devices without being root
• voice-compare -- which hearing this device should use, measured on it
• explicit-rust -- the dylint suite this workspace is written to, a workspace of its own
  • explicit001_fallible_result -- a failure met is a failure said
  • explicit002_infallible_result -- infallible fns return Result<T, Never>
  • explicit003_no_never_error -- Result<T, !> is forbidden; the name is Never
  • explicit004_no_panic -- no unwrap, expect, panic, todo, unreachable
  • explicit005_handle_fallible -- fallible values are handled or propagated
  • explicit006_option_not_error -- Option is for "may not exist", not for errors
  • explicit007_no_bool_return -- no bool return values
  • explicit008_no_bool_param -- no bool parameters
  • explicit009_explicit_discard -- a discarded #[must_use] is let _ =
  • explicit010_no_numeric_into -- no implicit numeric coercion
  • explicit011_no_as_cast -- no as casts
  • explicit012_safety_doc -- unsafe carries a // SAFETY: reason
  • explicit013_breathing_room -- a block that decides something gets a blank line around it
  • explicit014_no_index_slice -- no indexing or slicing; ask with get
  • explicit015_no_bare_arithmetic -- no bare integer arithmetic; the policy has a name
  • explicit016_no_wildcard_arm -- no wildcard arm over an enum
  • explicit017_question_mark_alone -- ? is the whole of a statement, never buried
  • explicit018_allow_with_reason -- an allow carries its reason
  • explicit019_no_if -- no if; a decision is a match that names both outcomes
  • explicit020_no_comment -- no comments; a //! head and a // SAFETY: stay

Licence

AGPL-3.0-or-later, for everything in this repository but one crate. Take it, change it, run it, sell it -- and whoever you hand it to, over a wire as much as on a disk, gets the source of what you handed them under the same terms. That is the whole reason for the choice: what is open here stays open downstream, and a desktop somebody serves rather than ships is not a hole in that.

The exception is crates/console-input-keyboard, which is GPL-3.0-or-later. It is a port of wvkbd and carries the licence it was given; the AGPL is not a later version of the GPL, so it was never ours to move. Its own module comment says so.

The two forks named in docs/forks.md are not here and keep their own.