tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Philip Cohn-Cort cfc29fafa6 Improve battery reporting reliability
2020-08-22 15:28:35 +00:00
..
battery Improve battery reporting reliability 2020-08-22 15:28:35 +00:00
bigscreen Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
clipboard Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
contacts Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
findmyphone Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
findthisdevice Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
lockdevice Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
mousepad Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
mpriscontrol add missing header to fix build with MSVC 14.27 2020-08-18 13:36:32 +05:30
mprisremote Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
notifications Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
pausemusic Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
photo Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
ping Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
presenter Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
remotecommands Reload remote commands model when commands change 2020-08-22 00:50:05 +02:00
remotecontrol Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
remotekeyboard Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
remotesystemvolume Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
runcommand Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
screensaver-inhibit Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
sendnotifications Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
sftp Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
share Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
sms Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
systemvolume Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
telephony Convert license headers to SPDX expressions 2020-08-17 09:48:10 +00:00
CMakeLists.txt Add real support for mpriscontrol on Windows 2020-05-31 15:50:56 -04:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2020-08-09 05:37:05 +02:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2020-06-20 05:10:40 +02: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

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".
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.