Skip to content

Commit

Permalink
update readm
Browse files Browse the repository at this point in the history
  • Loading branch information
vaxerski committed Aug 27, 2023
1 parent b1895a2 commit c9ab195
Showing 1 changed file with 4 additions and 49 deletions.
53 changes: 4 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,7 @@
# xdg-desktop-portal-hyprland
# v2 rewrite

[xdg-desktop-portal] backend for hyprland
shit is being worked on.

## 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.
going C++

Although `-wlr` **does** work with Hyprland, `-hyprland` offers more features.

## Additional dependencies
XDPH depends on `qt6` and `qt6-wayland` for the sharing selector. Lack of either will
cause screensharing to not work at all.

## Building

```sh
meson build --prefix=/usr
ninja -C build
cd hyprland-share-picker && make all && cd ..
```

## Installing

### From Source

```sh
ninja -C build install
sudo cp ./hyprland-share-picker/build/hyprland-share-picker /usr/bin
```

### AUR
```sh
yay -S xdg-desktop-portal-hyprland-git
```

## Usage

Although should start automatically, consult [the Hyprland wiki](https://wiki.hyprland.org/Useful-Utilities/Hyprland-desktop-portal/)
in case of issues.

## 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`)


## License
MIT

[xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
[screencast compatibility]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/Screencast-Compatibility
idk I will write this some day

0 comments on commit c9ab195

Please sign in to comment.