Skip to content

bea4dev/ShojiWM

Repository files navigation

ShojiWM

A highly customizable Wayland compositor configured with TypeScript/TSX.

Discord

example0.mp4

Documents

Features

  • Window management
  • Animations
  • Screenshots and screen sharing via xdg-desktop-portal-shojiwm
  • XWayland support via xwayland-satellite
  • Custom shaders
  • Layer shell support
  • Multi-monitor support
  • 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.

Image
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="./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

Capability Niri Hyprland ShojiWM
Server-side decoration (SSD) customization via a standard API
Build your own window-management strategy in TypeScript 🟡 1
Powerful custom shader pipeline API 🟡 2 🟡 3
Linux gaming support, including tearing 🟡 4
First-class xwayland-satellite support

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

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

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

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

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

About

The most customizable Wayland compositor with TypeScript(tsx).

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages