tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Nicolas Fella 8406e0de99 Merge internal openUrl with internal openFile
2019-06-17 21:35:53 +00:00
..
battery Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
clipboard Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
contacts Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
findmyphone Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
findthisdevice Remove trailing whitespace 2019-06-12 22:17:16 +02:00
lockdevice Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
mousepad Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
mpriscontrol Remove trailing whitespace 2019-06-12 22:17:16 +02:00
mprisremote Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
notifications Don't update new notifications 2019-06-17 21:31:00 +00:00
pausemusic Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
photo Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
ping Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
remotecommands Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
remotecontrol Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
remotekeyboard Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
remotesystemvolume Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
runcommand Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
screensaver-inhibit Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
sendnotifications Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
sftp Remove trailing whitespace 2019-06-12 22:17:16 +02:00
share Merge internal openUrl with internal openFile 2019-06-17 21:35:53 +00:00
sms Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
systemvolume Use K_PLUGIN_CLASS_WITH_JSON 2019-06-12 22:16:54 +02:00
telephony Use default destructor 2019-06-13 15:24:13 +02: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

README.txt 

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.