diff options
author | David Phillips <david@sighup.nz> | 2017-09-26 23:18:20 +1300 |
---|---|---|
committer | David Phillips <david@sighup.nz> | 2017-09-26 23:18:20 +1300 |
commit | a28a8885dce2a25ef8e96880ece27287b23d0eed (patch) | |
tree | f0a426b357b469b08b3d135e7b612313f4727d63 | |
parent | 20e56480ab73629afa1486542f01b0de9b95df94 (diff) | |
download | idalius-a28a8885dce2a25ef8e96880ece27287b23d0eed.tar.xz |
Describe modules in README instead of old monolithic bot behaviour
-rw-r--r-- | README.md | 25 |
1 files changed, 20 insertions, 5 deletions
@@ -1,12 +1,27 @@ # idalius -idalius 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. +idalius started out as a novelty IRC bot. Its original functionality has now +been moved into an optional module, "tittilate", while the remainder of the +bot's functionality is mostly configurable and extensible. -It's hard to word it nicely, so here's an example. +## Module: URL Title -## Example: +idalius can pick a URL out of any channel message and respond in-channel with +the title of the link, followed by the domain name (really just the bit in +between the first `//` and the first `/` in brackets, so you know roughly what +link the title is for, without being overly verbose. + + <phillid> Testing the URL title thingy https://sighup.nz/ and presuming it works + <idalius> Ahoy-hoy β SIGHUP (sighup.nz) + + +## Module: Tittilate + +The tittilate module is one which will ask idalius to check all channel +messages for special keywords, and for each message containing some of those +keywords, respond with a message with as many user-set responses to those +keywords, in order. It's kind of hard to get your head around with plain +words, so I'll give an example. Under the default configuration, idalius will trigger on 'sax', 'trumpet' and 'snake', replying with 'π·', 'πΊ' and 'π' respectively. Take a look at |