Added variables AGENT and AGENT_VERSION

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

diff --git a/README.md b/README.md
index 28b76cf2453e952ebb85e82c76cc13b8444c3b20..7394257c3285f2a6e1213b8aaffc96d11999e567 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 #libPurple core-answerscripts plugin
 #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...
   * 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.:
 
 
 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
 - 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)
 
 - Annoy everyone with spam (and probably **get banned everywhere**)
 - **Anything else that you can imagine...** (i'm looking forward to hearing your stories)
 


@@ -27,6 +28,7 @@ There are lot of hacks that you can do with this simple framework if you know so
     * Following **environment values are passed** to the script:
       * ANSW\_MSG      (text of the message)
       * ANSW\_FROM     (who sent you message)
     * Following **environment values are passed** to the script:
       * ANSW\_MSG      (text of the message)
       * ANSW\_FROM     (who sent you message)

+      * ANSW\_FROM_GROUP       (group which contains that buddy)

       * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: jabber, irc,...)
       * ANSW\_STATUS   (unique ID of status. eg.: available, away,...)
       * ANSW\_STATUS\_MSG      (status message set by user)
       * ANSW\_PROTOCOL (protocol used to deliver the message. eg.: jabber, irc,...)
       * ANSW\_STATUS   (unique ID of status. eg.: available, away,...)
       * ANSW\_STATUS\_MSG      (status message set by user)