tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Albert Vaca 6deef8b605 Comment was no longer true
2016-06-21 14:43:33 +02:00
..
battery Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
clipboard Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
findmyphone Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
lockdevice Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
mousepad Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
mpriscontrol Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
mprisremote Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
notifications Fix issues detected by clazy 2016-06-20 19:22:29 +02:00
pausemusic Comment was no longer true 2016-06-21 14:43:33 +02:00
ping Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
remotecommands Remote Commands plugin 2016-06-12 20:16:58 +02:00
remotecontrol Reflect to changes in the json file 2016-06-06 01:21:37 +02:00
runcommand Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
screensaver-inhibit Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
sendnotifications Fix issues detected by clazy 2016-06-20 19:22:29 +02:00
sftp Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
share Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
telepathy Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
telephony Clean up use of virtual and override keywords 2016-06-20 19:22:29 +02:00
CMakeLists.txt Move TelepathyQt5 dependency into the plugin 2016-06-18 13:33:58 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2016-06-13 10:44:25 +00:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2016-02-14 09:18:22 +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.