59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# wldash
|
|
|
|
A dashboard/launcher/control-panel thing for Wayland. Requires wlr-layer-shell-unstable-v1.
|
|
|
|
Consider this alpha-quality: While it works, *everything* is subject to change with a moments notice. You may end up pulling in the latest changes, and *poof*, wldash suddenly turns into an artisan espresso machine.
|
|
|
|
## How to use
|
|
|
|
1. Checkout: `git clone https://github.com/kennylevinsen/wldash`
|
|
2. Build: `cargo build --release`
|
|
If you want the Ivy calculator feature enabled (requires a Go toolchain): `cargo build --release --features ivy`
|
|
If you want the bc calculator feature enabled: `cargo build --release --features bc`
|
|
3. Put somewhere: `cp target/release/wldash /usr/local/bin/wldash`
|
|
4. Run: `wldash`
|
|
|
|
## How to use launcher
|
|
|
|
Assuming https://github.com/kennylevinsen/dot-desktop is installed: `eval "$(dot-desktop "$(dot-desktop | wldash)")"`
|
|
|
|
wldash simply takes a new-line separated list of strings, and returns the selection. dot-desktop generates this list, and afterwards processes the selection to return the proper instantiation string. Eval then executes it.
|
|
|
|
## Features
|
|
|
|
### Date and time
|
|
|
|
In nice, big letters!
|
|
|
|
### 3 month calendar
|
|
|
|
Scroll or click on the months to navigate.
|
|
|
|
### Battery level
|
|
|
|
Over upower, only visible if upower battery is detected
|
|
|
|
### Audio volume
|
|
|
|
Over pulseaudio, only visible if pulseaudio connection is successful. Scroll to adjust volume, right-click to toggle mute.
|
|
|
|
### Backlight control
|
|
|
|
Using backlight sys file, only visible of backlight is detected. Scroll to adjust, right-click to toggle between the extreme values.
|
|
|
|
### Launcher
|
|
|
|
Works like bemenu: pipe a list into wldash, and it will print out the selection made. Use https://github.com/kennylevinsen/dot-desktop if you want to launch using desktop files.
|
|
|
|
The launcher also accepts prefix operators to change its mode:
|
|
- `!`: Arbitrary command
|
|
- `=`: Calculator, currently requires the `ivy` feature. See https://godoc.org/robpike.io/ivy for documentation on the syntax and features.
|
|
|
|
To display the launcher on all outputs export `WLDASH_ALL_OUTPUTS=1`
|
|
|
|
## Notable missing features:
|
|
|
|
- Scaling of any kind - all sizes are currently hardcoded in pixels
|
|
- Configurability
|
|
- Cleanup and reorganization
|