kdeconnect-kde/plugins/README.txt

0001 Writing a plugin for KDE Connect
0002 =================================
0003
0004 For the desktop client (this project):
0005 --------------------------------------
0006
0007 1. Enter the "plugins" directory.
0008 2. Copy the "ping" under a different name ("findmyphone" in this example).
0009 3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
0010 4. Enter the new "findmyphone" directory.
0011 5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
0012 6. Rename other files in this directory by replacing "ping" with "findmyphone"
0013 7. Write a description of your plugin into "README"
0014 8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
0015   A. Change license header.
0016   B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
0017 9. Edit kdeconnect_findmyphone.json file:
0018   A. Replace "ping" with "findmyphone".
0019   B. Change name, description, icon, author, email, version, website, license info.
0020   C. Remove all the translations
0021   D. Set X-KDEConnect-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet type your plugin will receive
0022      and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
0023      the findmyphoneplugin.h file (in the line "#define PACKET_TYPE_..."), and also in Android.
0024 10. Now you have an empty skeleton to implement your new plugin logic.
0025
0026 For Android (project kdeconnect-android):
0027 -----------------------------------------
0028
0029 1. Change directory to src/org/kde/kdeconnect/Plugins.
0030 2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
0031 3. Enter the new "FindMyPhonePlugin" directory.
0032 4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
0033 5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
0034    and "plugin_ping" with "plugin_findmyphone".
0035 6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
0036    with "findmyphone" and edit the plugin name and description between <string> </string>).
0037 7. Now you have an empty skeleton to implement your new plugin logic.