README.md

About

Pinnacle is a Wayland compositor built in Rust using Smithay. It's my attempt at creating something like AwesomeWM for Wayland.

Features

• Tag system
• Dynamic tiling
• Customizable layouts
• Support for most wlr protocols
• Floating window support
• Xwayland support
• Configurable in Lua or Rust
• Is very cool 👍

Getting started, building, and running

Read the wiki to get started.

Roadmap

• See #403

API references

Lua: https://pinnacle-comp.github.io/lua-reference
Rust: https://pinnacle-comp.github.io/rust-reference/main

Feature Requests, Bug Reports, Contributions, and Questions

See CONTRIBUTING.md.

Special Thanks

• Smithay: For being a great compositor library and also allowing me not to deal with all the graphics stuff I still don't understand
• Niri: For all that rendering and protocol stuff I, ahem, took inspiration from. And session stuff. And the test fixture.