https://github.com/way-edges/way-edges
Light weight wayland client focusing on widgets hidden in your screen edge.
https://github.com/way-edges/way-edges
desktop desktop-widgets lightweight rice ricing rust smithay system-tray wayland widget
Last synced: 2 months ago
JSON representation
Light weight wayland client focusing on widgets hidden in your screen edge.
- Host: GitHub
- URL: https://github.com/way-edges/way-edges
- Owner: way-edges
- License: mit
- Created: 2024-08-12T15:26:35.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-04-13T03:37:20.000Z (3 months ago)
- Last Synced: 2025-05-05T20:12:03.892Z (2 months ago)
- Topics: desktop, desktop-widgets, lightweight, rice, ricing, rust, smithay, system-tray, wayland, widget
- Language: Rust
- Homepage: https://way-edges.github.io/description
- Size: 1.93 MB
- Stars: 67
- Watchers: 2
- Forks: 6
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
https://github.com/user-attachments/assets/366e506a-a476-4c4a-be17-678a8f1cd759
## 🫧 Project board
https://github.com/orgs/way-edges/projects/1/views/1
## 🔍 Doc
Please refer to https://way-edges.github.io/description
## 📥 Installation
### Arch(aur)
- [way-edges-bin](https://aur.archlinux.org/packages/way-edges-bin)
- [way-edges-git](https://aur.archlinux.org/packages/way-edges-git)
### Manual
```shell
git clone https://github.com/way-edges/way-edges.git
cd way-edges && cargo build --release
```
## ⚙️ Configuration
Place `config.jsonc` under `~/.config/way-edges/`
Example config: https://github.com/ogios/dots/tree/master/way-edges
### Full doc
Doc: https://way-edges.github.io/basic_config
### Schema*
**this can improve your experience of config writing dramatically.**
```jsonc
{
// add this
"$schema": "https://raw.githubusercontent.com/way-edges/way-edges/master/config/config.schema.json",
}
```
## 🚀 Launch
1. Run daemon first(`way-edges daemon`).
2. Add group of widgets given group name specified in your configuration file(`way-edges add `).
3. Some command require widget_name specified in order to operate.
```rust
Hidden widget on the screen edges
Usage: way-edges [OPTIONS]
Commands:
daemon run daemon. There can only be one daemon at a time
add add group of widgets to applicatoin given group name
rm remove group of widgets to applicatoin given group name
togglepin toggle pin of a widget under certain group. format: :
quit close daemon
help Print this message or the help of the given subcommand(s)
Options:
-d, --mouse-debug whether enable mouse click output, shoule be used width daemon command
-h, --help Print help
-V, --version Print version
```
## 💛 Thanks
Special thanks for:
- [JakeStanger/system-tray](https://github.com/JakeStanger/system-tray). I forked one for zbus5.0 version: https://github.com/ogios/system-tray-zbus5
- [Rayzeq/tryfol](https://github.com/Rayzeq/tryfol)
- [elkowar/eww](https://github.com/elkowar/eww)
- [YaLTeR/niri](https://github.com/YaLTeR/niri)
- [danieldg/rwaybar](https://github.com/danieldg/rwaybar)