- Screen sharing on Hyprland (Arch Linux)
- Introduction
- Install PipeWire and friends
- Install xdg-desktop-portal and friends
- Remove other portal implementations
- Edit the configuration file
- Restart your session
- Troubleshooting PipeWire
- Troubleshooting desktop portal
- Troubleshooting OBS
- Troubleshooting your browser
- Troubleshooting your app
- It still doesn't work!
- References
This guide will go through the setup and troubleshooting steps required to get screen sharing working on OBS with the Hyprland compositor.
This guide will use the yay AUR helper for AUR package installation, but the commands should be similar for other helpers such as paru.
WARNING: This guide demands that the user has a basic understanding on installing packages (both official and AUR), using git, compiling from source, and some patience.
First, we need to install pipewire and wireplumber. To do that, run the following command:
sudo pacman -S pipewire wireplumber
We will install the xdg-desktop-portal-hyprland-git package from the AUR, which provides additional functionality such as window sharing. With an AUR helper such as yay, you can install it this way:
yay -S xdg-desktop-portal-hyprland-git
This option provides less options than xdg-desktop-portal-wlr, but it will still allow fullscreen sharing. Install it running the following command:
sudo pacman -S xdg-desktop-portal-wlr
WARNING: The rest of this guide will assume xdg-desktop-portal-hyprland was choosed. If you picked this option, replace any -hyprland mentions for -wlr in the rest of this guide.
Make sure you don't have any other xdg-desktop-portal-* packages installed (except possibly xdg-desktop-portal-gtk for file dialogs), as this could cause problems later. To check if you have any, run the following command:
pacman -Q | grep xdg-desktop-portal-
then delete all of the listed packages except the -hyprland one we just installed and the -gtk one if you so chose.
Also make sure to install the optional dependencies grim and slurp:
sudo pacman -S grim slurp
Open your Hyprland config file (usually located at ~/.config/hypr/hyprland.conf) with a text editor, and add the following line at the end:
exec-once=dbus-update-activation-environment --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP
This will make sure that xdg-desktop-portal-hyprland can get the required variables on startup.
Now log out and then log back in, or reboot your system. Once you're back into Hyprland, try sharing in OBS with the "Screen Capture (PipeWire)" option.
If it works, congratulations! You may exit this guide now. If not, follow along:
Make sure both pipewire and wireplumber are running. Run the following command:
systemctl --user status pipewire wireplumber
This should return "active (running)" for both. If it doesn't, follow the Arch Wiki article for troubleshooting.
Run the following command to check for errors in xdg-desktop-portal-hyprland:
systemctl --user status xdg-desktop-portal-hyprland
This should return "active (running)". If it doesn't, check the errors it gives you. Here's some workarounds for common errors:
Make sure you added the required line to the Hyprland configuration. Check for typos.
Install the modified hyprland-nvidia-git AUR package:
yay -S hyprland-nvidia-git
Alternatively, you can modify the source code manually:
We'll need to modify the wlroots submodule source code to make it choose a viable format.
First, clone the Hyprland repo if you haven't already:
git clone --recursive https://github.com/vaxerski/Hyprland
Then, install all required dependencies for building, as specified in the wiki:
sudo pacman -S gdb ninja gcc cmake libxcb xcb-proto xcb-util xcb-util-keysyms libxfixes libx11 libxcomposite xorg-xinput libxrender pixman wayland-protocols cairo pango --needed
Open the wlroots/types/output/render.c file, look for the wlr_output_preferred_read_format, and replace it with the following:
uint32_t wlr_output_preferred_read_format(struct wlr_output *output) {
return DRM_FORMAT_XRGB8888;
}
Afterwards, compile and install by running sudo make install, then restart your session.
You can try the wlrobs-hg plugin.
If you're trying to share your screen in your browser, first make sure that it supports Wayland and screen sharing on it, else it will not work.
Make sure you're running on Wayland. To do this, go to about:support, look for "Window Protocol", and make sure it is set to "wayland".
If it isn't, set the environment variable MOZ_ENABLE_WAYLAND=1 in an environment file, like /etc/environment, /etc/profile, ~/.bash_profile, ~/.zshenv, etc.
If it still doesn't work, open about:config and make sure the media.peerconnection.enabled flag is set to true.
To run on Wayland, set the --ozone-platform-hint=auto flag in the chromium flags file (~/.config/chromium-flags.conf for the default package, ~/.config/chrome-flags.conf for Chrome).
Also ensure the "WebRTC PipeWire support" flag is enabled by opening chrome://flags/#enable-webrtc-pipewire-capturer and enabling it.
Make sure the app you're trying to share the screen with supports Wayland and sharing the screen with it.
Notable programs that still don't have full support for this are Discord and Zoom.
Follow the official xdg-desktop-portal-wlr troubleshooting guide.
If it still doesn't work, consider opening an issue in the xdg-desktop-portal-hyprland repo.
I forked this gist to correct the mention of
xdg-desktop-portal-wlrtoxdg-desktop-portal-hyprlandunder the section with same name (guessing that you wanted to refer to the later).