kdeconnect-kde/plugins
2023-05-21 10:42:09 +02:00
..
battery Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
bigscreen Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
clipboard Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
connectivity-report Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2023-03-27 01:57:05 +00:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2023-02-04 02:05:14 +00:00
findthisdevice Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
lockdevice Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
mmtelephony Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
mousepad Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2023-04-27 01:43:28 +00:00
mprisremote plugins/mpris*: "xesam:artist" is of stringlist type 2023-03-25 22:13:31 +08:00
notifications Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
pausemusic Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
photo SVN_SILENT made messages (.desktop file) - always resolve ours 2023-01-01 02:14:13 +00:00
ping Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
presenter Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2023-02-04 02:05:14 +00:00
remotecontrol Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2023-02-04 02:05:14 +00:00
remotesystemvolume Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
runcommand Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
screensaver-inhibit Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
sendnotifications Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
sftp Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
share Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
sms Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
systemvolume Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
telephony Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
virtualmonitor SVN_SILENT made messages (.desktop file) - always resolve ours 2023-03-27 01:57:05 +00:00
CMakeLists.txt Allow building against Qt6/KF6 2023-05-21 10:42:09 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2023-04-25 01:47:55 +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.