kdeconnect-kde/plugins
2019-06-10 14:40:28 +00:00
..
battery Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
clipboard Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
contacts Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
findmyphone Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
findthisdevice Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
lockdevice Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
mousepad SVN_SILENT made messages (.desktop file) - always resolve ours 2019-05-26 05:12:50 +02:00
mpriscontrol Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
mprisremote Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
notifications Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
pausemusic Add wrapper for macos dbus connection 2019-06-09 15:28:49 +00:00
photo Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
ping Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
remotecommands Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
remotecontrol Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
remotekeyboard Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
remotesystemvolume Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
runcommand Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
screensaver-inhibit Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
sendnotifications Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
sftp Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
share Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
sms Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
systemvolume Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
telephony Force usage of QStringLiteral and port remaining offenders 2019-06-10 14:40:28 +00:00
CMakeLists.txt Fix macos build 2019-05-19 09:41:56 +00:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-05-08 05:42:59 +02:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2019-05-08 05:42:59 +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.