tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Nicolas Fella d3b41924b5 Revert "Make PulseAudioQT mandatory" 
This breaks CI as PAQt is not yet available there

This reverts commit b48596d7c3.
2019-05-01 14:53:30 +02:00
..
battery SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
contacts More https 2019-03-23 17:38:09 +01:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
findthisdevice replace phonon with QtMultimedia 2019-04-30 16:24:09 +00:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2019-03-24 05:23:24 +01:00
mousepad SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2019-03-24 05:23:24 +01:00
notifications SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
pausemusic [pausemusic] Port to PulseAudioQt 2019-04-28 19:31:39 +00:00
photo SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-16 05:57:25 +02:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2019-03-24 05:23:24 +01:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2019-03-24 05:23:24 +01:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
remotesystemvolume Replace http GNU urls with https 2019-03-23 17:29:26 +01:00
runcommand SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
sendnotifications More https 2019-03-23 17:38:09 +01:00
sftp [sftp] Fix error message wording 2019-04-28 19:28:06 +00:00
share SVN_SILENT made messages (.desktop file) - always resolve ours 2019-05-01 05:56:02 +02:00
sms Add sanity check to dbus-exposed requestConversation() 2019-05-01 12:47:33 +00:00
systemvolume Add Macro for MinGW and fix GUID Macro Fix for Windows building 2019-05-01 00:21:19 +02:00
telephony SVN_SILENT made messages (.desktop file) - always resolve ours 2019-04-22 05:58:13 +02:00
CMakeLists.txt Revert "Make PulseAudioQT mandatory" 2019-05-01 14:53:30 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-02-26 05:29:15 +01:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2018-10-10 06:19:16 +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.