peachwm/README.md

PeachWM

• PeachWM
  • peachwm
  • Features
  • Dependencies
  • Configuration
  • Installation
  • Roadmap

peachwm

peachwm is a fork of swindle PeachWM is now a independent wayland compositor based on WLRoots that is designed to be similar to MangoWC, while remaining lightweight.

PeachWM is maintained by HuntedByTheIRS.

Features

• Lua configuration
• Dwindle, Master, Monocle, and Floating layouts
• XWayland support
• Lightweight

Dependencies

• libinput
• wayland
• wlroots-0.20 (compiled with the libinput backend)
• xkbcommon
• wayland-protocols (compile-time only)
• pkg-config (compile-time only)
• a C23 compiler — GCC 14+ or Clang 18+ (clang recommended)

Install these (and their -devel versions if your distro has separate development packages) and run make followed by doas/sudo make install, if you wish to install it (installs to /usr/local/bin/ by default).

Configuration

Read example/config.lua. It should give you a basic idea of how configuring peachwm works.

Its good to move/copy /etc/peachwm/config.lua to $HOME/.config/peachwm/, but will start without this step if you choose not to.

Installation

make release -j$(nproc)
sudo make install
mkdir -p $HOME/.config/peachwm/
cp /etc/peachwm/config.lua $HOME/.config/peachwm/config.lua

Roadmap

• No longer require exiting peachwm upon input config changes
• Allow status bar requests (swaymsg like)
• Add smartgaps
• Implement scratchpad workspaces
• Add animations via scenefx