Smithay/smithay

A smithy for rusty Wayland compositors

Goals

Smithay aims to provide building blocks to create Wayland compositors in Rust. While not being a full-blown compositor, it'll provide objects and interfaces implementing common functionalities that pretty much any compositor will need, in a generic fashion.

It supports the core Wayland protocols, the official protocol extensions, and some external extensions, such as those made by and for wlroots and KDE.

Also:

• Documented: Smithay strives to maintain clear and detailed documentation of its API and functionalities. Compiled documentation is available on docs.rs for released versions, and here for the master branch.
• Safety: Smithay aims to be memory-safe and reliable, thanks to Rust.
• Modularity: Smithay is not a framework and does not impose constraints. You are never required to use components you don’t need.
• High-level: You should not have to worry about gory low-level stuff (but Smithay won't stop you if you really want to dive into it).

Getting started

If you want to learn how to build a compositor with Smithay, the best place to start is the getting started guide.

Anvil

Smithay as a compositor library has its own sample compositor: anvil.

To get information about it and how you can run it, check out the anvil README

Other compositors that use Smithay

• Cosmic: Next-generation Cosmic desktop environment
• Catacomb: A Wayland Mobile Compositor
• emskin: A nested Wayland compositor for embedding any app inside Emacs
• MagmaWM: A versatile and customizable Wayland Compositor
• Niri: A scrollable-tiling Wayland compositor
• Strata: A cutting-edge, robust and sleek Wayland compositor
• Pinnacle: A WIP Wayland compositor, inspired by AwesomeWM
• Sudbury: Compositor designed for ChromeOS
• wprs: Like xpra, but for Wayland, and written in Rust.
• Local Desktop: An Android app for running GUI Linux via PRoot and Wayland.
• Otto: A gesture-driven stacking compositor.
• DriftWM: A trackpad-first infinite canvas Wayland compositor.

System Dependencies

(This list can depend on the features you enable)

• libwayland
• libxkbcommon
• libudev
• libinput
• libgbm
• libseat
• xwayland

Contact us

If you have questions or want to discuss the project with us, our main chatroom is on Matrix: #smithay:matrix.org.

Contributing

General notes on contributing to Smithay can be found here.

Please note that to submit code to Smithay, you must agree to our Developer Certificate of Origin.

If you are used to using generative AI, please ensure you read our Policy before starting.