kdeconnect-kde/plugins
2019-03-22 22:43:28 +01:00
..
battery [plugins/battery] Don't link against QtGui 2019-03-11 18:58:11 +01:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-06 05:29:27 +01:00
contacts [plugins/contacts] Don't link against KI18n 2019-03-11 19:03:10 +01:00
findmyphone [plugins/findmyphone] Don't link against core twice 2019-03-11 19:05:42 +01:00
findthisdevice Port remaining plugins 2019-03-22 22:43:28 +01:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
mousepad wayland: support removing the fake input interface 2019-01-31 16:38:21 +01:00
mpriscontrol [mpriscontrol] add primitive windows support 2018-12-21 19:24:06 +01:00
mprisremote [plugins/mprisremote] Don't link against KI18n 2019-03-11 19:09:00 +01:00
notifications Remove unused return type 2019-03-21 20:53:11 +01:00
pausemusic Port remaining plugins 2019-03-22 22:43:28 +01:00
photo SVN_SILENT made messages (.desktop file) - always resolve ours 2019-03-13 05:58:25 +01:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-06 05:29:27 +01:00
remotecommands [plugins/remotecommands] Remove stray includes 2019-03-11 19:14:48 +01:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
remotekeyboard [plugins/remotekeyboard] Don't link against KI18n 2019-03-13 13:36:09 +01:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
runcommand Port remaining plugins 2019-03-22 22:43:28 +01:00
screensaver-inhibit [plugins/screensaverinhibit] Don't link against KNotifications 2019-03-13 13:36:09 +01:00
sendnotifications Port remaining plugins 2019-03-22 22:43:28 +01:00
sftp [sftp] Also report desktop side errors via KIO 2019-03-09 14:24:29 +00:00
share Port remaining plugins 2019-03-22 22:43:28 +01:00
sms Fixed warnings 2019-03-07 19:48:06 +01:00
systemvolume Add license header 2019-02-03 01:50:36 +01:00
telephony Remove mention to SMS from telephony plugin description 2019-03-22 08:52:16 +01:00
CMakeLists.txt Add plugin for taking photos on remote device 2019-03-04 23:57:08 +01:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-02-26 05:29:15 +01:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2018-10-10 06:19:16 +02:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Fix typos 2018-07-27 15:00:23 +02: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".
1. 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.desktop 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 findmyplugin.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).
1. 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. Open src/org/kde/kdeconnect/Plugins/PluginFactory.java.
  A. Copy "import … PingPlugin" line with replacing "PingPlugin" with "FindMyPhonePlugin".
  B. Copy "PluginFactory.registerPlugin(PingPlugin.class);" line with replacing "PingPlugin" with "FindMyPhonePlugin".
8. Open src/org/kde/kdeconnect/NetworkPacket.java. Copy a "public final static String PACKET_TYPE_PING = …" line
   replacing "PING" with the packet type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.