mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-27 21:58:18 +01:00
116 lines
4 KiB
Markdown
116 lines
4 KiB
Markdown
Cool stuff happens on the dev branch sometimes, check it out!
|
|
|
|
# <div align="center">Pinnacle</div>
|
|
<div align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="/assets/cool_logo_dark_theme.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="/assets/cool_logo_light_theme.png">
|
|
<img alt="Cool logo" src="/assets/cool_logo_dark_theme.png">
|
|
</picture>
|
|
</div>
|
|
|
|
<div align="center">
|
|
A very, VERY WIP Smithay-based wayland compositor
|
|
</div>
|
|
|
|
## Features
|
|
- [x] Winit backend
|
|
- [x] Udev backend
|
|
- This is currently just a copy of Anvil's udev backend.
|
|
- [x] Basic tags
|
|
- Tags are currently very jank on the udev backend with multiple monitors. If you're checking udev out, I suggest unplugging all but one monitor or just using the winit backend until I flesh out the tag system.
|
|
- [ ] Widget system
|
|
- [ ] Layout system
|
|
- [ ] Server-side decorations
|
|
- [ ] The other stuff Awesome has
|
|
- [ ] XWayland support
|
|
- [ ] Layer-shell support
|
|
- [x] Is very cool :thumbsup:
|
|
|
|
## Info
|
|
### Why Pinnacle?
|
|
Well, I currently use [Awesome](https://github.com/awesomeWM/awesome). And I really like it! Unfortunately, Awesome doesn't exist for Wayland ([anymore](http://way-cooler.org/blog/2020/01/09/way-cooler-post-mortem.html)). There doesn't seem to be any Wayland compositor out there that has all of the following:
|
|
- Tags for window management
|
|
- Configurable in Lua (or any other programming language for that matter)
|
|
- Has a bunch of batteries included (widget system, systray, etc)
|
|
|
|
So, this is my attempt at making an Awesome-esque Wayland compositor.
|
|
|
|
## Dependencies
|
|
You'll need the following packages, as specified by [Smithay](https://github.com/Smithay/smithay):
|
|
```
|
|
libwayland
|
|
libxkbcommon
|
|
libudev
|
|
libinput
|
|
libgdm
|
|
libseat
|
|
```
|
|
Package names will vary across distros. TODO: list those names.
|
|
|
|
## Building
|
|
Build the project with:
|
|
```
|
|
cargo build [--release]
|
|
```
|
|
|
|
## Running
|
|
After building, run the executable located in either:
|
|
```
|
|
./target/debug/pinnacle --<backend> // without --release
|
|
./target/release/pinnacle --<backend> // with --release
|
|
```
|
|
|
|
Or, run the project directly with
|
|
```
|
|
cargo run [--release] -- --<backend>
|
|
```
|
|
|
|
`backend` can be one of two values:
|
|
|
|
- `winit`: run Pinnacle as a window in your graphical environment
|
|
- `udev`: run Pinnacle in a tty. NOTE: I tried running udev in Awesome and some things broke so uh, don't do that
|
|
|
|
## Configuration
|
|
Please note: this is VERY WIP and has basically no options yet.
|
|
|
|
Pinnacle supports configuration through Lua (and hopefully more languages if it's not too unwieldy :crab:).
|
|
|
|
Run Pinnacle with the `PINNACLE_CONFIG` environment variable set to the path of your config file. If not specified, Pinnacle will look for the following:
|
|
```
|
|
$XDG_CONFIG_HOME/pinnacle/init.lua
|
|
~/.config/pinnacle/init.lua // if XDG_CONFIG_HOME isn't set
|
|
```
|
|
The following will use the example config file in [`api/lua`](api/lua):
|
|
```
|
|
PINNACLE_CONFIG="./api/lua/example_config.lua" cargo run -- --<backend>
|
|
```
|
|
|
|
### Autocomplete and that cool stuff
|
|
It is *highly* recommended to use the [Lua language server](https://github.com/LuaLS/lua-language-server) and set it up to have the [`api/lua`](api/lua) directory as a library, as I'll be using its doc comments to provide autocomplete and error checking.
|
|
|
|
#### For VS Code:
|
|
Install the [Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) plugin, then go into its settings and add the absolute(?) path to the [`api/lua`](api/lua) directory to Workspace: Library.
|
|
|
|
#### For Neovim:
|
|
Pass this table into your Lua language server settings:
|
|
```lua
|
|
Lua = {
|
|
workspace = {
|
|
library = {
|
|
"/path/to/pinnacle/api/lua"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Doc website soon:tm:
|
|
|
|
## Controls
|
|
The following controls are currently hardcoded:
|
|
|
|
- `Ctrl + Left Mouse`: Move a window
|
|
- `Ctrl + Right Mouse`: Resize a window
|
|
- `Ctrl + Alt + Shift + Esc`: Kill Pinnacle. This is for when the compositor inevitably locks up because I did a dumb thing :thumbsup:
|
|
|
|
You can find the rest of the controls in the [`example_config`](api/lua/example_config.lua).
|