kdeconnect-kde/plugins
Alexander Lohnau 69d6c17214 plugins: Use QLatin1String::arg for faster and simpler string concatination
Using an infix with .arg() is simpler than having two string literals
2023-08-28 17:20:46 +00:00
..
battery plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
bigscreen plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
clipboard plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
connectivity-report plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
contacts plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
findmyphone plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
findthisdevice plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
lockdevice plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
mmtelephony kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
mousepad Remove duplicate target_sources 2023-08-08 17:01:21 +02:00
mpriscontrol kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
mprisremote plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
notifications plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
pausemusic kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
photo plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
ping plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
presenter kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
remotecommands plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
remotecontrol plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
remotekeyboard plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
remotesystemvolume plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
runcommand kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
screensaver-inhibit kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
sendnotifications plugins/sendnotifications: add support for Windows 2023-08-21 09:52:23 +08:00
sftp Reformat sshfs arguments so they are easier to read 2023-08-24 18:21:42 +02:00
share plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
sms plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
systemvolume kdeconnect_add_plugin: Autogenerate logging category 2023-08-07 19:47:41 +02:00
telephony plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
virtualmonitor plugins: Use QLatin1String::arg for faster and simpler string concatination 2023-08-28 17:20:46 +00:00
CMakeLists.txt plugins/sendnotifications: add support for Windows 2023-08-21 09:52:23 +08:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2023-08-01 01:39:50 +00:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
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.