README
¶
ergochat/irc-go
These are libraries to help in writing IRC clients and servers in Go, prioritizing correctness, safety, and IRCv3 support. They are not fully API-stable, but we expect any API breaks to be modest in scope.
Packages:
- ircmsg: IRC message handling, raw line parsing and creation.
- ircreader: Optimized reader for \n-terminated lines, with an expanding but bounded buffer.
- ircevent: IRC client library (fork of thoj/go-ircevent).
- ircfmt: IRC format codes handling, escaping and unescaping.
- ircutils: Useful utility functions and classes that don't fit into their own packages.
For a relatively complete example of the library's use, see slingamn/titlebot.
Documentation
¶
Overview ¶
ergochat/irc-go has useful, self-contained packages that help with IRC development. These packages are split up so you can easily choose which ones to use while ignoring the others, handling things like simplifying formatting codes, parsing and creating raw IRC lines, and event management.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ircfmt handles IRC formatting codes, escaping and unescaping.
|
Package ircfmt handles IRC formatting codes, escaping and unescaping. |
|
Package ircmsg helps parse and create lines for IRC connections.
|
Package ircmsg helps parse and create lines for IRC connections. |
|
Package ircutils provides small, useful utility functions and classes.
|
Package ircutils provides small, useful utility functions and classes. |
Click to show internal directories.
Click to hide internal directories.