Skip to content

linkfrg/ignis

Repository files navigation

Ignis

docs Checked with mypy Code style: black Linting: Ruff

A widget framework for building desktop shells, written and configurable in Python.

  • Configurable in Python
  • Easy to use
  • GTK4-based
  • Batteries Included (a lot of built-in Services and Utilities!)
  • Flexible work with widgets

Note

Ignis is mostly stable, but still a work in progress. The API is a subject to change.

The breaking changes tracker is available in #60

Getting started

See the Documentation

Supported Desktops

  • wlroots-based Wayland compositors (e.g., Sway)
  • Hyprland
  • Smithay based compositors (e.g., COSMIC)
  • KDE Plasma on wayland

...and all other compositors that implement the Layer Shell protocol.

Ignis is not supported on:

  • GNOME Wayland
  • X11

...because they don't support the Layer Shell protocol.

Examples

Contributing

Check out the Developer Guide

Special Thanks

AGS - for inspiration