Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/way-edges/way-edges
hidden widget on screen edges.
https://github.com/way-edges/way-edges
cairo gtk4 layer-shell rust wayedges wayland wayland-client
Last synced: 12 days ago
JSON representation
hidden widget on screen edges.
- Host: GitHub
- URL: https://github.com/way-edges/way-edges
- Owner: way-edges
- License: mit
- Created: 2024-08-12T15:26:35.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-28T10:12:42.000Z (17 days ago)
- Last Synced: 2024-10-28T13:21:43.467Z (17 days ago)
- Topics: cairo, gtk4, layer-shell, rust, wayedges, wayland, wayland-client
- Language: Rust
- Homepage: https://way-edges.github.io/description
- Size: 1.25 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
https://github.com/user-attachments/assets/37d267cb-1cb4-44b4-81a8-8ac02bb741cb
## 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/`
### Full doc
Doc: https://way-edges.github.io/basic_config
### Schema
Please refer to [config.jsonc](./config/config.jsonc) and [schema](./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
```
## TODO
- [x] fixed FPS.
- [x] widget grouping
- [x] configuration file
- [x] JSON schema for configuration file
- [x] watch file & hot reload
- [x] CLI
- [x] monitor relative height
- [ ] wayland working area relative height (wayland compositor specific relative height as features(including exclusive zone calculation))
- [ ] ease-in & ease-out widget motion curve
- [ ] widgets
- [x] Button
- [x] Slider
- [x] PulseAudio(Speaker, Microphone)
- [x] Brightness
- [x] Ring progress(ram/swap/cpu/battery/disk/custom)
- [x] Text(time/custom)
- [x] Box
- [x] Hyprland Workspaces
- [ ] Tray
- [ ] ?multiple click & long press & release event(Button widget)
- [ ] ~~?buttom size calculation, arrangement and overlap(should this be considered?)~~