tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Albert Vaca 6124e5273f Merge branch 'master' (early part) into 1.x 
# Conflicts:
#	plugins/kdeconnect.notifyrc
#	plugins/remotecommands/kdeconnect_remotecommands.json
#	plugins/sendnotifications/kdeconnect_sendnotifications_config.desktop
#	plugins/telephony/kdeconnect_telephony.json
2016-11-23 17:29:26 +01:00
..
battery Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +00:00
findmyphone Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +00:00
mousepad SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +00:00
mpriscontrol Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +00:00
notifications Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
pausemusic Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-28 11:59:13 +00:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2016-11-05 09:58:11 +00:00
remotecontrol Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
runcommand Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
screensaver-inhibit Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
sendnotifications Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
sftp Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
share SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +00:00
telephony Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
CMakeLists.txt Moved telepathy component to its own repo: telepathy-kdeconnect 2016-06-26 15:48:37 +02:00
kdeconnect.notifyrc Merge branch 'master' (early part) into 1.x 2016-11-23 17:29:26 +01:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2016-10-19 09:02:51 +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.