go-ircevent/README.markdown

59 lines
1.2 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.
2010-01-10 21:26:39 +00:00
* Handles basic irc demands for you
2010-01-10 21:27:34 +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
----------
2012-11-05 22:41:04 +00:00
$ go get github.com/thoj/go-ircevent
2009-11-21 23:05:12 +00:00
Example
----------
2012-11-05 22:41:04 +00:00
See test/irc_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.Event) {
//e.Message contains the message
//e.Nick Contains the sender
//e.Arguments[0] Contains the channel
});
Commands
--------
2010-09-29 07:55:31 +00:00
irc.IRC("<nick>", "<user>") //Create new ircobj
ircobj.Password = "[server password]"
ircobj.Connect("irc.someserver.com:6667") //Connect to server
ircobj.Sendraw("<string>") //sends string to server. Adds \r\n
ircobj.Sendraw("<formatstring>", ...) //sends formatted string to server.n
ircobj.Join("#channel [password]")
ircobj.Privmsg("#channel", "msg")
ircobj.Privmsg("nickname", "msg")
2010-09-29 07:55:31 +00:00
ircobj.Notice("<nickname | #channel>", "msg")