xdg-desktop-portal-hyprland/README.md

53 lines
1.4 KiB
Markdown
Raw Normal View History

2022-12-03 21:47:58 +01:00
# xdg-desktop-portal-hyprland
2018-12-12 22:29:57 +01:00
2022-12-03 21:47:58 +01:00
[xdg-desktop-portal] backend for hyprland
2020-03-10 13:40:27 +01:00
2022-12-03 21:47:58 +01:00
## What and why?
Due to reasons explained in [hyprland-protocols](https://github.com/hyprwm/hyprland-protocols),
we have a separate desktop portal impl for Hyprland.
Although `-wlr` **does** work with Hyprland, `-hyprland` offers more features.
2018-12-12 22:29:57 +01:00
2022-12-05 01:43:40 +01:00
## Additional dependencies
XDPH depends on `qt6` and `qt6-wayland` for the sharing selector. Lack of either will
cause screensharing to not work at all.
2018-12-12 22:29:57 +01:00
## Building
```sh
2022-12-05 01:08:17 +01:00
meson build --prefix=/usr
ninja -C build
2022-12-03 22:27:49 +01:00
cd hyprland-share-picker && make all && cd ..
```
2018-12-12 22:29:57 +01:00
## Installing
### From Source
```sh
ninja -C build install
2022-12-03 22:27:49 +01:00
sudo cp ./hyprland-share-picker/build/hyprland-share-picker /usr/bin
```
2022-12-05 02:04:20 +01:00
### AUR
```sh
yay -S xdg-desktop-portal-hyprland-git
```
2022-12-05 01:57:46 +01:00
## Usage
Although should start automatically, consult [the Hyprland wiki](https://wiki.hyprland.org/Useful-Utilities/Hyprland-desktop-portal/)
in case of issues.
2022-12-10 21:31:30 +01:00
## For other wlroots-based compositors
If you are a developer and wish to support features that XDPH provides, make sure to support those protocols:
- `wlr_foreign_toplevel_management_unstable_v1`
- `hyprland_toplevel_export_v1` - XDPH uses Rev2 exclusively (`_with_toplevel_handle`)
2018-12-12 22:29:57 +01:00
## License
MIT
2019-12-09 12:45:30 +01:00
[xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
[screencast compatibility]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/Screencast-Compatibility