kdeconnect-kde/plugins
2015-02-21 04:46:14 +00:00
..
battery SVN_SILENT made messages (.desktop file) 2014-12-26 04:20:08 +00:00
clipboard SVN_SILENT made messages (.desktop file) 2014-12-26 04:20:08 +00:00
mousepad SVN_SILENT made messages (.desktop file) 2015-02-21 04:46:14 +00:00
mpriscontrol SVN_SILENT made messages (.desktop file) 2014-12-26 04:20:08 +00:00
notifications Added "silent" param that makes new notifications not popup 2015-01-20 22:56:47 -08:00
pausemusic SVN_SILENT made messages (.desktop file) 2015-02-21 04:46:14 +00:00
ping SVN_SILENT made messages (.desktop file) 2015-01-03 03:53:09 +00:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) 2015-02-01 04:01:24 +00:00
sftp SVN_SILENT made messages (.desktop file) 2015-02-21 04:46:14 +00:00
share SVN_SILENT made messages (.desktop file) 2015-02-21 04:46:14 +00:00
telephony Added a button to incoming call notifications to mute the phone ringing. 2015-01-05 21:58:23 -08:00
CMakeLists.txt Added a plugin to inhibit the screensaver when a device is connected. 2014-12-29 23:31:25 -08:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) 2015-02-01 04:01:24 +00:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) 2014-12-26 04:20:08 +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.