Configuration | ShojiWM

📄️Overview

ShojiWM is configured from TypeScript/TSX by default. Your config is a normal

TypeScript/TSX is ShojiWM's default config language, but it is not the only

ShojiWM ships with a complete default config (packages/config/src/index.tsx,

Lifecycle hooks

COMPOSITOR.output controls monitor layout — resolution, refresh rate, scale,

COMPOSITOR.input configures keyboards, pointers (mice), and touchpads. As with

COMPOSITOR.cursor configures the XCursor theme used by ShojiWM's

Keyboard shortcuts

Session logs

COMPOSITOR.window.composition is the heart of ShojiWM's customization. Assign a

These are the building blocks you assemble inside

Every server-side decoration is drawn by a shader. Paint shaders let you

When you drag something from one window to another (text, a file, a link),

ShojiWM's composition is reactive: when a value your code read changes, the

ShojiWM can run GPU shader effects in these places, configured via

COMPOSITOR.effect.overlay(output, options) draws a fullscreen effect through the

COMPOSITOR.rendering.composition decides how each output is put together. It is

Every node and helper of output composition, all exported

Complete effects built from output composition. Each one

ShojiWM offers two ways to animate, with different trade-offs:

ShojiWM keeps time per output. Each output's clock is the presentation time

ShojiWM can host KDE's plasmashell, so you keep the KDE taskbar, Kickoff,

While the session is locked, ShojiWM normally draws nothing but the locker's