/waybox

An openbox clone on Wayland (WIP)

Primary LanguageCMIT LicenseMIT

Waybox

A *box-style (minimalist) Wayland compositor modeled largely on Openbox (WIP)

Goals

The main goal of this project is to provide a similar feel to *box-style window managers but on Wayland

Contributing

Details on contributing.

Dependencies

Build instructions

meson setup build
cd build
ninja

After that, you should have an executable as waybox/waybox

For those who don't want to use a Python-based build system, it's also possible to use muon instead of Meson.

Screenshots

Plain desktop with wallpaper, panel, and dock

Showing Firefox and some of the Waybox source code

All work and no play

Useful Programs

Because *box-style compositors are minimalist, most functionality is left to external programs. As such, Waybox only functions as a box in which you can put whatever you need. Here are some useful programs to complement Waybox if you desire:

  • Panel: You can use Waybar or yambar, similar to tint2 or fbpanel in Openbox or Fluxbox.
  • Dock: You can use Cairo Dock just like you did on Openbox. There's also a port with Wayland-specific enhancements that you may want to try. A much more compact option is LavaLauncher, but it's much harder to configure.
  • Wallpaper utility: There are various utilities to set your wallpaper, each with their own advantages, including wpaperd (can select a random wallpaper from a directory), swaybg (can set the background color as well well as a wallpaper), and hyprpaper (can change the wallpaper dynamically during runtime through IPC).
  • Notification client: mako
  • wl-clipboard: Access the clipboard in scripts (also used by neovim)
  • Screenshots: grim and slurp
  • Screen recording: wf-recorder
  • Menu support: rofi-wayland

Contact

I can be found as wiz on Rizon and wizbright on Libera. Join #waybox for discussion