go-ircevent/README.markdown

58 lines
1.1 KiB
Markdown
Raw Normal View History

2009-11-21 23:05:12 +00:00
Description
----------
Event based irc client library.
2009-11-29 21:11:27 +00:00
Features
---------
* Event based. Register Callbacks for the events you need to handle.
* Handles basic irc demands for you:
2010-01-06 18:36:27 +00:00
* Standard CTCP
* Reconnections on errors
* Detect stoned servers
2009-11-29 21:11:27 +00:00
2009-11-21 23:05:12 +00:00
Install
----------
2009-11-21 23:06:23 +00:00
$ git clone git@github.com:thoj/Go-IRC-Client-Library.git
$ cd Go-IRC-Client-Library
$ make
$ make install
2009-11-21 23:05:12 +00:00
Example
----------
See example/test.go
Events for callbacks
---------
2010-01-06 18:36:27 +00:00
* 001 Welcome
* PING
* CTCP Unknown CTCP
* CTCP_VERSION Version request (Handled internaly)
* CTCP_USERINFO
* CTCP_CLIENTINFO
* CTCP_TIME
* CTCP_PING
* PRIVMSG
* MODE
* JOIN
+Many more
AddCallback Example
---------
ircobj.AddCallback("PRIVMSG", func(event *irc.IRCEvent) {
//e.Message contains the message
//e.Nick Contains the sender
//e.Arguments[0] Contains the channel
});
Commands
--------
ircobj.Sendraw("<string>") //sends string to server. Adds \r\n
ircobj.Join("#channel [password]")
ircobj.Privmsg("#channel", "msg")
ircobj.Privmsg("nickname", "msg")
ircobj.Notice("nickname or #channel", "msg")