Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayfirewm/wayfire
A modular and extensible wayland compositor
https://github.com/wayfirewm/wayfire
wayfire wayland wayland-compositor window-manager
Last synced: about 1 month ago
JSON representation
A modular and extensible wayland compositor
- Host: GitHub
- URL: https://github.com/wayfirewm/wayfire
- Owner: WayfireWM
- License: mit
- Created: 2016-03-04T15:00:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T11:01:59.000Z (7 months ago)
- Last Synced: 2024-04-14T10:28:56.144Z (7 months ago)
- Topics: wayfire, wayland, wayland-compositor, window-manager
- Language: C++
- Homepage: https://wayfire.org/
- Size: 6.69 MB
- Stars: 2,224
- Watchers: 42
- Forks: 168
- Open Issues: 169
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [Wayfire]
[Wayfire]: https://wayfire.org
[](https://matrix.to/#/#wayfire:matrix.org)
[](https://web.libera.chat/#wayfire)
[](https://discord.gg/5SWAxmBCUH)
[](https://github.com/WayfireWM/wayfire/actions)
[](https://repology.org/project/wayfire/versions)
[](LICENSE)
###### [Get started] | [Manual] | [Configuration]
[Get started]: https://github.com/WayfireWM/wayfire/wiki/Tutorial
[Manual]: https://github.com/WayfireWM/wayfire/wiki/General
[Configuration]: https://github.com/WayfireWM/wayfire/wiki/Configuration
Wayfire is a 3D [Wayland] compositor, inspired by [Compiz] and based on [wlroots].
It aims to create a customizable, extendable and lightweight environment without sacrificing its appearance.
[](https://youtube.com/playlist?list=PLb7YRKEhWEBUIoT-a29UoJW9mhfzjpNle "YouTube – Wayfire demos")
[](https://youtube.com/playlist?list=PLb7YRKEhWEBUIoT-a29UoJW9mhfzjpNle) · [Wayfire demos](https://youtube.com/playlist?list=PLb7YRKEhWEBUIoT-a29UoJW9mhfzjpNle)
[Wayland]: https://wayland.freedesktop.org
[wlroots]: https://github.com/swaywm/wlroots
[Compiz]: https://launchpad.net/compiz
## Dependencies
### Wayfire Dependencies
These are the dependencies needed for building Wayfire.
- [Cairo](https://cairographics.org)
- [Pango](https://pango.gnome.org/) and PangoCairo
- [FreeType](https://freetype.org)
- [GLM](https://glm.g-truc.net)
- [libdrm](https://dri.freedesktop.org/wiki/DRM/)
- [libevdev](https://freedesktop.org/wiki/Software/libevdev/)
- [libGL](https://mesa3d.org)
- [libinput](https://freedesktop.org/wiki/Software/libinput/)
- [libjpeg](https://libjpeg-turbo.org)
- [libpng](http://libpng.org/pub/png/libpng.html)
- [libxkbcommon](https://xkbcommon.org)
- [libxml2](http://xmlsoft.org/)
- [Pixman](https://pixman.org)
- [pkg-config](https://freedesktop.org/wiki/Software/pkg-config/)
- [Wayland](https://wayland.freedesktop.org)
- [wayland-protocols](https://gitlab.freedesktop.org/wayland/wayland-protocols)
- [wf-config](https://github.com/WayfireWM/wf-config)
- [wlroots](https://github.com/swaywm/wlroots)
### wlroots Dependencies
These are the dependencies needed for building wlroots, and should be installed before building it.
They are relevant for cases when the system doesn't have a version of wlroots installed.
#### DRM Backend (required)
- [libdisplay-info-dev](https://gitlab.freedesktop.org/emersion/libdisplay-info)
- [hwdata-dev](https://github.com/vcrhonek/hwdata)
#### GLES2 renderer (required)
- [libglvnd](https://gitlab.freedesktop.org/glvnd/libglvnd)
- [mesa](https://gitlab.freedesktop.org/mesa/mesa) (with libEGL and gbm support)
#### Libinput Backend (required)
- [libinput](https://gitlab.freedesktop.org/libinput/libinput)
#### Session Provider (required)
- libudev (via [systemd](https://systemd.io/) **or** other providers)
- [seatd](https://git.sr.ht/~kennylevinsen/seatd)
#### XWayland Support (optional)
- [xcb](https://xcb.freedesktop.org/)
- [xcb-composite](https://xorg.freedesktop.org/wiki/)
- [xcb-render](https://xorg.freedesktop.org/wiki/)
- [xcb-xfixes](https://xorg.freedesktop.org/wiki/)
#### X11 Backend (optional)
- [xcb](https://xcb.freedesktop.org/)
- [x11-xcb](https://xcb.freedesktop.org/)
- [xcb-xinput](https://xorg.freedesktop.org/wiki/)
- [xcb-xfixes](https://xorg.freedesktop.org/wiki/)
## Installation
The easiest way to install Wayfire, wf-shell and WCM to get a functional desktop is to use the [install scripts](https://github.com/WayfireWM/wf-install).
Alternatively, you can build from source:
``` sh
meson build
ninja -C build
sudo ninja -C build install
```
**Note**: `wf-config` and `wlroots` can be built as submodules, by specifying
`-Duse_system_wfconfig=disabled` and `-Duse_system_wlroots=disabled` options to `meson`.
This is the default if they are not present on your system.
Installing [wf-shell](https://github.com/WayfireWM/wf-shell) is recommended for a complete experience.
###### Arch Linux
[wayfire](https://aur.archlinux.org/packages/wayfire/) and [wayfire-git] are available in the [AUR].
``` sh
yay -S wayfire
```
[AUR]: https://aur.archlinux.org
[wayfire-git]: https://aur.archlinux.org/packages/wayfire-git/
###### Exherbo
``` sh
cave resolve -x wayfire
```
###### Fedora
``` sh
dnf install wayfire
```
###### FreeBSD
Install the latest release and recommended addons with
``` sh
pkg install wayfire wayfire-plugins-extra wf-shell wcm
```
###### Gentoo
Install the latest release with
```sh
emerge --ask --verbose wayfire
```
and to use the live version
```sh
emerge --ask --verbose "=gui-wm/wayfire-9999"
```
###### NixOS
Enable Wayfire in your NixOS configuration:
```nix
programs.wayfire = {
enable = true;
plugins = with pkgs.wayfirePlugins; [
wcm
wf-shell
wayfire-plugins-extra
];
};
```
###### Ubuntu
```
apt install wayfire
```
###### Void
``` sh
xbps-install -S wayfire
```
## Configuration
Copy [`wayfire.ini`] to `~/.config/wayfire.ini`.
Before running Wayfire, you may want to change the command to start a terminal.
See the [Configuration] document for information on the options.
[`wayfire.ini`]: wayfire.ini
## Running
Run [`wayfire`][Manual] from a TTY, or via a Wayland-compatible login manager.