/strata

A cutting-edge, robust and sleek Wayland compositor with batteries included.

Primary LanguageRustGNU General Public License v3.0GPL-3.0

What's Strata?

Strata is a cutting-edge, robust and sleek Wayland compositor written in Rust using the Smithay library. It is designed to be minimal and flexible yet customizable. Strata is configured in Lua, a lightweight, high-level, multi-paradigm programming language. Lua allows you to customize Strata to a level which may be difficult to do in other config formats such as TOML or YAML.

Getting Started

1. Dependencies

To compile and use Strata, you need some dependencies that have to be installed using a package manager, such as pacman or apt, depending on your distro. The required dependencies are listed below:

  • udev
  • wayland
  • wayland-protocols
  • libinput
  • libxkbcommon
  • libglvnd
  • seatd
  • dbus-glib
  • mesa
  • make (for compiling and linking)

If you're on Arch or any Arch-based distro (such as Artix, Garuda, Manjaro, etc.), you can install these using the following command:

sudo pacman -S udev wayland wayland-protocols libinput libxkbcommon libglvnd seatd dbus-glib mesa make

If you're on Debian, or Debian-based distros such as Ubuntu, Mate, Zorin, etc... you can install these using this command:

sudo apt-get install libudev-dev libgbm-dev libxkbcommon-dev libegl1-mesa-dev libwayland-dev libinput-dev libdbus-1-dev libsystemd-dev libseat-dev make

2. Installing Rust

To compile Strata, you have to install Rust:

All Linux distros

curl https://sh.rustup.rs -sSf | sh

Arch Linux

sudo pacman -S rust

3. Compiling

3.1 Clone the repository

git clone https://github.com/stratawm/stratawm

3.2 Compile and Install

To install, cd into the cloned repo and then run:

sudo make install

This will compile Strata and also copy the necessary libraries. It will also copy a default config for you to get started with. This might take a bit of time since it has to compile the source code and all the dependencies but if your system is a bit better than a potato, it won't take much time.

Executing

To start Strata, you can run this command from a terminal

stratawm --backend winit

This will start Strata using the winit backend. For this to work, another X11 window manager or another Wayland should be running. Support for launching from the TTY will be added shortly.

License

StrataWM and all its subsidiaries are licensed under the GNU GPL v3 License. See LICENSE for details.

Contributing

Refer to CONTRIBUTING.md