Added list_vars.sh to easily enumerate exported variables from source

[mirrors/libpurple-core-answerscripts.git] / README.md

diff --git a/README.md b/README.md
index 28b76cf2453e952ebb85e82c76cc13b8444c3b20..5d5856bc06233905816aaad8ad84dc1e6fc6abe6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 #libPurple core-answerscripts plugin
+  * **Most hackable pidgin plugin!**
   * Framework for hooking scripts to **respond received messages** (and maybe bit more in future) for various **libpurple** clients such as **pidgin or finch**
   * 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.**
   * 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...
@@ -7,14 +8,14 @@
 
 There are lot of hacks that you can do with this simple framework if you know some basic scripting. eg.:
 
-- **Forward your instant messages** to email, SMS gateway, text-to-speach (eg. espeak) or something...
-  - Smart auto-replying messages based on regular expressions
-  - Remote control your music player (or anything else on your computer) using instant messages
-- Simple IRC/Jabber/ICQ bot (currently accepts PM only, you can run finch in screen on server)
-- Providing some service (Searching web, Weather info, System status, RPG game...)
+- **Map any response to any incomming message** (You can even use some substitutions and regexes)
+- **Forward your instant messages** to email, SMS gateway, text-to-speech (eg. espeak) or something...
+- **Remote control** your music player (or anything else on your computer) using instant messages
+- **Simple IRC/Jabber/ICQ bot** (currently accepts PM only, you can run finch in screen on server)
+- Providing some **service** (Searching web, Weather info, System status, RPG game...)
 - BackDoor (**even unintentional one - you've been warned**)
 - Loging and analyzing messages
-- Connect IM with Arduino
+- Connect IM with **Arduino**
 - Annoy everyone with spam (and probably **get banned everywhere**)
 - **Anything else that you can imagine...** (i'm looking forward to hearing your stories)
 
@@ -26,10 +27,21 @@ There are lot of hacks that you can do with this simple framework if you know so
     * Every line that is outputed by this script to it's **STDOUT is sent** as response to message that executed it
     * Following **environment values are passed** to the script:
       * ANSW\_MSG      (text of the message)
-      * ANSW\_FROM     (who sent you message)
-      * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: jabber, irc,...)
+      * ANSW\_FROM     (who sent you the message)
+      * ANSW\_FROM\_GROUP      (group which contains that buddy - buggy)
+      * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: xmpp, irc,...)
       * ANSW\_STATUS   (unique ID of status. eg.: available, away,...)
       * ANSW\_STATUS\_MSG      (status message set by user)
+      * ANSW\_AGENT    (ID of IM client used with answerscripts)
+      * ANSW\_AGENT\_VERSION   (Version of client)
+      * ANSW\_LOCAL\_NAME      (Name of local user - untested)
+      * ANSW\_LOCAL\_ALIAS     (Alias of local user - untested)
+      * ANSW\_REMOTE\_NAME     (???)
+      * ANSW\_REMOTE\_ALIAS\_ONLY      (buggy)
+      * ANSW\_REMOTE\_SERVER\_ALIAS    (buggy)
+      * ANSW\_REMOTE\_CONTACT\_ALIAS   (buggy)
+      * ANSW\_REMOTE\_LOCAL\_ALIAS     (???)
+      * ANSW\_REMOTE\_ALIAS    (???)
     * **WARNING: You should mind security (don't let attackers to execute their messages/nicks!)**
     * 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**
       * It's quite smart and all you need to do is set the filenames and permissions of answerscripts in that directory properly...