docs: Wine runs natively on Wayland, only X11 clients need xwayland-satellite (#27)
- commit
- 318f46a782a4e722008d8d053a4eca90170d6832
- author
- bnema · · 2026-09-27 16:17 UTC
- committer
- GitHub · · 2026-09-27 16:17 UTC
- parent
- f40b3c9
- signature
- GPG Unverified
B5690EEEBB952194The key is unknown
2 files · +3 -3
M README.md +2 -2
| @@ -22,7 +22,7 @@ The design is deliberately small, and it will stay small: no animations, no them | |||
| 22 | 22 | ||
| 23 | 23 | ## Features | |
| 24 | 24 | ||
| 25 | - | - **Games.** A fullscreen window is scanned out directly, with tearing, VRR and explicit sync when the client asks for them. Steam and Wine run through xwayland-satellite. See [the performance path](#the-performance-path). | |
| 25 | + | - **Games.** A fullscreen window is scanned out directly, with tearing, VRR and explicit sync when the client asks for them. Wine runs natively on Wayland; Steam and other X11 clients run through xwayland-satellite. See [the performance path](#the-performance-path). | |
| 26 | 26 | - **HDR.** HDR10 output on capable displays. HDR clients (games, browsers, video players) are shown at full range; SDR content is shown at a configured brightness. | |
| 27 | 27 | - **Column tiling.** Up to `max-columns` windows share the screen, as in Sway; past that, columns scroll to the right, as in Niri. Limits are set per output or per workspace. | |
| 28 | 28 | - **Workspaces.** Numbered workspaces are created and removed as needed. Named workspaces declare their columns (width and command); NeferWL starts the commands and places each window. | |
| @@ -62,7 +62,7 @@ These protocols and kernel features cut copies, waits and latency between the ap | |||
| 62 | 62 | - **Frame pacing.** Apps get real flip times through `wp_presentation`, and can queue frames with `wp_fifo_v1` and `wp_commit_timing_v1`. | |
| 63 | 63 | - **Only what changed.** NeferWL redraws only damaged regions, skips surfaces hidden behind opaque ones, and leaves idle outputs alone. Frame, cursor, overlay and VRR go to the kernel in one atomic commit. | |
| 64 | 64 | - **Input.** Relative pointer, pointer constraints and keyboard shortcuts inhibit for games. Input at 1 kHz and more never waits on rendering, and the cursor has its own hardware plane. | |
| 65 | - | - **X11 games.** Steam and Wine run through xwayland-satellite, started on the first X11 connection. | |
| 65 | + | - **X11 games.** Steam and X11-only games run through xwayland-satellite, started on the first X11 connection. Wine with its Wayland driver does not need it. | |
| 66 | 66 | ||
| 67 | 67 | ## Hardware support | |
| 68 | 68 | ||
| @@ -22,7 +22,7 @@ The design is deliberately small, and it will stay small: no animations, no them | |||||
| 22 | 22 | ||||
| 23 | ## Features | 23 | ## Features | ||
| 24 | 24 | ||||
| 25 | - | - **Games.** A fullscreen window is scanned out directly, with tearing, VRR and explicit sync when the client asks for them. Steam and Wine run through xwayland-satellite. See [the performance path](#the-performance-path). | 25 | + | - **Games.** A fullscreen window is scanned out directly, with tearing, VRR and explicit sync when the client asks for them. Wine runs natively on Wayland; Steam and other X11 clients run through xwayland-satellite. See [the performance path](#the-performance-path). |
| 26 | - **HDR.** HDR10 output on capable displays. HDR clients (games, browsers, video players) are shown at full range; SDR content is shown at a configured brightness. | 26 | - **HDR.** HDR10 output on capable displays. HDR clients (games, browsers, video players) are shown at full range; SDR content is shown at a configured brightness. | ||
| 27 | - **Column tiling.** Up to `max-columns` windows share the screen, as in Sway; past that, columns scroll to the right, as in Niri. Limits are set per output or per workspace. | 27 | - **Column tiling.** Up to `max-columns` windows share the screen, as in Sway; past that, columns scroll to the right, as in Niri. Limits are set per output or per workspace. | ||
| 28 | - **Workspaces.** Numbered workspaces are created and removed as needed. Named workspaces declare their columns (width and command); NeferWL starts the commands and places each window. | 28 | - **Workspaces.** Numbered workspaces are created and removed as needed. Named workspaces declare their columns (width and command); NeferWL starts the commands and places each window. | ||
| @@ -62,7 +62,7 @@ These protocols and kernel features cut copies, waits and latency between the ap | |||||
| 62 | - **Frame pacing.** Apps get real flip times through `wp_presentation`, and can queue frames with `wp_fifo_v1` and `wp_commit_timing_v1`. | 62 | - **Frame pacing.** Apps get real flip times through `wp_presentation`, and can queue frames with `wp_fifo_v1` and `wp_commit_timing_v1`. | ||
| 63 | - **Only what changed.** NeferWL redraws only damaged regions, skips surfaces hidden behind opaque ones, and leaves idle outputs alone. Frame, cursor, overlay and VRR go to the kernel in one atomic commit. | 63 | - **Only what changed.** NeferWL redraws only damaged regions, skips surfaces hidden behind opaque ones, and leaves idle outputs alone. Frame, cursor, overlay and VRR go to the kernel in one atomic commit. | ||
| 64 | - **Input.** Relative pointer, pointer constraints and keyboard shortcuts inhibit for games. Input at 1 kHz and more never waits on rendering, and the cursor has its own hardware plane. | 64 | - **Input.** Relative pointer, pointer constraints and keyboard shortcuts inhibit for games. Input at 1 kHz and more never waits on rendering, and the cursor has its own hardware plane. | ||
| 65 | - | - **X11 games.** Steam and Wine run through xwayland-satellite, started on the first X11 connection. | 65 | + | - **X11 games.** Steam and X11-only games run through xwayland-satellite, started on the first X11 connection. Wine with its Wayland driver does not need it. |
| 66 | 66 | ||||
| 67 | ## Hardware support | 67 | ## Hardware support | ||
| 68 | 68 | ||||
M docs/desktop.md +1 -1
| @@ -49,7 +49,7 @@ Drag and drop is not supported yet. | |||
| 49 | 49 | ||
| 50 | 50 | ## X11 apps | |
| 51 | 51 | ||
| 52 | - | X11 apps such as Steam and Wine run through [xwayland-satellite](https://github.com/Supreeeme/xwayland-satellite) 0.7 or later, found in `PATH`. NeferWL opens an X11 display, sets `DISPLAY` for the programs it starts, and starts xwayland-satellite when the first X11 app connects. If xwayland-satellite exits, the next X11 app starts it again. | |
| 52 | + | X11 apps such as Steam run through [xwayland-satellite](https://github.com/Supreeeme/xwayland-satellite) 0.7 or later, found in `PATH`. NeferWL opens an X11 display, sets `DISPLAY` for the programs it starts, and starts xwayland-satellite when the first X11 app connects. If xwayland-satellite exits, the next X11 app starts it again. | |
| 53 | 53 | ||
| 54 | 54 | ```text | |
| 55 | 55 | xwayland = xwayland-satellite # the default; a path also works | |
| @@ -49,7 +49,7 @@ Drag and drop is not supported yet. | |||||
| 49 | 49 | ||||
| 50 | ## X11 apps | 50 | ## X11 apps | ||
| 51 | 51 | ||||
| 52 | - | X11 apps such as Steam and Wine run through [xwayland-satellite](https://github.com/Supreeeme/xwayland-satellite) 0.7 or later, found in `PATH`. NeferWL opens an X11 display, sets `DISPLAY` for the programs it starts, and starts xwayland-satellite when the first X11 app connects. If xwayland-satellite exits, the next X11 app starts it again. | 52 | + | X11 apps such as Steam run through [xwayland-satellite](https://github.com/Supreeeme/xwayland-satellite) 0.7 or later, found in `PATH`. NeferWL opens an X11 display, sets `DISPLAY` for the programs it starts, and starts xwayland-satellite when the first X11 app connects. If xwayland-satellite exits, the next X11 app starts it again. |
| 53 | 53 | ||||
| 54 | ```text | 54 | ```text | ||
| 55 | xwayland = xwayland-satellite # the default; a path also works | 55 | xwayland = xwayland-satellite # the default; a path also works | ||