Repository files navigation

girc -- 💣 girc is a flexible IRC library for Go 👌

• Features
• Installing
• Examples
• References
• Support & Assistance
• Contributing
• License

• Focuses on simplicity, yet tries to still be flexible.
• Only requiresstandard library packages
• Event based triggering/responses (example, andCTCP too!)
• Documentation ismostly complete.
• Support for a good portion of theIRCv3 spec.
  • SASL Auth (currently onlyPLAIN andEXTERNAL is support by default,however you can simply implementSASLMech yourself to support additionalmechanisms.)
  • Message tags (things likeaccount-tag on by default)
  • account-notify,away-notify,chghost,extended-join, etc -- all handled seemlessly (cap.go for more info).
• Channel and user tracking. Easily find what users are in a channel, if auser is away, or if they are authenticated (if the server supports it!)
• Client state/capability tracking. Easy methods to access capability data (LookupChannel,LookupUser,GetServerOption (ISUPPORT), etc.)
• Built-in support for things you would commonly have to implement yourself.
  • Nick collision detection and prevention (also seeConfig.HandleNickCollide.)
  • Event/message rate limiting.
  • Channel, nick, and user validation methods (IsValidChannel,IsValidNick, etc.)
  • CTCP handling and auto-responses (CTCP)
  • And more!

$ go get -u github.com/lrstanley/girc

Seethe exampleswithin the documentation for real-world usecases. Here are a few real-worldusecases/examples/projects which utilize girc:

Working on a project and want to add it to the list? Submit a pull request!

• IRCv3: Specification Docs
• IRCv3: Specification Repo
• IRCv3 Capability Registry
• IRCv3: WEBIRC
• KiwiIRC: WEBIRC
• ISUPPORT Specification Docs (alternative 1,alternative 2,relevant draft)
• IRC Numerics List
• Extended WHO (also known as WHOX)
• RFC1459: Internet Relay Chat Protocol
• RFC2812: Internet Relay Chat: Client Protocol
• RFC2813: Internet Relay Chat: Server Protocol
• RFC7194: Default Port for Internet Relay Chat (IRC) via TLS/SSL
• RFC4422: Simple Authentication and Security Layer (SASL EXTERNAL)
• RFC4616: The PLAIN SASL Mechanism

• ❤️ Please review theCode of Conduct forguidelines on ensuring everyone has the best experience interacting withthe community.
• 🙋‍♂️ Take a look at thesupport document onguidelines for tips on how to ask the right questions.
• 🐞 For all features/bugs/issues/questions/etc,head over here.

• ❤️ Please review theCode of Conduct for guidelineson ensuring everyone has the best experience interacting with thecommunity.
• 📋 Please review thecontributing doc for submittingissues/a guide on submitting pull requests and helping out.
• 🗝️ For anything security related, please review this repositoriessecurity policy.

MIT LicenseCopyright (c) 2016 Liam Stanley <me@liamstanley.io>Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.

Also locatedhere

girc artwork licensed underCC 3.0based on Renee French under Creative Commons 3.0 Attributions.