kdeconnect-kde/plugins
Alexander Lohnau e97af9dc15 Provide default implementation for KdeConnectPlugin::connected
In most plugins, we just provided a dummy implementation
2023-07-22 16:06:21 +02:00
..
battery Allow building against Qt6/KF6 2023-07-20 11:15:41 +03:00
bigscreen Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
clipboard Qt6 build fixes in plugins and KCM 2023-07-20 11:15:46 +03:00
connectivity-report Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2023-03-27 01:57:05 +00:00
findmyphone Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
findthisdevice Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
lockdevice Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
mmtelephony Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
mousepad Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
mpriscontrol Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
mprisremote Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
notifications Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
pausemusic Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
photo Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
ping Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
presenter Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
remotecommands Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
remotecontrol Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
remotekeyboard Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
remotesystemvolume Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
runcommand Remove unneeded destructors from plugins 2023-07-22 16:01:21 +02:00
screensaver-inhibit Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
sendnotifications Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
sftp Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
share Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
sms Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
systemvolume Allow building against Qt6/KF6 2023-07-20 11:15:41 +03:00
telephony Provide default implementation for KdeConnectPlugin::connected 2023-07-22 16:06:21 +02:00
virtualmonitor Adjust includes/linking for QX11Extras 2023-07-20 11:15:46 +03:00
CMakeLists.txt Allow building against Qt6/KF6 2023-07-20 11:15:41 +03:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2023-06-01 01:40:26 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Fix file name on plugin's readme. 2022-11-27 01:40:51 +00:00

Writing a plugin for KDE Connect
=================================

For the desktop client (this project):
--------------------------------------

1. Enter the "plugins" directory.
2. Copy the "ping" under a different name ("findmyphone" in this example).
3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
4. Enter the new "findmyphone" directory.
5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
6. Rename other files in this directory by replacing "ping" with "findmyphone"
7. Write a description of your plugin into "README"
8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
  A. Change license header.
  B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
9. Edit kdeconnect_findmyphone.json file:
  A. Replace "ping" with "findmyphone".
  B. Change name, description, icon, author, email, version, website, license info.
  C. Remove all the translations
  D. Set X-KDEConnect-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet type your plugin will receive
     and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
     the findmyphoneplugin.h file (in the line "#define PACKET_TYPE_..."), and also in Android.
10. Now you have an empty skeleton to implement your new plugin logic.

For Android (project kdeconnect-android):
-----------------------------------------

1. Change directory to src/org/kde/kdeconnect/Plugins.
2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
3. Enter the new "FindMyPhonePlugin" directory.
4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
   and "plugin_ping" with "plugin_findmyphone".
6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
   with "findmyphone" and edit the plugin name and description between <string> </string>).
7. Now you have an empty skeleton to implement your new plugin logic.