kayos/girc-atomic
1
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
lmao probably don't use this your computer may explode
195 Commits 4 Branches 11 Tags 795 KiB
Go 100%
af22c0a64c
Go to file
Liam Stanley af22c0a64c remove unneeded c.IsConnected() checks; implement Whois(), Ping(), Pong(), Oper(), Kick(), Invite(), Away(), Back(), and List()
2017-02-05 07:09:48 -05:00
.travis.yml rename Prefix to Source 2016-11-19 09:36:17 -05:00
caller.go log callback registration/removal/execution to debug output 2017-02-05 06:09:35 -05:00
cap.go minor bug fixes and improvements to tag parsing and validation 2017-01-20 06:50:57 -05:00
client_test.go add examples of how to log incoming events 2017-02-05 05:31:45 -05:00
client.go remove unneeded c.IsConnected() checks; implement Whois(), Ping(), Pong(), Oper(), Kick(), Invite(), Away(), Back(), and List() 2017-02-05 07:09:48 -05:00
conn.go yay new year 2017-01-03 11:05:27 -05:00
contants.go add CAP NEW and CAP DEL checking and responding 2017-01-19 03:33:49 -05:00
ctcp_test.go yay new year 2017-01-03 11:05:27 -05:00
ctcp.go implement version config option to override default ctcp version 2017-01-12 02:34:29 -05:00
doc.go update examples link 2017-01-29 05:51:30 -05:00
event_test.go yay new year 2017-01-03 11:05:27 -05:00
event.go re-implement Config.Logger; add Config.Debugger, and implement Event.Pretty(). 2017-02-03 08:54:44 -05:00
format_test.go yay new year 2017-01-03 11:05:27 -05:00
format.go yay new year 2017-01-03 11:05:27 -05:00
handlers.go log callback registration/removal/execution to debug output 2017-02-05 06:09:35 -05:00
LICENSE first commit 2016-11-13 03:30:43 -05:00
README.md update TODOs to point to issues/projects 2017-01-20 07:25:53 -05:00
source_test.go yay new year 2017-01-03 11:05:27 -05:00
source.go yay new year 2017-01-03 11:05:27 -05:00
state.go track user modes using NAMES; closes #2 2017-01-27 07:01:37 -05:00

README.md

girc -- A flexible IRC library for Go

Build Status GoDoc Go Report Card IRC Chat GitHub Issues License

Features

  • Focuses on simplicity, yet tries to still be flexible.

  • Only requires standard library packages.

  • Event based triggering/responses (and CTCP too!).

  • Documentation is mostly on par.

  • Full support for the IRCv3 spec. [WIP]

  • Channel and user tracking. Easily find what users are in a channel, if a user is away, or if they are authenticated.

  • Client state/capability tracking. Easy methods to access capability data.

  • Built-in support for things you would commmonly have to implement yourself.

    • Nick collision detection and prevention.
    • Event/message rate limiting.
    • Channel, nick, and user validation on connection methods.
    • CTCP handling and auto-responses.

  • At this time, expect breaking changes to occur frequently. girc has not hit version 1.0.0 yet!

TODO

To review what is currently being worked on, or looked into, feel free to head over to the project board or the issues list.

Installing

$ go get -u github.com/lrstanley/girc

Examples

See the examples within the documentation for real-world usecases.

Contributing

Below are a few guidelines if you would like to contribute. Keep the code clean, standardized, and much of the quality should match Golang's standard library and common idioms.

  • Always test using the latest Go version.
  • Always use gofmt before committing anything.
  • Always have proper documentation before committing.
  • Keep the same whitespacing, documentation, and newline format as the rest of the project.
  • Only use 3rd party libraries if necessary. If only a small portion of the library is needed, simply rewrite it within the library to prevent useless imports.
  • Also see golang/go/wiki/CodeReviewComments

License

The MIT License (MIT); Copyright (c) Liam Stanley <me@liamstanley.io>