kdeconnect-kde/plugins
2019-02-17 02:41:42 +01:00
..
battery SVN_SILENT made messages (.desktop file) - always resolve ours 2019-02-15 05:34:24 +01:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-06 05:29:27 +01:00
contacts Clean up includes 2019-02-03 01:44:22 +01:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
findthisdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +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 Clean up includes 2019-02-03 01:44:22 +01:00
notifications Add actions to notifications 2019-02-08 23:54:04 +01:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-06 05:29:27 +01:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
runcommand SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-09 05:31:18 +01:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
sendnotifications Clean up includes 2019-02-03 01:44:22 +01:00
sftp Handle errorMessage in kdeconnect.sftp packet 2019-01-22 18:42:00 +01:00
share Respect users prefered text editor for shared text 2019-02-09 00:00:01 +01:00
sms SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-31 05:44:46 +01:00
systemvolume Add license header 2019-02-03 01:50:36 +01:00
telephony Emit DBus signal when receiving a call 2019-02-17 02:41:42 +01:00
CMakeLists.txt [mpriscontrol] add primitive windows support 2018-12-21 19:24:06 +01:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-01-06 05:29:27 +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.