girc -- A flexible IRC library for Go
## Status **girc is fairly close to marking the 1.0.0 endpoint, which will be tagged as necessary, so you will be able to use this with care knowing the specific tag you're using won't have breaking changes** ## Features - Focuses on simplicity, yet tries to still be flexible. - Only requires [standard library packages](https://godoc.org/github.com/lrstanley/girc?imports) - Event based triggering/responses ([example](https://godoc.org/github.com/lrstanley/girc#ex-package--Commands), and [CTCP too](https://godoc.org/github.com/lrstanley/girc#Commands.SendCTCP)!). - [Documentation](https://godoc.org/github.com/lrstanley/girc) is _mostly_ complete. - Support for almost all of the IRCv3 spec. - SASL Auth (currently only `PLAIN` and `EXTERNAL` is support by default, however you can simply implement `SASLMech` yourself to support additional mechanisms.) - Message tags (and with this, things like `account-tag` on by default) - `account-notify`, `away-notify`, `chghost`, `extended-join`, etc -- all handled seemlessly ([cap.go](https://github.com/lrstanley/girc/blob/master/cap.go) for more info). - Channel and user tracking. Easily find what users are in a channel, if a user is away, or if they are authenticated (if the server supports it!) - Client state/capability tracking. Easy methods to access capability data ([Lookup](https://godoc.org/github.com/lrstanley/girc#Client.Lookup), [Event.GetChannel](https://godoc.org/github.com/lrstanley/girc#Event.GetChannel), [GetServerOption (ISUPPORT)](https://godoc.org/github.com/lrstanley/girc#Client.GetServerOption), etc.) - Built-in support for things you would commmonly have to implement yourself. - Nick collision detection and prevention (also see [Config.HandleNickCollide](https://godoc.org/github.com/lrstanley/girc#Config).) - Event/message rate limiting. - Channel, nick, and user validation on connection methods ([IsValidChannel](https://godoc.org/github.com/lrstanley/girc#IsValidChannel), [IsValidNick](https://godoc.org/github.com/lrstanley/girc#IsValidNick), etc.) - CTCP handling and auto-responses ([CTCP](https://godoc.org/github.com/lrstanley/girc#CTCP).) - And more! ## Installing $ go get -u github.com/lrstanley/girc ## Examples See [the examples](https://godoc.org/github.com/lrstanley/girc#example-package--Bare) within the documentation for real-world usecases. ## Contributing To review what is currently being worked on, or looked into, feel free to head over to the [project board](https://github.com/lrstanley/girc/projects/1) or the [issues list](https://github.com/lrstanley/girc/issues). ---- Below are a few guidelines if you would like to contribute. Keep the code clean, standardized, and much of the quality should match Golang's standard library and common idioms. * Always test using the latest Go version. * Always use `gofmt` before committing anything. * Always have proper documentation before committing. * Keep the same whitespacing, documentation, and newline format as the rest of the project. * Only use 3rd party libraries if necessary. If only a small portion of the library is needed, simply rewrite it within the library to prevent useless imports. * Also see [golang/go/wiki/CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) ## License ``` LICENSE: The MIT License (MIT) Copyright (c) 2016 Liam Stanley