kdeconnect-kde/plugins
Alexander Lohnau cdc8428542 Create kdeconnect_add_kcm cmake function
This way, the namespace info is not duplicated within the buildsystem and we have a more reasonable place to put the QML file install into
2023-08-07 19:28:37 +02:00
..
battery plugins: Add context-aware logging in case of errors 2023-08-03 20:54:38 +02:00
bigscreen plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
clipboard Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
connectivity-report plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
contacts Simplify and optimize some string usages 2023-08-05 20:22:18 +00:00
findmyphone plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
findthisdevice Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
lockdevice Discard unused params more elegantly 2023-08-05 20:22:18 +00:00
mmtelephony Discard unused params more elegantly 2023-08-05 20:22:18 +00:00
mousepad Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
mpriscontrol Discard unused params more elegantly 2023-08-05 20:22:18 +00:00
mprisremote plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
notifications plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
pausemusic Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
photo plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
ping plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
presenter Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
remotecommands Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
remotecontrol plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
remotekeyboard Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
remotesystemvolume plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
runcommand Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
screensaver-inhibit Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
sendnotifications Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
sftp Use initializer list syntax where appropiate 2023-08-07 19:28:37 +02:00
share Create kdeconnect_add_kcm cmake function 2023-08-07 19:28:37 +02:00
sms Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
systemvolume Simplify KDEConnectPlugin::recievePacket 2023-08-03 20:49:44 +02:00
telephony plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
virtualmonitor plugins: Prefer using statements with baseclass over empty constructor 2023-08-07 19:28:37 +02:00
CMakeLists.txt Actually fix the MacOS build 2023-07-31 23:04:08 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2023-08-01 01:39:50 +00:00
Messages.sh
README.txt Fix file name on plugin's readme. 2022-11-27 01:40:51 +00: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".
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 findmyphoneplugin.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.