aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0abf9b0b3cf430a849b3f6bcd3c7214b54f7f5f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# sax robot

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> sax snake
	<somesaxbot> 🎷 🐍 
	<someuser> saxaphone woosaxsnakeSAXalright trumpetTRUMPET
	<somesaxbot> 🎷 🎷 🐍 🎷 🎺 🎺 

Simple eh.