Note that filepicking was mainly tested with lf file manager. I can't attest that others work properly!
xdg-desktop-portal backend for wlroots. A slightly modified version that integrates the wlroots functionality of screen recording and GermainZ's xdg-desktop-portal-termfilechooser with some patches of Boydaihungst's fork, so credits go mainly to them. My contributions include merging two codebases and adding better handling for lf file manager. I would like it one day to be merged into mainline as from my testing everything seems to work fine but I'm afraid if it were to be deployed at a large scale.
mkdir ~/.config/xdg-desktop-portal-wlr
and create a file name config there. The contents of that file can be taken from config.sample inside contrib folder.
There you can adjust what filepicker script to execute (along with regular xdg-desktop-portal-wlr config options related to screenrecording). Choose the script corresponding to your file picker of choice and place it in corresponding location (must use absolute full path). (lf wrapper has extra configuration that needs to be done see lf section. After that continue with the running guide.
For example with firefox, it's not enabled by default. To have it working you need to either run firefox with GTK_USE_PORTAL=1 firefox or for permanent configuration, change the widget.use-xdg-desktop-portal.file-picker to 1 in about:config settings page. Chromium-based browsers should use portals out of the box.
The lf file manager is being taliored to file picking by the lf config files present in contrib/lf/xdg-filepicker. You need to copy it to the folder where lfrc is (~/.config/xdg-desktop-portal-wlr/lf) and copy over lf-wrapper.sh that is also present there to ~/.config/xdg-desktop-portal-wlr. The main xdg-desktop-portal-wlr should be then pointing to that script (it does by default if using the config present in the contrib folder).
meson build
ninja -C buildThe fork also includes a PKGBUILD file for arch users, so you can just run makepkg inside the folder.
ninja -C build installMake sure XDG_CURRENT_DESKTOP is set. Make sure WAYLAND_DISPLAY and
XDG_CURRENT_DESKTOP are imported into D-Bus. If you're running Sway, this
can be added to your config file:
exec dbus-update-activation-environment --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP=sway
When correctly installed, xdg-desktop-portal should automatically invoke xdg-desktop-portal-wlr when needed.
Recent changes to xdg-desktop-portal is requiring desktop environments to set up a *-portals.conf configuration that specify which portals should be used for a given XDG_CURRENT_DESKTOP value. If this file does not exists in /usr/share/xdg-desktop-portal/, you should create it under ~/.config/xdg-desktop-portal/ with content like this:
[preferred]
default=gtk
org.freedesktop.impl.portal.Screenshot=wlr
org.freedesktop.impl.portal.ScreenCast=wlr(you can specify the default portal to use for any implementation not explicitly defined, and you can add any portal you need for other specific interfaces like gnome-keyring for the Secret portal).
See man 5 xdg-desktop-portal-wlr.
At the moment, some command line flags are available for development and testing. If you need to use one of these flags, you can start an instance of xdpw using the following command:
xdg-desktop-portal-wlr -r [OPTION...]To list the available options, you can run xdg-desktop-portal-wlr --help.
Check out or FAQ for answers to commonly asked questions.
Please see the screencast compatibility guide for more information on compatible applications and how to get them working.
If you have a question or problem that is not mentioned in those documents, please open an issue or come chat with us in #sway on Libera Chat.
If you're interested in testing or development, check out CONTRIBUTING.md for more information.
MIT