https://github.com/Smithay/smithay

A smithy for rusty wayland compositors
https://github.com/Smithay/smithay

rust wayland wayland-compositor

Last synced: about 1 month ago
JSON representation

A smithy for rusty wayland compositors

• Host: GitHub
• URL: https://github.com/Smithay/smithay
• Owner: Smithay
• License: mit
• Created: 2017-01-20T08:53:24.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T22:51:02.000Z (about 2 months ago)
• Last Synced: 2024-10-20T09:50:56.961Z (about 2 months ago)
• Topics: rust, wayland, wayland-compositor
• Language: Rust
• Size: 20.8 MB
• Stars: 1,853
• Watchers: 25
• Forks: 161
• Open Issues: 169
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-rust - Smithay/smithay

README

        


# Smithay

[![Crates.io](https://img.shields.io/crates/v/smithay.svg)](https://crates.io/crates/smithay)

[![docs.rs](https://docs.rs/smithay/badge.svg)](https://docs.rs/smithay)

[![Build Status](https://github.com/Smithay/smithay/workflows/Continuous%20Integration/badge.svg)](https://github.com/Smithay/smithay/actions)

[![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)

![Join the chat via bridge on #smithay on libera.chat](https://img.shields.io/badge/IRC-%23Smithay-blue.svg)

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](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)

Also:

- **Documented:** Smithay strives to maintain a clear and detailed documentation of its API and its

  functionalities. Compiled documentations are available on [docs.rs](https://docs.rs/smithay) for released

  versions, and [here](https://smithay.github.io/smithay) for the master branch.

- **Safety:** Smithay will target to be safe to use, because Rust.

- **Modularity:** Smithay is not a framework, and will not be constraining. If there is a

  part you don't want to use, you should not be forced to use it.

- **High-level:** You should be able to not have to worry about gory low-level stuff (but 

  Smithay won't stop you if you really want to dive into it).

## Anvil

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

To get informations about it and how you can run it visit [anvil README](https://github.com/Smithay/smithay/blob/master/anvil/README.md)

## Other compositors that use Smithay

- [Cosmic](https://github.com/pop-os/cosmic-epoch): Next generation Cosmic desktop environment

- [Catacomb](https://github.com/catacombing/catacomb): A Wayland Mobile Compositor

- [MagmaWM](https://github.com/MagmaWM/MagmaWM): A versatile and customizable Wayland Compositor

- [Niri](https://github.com/YaLTeR/niri): A scrollable-tiling Wayland compositor

- [Strata](https://github.com/StrataWM/strata): A cutting-edge, robust and sleek Wayland compositor

- [Pinnacle](https://github.com/Ottatop/pinnacle): A WIP Wayland compositor, inspired by AwesomeWM 

- [Sudbury](https://gitlab.freedesktop.org/bwidawsk/sudbury): Compositor designed for ChromeOS

- [wprs](https://github.com/wayland-transpositor/wprs): Like [xpra](https://en.wikipedia.org/wiki/Xpra), but for Wayland, and written in

Rust.

## System Dependencies

(This list can depend on features you enable)

- `libwayland`

- `libxkbcommon`

- `libudev`

- `libinput`

- `libgbm`

- [`libseat`](https://git.sr.ht/~kennylevinsen/seatd)

- `xwayland`

## Contact us

If 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).