kdeconnect-kde/plugins
2016-06-03 00:47:03 +02:00
..
battery Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2016-02-12 09:32:36 +00:00
findmyphone Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
lockdevice Refactor capabilities together with Albert 2016-05-31 17:16:01 +02:00
mousepad Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
mpriscontrol mpriscontrol doesn't send requests 2016-06-01 03:14:34 +02:00
mprisremote Refactor capabilities together with Albert 2016-05-31 17:16:01 +02:00
notifications Refactor capabilities together with Albert 2016-05-31 17:16:01 +02:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2016-02-14 09:18:22 +00:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2015-12-30 09:23:05 +00:00
remotecontrol Refactor capabilities together with Albert 2016-05-31 17:16:01 +02:00
runcommand Runcommand can now execute commands with pipes and other shell constructs 2016-06-01 12:19:39 +02:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2016-02-12 09:32:36 +00:00
sendnotifications Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
sftp Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
share Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
telephony Consistent naming of _REQUEST package type macros 2016-06-03 00:47:03 +02:00
CMakeLists.txt Split plugins for sending and receiving notifications 2016-05-25 12:49:13 -06:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2016-03-04 09:11:29 +00:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2016-02-14 09:18:22 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Added a README about how to create a plugin. 2014-12-21 19:37:41 -08:00

Writting 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-SupportedPackageType and X-KDEConnect-OutgoingPackageType to the package 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 PACKAGE_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/NetworkPackage.java. Copy a "public final static String PACKAGE_TYPE_PING = …" line
   replacing "PING" with the package type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.