https://github.com/kennylevinsen/wldash

Wayland launcher/dashboard
https://github.com/kennylevinsen/wldash

Last synced: about 2 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 (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T23:59:00.000Z (8 months ago)
• Last Synced: 2024-07-03T02:44:52.823Z (3 months ago)
• Language: Rust
• Homepage: https://sr.ht/~kennylevinsen/wldash
• Size: 5.08 MB
• Stars: 178
• Watchers: 7
• Forks: 17
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# wldash

![screenshot](https://git.sr.ht/~kennylevinsen/wldash/blob/master/assets/screenshot.jpg)

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`

3. Put somewhere: `cp target/release/wldash /usr/local/bin/wldash`

4. Run: `wldash`

To see the default configuration, run `wldash print-config`. To configure, place a file in `$XDG_CONFIG_HOME/wldash/config.yaml` (or if `XDG_CONFIG_HOME` is not set, `~/.config/wldash/config.yaml`). JSON is also currently supported.

Notable settings: `outptuMode` can be `active` or `all`, `scale` can be set to `2` to half the buffer size, and the widgets (and their layout) can be configured.

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

- Configurability

- Cleanup and reorganization

- Proper line editor for the launcher

## How to discuss

Go to #kennylevinsen @ irc.libera.chat to discuss, or use [~kennylevinsen/[email protected]](https://lists.sr.ht/~kennylevinsen/public-inbox).