Skip to content

Commit

Permalink
docs: troubleshooting details
Browse files Browse the repository at this point in the history
  • Loading branch information
galister authored Oct 25, 2024
1 parent 0b1a7e8 commit 7cb8e4a
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ We would like to work with you and include additional bindings.

## Troubleshooting

When an error is detected, we often print tips for fixing into the log file.

Logs will be at `/tmp/wlx.log` for most distros.

Check [here](https://github.com/galister/wlx-overlay-s/wiki/Troubleshooting) for tips.

## Known Issues
Expand All @@ -125,8 +129,22 @@ Hyprland users: Hyprland v0.41.0 changed their absolute input implementation to

Niri users: use on Niri 0.1.7 or later.

X11 users might be dealing with a [Phantom Monitor](https://wiki.archlinux.org/title/Xrandr#Disabling_phantom_monitor).

Other desktops: The screens may have been selected in the wrong order, see [First Start](#first-start).

### Crashes, blank screens

There are some driver-desktop combinations that don't play nice with DMA-buf capture.

Disabling DMA-buf capture is a good first step to try when encountering an app crash or gpu driver reset.

```bash
echo 'capture_method: pw_fallback' > ~/.config/wlxoverlay/conf.d/pw_fallback.yaml
```

Without DMA-buf capture, capturing screens takes CPU power, so let's try and not show too many screens at the same time.

### Space-drag crashes SteamVR

This has been idenfitied as an issue with SteamVR versions 2.5.5 and above (latest tested 2.7.2). One way to avoid the crash is by switching to the `temp-v1.27.5` branch of SteamVR (via beta selection) and selecting [Steam-Play-None](https://github.com/Scrumplex/Steam-Play-None) under the compatibility tab.
Expand Down

0 comments on commit 7cb8e4a

Please sign in to comment.