Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jrm780/gotirc
A Twitch.tv IRC library written in Go
https://github.com/jrm780/gotirc
chat chatbot chatbot-framework go golang irc library twitch twitch-irc twitch-tv twitchirc twitchtv
Last synced: 26 days ago
JSON representation
A Twitch.tv IRC library written in Go
- Host: GitHub
- URL: https://github.com/jrm780/gotirc
- Owner: jrm780
- License: mit
- Created: 2017-11-27T22:54:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-08T16:05:28.000Z (over 5 years ago)
- Last Synced: 2024-08-03T13:01:49.427Z (4 months ago)
- Topics: chat, chatbot, chatbot-framework, go, golang, irc, library, twitch, twitch-irc, twitch-tv, twitchirc, twitchtv
- Language: Go
- Size: 31.3 KB
- Stars: 8
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-twitch-dev - jrm780/gotirc - Twitch.tv IRC library. (Libraries / Golang)
README
# gotirc
 [](https://coveralls.io/github/jrm780/gotirc?branch=master)
### A Twitch.tv IRC library written in Go
[Twitch chat](https://dev.twitch.tv/docs/irc) uses a protocol built on TCP that is roughly based on Internet Relay Chat (IRC) RFC 1459. This package provides convenience functionality for implementing software that requires Twitch chat interaction (e.g., bots, statistics, etc.). The `gotirc.Client` public methods can be safely called from concurrent go-routines, and the API is inspired by [tmi.js](https://www.tmijs.org/). Message sending is rate limited to avoid global bans.
#### Client
A `gotirc.Client` is used to connect to Twitch chat. Callbacks can be passed to the Client to perform actions when particular events occur.
```go
package main
import (
"log"
"github.com/jrm780/gotirc"
)
func main() {
options := gotirc.Options{
Host: "irc.chat.twitch.tv",
Port: 6667,
Channels: []string{"#twitch"},
}
client := gotirc.NewClient(options)
// Whenever someone sends a message, log it
client.OnChat(func(channel string, tags map[string]string, msg string) {
log.Printf("[%s]: %s", tags["display-name"], msg)
})
// Connect and authenticate with the given username and oauth token
client.Connect("justinfan1337", "abc123")
}
```
`Client.Connect(nick, pass)` runs until the client is disconnected from the server. It's easy to implement automatic reconnecting by using a for-loop:
```go
client := gotirc.NewClient(options)
for {
err := client.Connect("justinfan1337", "abc123")
fmt.Printf("Disconnected: %s. Reconnecting in 5 seconds...\n", err)
time.Sleep(5*time.Second)
}
```
#### The Client can perform the following actions
* **Connect(**_nick string, pass string_**)** _error_
* Connects the client to the server specified in the options and uses the supplied nick and pass (oauth token) to authenticate. Connect blocks and runs event callbacks until disconnected
* **Connected()** _bool_
* Returns true if the client is currently connected to the server, false otherwise
* **Disconnect()**
* Closes the client's connection with the server
* **Join(**_channel string_**)**
* Joins a channel
* **Part(**_channel string_**)**
* Leaves a channel
* **Say(**_channel string, msg string_**)**
* Sends a message to a channel
* **Whisper(**_user string, msg string_**)**
* Sends a whisper to a user
#### Currently Implemented Callbacks
* **OnAction(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for action (e.g., /me) messages
* **OnChat(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for when a user sends a message in a channel
* **OnCheer(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for when a user cheers bits in a channel
* **OnJoin(**_func(channel, username string)_**)**
* Adds an event callback for when a user joins a channel
* **OnPart(**_func(channel, username string)_**)**
* Adds an event callback for when a user parts a channel
* **OnResub(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for when a user resubs to a channel
* **OnSubscription(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for when a user subscribes to a channel
* **OnSubGift(**_func(channel string, tags map[string]string, msg string)_**)**
* Adds an event callback for when one user gifts another a subscription to a channel. The tags for these messages are currently undocumented in the Twitch reference, so an example is provided:
* `badges`="subscriber/0,bits/100"
* `color`="#FF0000"
* `user-id`="59638395"
* `display-name`="GiftGiver1337"
* `login`="giftgiver1337"
* `subscriber`="1"
* `turbo`="0"
* `user-type`="..."
* `emotes`="..."
* `id`="8aee6b0e-b7eb-4c1b-99a8-dd875dd8688d"
* `mod`="0"
* `msg-id`="subgift"
* `msg-param-months`="2"
* `msg-param-recipient-display-name`="GiftRecipient1337"
* `msg-param-recipient-id`="133769696"
* `msg-param-recipient-user-name`="giftrecipient1337"
* `msg-param-sub-plan-name`="The\sBest\sSubs"
* `msg-param-sub-plan`="1000"
* `room-id`="133742069"
* `system-msg`="GiftGiver1337\sgifted\sa\s$4.99\ssub\sto\sGiftRecipient1337!"
* `tmi-sent-ts`="1513746444792"
Tags are metadata associated with the message and include information such as the user's display-name and chat color. Twitch may change the tags at any time, so it's best to refer to [their documentation](https://dev.twitch.tv/docs/irc#privmsg-twitch-tags) to determine which data is available.