summaryrefslogtreecommitdiff
path: root/README.md
blob: 2abc586342a9bdbebfe451cd93fa9cf89d36deac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Miaowe
Miaowe is an IRC bot that prints out image files (PPM at the moment) using mIRC colour codes on request.

Dependencies:
* GHC

To build:

    make

The resulting executable will be called "miaowe".

Miaowe includes no networking code of its own, but assumes stdin and stdout will be connected to an IRC server. A zsh script, nya.sh, is included to help with this. Users of other shells may need to adjust the script to work with their shell. NickServ login credentials are placed in a file called "conn" (in the parent of miaowe's PWD), on the first line and separated by a space. Image files are read from the working directory. If nya.sh is used, image_directory becomes miaowe's PWD.

Available commands:
* List -- lists all files in PWD
* Code -- shows code URL
* Help -- helps
* Quit -- quits

Miaowe can optionally include a fortune cookie command. To enable this, compile with: `make GHCFLAGS=-DFORTUNE`. The command will be called "Fortune".

To run:

    ./miaowe <channel>

or:

    ./nya.sh <channel> <image_directory>