aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2025-01-03 10:21:06 +0300
committerIvan Molodetskikh <yalterz@gmail.com>2025-01-03 10:50:02 +0300
commit0224452cef2af8c754b32a119998df8a4730eb42 (patch)
treec03d6bf2ea68ef5a612422f0671216e639b645ee
parentc17d4dc050327c974535369b0b70726b269fd82b (diff)
downloadniri-0224452cef2af8c754b32a119998df8a4730eb42.tar.gz
niri-0224452cef2af8c754b32a119998df8a4730eb42.tar.bz2
niri-0224452cef2af8c754b32a119998df8a4730eb42.zip
wiki/Xwayland: Clarify xwayland-satellite
-rw-r--r--wiki/Xwayland.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/wiki/Xwayland.md b/wiki/Xwayland.md
index b915239f..658b6a99 100644
--- a/wiki/Xwayland.md
+++ b/wiki/Xwayland.md
@@ -3,21 +3,27 @@ However, there are multiple solutions to running X11 apps in niri.
## Using xwayland-satellite
-[xwayland-satellite] is a new project that essentially implements rootless Xwayland in a separate application, without the host compositor's involvement.
+[xwayland-satellite] implements rootless Xwayland in a separate application, without the host compositor's involvement.
+It makes X11 windows appear as normal windows, just like a native Xwayland integration.
While it is still somewhat experimental, it handles a lot of applications correctly, like Steam, games and Discord.
-Build it according to instructions from its README, then run the `xwayland-satellite` binary.
-Now you can start X11 applications on the X11 DISPLAY that it provides:
+Install it from your package manager, or build it according to instructions from its README, then run the `xwayland-satellite` binary.
+Look for a log message like: `Connected to Xwayland on :0`.
+Now you can start X11 applications on this X11 DISPLAY:
```
env DISPLAY=:0 flatpak run com.valvesoftware.Steam
```
-They will appear as normal windows.
+![xwayland-satellite running Steam and Half-Life.](https://github.com/user-attachments/assets/57db8f96-40d4-4621-a389-373c169349a4)
-You can also set `DISPLAY` by default for all apps by adding it to the `environment` section of the niri config:
+You can also automatically run it at startup, and set `DISPLAY` by default for all apps by adding it to the `environment` section of the niri config:
```kdl
+spawn-at-startup "xwayland-satellite"
+// Or, if you built it by hand:
+// spawn-at-startup "~/path/to/code/target/release/xwayland-satellite"
+
environment {
DISPLAY ":0"
}