tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Friedrich W. H. Kossebau cfe83bb69d Revert accidental hard dependency on KF5Wayland
2018-03-22 17:34:15 +01:00
..
battery Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
clipboard Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
findmyphone Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
lockdevice Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
mousepad Revert accidental hard dependency on KF5Wayland 2018-03-22 17:34:15 +01:00
mousepad_windows Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
mpriscontrol MPRIS control: fix instance indicator with multiple app instances 2018-03-17 23:37:26 +01:00
mprisremote Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
notifications Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
pausemusic Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
ping Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
remotecommands Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
remotecontrol Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
remotekeyboard Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
runcommand Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
screensaver-inhibit Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
sendnotifications Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
sftp Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
share Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
telephony Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
CMakeLists.txt Remote command host can only be used from the qml app 2017-08-02 02:05:01 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2018-01-29 05:02:00 +01:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2017-09-19 04:58:52 +02:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Rename NetworkPackage -> NetworkPacket 2018-03-05 20:03:23 +01: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-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.