github.com/bea4dev/ShojiWM @main

ShojiWM

A highly customizable Wayland compositor configured with TypeScript/TSX.

Documents

• English
• 日本語

Quick Start

Source installs are documented in the getting started guide. Experimental NixOS support is also available:

nix develop
npm ci
cargo run --release -p shoji_wm -- --dev

For NixOS module installation, see the installation docs.

Features

• [x] Window management
• [x] Animations
• [x] Screenshots and screen sharing via xdg-desktop-portal-shojiwm
• [x] XWayland support via xwayland-satellite
• [x] Custom shaders
• [x] Layer shell support
• [x] Multi-monitor support
• [x] Intel, AMD, and NVIDIA GPU support

Why not Niri or Hyprland?

Niri and Hyprland are, at their core, software that bundles a window manager and a compositor together.

ShojiWM is different. It provides only the compositor, plus window-manager functionality as a default config.

In other words, the window-manager part is something you can program entirely and freely yourself. That is exactly why it bills itself as "The most customizable Wayland compositor with TypeScript (tsx)."

Here is an example. The code below implements a window's close button. When you run it, the button's composition changes reactively on hover, so its appearance updates.

const CloseButton = ({ window }: { window: WaylandWindow }) => {
  const [hover, setHover] = useState(false);

  const borderColor = hover((hover) => (hover ? "#00000000" : "#F0808030"));

  var icon: CompositionRenderable | null = null;
  if (hover()) {
    icon = (
      <Image
        src="https://github.com/bea4dev/ShojiWM/raw/main/assets/x.svg"
        style={{
          width: 16,
          height: 16,
          position: "absolute",
          zIndex: 1,
          pointerEvents: "none",
        }}
      />
    );
  }

  return (
    <Box style={{ position: "relative", flexShrink: 0 }}>
      <Button
        onHoverChange={setHover}
        style={{
          width: 16,
          height: 16,
          borderRadius: 8,
          background: "#FFFFFF20",
          border: { px: 1, color: borderColor },
        }}
        onClick={window.close}
      />
      {icon}
    </Box>
  );
};

How ShojiWM compares

How ShojiWM differs from two popular Wayland compositors, Niri and Hyprland.

Legend: ✅ Yes / built-in  ·  🟡 Partial / limited  ·  ❌ No

¹ Hyprland 0.55+ adds custom layouts and event scripting via Lua (not TypeScript); core WM behavior remains built-in.

² Custom GLSL is limited to window open/close/resize animations.

³ A single full-screen screen shader, not a per-element pipeline.

⁴ Niri supports VRR (adaptive sync), but not a tearing / immediate-flip mode.

Comparison reflects each project at the time of writing; corrections are welcome.