alexxnica / way-cooler

Customizable Wayland compositor (window manager)

Way Cooler

Way Cooler is a customizable tiling window manager written in Rust for Wayland and configurable using Lua.

It is heavily inspired by the tiling and extensibility of both i3 and awesome.

While Lua is used for the configuration, like awesome, extensions for Way Cooler are implemented as totally separate client programs using D-Bus.

This means that you can use virtually any language to extend the window manager, with much better guarantees about interoperability between extensions.

Development

Way Cooler is currently in alpha. The core features have been added and it is in a usable state, but more work is needed to make it user friendly. Here's an example of what Way Cooler looks like today:

Motivation

We wanted to get experience with Rust and we found current X11 window managers to not have all the features we wanted.

Currently there are very few fully-featured tiling window managers in the Wayland ecosystem, as most of the effort has been porting Gnome and KDE over. Although Wayland is still in early-stage development and is not backwards compatible with existing X11 tools, we wanted to put our stake in and provide for current tiling window manager users in the future.

Current Features

• i3-style tiling
  • Horizontal/vertical layouts
  • Nest containers with different layouts
  • Floating windows per workspace
• Client application support via the D-Bus IPC
  • See an example application here. It displays the tree in a somewhat organized format, and is actually really helpful for both debugging the tree and understanding how subcontainers work.
  • Enables dynamic configuration at runtime, without having to reload a configuration file
  • Allows extensions of the window manager to exist as separate programs talking over the IPC
• A Lua environment designed to make extending Way Cooler simple and easy
  • Lua is the configuration format, allowing the user to enhance their window manager in any way they want.
  • Utilities library included to aid communicating with Way Cooler
• X programs supported through XWayland
• Borders around windows
• Gaps between windows
• Basic X11 bar support (e.g lemonbar, polybar)
• Screen grabber / screen shot taker

Planned Features

• i3 tabbed/stacked tiling
• Notification support
• Lock screen
• Tiling window through configurable Lua scripts (awesome-style)
• Swappable status bars/docs/menus
  • A status bar built with Conrod and Lua
• More customization settings

Follow the development of these features in our issues section or checkout our contribution guidelines if you want to help out.

Installation

On the AUR

@vinipsmaker was kind enough to provide AUR packages:

way-cooler

way-cooler-git

NixOS

@miltador was kind enough to provide a NixOS package.

Installation Script

For users who are not on Arch or NixOS, we have provided a simple install script that you can run in the terminal in order to install Way Cooler.

curl https://way-cooler.github.io/way-cooler-release-i3-default.sh -sSLf | sh -s way-cooler-bg  wc-grab 

Build from source

You will need the following dependencies installed on your machine to install Way Cooler:

• Wayland
  • Including the server and client libraries
• wlc
  • Installation instructions can be found on their github page
• Weston (optional)
  • The init file defaults to using weston-terminal as the default terminal emulator
• Cargo
  • The package manager / build system used by Rust
• Cairo

Finally, to install Way Cooler simply run the following cargo command:

cargo install way-cooler

You can try it out while running in an X environment, or switch to a TTY and run it as a standalone

Init File

All keyboard shortcuts are configurable through the init file. The recommended strategy is to copy the default configuration file to $XDG_CONFIG_HOME/way-cooler/init.lua and edit from there.

Contributors

Way Cooler was started by @Timidger and @SnirkImmington, but these fine people have helped us:

• @vinipsmaker created (and maintains) AUR packages
• @miltador created NixOS package
• @starfys created way-cooler desktop file
• @toogley fixed a link
• @paulmenzel fixed a typo
• @thefarwind made kill way-cooler command rebindable
• @bluss for updating our use of PetGraph to use StableGraph
• @Abdillah
  • fixed background program to have solid colors be variable size at initilization
  • added modes to the background program (fill, fit, stretch, title)
• @hedning fixed an unsigned underflow in the tiling code

And of course, thanks to the Rust community and the developers of wlc.

Contributing

Check out Contributing for more information.

If you find bugs or have questions about the code, please submit an issue or ping us on gitter.