lmao probably don't use this your computer may explode
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kayos@tcp.direct 0dec6ca8e2
Coverage: Add silly little test to appease
2 weeks ago
.github/workflows CI: Update go version 2 weeks ago
.gitignore Documentation: slight change 1 month ago
CONTRIBUTING.md Fix nil compiled time and lint 7 months ago
LICENSE Update license 2 months ago
README.md Merge from yung stanley's master branch 2 months ago
builtin.go Upstream: merge in some changes 2 weeks ago
cap.go Upstream: merge in some changes 2 weeks ago
cap_sasl.go lint fixes 2 months ago
cap_tags.go Implement cmaps and break everything 2 months ago
cap_test.go Upstream: merge in some changes 2 weeks ago
client.go Upstream: merge in some changes 2 weeks ago
client_test.go Remove unnecessary debug output 2 months ago
codebook.go Add: missing ALREADYOPER error 2 months ago
commands.go Upstream: merge in some changes 2 weeks ago
conn.go Upstream: merge in some changes 2 weeks ago
conn_test.go Upstream: merge in some changes 2 weeks ago
constants.go Fix bugs from merge 2 months ago
ctcp.go Upstream: merge in some changes 2 weeks ago
ctcp_test.go Upstream: merge in some changes 2 weeks ago
doc.go update doc 5 years ago
event.go Upstream: merge in some changes 2 weeks ago
event_test.go colon should only cause prefix if the param starts with a colon 11 months ago
example_test.go Remove unnecessary debug output 2 months ago
format.go Upstream: merge in some changes 2 weeks ago
format_test.go Upstream: merge in some changes 2 weeks ago
go.mod 1.18 changes 2 weeks ago
go.sum 1.18 changes 2 weeks ago
handler.go Coverage: Add silly little test to appease 2 weeks ago
handler_test.go Coverage: Add silly little test to appease 2 weeks ago
modes.go Fix concurrent map read-write for user perms 2 months ago
state.go Documentation: slight change 1 month ago
state_test.go Lint + version bump 2 months ago
util.go Settle with less hellfire, more safety 6 months ago
version.go Lint + version bump 2 months ago

README.md

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

GoDoc Go Report Card IRC Chat Build Status

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
  • 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 the atomic/value package from stdlib to reduce backpressure in multi-client usage.
  • Additional CTCP handlers and customization.
  • ??????
  • PROFIT!!!1!

Examples

See the examples within the documentation for real-world usecases. Here are a few real-world usecases/examples/projects which utilize the real girc:

Project Description
nagios-check-ircd Nagios utility for monitoring the health of an ircd
nagios-notify-irc Nagios utility for sending alerts to one or many channels/networks
matterbridge bridge between mattermost, IRC, slack, discord (and many others) with REST API

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

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

later defiled by some idiot.

References