kdeconnect-kde/plugins
Weixuan Xiao 273c2e937a Just keep CMakeLists as it was
until Wayland supports macOS or Apple brings back X11
2019-07-21 22:49:07 +00:00
..
battery SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
clipboard macOS clipboard plugin 2019-07-18 11:54:41 +00:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
findthisdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2019-07-08 04:56:21 +02:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
mousepad Just keep CMakeLists as it was 2019-07-21 22:49:07 +00:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
mprisremote Adds the missing KDE Connect MPRIS properties on desktop receive-side 2019-07-19 20:08:56 +00:00
notifications Use QDir::setPath 2019-07-20 13:09:35 +02:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2019-07-08 04:56:21 +02:00
photo [plugins/photo] Remove requests from queue when cancel packet is received 2019-07-20 13:42:50 +00:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2019-07-10 05:22:58 +02:00
presenter Receive deltas instead of abs positions from phone 2019-07-21 12:27:23 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
runcommand retain Header Labels when resetting commands list 2019-07-15 15:13:26 +00:00
screensaver-inhibit Add inhibit screensaver plugin for macOS 2019-06-30 20:40:23 +00:00
sendnotifications SVN_SILENT made messages (.desktop file) - always resolve ours 2019-07-08 04:56:21 +02:00
sftp SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-29 05:17:17 +02:00
share Show error if user tries to share a nonexistant file 2019-07-17 21:06:58 +00:00
sms sms: Added opening kdeconnect-sms on the plasmoid and indicator 2019-07-21 18:30:41 +02:00
systemvolume System Volume Plugin for macOS 2019-07-02 12:37:01 +00:00
telephony SVN_SILENT made messages (.desktop file) - always resolve ours 2019-07-12 05:12:34 +02:00
CMakeLists.txt Build presenter plugin by default 2019-07-20 18:28:50 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-27 05:13:07 +02:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2019-06-27 05:13:07 +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

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.