https://github.com/pinnacle-comp/pinnacle

A WIP Smithay-based Wayland compositor, inspired by AwesomeWM and configured in Lua or Rust
https://github.com/pinnacle-comp/pinnacle

compositor lua rust smithay wayland

Last synced: 7 days ago
JSON representation

A WIP Smithay-based Wayland compositor, inspired by AwesomeWM and configured in Lua or Rust

• Host: GitHub
• URL: https://github.com/pinnacle-comp/pinnacle
• Owner: pinnacle-comp
• License: gpl-3.0
• Created: 2023-05-29T00:10:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T20:01:02.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T09:51:40.172Z (almost 2 years ago)
• Topics: compositor, lua, rust, smithay, wayland
• Language: Rust
• Homepage:
• Size: 2.69 MB
• Stars: 152
• Watchers: 10
• Forks: 4
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wayland - pinnacle - An AwesomeWM compositor clone. (Compositor / Tiling)

README

          
![Pinnacle banner](/assets/pinnacle_banner_dark.png)



[![Discord](https://img.shields.io/discord/1223351743522537565?style=for-the-badge&logo=discord&logoColor=white&label=Discord&labelColor=%235865F2&color=%231825A2)](https://discord.gg/JhpKtU2aMA)

[![Matrix](https://img.shields.io/matrix/pinnacle%3Amatrix.org?style=for-the-badge&logo=matrix&logoColor=white&label=Matrix&labelColor=black&color=gray)](https://matrix.to/#/#pinnacle:matrix.org)





## About

Pinnacle is a Wayland compositor built in Rust using [Smithay](https://github.com/Smithay/smithay).

It's my attempt at creating something like [AwesomeWM](https://github.com/awesomeWM/awesome)

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](https://pinnacle-comp.github.io/pinnacle/getting-started/introduction.html) to get started.

## Roadmap

- See [#403](https://github.com/pinnacle-comp/pinnacle/issues/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`](CONTRIBUTING.md).

## Special Thanks

- [Smithay](https://github.com/Smithay/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](https://github.com/YaLTeR/niri): For all that rendering and protocol stuff I, ahem, *took inspiration* from. And session stuff. And the test fixture.