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
291 Commits 4 Branches 11 Tags 795 KiB
Go 100%
Go to file
Liam Stanley 882bdb5862 make parts of CModes public 2017-02-20 21:32:51 -05:00
.travis.yml last one I swear 2017-02-13 03:29:15 -05:00
LICENSE remove year from LICENSE 2017-02-09 16:03:27 -05:00
README.md update coverall link to use go 2017-02-13 02:52:53 -05:00
builtin.go update docs; remove Client.DisableNickCollision; implement Config.HandleNickCollide 2017-02-20 21:03:35 -05:00
cap.go properly handle errors during write operations 2017-02-13 09:28:59 -05:00
client.go update docs; remove Client.DisableNickCollision; implement Config.HandleNickCollide 2017-02-20 21:03:35 -05:00
client_test.go Debug->Debugger; implement client side ping tracking; implement Config.Out; implement Config.PingDelay 2017-02-14 02:14:38 -05:00
commands.go properly handle errors during write operations 2017-02-13 09:28:59 -05:00
conn.go implement Client.Lag() 2017-02-20 20:39:16 -05:00
contants.go implement disconnect/stop virtual events 2017-02-11 21:51:30 -05:00
ctcp.go implement commands 2017-02-13 07:52:29 -05:00
ctcp_test.go update tests to be backwards compatible (removes t.Run() calls) 2017-02-13 01:57:07 -05:00
doc.go update copyright to remove year 2017-02-06 02:45:31 -05:00
event.go don't print sensitive events, additional handling for sending to server 2017-02-14 01:25:13 -05:00
event_test.go merge Source/Event into a single file 2017-02-13 04:46:05 -05:00
format.go add additional noting in regards to channel id lengths and ISUPPORT 2017-02-07 06:28:35 -05:00
format_test.go update tests to be backwards compatible (removes t.Run() calls) 2017-02-13 01:57:07 -05:00
handler.go Debug->Debugger; implement client side ping tracking; implement Config.Out; implement Config.PingDelay 2017-02-14 02:14:38 -05:00
modes.go make parts of CModes public 2017-02-20 21:32:51 -05:00
state.go make parts of CModes public 2017-02-20 21:32:51 -05:00

README.md

girc -- A flexible IRC library for Go

Build Status Coverage Status GoDoc Go Report Card IRC Chat

Status

EXPECT BREAKING CHANGES TO OCCUR FREQUENTLY. girc has not hit version 1.0.0 yet!

Changes are actively being made. At this time, most of the stateful parts of girc are not accessible, as well as other minor consistencies while things are still being flushed out. Not production ready! You've been warned!

Features

  • Focuses on simplicity, yet tries to still be flexible.
  • Only requires standard library packages (uses 2 sub-repo packages, one being context for backwards compatibility)
  • Event based triggering/responses (and CTCP too!).
  • Documentation is mostly on par.
  • Full support for the IRCv3 spec.
  • 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.

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

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

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.