README
¶
GoshuIRC-Go
These are libraries to help in writing IRC clients and servers in Go, prioritizing correctness, safety, and IRCv3 support. They are not yet API-stable, but any API breaks should 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.
- ircmap: IRC string casefolding.
- gircclient: Alternative, work-in-progress client library.
For a relatively complete example of the library's use, see slingamn/titlebot.
Documentation
¶
Overview ¶
Package goshuirc 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.
An example bot that uses these packages can be found here: https://gist.github.com/DanielOaks/cbbc957e8dba39f59d9e
These packages are in their early stages. For the status of each package, see the documentation for that package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package gircclient is an IRC client library.
|
Package gircclient is an IRC client library. |
|
Package ircfmt handles IRC formatting codes, escaping and unescaping.
|
Package ircfmt handles IRC formatting codes, escaping and unescaping. |
|
Package ircmap handles IRC casefolding, ie ascii/rfc1459 casefolding.
|
Package ircmap handles IRC casefolding, ie ascii/rfc1459 casefolding. |
|
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. |