kdeconnect-kde/plugins
Alexander Lohnau 319696c445 Remove version and website metadata for plugins
The plugin version doesn't matter, because all plugins are shipped as
part of kdeconnect and not separately.
The website was also set inconsistently, some pointed to a custom blog,
the KDE homepage or a broken link. If we want to make announcements more
visible, we should have a link in a more central place.
2023-07-22 19:12:33 +02:00
..
battery Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
bigscreen Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
clipboard Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
connectivity-report Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
contacts Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
findmyphone Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
findthisdevice Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
lockdevice Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
mmtelephony Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
mousepad Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
mpriscontrol Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
mprisremote Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
notifications Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
pausemusic Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
photo Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
ping Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
presenter Remove obsolete ServiceTypes definitions 2023-07-22 19:12:33 +02:00
remotecommands Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
remotecontrol Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
remotekeyboard Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
remotesystemvolume Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
runcommand Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
screensaver-inhibit Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
sendnotifications Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
sftp Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
share Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
sms Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
systemvolume Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
telephony Remove version and website metadata for plugins 2023-07-22 19:12:33 +02:00
virtualmonitor Remove version and website metadata for plugins 2023-07-22 19:12:33 +02: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.