1<img align="right" width="25%" src="https://github.com/Smithay/smithay/assets/20758186/7a84ab10-e229-4823-bad8-9c647546407b">
2
3# Smithay
4
5[![Crates.io](https://img.shields.io/crates/v/smithay.svg)](https://crates.io/crates/smithay)
6[![docs.rs](https://docs.rs/smithay/badge.svg)](https://docs.rs/smithay)
7[![Build Status](https://github.com/Smithay/smithay/workflows/Continuous%20Integration/badge.svg)](https://github.com/Smithay/smithay/actions)
8[![Join the chat on matrix at #smithay:matrix.org](https://img.shields.io/badge/%5Bm%5D-%23smithay%3Amatrix.org-blue.svg)](https://matrix.to/#/#smithay:matrix.org)
9![Join the chat via bridge on #smithay on libera.chat](https://img.shields.io/badge/IRC-%23Smithay-blue.svg)
10
11A smithy for rusty wayland compositors
12
13## Goals
14
15Smithay aims to provide building blocks to create wayland compositors in Rust. While not
16being a full-blown compositor, it'll provide objects and interfaces implementing common
17functionalities that pretty much any compositor will need, in a generic fashion.
18
19It supports the [core Wayland protocols](https://gitlab.freedesktop.org/wayland/wayland), the official [protocol extensions](https://gitlab.freedesktop.org/wayland/wayland-protocols), and *some* external extensions, such as those made by and for [wlroots](https://gitlab.freedesktop.org/wlroots/wlr-protocols) and [KDE](https://invent.kde.org/libraries/plasma-wayland-protocols)
20<!-- https://github.com/Smithay/smithay/pull/779#discussion_r993640470 https://github.com/Smithay/smithay/issues/778 -->
21
22Also:
23
24- **Documented:** Smithay strives to maintain a clear and detailed documentation of its API and its
25  functionalities. Compiled documentations are available on [docs.rs](https://docs.rs/smithay) for released
26  versions, and [here](https://smithay.github.io/smithay) for the master branch.
27- **Safety:** Smithay will target to be safe to use, because Rust.
28- **Modularity:** Smithay is not a framework, and will not be constraining. If there is a
29  part you don't want to use, you should not be forced to use it.
30- **High-level:** You should be able to not have to worry about gory low-level stuff (but 
31  Smithay won't stop you if you really want to dive into it).
32
33
34## Anvil
35
36Smithay as a compositor library has its own sample compositor: anvil.
37
38To get informations about it and how you can run it visit [anvil README](https://github.com/Smithay/smithay/blob/master/anvil/README.md)
39
40## Other compositors that use Smithay
41
42- [Cosmic](https://github.com/pop-os/cosmic-epoch): Next generation Cosmic desktop environment
43- [Catacomb](https://github.com/catacombing/catacomb): A Wayland Mobile Compositor
44- [MagmaWM](https://github.com/MagmaWM/MagmaWM): A versatile and customizable Wayland Compositor
45- [Niri](https://github.com/YaLTeR/niri): A scrollable-tiling Wayland compositor
46- [Strata](https://github.com/StrataWM/strata): A cutting-edge, robust and sleek Wayland compositor
47- [Pinnacle](https://github.com/Ottatop/pinnacle): A WIP Wayland compositor, inspired by AwesomeWM 
48- [Sudbury](https://gitlab.freedesktop.org/bwidawsk/sudbury): Compositor designed for ChromeOS
49- [wprs](https://github.com/wayland-transpositor/wprs): Like [xpra](https://en.wikipedia.org/wiki/Xpra), but for Wayland, and written in
50Rust.
51
52## System Dependencies
53
54(This list can depend on features you enable)
55
56- `libwayland`
57- `libxkbcommon`
58- `libudev`
59- `libinput`
60- `libgbm`
61- [`libseat`](https://git.sr.ht/~kennylevinsen/seatd)
62- `xwayland`
63
64## Contact us
65
66If you have questions or want to discuss the project with us, our main chatroom is on Matrix: [`#smithay:matrix.org`](https://matrix.to/#/#smithay:matrix.org).