Skip to content

docs: add Wayland troubleshooting section to README #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DavidMiserak wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Wayland troubleshooting section to README #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:** <https://foundry.ruleplaying.com/flc>
- **Issues**: <https://github.com/phenomen/flc/issues>
- **Changelog**: [CHANGELOG.md](CHANGELOG.md)

## Features
Expand Down Expand Up @@ -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.
Expand Down