initial commit
This commit is contained in:
commit
b7ea790891
1 changed files with 941 additions and 0 deletions
61
README.md
Normal file
61
README.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# quadshell
|
||||
|
||||
A phone shell for [niri](https://github.com/YaLTeR/niri), built with
|
||||
[Quickshell](https://quickshell.org). It's a status bar with a quick settings sheet that you pull
|
||||
down from it.
|
||||
|
||||
<img src="docs/screenshot.png" alt="The quick settings sheet pulled down over the app grid" width="300">
|
||||
|
||||
The bar shows the time, cellular, Wi-Fi, Bluetooth and battery. The sheet has:
|
||||
|
||||
- Wi-Fi, Bluetooth, cellular and mobile data toggles. The arrow on Wi-Fi opens `nmgui`, and on
|
||||
Bluetooth it opens `adw-bluetooth`.
|
||||
- A flashlight
|
||||
- Rotation, with a choice of orientations
|
||||
- Screenshot and power (suspend, restart, power off) buttons
|
||||
|
||||
Drag the bar down to open the sheet, and swipe up anywhere or tap below it to close it. You can
|
||||
also toggle it with `qs ipc call sheet toggle`.
|
||||
|
||||
## Using it
|
||||
|
||||
The flake has a `quadshell` package, and an overlay that adds it to nixpkgs:
|
||||
|
||||
```nix
|
||||
nixpkgs.overlays = [ quadshell.overlays.default ];
|
||||
```
|
||||
|
||||
Then start it with niri, in your niri config:
|
||||
|
||||
```kdl
|
||||
spawn-at-startup "quadshell"
|
||||
```
|
||||
|
||||
It brings `nmcli`, `mmcli`, `nmgui` and `adw-bluetooth` with it. The system needs:
|
||||
|
||||
- niri, NetworkManager and ModemManager running
|
||||
- systemd-logind, which the flashlight uses to set the LED without root
|
||||
- The Papirus-Dark icon theme and the Inter font
|
||||
|
||||
## Developing
|
||||
|
||||
```sh
|
||||
nix run .#phone [host]
|
||||
```
|
||||
|
||||
This copies `src` to the phone over SSH (`host` defaults to `phone`) and runs it there, showing
|
||||
its logs until you press Ctrl+C. It stops any other running Quickshell first, so when you quit
|
||||
there's no bar until you run it again. The phone needs Quickshell from this flake's nixpkgs
|
||||
already in its store, as it doesn't download anything.
|
||||
|
||||
### Editor support
|
||||
|
||||
For completion and lints in VS Code, install the Qt Qml extension and point it at `qmlls` from
|
||||
`qt6.qtdeclarative`. Then create an empty `src/.qmlls.ini` and run Quickshell on this machine once:
|
||||
|
||||
```sh
|
||||
nix run --inputs-from . nixpkgs#quickshell -- --path src
|
||||
```
|
||||
|
||||
Quickshell fills in `.qmlls.ini` with its import paths. That file links into `/run`, so do this
|
||||
again after a reboot.
|
||||
Loading…
Reference in a new issue