diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 13 insertions, 5 deletions
@@ -1,14 +1,22 @@ # sax robot -saxrobot/saxbot is a novelty IRC bot who matches any mention of the string "sax" -in any part of an IRC message in the channels it monitors, with as many -saxaphone icons (π·) as there were instances of "sax" throughout each message. +saxrobot/saxbot is a novelty IRC bot who counts user-set trigger words in +IRC channel messages and constructs a reply of user-set replies for each +instance of a trigger word in a message. + +It's hard to word it nicely, so here's an example. ## Example: +Under the default configuration, saxrobot will trigger on 'sax', 'trumpet' +and 'snake', replying with 'π·', 'πΊ' and 'π' respectively. Take a look at +this IRC log: + <someuser> sax <somesaxbot> π· - <someuser> saxaphone woosaxSAXalright - <somesaxbot> π· π· π· + <someuser> sax snake + <somesaxbot> π· π + <someuser> saxaphone woosaxsnakeSAXalright trumpetTRUMPET + <somesaxbot> π· π· π π· πΊ πΊ Simple eh. |