Most hackable plugin ;-)
[mirrors/libpurple-core-answerscripts.git] / README.md
1 #libPurple core-answerscripts plugin
2 * **Most hackable pidgin plugin!**
3 * Framework for hooking scripts to **respond received messages** (and maybe bit more in future) for various **libpurple** clients such as **pidgin or finch**
4 * This simple plugin just passes every single message received by any libPurple-based client (pidgin,finch) to sript(s) in user's home directory... So **you can add various hooks.**
5 * There are already few sample (answer)scripts in ./purple directory, so you can check how easy it is to write some script for pidgin or finch...
6
7 ##What can this do for me?
8
9 There are lot of hacks that you can do with this simple framework if you know some basic scripting. eg.:
10
11 - **Map any response to any incomming message** (You can even use some substitutions and regexes)
12 - **Forward your instant messages** to email, SMS gateway, text-to-speech (eg. espeak) or something...
13 - **Remote control** your music player (or anything else on your computer) using instant messages
14 - **Simple IRC/Jabber/ICQ bot** (currently accepts PM only, you can run finch in screen on server)
15 - Providing some **service** (Searching web, Weather info, System status, RPG game...)
16 - BackDoor (**even unintentional one - you've been warned**)
17 - Loging and analyzing messages
18 - Connect IM with **Arduino**
19 - Annoy everyone with spam (and probably **get banned everywhere**)
20 - **Anything else that you can imagine...** (i'm looking forward to hearing your stories)
21
22 ##Writing own (answer)scripts
23
24 * Check example scripts in **./purple/answerscripts.d/** to see how easy it is
25 * Basically
26 * Each time you receive message, the main **answerscripts.sh script (answerscripts.exe on M$ Windows) is executed** on background
27 * Every line that is outputed by this script to it's **STDOUT is sent** as response to message that executed it
28 * Following **environment values are passed** to the script:
29 * ANSW\_MSG (text of the message)
30 * ANSW\_FROM (who sent you message)
31 * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: jabber, irc,...)
32 * ANSW\_STATUS (unique ID of status. eg.: available, away,...)
33 * ANSW\_STATUS\_MSG (status message set by user)
34 * **WARNING: You should mind security (don't let attackers to execute their messages/nicks!)**
35 * I guess that you will want to use more than one answerscript, so i made such answerscript which will execute all answerscripts in **~/.purple/answerscripts.d**
36 * It's quite smart and all you need to do is set the filenames and permissions of answerscripts in that directory properly...
37 * See it's (**./purple/answerscripts.sh**) comments for rest of documentation...
38
39 ###Example
40 Following answerscript will reply to each incoming message if you are not available. Reply will consist of two messages: one with username of your buddy who sent you a message and text of that message; and second with your status message. Simple huh?
41
42 #!/bin/sh
43 [ "$ANSW_STATUS" != 'available' ] && echo "<$ANSW_FROM> $ANSW_MSG" && echo "My status: $ANSW_STATUS_MSG";
44
45 ##Building & installation
46
47 ###From packages
48 - ArchLinux: http://aur.archlinux.org/packages.php?ID=37942
49 ###Manually
50 - The libpurple header files are needed to compile the plugin.
51 - To build and install :
52 You can compile the plugin using
53
54 $ make
55
56 and install it with
57
58 $ make install
59
60 This will install it in ~/.purple/plugins so that only the user who install it can use it.
61
62 $ make user
63
64 Install main script and sample answerscripts to ~/.purple/answerscripts.d/
65
66 - To install it for everybody on your computer,
67
68 $ make
69 $ su
70 # make install PREFIX="/path/to/libpurple" (this command as root user)
71
72 generally /path/to/libpurple is /usr or /usr/local. If you don't know the path then you can find out using
73
74 $ whereis libpurple
75
76 and look for the part before "/lib/libpurple.so".
This page took 0.247015 seconds and 5 git commands to generate.