kdeconnect-kde

History

Albert Vaca 0dbaceafa3 Merge branch 'master' into 1.x # Conflicts: # plugins/battery/kdeconnect_battery.json # plugins/clipboard/kdeconnect_clipboard.json # plugins/findmyphone/kdeconnect_findmyphone.json # plugins/kdeconnect.notifyrc # plugins/lockdevice/kdeconnect_lockdevice.json # plugins/mousepad/kdeconnect_mousepad.json # plugins/mpriscontrol/kdeconnect_mpriscontrol.json # plugins/mprisremote/kdeconnect_mprisremote.json # plugins/notifications/kdeconnect_notifications.json # plugins/pausemusic/kdeconnect_pausemusic.json # plugins/ping/kdeconnect_ping.json # plugins/remotecommands/kdeconnect_remotecommands.json # plugins/remotecontrol/kdeconnect_remotecontrol.json # plugins/runcommand/kdeconnect_runcommand.json # plugins/screensaver-inhibit/kdeconnect_screensaver_inhibit.json # plugins/sendnotifications/kdeconnect_sendnotifications.json # plugins/sendnotifications/kdeconnect_sendnotifications_config.desktop # plugins/sftp/kdeconnect_sftp.json # plugins/share/kdeconnect_share.json # plugins/telephony/kdeconnect_telephony.json		2016-09-29 10:53:29 +02:00
..
battery	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
clipboard	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
findmyphone	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
lockdevice	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
mousepad	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
mpriscontrol	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
mprisremote	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
notifications	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
pausemusic	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
ping	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
remotecommands	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
remotecontrol	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
runcommand	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
screensaver-inhibit	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
sendnotifications	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
sftp	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
share	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
telepathy	Moved telepathy component to its own repo: telepathy-kdeconnect	2016-06-26 15:48:37 +02:00
telephony	Merge branch 'master' into 1.x	2016-09-29 10:53:29 +02:00
CMakeLists.txt	Moved telepathy component to its own repo: telepathy-kdeconnect	2016-06-26 15:48:37 +02:00
kdeconnect.notifyrc	SVN_SILENT made messages (.desktop file) - always resolve ours	2016-09-28 11:51:45 +00:00
kdeconnect_plugin.desktop	SVN_SILENT made messages (.desktop file) - always resolve ours	2016-08-30 10:03:14 +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

README.txt

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.