From fd6193ff62d2ba5d0750e53822ff6e6f731701ad Mon Sep 17 00:00:00 2001 From: David Miserak Date: Sun, 24 May 2026 17:47:47 -0400 Subject: [PATCH] docs: add Wayland troubleshooting section to README --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 39cd131..e2650ba 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ FLC is a lightweight desktop application for managing and connecting to Foundry Virtual Tabletop servers. -- **Website:** https://foundry.ruleplaying.com/flc -- **Issues**: https://github.com/phenomen/flc/issues +- **Website:** +- **Issues**: - **Changelog**: [CHANGELOG.md](CHANGELOG.md) ## Features @@ -57,6 +57,22 @@ bun install bun run tauri dev ``` +### Troubleshooting + +**Wayland: Protocol error on startup** + +If you see `Error 71 (Protocol error) dispatching to Wayland display`, WebKitGTK has a known compositing issue on some Wayland compositors. The `make run` target sets `WEBKIT_DISABLE_COMPOSITING_MODE=1` automatically. If running Tauri directly, prefix the command: + +```bash +WEBKIT_DISABLE_COMPOSITING_MODE=1 bun run tauri dev +``` + +Alternatively, force the X11 backend via XWayland: + +```bash +GDK_BACKEND=x11 bun run tauri dev +``` + ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.