adriangl/niri_overview
0
0
Fork 0
Code Issues Pull Requests Releases Activity

Delete readme.md

Browse Source
This commit is contained in:
Adrian Gunnar Lauterer 2025-04-25 13:52:12 +02:00
parent 07b87570c0
commit 6bfa912e98
Signed by: PVV Git
GPG Key ID: F594EC9FB2FCA9F1
1 changed files with 0 additions and 81 deletions

81
readme.md

@ -1,81 +0,0 @@
dependencies
gtk3.0 +++
python
build binary
```sh
python -m nuitka --standalone --onefile --include-package=gi --include-plugin-directory=/usr/lib/python3.13/site-packages/gi --include-data-file=style.css=style.css niri_overview.py
```
## Overview
This repository provides a GTK3-based overlay that presents Niri outputs, workspaces and windows in a compact, semi-transparent panel. It enables rapid navigation by clicking workspace or application entries to focus them, and visually distinguishes the active workspace and focused window through configurable neon-tinted borders and shadows.
## Dependencies
The application requires Python 3 (version 3.8 or later) and the following PyGObject-based GTK libraries:
• `PyGObject` with GTK 3.0, Gdk 3.0, Pango 1.0, Gio 2.0 and GLib 2.0 bindings
• A working `niri` command-line client in your $PATH, emitting JSON via `niri msg --json …`
• A compositor supporting RGBA visuals (e.g. picom or Mutter) for transparency
• A Nerd Font (e.g. Hack Nerd Font) installed to render glyph fallbacks
On Debian/Ubuntu-derived systems these can be installed via:
```bash
sudo apt install python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-gdkpixbuf-2.0 \
gir1.2-pango-1.0 gir1.2-glib-2.0 gir1.2-gio-2.0
```
Ensure `niri` is available (often bundled with Wayfire or similar) and that your compositor is running.
## Installation
Place the three files—`niri_overview.py`, `config.py` and `style.css`—in a single directory. Make `niri_overview.py` executable:
```bash
chmod +x niri_overview.py
```
Confirm that `config.py` references the correct path to `style.css` (by default it assumes both reside in the same folder).
to use nuitka to compile a static binary (on arch)
```bash
python -m nuitka --standalone --onefile --include-package=gi --include-plugin-directory=/usr/lib/python3.13/site-packages/gi --include-data-file=style.css=style.css niri_overview.py
```
## Configuration
All tunable parameters appear in `config.py`. Adjust `ICON_SIZE_PX` or `WINDOW_WIDTH` for icon sizing or panel width. Modify `BACKGROUND_RGBA` to change the overlay’s darkness and transparency. Application glyph fallbacks and the default glyph for unknown apps can also be extended there.
Styling is defined in `style.css`. You may alter the background RGBA, neon accent colors or border/shadow rules. GTK3’s CSS parser does not support custom properties, so all color values must be specified literally.
## Usage
Launch the overview panel by running:
```bash
./niri_overview.py
```
The script will subscribe to Niri’s JSON event stream, perform an initial data fetch, then enter the GTK main loop. To exit, press `q`, `Escape`, or close all visible panels.
## Customization
To use a different font for glyph fallbacks, install and reference it in your system. To change neon accent hues, edit the corresponding color values in `style.css` under the sections:
- `.output-title` for the output‐name accent
- `.clickable.workspace-focused` and `.clickable.window-focused` for focused borders
- `.glyph-label` for fallback glyph coloring
After modifying `style.css`, simply restart `niri_overview.py` to see changes.
## License
This project is provided under the GPL V3 License.