Go to file

Alex Bramley 1c31d5fb47 update vims to edit README too, maybe i'll actually add stuff.		2009-12-17 21:14:46 +00:00
doc	IRC RFCs and unreal docs for reference	2009-12-12 00:24:41 +00:00
irc	correct syntax errors from updating go to 4450:dd9bae5c7eac	2009-12-17 21:14:01 +00:00
.gitignore	vastly updated bot framework, now with state tracking etc.	2009-12-17 17:22:31 +00:00
Makefile	initial go IRC library, dirty hax abound :-)	2009-11-29 20:23:15 +00:00
README.md	Basic README for github.	2009-12-17 21:12:37 +00:00
client.go	correct syntax errors from updating go to 4450:dd9bae5c7eac	2009-12-17 21:14:01 +00:00
vims	update vims to edit README too, maybe i'll actually add stuff.	2009-12-17 21:14:46 +00:00

README.md

GoIRC Client Framework

Acquiring and Building

Pretty simple, really:

git clone git://github.com/fluffle/goirc.git
make -C irc install

You can build the test client also with:

make
./gobot

This will connect to freenode and join #go-lang by default, so be careful ;-)

Using the framework

The test client provides a good (if basic) example of how to use the framework. Reading irc/handlers.go gives a more in-depth look at how handlers can be written. Commands to be sent to the server (e.g. PRIVMSG) are methods of the main *irc.Conn object, and can be found in irc/commands.go (not all of the possible IRC commands are implemented yet). Events are produced directly from the messages from the IRC server, so you have to handle e.g. "332" for RPL_TOPIC to get the topic for a channel.

The vast majority of handlers implemented within the framework implement state tracking of all nicks in channels that the client is also present in. It's likely that this state tracking will become optional in the near future.

Misc.

Sorry the documentation is crap. Use the source, Luke.