Skip to content
noctalia-devPublic

About

A Wayland compositor designed for daily use, with scrolling, dwindle, master, and stacking layouts, per-output workspaces, window rules, blur, shadows, and fluid animations.

Resources

Contributing

Stars

1.4k stars

Watchers

16 watching

Forks

Repository files navigation

Umbriel

A Wayland compositor designed for daily use, with scrolling, dwindle, master, and stacking layouts, per-output workspaces, window rules, blur, shadows, and fluid animations.

It runs independently and pairs with Noctalia, which provides a first-class desktop shell on top. Under the hood: C++23, wlroots, and umbrielfx, an in-tree hard fork of SceneFX.

Important

The project is young and actively evolving. It is usable today, but configuration keys, keybinds, and behavior may change between releases, and rough edges remain. Current defaults are opinions, not stability promises.

Umbriel Logo

Documentation Discord

Why Umbriel?

There is no single killer feature: we were disappointed with the choices available, so we built the compositor we wanted to live in. That is how Noctalia came to life, and this is its compositor side.

We want one desktop for productivity and gaming: flexible layouts, tab groups, and scratchpads for organizing work, alongside HDR, variable refresh rate, and configurable fullscreen presentation for games.

To understand the values and philosophy guiding the project, read our ethos.

Features

Install and run

See the installation guide for distribution packages, Nix, and source builds, then pick Umbriel in your display manager or run start-umbriel from a TTY. The default keybinds open kitty with mod+Return and the Noctalia launcher with mod alone.

Configuration

Copy examples/config.toml to ~/.config/umbriel/config.toml to start; changes apply live. The online documentation is the full reference.

Contributing

See CONTRIBUTING.md for development builds, code style, and checks, and SCOPE.md for what the project takes on and declines; please skim it before opening a feature request. Bug reports are always welcome, and help and design discussion happen on Discord.

Acknowledgements

Umbriel would not exist without the work of these projects, and we are grateful to everyone who builds and maintains them:

  • wlroots: the compositor library Umbriel is built on.
  • SceneFX: umbrielfx, Umbriel's scene graph and renderer, is a hard fork of SceneFX (MIT). Thank you for the foundation.
  • niri: its scrolling layout and animations inspired ours. Thank you for showing how good they can feel.
  • Hyprland: its visual effects inspired ours. Thank you for raising the bar.

Thank you to all their authors and contributors.

License

MIT License. See LICENSE for details.

Star History

Star History

About

A Wayland compositor designed for daily use, with scrolling, dwindle, master, and stacking layouts, per-output workspaces, window rules, blur, shadows, and fluid animations.

Resources

Contributing

Stars

1.4k stars

Watchers

16 watching

Forks

Releases

Packages

Contributors

Languages