kdeconnect-kde/plugins
Nicolas Fella f7f3c01ec8 Use undeprecated install dirs
Using kde-dev-scripts/kf5/cmakelists_install_vars.pl
2022-04-21 00:50:14 +02:00
..
battery SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-24 01:36:30 +00:00
bigscreen SVN_SILENT made messages (.desktop file) - always resolve ours 2022-02-20 01:45:04 +00:00
clipboard Fix macOS build due to the inappropriate QTimer pointer 2022-02-26 19:10:52 +00:00
connectivity-report SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-18 01:49:08 +00:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-29 02:08:15 +00:00
findthisdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-24 01:36:30 +00:00
mousepad SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-04 01:16:42 +00:00
mpriscontrol Improve D-Bus implementation on macOS 2022-04-12 05:40:03 +00:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
notifications Improve D-Bus implementation on macOS 2022-04-12 05:40:03 +00:00
pausemusic Improve D-Bus implementation on macOS 2022-04-12 05:40:03 +00:00
photo SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-04 01:16:42 +00:00
presenter SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-24 01:36:30 +00:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-24 01:36:30 +00:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2022-03-31 01:41:19 +00:00
runcommand kcm: Fix showing plugins' configuration 2022-03-21 18:03:45 +01:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-04 01:16:42 +00:00
sendnotifications Improve D-Bus implementation on macOS 2022-04-12 05:40:03 +00:00
sftp SVN_SILENT made messages (.desktop file) - always resolve ours 2021-11-04 01:16:42 +00:00
share kcm: Fix showing plugins' configuration 2022-03-21 18:03:45 +01:00
sms SVN_SILENT made messages (.desktop file) - always resolve ours 2022-02-20 01:45:04 +00:00
systemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2022-02-20 01:45:04 +00:00
telephony SVN_SILENT made messages (.desktop file) - always resolve ours 2022-02-20 01:45:04 +00:00
CMakeLists.txt Use undeprecated install dirs 2022-04-21 00:50:14 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2022-04-12 01:42:58 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Update README.txt in Plugins to include the current method to build a skeleton for a Plugin 2020-03-27 21:02:16 +05:30

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".
4. 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.json 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).
3. 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. Now you have an empty skeleton to implement your new plugin logic.