A Lua framework for building your Wayland desktop. Layouts, widgets, keybindings, window rules, notifications, status bars, etc.
SomeWM has a complete widget system, a signal-driven object model, and a compositor runtime, all wired together so every piece can talk to every other piece. Write a widget that reacts to window focus changes. Build a layout that adapts to screen geometry. Script your entire workflow from rc.lua or from the command line.
Built on wlroots 0.20.2 or newer in the 0.20 series. Runs AwesomeWM configs: keybindings, rules, themes and the stock widgets carry over.
This branch (
main) is SomeWM 2.x. Widgets that draw themselves (their ownfitordraw, often built withwibox.widget.base.make_widget),wibox.hierarchyand the textbox measuring functions were removed in 2.1. If your config needs them, use SomeWM 1.4. See Choosing a version.
Default config (left) and a styled config (right)
| 1.4 | 2.x | |
|---|---|---|
| Branch | release/1.4 |
main |
| AUR | somewm |
somewm-git |
| Lua API | AwesomeWM's, follows AwesomeWM master | AwesomeWM's, minus what 2.1 removed |
| Receives | Crash fixes, build fixes, AwesomeWM ports | Features and fixes |
Use 1.4 if your config has widgets with their own fit or draw, walks wibox.hierarchy, or measures text with textbox:get_preferred_size. On 2.x such a widget is left out and the log names it. Otherwise use 2.x. The 2.0 to 2.1 upgrade guide lists everything that was removed.
Only the newest 2.x release gets fixes. 2.0 ended at 2.0.1. somewm-git builds main and moves to each new 2.x release when it lands, including releases that remove API.
Arch Linux (AUR):
yay -S somewm # 1.4
yay -S somewm-git # 2.x, builds mainFrom source:
git clone https://github.com/trip-zip/somewm
cd somewm
make
sudo make installFor Debian, Fedora, NixOS, and detailed instructions, see the Installation Guide.
wlroots. somewm links an installed wlroots 0.20.2 or newer in the 0.20 series when it finds one (wlroots0.20 on Arch). It must include GLES2, XWayland, DRM, libinput, X11 and session support. When none is installed, the build downloads wlroots 0.20.2 and builds it into somewm. wlroots needs wayland 1.24.0, libdrm 2.4.129, xkbcommon 1.8.0, pixman 0.46.0, wayland-protocols 1.47 and libdisplay-info 0.2.0 or newer. Each one that is older is downloaded at a fixed version and built alongside it. Debian 13 and Ubuntu 24.04 build this way. Pass --wrap-mode=nofallback to meson setup to forbid downloads.
XWayland. XWayland support is always built in, so xcb, xcb-icccm and Xwayland are required to build. X11 applications need the Xwayland binary at runtime.
From a TTY:
dbus-run-session somewmFrom a display manager, select "somewm" as your session.
Systemd units are also included for session management.
Validate your config before switching:
somewm --checkSee First Launch for configuration and migrating from AwesomeWM.
Full documentation at somewm.org:
- Getting Started - Installation, first launch, migration
- Tutorials - Keybindings, widgets, themes
- Wayland Protocols - Protocols somewm advertises to clients
- Troubleshooting - Common issues and solutions
Contributions welcome! Please read the Contributing Guide first.
- Report bugs or request features via Issues
- Questions and discussion at Discussions
- AwesomeWM - The GOAT window manager
- wlroots - The Wayland compositor library
- dwl - Initial reference for wlroots integration
GPLv3. See LICENSE for details.