https://github.com/sunspots/tmi

Go library for Twitch chat IRC/TMI (Twitch Message Interface)
https://github.com/sunspots/tmi

bot chat go irc irc-client tmi twitch

Last synced: 26 days ago
JSON representation

Go library for Twitch chat IRC/TMI (Twitch Message Interface)

• Host: GitHub
• URL: https://github.com/sunspots/tmi
• Owner: sunspots
• License: mit
• Created: 2015-04-02T08:15:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-03-06T18:01:00.000Z (almost 6 years ago)
• Last Synced: 2024-08-03T13:01:48.812Z (4 months ago)
• Topics: bot, chat, go, irc, irc-client, tmi, twitch
• Language: Go
• Homepage:
• Size: 43 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-twitch-dev - sunspots/tmi - Go library for Twitch chat IRC/TMI. (Libraries / Golang)

README

        
tmi

--------

A simple library to interface with Twitch's IRC, TMI  

The library is intended to be used as a base for bots, clients, web-relays, overlays, statistics etc.

It's designed for a mostly hands-free experience, so on top of basic IRC functionality, the parsing handles action(/me) messages, IRCv3 tags, connection timeout, automatic ping/pong etc.

THIS IS BARELY PRODUCTION TESTED! USE WITH CARE!

The library doesn't explicitly handle commands (it's all passed as strings),

and it doesn't implement any events. Instead it is built on a blocking (buffered) function call, which returns an event or an error. This way you can add on any event system you really want (I have previously used [emission](https://github.com/chuckpreslar/emission) since it's close to the patterns I'm used to), or just chuck it into a loop.

The current version is heavily influenced by [irc-event](https://github.com/thoj/go-ircevent) and it's forks. I will be refactoring and rewriting a lot of it since I'm not entirely convinced with the approach, but it's what I needed to make it work for now.

If you have issues, ideas, feature requests etc. Feel free to open an issue, or send a pull request!

## Installation

With Google's [Go](http://www.golang.org) installed on your machine:

    $ go get github.com/sunspots/tmi

## Usage

See examples

## Documentation

View godocs

    $ godoc github.com/sunspots/tmi

## Future wants

- Better handling of errors on the different loops,

cleaner approach to the whole looping insides.

- Lots of other stuff.

- Structure middleware usage.

## License

> The MIT License (MIT)

> Copyright (c) 2017 Sunspots

> 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.