kdeconnect-kde

History

Peter Mello bc3c7567a7 Port away from deprecated KIO/KCM functions Updated plugins/share/shareplugin.cpp: - KFileUtils::suggestName() is a drop-in replacement as of 5.64, just moved to another library Updated plugins/findthisdevice/findthisdevice_config.cpp: - KCModule::markAsChanged() is likewise as of 5.64 Signed-off-by: Peter J. Mello <admin@petermello.net>		2019-12-20 00:23:49 +00:00
..
battery	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-08-07 05:00:07 +02:00
clipboard	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-08-07 05:00:07 +02:00
contacts	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
findmyphone	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-08-07 05:00:07 +02:00
findthisdevice	Port away from deprecated KIO/KCM functions	2019-12-20 00:23:49 +00:00
lockdevice	Rename DbusHelper => DBusHelper	2019-08-14 17:36:19 +02:00
mousepad	re-add support for keyboard in Windows build	2019-08-18 19:58:02 +00:00
mpriscontrol	Use URL as title and album in MPRIS plugin	2019-12-19 18:11:12 +01:00
mprisremote	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-08-07 05:00:07 +02:00
notifications	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-11-08 05:29:51 +01:00
pausemusic	pause music plugin for Win32	2019-08-21 02:38:35 +00:00
photo	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
ping	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-09-29 05:09:20 +02:00
presenter	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
remotecommands	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
remotecontrol	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
remotekeyboard	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
remotesystemvolume	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
runcommand	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
screensaver-inhibit	add inhibit screensaver plugin for Windows	2019-08-31 10:40:43 +00:00
sendnotifications	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-11-30 05:34:44 +01:00
sftp	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
share	Port away from deprecated KIO/KCM functions	2019-12-20 00:23:49 +00:00
sms	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
systemvolume	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
telephony	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-12-19 05:49:03 +01:00
CMakeLists.txt	re-write findthisdevice plugin + add support for Windows	2019-09-19 22:45:39 +00:00
kdeconnect.notifyrc	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-11-17 05:06:27 +01:00
kdeconnect_plugin.desktop	SVN_SILENT made messages (.desktop file) - always resolve ours	2019-08-11 04:47:22 +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

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