From 96a971912c23ff202a2c28b28d2114438988f473 Mon Sep 17 00:00:00 2001
From: Simon McVittie <[EMAIL REDACTED]>
Date: Wed, 17 Dec 2025 14:46:46 +0000
Subject: [PATCH] README: Describe how to make X11-only games not need user
workarounds
Signed-off-by: Simon McVittie <smcv@collabora.com>
---
README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/README.md b/README.md
index 9c23bd63..ef656a38 100644
--- a/README.md
+++ b/README.md
@@ -179,3 +179,21 @@ program is expecting:
SDL_VIDEODRIVER=x11
+
+Please report this to the game developer as a bug.
+Game developers who know that their game engine requires X11 on Linux can
+arrange for this to happen by including code similar to this at the
+beginning of `main()`:
+```
+#ifdef SDL_VIDEO_DRIVER_X11
+SDL_SetHintWithPriority(SDL_HINT_VIDEODRIVER, "x11", SDL_HINT_OVERRIDE);
+#endif
+```
+
+This is backward-compatible with "classic" SDL 2 version 2.0.12 or later.
+If older versions need to be supported,
+set the `SDL_VIDEODRIVER` environment variable instead.
+
+For unmaintained games where applying this code change is not feasible,
+either a wrapper script can set the `SDL_VIDEODRIVER` environment variable,
+or the game can be added to the `quirks` array in sdl2-compat.