Multi-platform app that allows your devices to communicate
Find a file
Piyush Aggarwal f33fed6fa1 windows: fix support for WIN_SDK < 19041
inspired by : https://gitlab.kitware.com/cmake/cmake/-/blob/v3.17.3/Modules/InstallRequiredSystemLibraries.cmake#L339-358
Since CMake doesn't really has a way of providing the Win10 SDK's version ( see: https://gitlab.kitware.com/cmake/cmake/-/issues/20773 )
we read the XML file set up by the SDK and filter the SDK version out of it
2021-06-16 17:29:45 +05:30
.gitlab Update Issue.md 2019-09-19 07:48:59 +00:00
app include ecmaddappicon to fix win32 build 2021-06-15 01:37:02 +05:30
cli Added missing endline 2021-02-05 18:09:56 +00:00
cmake Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
core Fix warnings 2021-03-03 15:20:24 +01:00
daemon kdeconnectd: trigger indicator when daemon is spawned on Windows 2021-06-15 13:35:00 +05:30
data GIT_SILENT Update Appstream for new release 2021-06-05 23:24:55 +02:00
declarativeplugin Add support for generating qmltypes file 2021-05-09 19:34:22 +02:00
doc Reverted docs version as we didn't change them. 2016-07-22 13:13:30 +02:00
fileitemactionplugin SVN_SILENT made messages (.desktop file) - always resolve ours 2021-06-14 01:14:54 +00:00
icons Set program logo in KAboutData and trigger KIconLoader plugin in the process 2021-06-08 02:34:26 +05:30
indicator indicator: move KDBusService::Unique call to make sure it works on Windows 2021-06-15 13:48:39 +05:30
interfaces [interfaces] Make KConfig linkage public 2021-04-05 23:02:23 +02:00
kcm add KColorSchemeManager instance to install auto dark theme on Windows 2021-06-13 13:51:28 +05:30
kcmplugin Remove defunct calls to KAboutData::pluginData 2020-10-31 19:58:05 +00:00
kio CMake cleanup 2020-11-16 12:21:07 +00:00
LICENSES Add missing license file 2021-06-02 22:29:57 +02:00
nautilus-extension Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
plasmoid SVN_SILENT made messages (.desktop file) - always resolve ours 2021-04-22 01:12:28 +00:00
plugins add compilation check for WIN_SDK_VERSION 2021-06-15 18:06:03 +05:30
runners SVN_SILENT made messages (.desktop file) - always resolve ours 2021-04-22 01:12:28 +00:00
settings icons: add qrc for device status icons 2021-06-02 00:02:35 +00:00
smsapp Push a new layer when entering About Page in the SMS App 2021-06-16 11:08:34 +00:00
tests CMake cleanup 2020-11-16 12:21:07 +00:00
urlhandler add KColorSchemeManager instance to install auto dark theme on Windows 2021-06-13 13:51:28 +05:30
.editorconfig add trim_trailing_whitespace to editorconf 2019-06-11 01:08:31 +02:00
.gitignore Remove accidental DS_Store file 2020-11-16 01:27:44 +01:00
.gitlab-ci.yml Remove gitlab windows CI 2020-05-09 19:20:50 +02:00
CMakeLists.txt windows: fix support for WIN_SDK < 19041 2021-06-16 17:29:45 +05:30
CONTRIBUTING.md Fixed the link pointing to the GitLab repository in the CONTRIBUTING.md file to the moved repository 2021-03-31 09:44:26 +02:00
KDEConnectMacros.cmake [app] Add plugin settings page 2020-09-08 20:33:20 +02:00
README.md README: capitalize "Telegram" 2021-05-24 01:08:45 -03:00

KDE Connect - desktop app

KDE Connect is a multi-platform app that allows your devices to communicate (eg: your phone and your computer).

(Some) Features

  • Shared clipboard: copy and paste between your phone and your computer (or any other device).
  • Notification sync: Read and reply to your Android notifications from the desktop.
  • Share files and URLs instantly from one device to another including some filesystem integration.
  • Multimedia remote control: Use your phone as a remote for Linux media players.
  • Virtual touchpad: Use your phone screen as your computer's touchpad and keyboard.
  • Presentation remote: Advance your presentation slides straight from your phone.

All this is done completely wirelessly, utilising TLS encryption.

Supported platforms

  • Computers running Linux with Plasma 5, Gnome 3, Elementary OS... any distro with Qt5 support given a little work :)
  • Android, by installing the KDE Connect app from the Play Store or F-Droid.

How to install

These instructions explain how to install KDE Connect on your computer. You will also need to install it on your Android device and pair them together in the app before using this application. The Android app repository can be found here

On Linux

Look in your distribution repo for a package called kdeconnect-kde, kdeconnect-plasma, or just kdeconnect. If it's not there and you know how to build software from sources, you just found the repo :), instructions are here

On Mac or Windows

Platforms other than Linux are not officially supported, as there has yet to be an official release of KDE Connect for MacOS or Windows. However, most of the features have already been ported to windows so you can compile KDE Connect for Windows using Craft. It hasn't yet been completely tested on MacOS, contributions and feedback are welcome!

On BSD

It should work, but no promises :)

How does it work?

KDE Connect consists of a UI-agnostic "core" library that exposes a series of DBus interfaces, and several UI components that consume these DBus interfaces. This way, new UI components can be added to integrate better with specific platforms or desktops, without having to reimplement the protocol or any of the internals. The core KDE Connect library is also divided into 4 big blocks:

  • LinkProviders: Are in charge of discovering other KDE Connect-enabled devices in the network and establishing a Link to them.
  • Devices: Represent a remote device, abstracting the specific Link that is being used to reach it.
  • NetworkPackets: JSON-serializable and self-contained pieces of information to be sent by the plugins between devices.
  • Plugins: Independent pieces of code that implement a specific feature. Plugins will use NetworkPackets to exchange information through the network with other Plugins on a remote Device.

The basic structure of a NetworkPacket is the following:

{
  "id": 123456789,
  "type": "com.example.myplugin",
  "body": {  },
  "version": 5
}

The content of the "body" section is defined by each Plugin. Hence, only the emitter and receiver plugins of a given packet type need agree on the contents of the body.

NetworkPackets can also have binary data attached that can't be serialized to JSON. In this case, two new fields will be added:

"payloadSize": The size of the file, or -1 if it is a stream without known size. "payloadTransferInfo": Another JSON object where the specific Link can add information so the Link in the remote end can establish a connection and receive the payload (eg: IP and port in a local network). It's up to the Link implementation to decide how to use this field.

Contributing

To contribute patches, use KDE Connect's GitLab. There you can also find a task list with stuff to do and links to other relevant resources. It is a good idea to also subscribe to the KDE Connect mailing list. We can also be reached on IRC at #kdeconnect on freenode or on Telegram, contributions and feedback are warmly welcomed.

For bug reporting, please use KDE's Bugzilla. Please do not use the issue tracker in GitLab since we want to keep everything in one place.

Please know that all translations for all KDE apps are handled by the localization team. If you would like to submit a translation, that should be done by working with the proper team for that language.

License

GNU GPL v2 and GNU GPL v3

If you are reading this from Github, you should know that this is just a mirror of the KDE Project repo.