main answerscript is now bit more resistant to IM floods
[mirrors/libpurple-core-answerscripts.git] / README.md
CommitLineData
086adff4 1#libPurple core-answerscripts plugin
39195dd6 2 * **Most hackable pidgin plugin!**
086adff4
H
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
9There are lot of hacks that you can do with this simple framework if you know some basic scripting. eg.:
10
ea57654e
H
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...)
086adff4
H
16- BackDoor (**even unintentional one - you've been warned**)
17- Loging and analyzing messages
39195dd6 18- Connect IM with **Arduino**
086adff4
H
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)
7f54aeea 30 * ANSW\_FROM (who sent you the message)
2c80caf3 31 * ANSW\_FROM\_GROUP (group which contains that buddy)
7f54aeea 32 * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: xmpp, irc,...)
086adff4
H
33 * ANSW\_STATUS (unique ID of status. eg.: available, away,...)
34 * ANSW\_STATUS\_MSG (status message set by user)
7f54aeea
H
35 * ANSW\_AGENT (ID of IM client used with answerscripts)
36 * ANSW\_AGENT\_VERSION (Version of client)
37 * ANSW\_LOCAL\_NAME (Name of local user - untested)
38 * ANSW\_LOCAL\_ALIAS (Alias of local user - untested)
39 * ANSW\_REMOTE\_NAME (???)
40 * ANSW\_REMOTE\_ALIAS\_ONLY (buggy)
41 * ANSW\_REMOTE\_SERVER\_ALIAS (buggy)
42 * ANSW\_REMOTE\_CONTACT\_ALIAS (buggy)
43 * ANSW\_REMOTE\_LOCAL\_ALIAS (???)
44 * ANSW\_REMOTE\_ALIAS (???)
086adff4
H
45 * **WARNING: You should mind security (don't let attackers to execute their messages/nicks!)**
46 * 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**
47 * It's quite smart and all you need to do is set the filenames and permissions of answerscripts in that directory properly...
48 * See it's (**./purple/answerscripts.sh**) comments for rest of documentation...
49
50###Example
51Following 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?
52
53 #!/bin/sh
54 [ "$ANSW_STATUS" != 'available' ] && echo "<$ANSW_FROM> $ANSW_MSG" && echo "My status: $ANSW_STATUS_MSG";
55
56##Building & installation
57
58###From packages
59- ArchLinux: http://aur.archlinux.org/packages.php?ID=37942
60###Manually
61- The libpurple header files are needed to compile the plugin.
62- To build and install :
63 You can compile the plugin using
64
65 $ make
66
67 and install it with
68
69 $ make install
70
71 This will install it in ~/.purple/plugins so that only the user who install it can use it.
72
73 $ make user
74
75 Install main script and sample answerscripts to ~/.purple/answerscripts.d/
76
77- To install it for everybody on your computer,
78
79 $ make
80 $ su
81 # make install PREFIX="/path/to/libpurple" (this command as root user)
82
83 generally /path/to/libpurple is /usr or /usr/local. If you don't know the path then you can find out using
84
85 $ whereis libpurple
86
87 and look for the part before "/lib/libpurple.so".
This page took 0.18704 seconds and 4 git commands to generate.