system/xwaylandvideobridge/README.md

0001 <!--
0002 SPDX-License-Identifier: BSD-3-Clause
0003 SPDX-FileCopyrightText: 2023 David Edmundson <kde@davidedmundson.co.uk>
0004 SPDX-FileCopyrightText: 2023 Aleix Pol <aleixpol@kde.org>
0005 -->
0006
0007 # XWayland Video Bridge
0008
0009 # About
0010
0011 By design, X11 applications can't access window or screen contents for wayland clients. This is fine in principle, but it breaks screen sharing in tools like Discord, MS Teams, Skype, etc and more.
0012
0013 This tool allows us to share specific windows to X11 clients, but within the control of the user at all times.
0014
0015 # How to use
0016
0017 xwaylandvideobridge should autostart on login. It will run in the background. Next time you try to share a window a prompt will appear.
0018 The previously selected window should now be available for sharing. The title will always be "Wayland to X11 bridge" no matter what window is selected.
0019
0020 The system tray icon provides finer control.
0021
0022 # Use outside Plasma
0023
0024 This should work on any desktop that supports the Xdg desktop portals and pipewire streaming and have a working system tray.
0025
0026 # Future
0027
0028 Ideally this should be more automatic, but this tool aims purely to serve as a stop-gap whilst we wait for these clients to get native wayland support and for the surrounding wayland protocols to be better. How much more it gets developed depends on feedback and how the surrounding ecosystem evolves.
0029
0030 # Release Process
0031
0032 - Check it works
0033 - appstream-metainfo-release-update --version 0.3.0 -d today ./src/org.kde.xwaylandvideobridge.appdata.xml
0034 - Update set(PROJECT_VERSION "0.3.0") in CMakeLists.txt
0035 - In Releaseme  mkdir xwaylandvideobridge; cd xwaylandvideobridge; ../tarme.rb --origin trunk --version 0.3.0 xwaylandvideobridge
0036 - scp xwaylandvideobridge ftpadmin@tinami.kde.org:  and move to right place
0037 - Write a blog post and put on kde-announce