https://github.com/way-cooler/way-cooler

Wayland compositor for AwesomeWM
https://github.com/way-cooler/way-cooler

lua tiling-window wayland wayland-compositor

Last synced: 3 months ago
JSON representation

Wayland compositor for AwesomeWM

• Host: GitHub
• URL: https://github.com/way-cooler/way-cooler
• Owner: way-cooler
• License: mit
• Archived: true
• Created: 2016-01-09T05:24:44.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T21:57:23.000Z (almost 5 years ago)
• Last Synced: 2024-09-22T02:33:13.320Z (3 months ago)
• Topics: lua, tiling-window, wayland, wayland-compositor
• Language: C
• Homepage: http://way-cooler.org
• Size: 16.3 MB
• Stars: 2,137
• Watchers: 91
• Forks: 75
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog/v0.3.2.md
  • Contributing: Contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rust - way-cooler/way-cooler - ci.org/way-cooler/way-cooler.svg?branch=master">](https://travis-ci.org/way-cooler/way-cooler) (Applications / Window managers)
• awesome-rust-zh - way-cooler/way-cooler - 可定制的 Wayland 组合器（窗口管理器）[<img src="https://api.travis-ci.org/way-cooler/way-cooler.svg?branch=master">](https://travis-ci.org/way-cooler/way-cooler) (应用 / 窗口管理员)
• awesome-rust - way-cooler/way-cooler - ci.org/way-cooler/way-cooler.svg?branch=master">](https://travis-ci.org/way-cooler/way-cooler) (应用 Applications / 窗口管理 Window managers)
• awesome-starred - way-cooler/way-cooler - Wayland compositor for AwesomeWM (lua)
• awesome-rust-cn - way-cooler/way-cooler - ci.org/way-cooler/way-cooler.svg?branch=master">](https://travis-ci.org/way-cooler/way-cooler) (应用 / Window managers)

README

        
#  Way Cooler

[![Downloads](https://img.shields.io/crates/d/way-cooler.svg)](https://crates.io/crates/way-cooler)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/way-cooler/way-cooler/)

Way Cooler is the compositor component of [AwesomeWM][] for [Wayland][]. 

## Building

To build Way Cooler, ensure you have meson installed 

(as well as [wlroots][], or use the `subprojects/` directory 

and build it locally).

Then, execute:

```bash

meson build

ninja -C build

```

To run the compositor simply execute `build/way-cooler/way-cooler` in a TTY or

any existing window manager.

It can run with [this patched version of the Awesome

client](https://github.com/way-cooler/awesome). The simplest way to execute both

is to run `way-cooler -c `.

Though technically they can run standalone, the compositor is not usable by

itself and the client will fail out in other compositor due to the custom

protocols not being present.

## Development

Way Cooler is under active development. If you would like to contribute you can

contact me best on [IRC][] (I also hang out on freenode).

**Master is not usable for production**. There are old versions of Way Cooler

that do work, however:

* Is written in Rust and must be built with `cargo`.

* They use an old framework, [wlc][], and thus are very limited and buggy.

* Was not designed to emulate Awesome, but instead has [i3][] tiling and its own

  (very incomplete) Lua libraries.

[Wayland]: https://wayland.freedesktop.org/

[wlc]: https://github.com/Cloudef/wlc

[AwesomeWM]: https://awesomewm.org/

[wlroots]: https://github.com/swaywm/wlroots

[IRC]: https://webchat.oftc.net/?channels=awesome&uio=d4

[i3]: https://i3wm.org