Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2hdddg/zenway
WIP sway bar alternative that is not really a bar but an overlay displayed on top of workspaces
https://github.com/2hdddg/zenway
linux-desktop status-bar swaybar swaywm wayland
Last synced: 4 days ago
JSON representation
WIP sway bar alternative that is not really a bar but an overlay displayed on top of workspaces
- Host: GitHub
- URL: https://github.com/2hdddg/zenway
- Owner: 2hdddg
- Created: 2023-10-13T21:09:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-13T16:02:29.000Z (3 months ago)
- Last Synced: 2024-08-13T19:13:52.832Z (3 months ago)
- Topics: linux-desktop, status-bar, swaybar, swaywm, wayland
- Language: C++
- Homepage:
- Size: 973 KB
- Stars: 19
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# zenway
WIP sway bar alternative that is not really a bar but an overlay displayed on top of workspaces. The overlay is visible when Sway mod key is held down.
Screenshot shows Neovim and Firefox in background with zenway status shown above it.
# Features
* Configuration with lua.
* Dynamic layout similair to CSS flexbox but all in Lua (no html or css)
* Supports status for:
- Sway workspaces including applications per workspace
- Battery capacity
- Audio (currently only PulseAudio), mute, volume
- Current time and date
- Keyboard layout.
* Customizable mouse click/wheel per status widget.
# Installation
In Sway config add entry to start Zenway:
```
exec zenway
```
In Sway config bar config:
```
bar {
mode hide
modifier Mod1
swaybar_command whatever
}
```
# Configuration
## Location
Searches for configuration file in:
* XDG_CONFIG_HOME/zenway/config.lua
* ~/.config/zenway/config.lua
## Format
config.lua should return a Lua table that contains the static part
configuration properties:
```lua
return {
panels = {
{
anchor = "left"
widgets = {
{ sources = {'time', 'date'}, on_render = render_time },
{ sources = {'keyboard'}, on_render = render_keyboard, on_click = click_keyboard, on_wheel = wheel_keyboard },
},
direction = "column",
},
{
anchor = "right"
...
},
}
```
The above configuratuion will display a panel with two widgets on the left side of the
screen. When zenway determines that any of the specified sources is dirty like timer expired in case of 'time'
or keyboard layout changed in case of 'keyboard' the specified on_render Lua function is invoked.
Zenway maintains state of all sources and makes that state accesible from Lua.
This is how the keyboard render function might look like:
```lua
local function render_keyboard()
-- State of sources are kept in zen..
local layout = zen.keyboard.layout
-- Pango markup
local markup = "" .. layout .. ""
-- Simplified layout rendered by Zenway
return {
type = "box",
markup = markup,
color = "#1c1b19",
radius = 5,
border = { width = 2, color = '#10101080' },
tag = "id",
}
end
```
The widgets will be rendered with time aligned to the left with the keyboard rendered
below as specified by the direction = "column".
The keyboard widget also specifies two other Lua functions in on_click and on_wheel. Those are invoked
when user mouse clicks or wheels on widget. The render function specifies a tag, if the user clicks in
that part of the widget, the tag will be the first argument to the event handler.
# How to build
## Build with Docker
See docker container matching your platform to build locally. The docker containers
have two purposes. One, build on pull requests and two, build locally for different
platforms.
Docker based build scripts for different distributions are in project root.
Each build script outputs to a corresponding build directory where the binary can
be found. Runtime dependencies on host needs to be installed manually.
Supported distributions:
* Ubuntu-22.04. Use build script build-ubuntu-22.04.
* Archlinux. Use build script build-arch.
## Build on host
These packages are needed to build locally (exact name and version might vary):
* libfmt-dev
* wayland-protocols
* libwayland-client0
* libwayland-dev
* libcairo2-dev
* libpango1.0-dev
* libxkbcommon-dev
* liblua5.4-dev
* libpulse-dev
To build you need gcc, pkg-config, meson and ninja
In repo root:
meson build,
ninja -C build
Binary and config is currently not installed so invoke the binary from the build
directory. Copy the config folder to ~/.config/zenway/