Installation

Distro-specific

It is recommended that you install Pinnacle using your distro's package manager.

TODO: lmao we don't have any packages yet

From Source

Alternatively, you can build and install Pinnacle from source.

Dependencies

To build the project, you will need Rust 1.82 or newer.

First, you will need the following dependencies:

• just
• libwayland
• libxkbcommon
• libudev
• libinput
• libgbm
• libseat
• libEGL
• libsystemd
• libdisplay-info for monitor display information
• xwayland for Xwayland support
• protoc for the API

To configure Pinnacle using Lua, you will also need:

• lua 5.2 or newer
• luarocks for API installation

NOTE

You must run eval $(luarocks path --lua-version <your-lua-version>) so that your config can find the API library files. It is recommended to place this command in your shell's startup script.

Building

Clone the repository.

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

To build Pinnacle, run just, passing install to install the Lua API with Luarocks. This passes through arguments to Cargo.

just install build [--release]

IMPORTANT

When compiling with Snowcap integration (on by default), if you do not have Vulkan set up properly, Pinnacle will crash on startup.

For those using Nix outside of NixOS, you will need to run the built binary with nixGL using both GL and Vulkan wrappers, nested inside one another:

nix run --impure github:nix-community/nixGL -- nix run --impure github:nix-community/nixGL#nixVulkanIntel -- ./target/debug/pinnacle