https://github.com/kennylevinsen/wldash
Wayland launcher/dashboard
https://github.com/kennylevinsen/wldash
Last synced: 3 months ago
JSON representation
Wayland launcher/dashboard
- Host: GitHub
- URL: https://github.com/kennylevinsen/wldash
- Owner: kennylevinsen
- License: gpl-3.0
- Created: 2019-07-29T22:42:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-20T15:58:38.000Z (3 months ago)
- Last Synced: 2025-03-28T09:04:25.303Z (3 months ago)
- Language: Rust
- Homepage: https://sr.ht/~kennylevinsen/wldash
- Size: 4.96 MB
- Stars: 187
- Watchers: 7
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## Rewrite note
wldash has received a significant rewrite. The old version is available in the wldash1 branch for now.
## 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`
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.yaml`).
To regenerate the desktop file cache, run `wldash --desktop-refresh`.
For more info, look in `src/config.rs`.
## System dependencies
`dbus`. See https://github.com/diwic/dbus-rs#requirements.
## How to use launcher
The launcher for wldash is built-in, based on https://github.com/kennylevinsen/dot-desktop. Pluggable systems may come back in the future.
The environment variables `XDG_DATA_DIRS` and `XDG_DATA_HOME` are read to find the many `applications` folders that contain `desktop` files.
## 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
Loads desktop files from the usual locations.
The launcher also accepts prefix operators to change its mode:
- `!`: Arbitrary command
- `=`: Calculator based on rcalc_lib. See https://docs.rs/rcalc_lib/0.9.3/rcalc_lib/
## Notable missing features:
- Scaling of any kind - all sizes are currently hardcoded in pixels
## How to discuss
Go to #kennylevinsen @ irc.libera.chat to discuss, or use [~kennylevinsen/[email protected]](https://lists.sr.ht/~kennylevinsen/public-inbox).