Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastiancarlos/sway-musli
Sway-MÜSLI: Sway - Minimal Ültrafast Status LIne
https://github.com/sebastiancarlos/sway-musli
c i3 i3bar i3wm linux statusbar sway sway-config swaybar swaywm tiling-window-manager wayland
Last synced: about 6 hours ago
JSON representation
Sway-MÜSLI: Sway - Minimal Ültrafast Status LIne
- Host: GitHub
- URL: https://github.com/sebastiancarlos/sway-musli
- Owner: sebastiancarlos
- License: mit
- Created: 2023-12-01T16:04:20.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-28T12:47:21.000Z (11 months ago)
- Last Synced: 2023-12-28T13:55:03.020Z (11 months ago)
- Topics: c, i3, i3bar, i3wm, linux, statusbar, sway, sway-config, swaybar, swaywm, tiling-window-manager, wayland
- Language: C
- Homepage:
- Size: 61.5 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sway-MÜSLI: Sway – Minimal Ültrafast Status Line
## Example
`MyWiFi | Colemak | 65% - Charging | Fri 2023-12-01 17:01:13`
## Features
- Written in C for **ültra speed**.
- No dependencies. Uses sockets for communication with Sway and Linux
subsystems.
- Takes **1ms** to render on my machine.
- Great performance even when running in **60 FPS möde**!
- Supports both Sway and i3.
- Easy to adapt to any status bar which supports text input.
- Minimal features:
- Shows wifi connection.
- Shows keyboard layout.
- Shows battery status.
- Shows date and time (even seconds!).
## Installation
1. Clone the repo and run:
```bash
make
make install # if you want to have the executable in your path
```
2. Add to your Sway/i3 config file:
```
bar {
...
status_command sway-musli
...
}
```
## Usage
```
Usage: sway-musli [-1|--once] [-f|--fps ]
- Print a stream of status lines to be used with swaybar.
- If passed -1 or --once, print once and exit.
- If passed -f or --fps, print at most times per second.
- Default is 30 FPS.
- Example sway config:
...
bar {
status_command sway-musli
}
...
# Note: Make sure sway-musli is in your PATH.
```
## FPS?
That's right. We are in high-performance territory now.
By default, `sway-musli` runs at **30 FPS**, but you can change it with the
`--fps` option.
- **1 FPS** is completely acceptable, but you might want more if you add some
sort of dynamic content, or if you want to see keyboard layout changes reflected
immediately.
- At around **60 FPS**, your processor might feel a slight tickle. If your bar
is hidden by default, you might as well run it at 60 FPS because Sway/i3 won't
run it while the bar is hidden.
## Notes
- Assumes your network device is `wlan0`. But you can change this in the source
file.
- You can take this as a sample code to help you build your personal
**ültrafast** Sway status line.
- See also, [i3status](https://manned.org/i3status.1),
[i3status-rust](https://github.com/greshake/i3status-rust), and
[i3blocks](https://github.com/vivien/i3blocks)
- I ate müsli while coding this 🥣
- Contributions welcome!
## License
MIT
## Contributing
We welcome contributions of all kinds. If you have a suggestion or fix, please feel free to open an issue or pull request.