2019-08-02 15:59:38 +02:00
# wldash
2020-03-28 02:22:50 +01:00
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.
2025-02-27 17:42:09 +01:00
## Rewrite note
wldash has received a significant rewrite. The old version is available in the wldash1 branch for now.
2026-10-03 09:15:57 +00:00
## This fork
This is a maintained fork of [kennylevinsen/wldash ](https://github.com/kennylevinsen/wldash )
living at <https://project.uhhm.no/bl/wldash>. On top of upstream it fixes a number of
crashes (non-ASCII input in the launcher, machines without a backlight, battery or
PulseAudio, key-repeat rate 0, ...), corrects redraw damage tracking, and prefers a
machine-local `/etc/wldash/config.yml` over the per-user config when present, which keeps
per-host layouts apart on NFS-shared homes.
2019-08-04 14:39:46 +02:00
## How to use
2026-10-03 09:15:57 +00:00
1. Checkout: `git clone https://project.uhhm.no/bl/wldash`
2019-08-04 14:39:46 +02:00
2. Build: `cargo build --release`
3. Put somewhere: `cp target/release/wldash /usr/local/bin/wldash`
4. Run: `wldash`
2026-10-03 09:15:57 +00:00
To generate a new default configuration, run `wldash --write-default-config` . To configure, edit `$XDG_CONFIG_HOME/wldash/config.yml` (or if `XDG_CONFIG_HOME` is not set, `~/.config/wldash/config.yml` ). If `/etc/wldash/config.yml` exists it takes precedence over the per-user file; `--config FILE` overrides both.
2019-09-06 22:01:55 +02:00
2026-10-03 09:33:12 +00:00
Desktop files are scanned every time wldash starts (on a background thread), so there is no cache to refresh; `--desktop-refresh` is kept as a no-op for old key bindings. Calculator history and the prompt saved on Escape live in `$XDG_STATE_HOME/wldash` (`~/.local/state/wldash` ); older installs' files under `~/.cache/wldash` are still read.
2019-09-06 22:01:55 +02:00
For more info, look in `src/config.rs` .
2019-08-28 15:23:56 +02:00
2019-09-03 17:33:06 +02:00
## System dependencies
`dbus` . See https://github.com/diwic/dbus-rs#requirements .
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-09-06 22:01:55 +02:00
The environment variables `XDG_DATA_DIRS` and `XDG_DATA_HOME` are read to find the many `applications` folders that contain `desktop` files.
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:
2020-03-28 02:23:55 +01:00
2019-08-08 16:47:32 +02:00
- `!` : 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
2021-05-19 17:51:27 +02:00
## How to discuss
Go to #kennylevinsen @ irc.libera.chat to discuss, or use [~kennylevinsen/public-inbox@lists.sr.ht ](https://lists.sr.ht/~kennylevinsen/public-inbox ).
