2009-11-21 23:05:12 +00:00
|
|
|
Description
|
2014-02-14 16:56:19 +00:00
|
|
|
-----------
|
2009-11-21 23:05:12 +00:00
|
|
|
|
|
|
|
|
Event based irc client library.
|
|
|
|
|
|
2009-11-29 21:11:27 +00:00
|
|
|
|
|
|
|
|
Features
|
2014-02-14 16:56:19 +00:00
|
|
|
--------
|
2010-01-06 18:32:35 +00:00
|
|
|
* 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
|
2014-02-14 16:56:19 +00:00
|
|
|
-------
|
2012-11-05 22:41:04 +00:00
|
|
|
$ go get github.com/thoj/go-ircevent
|
2009-11-21 23:05:12 +00:00
|
|
|
|
|
|
|
|
Example
|
2014-02-14 16:56:19 +00:00
|
|
|
-------
|
2012-11-05 22:41:04 +00:00
|
|
|
See test/irc_test.go
|
2010-01-06 18:32:35 +00:00
|
|
|
|
|
|
|
|
Events for callbacks
|
2014-02-14 16:56:19 +00:00
|
|
|
--------------------
|
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
|
2014-02-02 05:38:45 +00:00
|
|
|
* CTCP_ACTION (/me)
|
2010-01-06 18:36:27 +00:00
|
|
|
* PRIVMSG
|
|
|
|
|
* MODE
|
|
|
|
|
* JOIN
|
2010-01-06 18:32:35 +00:00
|
|
|
|
|
|
|
|
+Many more
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AddCallback Example
|
2014-02-14 16:56:19 +00:00
|
|
|
-------------------
|
2012-05-11 11:49:15 +00:00
|
|
|
ircobj.AddCallback("PRIVMSG", func(event *irc.Event) {
|
2014-02-11 23:05:20 +00:00
|
|
|
//e.Message() contains the message
|
2010-01-06 18:32:35 +00:00
|
|
|
//e.Nick Contains the sender
|
|
|
|
|
//e.Arguments[0] Contains the channel
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
Commands
|
|
|
|
|
--------
|
2012-11-07 20:57:10 +00:00
|
|
|
ircobj := irc.IRC("<nick>", "<user>") //Create new ircobj
|
|
|
|
|
//Set options
|
|
|
|
|
ircobj.UseTLS = true //default is false
|
|
|
|
|
//ircobj.TLSOptions //set ssl options
|
2010-09-29 07:55:31 +00:00
|
|
|
ircobj.Password = "[server password]"
|
2012-11-07 20:57:10 +00:00
|
|
|
//Commands
|
2010-09-29 07:55:31 +00:00
|
|
|
ircobj.Connect("irc.someserver.com:6667") //Connect to server
|
2010-01-06 18:32:35 +00:00
|
|
|
ircobj.Sendraw("<string>") //sends string to server. Adds \r\n
|
2012-11-11 09:41:33 +00:00
|
|
|
ircobj.Sendrawf("<formatstring>", ...) //sends formatted string to server.n
|
|
|
|
|
ircobj.Join("<#channel> [password]")
|
2013-03-13 11:53:47 +00:00
|
|
|
ircobj.Nick("newnick")
|
2012-11-11 09:41:33 +00:00
|
|
|
ircobj.Privmsg("<nickname | #channel>", "msg")
|
|
|
|
|
ircobj.Privmsgf(<nickname | #channel>, "<formatstring>", ...)
|
2010-09-29 07:55:31 +00:00
|
|
|
ircobj.Notice("<nickname | #channel>", "msg")
|
2012-11-11 09:41:33 +00:00
|
|
|
ircobj.Noticef("<nickname | #channel>", "<formatstring>", ...)
|
