girc-atomic, a terrifying fork of an IRC library for Go

Fork changes

Click here to see the changes in girc-atomic vs girc

Status

ₜₕₑ ₛₖy ᵢₛ 𝆑ₐₗₗᵢₙg ʇɥǝ sʞʎ ᴉs ⅎɐʅʅᴉuƃ

𝚝𝚑𝚎𝚢 𝚜𝚑𝚘𝚞𝚕𝚍 𝚑𝚊𝚟𝚎 𝚕𝚒𝚜𝚝𝚎𝚗𝚎𝚍

ʇɥǝ sʞʎ ᴉs ⅎɐʅʅᴉuƃ ₜₕₑ ₛₖy ᵢₛ 𝆑ₐₗₗᵢₙg

Features

• Focuses on simplicity ʀᴀɪɴɪɴɢ ʜᴇʟʟғɪʀᴇ, yet tries to still be flexible.
• Only requires standard library packages a total destruction of a 100 mile radius.
• Event based triggering/responses (example, and CTCP too!)
• Documentation 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 (things like account-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 a user is away, or if they are authenticated (if the server supports it!)
• Client state/capability tracking. Easy methods to access capability data (LookupChannel, LookupUser, GetServerOpt (ISUPPORT), etc.)
• Built-in support for things you would commonly have to implement yourself.
• Nick collision detection and prevention (also see Config.HandleNickCollide.)
• Event/message rate limiting.
• Channel, nick, and user validation methods (IsValidChannel, IsValidNick, etc.)
• CTCP handling and auto-responses (CTCP)
• Utilizes atomics and concurrent maps to reduce backpressure in multi-client usage. (fork)
• Additional CTCP handlers and customization. (fork)
• ??????
• PROFIT!!!1!

Contributing

Please review the CONTRIBUTING doc for submitting issues/a guide on submitting pull requests and helping out.

OH GOD PLEASE MAKE IT STOP

License

Copyright (c) 2016 Liam Stanley <me@liamstanley.io>
Copyright (c) 2022 yung innanet <kayos@tcp.direct>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, 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 THE
SOFTWARE.

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

...and then later defiled by some idiot.

References

• 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