https://github.com/thoj/go-ircevent

Event based IRC client library in Go (golang)
https://github.com/thoj/go-ircevent

Last synced: about 2 months ago
JSON representation

Event based IRC client library in Go (golang)

• Host: GitHub
• URL: https://github.com/thoj/go-ircevent
• Owner: thoj
• License: bsd-3-clause
• Created: 2009-11-18T14:55:35.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T03:22:24.000Z (over 1 year ago)
• Last Synced: 2024-06-18T12:33:29.386Z (3 months ago)
• Language: Go
• Homepage:
• Size: 209 KB
• Stars: 480
• Watchers: 21
• Forks: 108
• Open Issues: 13
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

• awesome-irc - go-ircevent - Event-based. `Go` (Uncategorized / Uncategorized)

README

        
Description

-----------

Event based irc client library.

Features

--------

* Event based. Register Callbacks for the events you need to handle.

* Handles basic irc demands for you

	* Standard CTCP

	* Reconnections on errors

	* Detect stoned servers

Install

-------

	$ go get github.com/thoj/go-ircevent

Example

-------

See [examples/simple/simple.go](examples/simple/simple.go) and [irc_test.go](irc_test.go)

Events for callbacks

--------------------

* 001 Welcome

* PING

* CTCP Unknown CTCP

* CTCP_VERSION Version request (Handled internaly)

* CTCP_USERINFO

* CTCP_CLIENTINFO

* CTCP_TIME

* CTCP_PING

* CTCP_ACTION (/me)

* PRIVMSG

* MODE

* JOIN

+Many more

AddCallback Example

-------------------

	ircobj.AddCallback("PRIVMSG", func(event *irc.Event) {

		//event.Message() contains the message

		//event.Nick Contains the sender

		//event.Arguments[0] Contains the channel

	});

Please note: Callbacks are run in the main thread. If a callback needs a long

time to execute please run it in a new thread.

Example:

        ircobj.AddCallback("PRIVMSG", func(event *irc.Event) {

		go func(event *irc.Event) {

                        //event.Message() contains the message

                        //event.Nick Contains the sender

                        //event.Arguments[0] Contains the channel

		}(event)

        });

Commands

--------

	ircobj := irc.IRC("", "") //Create new ircobj

	//Set options

	ircobj.UseTLS = true //default is false

	//ircobj.TLSOptions //set ssl options

	ircobj.Password = "[server password]"

	//Commands

	ircobj.Connect("irc.someserver.com:6667") //Connect to server

	ircobj.SendRaw("") //sends string to server. Adds \r\n

	ircobj.SendRawf("", ...) //sends formatted string to server.n

	ircobj.Join("<#channel> [password]") 

	ircobj.Nick("newnick") 

	ircobj.Privmsg("", "msg") // sends a message to either a certain nick or a channel

	ircobj.Privmsgf(, "", ...)

	ircobj.Notice("", "msg")

	ircobj.Noticef("", "", ...)