2019-08-02 15:59:38 +02:00
# wldash
2019-08-04 14:11:05 +02:00
A dashboard/launcher/control-panel thing for Wayland. Requires wlr-layer-shell-unstable-v1.
2019-08-02 15:59:38 +02:00
2019-08-02 17:30:18 +02:00
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.
2019-08-04 14:39:46 +02:00
## How to use
1. Checkout: `git clone https://github.com/kennylevinsen/wldash`
2. Build: `cargo build --release`
3. Put somewhere: `cp target/release/wldash /usr/local/bin/wldash`
4. Run: `wldash`
2019-08-28 15:23:56 +02:00
To display wldash on all outputs, set `WLDASH_ALL_OUTPUTS=1` .
2019-08-04 14:39:46 +02:00
## How to use launcher
2019-08-29 01:03:48 +02:00
The launcher for wldash is built-in, based on https://github.com/kennylevinsen/dot-desktop. Pluggable systems may come back in the future.
2019-08-04 14:39:46 +02:00
2019-08-29 01:03:48 +02:00
Configuration currently happen through environment variables:
- WLDASH_APP_OPENER: The command used to open normal applications. For sway, the recommended value is "swaymsg exec".
- WLDASH_TERM_OPENER: The command used to open terminal applications.
- WLDASH_URL_OPENER: The command used to open a URL.
2019-08-04 14:39:46 +02:00
2019-08-02 15:59:38 +02:00
## Features
2019-08-02 17:21:03 +02:00
### Date and time
2019-08-02 15:59:38 +02:00
2019-08-02 17:21:03 +02:00
In nice, big letters!
### 3 month calendar
2019-08-02 15:59:38 +02:00
2019-08-03 01:14:57 +02:00
Scroll or click on the months to navigate.
2019-08-02 15:59:38 +02:00
2019-08-02 17:21:03 +02:00
### Battery level
2019-08-02 15:59:38 +02:00
Over upower, only visible if upower battery is detected
2019-08-02 17:21:03 +02:00
### Audio volume
2019-08-02 15:59:38 +02:00
Over pulseaudio, only visible if pulseaudio connection is successful. Scroll to adjust volume, right-click to toggle mute.
2019-08-02 17:21:03 +02:00
### Backlight control
2019-08-02 15:59:38 +02:00
Using backlight sys file, only visible of backlight is detected. Scroll to adjust, right-click to toggle between the extreme values.
2019-08-02 17:21:03 +02:00
### Launcher
2019-08-02 15:59:38 +02:00
2019-08-29 01:03:48 +02:00
Loads desktop files from the usual locations.
2019-08-02 15:59:38 +02:00
2019-08-08 16:47:32 +02:00
The launcher also accepts prefix operators to change its mode:
- `!` : Arbitrary command
2019-08-28 15:23:56 +02:00
- `=` : Calculator based on rcalc_lib. See https://docs.rs/rcalc_lib/0.9.3/rcalc_lib/
2019-08-26 18:14:12 +02:00
2019-08-02 15:59:38 +02:00
## Notable missing features:
- Scaling of any kind - all sizes are currently hardcoded in pixels
- Configurability
2019-08-02 17:21:03 +02:00
- Cleanup and reorganization
2019-08-29 01:03:48 +02:00
- Proper line editor for the launcher
