README
¶
GoshuIRC-Go
This is a bunch of self-contained packages that help with IRC development in Go. The package splits themselves are fairly similar to how things are split up in the original Python version.
I'm aiming for this to become a client library all of its own. The best path to that is writing a bunch of useful, testable, self-contained packages that I'm able to wire together!
These packages are still in their early stages. Specifically, they're probably not as well-optimised as we'd like, and the interfaces exposed by them may not be final. For specific package details, view the documentation of that package.
An example bot that uses these packages can be found here.
Packages:
- gircclient: Very work-in-progress client library.
- ircfmt: IRC format codes handling, escaping and unescaping.
- ircmap: IRC string casefolding.
- ircmatch: IRC string matching (mostly just a globbing engine).
- ircmsg: IRC message handling, raw line parsing and creation.
- ircutils: Useful utility functions and classes that don't fit into their own packages.
Also check out the eventmgr library here, which helps with event attaching and dispatching.
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 ircmatch handles matching IRC strings with the traditional glob-like syntax.
|
Package ircmatch handles matching IRC strings with the traditional glob-like syntax. |
|
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. |